Sync ugen.4 with FreeBSD.
authorSascha Wildner <saw@online.de>
Fri, 14 Mar 2014 09:28:37 +0000 (10:28 +0100)
committerSascha Wildner <saw@online.de>
Fri, 14 Mar 2014 09:28:37 +0000 (10:28 +0100)
share/man/man4/ugen.4

index ccf7b2b..d1d54b9 100644 (file)
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"        This product includes software developed by the NetBSD
-.\"        Foundation, Inc. and its contributors.
-.\" 4. Neither the name of The NetBSD Foundation nor the names of its
-.\"    contributors may be used to endorse or promote products derived
-.\"    from this software without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/ugen.4,v 1.1.2.2 2001/12/17 11:30:12 ru Exp $
-.\" $DragonFly: src/share/man/man4/ugen.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
+.\" $FreeBSD: head/share/man/man4/ugen.4 238705 2012-07-22 21:43:46Z wblock $
 .\"
-.Dd July 12, 1998
+.Dd March 14, 2014
 .Dt UGEN 4
 .Os
 .Sh NAME
 .Nm ugen
 .Nd USB generic device support
 .Sh SYNOPSIS
-.Cd "device ugen"
+.Nm
+is integrated into the
+.Xr usb 4
+kernel module.
 .Sh DESCRIPTION
 The
 .Nm
@@ -61,22 +56,22 @@ bulk, or interrupt.
 Each of the endpoints will have a different
 device node.
 The four least significant bits in the minor device
-number determines which endpoint the device accesses and the rest
-of the bits determines which USB device.
+number determine which endpoint the device accesses, and the rest
+of the bits determine which USB device.
 .Pp
-If an endpoint address is used both for input and output the device
+If an endpoint address is used both for input and output, the device
 can be opened for both read or write.
 .Pp
-To find out what endpoints that exist there are a series of
+To find out which endpoints exist, there are a series of
 .Xr ioctl 2
-operation on the control endpoint that returns the USB descriptors
+operations on the control endpoint that return the USB descriptors
 of the device, configurations, interfaces, and endpoints.
 .Pp
 The control transfer mode can only happen on the control endpoint
 which is always endpoint 0.
-The control endpoint accepts request
-and may respond with an answer to such request.
-Control request
+The control endpoint accepts request
+and may respond with an answer to such request.
+Control requests
 are issued by
 .Xr ioctl 2
 calls.
@@ -105,9 +100,12 @@ and
 should be used.
 All I/O operations on a bulk endpoint are unbuffered.
 .Pp
-The interrupt transfer mode can only be in.
-To perform input from an interrupt endpoint
+The interrupt transfer mode can be in or out depending on the
+endpoint.
+To perform I/O on an interrupt endpoint
 .Xr read 2
+and
+.Xr write 2
 should be used.
 A moderate amount of buffering is done
 by the driver.
@@ -122,8 +120,8 @@ Normally a transfer from the device
 which is shorter than the request specified is reported as an
 error.
 .It Dv USB_SET_TIMEOUT Pq Vt int
-Set the timeout on the device operations, the time is specified
-in milliseconds.
+Set the timeout on the device operations
+The time is specified in milliseconds.
 The value 0 is used to indicate that there is
 no timeout.
 .El
@@ -143,51 +141,51 @@ is the sole open endpoint.
 Get the alternative setting number for the interface with the given
 index.
 The
-.Va config_index
+.Fa uai_config_index
 is ignored in this call.
 .Bd -literal
 struct usb_alt_interface {
-       int     config_index;
-       int     interface_index;
-       int     alt_no;
+       int     uai_config_index;
+       int     uai_interface_index;
+       int     uai_alt_no;
 };
 .Ed
 .It Dv USB_SET_ALTINTERFACE Pq Vt "struct usb_alt_interface"
 Set the alternative setting to the given number in the interface with the
 given index.
 The
-.Va config_index
+.Fa uai_config_index
 is ignored in this call.
 .Pp
 This operation can only be performed when no endpoints for the interface
 are open.
 .It Dv USB_GET_NO_ALT Pq Vt "struct usb_alt_interface"
 Return the number of different alternate settings in the
-.Va alt_no
+.Fa uai_alt_no
 field.
 .It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t
 Return the device descriptor.
 .It Dv USB_GET_CONFIG_DESC Pq Vt "struct usb_config_desc"
 Return the descriptor for the configuration with the given index.
-For convenience the current configuration can be specified by
+For convenience, the current configuration can be specified by
 .Dv USB_CURRENT_CONFIG_INDEX .
 .Bd -literal
 struct usb_config_desc {
-       int     config_index;
-       usb_config_descriptor_t desc;
+       int     ucd_config_index;
+       usb_config_descriptor_t ucd_desc;
 };
 .Ed
 .It Dv USB_GET_INTERFACE_DESC Pq Vt "struct usb_interface_desc"
 Return the interface descriptor for an interface specified by its
 configuration index, interface index, and alternative index.
