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