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