xfnw/plan9fox
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

nusb(2): remove startdevs() reference, document getdev() (thanks BurnZeZ)

Browse source
This commit is contained in:
cinap_lenrek 2019-05-14 09:06:09 +02:00
parent adf96a529e
commit 704970074e
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
sys/man/2/nusb
View file

@ -217,6 +217,14 @@ as an aid for the driver
(which should know how to parse them and what to do with the information). (which should know how to parse them and what to do with the information).
.SS Configuration .SS Configuration
.PP .PP
.I Getdev
is the primary entry point for device setup. It takes a
numeric device address or device path which usually gets
passed to drivers as a program argument and sets up the device,
retuning a configured
.B Dev
representing the setup endpoint of the device.
.PP
.I Opendev .I Opendev
creates a creates a
.B Dev .B Dev
@ -225,7 +233,7 @@ for the endpoint with directory
Usually, the endpoint is a setup endpoint representing a device. The endpoint Usually, the endpoint is a setup endpoint representing a device. The endpoint
control file is open, but the data file is not. The USB description is void. control file is open, but the data file is not. The USB description is void.
In most cases drivers call In most cases drivers call
.I startdevs .I getdev
and and
.I openep .I openep
and do not call this function directly. and do not call this function directly.
@ -236,6 +244,9 @@ loads and parses its configuration information.
After calling it, the device is ready for I/O and the USB description in After calling it, the device is ready for I/O and the USB description in
.B Dev.usb .B Dev.usb
is valid. is valid.
In most cases drivers call
.I getdev
and do not call this function directly.
.PP .PP
Control requests for an endpoint may be written by calling Control requests for an endpoint may be written by calling
.I devctl .I devctl