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