LXR linux/include/linux/fb.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _LINUX_FB_H
   3#define _LINUX_FB_H
   4
   5#include <linux/kgdb.h>
   6#include <uapi/linux/fb.h>
   7
   8#define FBIO_CURSOR            _IOWR('F', 0x08, struct fb_cursor_user)
   9
  10#include <linux/fs.h>
  11#include <linux/init.h>
  12#include <linux/workqueue.h>
  13#include <linux/notifier.h>
  14#include <linux/list.h>
  15#include <linux/backlight.h>
  16#include <linux/slab.h>
  17#include <asm/io.h>
  18
  19struct vm_area_struct;
  20struct fb_info;
  21struct device;
  22struct file;
  23struct videomode;
  24struct device_node;
  25
  26/* Definitions below are used in the parsed monitor specs */
  27#define FB_DPMS_ACTIVE_OFF      1
  28#define FB_DPMS_SUSPEND         2
  29#define FB_DPMS_STANDBY         4
  30
  31#define FB_DISP_DDI             1
  32#define FB_DISP_ANA_700_300     2
  33#define FB_DISP_ANA_714_286     4
  34#define FB_DISP_ANA_1000_400    8
  35#define FB_DISP_ANA_700_000     16
  36
  37#define FB_DISP_MONO            32
  38#define FB_DISP_RGB             64
  39#define FB_DISP_MULTI           128
  40#define FB_DISP_UNKNOWN         256
  41
  42#define FB_SIGNAL_NONE          0
  43#define FB_SIGNAL_BLANK_BLANK   1
  44#define FB_SIGNAL_SEPARATE      2
  45#define FB_SIGNAL_COMPOSITE     4
  46#define FB_SIGNAL_SYNC_ON_GREEN 8
  47#define FB_SIGNAL_SERRATION_ON  16
  48
  49#define FB_MISC_PRIM_COLOR      1
  50#define FB_MISC_1ST_DETAIL      2       /* First Detailed Timing is preferred */
  51#define FB_MISC_HDMI            4
  52struct fb_chroma {
  53        __u32 redx;     /* in fraction of 1024 */
  54        __u32 greenx;
  55        __u32 bluex;
  56        __u32 whitex;
  57        __u32 redy;
  58        __u32 greeny;
  59        __u32 bluey;
  60        __u32 whitey;
  61};
  62
  63struct fb_monspecs {
  64        struct fb_chroma chroma;
  65        struct fb_videomode *modedb;    /* mode database */
  66        __u8  manufacturer[4];          /* Manufacturer */
  67        __u8  monitor[14];              /* Monitor String */
  68        __u8  serial_no[14];            /* Serial Number */
  69        __u8  ascii[14];                /* ? */
  70        __u32 modedb_len;               /* mode database length */
  71        __u32 model;                    /* Monitor Model */
  72        __u32 serial;                   /* Serial Number - Integer */
  73        __u32 year;                     /* Year manufactured */
  74        __u32 week;                     /* Week Manufactured */
  75        __u32 hfmin;                    /* hfreq lower limit (Hz) */
  76        __u32 hfmax;                    /* hfreq upper limit (Hz) */
  77        __u32 dclkmin;                  /* pixelclock lower limit (Hz) */
  78        __u32 dclkmax;                  /* pixelclock upper limit (Hz) */
  79        __u16 input;                    /* display type - see FB_DISP_* */
  80        __u16 dpms;                     /* DPMS support - see FB_DPMS_ */
  81        __u16 signal;                   /* Signal Type - see FB_SIGNAL_* */
  82        __u16 vfmin;                    /* vfreq lower limit (Hz) */
  83        __u16 vfmax;                    /* vfreq upper limit (Hz) */
  84        __u16 gamma;                    /* Gamma - in fractions of 100 */
  85        __u16 gtf       : 1;            /* supports GTF */
  86        __u16 misc;                     /* Misc flags - see FB_MISC_* */
  87        __u8  version;                  /* EDID version... */
  88        __u8  revision;                 /* ...and revision */
  89        __u8  max_x;                    /* Maximum horizontal size (cm) */
  90        __u8  max_y;                    /* Maximum vertical size (cm) */
  91};
  92
  93struct fb_cmap_user {
  94        __u32 start;                    /* First entry  */
  95        __u32 len;                      /* Number of entries */
  96        __u16 __user *red;              /* Red values   */
  97        __u16 __user *green;
  98        __u16 __user *blue;
  99        __u16 __user *transp;           /* transparency, can be NULL */
 100};
 101
 102struct fb_image_user {
 103        __u32 dx;                       /* Where to place image */
 104        __u32 dy;
 105        __u32 width;                    /* Size of image */
 106        __u32 height;
 107        __u32 fg_color;                 /* Only used when a mono bitmap */
 108        __u32 bg_color;
 109        __u8  depth;                    /* Depth of the image */
 110        const char __user *data;        /* Pointer to image data */
 111        struct fb_cmap_user cmap;       /* color map info */
 112};
 113
 114struct fb_cursor_user {
 115        __u16 set;                      /* what to set */
 116        __u16 enable;                   /* cursor on/off */
 117        __u16 rop;                      /* bitop operation */
 118        const char __user *mask;        /* cursor mask bits */
 119        struct fbcurpos hot;            /* cursor hot spot */
 120        struct fb_image_user image;     /* Cursor image */
 121};
 122
 123/*
 124 * Register/unregister for framebuffer events
 125 */
 126
 127/*      The resolution of the passed in fb_info about to change */ 
 128#define FB_EVENT_MODE_CHANGE            0x01
 129
 130#ifdef CONFIG_GUMSTIX_AM200EPD
 131/* only used by mach-pxa/am200epd.c */
 132#define FB_EVENT_FB_REGISTERED          0x05
 133#define FB_EVENT_FB_UNREGISTERED        0x06
 134#endif
 135
 136/*      A display blank is requested       */
 137#define FB_EVENT_BLANK                  0x09
 138/*      A hardware display blank early change occurred */
 139#define FB_EARLY_EVENT_BLANK            0x10
 140/*      A hardware display blank revert early change occurred */
 141#define FB_R_EARLY_EVENT_BLANK          0x11
 142
 143struct fb_event {
 144        struct fb_info *info;
 145        void *data;
 146};
 147
 148struct fb_blit_caps {
 149        u32 x;
 150        u32 y;
 151        u32 len;
 152        u32 flags;
 153};
 154
 155#ifdef CONFIG_FB_NOTIFY
 156extern int fb_register_client(struct notifier_block *nb);
 157extern int fb_unregister_client(struct notifier_block *nb);
 158extern int fb_notifier_call_chain(unsigned long val, void *v);
 159#else
 160static inline int fb_register_client(struct notifier_block *nb)
 161{
 162        return 0;
 163};
 164
 165static inline int fb_unregister_client(struct notifier_block *nb)
 166{
 167        return 0;
 168};
 169
 170static inline int fb_notifier_call_chain(unsigned long val, void *v)
 171{
 172        return 0;
 173};
 174#endif
 175
 176/*
 177 * Pixmap structure definition
 178 *
 179 * The purpose of this structure is to translate data
 180 * from the hardware independent format of fbdev to what
 181 * format the hardware needs.
 182 */
 183
 184#define FB_PIXMAP_DEFAULT 1     /* used internally by fbcon */
 185#define FB_PIXMAP_SYSTEM  2     /* memory is in system RAM  */
 186#define FB_PIXMAP_IO      4     /* memory is iomapped       */
 187#define FB_PIXMAP_SYNC    256   /* set if GPU can DMA       */
 188
 189struct fb_pixmap {
 190        u8  *addr;              /* pointer to memory                    */
 191        u32 size;               /* size of buffer in bytes              */
 192        u32 offset;             /* current offset to buffer             */
 193        u32 buf_align;          /* byte alignment of each bitmap        */
 194        u32 scan_align;         /* alignment per scanline               */
 195        u32 access_align;       /* alignment per read/write (bits)      */
 196        u32 flags;              /* see FB_PIXMAP_*                      */
 197        u32 blit_x;             /* supported bit block dimensions (1-32)*/
 198        u32 blit_y;             /* Format: blit_x = 1 << (width - 1)    */
 199                                /*         blit_y = 1 << (height - 1)   */
 200                                /* if 0, will be set to 0xffffffff (all)*/
 201        /* access methods */
 202        void (*writeio)(struct fb_info *info, void __iomem *dst, void *src, unsigned int size);
 203        void (*readio) (struct fb_info *info, void *dst, void __iomem *src, unsigned int size);
 204};
 205
 206#ifdef CONFIG_FB_DEFERRED_IO
 207struct fb_deferred_io {
 208        /* delay between mkwrite and deferred handler */
 209        unsigned long delay;
 210        struct mutex lock; /* mutex that protects the page list */
 211        struct list_head pagelist; /* list of touched pages */
 212        /* callback */
 213        void (*first_io)(struct fb_info *info);
 214        void (*deferred_io)(struct fb_info *info, struct list_head *pagelist);
 215};
 216#endif
 217
 218/*
 219 * Frame buffer operations
 220 *
 221 * LOCKING NOTE: those functions must _ALL_ be called with the console
 222 * semaphore held, this is the only suitable locking mechanism we have
 223 * in 2.6. Some may be called at interrupt time at this point though.
 224 *
 225 * The exception to this is the debug related hooks.  Putting the fb
 226 * into a debug state (e.g. flipping to the kernel console) and restoring
 227 * it must be done in a lock-free manner, so low level drivers should
 228 * keep track of the initial console (if applicable) and may need to
 229 * perform direct, unlocked hardware writes in these hooks.
 230 */
 231
 232struct fb_ops {
 233        /* open/release and usage marking */
 234        struct module *owner;
 235        int (*fb_open)(struct fb_info *info, int user);
 236        int (*fb_release)(struct fb_info *info, int user);
 237
 238        /* For framebuffers with strange non linear layouts or that do not
 239         * work with normal memory mapped access
 240         */
 241        ssize_t (*fb_read)(struct fb_info *info, char __user *buf,
 242                           size_t count, loff_t *ppos);
 243        ssize_t (*fb_write)(struct fb_info *info, const char __user *buf,
 244                            size_t count, loff_t *ppos);
 245
 246        /* checks var and eventually tweaks it to something supported,
 247         * DO NOT MODIFY PAR */
 248        int (*fb_check_var)(struct fb_var_screeninfo *var, struct fb_info *info);
 249
 250        /* set the video mode according to info->var */
 251        int (*fb_set_par)(struct fb_info *info);
 252
 253        /* set color register */
 254        int (*fb_setcolreg)(unsigned regno, unsigned red, unsigned green,
 255                            unsigned blue, unsigned transp, struct fb_info *info);
 256
 257        /* set color registers in batch */
 258        int (*fb_setcmap)(struct fb_cmap *cmap, struct fb_info *info);
 259
 260        /* blank display */
 261        int (*fb_blank)(int blank, struct fb_info *info);
 262
 263        /* pan display */
 264        int (*fb_pan_display)(struct fb_var_screeninfo *var, struct fb_info *info);
 265
 266        /* Draws a rectangle */
 267        void (*fb_fillrect) (struct fb_info *info, const struct fb_fillrect *rect);
 268        /* Copy data from area to another */
 269        void (*fb_copyarea) (struct fb_info *info, const struct fb_copyarea *region);
 270        /* Draws a image to the display */
 271        void (*fb_imageblit) (struct fb_info *info, const struct fb_image *image);
 272
 273        /* Draws cursor */
 274        int (*fb_cursor) (struct fb_info *info, struct fb_cursor *cursor);
 275
 276        /* wait for blit idle, optional */
 277        int (*fb_sync)(struct fb_info *info);
 278
 279        /* perform fb specific ioctl (optional) */
 280        int (*fb_ioctl)(struct fb_info *info, unsigned int cmd,
 281                        unsigned long arg);
 282
 283        /* Handle 32bit compat ioctl (optional) */
 284        int (*fb_compat_ioctl)(struct fb_info *info, unsigned cmd,
 285                        unsigned long arg);
 286
 287        /* perform fb specific mmap */
 288        int (*fb_mmap)(struct fb_info *info, struct vm_area_struct *vma);
 289
 290        /* get capability given var */
 291        void (*fb_get_caps)(struct fb_info *info, struct fb_blit_caps *caps,
 292                            struct fb_var_screeninfo *var);
 293
 294        /* teardown any resources to do with this framebuffer */
 295        void (*fb_destroy)(struct fb_info *info);
 296
 297        /* called at KDB enter and leave time to prepare the console */
 298        int (*fb_debug_enter)(struct fb_info *info);
 299        int (*fb_debug_leave)(struct fb_info *info);
 300};
 301
 302#ifdef CONFIG_FB_TILEBLITTING
 303#define FB_TILE_CURSOR_NONE        0
 304#define FB_TILE_CURSOR_UNDERLINE   1
 305#define FB_TILE_CURSOR_LOWER_THIRD 2
 306#define FB_TILE_CURSOR_LOWER_HALF  3
 307#define FB_TILE_CURSOR_TWO_THIRDS  4
 308#define FB_TILE_CURSOR_BLOCK       5
 309
 310struct fb_tilemap {
 311        __u32 width;                /* width of each tile in pixels */
 312        __u32 height;               /* height of each tile in scanlines */
 313        __u32 depth;                /* color depth of each tile */
 314        __u32 length;               /* number of tiles in the map */
 315        const __u8 *data;           /* actual tile map: a bitmap array, packed
 316                                       to the nearest byte */
 317};
 318
 319struct fb_tilerect {
 320        __u32 sx;                   /* origin in the x-axis */
 321        __u32 sy;                   /* origin in the y-axis */
 322        __u32 width;                /* number of tiles in the x-axis */
 323        __u32 height;               /* number of tiles in the y-axis */
 324        __u32 index;                /* what tile to use: index to tile map */
 325        __u32 fg;                   /* foreground color */
 326        __u32 bg;                   /* background color */
 327        __u32 rop;                  /* raster operation */
 328};
 329
 330struct fb_tilearea {
 331        __u32 sx;                   /* source origin in the x-axis */
 332        __u32 sy;                   /* source origin in the y-axis */
 333        __u32 dx;                   /* destination origin in the x-axis */
 334        __u32 dy;                   /* destination origin in the y-axis */
 335        __u32 width;                /* number of tiles in the x-axis */
 336        __u32 height;               /* number of tiles in the y-axis */
 337};
 338
 339struct fb_tileblit {
 340        __u32 sx;                   /* origin in the x-axis */
 341        __u32 sy;                   /* origin in the y-axis */
 342        __u32 width;                /* number of tiles in the x-axis */
 343        __u32 height;               /* number of tiles in the y-axis */
 344        __u32 fg;                   /* foreground color */
 345        __u32 bg;                   /* background color */
 346        __u32 length;               /* number of tiles to draw */
 347        __u32 *indices;             /* array of indices to tile map */
 348};
 349
 350struct fb_tilecursor {
 351        __u32 sx;                   /* cursor position in the x-axis */
 352        __u32 sy;                   /* cursor position in the y-axis */
 353        __u32 mode;                 /* 0 = erase, 1 = draw */
 354        __u32 shape;                /* see FB_TILE_CURSOR_* */
 355        __u32 fg;                   /* foreground color */
 356        __u32 bg;                   /* background color */
 357};
 358
 359struct fb_tile_ops {
 360        /* set tile characteristics */
 361        void (*fb_settile)(struct fb_info *info, struct fb_tilemap *map);
 362
 363        /* all dimensions from hereon are in terms of tiles */
 364
 365        /* move a rectangular region of tiles from one area to another*/
 366        void (*fb_tilecopy)(struct fb_info *info, struct fb_tilearea *area);
 367        /* fill a rectangular region with a tile */
 368        void (*fb_tilefill)(struct fb_info *info, struct fb_tilerect *rect);
 369        /* copy an array of tiles */
 370        void (*fb_tileblit)(struct fb_info *info, struct fb_tileblit *blit);
 371        /* cursor */
 372        void (*fb_tilecursor)(struct fb_info *info,
 373                              struct fb_tilecursor *cursor);
 374        /* get maximum length of the tile map */
 375        int (*fb_get_tilemax)(struct fb_info *info);
 376};
 377#endif /* CONFIG_FB_TILEBLITTING */
 378
 379/* FBINFO_* = fb_info.flags bit flags */
 380#define FBINFO_DEFAULT          0
 381#define FBINFO_HWACCEL_DISABLED 0x0002
 382        /* When FBINFO_HWACCEL_DISABLED is set:
 383         *  Hardware acceleration is turned off.  Software implementations
 384         *  of required functions (copyarea(), fillrect(), and imageblit())
 385         *  takes over; acceleration engine should be in a quiescent state */
 386
 387/* hints */
 388#define FBINFO_VIRTFB           0x0004 /* FB is System RAM, not device. */
 389#define FBINFO_PARTIAL_PAN_OK   0x0040 /* otw use pan only for double-buffering */
 390#define FBINFO_READS_FAST       0x0080 /* soft-copy faster than rendering */
 391
 392/* hardware supported ops */
 393/*  semantics: when a bit is set, it indicates that the operation is
 394 *   accelerated by hardware.
 395 *  required functions will still work even if the bit is not set.
 396 *  optional functions may not even exist if the flag bit is not set.
 397 */
 398#define FBINFO_HWACCEL_NONE             0x0000
 399#define FBINFO_HWACCEL_COPYAREA         0x0100 /* required */
 400#define FBINFO_HWACCEL_FILLRECT         0x0200 /* required */
 401#define FBINFO_HWACCEL_IMAGEBLIT        0x0400 /* required */
 402#define FBINFO_HWACCEL_ROTATE           0x0800 /* optional */
 403#define FBINFO_HWACCEL_XPAN             0x1000 /* optional */
 404#define FBINFO_HWACCEL_YPAN             0x2000 /* optional */
 405#define FBINFO_HWACCEL_YWRAP            0x4000 /* optional */
 406
 407#define FBINFO_MISC_USEREVENT          0x10000 /* event request
 408                                                  from userspace */
 409#define FBINFO_MISC_TILEBLITTING       0x20000 /* use tile blitting */
 410
 411/* A driver may set this flag to indicate that it does want a set_par to be
 412 * called every time when fbcon_switch is executed. The advantage is that with
 413 * this flag set you can really be sure that set_par is always called before
 414 * any of the functions dependent on the correct hardware state or altering
 415 * that state, even if you are using some broken X releases. The disadvantage
 416 * is that it introduces unwanted delays to every console switch if set_par
 417 * is slow. It is a good idea to try this flag in the drivers initialization
 418 * code whenever there is a bug report related to switching between X and the
 419 * framebuffer console.
 420 */
 421#define FBINFO_MISC_ALWAYS_SETPAR   0x40000
 422
 423/* where the fb is a firmware driver, and can be replaced with a proper one */
 424#define FBINFO_MISC_FIRMWARE        0x80000
 425/*
 426 * Host and GPU endianness differ.
 427 */
 428#define FBINFO_FOREIGN_ENDIAN   0x100000
 429/*
 430 * Big endian math. This is the same flags as above, but with different
 431 * meaning, it is set by the fb subsystem depending FOREIGN_ENDIAN flag
 432 * and host endianness. Drivers should not use this flag.
 433 */
 434#define FBINFO_BE_MATH  0x100000
 435/*
 436 * Hide smem_start in the FBIOGET_FSCREENINFO IOCTL. This is used by modern DRM
 437 * drivers to stop userspace from trying to share buffers behind the kernel's
 438 * back. Instead dma-buf based buffer sharing should be used.
 439 */
 440#define FBINFO_HIDE_SMEM_START  0x200000
 441
 442
 443struct fb_info {
 444        atomic_t count;
 445        int node;
 446        int flags;
 447        /*
 448         * -1 by default, set to a FB_ROTATE_* value by the driver, if it knows
 449         * a lcd is not mounted upright and fbcon should rotate to compensate.
 450         */
 451        int fbcon_rotate_hint;
 452        struct mutex lock;              /* Lock for open/release/ioctl funcs */
 453        struct mutex mm_lock;           /* Lock for fb_mmap and smem_* fields */
 454        struct fb_var_screeninfo var;   /* Current var */
 455        struct fb_fix_screeninfo fix;   /* Current fix */
 456        struct fb_monspecs monspecs;    /* Current Monitor specs */
 457        struct work_struct queue;       /* Framebuffer event queue */
 458        struct fb_pixmap pixmap;        /* Image hardware mapper */
 459        struct fb_pixmap sprite;        /* Cursor hardware mapper */
 460        struct fb_cmap cmap;            /* Current cmap */
 461        struct list_head modelist;      /* mode list */
 462        struct fb_videomode *mode;      /* current mode */
 463
 464#if IS_ENABLED(CONFIG_FB_BACKLIGHT)
 465        /* assigned backlight device */
 466        /* set before framebuffer registration, 
 467           remove after unregister */
 468        struct backlight_device *bl_dev;
 469
 470        /* Backlight level curve */
 471        struct mutex bl_curve_mutex;    
 472        u8 bl_curve[FB_BACKLIGHT_LEVELS];
 473#endif
 474#ifdef CONFIG_FB_DEFERRED_IO
 475        struct delayed_work deferred_work;
 476        struct fb_deferred_io *fbdefio;
 477#endif
 478
 479        struct fb_ops *fbops;
 480        struct device *device;          /* This is the parent */
 481        struct device *dev;             /* This is this fb device */
 482        int class_flag;                    /* private sysfs flags */
 483#ifdef CONFIG_FB_TILEBLITTING
 484        struct fb_tile_ops *tileops;    /* Tile Blitting */
 485#endif
 486        union {
 487                char __iomem *screen_base;      /* Virtual address */
 488                char *screen_buffer;
 489        };
 490        unsigned long screen_size;      /* Amount of ioremapped VRAM or 0 */ 
 491        void *pseudo_palette;           /* Fake palette of 16 colors */ 
 492#define FBINFO_STATE_RUNNING    0
 493#define FBINFO_STATE_SUSPENDED  1
 494        u32 state;                      /* Hardware state i.e suspend */
 495        void *fbcon_par;                /* fbcon use-only private area */
 496        /* From here on everything is device dependent */
 497        void *par;
 498        /* we need the PCI or similar aperture base/size not
 499           smem_start/size as smem_start may just be an object
 500           allocated inside the aperture so may not actually overlap */
 501        struct apertures_struct {
 502                unsigned int count;
 503                struct aperture {
 504                        resource_size_t base;
 505                        resource_size_t size;
 506                } ranges[0];
 507        } *apertures;
 508
 509        bool skip_vt_switch; /* no VT switch on suspend/resume required */
 510};
 511
 512static inline struct apertures_struct *alloc_apertures(unsigned int max_num) {
 513        struct apertures_struct *a = kzalloc(sizeof(struct apertures_struct)
 514                        + max_num * sizeof(struct aperture), GFP_KERNEL);
 515        if (!a)
 516                return NULL;
 517        a->count = max_num;
 518        return a;
 519}
 520
 521#define FBINFO_FLAG_DEFAULT     FBINFO_DEFAULT
 522
 523/* This will go away
 524 * fbset currently hacks in FB_ACCELF_TEXT into var.accel_flags
 525 * when it wants to turn the acceleration engine on.  This is
 526 * really a separate operation, and should be modified via sysfs.
 527 *  But for now, we leave it broken with the following define
 528 */
 529#define STUPID_ACCELF_TEXT_SHIT
 530
 531// This will go away
 532#if defined(__sparc__)
 533
 534/* We map all of our framebuffers such that big-endian accesses
 535 * are what we want, so the following is sufficient.
 536 */
 537
 538// This will go away
 539#define fb_readb sbus_readb
 540#define fb_readw sbus_readw
 541#define fb_readl sbus_readl
 542#define fb_readq sbus_readq
 543#define fb_writeb sbus_writeb
 544#define fb_writew sbus_writew
 545#define fb_writel sbus_writel
 546#define fb_writeq sbus_writeq
 547#define fb_memset sbus_memset_io
 548#define fb_memcpy_fromfb sbus_memcpy_fromio
 549#define fb_memcpy_tofb sbus_memcpy_toio
 550
 551#elif defined(__i386__) || defined(__alpha__) || defined(__x86_64__) || \
 552        defined(__hppa__) || defined(__sh__) || defined(__powerpc__) || \
 553        defined(__arm__) || defined(__aarch64__)
 554
 555#define fb_readb __raw_readb
 556#define fb_readw __raw_readw
 557#define fb_readl __raw_readl
 558#define fb_readq __raw_readq
 559#define fb_writeb __raw_writeb
 560#define fb_writew __raw_writew
 561#define fb_writel __raw_writel
 562#define fb_writeq __raw_writeq
 563#define fb_memset memset_io
 564#define fb_memcpy_fromfb memcpy_fromio
 565#define fb_memcpy_tofb memcpy_toio
 566
 567#else
 568
 569#define fb_readb(addr) (*(volatile u8 *) (addr))
 570#define fb_readw(addr) (*(volatile u16 *) (addr))
 571#define fb_readl(addr) (*(volatile u32 *) (addr))
 572#define fb_readq(addr) (*(volatile u64 *) (addr))
 573#define fb_writeb(b,addr) (*(volatile u8 *) (addr) = (b))
 574#define fb_writew(b,addr) (*(volatile u16 *) (addr) = (b))
 575#define fb_writel(b,addr) (*(volatile u32 *) (addr) = (b))
 576#define fb_writeq(b,addr) (*(volatile u64 *) (addr) = (b))
 577#define fb_memset memset
 578#define fb_memcpy_fromfb memcpy
 579#define fb_memcpy_tofb memcpy
 580
 581#endif
 582
 583#define FB_LEFT_POS(p, bpp)          (fb_be_math(p) ? (32 - (bpp)) : 0)
 584#define FB_SHIFT_HIGH(p, val, bits)  (fb_be_math(p) ? (val) >> (bits) : \
 585                                                      (val) << (bits))
 586#define FB_SHIFT_LOW(p, val, bits)   (fb_be_math(p) ? (val) << (bits) : \
 587                                                      (val) >> (bits))
 588
 589    /*
 590     *  `Generic' versions of the frame buffer device operations
 591     */
 592
 593extern int fb_set_var(struct fb_info *info, struct fb_var_screeninfo *var); 
 594extern int fb_pan_display(struct fb_info *info, struct fb_var_screeninfo *var); 
 595extern int fb_blank(struct fb_info *info, int blank);
 596extern void cfb_fillrect(struct fb_info *info, const struct fb_fillrect *rect); 
 597extern void cfb_copyarea(struct fb_info *info, const struct fb_copyarea *area); 
 598extern void cfb_imageblit(struct fb_info *info, const struct fb_image *image);
 599/*
 600 * Drawing operations where framebuffer is in system RAM
 601 */
 602extern void sys_fillrect(struct fb_info *info, const struct fb_fillrect *rect);
 603extern void sys_copyarea(struct fb_info *info, const struct fb_copyarea *area);
 604extern void sys_imageblit(struct fb_info *info, const struct fb_image *image);
 605extern ssize_t fb_sys_read(struct fb_info *info, char __user *buf,
 606                           size_t count, loff_t *ppos);
 607extern ssize_t fb_sys_write(struct fb_info *info, const char __user *buf,
 608                            size_t count, loff_t *ppos);
 609
 610/* drivers/video/fbmem.c */
 611extern int register_framebuffer(struct fb_info *fb_info);
 612extern void unregister_framebuffer(struct fb_info *fb_info);
 613extern void unlink_framebuffer(struct fb_info *fb_info);
 614extern int remove_conflicting_pci_framebuffers(struct pci_dev *pdev, int res_id,
 615                                               const char *name);
 616extern int remove_conflicting_framebuffers(struct apertures_struct *a,
 617                                           const char *name, bool primary);
 618extern int fb_prepare_logo(struct fb_info *fb_info, int rotate);
 619extern int fb_show_logo(struct fb_info *fb_info, int rotate);
 620extern char* fb_get_buffer_offset(struct fb_info *info, struct fb_pixmap *buf, u32 size);
 621extern void fb_pad_unaligned_buffer(u8 *dst, u32 d_pitch, u8 *src, u32 idx,
 622                                u32 height, u32 shift_high, u32 shift_low, u32 mod);
 623extern void fb_pad_aligned_buffer(u8 *dst, u32 d_pitch, u8 *src, u32 s_pitch, u32 height);
 624extern void fb_set_suspend(struct fb_info *info, int state);
 625extern int fb_get_color_depth(struct fb_var_screeninfo *var,
 626                              struct fb_fix_screeninfo *fix);
 627extern int fb_get_options(const char *name, char **option);
 628extern int fb_new_modelist(struct fb_info *info);
 629
 630extern struct fb_info *registered_fb[FB_MAX];
 631extern int num_registered_fb;
 632extern bool fb_center_logo;
 633extern struct class *fb_class;
 634
 635#define for_each_registered_fb(i)               \
 636        for (i = 0; i < FB_MAX; i++)            \
 637                if (!registered_fb[i]) {} else
 638
 639static inline void lock_fb_info(struct fb_info *info)
 640{
 641        mutex_lock(&info->lock);
 642}
 643
 644static inline void unlock_fb_info(struct fb_info *info)
 645{
 646        mutex_unlock(&info->lock);
 647}
 648
 649static inline void __fb_pad_aligned_buffer(u8 *dst, u32 d_pitch,
 650                                           u8 *src, u32 s_pitch, u32 height)
 651{
 652        u32 i, j;
 653
 654        d_pitch -= s_pitch;
 655
 656        for (i = height; i--; ) {
 657                /* s_pitch is a few bytes at the most, memcpy is suboptimal */
 658                for (j = 0; j < s_pitch; j++)
 659                        *dst++ = *src++;
 660                dst += d_pitch;
 661        }
 662}
 663
 664/* drivers/video/fb_defio.c */
 665int fb_deferred_io_mmap(struct fb_info *info, struct vm_area_struct *vma);
 666extern void fb_deferred_io_init(struct fb_info *info);
 667extern void fb_deferred_io_open(struct fb_info *info,
 668                                struct inode *inode,
 669                                struct file *file);
 670extern void fb_deferred_io_cleanup(struct fb_info *info);
 671extern int fb_deferred_io_fsync(struct file *file, loff_t start,
 672                                loff_t end, int datasync);
 673
 674static inline bool fb_be_math(struct fb_info *info)
 675{
 676#ifdef CONFIG_FB_FOREIGN_ENDIAN
 677#if defined(CONFIG_FB_BOTH_ENDIAN)
 678        return info->flags & FBINFO_BE_MATH;
 679#elif defined(CONFIG_FB_BIG_ENDIAN)
 680        return true;
 681#elif defined(CONFIG_FB_LITTLE_ENDIAN)
 682        return false;
 683#endif /* CONFIG_FB_BOTH_ENDIAN */
 684#else
 685#ifdef __BIG_ENDIAN
 686        return true;
 687#else
 688        return false;
 689#endif /* __BIG_ENDIAN */
 690#endif /* CONFIG_FB_FOREIGN_ENDIAN */
 691}
 692
 693/* drivers/video/fbsysfs.c */
 694extern struct fb_info *framebuffer_alloc(size_t size, struct device *dev);
 695extern void framebuffer_release(struct fb_info *info);
 696extern int fb_init_device(struct fb_info *fb_info);
 697extern void fb_cleanup_device(struct fb_info *head);
 698extern void fb_bl_default_curve(struct fb_info *fb_info, u8 off, u8 min, u8 max);
 699
 700/* drivers/video/fbmon.c */
 701#define FB_MAXTIMINGS           0
 702#define FB_VSYNCTIMINGS         1
 703#define FB_HSYNCTIMINGS         2
 704#define FB_DCLKTIMINGS          3
 705#define FB_IGNOREMON            0x100
 706
 707#define FB_MODE_IS_UNKNOWN      0
 708#define FB_MODE_IS_DETAILED     1
 709#define FB_MODE_IS_STANDARD     2
 710#define FB_MODE_IS_VESA         4
 711#define FB_MODE_IS_CALCULATED   8
 712#define FB_MODE_IS_FIRST        16
 713#define FB_MODE_IS_FROM_VAR     32
 714
 715extern int fbmon_dpms(const struct fb_info *fb_info);
 716extern int fb_get_mode(int flags, u32 val, struct fb_var_screeninfo *var,
 717                       struct fb_info *info);
 718extern int fb_validate_mode(const struct fb_var_screeninfo *var,
 719                            struct fb_info *info);
 720extern int fb_parse_edid(unsigned char *edid, struct fb_var_screeninfo *var);
 721extern const unsigned char *fb_firmware_edid(struct device *device);
 722extern void fb_edid_to_monspecs(unsigned char *edid,
 723                                struct fb_monspecs *specs);
 724extern void fb_edid_add_monspecs(unsigned char *edid,
 725                                 struct fb_monspecs *specs);
 726extern void fb_destroy_modedb(struct fb_videomode *modedb);
 727extern int fb_find_mode_cvt(struct fb_videomode *mode, int margins, int rb);
 728extern unsigned char *fb_ddc_read(struct i2c_adapter *adapter);
 729
 730extern int of_get_fb_videomode(struct device_node *np,
 731                               struct fb_videomode *fb,
 732                               int index);
 733extern int fb_videomode_from_videomode(const struct videomode *vm,
 734                                       struct fb_videomode *fbmode);
 735
 736/* drivers/video/modedb.c */
 737#define VESA_MODEDB_SIZE 43
 738#define DMT_SIZE 0x50
 739
 740extern void fb_var_to_videomode(struct fb_videomode *mode,
 741                                const struct fb_var_screeninfo *var);
 742extern void fb_videomode_to_var(struct fb_var_screeninfo *var,
 743                                const struct fb_videomode *mode);
 744extern int fb_mode_is_equal(const struct fb_videomode *mode1,
 745                            const struct fb_videomode *mode2);
 746extern int fb_add_videomode(const struct fb_videomode *mode,
 747                            struct list_head *head);
 748extern void fb_delete_videomode(const struct fb_videomode *mode,
 749                                struct list_head *head);
 750extern const struct fb_videomode *fb_match_mode(const struct fb_var_screeninfo *var,
 751                                                struct list_head *head);
 752extern const struct fb_videomode *fb_find_best_mode(const struct fb_var_screeninfo *var,
 753                                                    struct list_head *head);
 754extern const struct fb_videomode *fb_find_nearest_mode(const struct fb_videomode *mode,
 755                                                       struct list_head *head);
 756extern void fb_destroy_modelist(struct list_head *head);
 757extern void fb_videomode_to_modelist(const struct fb_videomode *modedb, int num,
 758                                     struct list_head *head);
 759extern const struct fb_videomode *fb_find_best_display(const struct fb_monspecs *specs,
 760                                                       struct list_head *head);
 761
 762/* drivers/video/fbcmap.c */
 763extern int fb_alloc_cmap(struct fb_cmap *cmap, int len, int transp);
 764extern int fb_alloc_cmap_gfp(struct fb_cmap *cmap, int len, int transp, gfp_t flags);
 765extern void fb_dealloc_cmap(struct fb_cmap *cmap);
 766extern int fb_copy_cmap(const struct fb_cmap *from, struct fb_cmap *to);
 767extern int fb_cmap_to_user(const struct fb_cmap *from, struct fb_cmap_user *to);
 768extern int fb_set_cmap(struct fb_cmap *cmap, struct fb_info *fb_info);
 769extern int fb_set_user_cmap(struct fb_cmap_user *cmap, struct fb_info *fb_info);
 770extern const struct fb_cmap *fb_default_cmap(int len);
 771extern void fb_invert_cmaps(void);
 772
 773struct fb_videomode {
 774        const char *name;       /* optional */
 775        u32 refresh;            /* optional */
 776        u32 xres;
 777        u32 yres;
 778        u32 pixclock;
 779        u32 left_margin;
 780        u32 right_margin;
 781        u32 upper_margin;
 782        u32 lower_margin;
 783        u32 hsync_len;
 784        u32 vsync_len;
 785        u32 sync;
 786        u32 vmode;
 787        u32 flag;
 788};
 789
 790struct dmt_videomode {
 791        u32 dmt_id;
 792        u32 std_2byte_code;
 793        u32 cvt_3byte_code;
 794        const struct fb_videomode *mode;
 795};
 796
 797extern const char *fb_mode_option;
 798extern const struct fb_videomode vesa_modes[];
 799extern const struct fb_videomode cea_modes[65];
 800extern const struct dmt_videomode dmt_modes[];
 801
 802struct fb_modelist {
 803        struct list_head list;
 804        struct fb_videomode mode;
 805};
 806
 807extern int fb_find_mode(struct fb_var_screeninfo *var,
 808                        struct fb_info *info, const char *mode_option,
 809                        const struct fb_videomode *db,
 810                        unsigned int dbsize,
 811                        const struct fb_videomode *default_mode,
 812                        unsigned int default_bpp);
 813
 814/* Convenience logging macros */
 815#define fb_err(fb_info, fmt, ...)                                       \
 816        pr_err("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
 817#define fb_notice(info, fmt, ...)                                       \
 818        pr_notice("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
 819#define fb_warn(fb_info, fmt, ...)                                      \
 820        pr_warn("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
 821#define fb_info(fb_info, fmt, ...)                                      \
 822        pr_info("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
 823#define fb_dbg(fb_info, fmt, ...)                                       \
 824        pr_debug("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
 825
 826#endif /* _LINUX_FB_H */
 827