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