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