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