[deliverable/linux.git] / drivers / gpu / drm / udl / udl_main.c

/*
 * Copyright (C) 2012 Red Hat
 *
 * based in parts on udlfb.c:
 * Copyright (C) 2009 Roberto De Ioris <roberto@unbit.it>
 * Copyright (C) 2009 Jaya Kumar <jayakumar.lkml@gmail.com>
 * Copyright (C) 2009 Bernie Thompson <bernie@plugable.com>
 *
 * This file is subject to the terms and conditions of the GNU General Public
 * License v2. See the file COPYING in the main directory of this archive for
 * more details.
 */
#include <drm/drmP.h>
#include "udl_drv.h"

/* -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)

static int udl_parse_vendor_descriptor(struct drm_device *dev,
				       struct usb_device *usbdev)
{
	struct udl_device *udl = dev->dev_private;
	char *desc;
	char *buf;
	char *desc_end;

	u8 total_len = 0;

	buf = kzalloc(MAX_VENDOR_DESCRIPTOR_SIZE, GFP_KERNEL);
	if (!buf)
		return false;
	desc = buf;

	total_len = usb_get_descriptor(usbdev, 0x5f, /* vendor specific */
				    0, desc, MAX_VENDOR_DESCRIPTOR_SIZE);
	if (total_len > 5) {
		DRM_INFO("vendor descriptor length:%x data:%11ph\n",
			total_len, desc);

		if ((desc[0] != total_len) || /* descriptor length */
		    (desc[1] != 0x5f) ||   /* vendor descriptor type */
		    (desc[2] != 0x01) ||   /* version (2 bytes) */
		    (desc[3] != 0x00) ||
		    (desc[4] != total_len - 2)) /* length after type */
			goto unrecognized;

		desc_end = desc + total_len;
		desc += 5; /* the fixed header we've already parsed */

		while (desc < desc_end) {
			u8 length;
			u16 key;

			key = le16_to_cpu(*((u16 *) desc));
			desc += sizeof(u16);
			length = *desc;
			desc++;

			switch (key) {
			case 0x0200: { /* max_area */
				u32 max_area;
				max_area = le32_to_cpu(*((u32 *)desc));
				DRM_DEBUG("DL chip limited to %d pixel modes\n",
					max_area);
				udl->sku_pixel_limit = max_area;
				break;
			}
			default:
				break;
			}
			desc += length;
		}
	}

	goto success;

unrecognized:
	/* allow udlfb to load for now even if firmware unrecognized */
	DRM_ERROR("Unrecognized vendor firmware descriptor\n");

success:
	kfree(buf);
	return true;
}

static void udl_release_urb_work(struct work_struct *work)
{
	struct urb_node *unode = container_of(work, struct urb_node,
					      release_urb_work.work);

	up(&unode->dev->urbs.limit_sem);
}

void udl_urb_completion(struct urb *urb)
{
	struct urb_node *unode = urb->context;
	struct udl_device *udl = unode->dev;
	unsigned long flags;

	/* sync/async unlink faults aren't errors */
	if (urb->status) {
		if (!(urb->status == -ENOENT ||
		    urb->status == -ECONNRESET ||
		    urb->status == -ESHUTDOWN)) {
			DRM_ERROR("%s - nonzero write bulk status received: %d\n",
				__func__, urb->status);
			atomic_set(&udl->lost_pixels, 1);
		}
	}

	urb->transfer_buffer_length = udl->urbs.size; /* reset to actual */

	spin_lock_irqsave(&udl->urbs.lock, flags);
	list_add_tail(&unode->entry, &udl->urbs.list);
	udl->urbs.available++;
	spin_unlock_irqrestore(&udl->urbs.lock, flags);

#if 0
	/*
	 * When using fb_defio, we deadlock if up() is called
	 * while another is waiting. So queue to another process.
	 */
	if (fb_defio)
		schedule_delayed_work(&unode->release_urb_work, 0);
	else
#endif
		up(&udl->urbs.limit_sem);
}

