summaryrefslogtreecommitdiffstats
path: root/lib/libusb
diff options
context:
space:
mode:
authorgjb <gjb@FreeBSD.org>2012-05-11 20:06:46 +0000
committergjb <gjb@FreeBSD.org>2012-05-11 20:06:46 +0000
commit8670397617a81b2ecea7375cbd0af3c77821459b (patch)
tree0b28f0bebde32579d2780e773f4990dfb45d3f30 /lib/libusb
parent39c22309ed9c2ffe7c028062bc1cb57b20ec6945 (diff)
downloadFreeBSD-src-8670397617a81b2ecea7375cbd0af3c77821459b.zip
FreeBSD-src-8670397617a81b2ecea7375cbd0af3c77821459b.tar.gz
General mdoc(7) and typo fixes.
PR: 167734 Submitted by: Nobuyuki Koganemaru (kogane!jp.freebsd.org) MFC after: 3 days
Diffstat (limited to 'lib/libusb')
-rw-r--r--lib/libusb/libusb.326
-rw-r--r--lib/libusb/libusb20.310
2 files changed, 18 insertions, 18 deletions
diff --git a/lib/libusb/libusb.3 b/lib/libusb/libusb.3
index 1ab0a8b..ffc761b 100644
--- a/lib/libusb/libusb.3
+++ b/lib/libusb/libusb.3
@@ -100,12 +100,12 @@ counter decremented once.
.Ft uint8_t
.Fn libusb_get_bus_number "libusb_device *dev"
Returns the number of the bus contained by the device
-.Fa dev.
+.Fa dev .
.Pp
.Ft uint8_t
.Fn libusb_get_device_address "libusb_device *dev"
Returns the device_address contained by the device
-.Fa dev.
+.Fa dev .
.Pp
.Ft enum libusb_speed
.Fn libusb_get_device_speed "libusb_device *dev"
@@ -127,12 +127,12 @@ LIBUSB_ERROR_OTHERS on other failure.
.Ft libusb_device *
.Fn libusb_ref_device "libusb_device *dev"
Increment the reference counter of the device
-.Fa dev.
+.Fa dev .
.Pp
.Ft void
.Fn libusb_unref_device "libusb_device *dev"
Decrement the reference counter of the device
-.Fa dev.
+.Fa dev .
.Pp
.Ft int
.Fn libusb_open "libusb_device *dev" "libusb_device_handle **devh"
@@ -147,7 +147,7 @@ disconnected and a LIBUSB_ERROR code on other errors.
A convenience function to open a device by vendor and product IDs
.Fa vid
and
-.Fa pid.
+.Fa pid .
Returns NULL on error.
.Pp
.Ft void
@@ -161,7 +161,7 @@ Returns NULL on error.
.Pp
.Ft int
.Fn libusb_get_configuration "libusb_device_handle *devh" "int *config"
-Returns the bConfiguration value of the current configuration.
+Returns the value of the current configuration.
Returns 0
on success, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
and a LIBUSB_ERROR code on error.
@@ -171,7 +171,7 @@ and a LIBUSB_ERROR code on error.
Set the active configuration to
.Fa config
for the device contained by
-.Fa devh.
+.Fa devh .
This function returns 0 on success, LIBUSB_ERROR_NOT_FOUND if the requested
configuration does not exist, LIBUSB_ERROR_BUSY if the interfaces are currently
claimed, LIBUSB_ERROR_NO_DEVICE if the device has been disconnected and a
@@ -180,7 +180,7 @@ LIBUSB_ERROR code on failure.
.Ft int
.Fn libusb_claim_interface "libusb_device_handle *devh" "int interface_number"
Claim an interface in a given libusb_handle
-.Fa devh.
+.Fa devh .
This is a non-blocking function.
It returns 0 on success, LIBUSB_ERROR_NOT_FOUND
if the requested interface does not exist, LIBUSB_ERROR_BUSY if a program or
@@ -279,7 +279,7 @@ LIBUSB_ERROR code on failure.
.Ft int
.Fn libusb_get_device_descriptor "libusb_device *dev" "libusb_device_descriptor *desc"
Get the USB device descriptor for the device
-.Fa dev.
+.Fa dev .
This is a non-blocking function.
Returns 0 on success and a LIBUSB_ERROR code on
failure.
@@ -330,11 +330,11 @@ on success and a LIBUSB_ERROR code on failure.
This function parses the USB 3.0 endpoint companion descriptor in host endian format pointed to by
.Fa buf
and having a length of
-.Fa len.
+.Fa len .
Typically these arguments are the extra and extra_length fields of the
endpoint descriptor.
On success the pointer to resulting descriptor is stored at the location given by
-.Fa ep_comp.
+.Fa ep_comp .
Returns zero on success and a LIBUSB_ERROR code on failure.
On success the parsed USB 3.0 endpoint companion descriptor must be
freed using the libusb_free_ss_endpoint_comp function.
@@ -348,9 +348,9 @@ This function is NULL safe and frees a parsed USB 3.0 endpoint companion descrip
This function parses a Binary Object Store, BOS, descriptor into host endian format pointed to by
.Fa buf
and having a length of
-.Fa len.
+.Fa len .
On success the pointer to resulting descriptor is stored at the location given by
-.Fa bos.
+.Fa bos .
Returns zero on success and a LIBUSB_ERROR code on failure.
On success the parsed BOS descriptor must be freed using the
libusb_free_bos_descriptor function.
diff --git a/lib/libusb/libusb20.3 b/lib/libusb/libusb20.3
index d1abc55..2253ece 100644
--- a/lib/libusb/libusb20.3
+++ b/lib/libusb/libusb20.3
@@ -331,7 +331,7 @@ packets are avoided for proxy buffers.
.Pp
.
.Fn libusb20_tr_get_max_total_length
-function will return the maximum value for the data length sum of all USB
+will return the maximum value for the data length sum of all USB
frames associated with an USB transfer.
In case of control transfers the value returned does not include the
length of the SETUP packet, 8 bytes, which is part of frame zero.
@@ -815,7 +815,7 @@ returns the current speed of the given USB device.
.Pp
.
.Fn libusb20_dev_get_config_index
-This function returns the currently select config index for the given
+returns the currently selected config index for the given
USB device.
.
.Pp
@@ -832,7 +832,7 @@ will set the debug level for the given USB device.
.Pp
.
.Fn libusb20_dev_wait_process
-function will wait until a pending USB transfer has completed on
+will wait until a pending USB transfer has completed on
the given USB device.
.
A timeout value can be specified which is passed on to the
@@ -866,7 +866,7 @@ returned.
.Pp
.
.Fn libusb20_be_get_dev_quirk
-This function will return the device quirk according to
+will return the device quirk according to
.Fa index
into the libusb20_quirk structure pointed to by
.Fa pq .
@@ -948,7 +948,7 @@ Dequeued USB devices will not be freed when the backend is freed.
.Pp
.
.Fn libusb20_be_enqueue_device
-This function will enqueue the given USB device pointer in the backend USB device list.
+will enqueue the given USB device pointer in the backend USB device list.
.
Enqueued USB devices will get freed when the backend is freed.
.
OpenPOWER on IntegriCloud