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