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