usbdi.c revision 1.27 1 1.27 augustss /* $NetBSD: usbdi.c,v 1.27 1999/08/14 14:49:32 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.27 augustss #define DPRINTF(x) if (usbdebug) logprintf x
65 1.27 augustss #define DPRINTFN(n,x) if (usbdebug>(n)) logprintf 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.27 augustss usbd_open_pipe_iso(iface, address, flags, pipe, priv, bufsize, nbuf)
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 {
170 1.9 augustss usbd_status r;
171 1.9 augustss usbd_pipe_handle p;
172 1.9 augustss
173 1.9 augustss r = usbd_open_pipe(iface, address, USBD_EXCLUSIVE_USE, &p);
174 1.9 augustss if (r != USBD_NORMAL_COMPLETION)
175 1.9 augustss return (r);
176 1.9 augustss if (!p->methods->isobuf) {
177 1.9 augustss usbd_close_pipe(p);
178 1.9 augustss return (USBD_INVAL);
179 1.9 augustss }
180 1.9 augustss r = p->methods->isobuf(p, bufsize, nbuf);
181 1.9 augustss if (r != USBD_NORMAL_COMPLETION) {
182 1.9 augustss usbd_close_pipe(p);
183 1.9 augustss return (r);
184 1.9 augustss }
185 1.9 augustss *pipe = p;
186 1.9 augustss return r;
187 1.9 augustss }
188 1.9 augustss
189 1.1 augustss usbd_status
190 1.1 augustss usbd_close_pipe(pipe)
191 1.1 augustss usbd_pipe_handle pipe;
192 1.1 augustss {
193 1.26 augustss #ifdef DIAGNOSTIC
194 1.26 augustss if (pipe == 0) {
195 1.26 augustss printf("usbd_close_pipe: pipe==NULL\n");
196 1.26 augustss return (USBD_NORMAL_COMPLETION);
197 1.26 augustss }
198 1.26 augustss #endif
199 1.26 augustss
200 1.1 augustss if (--pipe->refcnt != 0)
201 1.1 augustss return (USBD_NORMAL_COMPLETION);
202 1.1 augustss if (SIMPLEQ_FIRST(&pipe->queue) != 0)
203 1.1 augustss return (USBD_PENDING_REQUESTS);
204 1.1 augustss LIST_REMOVE(pipe, next);
205 1.1 augustss pipe->endpoint->refcnt--;
206 1.1 augustss pipe->methods->close(pipe);
207 1.1 augustss if (pipe->intrreqh)
208 1.1 augustss usbd_free_request(pipe->intrreqh);
209 1.1 augustss free(pipe, M_USB);
210 1.1 augustss return (USBD_NORMAL_COMPLETION);
211 1.1 augustss }
212 1.1 augustss
213 1.1 augustss usbd_status
214 1.1 augustss usbd_transfer(reqh)
215 1.1 augustss usbd_request_handle reqh;
216 1.1 augustss {
217 1.1 augustss reqh->xfercb = usbd_transfer_cb;
218 1.1 augustss return (usbd_do_transfer(reqh));
219 1.1 augustss }
220 1.1 augustss
221 1.1 augustss static usbd_status
222 1.1 augustss usbd_do_transfer(reqh)
223 1.1 augustss usbd_request_handle reqh;
224 1.1 augustss {
225 1.1 augustss usbd_pipe_handle pipe = reqh->pipe;
226 1.16 augustss
227 1.16 augustss DPRINTFN(10,("usbd_do_transfer: reqh=%p\n", reqh));
228 1.16 augustss reqh->done = 0;
229 1.16 augustss return (pipe->methods->transfer(reqh));
230 1.16 augustss }
231 1.16 augustss
232 1.1 augustss usbd_request_handle
233 1.1 augustss usbd_alloc_request()
234 1.1 augustss {
235 1.1 augustss usbd_request_handle reqh;
236 1.1 augustss
237 1.1 augustss reqh = SIMPLEQ_FIRST(&usbd_free_requests);
238 1.1 augustss if (reqh)
239 1.1 augustss SIMPLEQ_REMOVE_HEAD(&usbd_free_requests, reqh, next);
240 1.1 augustss else
241 1.1 augustss reqh = malloc(sizeof(*reqh), M_USB, M_NOWAIT);
242 1.1 augustss if (!reqh)
243 1.1 augustss return (0);
244 1.1 augustss memset(reqh, 0, sizeof *reqh);
245 1.25 augustss DPRINTFN(1,("usbd_alloc_request() = %p\n", reqh));
246 1.1 augustss return (reqh);
247 1.1 augustss }
248 1.1 augustss
249 1.1 augustss usbd_status
250 1.1 augustss usbd_free_request(reqh)
251 1.1 augustss usbd_request_handle reqh;
252 1.1 augustss {
253 1.25 augustss DPRINTFN(1,("usbd_free_request: %p\n", reqh));
254 1.1 augustss SIMPLEQ_INSERT_HEAD(&usbd_free_requests, reqh, next);
255 1.1 augustss return (USBD_NORMAL_COMPLETION);
256 1.1 augustss }
257 1.1 augustss
258 1.1 augustss usbd_status
259 1.1 augustss usbd_setup_request(reqh, pipe, priv, buffer, length, flags, timeout, callback)
260 1.1 augustss usbd_request_handle reqh;
261 1.1 augustss usbd_pipe_handle pipe;
262 1.1 augustss usbd_private_handle priv;
263 1.1 augustss void *buffer;
264 1.1 augustss u_int32_t length;
265 1.1 augustss u_int16_t flags;
266 1.1 augustss u_int32_t timeout;
267 1.1 augustss void (*callback) __P((usbd_request_handle,
268 1.1 augustss usbd_private_handle,
269 1.1 augustss usbd_status));
270 1.1 augustss {
271 1.1 augustss reqh->pipe = pipe;
272 1.1 augustss reqh->priv = priv;
273 1.1 augustss reqh->buffer = buffer;
274 1.1 augustss reqh->length = length;
275 1.1 augustss reqh->actlen = 0;
276 1.1 augustss reqh->flags = flags;
277 1.22 augustss reqh->timeout = timeout;
278 1.22 augustss reqh->status = USBD_NOT_STARTED;
279 1.1 augustss reqh->callback = callback;
280 1.1 augustss reqh->retries = 1;
281 1.22 augustss reqh->isreq = 0;
282 1.1 augustss return (USBD_NORMAL_COMPLETION);
283 1.1 augustss }
284 1.1 augustss
285 1.1 augustss usbd_status
286 1.1 augustss usbd_setup_default_request(reqh, dev, priv, timeout, req, buffer,
287 1.1 augustss length, flags, callback)
288 1.1 augustss usbd_request_handle reqh;
289 1.1 augustss usbd_device_handle dev;
290 1.1 augustss usbd_private_handle priv;
291 1.1 augustss u_int32_t timeout;
292 1.1 augustss usb_device_request_t *req;
293 1.1 augustss void *buffer;
294 1.1 augustss u_int32_t length;
295 1.1 augustss u_int16_t flags;
296 1.1 augustss void (*callback) __P((usbd_request_handle,
297 1.1 augustss usbd_private_handle,
298 1.1 augustss usbd_status));
299 1.1 augustss {
300 1.1 augustss reqh->pipe = dev->default_pipe;
301 1.1 augustss reqh->priv = priv;
302 1.1 augustss reqh->buffer = buffer;
303 1.1 augustss reqh->length = length;
304 1.1 augustss reqh->actlen = 0;
305 1.1 augustss reqh->flags = flags;
306 1.1 augustss reqh->timeout = timeout;
307 1.1 augustss reqh->status = USBD_NOT_STARTED;
308 1.1 augustss reqh->callback = callback;
309 1.1 augustss reqh->request = *req;
310 1.22 augustss reqh->retries = 1;
311 1.1 augustss reqh->isreq = 1;
312 1.1 augustss return (USBD_NORMAL_COMPLETION);
313 1.1 augustss }
314 1.1 augustss
315 1.1 augustss usbd_status
316 1.1 augustss usbd_get_request_status(reqh, priv, buffer, count, status)
317 1.1 augustss usbd_request_handle reqh;
318 1.1 augustss usbd_private_handle *priv;
319 1.1 augustss void **buffer;
320 1.1 augustss u_int32_t *count;
321 1.1 augustss usbd_status *status;
322 1.1 augustss {
323 1.1 augustss *priv = reqh->priv;
324 1.1 augustss *buffer = reqh->buffer;
325 1.1 augustss *count = reqh->actlen;
326 1.1 augustss *status = reqh->status;
327 1.1 augustss return (USBD_NORMAL_COMPLETION);
328 1.1 augustss }
329 1.1 augustss
330 1.1 augustss usb_config_descriptor_t *
331 1.1 augustss usbd_get_config_descriptor(dev)
332 1.1 augustss usbd_device_handle dev;
333 1.1 augustss {
334 1.1 augustss return (dev->cdesc);
335 1.1 augustss }
336 1.1 augustss
337 1.1 augustss usb_interface_descriptor_t *
338 1.1 augustss usbd_get_interface_descriptor(iface)
339 1.1 augustss usbd_interface_handle iface;
340 1.1 augustss {
341 1.1 augustss return (iface->idesc);
342 1.1 augustss }
343 1.1 augustss
344 1.1 augustss usb_device_descriptor_t *
345 1.1 augustss usbd_get_device_descriptor(dev)
346 1.1 augustss usbd_device_handle dev;
347 1.1 augustss {
348 1.1 augustss return (&dev->ddesc);
349 1.1 augustss }
350 1.1 augustss
351 1.1 augustss usb_endpoint_descriptor_t *
352 1.1 augustss usbd_interface2endpoint_descriptor(iface, index)
353 1.1 augustss usbd_interface_handle iface;
354 1.1 augustss u_int8_t index;
355 1.1 augustss {
356 1.1 augustss if (index >= iface->idesc->bNumEndpoints)
357 1.12 augustss return (0);
358 1.1 augustss return (iface->endpoints[index].edesc);
359 1.1 augustss }
360 1.1 augustss
361 1.12 augustss usbd_status
362 1.1 augustss usbd_abort_pipe(pipe)
363 1.1 augustss usbd_pipe_handle pipe;
364 1.1 augustss {
365 1.1 augustss usbd_status r;
366 1.24 augustss int s;
367 1.1 augustss
368 1.26 augustss #ifdef DIAGNOSTIC
369 1.26 augustss if (pipe == 0) {
370 1.26 augustss printf("usbd_close_pipe: pipe==NULL\n");
371 1.26 augustss return (USBD_NORMAL_COMPLETION);
372 1.26 augustss }
373 1.26 augustss #endif
374 1.1 augustss s = splusb();
375 1.1 augustss r = usbd_ar_pipe(pipe);
376 1.1 augustss splx(s);
377 1.1 augustss return (r);
378 1.1 augustss }
379 1.1 augustss
380 1.1 augustss usbd_status
381 1.1 augustss usbd_clear_endpoint_stall(pipe)
382 1.1 augustss usbd_pipe_handle pipe;
383 1.1 augustss {
384 1.1 augustss usbd_device_handle dev = pipe->device;
385 1.1 augustss usb_device_request_t req;
386 1.1 augustss usbd_status r;
387 1.1 augustss
388 1.22 augustss DPRINTFN(8, ("usbd_clear_endpoint_stall\n"));
389 1.1 augustss req.bmRequestType = UT_WRITE_ENDPOINT;
390 1.1 augustss req.bRequest = UR_CLEAR_FEATURE;
391 1.15 augustss USETW(req.wValue, UF_ENDPOINT_HALT);
392 1.7 augustss USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
393 1.1 augustss USETW(req.wLength, 0);
394 1.1 augustss r = usbd_do_request(dev, &req, 0);
395 1.1 augustss #if 0
396 1.1 augustss XXX should we do this?
397 1.1 augustss if (r == USBD_NORMAL_COMPLETION) {
398 1.1 augustss pipe->state = USBD_PIPE_ACTIVE;
399 1.1 augustss /* XXX activate pipe */
400 1.1 augustss }
401 1.1 augustss #endif
402 1.1 augustss return (r);
403 1.1 augustss }
404 1.1 augustss
405 1.1 augustss usbd_status
406 1.7 augustss usbd_clear_endpoint_stall_async(pipe)
407 1.7 augustss usbd_pipe_handle pipe;
408 1.7 augustss {
409 1.7 augustss usbd_device_handle dev = pipe->device;
410 1.7 augustss usb_device_request_t req;
411 1.7 augustss usbd_status r;
412 1.7 augustss
413 1.7 augustss req.bmRequestType = UT_WRITE_ENDPOINT;
414 1.7 augustss req.bRequest = UR_CLEAR_FEATURE;
415 1.15 augustss USETW(req.wValue, UF_ENDPOINT_HALT);
416 1.7 augustss USETW(req.wIndex, pipe->endpoint->edesc->bEndpointAddress);
417 1.7 augustss USETW(req.wLength, 0);
418 1.7 augustss r = usbd_do_request_async(dev, &req, 0);
419 1.7 augustss return (r);
420 1.7 augustss }
421 1.7 augustss
422 1.7 augustss usbd_status
423 1.1 augustss usbd_endpoint_count(iface, count)
424 1.1 augustss usbd_interface_handle iface;
425 1.1 augustss u_int8_t *count;
426 1.1 augustss {
427 1.1 augustss *count = iface->idesc->bNumEndpoints;
428 1.1 augustss return (USBD_NORMAL_COMPLETION);
429 1.1 augustss }
430 1.1 augustss
431 1.1 augustss usbd_status
432 1.1 augustss usbd_interface_count(dev, count)
433 1.1 augustss usbd_device_handle dev;
434 1.1 augustss u_int8_t *count;
435 1.1 augustss {
436 1.1 augustss if (!dev->cdesc)
437 1.1 augustss return (USBD_NOT_CONFIGURED);
438 1.1 augustss *count = dev->cdesc->bNumInterface;
439 1.1 augustss return (USBD_NORMAL_COMPLETION);
440 1.1 augustss }
441 1.1 augustss
442 1.1 augustss usbd_status
443 1.1 augustss usbd_interface2device_handle(iface, dev)
444 1.1 augustss usbd_interface_handle iface;
445 1.1 augustss usbd_device_handle *dev;
446 1.1 augustss {
447 1.1 augustss *dev = iface->device;
448 1.1 augustss return (USBD_NORMAL_COMPLETION);
449 1.1 augustss }
450 1.1 augustss
451 1.1 augustss usbd_status
452 1.1 augustss usbd_device2interface_handle(dev, ifaceno, iface)
453 1.1 augustss usbd_device_handle dev;
454 1.1 augustss u_int8_t ifaceno;
455 1.1 augustss usbd_interface_handle *iface;
456 1.1 augustss {
457 1.1 augustss if (!dev->cdesc)
458 1.1 augustss return (USBD_NOT_CONFIGURED);
459 1.1 augustss if (ifaceno >= dev->cdesc->bNumInterface)
460 1.1 augustss return (USBD_INVAL);
461 1.1 augustss *iface = &dev->ifaces[ifaceno];
462 1.1 augustss return (USBD_NORMAL_COMPLETION);
463 1.1 augustss }
464 1.1 augustss
465 1.13 augustss /* XXXX use altno */
466 1.3 augustss usbd_status
467 1.13 augustss usbd_set_interface(iface, altidx)
468 1.3 augustss usbd_interface_handle iface;
469 1.13 augustss int altidx;
470 1.3 augustss {
471 1.3 augustss usb_device_request_t req;
472 1.13 augustss usbd_status r;
473 1.13 augustss
474 1.13 augustss if (LIST_FIRST(&iface->pipes) != 0)
475 1.13 augustss return (USBD_IN_USE);
476 1.13 augustss
477 1.16 augustss if (iface->endpoints)
478 1.16 augustss free(iface->endpoints, M_USB);
479 1.13 augustss iface->endpoints = 0;
480 1.13 augustss iface->idesc = 0;
481 1.13 augustss
482 1.13 augustss r = usbd_fill_iface_data(iface->device, iface->index, altidx);
483 1.13 augustss if (r != USBD_NORMAL_COMPLETION)
484 1.13 augustss return (r);
485 1.3 augustss
486 1.3 augustss req.bmRequestType = UT_WRITE_INTERFACE;
487 1.3 augustss req.bRequest = UR_SET_INTERFACE;
488 1.13 augustss USETW(req.wValue, iface->idesc->bAlternateSetting);
489 1.16 augustss USETW(req.wIndex, iface->idesc->bInterfaceNumber);
490 1.3 augustss USETW(req.wLength, 0);
491 1.3 augustss return usbd_do_request(iface->device, &req, 0);
492 1.12 augustss }
493 1.12 augustss
494 1.12 augustss int
495 1.13 augustss usbd_get_no_alts(cdesc, ifaceno)
496 1.13 augustss usb_config_descriptor_t *cdesc;
497 1.13 augustss int ifaceno;
498 1.12 augustss {
499 1.13 augustss char *p = (char *)cdesc;
500 1.13 augustss char *end = p + UGETW(cdesc->wTotalLength);
501 1.12 augustss usb_interface_descriptor_t *d;
502 1.12 augustss int n;
503 1.12 augustss
504 1.12 augustss for (n = 0; p < end; p += d->bLength) {
505 1.12 augustss d = (usb_interface_descriptor_t *)p;
506 1.12 augustss if (p + d->bLength <= end &&
507 1.12 augustss d->bDescriptorType == UDESC_INTERFACE &&
508 1.13 augustss d->bInterfaceNumber == ifaceno)
509 1.12 augustss n++;
510 1.12 augustss }
511 1.12 augustss return (n);
512 1.13 augustss }
513 1.13 augustss
514 1.13 augustss int
515 1.13 augustss usbd_get_interface_altindex(iface)
516 1.13 augustss usbd_interface_handle iface;
517 1.13 augustss {
518 1.13 augustss return (iface->altindex);
519 1.12 augustss }
520 1.12 augustss
521 1.12 augustss usbd_status
522 1.12 augustss usbd_get_interface(iface, aiface)
523 1.12 augustss usbd_interface_handle iface;
524 1.12 augustss u_int8_t *aiface;
525 1.12 augustss {
526 1.12 augustss usb_device_request_t req;
527 1.12 augustss
528 1.12 augustss req.bmRequestType = UT_READ_INTERFACE;
529 1.12 augustss req.bRequest = UR_GET_INTERFACE;
530 1.12 augustss USETW(req.wValue, 0);
531 1.16 augustss USETW(req.wIndex, iface->idesc->bInterfaceNumber);
532 1.12 augustss USETW(req.wLength, 1);
533 1.12 augustss return usbd_do_request(iface->device, &req, aiface);
534 1.3 augustss }
535 1.1 augustss
536 1.1 augustss /*** Internal routines ***/
537 1.1 augustss
538 1.1 augustss /* Dequeue all pipe operations, called at splusb(). */
539 1.1 augustss static usbd_status
540 1.1 augustss usbd_ar_pipe(pipe)
541 1.1 augustss usbd_pipe_handle pipe;
542 1.1 augustss {
543 1.1 augustss usbd_request_handle reqh;
544 1.1 augustss
545 1.20 augustss #if 0
546 1.1 augustss for (;;) {
547 1.1 augustss reqh = SIMPLEQ_FIRST(&pipe->queue);
548 1.1 augustss if (reqh == 0)
549 1.1 augustss break;
550 1.1 augustss SIMPLEQ_REMOVE_HEAD(&pipe->queue, reqh, next);
551 1.1 augustss reqh->status = USBD_CANCELLED;
552 1.1 augustss if (reqh->callback)
553 1.1 augustss reqh->callback(reqh, reqh->priv, reqh->status);
554 1.1 augustss }
555 1.20 augustss #else
556 1.25 augustss DPRINTFN(2,("usbd_ar_pipe: pipe=%p\n", pipe));
557 1.20 augustss while ((reqh = SIMPLEQ_FIRST(&pipe->queue))) {
558 1.25 augustss DPRINTFN(2,("usbd_ar_pipe: reqh=%p (methods=%p)\n",
559 1.25 augustss pipe, pipe->methods));
560 1.20 augustss pipe->methods->abort(reqh);
561 1.20 augustss SIMPLEQ_REMOVE_HEAD(&pipe->queue, reqh, next);
562 1.20 augustss }
563 1.20 augustss #endif
564 1.1 augustss return (USBD_NORMAL_COMPLETION);
565 1.1 augustss }
566 1.1 augustss
567 1.1 augustss static int usbd_global_init_done = 0;
568 1.1 augustss
569 1.1 augustss void
570 1.1 augustss usbd_init()
571 1.1 augustss {
572 1.15 augustss #if defined(__FreeBSD__)
573 1.15 augustss dev_t dev;
574 1.15 augustss #endif
575 1.15 augustss
576 1.1 augustss if (!usbd_global_init_done) {
577 1.1 augustss usbd_global_init_done = 1;
578 1.1 augustss SIMPLEQ_INIT(&usbd_free_requests);
579 1.15 augustss
580 1.15 augustss #if defined(__FreeBSD__)
581 1.15 augustss dev = makedev(USB_CDEV_MAJOR, 0);
582 1.15 augustss cdevsw_add(&dev, &usb_cdevsw, NULL);
583 1.15 augustss #endif
584 1.1 augustss }
585 1.1 augustss }
586 1.1 augustss
587 1.1 augustss static void
588 1.1 augustss usbd_transfer_cb(reqh)
589 1.1 augustss usbd_request_handle reqh;
590 1.1 augustss {
591 1.1 augustss usbd_pipe_handle pipe = reqh->pipe;
592 1.5 augustss
593 1.22 augustss DPRINTFN(10, ("usbd_transfer_cb: reqh=%p\n", reqh));
594 1.5 augustss /* Count completed transfers. */
595 1.23 augustss #ifdef DIAGNOSTIC
596 1.23 augustss if (!pipe)
597 1.23 augustss printf("usbd_transfer_cb: pipe==0, reqh=%p\n", reqh);
598 1.23 augustss else
599 1.23 augustss #endif
600 1.5 augustss ++pipe->device->bus->stats.requests
601 1.5 augustss [pipe->endpoint->edesc->bmAttributes & UE_XFERTYPE];
602 1.1 augustss
603 1.1 augustss /* XXX check retry count */
604 1.1 augustss reqh->done = 1;
605 1.1 augustss if (reqh->status == USBD_NORMAL_COMPLETION &&
606 1.1 augustss reqh->actlen < reqh->length &&
607 1.1 augustss !(reqh->flags & USBD_SHORT_XFER_OK)) {
608 1.18 augustss DPRINTFN(-1, ("usbd_transfer_cb: short xfer %d<%d (bytes)\n",
609 1.1 augustss reqh->actlen, reqh->length));
610 1.1 augustss reqh->status = USBD_SHORT_XFER;
611 1.1 augustss }
612 1.1 augustss if (reqh->callback)
613 1.1 augustss reqh->callback(reqh, reqh->priv, reqh->status);
614 1.1 augustss }
615 1.1 augustss
616 1.1 augustss static void
617 1.1 augustss usbd_sync_transfer_cb(reqh)
618 1.1 augustss usbd_request_handle reqh;
619 1.1 augustss {
620 1.22 augustss DPRINTFN(10, ("usbd_sync_transfer_cb: reqh=%p\n", reqh));
621 1.1 augustss usbd_transfer_cb(reqh);
622 1.8 augustss if (!reqh->pipe->device->bus->use_polling)
623 1.1 augustss wakeup(reqh);
624 1.1 augustss }
625 1.1 augustss
626 1.1 augustss /* Like usbd_transfer(), but waits for completion. */
627 1.1 augustss usbd_status
628 1.1 augustss usbd_sync_transfer(reqh)
629 1.1 augustss usbd_request_handle reqh;
630 1.1 augustss {
631 1.1 augustss usbd_status r;
632 1.1 augustss int s;
633 1.1 augustss
634 1.1 augustss reqh->xfercb = usbd_sync_transfer_cb;
635 1.1 augustss r = usbd_do_transfer(reqh);
636 1.1 augustss if (r != USBD_IN_PROGRESS)
637 1.1 augustss return (r);
638 1.1 augustss s = splusb();
639 1.1 augustss if (!reqh->done) {
640 1.8 augustss if (reqh->pipe->device->bus->use_polling)
641 1.1 augustss panic("usbd_sync_transfer: not done\n");
642 1.1 augustss tsleep(reqh, PRIBIO, "usbsyn", 0);
643 1.1 augustss }
644 1.1 augustss splx(s);
645 1.1 augustss return (reqh->status);
646 1.1 augustss }
647 1.1 augustss
648 1.1 augustss usbd_status
649 1.1 augustss usbd_do_request(dev, req, data)
650 1.1 augustss usbd_device_handle dev;
651 1.1 augustss usb_device_request_t *req;
652 1.1 augustss void *data;
653 1.1 augustss {
654 1.19 augustss return (usbd_do_request_flags(dev, req, data, 0, 0));
655 1.17 augustss }
656 1.17 augustss
657 1.17 augustss usbd_status
658 1.19 augustss usbd_do_request_flags(dev, req, data, flags, actlen)
659 1.17 augustss usbd_device_handle dev;
660 1.17 augustss usb_device_request_t *req;
661 1.17 augustss void *data;
662 1.17 augustss u_int16_t flags;
663 1.19 augustss int *actlen;
664 1.17 augustss {
665 1.1 augustss usbd_request_handle reqh;
666 1.1 augustss usbd_status r;
667 1.1 augustss
668 1.7 augustss #ifdef DIAGNOSTIC
669 1.7 augustss if (!curproc) {
670 1.7 augustss printf("usbd_do_request: not in process context\n");
671 1.7 augustss return (USBD_XXX);
672 1.7 augustss }
673 1.7 augustss #endif
674 1.7 augustss
675 1.1 augustss reqh = usbd_alloc_request();
676 1.1 augustss if (reqh == 0)
677 1.1 augustss return (USBD_NOMEM);
678 1.1 augustss r = usbd_setup_default_request(
679 1.1 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, req, data,
680 1.17 augustss UGETW(req->wLength), flags, 0);
681 1.15 augustss if (r != USBD_NORMAL_COMPLETION)
682 1.15 augustss goto bad;
683 1.1 augustss r = usbd_sync_transfer(reqh);
684 1.1 augustss #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
685 1.1 augustss if (reqh->actlen > reqh->length)
686 1.14 augustss printf("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
687 1.14 augustss "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
688 1.1 augustss dev->address, reqh->request.bmRequestType,
689 1.1 augustss reqh->request.bRequest, UGETW(reqh->request.wValue),
690 1.1 augustss UGETW(reqh->request.wIndex),
691 1.1 augustss UGETW(reqh->request.wLength),
692 1.1 augustss reqh->length, reqh->actlen);
693 1.1 augustss #endif
694 1.19 augustss if (actlen)
695 1.19 augustss *actlen = reqh->actlen;
696 1.15 augustss if (r == USBD_STALLED) {
697 1.15 augustss /*
698 1.15 augustss * The control endpoint has stalled. Control endpoints
699 1.15 augustss * should not halt, but some may do so anyway so clear
700 1.15 augustss * any halt condition.
701 1.15 augustss */
702 1.15 augustss usb_device_request_t treq;
703 1.15 augustss usb_status_t status;
704 1.15 augustss u_int16_t s;
705 1.15 augustss usbd_status nr;
706 1.15 augustss
707 1.15 augustss treq.bmRequestType = UT_READ_ENDPOINT;
708 1.15 augustss treq.bRequest = UR_GET_STATUS;
709 1.15 augustss USETW(treq.wValue, 0);
710 1.15 augustss USETW(treq.wIndex, 0);
711 1.15 augustss USETW(treq.wLength, sizeof(usb_status_t));
712 1.15 augustss nr = usbd_setup_default_request(
713 1.15 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, &treq, &status,
714 1.15 augustss sizeof(usb_status_t), 0, 0);
715 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
716 1.15 augustss goto bad;
717 1.15 augustss nr = usbd_sync_transfer(reqh);
718 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
719 1.15 augustss goto bad;
720 1.15 augustss s = UGETW(status.wStatus);
721 1.15 augustss DPRINTF(("usbd_do_request: status = 0x%04x\n", s));
722 1.15 augustss if (!(s & UES_HALT))
723 1.15 augustss goto bad;
724 1.15 augustss treq.bmRequestType = UT_WRITE_ENDPOINT;
725 1.15 augustss treq.bRequest = UR_CLEAR_FEATURE;
726 1.15 augustss USETW(treq.wValue, UF_ENDPOINT_HALT);
727 1.15 augustss USETW(treq.wIndex, 0);
728 1.15 augustss USETW(treq.wLength, 0);
729 1.15 augustss nr = usbd_setup_default_request(
730 1.15 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, &treq, &status,
731 1.15 augustss 0, 0, 0);
732 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
733 1.15 augustss goto bad;
734 1.15 augustss nr = usbd_sync_transfer(reqh);
735 1.15 augustss if (nr != USBD_NORMAL_COMPLETION)
736 1.15 augustss goto bad;
737 1.15 augustss }
738 1.15 augustss
739 1.15 augustss bad:
740 1.1 augustss usbd_free_request(reqh);
741 1.1 augustss return (r);
742 1.7 augustss }
743 1.7 augustss
744 1.7 augustss void
745 1.7 augustss usbd_do_request_async_cb(reqh, priv, status)
746 1.7 augustss usbd_request_handle reqh;
747 1.7 augustss usbd_private_handle priv;
748 1.7 augustss usbd_status status;
749 1.7 augustss {
750 1.7 augustss #if defined(USB_DEBUG) || defined(DIAGNOSTIC)
751 1.7 augustss if (reqh->actlen > reqh->length)
752 1.14 augustss printf("usbd_do_request: overrun addr=%d type=0x%02x req=0x"
753 1.14 augustss "%02x val=%d index=%d rlen=%d length=%d actlen=%d\n",
754 1.7 augustss reqh->pipe->device->address,
755 1.7 augustss reqh->request.bmRequestType,
756 1.7 augustss reqh->request.bRequest, UGETW(reqh->request.wValue),
757 1.7 augustss UGETW(reqh->request.wIndex),
758 1.7 augustss UGETW(reqh->request.wLength),
759 1.7 augustss reqh->length, reqh->actlen);
760 1.7 augustss #endif
761 1.7 augustss usbd_free_request(reqh);
762 1.7 augustss }
763 1.7 augustss
764 1.7 augustss /*
765 1.7 augustss * Execute a request without waiting for completion.
766 1.7 augustss * Can be used from interrupt context.
767 1.7 augustss */
768 1.7 augustss usbd_status
769 1.7 augustss usbd_do_request_async(dev, req, data)
770 1.7 augustss usbd_device_handle dev;
771 1.7 augustss usb_device_request_t *req;
772 1.7 augustss void *data;
773 1.7 augustss {
774 1.7 augustss usbd_request_handle reqh;
775 1.7 augustss usbd_status r;
776 1.7 augustss
777 1.7 augustss reqh = usbd_alloc_request();
778 1.7 augustss if (reqh == 0)
779 1.7 augustss return (USBD_NOMEM);
780 1.7 augustss r = usbd_setup_default_request(
781 1.7 augustss reqh, dev, 0, USBD_DEFAULT_TIMEOUT, req, data,
782 1.7 augustss UGETW(req->wLength), 0, usbd_do_request_async_cb);
783 1.7 augustss if (r != USBD_NORMAL_COMPLETION) {
784 1.7 augustss usbd_free_request(reqh);
785 1.7 augustss return (r);
786 1.7 augustss }
787 1.7 augustss r = usbd_transfer(reqh);
788 1.7 augustss if (r != USBD_IN_PROGRESS)
789 1.7 augustss return (r);
790 1.7 augustss return (USBD_NORMAL_COMPLETION);
791 1.1 augustss }
792 1.1 augustss
793 1.1 augustss struct usbd_quirks *
794 1.1 augustss usbd_get_quirks(dev)
795 1.1 augustss usbd_device_handle dev;
796 1.1 augustss {
797 1.1 augustss return (dev->quirks);
798 1.1 augustss }
799 1.1 augustss
800 1.1 augustss /* XXX do periodic free() of free list */
801 1.1 augustss
802 1.6 augustss /*
803 1.6 augustss * Called from keyboard driver when in polling mode.
804 1.6 augustss */
805 1.6 augustss void
806 1.6 augustss usbd_dopoll(iface)
807 1.6 augustss usbd_interface_handle iface;
808 1.6 augustss {
809 1.6 augustss iface->device->bus->do_poll(iface->device->bus);
810 1.8 augustss }
811 1.8 augustss
812 1.8 augustss void
813 1.8 augustss usbd_set_polling(iface, on)
814 1.8 augustss usbd_interface_handle iface;
815 1.8 augustss int on;
816 1.8 augustss {
817 1.8 augustss iface->device->bus->use_polling = on;
818 1.6 augustss }
819 1.12 augustss
820 1.12 augustss
821 1.12 augustss usb_endpoint_descriptor_t *
822 1.12 augustss usbd_get_endpoint_descriptor(iface, address)
823 1.12 augustss usbd_interface_handle iface;
824 1.12 augustss u_int8_t address;
825 1.12 augustss {
826 1.12 augustss struct usbd_endpoint *ep;
827 1.12 augustss int i;
828 1.12 augustss
829 1.12 augustss for (i = 0; i < iface->idesc->bNumEndpoints; i++) {
830 1.12 augustss ep = &iface->endpoints[i];
831 1.12 augustss if (ep->edesc->bEndpointAddress == address)
832 1.12 augustss return (iface->endpoints[i].edesc);
833 1.12 augustss }
834 1.12 augustss return (0);
835 1.12 augustss }
836 1.12 augustss
837 1.20 augustss #if defined(__FreeBSD__)
838 1.20 augustss void
839 1.20 augustss usbd_print_child(device_t parent, device_t child)
840 1.20 augustss {
841 1.20 augustss /*
842 1.20 augustss struct usb_softc *sc = device_get_softc(child);
843 1.20 augustss */
844 1.20 augustss
845 1.20 augustss printf(" at %s%d", device_get_name(parent), device_get_unit(parent));
846 1.20 augustss
847 1.20 augustss /* XXX How do we get to the usbd_device_handle???
848 1.20 augustss usbd_device_handle dev = invalidadosch;
849 1.20 augustss
850 1.20 augustss printf(" addr %d", dev->addr);
851 1.20 augustss
852 1.20 augustss if (bootverbose) {
853 1.20 augustss if (dev->lowspeed)
854 1.20 augustss printf(", lowspeed");
855 1.20 augustss if (dev->self_powered)
856 1.20 augustss printf(", self powered");
857 1.20 augustss else
858 1.20 augustss printf(", %dmA", dev->power);
859 1.20 augustss printf(", config %d", dev->config);
860 1.20 augustss }
861 1.20 augustss */
862 1.20 augustss }
863 1.20 augustss
864 1.20 augustss /* Reconfigure all the USB busses in the system. */
865 1.20 augustss int
866 1.20 augustss usbd_driver_load(module_t mod, int what, void *arg)
867 1.20 augustss {
868 1.20 augustss devclass_t usb_devclass = devclass_find("usb");
869 1.20 augustss devclass_t ugen_devclass = devclass_find("ugen");
870 1.20 augustss device_t *devlist;
871 1.20 augustss int devcount;
872 1.20 augustss int error;
873 1.20 augustss
874 1.20 augustss switch (what) {
875 1.20 augustss case MOD_LOAD:
876 1.20 augustss case MOD_UNLOAD:
877 1.20 augustss if (!usb_devclass)
878 1.20 augustss return 0; /* just ignore call */
879 1.20 augustss
880 1.20 augustss if (ugen_devclass) {
881 1.20 augustss /* detach devices from generic driver if possible */
882 1.20 augustss error = devclass_get_devices(ugen_devclass, &devlist,
883 1.20 augustss &devcount);
884 1.20 augustss if (!error)
885 1.20 augustss for (devcount--; devcount >= 0; devcount--)
886 1.20 augustss (void)DEVICE_DETACH(devlist[devcount]);
887 1.20 augustss }
888 1.20 augustss
889 1.20 augustss error = devclass_get_devices(usb_devclass, &devlist, &devcount);
890 1.20 augustss if (error)
891 1.20 augustss return 0; /* XXX maybe transient, or error? */
892 1.20 augustss
893 1.20 augustss for (devcount--; devcount >= 0; devcount--)
894 1.20 augustss USB_RECONFIGURE(devlist[devcount]);
895 1.20 augustss
896 1.20 augustss free(devlist, M_TEMP);
897 1.20 augustss return 0;
898 1.20 augustss }
899 1.20 augustss
900 1.20 augustss return 0; /* nothing to do by us */
901 1.20 augustss }
902 1.20 augustss
903 1.20 augustss /* Set the description of the device including a malloc and copy. */
904 1.20 augustss void
905 1.20 augustss usbd_device_set_desc(device_t device, char *devinfo)
906 1.20 augustss {
907 1.20 augustss size_t l;
908 1.20 augustss char *desc;
909 1.20 augustss
910 1.20 augustss if ( devinfo ) {
911 1.20 augustss l = strlen(devinfo);
912 1.20 augustss desc = malloc(l+1, M_USB, M_NOWAIT);
913 1.20 augustss if (desc)
914 1.20 augustss memcpy(desc, devinfo, l+1);
915 1.20 augustss } else
916 1.20 augustss desc = NULL;
917 1.20 augustss
918 1.20 augustss device_set_desc(device, desc);
919 1.20 augustss }
920 1.20 augustss
921 1.20 augustss char *
922 1.20 augustss usbd_devname(bdevice *bdev)
923 1.20 augustss {
924 1.20 augustss static char buf[20];
925 1.21 augustss /*
926 1.21 augustss * A static buffer is a loss if this routine is used from an interrupt,
927 1.21 augustss * but it's not fatal.
928 1.21 augustss */
929 1.20 augustss
930 1.20 augustss sprintf(buf, "%s%d", device_get_name(*bdev), device_get_unit(*bdev));
931 1.20 augustss return (buf);
932 1.20 augustss }
933 1.20 augustss
934 1.20 augustss #endif
935