usbdivar.h revision 1.10
1 /* $NetBSD: usbdivar.h,v 1.10 1998/12/09 00:18:12 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (augustss (at) carlstedt.se) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 struct usbd_request; 41 struct usbd_pipe; 42 43 struct usbd_endpoint { 44 usb_endpoint_descriptor_t *edesc; 45 usbd_endpoint_state state; 46 int refcnt; 47 int toggle; /* XXX */ 48 }; 49 50 typedef void (*usbd_xfercb)__P((usbd_request_handle req)); 51 52 struct usbd_methods { 53 usbd_status (*transfer)__P((usbd_request_handle reqh)); 54 void (*abort)__P((usbd_request_handle reqh)); 55 void (*close)__P((usbd_pipe_handle pipe)); 56 usbd_status (*isobuf)__P((usbd_pipe_handle pipe, 57 u_int32_t bufsize,u_int32_t nbuf)); 58 }; 59 60 struct usbd_port { 61 usb_port_status_t status; 62 int power; /* mA of current on port */ 63 struct usbd_device *device; 64 struct usbd_device *parent; /* The ports hub */ 65 }; 66 67 struct usbd_hub { 68 usbd_status (*explore)__P((struct device *parent, 69 usbd_device_handle hub)); 70 void *hubdata; 71 usb_hub_descriptor_t hubdesc; 72 struct usbd_port ports[1]; 73 }; 74 75 struct usb_softc; 76 77 /*****/ 78 79 struct usbd_bus { 80 /* Filled by HC driver */ 81 struct device bdev; /* base device */ 82 usbd_status (*open_pipe)__P((struct usbd_pipe *pipe)); 83 u_int32_t pipe_size; /* size of a pipe struct */ 84 void (*do_poll)__P((struct usbd_bus *)); 85 /* Filled by usb driver */ 86 struct usbd_device *root_hub; 87 usbd_device_handle devices[USB_MAX_DEVICES]; 88 char needs_explore;/* a hub a signalled a change */ 89 char use_polling; 90 struct usb_softc *usbctl; 91 struct usb_device_stats stats; 92 }; 93 94 struct usbd_device { 95 struct usbd_bus *bus; 96 usbd_device_state state; 97 struct usbd_pipe *default_pipe; 98 u_int8_t address; 99 u_int8_t depth; 100 u_int8_t lowspeed; 101 u_int16_t power; 102 u_int8_t self_powered; 103 int config; 104 struct usbd_port *powersrc; 105 struct usbd_endpoint def_ep; /* for pipe 0 */ 106 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 107 struct usbd_interface *ifaces; 108 usb_device_descriptor_t ddesc; 109 usb_config_descriptor_t *cdesc; /* full config descr */ 110 struct usbd_quirks *quirks; 111 struct usbd_hub *hub; /* only if this is a hub */ 112 }; 113 114 struct usbd_interface { 115 struct usbd_device *device; 116 usbd_interface_state state; 117 usb_interface_descriptor_t *idesc; 118 int index; 119 int altindex; 120 struct usbd_endpoint *endpoints; 121 void *priv; 122 LIST_HEAD(, usbd_pipe) pipes; 123 }; 124 125 struct usbd_pipe { 126 struct usbd_interface *iface; 127 struct usbd_device *device; 128 struct usbd_endpoint *endpoint; 129 usbd_pipe_state state; 130 int32_t refcnt; 131 char running; 132 SIMPLEQ_HEAD(, usbd_request) queue; 133 LIST_ENTRY(usbd_pipe) next; 134 135 void (*disco) __P((void *)); 136 void *discoarg; 137 138 usbd_request_handle intrreqh; /* used for repeating requests */ 139 usbd_request_handle curreqh; /* currently running request */ 140 141 /* Filled by HC driver. */ 142 struct usbd_methods *methods; 143 }; 144 145 struct usbd_request { 146 struct usbd_pipe *pipe; 147 void *priv; 148 void *buffer; 149 u_int32_t length; 150 u_int32_t actlen; 151 u_int16_t flags; 152 u_int32_t timeout; 153 usbd_status status; 154 usbd_callback callback; 155 usbd_xfercb xfercb; 156 u_int32_t retries; 157 char done; 158 159 usb_device_request_t request; 160 u_int8_t isreq; 161 162 SIMPLEQ_ENTRY(usbd_request) next; 163 164 void *hcpriv; /* XXX private use by the HC driver */ 165 }; 166 167 void usbd_init __P((void)); 168 169 /* Routines from usb_subr.c */ 170 int usbctlprint __P((void *, const char *)); 171 void usbd_delay_ms __P((usbd_bus_handle, int)); 172 void usbd_devinfo_vp __P((usbd_device_handle, char *, char *)); 173 usbd_status usbd_set_config_no __P((usbd_device_handle, int, int)); 174 usbd_status usbd_reset_port __P((usbd_device_handle dev, 175 int port, usb_port_status_t *ps)); 176 usbd_status usbd_setup_pipe __P((usbd_device_handle dev, 177 usbd_interface_handle iface, 178 struct usbd_endpoint *, 179 usbd_pipe_handle *pipe)); 180 usbd_status usbd_new_device __P((struct device *parent, 181 usbd_bus_handle bus, int depth, 182 int lowspeed, int port, 183 struct usbd_port *)); 184 int usbd_printBCD __P((char *cp, int bcd)); 185 usbd_status usbd_fill_iface_data __P((usbd_device_handle dev, 186 int i, int a)); 187 188 /* Routines from usb.c */ 189 int usb_bus_count __P((void)); 190 usbd_status usb_get_bus_handle __P((int, usbd_bus_handle *)); 191 void usb_needs_explore __P((usbd_bus_handle)); 192 193 extern int usbd_use_polling; 194 195 /* Locator stuff. */ 196 197 #include "locators.h" 198 199 #define uhubcf_port cf_loc[UHUBCF_PORT] 200 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 201 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 202 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 203 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 204 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 205 206
Indexes created Mon Sep 22 13:09:51 GMT 2025