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