static void udl_free_urb_list(struct drm_device *dev)
{
	struct udl_device *udl = dev->dev_private;
	int count = udl->urbs.count;
	struct list_head *node;
	struct urb_node *unode;
	struct urb *urb;
	int ret;
	unsigned long flags;

	DRM_DEBUG("Waiting for completes and freeing all render urbs\n");

	/* keep waiting and freeing, until we've got 'em all */
	while (count--) {

		/* Getting interrupted means a leak, but ok at shutdown*/
		ret = down_interruptible(&udl->urbs.limit_sem);
		if (ret)
			break;

		spin_lock_irqsave(&udl->urbs.lock, flags);

		node = udl->urbs.list.next; /* have reserved one with sem */
		list_del_init(node);

		spin_unlock_irqrestore(&udl->urbs.lock, flags);

		unode = list_entry(node, struct urb_node, entry);
		urb = unode->urb;

		/* Free each separately allocated piece */
		usb_free_coherent(urb->dev, udl->urbs.size,
				  urb->transfer_buffer, urb->transfer_dma);
		usb_free_urb(urb);
		kfree(node);
	}
	udl->urbs.count = 0;
}

static int udl_alloc_urb_list(struct drm_device *dev, int count, size_t size)
{
	struct udl_device *udl = dev->dev_private;
	int i = 0;
	struct urb *urb;
	struct urb_node *unode;
	char *buf;

	spin_lock_init(&udl->urbs.lock);

	udl->urbs.size = size;
	INIT_LIST_HEAD(&udl->urbs.list);

	while (i < count) {
		unode = kzalloc(sizeof(struct urb_node), GFP_KERNEL);
		if (!unode)
			break;
		unode->dev = udl;

		INIT_DELAYED_WORK(&unode->release_urb_work,
			  udl_release_urb_work);

		urb = usb_alloc_urb(0, GFP_KERNEL);
		if (!urb) {
			kfree(unode);
			break;
		}
		unode->urb = urb;

		buf = usb_alloc_coherent(udl->udev, MAX_TRANSFER, GFP_KERNEL,
					 &urb->transfer_dma);
		if (!buf) {
			kfree(unode);
			usb_free_urb(urb);
			break;
		}

		/* urb->transfer_buffer_length set to actual before submit */
		usb_fill_bulk_urb(urb, udl->udev, usb_sndbulkpipe(udl->udev, 1),
			buf, size, udl_urb_completion, unode);
		urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;

		list_add_tail(&unode->entry, &udl->urbs.list);

		i++;
	}

	sema_init(&udl->urbs.limit_sem, i);
	udl->urbs.count = i;
	udl->urbs.available = i;

	DRM_DEBUG("allocated %d %d byte urbs\n", i, (int) size);

	return i;
}

struct urb *udl_get_urb(struct drm_device *dev)
{
	struct udl_device *udl = dev->dev_private;
	int ret = 0;
	struct list_head *entry;
	struct urb_node *unode;
	struct urb *urb = NULL;
	unsigned long flags;

	/* Wait for an in-flight buffer to complete and get re-queued */
	ret = down_timeout(&udl->urbs.limit_sem, GET_URB_TIMEOUT);
	if (ret) {
		atomic_set(&udl->lost_pixels, 1);
		DRM_INFO("wait for urb interrupted: %x available: %d\n",
		       ret, udl->urbs.available);
		goto error;
	}

	spin_lock_irqsave(&udl->urbs.lock, flags);

	BUG_ON(list_empty(&udl->urbs.list)); /* reserved one with limit_sem */
	entry = udl->urbs.list.next;
	list_del_init(entry);
	udl->urbs.available--;

	spin_unlock_irqrestore(&udl->urbs.lock, flags);

	unode = list_entry(entry, struct urb_node, entry);
	urb = unode->urb;

error:
	return urb;
}

