Make the field names in the documented structures match dev/usb/usb.h.

This commit is contained in:
John Birrell 2003-09-24 04:53:50 +00:00
parent 77e399e8be
commit 432facc3a8

View File

@ -149,9 +149,9 @@ The
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"
@ -175,8 +175,8 @@ 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"
@ -186,10 +186,10 @@ 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"
@ -198,20 +198,20 @@ 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
@ -229,9 +229,9 @@ 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"
@ -251,12 +251,12 @@ be shorter than the requested size, and the
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