[mirror_ubuntu-jammy-kernel.git] / include / video / udlfb.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef UDLFB_H
#define UDLFB_H

/*
 * TODO: Propose standard fb.h ioctl for reporting damage,
 * using _IOWR() and one of the existing area structs from fb.h
 * Consider these ioctls deprecated, but they're still used by the
 * DisplayLink X server as yet - need both to be modified in tandem
 * when new ioctl(s) are ready.
 */
#define DLFB_IOCTL_RETURN_EDID	 0xAD
#define DLFB_IOCTL_REPORT_DAMAGE 0xAA
struct dloarea {
	int x, y;
	int w, h;
	int x2, y2;
};

struct urb_node {
	struct list_head entry;
	struct dlfb_data *dlfb;
	struct urb *urb;
};

struct urb_list {
	struct list_head list;
	spinlock_t lock;
	struct semaphore limit_sem;
	int available;
	int count;
	size_t size;
};

struct dlfb_data {
	struct usb_device *udev;
	struct fb_info *info;
	struct urb_list urbs;
	char *backing_buffer;
	int fb_count;
	bool virtualized; /* true when physical usb device not present */
	atomic_t usb_active; /* 0 = update virtual buffer, but no usb traffic */
	atomic_t lost_pixels; /* 1 = a render op failed. Need screen refresh */
	char *edid; /* null until we read edid from hw or get from sysfs */
	size_t edid_size;
	int sku_pixel_limit;
	int base16;
	int base8;
	u32 pseudo_palette[256];
	int blank_mode; /*one of FB_BLANK_ */
	int damage_x;
	int damage_y;
	int damage_x2;
	int damage_y2;
	spinlock_t damage_lock;
	struct work_struct damage_work;
	struct fb_ops ops;
	/* blit-only rendering path metrics, exposed through sysfs */
	atomic_t bytes_rendered; /* raw pixel-bytes driver asked to render */
	atomic_t bytes_identical; /* saved effort with backbuffer comparison */
	atomic_t bytes_sent; /* to usb, after compression including overhead */
	atomic_t cpu_kcycles_used; /* transpired during pixel processing */
	struct fb_var_screeninfo current_mode;
	struct list_head deferred_free;
};

#define NR_USB_REQUEST_I2C_SUB_IO 0x02
#define NR_USB_REQUEST_CHANNEL 0x12

/* -BULK_SIZE as per usb-skeleton. Can we get full page and avoid overhead? */
#define BULK_SIZE 512
#define MAX_TRANSFER (PAGE_SIZE*16 - BULK_SIZE)
#define WRITES_IN_FLIGHT (4)

#define MAX_VENDOR_DESCRIPTOR_SIZE 256

#define GET_URB_TIMEOUT	HZ
#define FREE_URB_TIMEOUT (HZ*2)

#define BPP                     2
#define MAX_CMD_PIXELS		255

#define RLX_HEADER_BYTES	7
#define MIN_RLX_PIX_BYTES       4
#define MIN_RLX_CMD_BYTES	(RLX_HEADER_BYTES + MIN_RLX_PIX_BYTES)

#define RLE_HEADER_BYTES	6
#define MIN_RLE_PIX_BYTES	3
#define MIN_RLE_CMD_BYTES	(RLE_HEADER_BYTES + MIN_RLE_PIX_BYTES)

#define RAW_HEADER_BYTES	6
#define MIN_RAW_PIX_BYTES	2
#define MIN_RAW_CMD_BYTES	(RAW_HEADER_BYTES + MIN_RAW_PIX_BYTES)

#define DL_DEFIO_WRITE_DELAY    msecs_to_jiffies(HZ <= 300 ? 4 : 10) /* optimal value for 720p video */
#define DL_DEFIO_WRITE_DISABLE  (HZ*60) /* "disable" with long delay */

/* remove these once align.h patch is taken into kernel */
#define DL_ALIGN_UP(x, a) ALIGN(x, a)
#define DL_ALIGN_DOWN(x, a) ALIGN_DOWN(x, a)

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
39e7df5d GKH	2	#ifndef UDLFB_H
39e7df5d GKH	3	#define UDLFB_H
88e58b1a	4
530f43a8 BT	5	/*
	6	* TODO: Propose standard fb.h ioctl for reporting damage,
	7	* using _IOWR() and one of the existing area structs from fb.h
	8	* Consider these ioctls deprecated, but they're still used by the
	9	* DisplayLink X server as yet - need both to be modified in tandem
	10	* when new ioctl(s) are ready.
	11	*/
	12	#define DLFB_IOCTL_RETURN_EDID 0xAD
	13	#define DLFB_IOCTL_REPORT_DAMAGE 0xAA
	14	struct dloarea {
	15	int x, y;
	16	int w, h;
	17	int x2, y2;
	18	};
