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