share/man/man4/ugen.4

   1 .\" $NetBSD: ugen.4,v 1.13 2001/09/11 22:52:54 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Lennart Augustsson.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgement:
  19 .\"        This product includes software developed by the NetBSD
  20 .\"        Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $FreeBSD: src/share/man/man4/ugen.4,v 1.1.2.2 2001/12/17 11:30:12 ru Exp $
  38 .\" $DragonFly: src/share/man/man4/ugen.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  39 .\"
  40 .Dd July 12, 1998
  41 .Dt UGEN 4
  42 .Os
  43 .Sh NAME
  44 .Nm ugen
  45 .Nd USB generic device support
  46 .Sh SYNOPSIS
  47 .Cd "device ugen"
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver provides support for all USB devices that do not have
  52 a special driver.
  53 It supports access to all parts of the device,
  54 but not in a way that is as convenient as a special purpose driver.
  55 .Pp
  56 There can be up to 127 USB devices connected to a USB bus.
  57 Each USB device can have up to 16 endpoints.
  58 Each of these endpoints
  59 will communicate in one of four different modes: control, isochronous,
  60 bulk, or interrupt.
  61 Each of the endpoints will have a different
  62 device node.
  63 The four least significant bits in the minor device
  64 number determines which endpoint the device accesses and the rest
  65 of the bits determines which USB device.
  66 .Pp
  67 If an endpoint address is used both for input and output the device
  68 can be opened for both read or write.
  69 .Pp
  70 To find out what endpoints that exist there are a series of
  71 .Xr ioctl 2
  72 operation on the control endpoint that returns the USB descriptors
  73 of the device, configurations, interfaces, and endpoints.
  74 .Pp
  75 The control transfer mode can only happen on the control endpoint
  76 which is always endpoint 0.
  77 The control endpoint accepts request
  78 and may respond with an answer to such request.
  79 Control request
  80 are issued by
  81 .Xr ioctl 2
  82 calls.
  83 .\" .Pp
  84 .\" The isochronous transfer mode can be in or out depending on the
  85 .\" endpoint.
  86 .\" To perform I/O on an isochronous endpoint
  87 .\" .Xr read 2
  88 .\" and
  89 .\" .Xr write 2
  90 .\" should be used.
  91 .\" Before any I/O operations can take place the transfer rate in
  92 .\" bytes/second has to be set.
  93 .\" This is done with
  94 .\" .Xr ioctl 2
  95 .\" .Dv USB_SET_ISO_RATE .
  96 .\" Performing this call sets up a buffer corresponding to
  97 .\" about 1 second of data.
  98 .Pp
  99 The bulk transfer mode can be in or out depending on the
 100 endpoint.
 101 To perform I/O on a bulk endpoint
 102 .Xr read 2
 103 and
 104 .Xr write 2
 105 should be used.
 106 All I/O operations on a bulk endpoint are unbuffered.
 107 .Pp
 108 The interrupt transfer mode can only be in.
 109 To perform input from an interrupt endpoint
 110 .Xr read 2
 111 should be used.
 112 A moderate amount of buffering is done
 113 by the driver.
 114 .Pp
 115 All endpoints handle the following
 116 .Xr ioctl 2
 117 calls:
 118 .Bl -tag -width indent
 119 .It Dv USB_SET_SHORT_XFER Pq Vt int
 120 Allow short read transfer.
 121 Normally a transfer from the device
 122 which is shorter than the request specified is reported as an
 123 error.
 124 .It Dv USB_SET_TIMEOUT Pq Vt int
 125 Set the timeout on the device operations, the time is specified
 126 in milliseconds.
 127 The value 0 is used to indicate that there is
 128 no timeout.
 129 .El
 130 .Pp
 131 The control endpoint (endpoint 0) handles the following
 132 .Xr ioctl 2
 133 calls:
 134 .Bl -tag -width indent
 135 .It Dv USB_GET_CONFIG Pq Vt int
 136 Get the device configuration number.
 137 .It Dv USB_SET_CONFIG Pq Vt int
 138 Set the device into the given configuration number.
 139 .Pp
 140 This operation can only be performed when the control endpoint
 141 is the sole open endpoint.
 142 .It Dv USB_GET_ALTINTERFACE Pq Vt "struct usb_alt_interface"
 143 Get the alternative setting number for the interface with the given
 144 index.
 145 The
 146 .Va config_index
 147 is ignored in this call.
 148 .Bd -literal
 149 struct usb_alt_interface {
 150         int     config_index;
 151         int     interface_index;
 152         int     alt_no;
 153 };
 154 .Ed
 155 .It Dv USB_SET_ALTINTERFACE Pq Vt "struct usb_alt_interface"
 156 Set the alternative setting to the given number in the interface with the
 157 given index.
 158 The
 159 .Va config_index
 160 is ignored in this call.
 161 .Pp
 162 This operation can only be performed when no endpoints for the interface
 163 are open.
 164 .It Dv USB_GET_NO_ALT Pq Vt "struct usb_alt_interface"
 165 Return the number of different alternate settings in the
 166 .Va alt_no
 167 field.
 168 .It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t
 169 Return the device descriptor.
 170 .It Dv USB_GET_CONFIG_DESC Pq Vt "struct usb_config_desc"
 171 Return the descriptor for the configuration with the given index.
 172 For convenience the current configuration can be specified by
 173 .Dv USB_CURRENT_CONFIG_INDEX .
 174 .Bd -literal
 175 struct usb_config_desc {
 176         int     config_index;
 177         usb_config_descriptor_t desc;
 178 };
 179 .Ed
 180 .It Dv USB_GET_INTERFACE_DESC Pq Vt "struct usb_interface_desc"
 181 Return the interface descriptor for an interface specified by its
 182 configuration index, interface index, and alternative index.
 183 For convenience the current alternative can be specified by
 184 .Dv USB_CURRENT_ALT_INDEX .
 185 .Bd -literal
 186 struct usb_interface_desc {
 187         int     config_index;
 188         int     interface_index;
 189         int     alt_index;
 190         usb_interface_descriptor_t desc;
 191 };
 192 .Ed
 193 .It Dv USB_GET_ENDPOINT_DESC Pq Vt "struct usb_endpoint_desc"
 194 Return the endpoint descriptor for the endpoint specified by its
 195 configuration index, interface index, alternative index, and
 196 endpoint index.
 197 .Bd -literal
 198 struct usb_endpoint_desc {
 199         int     config_index;
 200         int     interface_index;
 201         int     alt_index;
 202         int     endpoint_index;
 203         usb_endpoint_descriptor_t desc;
 204 };
 205 .Ed
 206 .It Dv USB_GET_FULL_DESC Pq Vt "struct usb_full_desc"
 207 Return all the descriptors for the given configuration.
 208 .Bd -literal
 209 struct usb_full_desc {
 210         int     config_index;
 211         u_int   size;
 212         u_char  *data;
 213 };
 214 .Ed
 215 The
 216 .Va data
 217 field should point to a memory area of the size given in the
 218 .Va size
 219 field.
 220 The proper size can be determined by first issuing a
 221 .Dv USB_GET_CONFIG_DESC
 222 and inspecting the
 223 .Va wTotalLength
 224 field.
 225 .It Dv USB_GET_STRING_DESC Pq Vt "struct usb_string_desc"
 226 Get a string descriptor for the given language ID and
 227 string index.
 228 .Bd -literal
 229 struct usb_string_desc {
 230         int     string_index;
 231         int     language_id;
 232         usb_string_descriptor_t desc;
 233 };
 234 .Ed
 235 .It Dv USB_DO_REQUEST Pq Vt "struct usb_ctl_request"
 236 Send a USB request to the device on the control endpoint.
 237 Any data sent to/from the device is located at
 238 .Va data .
 239 The size of the transferred data is determined from the
 240 .Va request .
 241 The
 242 .Va addr
 243 field is ignored in this call.
 244 The
 245 .Va flags
 246 field can be used to flag that the request is allowed to
 247 be shorter than the requested size, and the
 248 .Va actlen
 249 will contain the actual size on completion.
 250 .Bd -literal
 251 struct usb_ctl_request {
 252         int     addr;
 253         usb_device_request_t request;
 254         void    *data;
 255         int     flags;
 256 #define USBD_SHORT_XFER_OK      0x04    /* allow short reads */
 257         int     actlen;         /* actual length transferred */
 258 };
 259 .Ed
 260 This is a dangerous operation in that it can perform arbitrary operations
 261 on the device.
 262 Some of the most dangerous (e.g., changing the device
 263 address) are not allowed.
 264 .It Dv USB_GET_DEVICEINFO Pq Vt "struct usb_device_info"
 265 Get an information summary for the device.
 266 This call will not
 267 issue any USB transactions.
 268 .El
 269 .Pp
 270 Note that there are two different ways of addressing configurations, interfaces,
 271 alternatives, and endpoints: by index or by number.
 272 The index is the ordinal number (starting from 0) of the descriptor
 273 as presented by the device.
 274 The number is the respective number of
 275 the entity as found in its descriptor.
 276 Enumeration of descriptors
 277 use the index, getting and setting typically uses numbers.
 278 .Pp
 279 Example:
 280 all endpoints (except the control endpoint) for the current configuration
 281 can be found by iterating the
 282 .Va interface_index
 283 from 0 to
 284 .Va config_desc->bNumInterface Ns \-1
 285 and for each of these iterating the
 286 .Va endpoint_index
 287 from 0 to
 288 .Va interface_desc->bNumEndpoints .
 289 The
 290 .Va config_index
 291 should set to
 292 .Dv USB_CURRENT_CONFIG_INDEX
 293 and
 294 .Va alt_index
 295 should be set to
 296 .Dv USB_CURRENT_ALT_INDEX .
 297 .Sh FILES
 298 .Bl -tag -width ".Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE" -compact
 299 .It Pa /dev/ugen Ns Ar N Ns Pa \&. Ns Ar EE
 300 Endpoint
 301 .Ar EE
 302 of device
 303 .Ar N .
 304 .El
 305 .Sh SEE ALSO
 306 .Xr usb 4
 307 .Sh HISTORY
 308 The
 309 .Nm
 310 driver
 311 appeared in
 312 .Nx 1.4 .
 313 .\" .Sh BUGS
 314 .\" The driver is not yet finished; there is no access to isochronous endpoints.