[src/trunk]: src/share/man/man9 Update after nick-nhusb merge

[skrll <skrll%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/531843595b72
branches:  trunk
changeset: 814994:531843595b72
user:      skrll <skrll%NetBSD.org@localhost>
date:      Sun Apr 24 15:03:18 2016 +0000

description:
Update after nick-nhusb merge

diffstat:

 share/man/man9/usbdi.9 |  341 ++++++++++++++++++++++++------------------------
 1 files changed, 172 insertions(+), 169 deletions(-)

diffs (truncated from 621 to 300 lines):

diff -r 95a334c3bb8f -r 531843595b72 share/man/man9/usbdi.9
--- a/share/man/man9/usbdi.9    Sun Apr 24 09:01:45 2016 +0000
+++ b/share/man/man9/usbdi.9    Sun Apr 24 15:03:18 2016 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: usbdi.9,v 1.30 2015/06/29 16:20:14 skrll Exp $
+.\"    $NetBSD: usbdi.9,v 1.31 2016/04/24 15:03:18 skrll Exp $
 .\"
 .\" Copyright (c) 2012 Matthew R. Green
 .\" All rights reserved.
@@ -27,11 +27,11 @@
 .\" SUCH DAMAGE.
 .\"
 .\"
-.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
+.\" Copyright (c) 1999, 2016 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to The NetBSD Foundation
-.\" by Lennart Augustsson.
+.\" by Lennart Augustsson and Nick Hudson.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
@@ -54,7 +54,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd June 29, 2015
+.Dd April 24, 2016
 .Dt USBDI 9
 .Os
 .Sh NAME
@@ -66,144 +66,148 @@
 .In dev/usb/usbdi_util.h
 .Ss Functions offered by usbdi.h
 .Ft usbd_status
-.Fn usbd_open_pipe "usbd_interface_handle iface" "uint8_t address" \
- "uint8_t flags" "usbd_pipe_handle *pipe"
+.Fn usbd_open_pipe "struct usbd_interface *iface" "uint8_t address" \
+ "uint8_t flags" "struct usbd_pipe **pipe"
 .Ft usbd_status
-.Fn usbd_close_pipe "usbd_pipe_handle pipe"
+.Fn usbd_close_pipe "struct usbd_pipe *pipe"
 .Ft usbd_status
-.Fn usbd_transfer "usbd_xfer_handle xfer"
-.Ft usbd_xfer_handle
-.Fn usbd_alloc_xfer "usbd_device_handle dev"
-.Ft usbd_status
-.Fn usbd_free_xfer "usbd_xfer_handle xfer"
-.Ft void
-.Fn usbd_setup_xfer "usbd_xfer_handle xfer" "usbd_pipe_handle pipe" \
- "usbd_private_handle priv" "void *buffer" "uint32_t length" \
+.Fn usbd_transfer "struct usbd_xfer *xfer"
+.Ft struct usbd_xfer *
+.Fn usbd_setup_xfer "struct usbd_xfer *xfer" \
+ "void *priv" "void *buffer" "uint32_t length" \
  "uint16_t flags" "uint32_t timeout" "usbd_callback"
 .Ft void
-.Fn usbd_setup_default_xfer "usbd_xfer_handle xfer" \
- "usbd_device_handle dev" "usbd_private_handle priv" \
+.Fn usbd_setup_default_xfer "struct usbd_xfer *xfer" \
+ "struct usbd_device *dev" "void *priv" \
  "uint32_t timeout" "usb_device_request_t *req" " void *buffer" \
  "uint32_t length" "uint16_t flags" "usbd_callback"
 .Ft void
-.Fn usbd_setup_isoc_xfer "usbd_xfer_handle xfer" "usbd_pipe_handle pipe" \
- "usbd_private_handle priv" "uint16_t *frlengths" \
+.Fn usbd_setup_isoc_xfer "struct usbd_xfer *xfer" \
+ "void *priv" "uint16_t *frlengths" \
  "uint32_t nframes" "uint16_t flags" "usbd_callback"
 .Ft void
-.Fn usbd_get_xfer_status "usbd_xfer_handle xfer" "usbd_private_handle *priv" \
+.Fn usbd_get_xfer_status "struct usbd_xfer *xfer" "void **priv" \
  "void **buffer" "uint32_t *count" "usbd_status *status"
 .Ft usb_endpoint_descriptor_t *
-.Fn usbd_interface2endpoint_descriptor "usbd_interface_handle iface" \
+.Fn usbd_interface2endpoint_descriptor "struct usbd_interface *iface" \
  "uint8_t address"
 .Ft usbd_status
-.Fn usbd_abort_pipe "usbd_pipe_handle pipe"
+.Fn usbd_abort_pipe "struct usbd_pipe *pipe"
 .Ft usbd_status
-.Fn usbd_abort_default_pipe "usbd_device_handle dev"
+.Fn usbd_abort_default_pipe "struct usbd_device *dev"
 .Ft usbd_status
-.Fn usbd_clear_endpoint_stall "usbd_pipe_handle pipe"
+.Fn usbd_clear_endpoint_stall "struct usbd_pipe *pipe"
 .Ft usbd_status
-.Fn usbd_clear_endpoint_stall_async "usbd_pipe_handle pipe"
+.Fn usbd_clear_endpoint_stall_async "struct usbd_pipe *pipe"
 .Ft void
-.Fn usbd_clear_endpoint_toggle "usbd_pipe_handle pipe"
+.Fn usbd_clear_endpoint_toggle "struct usbd_pipe *pipe"
 .Ft usbd_status
-.Fn usbd_endpoint_count "usbd_interface_handle dev" "uint8_t *count"
+.Fn usbd_endpoint_count "struct usbd_interface *dev" "uint8_t *count"
 .Ft usbd_status
-.Fn usbd_interface_count "usbd_device_handle dev" "uint8_t *count"
+.Fn usbd_interface_count "struct usbd_device *dev" "uint8_t *count"
 .Ft usbd_status
-.Fn usbd_interface2device_handle "usbd_interface_handle iface" "usbd_device_handle *dev"
+.Fn usbd_interface2device_handle "struct usbd_interface *iface" "struct usbd_device **dev"
 .Ft usbd_status
-.Fn usbd_device2interface_handle "usbd_device_handle dev" "uint8_t ifaceno" "usbd_interface_handle *iface"
+.Fn usbd_device2interface_handle "struct usbd_device *dev" "uint8_t ifaceno" "struct usbd_interface **iface"
 .Pp
-.Ft usbd_device_handle
-.Fn usbd_pipe2device_handle "usbd_pipe_handle pipe"
-.Ft void *
-.Fn usbd_alloc_buffer "usbd_xfer_handle req" "uint32_t size"
+.Ft struct usbd_device *
+.Fn usbd_pipe2device_handle "struct usbd_pipe *pipe"
+.Ft int
+.Fn usbd_create_xfer "struct usbd_pipe *pipe" "size_t len" \
+"unsigned int flags" "unsigned int nframes" "struct usbd_xfer **xp"
 .Ft void
-.Fn usbd_free_buffer "usbd_xfer_handle req"
+.Fn usbd_destroy_xfer "struct usbd_xfer *xfer"
 .Ft void *
-.Fn usbd_get_buffer "usbd_xfer_handle xfer"
+.Fn usbd_get_buffer "struct usbd_xfer *xfer"
 .Ft usbd_status
-.Fn usbd_sync_transfer "usbd_xfer_handle req"
+.Fn usbd_sync_transfer "struct usbd_xfer *req"
 .Ft usbd_status
-.Fn usbd_sync_transfer_sig "usbd_xfer_handle req"
+.Fn usbd_sync_transfer_sig "struct usbd_xfer *req"
 .Ft usbd_status
-.Fn usbd_open_pipe_intr "usbd_interface_handle iface" "uint8_t address" \
- "uint8_t flags" "usbd_pipe_handle *pipe" \
- "usbd_private_handle priv" "void *buffer" \
+.Fn usbd_open_pipe_intr "struct usbd_interface *iface" "uint8_t address" \
+ "uint8_t flags" "struct usbd_pipe **pipe" \
+ "void *priv" "void *buffer" \
  "uint32_t length" "usbd_callback callback" "int interval"
 .Ft usbd_status
-.Fn usbd_do_request "usbd_device_handle dev" "usb_device_request_t *req" \
+.Fn usbd_do_request "struct usbd_device *dev" "usb_device_request_t *req" \
  "void *data"
 .Ft usbd_status
-.Fn usbd_do_request_flags "usbd_device_handle dev" \
+.Fn usbd_do_request_flags "struct usbd_device *dev" \
  "usb_device_request_t *req" "void *data" "uint16_t flags" "int *actlen" \
- "u_int32_t timo"
+ "uint32_t timo"
 .\" usbd_do_request_async() not used outside of usbdi*
 .Ft usb_interface_descriptor_t *
-.Fn usbd_get_interface_descriptor "usbd_interface_handle iface"
+.Fn usbd_get_interface_descriptor "struct usbd_interface *iface"
 .Ft usb_config_descriptor_t *
-.Fn usbd_get_config_descriptor "usbd_device_handle dev"
+.Fn usbd_get_config_descriptor "struct usbd_device *dev"
 .Ft usb_device_descriptor_t *
-.Fn usbd_get_device_descriptor "usbd_device_handle dev"
+.Fn usbd_get_device_descriptor "struct usbd_device *dev"
 .Ft usbd_status
-.Fn usbd_set_interface "usbd_interface_handle iface" "int altidx"
+.Fn usbd_set_interface "struct usbd_interface *iface" "int altidx"
 .Ft int
 .Fn usbd_get_no_alts "usb_config_descriptor_t *iface" "int ifaceno"
 .Ft usbd_status
 .\" unused, delete?
-.\" .Fn usbd_get_interface "usbd_interface_handle iface" "uint8_t *aiface"
+.\" .Fn usbd_get_interface "struct usbd_interface *iface" "uint8_t *aiface"
 .\" .Ft void
-.Fn usbd_fill_deviceinfo "usbd_device_handle dev" "struct usb_device_info *di"
+.Fn usbd_fill_deviceinfo "struct usbd_device *dev" "struct usb_device_info *di"
 .Ft int
-.Fn usbd_get_interface_altindex "usbd_interface_handle iface"
+.Fn usbd_get_interface_altindex "struct usbd_interface *iface"
 .Ft usb_endpoint_descriptor_t *
-.Fn usbd_get_endpoint_descriptor "usbd_interface_handle dev" \
- "u_int8_t address"
+.Fn usbd_get_endpoint_descriptor "struct usbd_interface *dev" \
+ "uint8_t address"
 .Ft usb_interface_descriptor_t *
 .Fn usbd_find_idesc "usb_config_descriptor_t *cd" "int iindex" "int ano"
 .Ft usb_endpoint_descriptor_t *
 .Fn usbd_find_edesc "usb_config_descriptor_t *cd" "int ifaceidx" "int altidx" \
  "int endptidx"
 .Ft void
-.Fn usbd_dopoll "usbd_interface_handle iface"
+.Fn usbd_dopoll "struct usbd_interface *iface"
 .Ft void
-.Fn usbd_set_polling "usbd_device_handle iface" "int val"
+.Fn usbd_set_polling "struct usbd_device *iface" "int val"
 .Ft const char *
 .Fn usbd_errstr "usbd_status err"
 .Ft void
-.Fn usbd_add_dev_event "int type" "usbd_device_handle iface"
+.Fn usbd_add_dev_event "int type" "struct usbd_device *iface"
 .Ft void
-.Fn usbd_add_drv_event "int type" "usbd_device_handle iface" "device_t dv"
+.Fn usbd_add_drv_event "int type" "struct usbd_device *iface" "device_t dv"
 .Ft char *
-.Fn usbd_devinfo_alloc "usbd_device_handle iface" "int showclass"
+.Fn usbd_devinfo_alloc "struct usbd_device *iface" "int showclass"
 .Ft void
 .Fn usbd_devinfo_free "char *str"
 .Ft const struct usbd_quirks *
-.Fn usbd_get_quirks "usbd_device_handle iface"
+.Fn usbd_get_quirks "struct usbd_device *iface"
 .Ft usbd_status
-.Fn usbd_reload_device_desc "usbd_device_handle iface"
+.Fn usbd_reload_device_desc "struct usbd_device *iface"
 .Ft int
 .Fn usbd_ratecheck "struct timeval *tv"
 .Ft usbd_status
-.Fn usbd_get_string "usbd_device_handle iface" "int si" "char *buf"
+.Fn usbd_get_string "struct usbd_device *iface" "int si" "char *buf"
 .Ft usbd_status
-.Fn usbd_get_string0 "usbd_device_handle iface" "int si" "char *buf" \
+.Fn usbd_get_string0 "struct usbd_device *iface" "int si" "char *buf" \
  "int unicode"
 .Ft void
-.Fn usb_desc_iter_init "usbd_device_handle iface" "usbd_desc_iter_t *iter"
+.Fn usb_desc_iter_init "struct usbd_device *iface" "usbd_desc_iter_t *iter"
 .Ft const usb_descriptor_t *
 .Fn usb_desc_iter_next "usbd_desc_iter_t *iter"
 .Ft void
-.Fn usb_add_task "usbd_device_handle iface" "struct usb_task *task" \
+.Fn usb_add_task "struct usbd_device *iface" "struct usb_task *task" \
  "int queue"
 .Ft void
-.Fn usb_rem_task "usbd_device_handle iface" "struct usb_task *task"
+.Fn usb_rem_task "struct usbd_device *iface" "struct usb_task *task"
 .Ft void
 .Fn usb_init_task "struct usb_task *task" "void (*func)(void *)" \
  "void *arg" uint8_t flags
 .Ft const struct usb_devno *
 .Fn usb_lookup "const struct usb_devno *tbl" \
- "u_int16_t vendor" "u_int16_t product"
+ "uint16_t vendor" "uint16_t product"
+.Ss Obsolete functions
+The following functions have been obsoleted from
+.Dv usbdi.h .
+.Ft void *
+.Fn usbd_alloc_buffer "struct usbd_xfer *xfer" "uint32_t size"
+.Ft void
+.Fn usbd_free_buffer "struct usbd_xfer *xfer"
 .Ss Utilities from usbdi_util.h
 Based on the routines in
 .Dv usbdi.h
@@ -211,67 +215,67 @@
 through
 .Dv usbdi_util.h .
 .Ft usbd_status
-.Fn usbd_get_desc "usbd_device_handle dev" "int type" "int index" \
+.Fn usbd_get_desc "struct usbd_device *dev" "int type" "int index" \
  "int len" "void *desc"
 .Ft usbd_status
-.Fn usbd_get_config_desc "usbd_device_handle dev" "int confidx" \
+.Fn usbd_get_config_desc "struct usbd_device *dev" "int confidx" \
  "usb_config_descriptor_t *d"
 .Ft usbd_status
-.Fn usbd_get_config_desc_full "usbd_device_handle" "int dev" "void *d" "int size"
+.Fn usbd_get_config_desc_full "struct usbd_device *" "int dev" "void *d" "int size"
 .Ft usbd_status
-.Fn usbd_get_device_desc "usbd_device_handle dev" \
+.Fn usbd_get_device_desc "struct usbd_device *dev" \
  "usb_device_descriptor_t *d"
 .Ft usbd_status
-.Fn usbd_set_address "usbd_device_handle dev" "int addr"
+.Fn usbd_set_address "struct usbd_device *dev" "int addr"
 .Ft usbd_status
-.Fn usbd_get_port_status "usbd_device_handle dev" "int port" "usb_port_status_t *ps"
+.Fn usbd_get_port_status "struct usbd_device *dev" "int port" "usb_port_status_t *ps"
 .Ft usbd_status
-.Fn usbd_set_hub_feature "usbd_device_handle dev" "int sel"
+.Fn usbd_set_hub_feature "struct usbd_device *dev" "int sel"
 .Ft usbd_status
-.Fn usbd_clear_hub_feature "usbd_device_handle dev" "int sel"
+.Fn usbd_clear_hub_feature "struct usbd_device *dev" "int sel"
 .Ft usbd_status
-.Fn usbd_set_port_feature "usbd_device_handle dev" "int port" "int sel"
+.Fn usbd_set_port_feature "struct usbd_device *dev" "int port" "int sel"
 .Ft usbd_status
-.Fn usbd_clear_port_feature "usbd_device_handle dev" "int port" "int sel"
+.Fn usbd_clear_port_feature "struct usbd_device *dev" "int port" "int sel"
 .Ft usbd_status
-.Fn usbd_get_device_status "usbd_device_handle dev" "usb_status_t *st"
+.Fn usbd_get_device_status "struct usbd_device *dev" "usb_status_t *st"
 .Ft usbd_status
-.Fn usbd_get_hub_status "usbd_device_handle dev" "usb_hub_status_t *st"
+.Fn usbd_get_hub_status "struct usbd_device *dev" "usb_hub_status_t *st"
 .Ft usbd_status
-.Fn usbd_set_protocol "usbd_interface_handle dev" "int report"
+.Fn usbd_set_protocol "struct usbd_interface *dev" "int report"
 .Ft usbd_status
-.Fn usbd_get_report_descriptor  "usbd_device_handle dev" "int ifcno" "int repid" "int size" "void *d"
+.Fn usbd_get_report_descriptor  "struct usbd_device *dev" "int ifcno" "int repid" "int size" "void *d"
 .Ft struct usb_hid_descriptor *
-.Fn usbd_get_hid_descriptor "usbd_interface_handle ifc"
+.Fn usbd_get_hid_descriptor "struct usbd_interface *ifc"
 .Ft usbd_status
-.Fn usbd_set_report "usbd_interface_handle iface" "int type" "int id" "void *data" "int len"
+.Fn usbd_set_report "struct usbd_interface *iface" "int type" "int id" "void *data" "int len"
 .Ft usbd_status
-.Fn usbd_set_report_async "usbd_interface_handle iface" "int type" "int id" "void *data" "int len"
+.Fn usbd_set_report_async "struct usbd_interface *iface" "int type" "int id" "void *data" "int len"