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