-For convenience the current alternative can be specified by
+For convenience, the current alternative can be specified by
 .Dv USB_CURRENT_ALT_INDEX .
 .Bd -literal
 struct usb_interface_desc {
-       int     config_index;
-       int     interface_index;
-       int     alt_index;
-       usb_interface_descriptor_t desc;
+       int     uid_config_index;
+       int     uid_interface_index;
+       int     uid_alt_index;
+       usb_interface_descriptor_t uid_desc;
 };
 .Ed
 .It Dv USB_GET_ENDPOINT_DESC Pq Vt "struct usb_endpoint_desc"
@@ -196,65 +194,65 @@ configuration index, interface index, alternative index, and
 endpoint index.
 .Bd -literal
 struct usb_endpoint_desc {
-       int     config_index;
-       int     interface_index;
-       int     alt_index;
-       int     endpoint_index;
-       usb_endpoint_descriptor_t desc;
+       int     ued_config_index;
+       int     ued_interface_index;
+       int     ued_alt_index;
+       int     ued_endpoint_index;
+       usb_endpoint_descriptor_t ued_desc;
 };
 .Ed
 .It Dv USB_GET_FULL_DESC Pq Vt "struct usb_full_desc"
 Return all the descriptors for the given configuration.
 .Bd -literal
 struct usb_full_desc {
-       int     config_index;
-       u_int   size;
-       u_char  *data;
+       int     ufd_config_index;
+       u_int   ufd_size;
+       u_char  *ufd_data;
 };
 .Ed
 The
-.Va data
+.Fa ufd_data
 field should point to a memory area of the size given in the
-.Va size
+.Fa ufd_size
 field.
 The proper size can be determined by first issuing a
 .Dv USB_GET_CONFIG_DESC
 and inspecting the
-.Va wTotalLength
+.Fa wTotalLength
 field.
 .It Dv USB_GET_STRING_DESC Pq Vt "struct usb_string_desc"
 Get a string descriptor for the given language ID and
 string index.
 .Bd -literal
 struct usb_string_desc {
-       int     string_index;
-       int     language_id;
-       usb_string_descriptor_t desc;
+       int     usd_string_index;
+       int     usd_language_id;
+       usb_string_descriptor_t usd_desc;
 };
 .Ed
 .It Dv USB_DO_REQUEST Pq Vt "struct usb_ctl_request"
 Send a USB request to the device on the control endpoint.
 Any data sent to/from the device is located at
-.Va data .
+.Fa ucr_data .
 The size of the transferred data is determined from the
-.Va request .
+.Fa ucr_request .
 The
-.Va addr
+.Fa ucr_addr
 field is ignored in this call.
 The
-.Va flags
+.Fa ucr_flags
 field can be used to flag that the request is allowed to
-be shorter than the requested size, and the
-.Va actlen
+be shorter than the requested size, and
+.Fa ucr_actlen
 will contain the actual size on completion.
 .Bd -literal
 struct usb_ctl_request {
-       int     addr;
-       usb_device_request_t request;
-       void    *data;
-       int     flags;
+       int     ucr_addr;
+       usb_device_request_t ucr_request;
+       void    *ucr_data;
+       int     ucr_flags;
 #define USBD_SHORT_XFER_OK     0x04    /* allow short reads */
-       int     actlen;         /* actual length transferred */
+       int     ucr_actlen;             /* actual length transferred */
 };
 .Ed
 This is a dangerous operation in that it can perform arbitrary operations
@@ -263,18 +261,17 @@ Some of the most dangerous (e.g., changing the device
 address) are not allowed.
 .It Dv USB_GET_DEVICEINFO Pq Vt "struct usb_device_info"
 Get an information summary for the device.
-This call will not
-issue any USB transactions.
+This call will not issue any USB transactions.
 .El
 .Pp
-Note that there are two different ways of addressing configurations, interfaces,
-alternatives, and endpoints: by index or by number.
+Note that there are two different ways of addressing configurations,
+interfaces, alternatives, and endpoints: by index or by number.
 The index is the ordinal number (starting from 0) of the descriptor
 as presented by the device.
 The number is the respective number of
 the entity as found in its descriptor.
 Enumeration of descriptors
-use the index, getting and setting typically uses numbers.
+uses the index, getting and setting typically uses numbers.
 .Pp
 Example:
 all endpoints (except the control endpoint) for the current configuration
@@ -282,13 +279,13 @@ can be found by iterating the
 .Va interface_index
 from 0 to
 .Va config_desc->bNumInterface Ns \-1
-and for each of these iterating the
+and for each of these, iterating the
 .Va endpoint_index
 from 0 to
 .Va interface_desc->bNumEndpoints .
 The
 .Va config_index
-should set to
+should be set to
 .Dv USB_CURRENT_CONFIG_INDEX
 and
 .Va alt_index