blob: dfe88351341fa78f9f6064b5296291cda94cef6f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_FB_H
2#define _LINUX_FB_H
3
Jesse Barnesd219adc2010-08-02 12:05:41 -07004#include <linux/kgdb.h>
David Howells607ca462012-10-13 10:46:48 +01005#include <uapi/linux/fb.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#define FBIO_CURSOR _IOWR('F', 0x08, struct fb_cursor_user)
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
9#include <linux/fs.h>
10#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/workqueue.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/notifier.h>
13#include <linux/list.h>
Michal Januszewski2b257422006-08-13 23:24:26 -070014#include <linux/backlight.h>
Marcin Slusarz1471ca92010-05-16 17:27:03 +020015#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <asm/io.h>
17
18struct vm_area_struct;
19struct fb_info;
20struct device;
21struct file;
Steffen Trumtrar2db54c72012-11-14 10:55:04 +010022struct videomode;
Steffen Trumtrar79089042012-11-14 11:12:38 +010023struct device_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25/* Definitions below are used in the parsed monitor specs */
26#define FB_DPMS_ACTIVE_OFF 1
27#define FB_DPMS_SUSPEND 2
28#define FB_DPMS_STANDBY 4
29
30#define FB_DISP_DDI 1
31#define FB_DISP_ANA_700_300 2
32#define FB_DISP_ANA_714_286 4
33#define FB_DISP_ANA_1000_400 8
34#define FB_DISP_ANA_700_000 16
35
36#define FB_DISP_MONO 32
37#define FB_DISP_RGB 64
38#define FB_DISP_MULTI 128
39#define FB_DISP_UNKNOWN 256
40
41#define FB_SIGNAL_NONE 0
42#define FB_SIGNAL_BLANK_BLANK 1
43#define FB_SIGNAL_SEPARATE 2
44#define FB_SIGNAL_COMPOSITE 4
45#define FB_SIGNAL_SYNC_ON_GREEN 8
46#define FB_SIGNAL_SERRATION_ON 16
47
48#define FB_MISC_PRIM_COLOR 1
49#define FB_MISC_1ST_DETAIL 2 /* First Detailed Timing is preferred */
David Unge6853aa2014-03-26 15:35:37 -070050#define FB_MISC_HDMI 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070051struct fb_chroma {
52 __u32 redx; /* in fraction of 1024 */
53 __u32 greenx;
54 __u32 bluex;
55 __u32 whitex;
56 __u32 redy;
57 __u32 greeny;
58 __u32 bluey;
59 __u32 whitey;
60};
61
62struct fb_monspecs {
63 struct fb_chroma chroma;
64 struct fb_videomode *modedb; /* mode database */
65 __u8 manufacturer[4]; /* Manufacturer */
66 __u8 monitor[14]; /* Monitor String */
67 __u8 serial_no[14]; /* Serial Number */
68 __u8 ascii[14]; /* ? */
69 __u32 modedb_len; /* mode database length */
70 __u32 model; /* Monitor Model */
71 __u32 serial; /* Serial Number - Integer */
72 __u32 year; /* Year manufactured */
73 __u32 week; /* Week Manufactured */
74 __u32 hfmin; /* hfreq lower limit (Hz) */
75 __u32 hfmax; /* hfreq upper limit (Hz) */
76 __u32 dclkmin; /* pixelclock lower limit (Hz) */
77 __u32 dclkmax; /* pixelclock upper limit (Hz) */
78 __u16 input; /* display type - see FB_DISP_* */
79 __u16 dpms; /* DPMS support - see FB_DPMS_ */
80 __u16 signal; /* Signal Type - see FB_SIGNAL_* */
81 __u16 vfmin; /* vfreq lower limit (Hz) */
82 __u16 vfmax; /* vfreq upper limit (Hz) */
83 __u16 gamma; /* Gamma - in fractions of 100 */
84 __u16 gtf : 1; /* supports GTF */
85 __u16 misc; /* Misc flags - see FB_MISC_* */
86 __u8 version; /* EDID version... */
87 __u8 revision; /* ...and revision */
88 __u8 max_x; /* Maximum horizontal size (cm) */
89 __u8 max_y; /* Maximum vertical size (cm) */
90};
91
92struct fb_cmap_user {
93 __u32 start; /* First entry */
94 __u32 len; /* Number of entries */
95 __u16 __user *red; /* Red values */
96 __u16 __user *green;
97 __u16 __user *blue;
98 __u16 __user *transp; /* transparency, can be NULL */
99};
100
101struct fb_image_user {
102 __u32 dx; /* Where to place image */
103 __u32 dy;
104 __u32 width; /* Size of image */
105 __u32 height;
106 __u32 fg_color; /* Only used when a mono bitmap */
107 __u32 bg_color;
108 __u8 depth; /* Depth of the image */
109 const char __user *data; /* Pointer to image data */
110 struct fb_cmap_user cmap; /* color map info */
111};
112
113struct fb_cursor_user {
114 __u16 set; /* what to set */
115 __u16 enable; /* cursor on/off */
116 __u16 rop; /* bitop operation */
117 const char __user *mask; /* cursor mask bits */
118 struct fbcurpos hot; /* cursor hot spot */
119 struct fb_image_user image; /* Cursor image */
120};
121
122/*
123 * Register/unregister for framebuffer events
124 */
125
126/* The resolution of the passed in fb_info about to change */
127#define FB_EVENT_MODE_CHANGE 0x01
128/* The display on this fb_info is beeing suspended, no access to the
129 * framebuffer is allowed any more after that call returns
130 */
131#define FB_EVENT_SUSPEND 0x02
132/* The display on this fb_info was resumed, you can restore the display
133 * if you own it
134 */
135#define FB_EVENT_RESUME 0x03
136/* An entry from the modelist was removed */
137#define FB_EVENT_MODE_DELETE 0x04
138/* A driver registered itself */
139#define FB_EVENT_FB_REGISTERED 0x05
Antonino A. Daplase614b182006-06-26 00:27:09 -0700140/* A driver unregistered itself */
141#define FB_EVENT_FB_UNREGISTERED 0x06
Antonino A. Daplase4fc2762005-11-08 21:39:09 -0800142/* CONSOLE-SPECIFIC: get console to framebuffer mapping */
Antonino A. Daplase614b182006-06-26 00:27:09 -0700143#define FB_EVENT_GET_CONSOLE_MAP 0x07
Antonino A. Daplase4fc2762005-11-08 21:39:09 -0800144/* CONSOLE-SPECIFIC: set console to framebuffer mapping */
Antonino A. Daplase614b182006-06-26 00:27:09 -0700145#define FB_EVENT_SET_CONSOLE_MAP 0x08
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300146/* A hardware display blank change occurred */
Antonino A. Daplase614b182006-06-26 00:27:09 -0700147#define FB_EVENT_BLANK 0x09
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148/* Private modelist is to be replaced */
Antonino A. Daplase614b182006-06-26 00:27:09 -0700149#define FB_EVENT_NEW_MODELIST 0x0A
Antonino A. Daplas7726e9e2005-09-09 13:04:29 -0700150/* The resolution of the passed in fb_info about to change and
151 all vc's should be changed */
Antonino A. Daplase614b182006-06-26 00:27:09 -0700152#define FB_EVENT_MODE_CHANGE_ALL 0x0B
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300153/* A software display blank change occurred */
Richard Purdie994efac2007-02-09 09:46:45 +0000154#define FB_EVENT_CONBLANK 0x0C
Antonino A. Daplas38a3dc52007-05-08 00:39:37 -0700155/* Get drawing requirements */
156#define FB_EVENT_GET_REQ 0x0D
Jesse Barnescfafca82007-07-17 04:05:33 -0700157/* Unbind from the console if possible */
158#define FB_EVENT_FB_UNBIND 0x0E
Lukas Wunnerf15a66e2015-09-05 11:22:39 +0200159/* CONSOLE-SPECIFIC: remap all consoles to new fb - for vga_switcheroo */
Dave Airlie6a9ee8a2010-02-01 15:38:10 +1000160#define FB_EVENT_REMAP_ALL_CONSOLE 0x0F
Inki Daebf059292012-05-29 15:07:12 -0700161/* A hardware display blank early change occured */
162#define FB_EARLY_EVENT_BLANK 0x10
163/* A hardware display blank revert early change occured */
164#define FB_R_EARLY_EVENT_BLANK 0x11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166struct fb_event {
167 struct fb_info *info;
168 void *data;
169};
170
Antonino A. Daplas38a3dc52007-05-08 00:39:37 -0700171struct fb_blit_caps {
172 u32 x;
173 u32 y;
174 u32 len;
175 u32 flags;
176};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Ezequiel Garcia5ec96532015-11-25 00:11:48 -0300178#ifdef CONFIG_FB_NOTIFY
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179extern int fb_register_client(struct notifier_block *nb);
180extern int fb_unregister_client(struct notifier_block *nb);
Antonino A. Daplas256154f2006-07-30 03:04:17 -0700181extern int fb_notifier_call_chain(unsigned long val, void *v);
Ezequiel Garcia5ec96532015-11-25 00:11:48 -0300182#else
183static inline int fb_register_client(struct notifier_block *nb)
184{
185 return 0;
186};
187
188static inline int fb_unregister_client(struct notifier_block *nb)
189{
190 return 0;
191};
192
193static inline int fb_notifier_call_chain(unsigned long val, void *v)
194{
195 return 0;
196};
197#endif
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199/*
200 * Pixmap structure definition
201 *
202 * The purpose of this structure is to translate data
203 * from the hardware independent format of fbdev to what
204 * format the hardware needs.
205 */
206
207#define FB_PIXMAP_DEFAULT 1 /* used internally by fbcon */
208#define FB_PIXMAP_SYSTEM 2 /* memory is in system RAM */
209#define FB_PIXMAP_IO 4 /* memory is iomapped */
210#define FB_PIXMAP_SYNC 256 /* set if GPU can DMA */
211
212struct fb_pixmap {
213 u8 *addr; /* pointer to memory */
214 u32 size; /* size of buffer in bytes */
215 u32 offset; /* current offset to buffer */
216 u32 buf_align; /* byte alignment of each bitmap */
217 u32 scan_align; /* alignment per scanline */
James Simmonsf5a99512005-06-21 17:16:58 -0700218 u32 access_align; /* alignment per read/write (bits) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 u32 flags; /* see FB_PIXMAP_* */
Antonino A. Daplasbf26ad72007-05-08 00:39:09 -0700220 u32 blit_x; /* supported bit block dimensions (1-32)*/
221 u32 blit_y; /* Format: blit_x = 1 << (width - 1) */
222 /* blit_y = 1 << (height - 1) */
223 /* if 0, will be set to 0xffffffff (all)*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 /* access methods */
James Simmonsf5a99512005-06-21 17:16:58 -0700225 void (*writeio)(struct fb_info *info, void __iomem *dst, void *src, unsigned int size);
226 void (*readio) (struct fb_info *info, void *dst, void __iomem *src, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227};
228
Jaya Kumar60b59be2007-05-08 00:37:37 -0700229#ifdef CONFIG_FB_DEFERRED_IO
230struct fb_deferred_io {
231 /* delay between mkwrite and deferred handler */
232 unsigned long delay;
233 struct mutex lock; /* mutex that protects the page list */
234 struct list_head pagelist; /* list of touched pages */
235 /* callback */
Heiko Stübner1f45f9d2012-04-28 12:19:10 +0200236 void (*first_io)(struct fb_info *info);
Jaya Kumar60b59be2007-05-08 00:37:37 -0700237 void (*deferred_io)(struct fb_info *info, struct list_head *pagelist);
238};
239#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
241/*
242 * Frame buffer operations
243 *
244 * LOCKING NOTE: those functions must _ALL_ be called with the console
Adrian Bunkb3c2ffd2006-06-30 18:20:44 +0200245 * semaphore held, this is the only suitable locking mechanism we have
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 * in 2.6. Some may be called at interrupt time at this point though.
Jesse Barnesd219adc2010-08-02 12:05:41 -0700247 *
248 * The exception to this is the debug related hooks. Putting the fb
249 * into a debug state (e.g. flipping to the kernel console) and restoring
250 * it must be done in a lock-free manner, so low level drivers should
251 * keep track of the initial console (if applicable) and may need to
252 * perform direct, unlocked hardware writes in these hooks.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 */
254
255struct fb_ops {
256 /* open/release and usage marking */
257 struct module *owner;
258 int (*fb_open)(struct fb_info *info, int user);
259 int (*fb_release)(struct fb_info *info, int user);
260
261 /* For framebuffers with strange non linear layouts or that do not
262 * work with normal memory mapped access
263 */
Antonino A. Daplas3f9b0882007-05-08 00:39:02 -0700264 ssize_t (*fb_read)(struct fb_info *info, char __user *buf,
265 size_t count, loff_t *ppos);
266 ssize_t (*fb_write)(struct fb_info *info, const char __user *buf,
267 size_t count, loff_t *ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 /* checks var and eventually tweaks it to something supported,
270 * DO NOT MODIFY PAR */
271 int (*fb_check_var)(struct fb_var_screeninfo *var, struct fb_info *info);
272
273 /* set the video mode according to info->var */
274 int (*fb_set_par)(struct fb_info *info);
275
276 /* set color register */
277 int (*fb_setcolreg)(unsigned regno, unsigned red, unsigned green,
278 unsigned blue, unsigned transp, struct fb_info *info);
279
Benjamin Herrenschmidt71494372005-05-01 08:59:22 -0700280 /* set color registers in batch */
281 int (*fb_setcmap)(struct fb_cmap *cmap, struct fb_info *info);
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 /* blank display */
284 int (*fb_blank)(int blank, struct fb_info *info);
285
286 /* pan display */
287 int (*fb_pan_display)(struct fb_var_screeninfo *var, struct fb_info *info);
288
289 /* Draws a rectangle */
290 void (*fb_fillrect) (struct fb_info *info, const struct fb_fillrect *rect);
291 /* Copy data from area to another */
292 void (*fb_copyarea) (struct fb_info *info, const struct fb_copyarea *region);
293 /* Draws a image to the display */
294 void (*fb_imageblit) (struct fb_info *info, const struct fb_image *image);
295
296 /* Draws cursor */
297 int (*fb_cursor) (struct fb_info *info, struct fb_cursor *cursor);
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 /* wait for blit idle, optional */
300 int (*fb_sync)(struct fb_info *info);
301
302 /* perform fb specific ioctl (optional) */
Christoph Hellwig67a66802006-01-14 13:21:25 -0800303 int (*fb_ioctl)(struct fb_info *info, unsigned int cmd,
304 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 /* Handle 32bit compat ioctl (optional) */
Christoph Hellwig67a66802006-01-14 13:21:25 -0800307 int (*fb_compat_ioctl)(struct fb_info *info, unsigned cmd,
308 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310 /* perform fb specific mmap */
Christoph Hellwig216d5262006-01-14 13:21:25 -0800311 int (*fb_mmap)(struct fb_info *info, struct vm_area_struct *vma);
Antonino A. Daplas47434842005-12-12 22:17:16 -0800312
Antonino A. Daplas38a3dc52007-05-08 00:39:37 -0700313 /* get capability given var */
314 void (*fb_get_caps)(struct fb_info *info, struct fb_blit_caps *caps,
315 struct fb_var_screeninfo *var);
Dave Airlie4410f392009-06-16 15:34:38 -0700316
317 /* teardown any resources to do with this framebuffer */
318 void (*fb_destroy)(struct fb_info *info);
Jesse Barnesd219adc2010-08-02 12:05:41 -0700319
320 /* called at KDB enter and leave time to prepare the console */
321 int (*fb_debug_enter)(struct fb_info *info);
322 int (*fb_debug_leave)(struct fb_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323};
324
325#ifdef CONFIG_FB_TILEBLITTING
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326#define FB_TILE_CURSOR_NONE 0
327#define FB_TILE_CURSOR_UNDERLINE 1
328#define FB_TILE_CURSOR_LOWER_THIRD 2
329#define FB_TILE_CURSOR_LOWER_HALF 3
330#define FB_TILE_CURSOR_TWO_THIRDS 4
331#define FB_TILE_CURSOR_BLOCK 5
332
333struct fb_tilemap {
334 __u32 width; /* width of each tile in pixels */
335 __u32 height; /* height of each tile in scanlines */
336 __u32 depth; /* color depth of each tile */
337 __u32 length; /* number of tiles in the map */
Jan Beulich2f4516d2005-09-13 01:25:44 -0700338 const __u8 *data; /* actual tile map: a bitmap array, packed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 to the nearest byte */
340};
341
342struct fb_tilerect {
343 __u32 sx; /* origin in the x-axis */
344 __u32 sy; /* origin in the y-axis */
345 __u32 width; /* number of tiles in the x-axis */
346 __u32 height; /* number of tiles in the y-axis */
347 __u32 index; /* what tile to use: index to tile map */
348 __u32 fg; /* foreground color */
349 __u32 bg; /* background color */
350 __u32 rop; /* raster operation */
351};
352
353struct fb_tilearea {
354 __u32 sx; /* source origin in the x-axis */
355 __u32 sy; /* source origin in the y-axis */
356 __u32 dx; /* destination origin in the x-axis */
357 __u32 dy; /* destination origin in the y-axis */
358 __u32 width; /* number of tiles in the x-axis */
359 __u32 height; /* number of tiles in the y-axis */
360};
361
362struct fb_tileblit {
363 __u32 sx; /* origin in the x-axis */
364 __u32 sy; /* origin in the y-axis */
365 __u32 width; /* number of tiles in the x-axis */
366 __u32 height; /* number of tiles in the y-axis */
367 __u32 fg; /* foreground color */
368 __u32 bg; /* background color */
369 __u32 length; /* number of tiles to draw */
370 __u32 *indices; /* array of indices to tile map */
371};
372
373struct fb_tilecursor {
374 __u32 sx; /* cursor position in the x-axis */
375 __u32 sy; /* cursor position in the y-axis */
376 __u32 mode; /* 0 = erase, 1 = draw */
377 __u32 shape; /* see FB_TILE_CURSOR_* */
378 __u32 fg; /* foreground color */
379 __u32 bg; /* background color */
380};
381
382struct fb_tile_ops {
383 /* set tile characteristics */
384 void (*fb_settile)(struct fb_info *info, struct fb_tilemap *map);
385
386 /* all dimensions from hereon are in terms of tiles */
387
388 /* move a rectangular region of tiles from one area to another*/
389 void (*fb_tilecopy)(struct fb_info *info, struct fb_tilearea *area);
390 /* fill a rectangular region with a tile */
391 void (*fb_tilefill)(struct fb_info *info, struct fb_tilerect *rect);
392 /* copy an array of tiles */
393 void (*fb_tileblit)(struct fb_info *info, struct fb_tileblit *blit);
394 /* cursor */
395 void (*fb_tilecursor)(struct fb_info *info,
396 struct fb_tilecursor *cursor);
Antonino A. Daplas11f11d52007-05-08 00:39:16 -0700397 /* get maximum length of the tile map */
398 int (*fb_get_tilemax)(struct fb_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399};
400#endif /* CONFIG_FB_TILEBLITTING */
401
402/* FBINFO_* = fb_info.flags bit flags */
403#define FBINFO_MODULE 0x0001 /* Low-level driver is a module */
404#define FBINFO_HWACCEL_DISABLED 0x0002
405 /* When FBINFO_HWACCEL_DISABLED is set:
406 * Hardware acceleration is turned off. Software implementations
407 * of required functions (copyarea(), fillrect(), and imageblit())
408 * takes over; acceleration engine should be in a quiescent state */
409
410/* hints */
Konrad Rzeszutek Wilk7164bb42009-12-03 10:31:56 -0500411#define FBINFO_VIRTFB 0x0004 /* FB is System RAM, not device. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412#define FBINFO_PARTIAL_PAN_OK 0x0040 /* otw use pan only for double-buffering */
413#define FBINFO_READS_FAST 0x0080 /* soft-copy faster than rendering */
414
415/* hardware supported ops */
416/* semantics: when a bit is set, it indicates that the operation is
417 * accelerated by hardware.
418 * required functions will still work even if the bit is not set.
419 * optional functions may not even exist if the flag bit is not set.
420 */
421#define FBINFO_HWACCEL_NONE 0x0000
422#define FBINFO_HWACCEL_COPYAREA 0x0100 /* required */
423#define FBINFO_HWACCEL_FILLRECT 0x0200 /* required */
424#define FBINFO_HWACCEL_IMAGEBLIT 0x0400 /* required */
425#define FBINFO_HWACCEL_ROTATE 0x0800 /* optional */
426#define FBINFO_HWACCEL_XPAN 0x1000 /* optional */
427#define FBINFO_HWACCEL_YPAN 0x2000 /* optional */
428#define FBINFO_HWACCEL_YWRAP 0x4000 /* optional */
429
430#define FBINFO_MISC_USEREVENT 0x10000 /* event request
431 from userspace */
432#define FBINFO_MISC_TILEBLITTING 0x20000 /* use tile blitting */
433
Knut Petersen39942fd2005-12-12 22:17:19 -0800434/* A driver may set this flag to indicate that it does want a set_par to be
435 * called every time when fbcon_switch is executed. The advantage is that with
Alexey Dobriyan7f927fc2006-03-28 01:56:53 -0800436 * this flag set you can really be sure that set_par is always called before
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300437 * any of the functions dependent on the correct hardware state or altering
Knut Petersen39942fd2005-12-12 22:17:19 -0800438 * that state, even if you are using some broken X releases. The disadvantage
439 * is that it introduces unwanted delays to every console switch if set_par
440 * is slow. It is a good idea to try this flag in the drivers initialization
441 * code whenever there is a bug report related to switching between X and the
442 * framebuffer console.
443 */
444#define FBINFO_MISC_ALWAYS_SETPAR 0x40000
445
Dave Airlieb26c9492010-06-23 11:35:41 +1000446/* where the fb is a firmware driver, and can be replaced with a proper one */
447#define FBINFO_MISC_FIRMWARE 0x80000
Anton Vorontsove4c690e2008-04-28 02:14:49 -0700448/*
449 * Host and GPU endianness differ.
450 */
451#define FBINFO_FOREIGN_ENDIAN 0x100000
452/*
453 * Big endian math. This is the same flags as above, but with different
454 * meaning, it is set by the fb subsystem depending FOREIGN_ENDIAN flag
455 * and host endianness. Drivers should not use this flag.
456 */
457#define FBINFO_BE_MATH 0x100000
458
Jesse Barnes8fd4bd22010-06-23 12:56:12 -0700459/* report to the VT layer that this fb driver can accept forced console
460 output like oopses */
461#define FBINFO_CAN_FORCE_OUTPUT 0x200000
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463struct fb_info {
Linus Torvalds698b3682011-05-11 14:49:36 -0700464 atomic_t count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 int node;
466 int flags;
Krzysztof Helt3e680aa2008-10-18 20:27:51 -0700467 struct mutex lock; /* Lock for open/release/ioctl funcs */
Krzysztof Helt537a1bf2009-06-30 11:41:29 -0700468 struct mutex mm_lock; /* Lock for fb_mmap and smem_* fields */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 struct fb_var_screeninfo var; /* Current var */
470 struct fb_fix_screeninfo fix; /* Current fix */
471 struct fb_monspecs monspecs; /* Current Monitor specs */
472 struct work_struct queue; /* Framebuffer event queue */
473 struct fb_pixmap pixmap; /* Image hardware mapper */
474 struct fb_pixmap sprite; /* Cursor hardware mapper */
475 struct fb_cmap cmap; /* Current cmap */
476 struct list_head modelist; /* mode list */
477 struct fb_videomode *mode; /* current mode */
Michael Hanselmann5474c122006-06-25 05:47:08 -0700478
479#ifdef CONFIG_FB_BACKLIGHT
Michael Hanselmann5474c122006-06-25 05:47:08 -0700480 /* assigned backlight device */
Richard Purdie37ce69a2007-02-10 14:10:33 +0000481 /* set before framebuffer registration,
482 remove after unregister */
Michael Hanselmann5474c122006-06-25 05:47:08 -0700483 struct backlight_device *bl_dev;
484
485 /* Backlight level curve */
Richard Purdie37ce69a2007-02-10 14:10:33 +0000486 struct mutex bl_curve_mutex;
Michael Hanselmann5474c122006-06-25 05:47:08 -0700487 u8 bl_curve[FB_BACKLIGHT_LEVELS];
488#endif
Jaya Kumar60b59be2007-05-08 00:37:37 -0700489#ifdef CONFIG_FB_DEFERRED_IO
490 struct delayed_work deferred_work;
491 struct fb_deferred_io *fbdefio;
492#endif
Michael Hanselmann5474c122006-06-25 05:47:08 -0700493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 struct fb_ops *fbops;
Greg Kroah-Hartman78cde08872006-09-14 07:30:59 -0700495 struct device *device; /* This is the parent */
496 struct device *dev; /* This is this fb device */
Antonino A. Daplas1a6600b2006-10-03 01:14:50 -0700497 int class_flag; /* private sysfs flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498#ifdef CONFIG_FB_TILEBLITTING
499 struct fb_tile_ops *tileops; /* Tile Blitting */
500#endif
Lars Svensson17a7b0b2015-10-07 09:20:12 +0200501 union {
502 char __iomem *screen_base; /* Virtual address */
503 char *screen_buffer;
504 };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 unsigned long screen_size; /* Amount of ioremapped VRAM or 0 */
506 void *pseudo_palette; /* Fake palette of 16 colors */
507#define FBINFO_STATE_RUNNING 0
508#define FBINFO_STATE_SUSPENDED 1
509 u32 state; /* Hardware state i.e suspend */
510 void *fbcon_par; /* fbcon use-only private area */
511 /* From here on everything is device dependent */
Dave Airlie4410f392009-06-16 15:34:38 -0700512 void *par;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300513 /* we need the PCI or similar aperture base/size not
Dave Airlie4410f392009-06-16 15:34:38 -0700514 smem_start/size as smem_start may just be an object
515 allocated inside the aperture so may not actually overlap */
Marcin Slusarz1471ca92010-05-16 17:27:03 +0200516 struct apertures_struct {
517 unsigned int count;
518 struct aperture {
519 resource_size_t base;
520 resource_size_t size;
521 } ranges[0];
522 } *apertures;
Jesse Barnes3cf26672013-02-04 13:37:21 +0000523
524 bool skip_vt_switch; /* no VT switch on suspend/resume required */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525};
526
Marcin Slusarz1471ca92010-05-16 17:27:03 +0200527static inline struct apertures_struct *alloc_apertures(unsigned int max_num) {
528 struct apertures_struct *a = kzalloc(sizeof(struct apertures_struct)
529 + max_num * sizeof(struct aperture), GFP_KERNEL);
Dan Carpenter772a2f92010-07-15 10:39:47 +0200530 if (!a)
531 return NULL;
Marcin Slusarz1471ca92010-05-16 17:27:03 +0200532 a->count = max_num;
533 return a;
534}
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536#ifdef MODULE
537#define FBINFO_DEFAULT FBINFO_MODULE
538#else
539#define FBINFO_DEFAULT 0
540#endif
541
542// This will go away
543#define FBINFO_FLAG_MODULE FBINFO_MODULE
544#define FBINFO_FLAG_DEFAULT FBINFO_DEFAULT
545
546/* This will go away
547 * fbset currently hacks in FB_ACCELF_TEXT into var.accel_flags
548 * when it wants to turn the acceleration engine on. This is
549 * really a separate operation, and should be modified via sysfs.
550 * But for now, we leave it broken with the following define
551 */
552#define STUPID_ACCELF_TEXT_SHIT
553
554// This will go away
555#if defined(__sparc__)
556
557/* We map all of our framebuffers such that big-endian accesses
558 * are what we want, so the following is sufficient.
559 */
560
561// This will go away
562#define fb_readb sbus_readb
563#define fb_readw sbus_readw
564#define fb_readl sbus_readl
565#define fb_readq sbus_readq
566#define fb_writeb sbus_writeb
567#define fb_writew sbus_writew
568#define fb_writel sbus_writel
569#define fb_writeq sbus_writeq
570#define fb_memset sbus_memset_io
James Hoganf11b4782010-10-27 15:33:28 -0700571#define fb_memcpy_fromfb sbus_memcpy_fromio
572#define fb_memcpy_tofb sbus_memcpy_toio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Archit Taneja981409b2012-11-16 14:46:04 +0530574#elif defined(__i386__) || defined(__alpha__) || defined(__x86_64__) || defined(__hppa__) || defined(__sh__) || defined(__powerpc__) || defined(__avr32__) || defined(__bfin__) || defined(__arm__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576#define fb_readb __raw_readb
577#define fb_readw __raw_readw
578#define fb_readl __raw_readl
579#define fb_readq __raw_readq
580#define fb_writeb __raw_writeb
581#define fb_writew __raw_writew
582#define fb_writel __raw_writel
583#define fb_writeq __raw_writeq
584#define fb_memset memset_io
James Hoganf11b4782010-10-27 15:33:28 -0700585#define fb_memcpy_fromfb memcpy_fromio
586#define fb_memcpy_tofb memcpy_toio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588#else
589
590#define fb_readb(addr) (*(volatile u8 *) (addr))
591#define fb_readw(addr) (*(volatile u16 *) (addr))
592#define fb_readl(addr) (*(volatile u32 *) (addr))
593#define fb_readq(addr) (*(volatile u64 *) (addr))
594#define fb_writeb(b,addr) (*(volatile u8 *) (addr) = (b))
595#define fb_writew(b,addr) (*(volatile u16 *) (addr) = (b))
596#define fb_writel(b,addr) (*(volatile u32 *) (addr) = (b))
597#define fb_writeq(b,addr) (*(volatile u64 *) (addr) = (b))
598#define fb_memset memset
James Hoganf11b4782010-10-27 15:33:28 -0700599#define fb_memcpy_fromfb memcpy
600#define fb_memcpy_tofb memcpy
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602#endif
603
Anton Vorontsove4c690e2008-04-28 02:14:49 -0700604#define FB_LEFT_POS(p, bpp) (fb_be_math(p) ? (32 - (bpp)) : 0)
605#define FB_SHIFT_HIGH(p, val, bits) (fb_be_math(p) ? (val) >> (bits) : \
606 (val) << (bits))
607#define FB_SHIFT_LOW(p, val, bits) (fb_be_math(p) ? (val) << (bits) : \
608 (val) >> (bits))
Antonino A. Daplasbe0d9b62005-12-12 22:17:21 -0800609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 /*
611 * `Generic' versions of the frame buffer device operations
612 */
613
614extern int fb_set_var(struct fb_info *info, struct fb_var_screeninfo *var);
615extern int fb_pan_display(struct fb_info *info, struct fb_var_screeninfo *var);
616extern int fb_blank(struct fb_info *info, int blank);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617extern void cfb_fillrect(struct fb_info *info, const struct fb_fillrect *rect);
618extern void cfb_copyarea(struct fb_info *info, const struct fb_copyarea *area);
619extern void cfb_imageblit(struct fb_info *info, const struct fb_image *image);
Antonino A. Daplas68648ed2007-05-08 00:38:57 -0700620/*
621 * Drawing operations where framebuffer is in system RAM
622 */
623extern void sys_fillrect(struct fb_info *info, const struct fb_fillrect *rect);
624extern void sys_copyarea(struct fb_info *info, const struct fb_copyarea *area);
625extern void sys_imageblit(struct fb_info *info, const struct fb_image *image);
Antonino A. Daplas09aaf262007-05-08 00:39:03 -0700626extern ssize_t fb_sys_read(struct fb_info *info, char __user *buf,
627 size_t count, loff_t *ppos);
628extern ssize_t fb_sys_write(struct fb_info *info, const char __user *buf,
629 size_t count, loff_t *ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631/* drivers/video/fbmem.c */
632extern int register_framebuffer(struct fb_info *fb_info);
633extern int unregister_framebuffer(struct fb_info *fb_info);
Kay Sieversce880cb2012-01-28 19:57:46 +0000634extern int unlink_framebuffer(struct fb_info *fb_info);
Chris Wilson46eeb2c2013-12-16 15:57:39 +0000635extern int remove_conflicting_framebuffers(struct apertures_struct *a,
636 const char *name, bool primary);
Antonino A. Daplas9c44e5f2005-11-08 21:39:10 -0800637extern int fb_prepare_logo(struct fb_info *fb_info, int rotate);
638extern int fb_show_logo(struct fb_info *fb_info, int rotate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639extern char* fb_get_buffer_offset(struct fb_info *info, struct fb_pixmap *buf, u32 size);
James Simmonsf1ab5da2005-06-21 17:17:07 -0700640extern void fb_pad_unaligned_buffer(u8 *dst, u32 d_pitch, u8 *src, u32 idx,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 u32 height, u32 shift_high, u32 shift_low, u32 mod);
James Simmonsf1ab5da2005-06-21 17:17:07 -0700642extern void fb_pad_aligned_buffer(u8 *dst, u32 d_pitch, u8 *src, u32 s_pitch, u32 height);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643extern void fb_set_suspend(struct fb_info *info, int state);
Antonino A. Daplasb8c90942005-09-09 13:04:37 -0700644extern int fb_get_color_depth(struct fb_var_screeninfo *var,
645 struct fb_fix_screeninfo *fix);
Vincent Stehléa66e62a2013-06-18 16:23:05 +0200646extern int fb_get_options(const char *name, char **option);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647extern int fb_new_modelist(struct fb_info *info);
648
649extern struct fb_info *registered_fb[FB_MAX];
650extern int num_registered_fb;
Geert Uytterhoeven9db71a12007-06-01 00:46:46 -0700651extern struct class *fb_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Andrew Morton6a7f2822009-03-31 15:25:19 -0700653extern int lock_fb_info(struct fb_info *info);
Andrea Righi1f5e31d2009-02-04 15:12:03 -0800654
655static inline void unlock_fb_info(struct fb_info *info)
656{
657 mutex_unlock(&info->lock);
658}
659
Antonino A. Daplas829e79b2005-09-09 13:10:04 -0700660static inline void __fb_pad_aligned_buffer(u8 *dst, u32 d_pitch,
661 u8 *src, u32 s_pitch, u32 height)
662{
Brian W Hartee346872014-05-01 14:32:35 -0500663 u32 i, j;
Antonino A. Daplas829e79b2005-09-09 13:10:04 -0700664
665 d_pitch -= s_pitch;
666
667 for (i = height; i--; ) {
668 /* s_pitch is a few bytes at the most, memcpy is suboptimal */
669 for (j = 0; j < s_pitch; j++)
670 *dst++ = *src++;
671 dst += d_pitch;
672 }
673}
674
Jaya Kumar60b59be2007-05-08 00:37:37 -0700675/* drivers/video/fb_defio.c */
676extern void fb_deferred_io_init(struct fb_info *info);
Ian Campbelld8474712008-08-20 14:09:23 -0700677extern void fb_deferred_io_open(struct fb_info *info,
678 struct inode *inode,
679 struct file *file);
Jaya Kumar60b59be2007-05-08 00:37:37 -0700680extern void fb_deferred_io_cleanup(struct fb_info *info);
Josef Bacik02c24a82011-07-16 20:44:56 -0400681extern int fb_deferred_io_fsync(struct file *file, loff_t start,
682 loff_t end, int datasync);
Jaya Kumar60b59be2007-05-08 00:37:37 -0700683
Anton Vorontsove4c690e2008-04-28 02:14:49 -0700684static inline bool fb_be_math(struct fb_info *info)
685{
686#ifdef CONFIG_FB_FOREIGN_ENDIAN
687#if defined(CONFIG_FB_BOTH_ENDIAN)
688 return info->flags & FBINFO_BE_MATH;
689#elif defined(CONFIG_FB_BIG_ENDIAN)
690 return true;
691#elif defined(CONFIG_FB_LITTLE_ENDIAN)
692 return false;
693#endif /* CONFIG_FB_BOTH_ENDIAN */
694#else
695#ifdef __BIG_ENDIAN
696 return true;
697#else
698 return false;
699#endif /* __BIG_ENDIAN */
700#endif /* CONFIG_FB_FOREIGN_ENDIAN */
701}
702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703/* drivers/video/fbsysfs.c */
704extern struct fb_info *framebuffer_alloc(size_t size, struct device *dev);
705extern void framebuffer_release(struct fb_info *info);
Greg Kroah-Hartman78cde08872006-09-14 07:30:59 -0700706extern int fb_init_device(struct fb_info *fb_info);
707extern void fb_cleanup_device(struct fb_info *head);
Michael Hanselmann5474c122006-06-25 05:47:08 -0700708extern void fb_bl_default_curve(struct fb_info *fb_info, u8 off, u8 min, u8 max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710/* drivers/video/fbmon.c */
711#define FB_MAXTIMINGS 0
712#define FB_VSYNCTIMINGS 1
713#define FB_HSYNCTIMINGS 2
714#define FB_DCLKTIMINGS 3
715#define FB_IGNOREMON 0x100
716
717#define FB_MODE_IS_UNKNOWN 0
718#define FB_MODE_IS_DETAILED 1
719#define FB_MODE_IS_STANDARD 2
720#define FB_MODE_IS_VESA 4
721#define FB_MODE_IS_CALCULATED 8
722#define FB_MODE_IS_FIRST 16
723#define FB_MODE_IS_FROM_VAR 32
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725extern int fbmon_dpms(const struct fb_info *fb_info);
726extern int fb_get_mode(int flags, u32 val, struct fb_var_screeninfo *var,
727 struct fb_info *info);
728extern int fb_validate_mode(const struct fb_var_screeninfo *var,
729 struct fb_info *info);
730extern int fb_parse_edid(unsigned char *edid, struct fb_var_screeninfo *var);
Antonino A. Daplas5e518d72005-09-09 13:04:34 -0700731extern const unsigned char *fb_firmware_edid(struct device *device);
732extern void fb_edid_to_monspecs(unsigned char *edid,
733 struct fb_monspecs *specs);
Erik Gilling9fbbdde2010-11-11 15:44:43 +0100734extern void fb_edid_add_monspecs(unsigned char *edid,
735 struct fb_monspecs *specs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736extern void fb_destroy_modedb(struct fb_videomode *modedb);
Antonino A. Daplas96fe6a22005-09-09 13:09:58 -0700737extern int fb_find_mode_cvt(struct fb_videomode *mode, int margins, int rb);
Dennis Munsiefc5891c2006-10-03 01:14:42 -0700738extern unsigned char *fb_ddc_read(struct i2c_adapter *adapter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Steffen Trumtrar79089042012-11-14 11:12:38 +0100740extern int of_get_fb_videomode(struct device_node *np,
741 struct fb_videomode *fb,
742 int index);
Steffen Trumtrar2db54c72012-11-14 10:55:04 +0100743extern int fb_videomode_from_videomode(const struct videomode *vm,
744 struct fb_videomode *fbmode);
745
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746/* drivers/video/modedb.c */
David Ung37715f52015-01-13 19:04:25 -0800747#define VESA_MODEDB_SIZE 43
David Ung8f5ee772015-01-13 19:04:26 -0800748#define DMT_SIZE 0x50
749
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750extern void fb_var_to_videomode(struct fb_videomode *mode,
Geert Uytterhoeven9791d762007-02-12 00:55:19 -0800751 const struct fb_var_screeninfo *var);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752extern void fb_videomode_to_var(struct fb_var_screeninfo *var,
Geert Uytterhoeven9791d762007-02-12 00:55:19 -0800753 const struct fb_videomode *mode);
754extern int fb_mode_is_equal(const struct fb_videomode *mode1,
755 const struct fb_videomode *mode2);
756extern int fb_add_videomode(const struct fb_videomode *mode,
757 struct list_head *head);
758extern void fb_delete_videomode(const struct fb_videomode *mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 struct list_head *head);
Geert Uytterhoeven9791d762007-02-12 00:55:19 -0800760extern const struct fb_videomode *fb_match_mode(const struct fb_var_screeninfo *var,
761 struct list_head *head);
762extern const struct fb_videomode *fb_find_best_mode(const struct fb_var_screeninfo *var,
763 struct list_head *head);
764extern const struct fb_videomode *fb_find_nearest_mode(const struct fb_videomode *mode,
765 struct list_head *head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766extern void fb_destroy_modelist(struct list_head *head);
Geert Uytterhoeven9791d762007-02-12 00:55:19 -0800767extern void fb_videomode_to_modelist(const struct fb_videomode *modedb, int num,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 struct list_head *head);
Geert Uytterhoeven9791d762007-02-12 00:55:19 -0800769extern const struct fb_videomode *fb_find_best_display(const struct fb_monspecs *specs,
770 struct list_head *head);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
772/* drivers/video/fbcmap.c */
773extern int fb_alloc_cmap(struct fb_cmap *cmap, int len, int transp);
Dan Carpenter1e7c7802010-11-16 12:11:02 +0300774extern int fb_alloc_cmap_gfp(struct fb_cmap *cmap, int len, int transp, gfp_t flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775extern void fb_dealloc_cmap(struct fb_cmap *cmap);
Helge Delleradf6b202006-12-08 02:40:27 -0800776extern int fb_copy_cmap(const struct fb_cmap *from, struct fb_cmap *to);
777extern int fb_cmap_to_user(const struct fb_cmap *from, struct fb_cmap_user *to);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778extern int fb_set_cmap(struct fb_cmap *cmap, struct fb_info *fb_info);
779extern int fb_set_user_cmap(struct fb_cmap_user *cmap, struct fb_info *fb_info);
Helge Delleradf6b202006-12-08 02:40:27 -0800780extern const struct fb_cmap *fb_default_cmap(int len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781extern void fb_invert_cmaps(void);
782
783struct fb_videomode {
784 const char *name; /* optional */
785 u32 refresh; /* optional */
786 u32 xres;
787 u32 yres;
788 u32 pixclock;
789 u32 left_margin;
790 u32 right_margin;
791 u32 upper_margin;
792 u32 lower_margin;
793 u32 hsync_len;
794 u32 vsync_len;
795 u32 sync;
796 u32 vmode;
797 u32 flag;
798};
799
David Ung8f5ee772015-01-13 19:04:26 -0800800struct dmt_videomode {
801 u32 dmt_id;
802 u32 std_2byte_code;
803 u32 cvt_3byte_code;
804 const struct fb_videomode *mode;
805};
806
Geert Uytterhoeven9a054fb2007-10-16 01:29:51 -0700807extern const char *fb_mode_option;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808extern const struct fb_videomode vesa_modes[];
Tomi Valkeinen6080a892015-01-15 13:47:19 +0200809extern const struct fb_videomode cea_modes[65];
David Ung8f5ee772015-01-13 19:04:26 -0800810extern const struct dmt_videomode dmt_modes[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
812struct fb_modelist {
813 struct list_head list;
814 struct fb_videomode mode;
815};
816
817extern int fb_find_mode(struct fb_var_screeninfo *var,
818 struct fb_info *info, const char *mode_option,
819 const struct fb_videomode *db,
820 unsigned int dbsize,
821 const struct fb_videomode *default_mode,
822 unsigned int default_bpp);
823
Joe Perchesf51a07d2013-09-19 18:35:54 -0700824/* Convenience logging macros */
825#define fb_err(fb_info, fmt, ...) \
826 pr_err("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
827#define fb_notice(info, fmt, ...) \
828 pr_notice("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
829#define fb_warn(fb_info, fmt, ...) \
830 pr_warn("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
831#define fb_info(fb_info, fmt, ...) \
832 pr_info("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
833#define fb_dbg(fb_info, fmt, ...) \
834 pr_debug("fb%d: " fmt, (fb_info)->node, ##__VA_ARGS__)
835
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836#endif /* _LINUX_FB_H */