int udl_submit_urb(struct drm_device *dev, struct urb *urb, size_t len)
{
	struct udl_device *udl = dev->dev_private;
	int ret;

	BUG_ON(len > udl->urbs.size);

	urb->transfer_buffer_length = len; /* set to actual payload len */
	ret = usb_submit_urb(urb, GFP_ATOMIC);
	if (ret) {
		udl_urb_completion(urb); /* because no one else will */
		atomic_set(&udl->lost_pixels, 1);
		DRM_ERROR("usb_submit_urb error %x\n", ret);
	}
	return ret;
}

int udl_driver_load(struct drm_device *dev, unsigned long flags)
{
	struct usb_device *udev = (void*)flags;
	struct udl_device *udl;
	int ret = -ENOMEM;

	DRM_DEBUG("\n");
	udl = kzalloc(sizeof(struct udl_device), GFP_KERNEL);
	if (!udl)
		return -ENOMEM;

	udl->udev = udev;
	udl->ddev = dev;
	dev->dev_private = udl;

	if (!udl_parse_vendor_descriptor(dev, udl->udev)) {
		ret = -ENODEV;
		DRM_ERROR("firmware not recognized. Assume incompatible device\n");
		goto err;
	}

	if (!udl_alloc_urb_list(dev, WRITES_IN_FLIGHT, MAX_TRANSFER)) {
		DRM_ERROR("udl_alloc_urb_list failed\n");
		goto err;
	}

	DRM_DEBUG("\n");
	ret = udl_modeset_init(dev);
	if (ret)
		goto err;

	ret = udl_fbdev_init(dev);
	if (ret)
		goto err;

	ret = drm_vblank_init(dev, 1);
	if (ret)
		goto err_fb;

	return 0;
err_fb:
	udl_fbdev_cleanup(dev);
err:
	if (udl->urbs.count)
		udl_free_urb_list(dev);
	kfree(udl);
	DRM_ERROR("%d\n", ret);
	return ret;
}

int udl_drop_usb(struct drm_device *dev)
{
	udl_free_urb_list(dev);
	return 0;
}

int udl_driver_unload(struct drm_device *dev)
{
	struct udl_device *udl = dev->dev_private;

	drm_vblank_cleanup(dev);

	if (udl->urbs.count)
		udl_free_urb_list(dev);

	udl_fbdev_cleanup(dev);
	udl_modeset_cleanup(dev);
	kfree(udl);
	return 0;
}
Commit	Line	Data
5320918b DA	1	/*
	2	* Copyright (C) 2012 Red Hat
	3	*
	4	* based in parts on udlfb.c:
	5	* Copyright (C) 2009 Roberto De Ioris <roberto@unbit.it>
	6	* Copyright (C) 2009 Jaya Kumar <jayakumar.lkml@gmail.com>
	7	* Copyright (C) 2009 Bernie Thompson <bernie@plugable.com>
	8	*
	9	* This file is subject to the terms and conditions of the GNU General Public
	10	* License v2. See the file COPYING in the main directory of this archive for
	11	* more details.
	12	*/
