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