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