88e58b1a	19
4a4854dd BT	20	struct urb_node {
4a4854dd BT	21	struct list_head entry;
7ea46206	22	struct dlfb_data *dlfb;
4a4854dd BT	23	struct urb *urb;
	24	};
	25
	26	struct urb_list {
	27	struct list_head list;
	28	spinlock_t lock;
	29	struct semaphore limit_sem;
	30	int available;
	31	int count;
	32	size_t size;
	33	};
	34
88e58b1a RDI	35	struct dlfb_data {
88e58b1a RDI	36	struct usb_device *udev;
88e58b1a	37	struct fb_info *info;
4a4854dd	38	struct urb_list urbs;
88e58b1a	39	char *backing_buffer;
7d9485e2	40	int fb_count;
33077b8d	41	bool virtualized; /* true when physical usb device not present */
7d9485e2	42	atomic_t usb_active; /* 0 = update virtual buffer, but no usb traffic */
4a4854dd	43	atomic_t lost_pixels; /* 1 = a render op failed. Need screen refresh */
18dffdf8 BT	44	char edid; / null until we read edid from hw or get from sysfs */
18dffdf8 BT	45	size_t edid_size;
7d9485e2	46	int sku_pixel_limit;
88e58b1a RDI	47	int base16;
88e58b1a RDI	48	int base8;
59277b67	49	u32 pseudo_palette[256];
58e7c3b0	50	int blank_mode; /one of FB_BLANK_ /
6b11f9d8 MP	51	int damage_x;
	52	int damage_y;
	53	int damage_x2;
	54	int damage_y2;
	55	spinlock_t damage_lock;
	56	struct work_struct damage_work;
2c29cfc3	57	struct fb_ops ops;
7d9485e2 BT	58	/* blit-only rendering path metrics, exposed through sysfs */
	59	atomic_t bytes_rendered; /* raw pixel-bytes driver asked to render */
	60	atomic_t bytes_identical; /* saved effort with backbuffer comparison */
	61	atomic_t bytes_sent; /* to usb, after compression including overhead */
	62	atomic_t cpu_kcycles_used; /* transpired during pixel processing */
564f1807	63	struct fb_var_screeninfo current_mode;
7433914e	64	struct list_head deferred_free;
88e58b1a RDI	65	};
88e58b1a RDI	66
cc403dc6 BT	67	#define NR_USB_REQUEST_I2C_SUB_IO 0x02
	68	#define NR_USB_REQUEST_CHANNEL 0x12
	69
4a4854dd BT	70	/* -BULK_SIZE as per usb-skeleton. Can we get full page and avoid overhead? */
	71	#define BULK_SIZE 512
	72	#define MAX_TRANSFER (PAGE_SIZE*16 - BULK_SIZE)
	73	#define WRITES_IN_FLIGHT (4)
	74
18dffdf8 BT	75	#define MAX_VENDOR_DESCRIPTOR_SIZE 256
18dffdf8 BT	76
4a4854dd BT	77	#define GET_URB_TIMEOUT HZ
	78	#define FREE_URB_TIMEOUT (HZ*2)
	79
530f43a8 BT	80	#define BPP 2
530f43a8 BT	81	#define MAX_CMD_PIXELS 255
88e58b1a	82
530f43a8 BT	83	#define RLX_HEADER_BYTES 7
	84	#define MIN_RLX_PIX_BYTES 4
	85	#define MIN_RLX_CMD_BYTES (RLX_HEADER_BYTES + MIN_RLX_PIX_BYTES)
88e58b1a	86
530f43a8 BT	87	#define RLE_HEADER_BYTES 6
	88	#define MIN_RLE_PIX_BYTES 3
	89	#define MIN_RLE_CMD_BYTES (RLE_HEADER_BYTES + MIN_RLE_PIX_BYTES)
88e58b1a	90
530f43a8 BT	91	#define RAW_HEADER_BYTES 6
	92	#define MIN_RAW_PIX_BYTES 2
	93	#define MIN_RAW_CMD_BYTES (RAW_HEADER_BYTES + MIN_RAW_PIX_BYTES)
88e58b1a	94
bb24153a	95	#define DL_DEFIO_WRITE_DELAY msecs_to_jiffies(HZ <= 300 ? 4 : 10) /* optimal value for 720p video */
5bea1fbf BT	96	#define DL_DEFIO_WRITE_DISABLE (HZ60) / "disable" with long delay */
5bea1fbf BT	97
530f43a8 BT	98	/* remove these once align.h patch is taken into kernel */
530f43a8 BT	99	#define DL_ALIGN_UP(x, a) ALIGN(x, a)
ed067d4a	100	#define DL_ALIGN_DOWN(x, a) ALIGN_DOWN(x, a)
39e7df5d GKH	101
39e7df5d GKH	102	#endif