[mirror_ubuntu-jammy-kernel.git] / drivers / staging / udlfb / udlfb.h

#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 *dev;
	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 device *gdev; /* &udev->dev */
	struct fb_info *info;
	struct urb_list urbs;
	struct kref kref;
	char *backing_buffer;
	struct delayed_work deferred_work;
	struct mutex fb_open_lock;
	int fb_count;
	atomic_t usb_active; /* 0 = update virtual buffer, but no usb traffic */
	atomic_t lost_pixels; /* 1 = a render op failed. Need screen refresh */
	atomic_t use_defio; /* 0 = rely on ioctls and blit/copy/fill rects */
	char edid[128];
	int sku_pixel_limit;
	int base16;
	int base8;
	u32 pseudo_palette[256];
	/* 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 */
};

#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 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)

/* 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(x-(a-1), a)

/* remove once this gets added to sysfs.h */
#define __ATTR_RW(attr) __ATTR(attr, 0644, attr##_show, attr##_store)

#define dl_err(format, arg...) \
	dev_err(dev->gdev, "dlfb: " format, ## arg)
#define dl_warn(format, arg...) \
	dev_warn(dev->gdev, "dlfb: " format, ## arg)
#define dl_notice(format, arg...) \
	dev_notice(dev->gdev, "dlfb: " format, ## arg)
#define dl_info(format, arg...) \
	dev_info(dev->gdev, "dlfb: " format, ## arg)
#endif
Commit	Line	Data
39e7df5d GKH	1	#ifndef UDLFB_H
39e7df5d GKH	2	#define UDLFB_H
88e58b1a	3
530f43a8 BT	4	/*
	5	* TODO: Propose standard fb.h ioctl for reporting damage,
	6	* using _IOWR() and one of the existing area structs from fb.h
	7	* Consider these ioctls deprecated, but they're still used by the
	8	* DisplayLink X server as yet - need both to be modified in tandem
	9	* when new ioctl(s) are ready.
	10	*/
	11	#define DLFB_IOCTL_RETURN_EDID 0xAD
	12	#define DLFB_IOCTL_REPORT_DAMAGE 0xAA
	13	struct dloarea {
	14	int x, y;
	15	int w, h;
	16	int x2, y2;
	17	};
88e58b1a	18
4a4854dd BT	19	struct urb_node {
	20	struct list_head entry;
	21	struct dlfb_data *dev;
	22	struct urb *urb;
	23	};
	24
	25	struct urb_list {
	26	struct list_head list;
	27	spinlock_t lock;
	28	struct semaphore limit_sem;
	29	int available;
	30	int count;
	31	size_t size;
	32	};
	33
88e58b1a RDI	34	struct dlfb_data {
88e58b1a RDI	35	struct usb_device *udev;
4a4854dd	36	struct device gdev; / &udev->dev */
88e58b1a	37	struct fb_info *info;
4a4854dd BT	38	struct urb_list urbs;
4a4854dd BT	39	struct kref kref;
88e58b1a	40	char *backing_buffer;
2469d5db BT	41	struct delayed_work deferred_work;
2469d5db BT	42	struct mutex fb_open_lock;
7d9485e2 BT	43	int fb_count;
7d9485e2 BT	44	atomic_t usb_active; /* 0 = update virtual buffer, but no usb traffic */
4a4854dd	45	atomic_t lost_pixels; /* 1 = a render op failed. Need screen refresh */
7d9485e2	46	atomic_t use_defio; /* 0 = rely on ioctls and blit/copy/fill rects */
88e58b1a	47	char edid[128];
7d9485e2	48	int sku_pixel_limit;
88e58b1a RDI	49	int base16;
88e58b1a RDI	50	int base8;
59277b67	51	u32 pseudo_palette[256];
7d9485e2 BT	52	/* blit-only rendering path metrics, exposed through sysfs */
	53	atomic_t bytes_rendered; /* raw pixel-bytes driver asked to render */
	54	atomic_t bytes_identical; /* saved effort with backbuffer comparison */
	55	atomic_t bytes_sent; /* to usb, after compression including overhead */
	56	atomic_t cpu_kcycles_used; /* transpired during pixel processing */
88e58b1a RDI	57	};
88e58b1a RDI	58
cc403dc6 BT	59	#define NR_USB_REQUEST_I2C_SUB_IO 0x02
	60	#define NR_USB_REQUEST_CHANNEL 0x12
	61
4a4854dd BT	62	/* -BULK_SIZE as per usb-skeleton. Can we get full page and avoid overhead? */
	63	#define BULK_SIZE 512
	64	#define MAX_TRANSFER (PAGE_SIZE*16 - BULK_SIZE)
	65	#define WRITES_IN_FLIGHT (4)
	66
	67	#define GET_URB_TIMEOUT HZ
	68	#define FREE_URB_TIMEOUT (HZ*2)
	69
530f43a8 BT	70	#define BPP 2
530f43a8 BT	71	#define MAX_CMD_PIXELS 255
88e58b1a	72
530f43a8 BT	73	#define RLX_HEADER_BYTES 7
	74	#define MIN_RLX_PIX_BYTES 4
	75	#define MIN_RLX_CMD_BYTES (RLX_HEADER_BYTES + MIN_RLX_PIX_BYTES)
88e58b1a	76
530f43a8 BT	77	#define RLE_HEADER_BYTES 6
	78	#define MIN_RLE_PIX_BYTES 3
	79	#define MIN_RLE_CMD_BYTES (RLE_HEADER_BYTES + MIN_RLE_PIX_BYTES)
88e58b1a	80
530f43a8 BT	81	#define RAW_HEADER_BYTES 6
	82	#define MIN_RAW_PIX_BYTES 2
	83	#define MIN_RAW_CMD_BYTES (RAW_HEADER_BYTES + MIN_RAW_PIX_BYTES)
88e58b1a	84
530f43a8 BT	85	/* remove these once align.h patch is taken into kernel */
	86	#define DL_ALIGN_UP(x, a) ALIGN(x, a)
	87	#define DL_ALIGN_DOWN(x, a) ALIGN(x-(a-1), a)
39e7df5d	88
7d9485e2 BT	89	/* remove once this gets added to sysfs.h */
	90	#define __ATTR_RW(attr) __ATTR(attr, 0644, attr##_show, attr##_store)
	91
4a4854dd BT	92	#define dl_err(format, arg...) \
	93	dev_err(dev->gdev, "dlfb: " format, ## arg)
	94	#define dl_warn(format, arg...) \
	95	dev_warn(dev->gdev, "dlfb: " format, ## arg)
	96	#define dl_notice(format, arg...) \
	97	dev_notice(dev->gdev, "dlfb: " format, ## arg)
	98	#define dl_info(format, arg...) \
	99	dev_info(dev->gdev, "dlfb: " format, ## arg)
39e7df5d	100	#endif