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