760285e7	13	#include <drm/drmP.h>
5320918b DA	14	#include "udl_drv.h"
	15
	16	/* -BULK_SIZE as per usb-skeleton. Can we get full page and avoid overhead? */
	17	#define BULK_SIZE 512
	18
	19	#define MAX_TRANSFER (PAGE_SIZE*16 - BULK_SIZE)
	20	#define WRITES_IN_FLIGHT (4)
	21	#define MAX_VENDOR_DESCRIPTOR_SIZE 256
	22
	23	#define GET_URB_TIMEOUT HZ
	24	#define FREE_URB_TIMEOUT (HZ*2)
	25
	26	static int udl_parse_vendor_descriptor(struct drm_device *dev,
	27	struct usb_device *usbdev)
	28	{
	29	struct udl_device *udl = dev->dev_private;
	30	char *desc;
	31	char *buf;
	32	char *desc_end;
	33
	34	u8 total_len = 0;
	35
	36	buf = kzalloc(MAX_VENDOR_DESCRIPTOR_SIZE, GFP_KERNEL);
	37	if (!buf)
	38	return false;
	39	desc = buf;
	40
	41	total_len = usb_get_descriptor(usbdev, 0x5f, /* vendor specific */
	42	0, desc, MAX_VENDOR_DESCRIPTOR_SIZE);
	43	if (total_len > 5) {
08fcd72b AS	44	DRM_INFO("vendor descriptor length:%x data:%11ph\n",
08fcd72b AS	45	total_len, desc);
5320918b DA	46
	47	if ((desc[0] != total_len) \|\| /* descriptor length */
	48	(desc[1] != 0x5f) \|\| /* vendor descriptor type */
	49	(desc[2] != 0x01) \|\| /* version (2 bytes) */
	50	(desc[3] != 0x00) \|\|
	51	(desc[4] != total_len - 2)) /* length after type */
	52	goto unrecognized;
	53
	54	desc_end = desc + total_len;
	55	desc += 5; /* the fixed header we've already parsed */
	56
	57	while (desc < desc_end) {
	58	u8 length;
	59	u16 key;
	60
d42f0349	61	key = le16_to_cpu(((u16 ) desc));
5320918b DA	62	desc += sizeof(u16);
	63	length = *desc;
	64	desc++;
	65
	66	switch (key) {
	67	case 0x0200: { /* max_area */
	68	u32 max_area;
	69	max_area = le32_to_cpu(((u32 )desc));
	70	DRM_DEBUG("DL chip limited to %d pixel modes\n",
	71	max_area);
	72	udl->sku_pixel_limit = max_area;
	73	break;
	74	}
	75	default:
	76	break;
	77	}
	78	desc += length;
	79	}
	80	}
	81
	82	goto success;
	83
	84	unrecognized:
	85	/* allow udlfb to load for now even if firmware unrecognized */
	86	DRM_ERROR("Unrecognized vendor firmware descriptor\n");
	87
	88	success:
	89	kfree(buf);
	90	return true;
	91	}
	92
	93	static void udl_release_urb_work(struct work_struct *work)
	94	{
	95	struct urb_node *unode = container_of(work, struct urb_node,
	96	release_urb_work.work);
	97
	98	up(&unode->dev->urbs.limit_sem);
	99	}
	100
	101	void udl_urb_completion(struct urb *urb)
	102	{
	103	struct urb_node *unode = urb->context;
	104	struct udl_device *udl = unode->dev;
	105	unsigned long flags;
	106
	107	/* sync/async unlink faults aren't errors */
	108	if (urb->status) {
	109	if (!(urb->status == -ENOENT \|\|
	110	urb->status == -ECONNRESET \|\|
	111	urb->status == -ESHUTDOWN)) {
	112	DRM_ERROR("%s - nonzero write bulk status received: %d\n",
	113	__func__, urb->status);
	114	atomic_set(&udl->lost_pixels, 1);
	115	}
	116	}
	117
	118	urb->transfer_buffer_length = udl->urbs.size; /* reset to actual */
	119
	120	spin_lock_irqsave(&udl->urbs.lock, flags);
	121	list_add_tail(&unode->entry, &udl->urbs.list);
	122	udl->urbs.available++;
	123	spin_unlock_irqrestore(&udl->urbs.lock, flags);
	124
	125	#if 0
126	/*
127	* When using fb_defio, we deadlock if up() is called
128	* while another is waiting. So queue to another process.
129	*/
130	if (fb_defio)
131	schedule_delayed_work(&unode->release_urb_work, 0);
132	else
133	#endif
134	up(&udl->urbs.limit_sem);
135	}
136
137	static void udl_free_urb_list(struct drm_device *dev)
138	{
139	struct udl_device *udl = dev->dev_private;
140	int count = udl->urbs.count;
141	struct list_head *node;
142	struct urb_node *unode;
143	struct urb *urb;
144	int ret;
145	unsigned long flags;
146
147	DRM_DEBUG("Waiting for completes and freeing all render urbs\n");
148
149	/* keep waiting and freeing, until we've got 'em all */
150	while (count--) {
151
152	/* Getting interrupted means a leak, but ok at shutdown*/
153	ret = down_interruptible(&udl->urbs.limit_sem);
154	if (ret)
155	break;
156
157	spin_lock_irqsave(&udl->urbs.lock, flags);
158
159	node = udl->urbs.list.next; /* have reserved one with sem */
160	list_del_init(node);
161
162	spin_unlock_irqrestore(&udl->urbs.lock, flags);
163
164	unode = list_entry(node, struct urb_node, entry);
165	urb = unode->urb;
166
167	/* Free each separately allocated piece */
168	usb_free_coherent(urb->dev, udl->urbs.size,
169	urb->transfer_buffer, urb->transfer_dma);
170	usb_free_urb(urb);
171	kfree(node);
172	}
173	udl->urbs.count = 0;
174	}
175
176	static int udl_alloc_urb_list(struct drm_device *dev, int count, size_t size)
177	{
178	struct udl_device *udl = dev->dev_private;
179	int i = 0;
180	struct urb *urb;
181	struct urb_node *unode;
182	char *buf;
183
184	spin_lock_init(&udl->urbs.lock);
185
186	udl->urbs.size = size;
187	INIT_LIST_HEAD(&udl->urbs.list);
188
189	while (i < count) {
190	unode = kzalloc(sizeof(struct urb_node), GFP_KERNEL);
191	if (!unode)
192	break;
193	unode->dev = udl;
194
195	INIT_DELAYED_WORK(&unode->release_urb_work,
196	udl_release_urb_work);
197
198	urb = usb_alloc_urb(0, GFP_KERNEL);
199	if (!urb) {
200	kfree(unode);
201	break;
202	}
203	unode->urb = urb;
204
d4f68a75	205	buf = usb_alloc_coherent(udl->udev, MAX_TRANSFER, GFP_KERNEL,
5320918b DA	206	&urb->transfer_dma);
	207	if (!buf) {
	208	kfree(unode);
	209	usb_free_urb(urb);
	210	break;
	211	}
	212
	213	/* urb->transfer_buffer_length set to actual before submit */
d4f68a75	214	usb_fill_bulk_urb(urb, udl->udev, usb_sndbulkpipe(udl->udev, 1),
5320918b DA	215	buf, size, udl_urb_completion, unode);
	216	urb->transfer_flags \|= URB_NO_TRANSFER_DMA_MAP;
	217
	218	list_add_tail(&unode->entry, &udl->urbs.list);
	219
	220	i++;
	221	}
	222
	223	sema_init(&udl->urbs.limit_sem, i);
	224	udl->urbs.count = i;
	225	udl->urbs.available = i;
	226
	227	DRM_DEBUG("allocated %d %d byte urbs\n", i, (int) size);
	228
	229	return i;
	230	}
	231
	232	struct urb udl_get_urb(struct drm_device dev)
	233	{
	234	struct udl_device *udl = dev->dev_private;
	235	int ret = 0;
	236	struct list_head *entry;
	237	struct urb_node *unode;
	238	struct urb *urb = NULL;
	239	unsigned long flags;
	240
	241	/* Wait for an in-flight buffer to complete and get re-queued */
	242	ret = down_timeout(&udl->urbs.limit_sem, GET_URB_TIMEOUT);
	243	if (ret) {
	244	atomic_set(&udl->lost_pixels, 1);
	245	DRM_INFO("wait for urb interrupted: %x available: %d\n",
	246	ret, udl->urbs.available);
	247	goto error;
	248	}
	249
	250	spin_lock_irqsave(&udl->urbs.lock, flags);
	251
	252	BUG_ON(list_empty(&udl->urbs.list)); /* reserved one with limit_sem */
	253	entry = udl->urbs.list.next;
	254	list_del_init(entry);
	255	udl->urbs.available--;
	256
	257	spin_unlock_irqrestore(&udl->urbs.lock, flags);
	258
	259	unode = list_entry(entry, struct urb_node, entry);
	260	urb = unode->urb;
	261
	262	error:
	263	return urb;
	264	}
	265
	266	int udl_submit_urb(struct drm_device dev, struct urb urb, size_t len)
	267	{
	268	struct udl_device *udl = dev->dev_private;
	269	int ret;
	270
	271	BUG_ON(len > udl->urbs.size);
	272
	273	urb->transfer_buffer_length = len; /* set to actual payload len */
	274	ret = usb_submit_urb(urb, GFP_ATOMIC);
	275	if (ret) {
	276	udl_urb_completion(urb); /* because no one else will */
	277	atomic_set(&udl->lost_pixels, 1);
	278	DRM_ERROR("usb_submit_urb error %x\n", ret);
279	}
280	return ret;
281	}
282
283	int udl_driver_load(struct drm_device *dev, unsigned long flags)
284	{
d4f68a75	285	struct usb_device udev = (void)flags;
5320918b	286	struct udl_device *udl;
737583f0	287	int ret = -ENOMEM;
5320918b DA	288
	289	DRM_DEBUG("\n");
	290	udl = kzalloc(sizeof(struct udl_device), GFP_KERNEL);
	291	if (!udl)
	292	return -ENOMEM;
	293
d4f68a75	294	udl->udev = udev;
5320918b DA	295	udl->ddev = dev;
	296	dev->dev_private = udl;
	297
d4f68a75	298	if (!udl_parse_vendor_descriptor(dev, udl->udev)) {
e39a52da	299	ret = -ENODEV;
5320918b DA	300	DRM_ERROR("firmware not recognized. Assume incompatible device\n");
	301	goto err;
	302	}
	303
	304	if (!udl_alloc_urb_list(dev, WRITES_IN_FLIGHT, MAX_TRANSFER)) {
5320918b DA	305	DRM_ERROR("udl_alloc_urb_list failed\n");
	306	goto err;
	307	}
	308
	309	DRM_DEBUG("\n");
	310	ret = udl_modeset_init(dev);
26507b06 SM	311	if (ret)
26507b06 SM	312	goto err;
5320918b DA	313
5320918b DA	314	ret = udl_fbdev_init(dev);
26507b06 SM	315	if (ret)
	316	goto err;
	317
	318	ret = drm_vblank_init(dev, 1);
	319	if (ret)
	320	goto err_fb;
	321
5320918b	322	return 0;
26507b06 SM	323	err_fb:
26507b06 SM	324	udl_fbdev_cleanup(dev);
5320918b	325	err:
26507b06 SM	326	if (udl->urbs.count)
26507b06 SM	327	udl_free_urb_list(dev);
5320918b DA	328	kfree(udl);
	329	DRM_ERROR("%d\n", ret);
	330	return ret;
	331	}
	332
	333	int udl_drop_usb(struct drm_device *dev)
	334	{
	335	udl_free_urb_list(dev);
	336	return 0;
	337	}
	338
	339	int udl_driver_unload(struct drm_device *dev)
	340	{
	341	struct udl_device *udl = dev->dev_private;
	342
26507b06 SM	343	drm_vblank_cleanup(dev);
26507b06 SM	344
5320918b DA	345	if (udl->urbs.count)
	346	udl_free_urb_list(dev);
	347
	348	udl_fbdev_cleanup(dev);
	349	udl_modeset_cleanup(dev);
	350	kfree(udl);
	351	return 0;
	352	}