xref: /openbmc/linux/drivers/gpu/drm/udl/udl_main.c (revision 0f7dc324)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2012 Red Hat
4  *
5  * based in parts on udlfb.c:
6  * Copyright (C) 2009 Roberto De Ioris <roberto@unbit.it>
7  * Copyright (C) 2009 Jaya Kumar <jayakumar.lkml@gmail.com>
8  * Copyright (C) 2009 Bernie Thompson <bernie@plugable.com>
9  */
10 
11 #include <drm/drm.h>
12 #include <drm/drm_print.h>
13 #include <drm/drm_probe_helper.h>
14 
15 #include "udl_drv.h"
16 
17 /* -BULK_SIZE as per usb-skeleton. Can we get full page and avoid overhead? */
18 #define BULK_SIZE 512
19 
20 #define NR_USB_REQUEST_CHANNEL 0x12
21 
22 #define MAX_TRANSFER (PAGE_SIZE*16 - BULK_SIZE)
23 #define WRITES_IN_FLIGHT (4)
24 #define MAX_VENDOR_DESCRIPTOR_SIZE 256
25 
26 static int udl_parse_vendor_descriptor(struct udl_device *udl)
27 {
28 	struct usb_device *udev = udl_to_usb_device(udl);
29 	char *desc;
30 	char *buf;
31 	char *desc_end;
32 
33 	u8 total_len = 0;
34 
35 	buf = kzalloc(MAX_VENDOR_DESCRIPTOR_SIZE, GFP_KERNEL);
36 	if (!buf)
37 		return false;
38 	desc = buf;
39 
40 	total_len = usb_get_descriptor(udev, 0x5f, /* vendor specific */
41 				    0, desc, MAX_VENDOR_DESCRIPTOR_SIZE);
42 	if (total_len > 5) {
43 		DRM_INFO("vendor descriptor length:%x data:%11ph\n",
44 			total_len, desc);
45 
46 		if ((desc[0] != total_len) || /* descriptor length */
47 		    (desc[1] != 0x5f) ||   /* vendor descriptor type */
48 		    (desc[2] != 0x01) ||   /* version (2 bytes) */
49 		    (desc[3] != 0x00) ||
50 		    (desc[4] != total_len - 2)) /* length after type */
51 			goto unrecognized;
52 
53 		desc_end = desc + total_len;
54 		desc += 5; /* the fixed header we've already parsed */
55 
56 		while (desc < desc_end) {
57 			u8 length;
58 			u16 key;
59 
60 			key = le16_to_cpu(*((u16 *) desc));
61 			desc += sizeof(u16);
62 			length = *desc;
63 			desc++;
64 
65 			switch (key) {
66 			case 0x0200: { /* max_area */
67 				u32 max_area;
68 				max_area = le32_to_cpu(*((u32 *)desc));
69 				DRM_DEBUG("DL chip limited to %d pixel modes\n",
70 					max_area);
71 				udl->sku_pixel_limit = max_area;
72 				break;
73 			}
74 			default:
75 				break;
76 			}
77 			desc += length;
78 		}
79 	}
80 
81 	goto success;
82 
83 unrecognized:
84 	/* allow udlfb to load for now even if firmware unrecognized */
85 	DRM_ERROR("Unrecognized vendor firmware descriptor\n");
86 
87 success:
88 	kfree(buf);
89 	return true;
90 }
91 
92 /*
93  * Need to ensure a channel is selected before submitting URBs
94  */
95 static int udl_select_std_channel(struct udl_device *udl)
96 {
97 	static const u8 set_def_chn[] = {0x57, 0xCD, 0xDC, 0xA7,
98 					 0x1C, 0x88, 0x5E, 0x15,
99 					 0x60, 0xFE, 0xC6, 0x97,
100 					 0x16, 0x3D, 0x47, 0xF2};
101 
102 	void *sendbuf;
103 	int ret;
104 	struct usb_device *udev = udl_to_usb_device(udl);
105 
106 	sendbuf = kmemdup(set_def_chn, sizeof(set_def_chn), GFP_KERNEL);
107 	if (!sendbuf)
108 		return -ENOMEM;
109 
110 	ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
111 			      NR_USB_REQUEST_CHANNEL,
112 			      (USB_DIR_OUT | USB_TYPE_VENDOR), 0, 0,
113 			      sendbuf, sizeof(set_def_chn),
114 			      USB_CTRL_SET_TIMEOUT);
115 	kfree(sendbuf);
116 	return ret < 0 ? ret : 0;
117 }
118 
119 void udl_urb_completion(struct urb *urb)
120 {
121 	struct urb_node *unode = urb->context;
122 	struct udl_device *udl = unode->dev;
123 	unsigned long flags;
124 
125 	/* sync/async unlink faults aren't errors */
126 	if (urb->status) {
127 		if (!(urb->status == -ENOENT ||
128 		    urb->status == -ECONNRESET ||
129 		    urb->status == -ESHUTDOWN)) {
130 			DRM_ERROR("%s - nonzero write bulk status received: %d\n",
131 				__func__, urb->status);
132 		}
133 	}
134 
135 	urb->transfer_buffer_length = udl->urbs.size; /* reset to actual */
136 
137 	spin_lock_irqsave(&udl->urbs.lock, flags);
138 	list_add_tail(&unode->entry, &udl->urbs.list);
139 	udl->urbs.available++;
140 	spin_unlock_irqrestore(&udl->urbs.lock, flags);
141 
142 	wake_up(&udl->urbs.sleep);
143 }
144 
145 static void udl_free_urb_list(struct drm_device *dev)
146 {
147 	struct udl_device *udl = to_udl(dev);
148 	int count = udl->urbs.count;
149 	struct urb_node *unode;
150 	struct urb *urb;
151 
152 	DRM_DEBUG("Waiting for completes and freeing all render urbs\n");
153 
154 	/* keep waiting and freeing, until we've got 'em all */
155 	while (count--) {
156 		urb = udl_get_urb_timeout(dev, MAX_SCHEDULE_TIMEOUT);
157 		if (WARN_ON(!urb))
158 			break;
159 		unode = urb->context;
160 		/* Free each separately allocated piece */
161 		usb_free_coherent(urb->dev, udl->urbs.size,
162 				  urb->transfer_buffer, urb->transfer_dma);
163 		usb_free_urb(urb);
164 		kfree(unode);
165 	}
166 	udl->urbs.count = 0;
167 }
168 
169 static int udl_alloc_urb_list(struct drm_device *dev, int count, size_t size)
170 {
171 	struct udl_device *udl = to_udl(dev);
172 	struct urb *urb;
173 	struct urb_node *unode;
174 	char *buf;
175 	size_t wanted_size = count * size;
176 	struct usb_device *udev = udl_to_usb_device(udl);
177 
178 	spin_lock_init(&udl->urbs.lock);
179 
180 retry:
181 	udl->urbs.size = size;
182 	INIT_LIST_HEAD(&udl->urbs.list);
183 
184 	init_waitqueue_head(&udl->urbs.sleep);
185 	udl->urbs.count = 0;
186 	udl->urbs.available = 0;
187 
188 	while (udl->urbs.count * size < wanted_size) {
189 		unode = kzalloc(sizeof(struct urb_node), GFP_KERNEL);
190 		if (!unode)
191 			break;
192 		unode->dev = udl;
193 
194 		urb = usb_alloc_urb(0, GFP_KERNEL);
195 		if (!urb) {
196 			kfree(unode);
197 			break;
198 		}
199 		unode->urb = urb;
200 
201 		buf = usb_alloc_coherent(udev, size, GFP_KERNEL,
202 					 &urb->transfer_dma);
203 		if (!buf) {
204 			kfree(unode);
205 			usb_free_urb(urb);
206 			if (size > PAGE_SIZE) {
207 				size /= 2;
208 				udl_free_urb_list(dev);
209 				goto retry;
210 			}
211 			break;
212 		}
213 
214 		/* urb->transfer_buffer_length set to actual before submit */
215 		usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, 1),
216 				  buf, size, udl_urb_completion, unode);
217 		urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
218 
219 		list_add_tail(&unode->entry, &udl->urbs.list);
220 
221 		udl->urbs.count++;
222 		udl->urbs.available++;
223 	}
224 
225 	DRM_DEBUG("allocated %d %d byte urbs\n", udl->urbs.count, (int) size);
226 
227 	return udl->urbs.count;
228 }
229 
230 struct urb *udl_get_urb_timeout(struct drm_device *dev, long timeout)
231 {
232 	struct udl_device *udl = to_udl(dev);
233 	struct urb_node *unode = NULL;
234 
235 	if (!udl->urbs.count)
236 		return NULL;
237 
238 	/* Wait for an in-flight buffer to complete and get re-queued */
239 	spin_lock_irq(&udl->urbs.lock);
240 	if (!wait_event_lock_irq_timeout(udl->urbs.sleep,
241 					 !list_empty(&udl->urbs.list),
242 					 udl->urbs.lock, timeout)) {
243 		DRM_INFO("wait for urb interrupted: available: %d\n",
244 			 udl->urbs.available);
245 		goto unlock;
246 	}
247 
248 	unode = list_first_entry(&udl->urbs.list, struct urb_node, entry);
249 	list_del_init(&unode->entry);
250 	udl->urbs.available--;
251 
252 unlock:
253 	spin_unlock_irq(&udl->urbs.lock);
254 	return unode ? unode->urb : NULL;
255 }
256 
257 int udl_submit_urb(struct drm_device *dev, struct urb *urb, size_t len)
258 {
259 	struct udl_device *udl = to_udl(dev);
260 	int ret;
261 
262 	BUG_ON(len > udl->urbs.size);
263 
264 	urb->transfer_buffer_length = len; /* set to actual payload len */
265 	ret = usb_submit_urb(urb, GFP_ATOMIC);
266 	if (ret) {
267 		udl_urb_completion(urb); /* because no one else will */
268 		DRM_ERROR("usb_submit_urb error %x\n", ret);
269 	}
270 	return ret;
271 }
272 
273 /* wait until all pending URBs have been processed */
274 int udl_sync_pending_urbs(struct drm_device *dev)
275 {
276 	struct udl_device *udl = to_udl(dev);
277 	int ret = 0;
278 
279 	spin_lock_irq(&udl->urbs.lock);
280 	/* 2 seconds as a sane timeout */
281 	if (!wait_event_lock_irq_timeout(udl->urbs.sleep,
282 					 udl->urbs.available == udl->urbs.count,
283 					 udl->urbs.lock,
284 					 msecs_to_jiffies(2000)))
285 		ret = -ETIMEDOUT;
286 	spin_unlock_irq(&udl->urbs.lock);
287 	return ret;
288 }
289 
290 int udl_init(struct udl_device *udl)
291 {
292 	struct drm_device *dev = &udl->drm;
293 	int ret = -ENOMEM;
294 
295 	DRM_DEBUG("\n");
296 
297 	udl->dmadev = usb_intf_get_dma_device(to_usb_interface(dev->dev));
298 	if (!udl->dmadev)
299 		drm_warn(dev, "buffer sharing not supported"); /* not an error */
300 
301 	mutex_init(&udl->gem_lock);
302 
303 	if (!udl_parse_vendor_descriptor(udl)) {
304 		ret = -ENODEV;
305 		DRM_ERROR("firmware not recognized. Assume incompatible device\n");
306 		goto err;
307 	}
308 
309 	if (udl_select_std_channel(udl))
310 		DRM_ERROR("Selecting channel failed\n");
311 
312 	if (!udl_alloc_urb_list(dev, WRITES_IN_FLIGHT, MAX_TRANSFER)) {
313 		DRM_ERROR("udl_alloc_urb_list failed\n");
314 		goto err;
315 	}
316 
317 	DRM_DEBUG("\n");
318 	ret = udl_modeset_init(dev);
319 	if (ret)
320 		goto err;
321 
322 	drm_kms_helper_poll_init(dev);
323 
324 	return 0;
325 
326 err:
327 	if (udl->urbs.count)
328 		udl_free_urb_list(dev);
329 	put_device(udl->dmadev);
330 	DRM_ERROR("%d\n", ret);
331 	return ret;
332 }
333 
334 int udl_drop_usb(struct drm_device *dev)
335 {
336 	struct udl_device *udl = to_udl(dev);
337 
338 	udl_free_urb_list(dev);
339 	put_device(udl->dmadev);
340 	udl->dmadev = NULL;
341 
342 	return 0;
343 }
344