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