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