usbdi.c revision 1.26 1 1.26 augustss /* $NetBSD: usbdi.c,v 1.26 1999/07/06 07:12:03 augustss Exp $ */
2 1.1 augustss
3 1.1 augustss /*
4 1.1 augustss * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 1.1 augustss * All rights reserved.
6 1.1 augustss *
7 1.11 augustss * This code is derived from software contributed to The NetBSD Foundation
8 1.11 augustss * by Lennart Augustsson (augustss (at) carlstedt.se) at
9 1.11 augustss * Carlstedt Research & Technology.
10 1.1 augustss *
11 1.1 augustss * Redistribution and use in source and binary forms, with or without
12 1.1 augustss * modification, are permitted provided that the following conditions
13 1.1 augustss * are met:
14 1.1 augustss * 1. Redistributions of source code must retain the above copyright
15 1.1 augustss * notice, this list of conditions and the following disclaimer.
16 1.1 augustss * 2. Redistributions in binary form must reproduce the above copyright
17 1.1 augustss * notice, this list of conditions and the following disclaimer in the
18 1.1 augustss * documentation and/or other materials provided with the distribution.
19 1.1 augustss * 3. All advertising materials mentioning features or use of this software
20 1.1 augustss * must display the following acknowledgement:
21 1.1 augustss * This product includes software developed by the NetBSD
22 1.1 augustss * Foundation, Inc. and its contributors.
23 1.1 augustss * 4. Neither the name of The NetBSD Foundation nor the names of its
24 1.1 augustss * contributors may be used to endorse or promote products derived
25 1.1 augustss * from this software without specific prior written permission.
26 1.1 augustss *
27 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 1.1 augustss * POSSIBILITY OF SUCH DAMAGE.
38 1.1 augustss */
39 1.1 augustss
40 1.1 augustss #include <sys/param.h>
41 1.1 augustss #include <sys/systm.h>
42 1.1 augustss #include <sys/kernel.h>
43 1.15 augustss #if defined(__NetBSD__)
44 1.15 augustss #include <sys/device.h>
45 1.15 augustss #else
46 1.15 augustss #include <sys/module.h>
47 1.15 augustss #include <sys/bus.h>
48 1.15 augustss #include <sys/conf.h>
49 1.15 augustss #endif
50 1.1 augustss #include <sys/malloc.h>
51 1.1 augustss #include <sys/proc.h>
52 1.1 augustss
53 1.1 augustss #include <dev/usb/usb.h>
54 1.1 augustss
55 1.1 augustss #include <dev/usb/usbdi.h>
56 1.1 augustss #include <dev/usb/usbdi_util.h>
57 1.1 augustss #include <dev/usb/usbdivar.h>
58 1.1 augustss
59 1.20 augustss #if defined(__FreeBSD__)
60 1.20 augustss #include "usb_if.h"
61 1.20 augustss #endif
62 1.20 augustss
63 1.1 augustss #ifdef USB_DEBUG
64 1.1 augustss #define DPRINTF(x) if (usbdebug) printf x
65 1.1 augustss #define DPRINTFN(n,x) if (usbdebug>(n)) printf x
66 1.1 augustss extern int usbdebug;
67 1.1 augustss #else
68 1.1 augustss #define DPRINTF(x)
69 1.1 augustss #define DPRINTFN(n,x)
70 1.1 augustss #endif
71 1.1 augustss
72 1.1 augustss static usbd_status usbd_ar_pipe __P((usbd_pipe_handle pipe));
73 1.1 augustss static void usbd_transfer_cb __P((usbd_request_handle reqh));
74 1.1 augustss static void usbd_sync_transfer_cb __P((usbd_request_handle reqh));
75 1.1 augustss static usbd_status usbd_do_transfer __P((usbd_request_handle reqh));
76 1.7 augustss void usbd_do_request_async_cb
77 1.7 augustss __P((usbd_request_handle, usbd_private_handle, usbd_status));
78 1.1 augustss
79 1.1 augustss static SIMPLEQ_HEAD(, usbd_request) usbd_free_requests;
80 1.1 augustss
81 1.15 augustss #if defined(__FreeBSD__)
82 1.20 augustss #define USB_CDEV_MAJOR 108
83 1.15 augustss
84 1.15 augustss extern struct cdevsw usb_cdevsw;
85 1.15 augustss #endif
86 1.15 augustss
87 1.1 augustss usbd_status
88 1.1 augustss usbd_open_pipe(iface, address, flags, pipe)
89 1.1 augustss usbd_interface_handle iface;
90 1.1 augustss u_int8_t address;
91 1.1 augustss u_int8_t flags;
92 1.1 augustss usbd_pipe_handle *pipe;
93 1.1 augustss {
94 1.1 augustss usbd_pipe_handle p;
95 1.1 augustss struct usbd_endpoint *ep;
96 1.12 augustss usbd_status r;
97 1.12 augustss int i;
98 1.1 augustss
99 1.1 augustss for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
100 1.1 augustss ep = &iface->endpoints[i];
101 1.1 augustss if (ep->edesc->bEndpointAddress == address)
102 1.1 augustss goto found;
103 1.1 augustss }
104 1.1 augustss return (USBD_BAD_ADDRESS);
105 1.1 augustss found:
106 1.1 augustss if ((flags & USBD_EXCLUSIVE_USE) &&
107 1.1 augustss ep->refcnt != 0)
108 1.1 augustss return (USBD_IN_USE);
109 1.1 augustss r = usbd_setup_pipe(iface->device, iface, ep, &p);
110 1.1 augustss if (r != USBD_NORMAL_COMPLETION)
111 1.1 augustss return (r);
112 1.1 augustss LIST_INSERT_HEAD(&iface->pipes, p, next);
113 1.1 augustss *pipe = p;
114 1.1 augustss return (USBD_NORMAL_COMPLETION);
115 1.1 augustss }
116 1.1 augustss
117 1.1 augustss usbd_status
118 1.1 augustss usbd_open_pipe_intr(iface, address, flags, pipe, priv, buffer, length, cb)
119 1.1 augustss usbd_interface_handle iface;
120 1.1 augustss u_int8_t address;
121 1.1 augustss u_int8_t flags;
122 1.1 augustss usbd_pipe_handle *pipe;
123 1.1 augustss usbd_private_handle priv;
124 1.1 augustss void *buffer;
125 1.1 augustss u_int32_t length;
126 1.1 augustss usbd_callback cb;
127 1.1 augustss {
128 1.1 augustss usbd_status r;
129 1.1 augustss usbd_request_handle reqh;
130 1.1 augustss usbd_pipe_handle ipipe;
131 1.1 augustss
132 1.1 augustss reqh = usbd_alloc_request();
133 1.1 augustss if (reqh == 0)
134 1.1 augustss return (USBD_NOMEM);
135 1.1 augustss r = usbd_open_pipe(iface, address, USBD_EXCLUSIVE_USE, &ipipe);
136 1.1 augustss if (r != USBD_NORMAL_COMPLETION)
137 1.1 augustss goto bad1;
138 1.1 augustss r = usbd_setup_request(reqh, ipipe, priv, buffer, length,
139 1.1 augustss USBD_XFER_IN | flags, USBD_NO_TIMEOUT, cb);
140 1.1 augustss if (r != USBD_NORMAL_COMPLETION)
141 1.1 augustss goto bad2;
142 1.1 augustss ipipe->intrreqh = reqh;
143 1.25 augustss ipipe->repeat = 1;
144 1.1 augustss r = usbd_transfer(reqh);
145 1.1 augustss *pipe = ipipe;
146 1.1 augustss if (r != USBD_IN_PROGRESS)
147 1.1 augustss goto bad3;
148 1.1 augustss return (USBD_NORMAL_COMPLETION);
149 1.1 augustss
150 1.1 augustss bad3:
151 1.1 augustss ipipe->intrreqh = 0;
152 1.25 augustss ipipe->repeat = 0;
153 1.1 augustss bad2:
154 1.1 augustss usbd_close_pipe(ipipe);
155 1.1 augustss bad1:
156 1.1 augustss usbd_free_request(reqh);
157 1.1 augustss return r;
158 1.1 augustss }
159 1.1 augustss
160 1.9 augustss usbd_status
161 1.9 augustss usbd_open_pipe_iso(iface, address, flags, pipe, priv, bufsize, nbuf, cb)
162 1.9 augustss usbd_interface_handle iface;
163 1.9 augustss u_int8_t address;
164 1.9 augustss u_int8_t flags;
165 1.9 augustss usbd_pipe_handle *pipe;
166 1.9 augustss usbd_private_handle priv;
167 1.9 augustss u_int32_t bufsize;
168 1.9 augustss u_int32_t nbuf;
169 1.9 augustss usbd_callback cb;
170 1.9 augustss {
171 1.9 augustss usbd_status r;
172 1.9 augustss usbd_pipe_handle p;
173 1.9 augustss
174 1.9 augustss r = usbd_open_pipe(iface, address, USBD_EXCLUSIVE_USE, &p);
175 1.9 augustss if (r != USBD_NORMAL_COMPLETION)
176 1.9 augustss return (r);
177 1.9 augustss if (!p->methods->isobuf) {
178 1.9 augustss usbd_close_pipe(p);
179 1.9 augustss return (USBD_INVAL);
180 1.9 augustss }
181 1.9 augustss r = p->methods->isobuf(p, bufsize, nbuf);
182 1.9 augustss if (r != USBD_NORMAL_COMPLETION) {
183 1.9 augustss usbd_close_pipe(p);
184 1.9 augustss return (r);
185 1.9 augustss }
186 1.9 augustss *pipe = p;
187 1.9 augustss return r;
188 1.9 augustss }
189 1.9 augustss
190 1.1 augustss usbd_status
191 1.1 augustss usbd_close_pipe(pipe)
192 1.1 augustss usbd_pipe_handle pipe;
193 1.1 augustss {
194 1.26 augustss #ifdef DIAGNOSTIC
195 1.26 augustss if (pipe == 0) {
196 1.26 augustss printf("usbd_close_pipe: pipe==NULL\n");
197 1.26 augustss return (USBD_NORMAL_COMPLETION);
198 1.26 augustss }
199 1.26 augustss #endif
200 1.26 augustss
201 1.1 augustss if (--pipe->refcnt != 0)
202 1.1 augustss return (USBD_NORMAL_COMPLETION);
203 1.1 augustss if (SIMPLEQ_FIRST(&pipe->queue) != 0)
204 1.1 augustss return (USBD_PENDING_REQUESTS);
205 1.1 augustss LIST_REMOVE(pipe, next);
206 1.1 augustss pipe->endpoint->refcnt--;
207 1.1 augustss pipe->methods->close(pipe);
208 1.1 augustss if (pipe->intrreqh)
209 1.1 augustss usbd_free_request(pipe->intrreqh);
210 1.1 augustss free(pipe, M_USB);
211 1.1 augustss return (USBD_NORMAL_COMPLETION);
212 1.1 augustss }
213 1.1 augustss
214 1.1 augustss usbd_status
215 1.1 augustss usbd_transfer(reqh)
216 1.1 augustss usbd_request_handle reqh;
217 1.1 augustss {
218 1.1 augustss reqh->xfercb = usbd_transfer_cb;
219 1.1 augustss return (usbd_do_transfer(reqh));
220 1.1 augustss }
221 1.1 augustss
222 1.1 augustss static usbd_status
223 1.1 augustss usbd_do_transfer(reqh)
224 1.1 augustss usbd_request_handle reqh;
225 1.1 augustss {
226 1.1 augustss usbd_pipe_handle pipe = reqh->pipe;
227 1.16 augustss
228 1.16 augustss DPRINTFN(10,("usbd_do_transfer: reqh=%p\n", reqh));
229 1.16 augustss reqh->done = 0;
230 1.16 augustss return (pipe->methods->transfer(reqh));
231 1.16 augustss }
232 1.16 augustss
233 1.1 augustss usbd_request_handle
234 1.1 augustss usbd_alloc_request()
235 1.1 augustss {
236 1.1 augustss usbd_request_handle reqh;
237 1.1 augustss
238 1.1 augustss reqh = SIMPLEQ_FIRST(&usbd_free_requests);
239 1.1 augustss if (reqh)
240 1.1 augustss SIMPLEQ_REMOVE_HEAD(&usbd_free_requests, reqh, next);
241 1.1 augustss else
242 1.1 augustss reqh = malloc(sizeof(*reqh), M_USB, M_NOWAIT);
243 1.1 augustss if (!reqh)
244 1.1 augustss return (0);
245 1.1 augustss memset(reqh, 0, sizeof *reqh);
246 1.25 augustss DPRINTFN(1,("usbd_alloc_request() = %p\n", reqh));
247 1.1 augustss return (reqh);
248 1.1 augustss }
249 1.1 augustss
250 1.1 augustss usbd_status
251 1.1 augustss usbd_free_request(reqh)
252 1.1 augustss usbd_request_handle reqh;
253 1.1 augustss {
254 1.25 augustss DPRINTFN(1,("usbd_free_request: %p\n", reqh));
255 1.1 augustss SIMPLEQ_INSERT_HEAD(&usbd_free_requests, reqh, next);
256 1.1 augustss return (USBD_NORMAL_COMPLETION);
257 1.1 augustss }
258 1.1 augustss
259 1.1 augustss usbd_status
260 1.1 augustss usbd_setup_request(reqh, pipe, priv, buffer, length, flags, timeout, callback)
261 1.1 augustss usbd_request_handle reqh;
262 1.1 augustss usbd_pipe_handle pipe;
263 1.1 augustss usbd_private_handle priv;
264 1.1 augustss void *buffer;
265 1.1 augustss u_int32_t length;
266 1.1 augustss u_int16_t flags;
267 1.1 augustss u_int32_t timeout;
268 1.1 augustss void (*callback) __P((usbd_request_handle,
269 1.1 augustss usbd_private_handle,
270 1.1 augustss usbd_status));
271 1.1 augustss {
272 1.1 augustss reqh->pipe = pipe;
273 1.1 augustss reqh->priv = priv;
274 1.1 augustss reqh->buffer = buffer;
275 1.1 augustss reqh->length = length;
276 1.1 augustss reqh->actlen = 0;
277 1.1 augustss reqh->flags = flags;
278 1.22 augustss reqh->timeout = timeout;
279 1.22 augustss reqh->status = USBD_NOT_STARTED;
280 1.1 augustss reqh->callback = callback;
281 1.1 augustss reqh->retries = 1;
282 1.22 augustss reqh->isreq = 0;
283 1.1 augustss return (USBD_NORMAL_COMPLETION);
284 1.1 augustss }
285 1.1 augustss
286 1.1 augustss usbd_status
287 1.1 augustss usbd_setup_default_request(reqh, dev, priv, timeout, req, buffer,
288 1.1 augustss length, flags, callback)
289 1.1 augustss usbd_request_handle reqh;
290 1.1 augustss usbd_device_handle dev;
291 1.1 augustss usbd_private_handle priv;
292 1.1 augustss u_int32_t timeout;
293 1.1 augustss usb_device_request_t *req;
294 1.1 augustss void *buffer;
295 1.1 augustss u_int32_t length;
296 1.1 augustss u_int16_t flags;
297 1.1 augustss void (*callback) __P((usbd_request_handle,
298 1.1 augustss usbd_private_handle,
299 1.1 augustss usbd_status));
300 1.1 augustss {
301 1.1 augustss reqh->pipe = dev->default_pipe;
302 1.1 augustss reqh->priv = priv;
303 1.1 augustss reqh->buffer = buffer;
304 1.1 augustss reqh->length = length;
305 1.1 augustss reqh->actlen = 0;
306 1.1 augustss reqh->flags = flags;
307 1.1 augustss reqh->timeout = timeout;
308 1.1 augustss reqh->status = USBD_NOT_STARTED;
309 1.1 augustss reqh->callback = callback;
310 1.1 augustss reqh->request = *req;
311 1.22 augustss reqh->retries = 1;
312 1.1 augustss reqh->isreq = 1;
313 1.1 augustss return (USBD_NORMAL_COMPLETION);
314 1.1 augustss }
315 1.1 augustss
316 1.1 augustss usbd_status
317 1.1 augustss usbd_get_request_status(reqh, priv, buffer, count, status)
318 1.1 augustss usbd_request_handle reqh;
319 1.1 augustss usbd_private_handle *priv;
320 1.1 augustss void **buffer;
321 1.1 augustss u_int32_t *count;
322 1.1 augustss usbd_status *status;
323 1.1 augustss {
324 1.1 augustss *priv = reqh->priv;
325 1.1 augustss *buffer = reqh->buffer;
326 1.1 augustss *count = reqh->actlen;
327 1.1 augustss *status = reqh->status;
328 1.1 augustss return (USBD_NORMAL_COMPLETION);
329 1.1 augustss }
330 1.1 augustss
331 1.1 augustss usb_config_descriptor_t *
332 1.1 augustss usbd_get_config_descriptor(dev)
333 1.1 augustss usbd_device_handle dev;
334 1.1 augustss {
335 1.1 augustss return (dev->cdesc);
336 1.1 augustss }
337 1.1 augustss
338 1.1 augustss usb_interface_descriptor_t *
339 1.1 augustss usbd_get_interface_descriptor(iface)
340 1.1 augustss usbd_interface_handle iface;
341 1.1 augustss {
342 1.1 augustss return (iface->idesc);
343 1.1 augustss }
344 1.1 augustss
345 1.1 augustss usb_device_descriptor_t *
346 1.1 augustss usbd_get_device_descriptor(dev)
347 1.1 augustss usbd_device_handle dev;
348 1.1 augustss {
349 1.1 augustss return (&dev->ddesc);
350 1.1 augustss }
351 1.1 augustss
352 1.1 augustss usb_endpoint_descriptor_t *
353 1.1 augustss usbd_interface2endpoint_descriptor(iface, index)
354 1.1 augustss usbd_interface_handle iface;
355 1.1 augustss u_int8_t index;
356 1.1 augustss {
357 1.1 augustss if (index >= iface->idesc->bNumEndpoints)
358 1.12 augustss return (0);
359 1.1 augustss return (iface->endpoints[index].edesc);
360 1.1 augustss }
361 1.1 augustss
362 1.12 augustss usbd_status
363 1.1 augustss usbd_abort_pipe(pipe)
364 1.1 augustss usbd_pipe_handle pipe;
365 1.1 augustss {
366 1.1 augustss usbd_status r;
367 1.24 augustss int s;
368 1.1 augustss
369 1.26 augustss #ifdef DIAGNOSTIC
370 1.26 augustss if (pipe == 0) {
371 1.26 augustss printf("usbd_close_pipe: pipe==NULL\n");
372 1.26 augustss return (USBD_NORMAL_COMPLETION);
373 1.26 augustss }
374 1.26 augustss #endif
375 1.1 augustss s = splusb();
376 1.1 augustss r = usbd_ar_pipe(pipe);
377 1.1 augustss splx(s);
378 1.1 augustss return (r);
379 1.1 augustss }
380 1.1 augustss
381 1.1 augustss usbd_status
382 1.1 augustss usbd_clear_endpoint_stall(pipe)
383 1.1 augustss usbd_pipe_handle pipe;
384 1.1 augustss {
385 1.1 augustss usbd_device_handle dev = pipe->device;
386 1.1 augustss usb_device_request_t req;
387 1.1 augustss usbd_status r;
388 1.1 augustss
389 1.22 augustss DPRINTFN(8, ("usbd_clear_endpoint_stall\n"));
390 1.1 augustss req.bmRequestType = UT_WRITE_ENDPOINT;
391 1.1 augustss req.bRequest = UR_CLEAR_FEATURE;
392 1.15 augustss USETW(req.wValue, UF_ENDPOINT_HALT);
393 1.7 augustss USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
394 1.1 augustss USETW(req.wLength, 0);
395 1.1 augustss r = usbd_do_request(dev, &req, 0);
396 1.1 augustss #if 0
397 1.1 augustss XXX should we do this?
398 1.1 augustss if (r == USBD_NORMAL_COMPLETION) {
399 1.1 augustss pipe->state = USBD_PIPE_ACTIVE;
400 1.1 augustss /* XXX activate pipe */
401 1.1 augustss }
402 1.1 augustss #endif
403 1.1 augustss return (r);
404 1.1 augustss }
405 1.1 augustss
406 1.1 augustss usbd_status
407 1.7 augustss usbd_clear_endpoint_stall_async(pipe)
408 1.7 augustss usbd_pipe_handle pipe;
409 1.7 augustss {
410 1.7 augustss usbd_device_handle dev = pipe->device;
411 1.7 augustss usb_device_request_t req;
412 1.7 augustss usbd_status r;
413 1.7 augustss
414 1.7 augustss req.bmRequestType = UT_WRITE_ENDPOINT;
415 1.7 augustss req.bRequest = UR_CLEAR_FEATURE;
416 1.15 augustss USETW(req.wValue, UF_ENDPOINT_HALT);
417 1.7 augustss USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
418 1.7 augustss USETW(req.wLength, 0);
419 1.7 augustss r = usbd_do_request_async(dev, &req, 0);
420 1.7 augustss return (r);
421 1.7 augustss }
422 1.7 augustss
423 1.7 augustss usbd_status
424 1.1 augustss usbd_endpoint_count(iface, count)
425 1.1 augustss usbd_interface_handle iface;
426 1.1 augustss u_int8_t *count;
427 1.1 augustss {
428 1.1 augustss *count = iface->idesc->bNumEndpoints;
429 1.1 augustss return (USBD_NORMAL_COMPLETION);
430 1.1 augustss }
431 1.1 augustss
432 1.1 augustss usbd_status
433 1.1 augustss usbd_interface_count(dev, count)
434 1.1 augustss usbd_device_handle dev;
435 1.1 augustss u_int8_t *count;
436 1.1 augustss {
437 1.1 augustss if (!dev->cdesc)
438 1.1 augustss return (USBD_NOT_CONFIGURED);
439 1.1 augustss *count = dev->cdesc->bNumInterface;
440 1.1 augustss return (USBD_NORMAL_COMPLETION);
441 1.1 augustss }
442 1.1 augustss
443 1.1 augustss usbd_status
444 1.1 augustss usbd_interface2device_handle(iface, dev)
445 1.1 augustss usbd_interface_handle iface;
446 1.1 augustss usbd_device_handle *dev;
447 1.1 augustss {
448 1.1 augustss *dev = iface->device;
449 1.1 augustss return (USBD_NORMAL_COMPLETION);
450 1.1 augustss }
451 1.1 augustss
452 1.1 augustss usbd_status
453 1.1 augustss usbd_device2interface_handle(dev, ifaceno, iface)
454 1.1 augustss usbd_device_handle dev;
455 1.1 augustss u_int8_t ifaceno;
456 1.1 augustss usbd_interface_handle *iface;
457 1.1 augustss {
458 1.1 augustss if (!dev->cdesc)
459 1.1 augustss return (USBD_NOT_CONFIGURED);
460 1.1 augustss if (ifaceno >= dev->cdesc->bNumInterface)
461 1.1 augustss return (USBD_INVAL);
462 1.1 augustss *iface = &dev->ifaces[ifaceno];
463 1.1 augustss return (USBD_NORMAL_COMPLETION);
464 1.1 augustss }
465 1.1 augustss
466 1.13 augustss /* XXXX use altno */
467 1.3 augustss usbd_status
468 1.13 augustss usbd_set_interface(iface, altidx)
469 1.3 augustss usbd_interface_handle iface;
470 1.13 augustss int altidx;
471 1.3 augustss {
472 1.3 augustss usb_device_request_t req;
473 1.13 augustss usbd_status r;
474 1.13 augustss
475 1.13 augustss if (LIST_FIRST(&iface->pipes) != 0)
476 1.13 augustss return (USBD_IN_USE);
477 1.13 augustss
478 1.16 augustss if (iface->endpoints)
479 1.16 augustss free(iface->endpoints, M_USB);
480 1.13 augustss iface->endpoints = 0;
481 1.13 augustss iface->idesc = 0;
482 1.13 augustss
483 1.13 augustss r = usbd_fill_iface_data(iface->device, iface->index, altidx);
484 1.13 augustss if (r != USBD_NORMAL_COMPLETION)
485 1.13 augustss return (r);
486 1.3 augustss
487 1.3 augustss req.bmRequestType = UT_WRITE_INTERFACE;
488 1.3 augustss req.bRequest = UR_SET_INTERFACE;
489 1.13 augustss USETW(req.wValue, iface->idesc->bAlternateSetting);
490 1.16 augustss USETW(req.wIndex, iface->idesc->bInterfaceNumber);
491 1.3 augustss USETW(req.wLength, 0);
492 1.3 augustss return usbd_do_request(iface->device, &req, 0);
493 1.12 augustss }
494 1.12 augustss
495 1.12 augustss int
496 1.13 augustss usbd_get_no_alts(cdesc, ifaceno)
497 1.13 augustss usb_config_descriptor_t *cdesc;
498 1.13 augustss int ifaceno;
499 1.12 augustss {
500 1.13 augustss char *p = (char *)cdesc;
501 1.13 augustss char *end = p + UGETW(cdesc->wTotalLength);
502 1.12 augustss usb_interface_descriptor_t *d;
503 1.12 augustss int n;
504 1.12 augustss
505 1.12 augustss for (n = 0; p < end; p += d->bLength) {
506 1.12 augustss d = (usb_interface_descriptor_t *)p;
507 1.12 augustss if (p + d->bLength <= end &&
508 1.12 augustss d->bDescriptorType == UDESC_INTERFACE &&
509 1.13 augustss d->bInterfaceNumber == ifaceno)
510 1.12 augustss n++;
511 1.12 augustss }
512 1.12 augustss return (n);
513 1.13 augustss }
514 1.13 augustss
515 1.13 augustss int
516 1.13 augustss usbd_get_interface_altindex(iface)
517 1.13 augustss usbd_interface_handle iface;
518 1.13 augustss {
519 1.13 augustss return (iface->altindex);
520 1.12 augustss }
521 1.12 augustss
522 1.12 augustss usbd_status
523 1.12 augustss usbd_get_interface(iface, aiface)
524 1.12 augustss usbd_interface_handle iface;
525 1.12 augustss u_int8_t *aiface;
526 1.12 augustss {
527 1.12 augustss usb_device_request_t req;
528 1.12 augustss
529 1.12 augustss req.bmRequestType = UT_READ_INTERFACE;
530 1.12 augustss req.bRequest = UR_GET_INTERFACE;
531 1.12 augustss USETW(req.wValue, 0);
532 1.16 augustss USETW(req.wIndex, iface->idesc->bInterfaceNumber);
533 1.12 augustss USETW(req.wLength, 1);
534 1.12 augustss return usbd_do_request(iface->device, &req, aiface);
535 1.3 augustss }
536 1.1 augustss
537 1.1 augustss /*** Internal routines ***/
538 1.1 augustss
539 1.1 augustss /* Dequeue all pipe operations, called at splusb(). */
540 1.1 augustss static usbd_status
541 1.1 augustss usbd_ar_pipe(pipe)
542 1.1 augustss usbd_pipe_handle pipe;
543 1.1 augustss {
544 1.1 augustss usbd_request_handle reqh;
545 1.1 augustss
546 1.20 augustss #if 0
547 1.1 augustss for (;;) {
548 1.1 augustss reqh = SIMPLEQ_FIRST(&pipe->queue);
549 1.1 augustss if (reqh == 0)
550 1.1 augustss break;
551 1.1 augustss SIMPLEQ_REMOVE_HEAD(&pipe->queue, reqh, next);
552 1.1 augustss reqh->status = USBD_CANCELLED;
553 1.1 augustss if (reqh->callback)
554 1.1 augustss reqh->callback(reqh, reqh->priv, reqh->status);
555 1.1 augustss }
556 1.20 augustss #else
557 1.25 augustss DPRINTFN(2,("usbd_ar_pipe: pipe=%p\n", pipe));
558 1.20 augustss while ((reqh = SIMPLEQ_FIRST(&pipe->queue))) {
559 1.25 augustss DPRINTFN(2,("usbd_ar_pipe: reqh=%p (methods=%p)\n",
560 1.25 augustss pipe, pipe->methods));
561 1.20 augustss pipe->methods->abort(reqh);
562 1.20 augustss SIMPLEQ_REMOVE_HEAD(&pipe->queue, reqh, next);
563 1.20 augustss }
564 1.20 augustss #endif
565 1.1 augustss return (USBD_NORMAL_COMPLETION);
566 1.1 augustss }
567 1.1 augustss
568 1.1 augustss static int usbd_global_init_done = 0;
569 1.1 augustss
570 1.1 augustss void
571 1.1 augustss usbd_init()
572 1.1 augustss {
573 1.15 augustss #if defined(__FreeBSD__)
574 1.15 augustss dev_t dev;
575 1.15 augustss #endif
576 1.15 augustss
577 1.1 augustss if (!usbd_global_init_done) {
578 1.1 augustss usbd_global_init_done = 1;
579 1.1 augustss SIMPLEQ_INIT(&usbd_free_requests);
580 1.15 augustss
581 1.15 augustss #if defined(__FreeBSD__)
582 1.15 augustss dev = makedev(USB_CDEV_MAJOR, 0);
583 1.15 augustss cdevsw_add(&dev, &usb_cdevsw, NULL);
584 1.15 augustss #endif
585 1.1 augustss }
586 1.1 augustss }
587 1.1 augustss
588 1.1 augustss static void
589 1.1 augustss usbd_transfer_cb(reqh)
590 1.1 augustss usbd_request_handle reqh;
591 1.1 augustss {
592 1.1 augustss usbd_pipe_handle pipe = reqh->pipe;
593 1.5 augustss
594 1.22 augustss DPRINTFN(10, ("usbd_transfer_cb: reqh=%p\n", reqh));
595 1.5 augustss /* Count completed transfers. */
596 1.23 augustss #ifdef DIAGNOSTIC
597 1.23 augustss if (!pipe)
598 1.23 augustss printf("usbd_transfer_cb: pipe==0, reqh=%p\n", reqh);
599 1.23 augustss else
600 1.23 augustss #endif
601 1.5 augustss ++pipe->device->bus->stats.requests
602 1.5 augustss [pipe->endpoint->edesc->bmAttributes & UE_XFERTYPE];
603 1.1 augustss
604 1.1 augustss /* XXX check retry count */
605 1.1 augustss reqh->done = 1;
606 1.1 augustss if (reqh->status == USBD_NORMAL_COMPLETION &&
607 1.1 augustss reqh->actlen < reqh->length &&
608 1.1 augustss !(reqh->flags & USBD_SHORT_XFER_OK)) {
609 1.18 augustss DPRINTFN(-1, ("usbd_transfer_cb: short xfer %d<%d (bytes)\n",
610 1.1 augustss reqh->actlen, reqh->length));
611 1.1 augustss reqh->status = USBD_SHORT_XFER;
612 1.1 augustss }
613 1.1 augustss if (reqh->callback)
614 1.1 augustss reqh->callback(reqh, reqh->priv, reqh->status);
615 1.1 augustss }
616 1.1 augustss
617 1.1 augustss static void
618 1.1 augustss usbd_sync_transfer_cb(reqh)
619 1.1 augustss usbd_request_handle reqh;
620 1.1 augustss {
621 1.22 augustss DPRINTFN(10, ("usbd_sync_transfer_cb: reqh=%p\n", reqh));
622 1.1 augustss usbd_transfer_cb(reqh);
623 1.8 augustss if (!reqh->pipe->device->bus->use_polling)
624 1.1 augustss wakeup(reqh);
625 1.1 augustss }
626 1.1 augustss
627 1.1 augustss /* Like usbd_transfer(), but waits for completion. */
628 1.1 augustss usbd_status
629 1.1 augustss usbd_sync_transfer(reqh)
630 1.1 augustss usbd_request_handle reqh;
631 1.1 augustss {
632 1.1 augustss usbd_status r;
633 1.1 augustss int s;
634 1.1 augustss
635 1.1 augustss reqh->xfercb = usbd_sync_transfer_cb;
636 1.1 augustss r = usbd_do_transfer(reqh);
637 1.1 augustss if (r != USBD_IN_PROGRESS)
638 1.1 augustss return (r);
639 1.1 augustss s = splusb();
640 1.1 augustss if (!reqh->done) {
641 1.8 augustss if (reqh->pipe->device->bus->use_polling)
642 1.1 augustss panic("usbd_sync_transfer: not done\n");
643 1.1 augustss tsleep(reqh, PRIBIO, "usbsyn", 0);
644 1.1 augustss }
645 1.1 augustss splx(s);
646 1.1 augustss return (reqh->status);
647 1.1 augustss }
648 1.1 augustss
649 1.1 augustss usbd_status
650 1.1 augustss usbd_do_request(dev, req, data)
651 1.1 augustss usbd_device_handle dev;
652 1.1 augustss usb_device_request_t *req;
653 1.1 augustss void *data;
654 1.1 augustss {
655 1.19 augustss return (usbd_do_request_flags(dev, req, data, 0, 0));
656 1.17 augustss }
657 1.17 augustss
658 1.17 augustss usbd_status
659 1.19 augustss usbd_do_request_flags(dev, req, data, flags, actlen)
660 1.17 augustss usbd_device_handle dev;
661 1.17 augustss usb_device_request_t *req;
662 1.17 augustss void *data;
663 1.17 augustss u_int16_t flags;
664 1.19 augustss int *actlen;
665 1.17 augustss {
666 1.1 augustss usbd_request_handle reqh;
667 1.1 augustss usbd_status r;
668 1.1 augustss
669 1.7 augustss #ifdef DIAGNOSTIC
670 1.7 augustss if (!curproc) {
671 1.7 augustss printf("usbd_do_request: not in process context\n");
672 1.7 augustss return (USBD_XXX);
673 1.7 augustss }
674 1.7 augustss #endif
675 1.7 augustss
676 1.1 augustss reqh = usbd_alloc_request();
677 1.1 augustss if (reqh == 0)
678 1.1 augustss return (USBD_NOMEM);
679 1.1 augustss r = usbd_setup_default_request(
680 1.1 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, req, data,
681 1.17 augustss UGETW(req->wLength), flags, 0);
682 1.15 augustss if (r != USBD_NORMAL_COMPLETION)
683 1.15 augustss goto bad;
684 1.1 augustss r = usbd_sync_transfer(reqh);
685 1.1 augustss #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
686 1.1 augustss if (reqh->actlen > reqh->length)
687 1.14 augustss printf("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
688 1.14 augustss "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
689 1.1 augustss dev->address, reqh->request.bmRequestType,
690 1.1 augustss reqh->request.bRequest, UGETW(reqh->request.wValue),
691 1.1 augustss UGETW(reqh->request.wIndex),
692 1.1 augustss UGETW(reqh->request.wLength),
693 1.1 augustss reqh->length, reqh->actlen);
694 1.1 augustss #endif
695 1.19 augustss if (actlen)
696 1.19 augustss *actlen = reqh->actlen;
697 1.15 augustss if (r == USBD_STALLED) {
698 1.15 augustss /*
699 1.15 augustss * The control endpoint has stalled. Control endpoints
700 1.15 augustss * should not halt, but some may do so anyway so clear
701 1.15 augustss * any halt condition.
702 1.15 augustss */
703 1.15 augustss usb_device_request_t treq;
704 1.15 augustss usb_status_t status;
705 1.15 augustss u_int16_t s;
706 1.15 augustss usbd_status nr;
707 1.15 augustss
708 1.15 augustss treq.bmRequestType = UT_READ_ENDPOINT;
709 1.15 augustss treq.bRequest = UR_GET_STATUS;
710 1.15 augustss USETW(treq.wValue, 0);
711 1.15 augustss USETW(treq.wIndex, 0);
712 1.15 augustss USETW(treq.wLength, sizeof(usb_status_t));
713 1.15 augustss nr = usbd_setup_default_request(
714 1.15 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, &treq, &status,
715 1.15 augustss sizeof(usb_status_t), 0, 0);
716 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
717 1.15 augustss goto bad;
718 1.15 augustss nr = usbd_sync_transfer(reqh);
719 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
720 1.15 augustss goto bad;
721 1.15 augustss s = UGETW(status.wStatus);
722 1.15 augustss DPRINTF(("usbd_do_request: status = 0x%04x\n", s));
723 1.15 augustss if (!(s & UES_HALT))
724 1.15 augustss goto bad;
725 1.15 augustss treq.bmRequestType = UT_WRITE_ENDPOINT;
726 1.15 augustss treq.bRequest = UR_CLEAR_FEATURE;
727 1.15 augustss USETW(treq.wValue, UF_ENDPOINT_HALT);
728 1.15 augustss USETW(treq.wIndex, 0);
729 1.15 augustss USETW(treq.wLength, 0);
730 1.15 augustss nr = usbd_setup_default_request(
731 1.15 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, &treq, &status,
732 1.15 augustss 0, 0, 0);
733 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
734 1.15 augustss goto bad;
735 1.15 augustss nr = usbd_sync_transfer(reqh);
736 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
737 1.15 augustss goto bad;
738 1.15 augustss }
739 1.15 augustss
740 1.15 augustss bad:
741 1.1 augustss usbd_free_request(reqh);
742 1.1 augustss return (r);
743 1.7 augustss }
744 1.7 augustss
745 1.7 augustss void
746 1.7 augustss usbd_do_request_async_cb(reqh, priv, status)
747 1.7 augustss usbd_request_handle reqh;
748 1.7 augustss usbd_private_handle priv;
749 1.7 augustss usbd_status status;
750 1.7 augustss {
751 1.7 augustss #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
752 1.7 augustss if (reqh->actlen > reqh->length)
753 1.14 augustss printf("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
754 1.14 augustss "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
755 1.7 augustss reqh->pipe->device->address,
756 1.7 augustss reqh->request.bmRequestType,
757 1.7 augustss reqh->request.bRequest, UGETW(reqh->request.wValue),
758 1.7 augustss UGETW(reqh->request.wIndex),
759 1.7 augustss UGETW(reqh->request.wLength),
760 1.7 augustss reqh->length, reqh->actlen);
761 1.7 augustss #endif
762 1.7 augustss usbd_free_request(reqh);
763 1.7 augustss }
764 1.7 augustss
765 1.7 augustss /*
766 1.7 augustss * Execute a request without waiting for completion.
767 1.7 augustss * Can be used from interrupt context.
768 1.7 augustss */
769 1.7 augustss usbd_status
770 1.7 augustss usbd_do_request_async(dev, req, data)
771 1.7 augustss usbd_device_handle dev;
772 1.7 augustss usb_device_request_t *req;
773 1.7 augustss void *data;
774 1.7 augustss {
775 1.7 augustss usbd_request_handle reqh;
776 1.7 augustss usbd_status r;
777 1.7 augustss
778 1.7 augustss reqh = usbd_alloc_request();
779 1.7 augustss if (reqh == 0)
780 1.7 augustss return (USBD_NOMEM);
781 1.7 augustss r = usbd_setup_default_request(
782 1.7 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, req, data,
783 1.7 augustss UGETW(req->wLength), 0, usbd_do_request_async_cb);
784 1.7 augustss if (r != USBD_NORMAL_COMPLETION) {
785 1.7 augustss usbd_free_request(reqh);
786 1.7 augustss return (r);
787 1.7 augustss }
788 1.7 augustss r = usbd_transfer(reqh);
789 1.7 augustss if (r != USBD_IN_PROGRESS)
790 1.7 augustss return (r);
791 1.7 augustss return (USBD_NORMAL_COMPLETION);
792 1.1 augustss }
793 1.1 augustss
794 1.1 augustss struct usbd_quirks *
795 1.1 augustss usbd_get_quirks(dev)
796 1.1 augustss usbd_device_handle dev;
797 1.1 augustss {
798 1.1 augustss return (dev->quirks);
799 1.1 augustss }
800 1.1 augustss
801 1.1 augustss /* XXX do periodic free() of free list */
802 1.1 augustss
803 1.6 augustss /*
804 1.6 augustss * Called from keyboard driver when in polling mode.
805 1.6 augustss */
806 1.6 augustss void
807 1.6 augustss usbd_dopoll(iface)
808 1.6 augustss usbd_interface_handle iface;
809 1.6 augustss {
810 1.6 augustss iface->device->bus->do_poll(iface->device->bus);
811 1.8 augustss }
812 1.8 augustss
813 1.8 augustss void
814 1.8 augustss usbd_set_polling(iface, on)
815 1.8 augustss usbd_interface_handle iface;
816 1.8 augustss int on;
817 1.8 augustss {
818 1.8 augustss iface->device->bus->use_polling = on;
819 1.6 augustss }
820 1.12 augustss
821 1.12 augustss
822 1.12 augustss usb_endpoint_descriptor_t *
823 1.12 augustss usbd_get_endpoint_descriptor(iface, address)
824 1.12 augustss usbd_interface_handle iface;
825 1.12 augustss u_int8_t address;
826 1.12 augustss {
827 1.12 augustss struct usbd_endpoint *ep;
828 1.12 augustss int i;
829 1.12 augustss
830 1.12 augustss for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
831 1.12 augustss ep = &iface->endpoints[i];
832 1.12 augustss if (ep->edesc->bEndpointAddress == address)
833 1.12 augustss return (iface->endpoints[i].edesc);
834 1.12 augustss }
835 1.12 augustss return (0);
836 1.12 augustss }
837 1.12 augustss
838 1.20 augustss #if defined(__FreeBSD__)
839 1.20 augustss void
840 1.20 augustss usbd_print_child(device_t parent, device_t child)
841 1.20 augustss {
842 1.20 augustss /*
843 1.20 augustss struct usb_softc *sc = device_get_softc(child);
844 1.20 augustss */
845 1.20 augustss
846 1.20 augustss printf(" at %s%d", device_get_name(parent), device_get_unit(parent));
847 1.20 augustss
848 1.20 augustss /* XXX How do we get to the usbd_device_handle???
849 1.20 augustss usbd_device_handle dev = invalidadosch;
850 1.20 augustss
851 1.20 augustss printf(" addr %d", dev->addr);
852 1.20 augustss
853 1.20 augustss if (bootverbose) {
854 1.20 augustss if (dev->lowspeed)
855 1.20 augustss printf(", lowspeed");
856 1.20 augustss if (dev->self_powered)
857 1.20 augustss printf(", self powered");
858 1.20 augustss else
859 1.20 augustss printf(", %dmA", dev->power);
860 1.20 augustss printf(", config %d", dev->config);
861 1.20 augustss }
862 1.20 augustss */
863 1.20 augustss }
864 1.20 augustss
865 1.20 augustss /* Reconfigure all the USB busses in the system. */
866 1.20 augustss int
867 1.20 augustss usbd_driver_load(module_t mod, int what, void *arg)
868 1.20 augustss {
869 1.20 augustss devclass_t usb_devclass = devclass_find("usb");
870 1.20 augustss devclass_t ugen_devclass = devclass_find("ugen");
871 1.20 augustss device_t *devlist;
872 1.20 augustss int devcount;
873 1.20 augustss int error;
874 1.20 augustss
875 1.20 augustss switch (what) {
876 1.20 augustss case MOD_LOAD:
877 1.20 augustss case MOD_UNLOAD:
878 1.20 augustss if (!usb_devclass)
879 1.20 augustss return 0; /* just ignore call */
880 1.20 augustss
881 1.20 augustss if (ugen_devclass) {
882 1.20 augustss /* detach devices from generic driver if possible */
883 1.20 augustss error = devclass_get_devices(ugen_devclass, &devlist,
884 1.20 augustss &devcount);
885 1.20 augustss if (!error)
886 1.20 augustss for (devcount--; devcount >= 0; devcount--)
887 1.20 augustss (void)DEVICE_DETACH(devlist[devcount]);
888 1.20 augustss }
889 1.20 augustss
890 1.20 augustss error = devclass_get_devices(usb_devclass, &devlist, &devcount);
891 1.20 augustss if (error)
892 1.20 augustss return 0; /* XXX maybe transient, or error? */
893 1.20 augustss
894 1.20 augustss for (devcount--; devcount >= 0; devcount--)
895 1.20 augustss USB_RECONFIGURE(devlist[devcount]);
896 1.20 augustss
897 1.20 augustss free(devlist, M_TEMP);
898 1.20 augustss return 0;
899 1.20 augustss }
900 1.20 augustss
901 1.20 augustss return 0; /* nothing to do by us */
902 1.20 augustss }
903 1.20 augustss
904 1.20 augustss /* Set the description of the device including a malloc and copy. */
905 1.20 augustss void
906 1.20 augustss usbd_device_set_desc(device_t device, char *devinfo)
907 1.20 augustss {
908 1.20 augustss size_t l;
909 1.20 augustss char *desc;
910 1.20 augustss
911 1.20 augustss if ( devinfo ) {
912 1.20 augustss l = strlen(devinfo);
913 1.20 augustss desc = malloc(l+1, M_USB, M_NOWAIT);
914 1.20 augustss if (desc)
915 1.20 augustss memcpy(desc, devinfo, l+1);
916 1.20 augustss } else
917 1.20 augustss desc = NULL;
918 1.20 augustss
919 1.20 augustss device_set_desc(device, desc);
920 1.20 augustss }
921 1.20 augustss
922 1.20 augustss char *
923 1.20 augustss usbd_devname(bdevice *bdev)
924 1.20 augustss {
925 1.20 augustss static char buf[20];
926 1.21 augustss /*
927 1.21 augustss * A static buffer is a loss if this routine is used from an interrupt,
928 1.21 augustss * but it's not fatal.
929 1.21 augustss */
930 1.20 augustss
931 1.20 augustss sprintf(buf, "%s%d", device_get_name(*bdev), device_get_unit(*bdev));
932 1.20 augustss return (buf);
933 1.20 augustss }
934 1.20 augustss
935 1.20 augustss #endif
936