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