Commit Graph

34 Commits

Author SHA1 Message Date
mrg cb3618ce23 s/of/or/ 2018-09-04 00:00:47 +00:00
dholland 533063d806 Typo fixes from Eitan Adler. 2018-02-08 09:03:23 +00:00
wiz 1202244b0e Remove trailing whitespace. 2016-04-24 15:11:26 +00:00
skrll 7c06acf192 Update after nick-nhusb merge 2016-04-24 15:03:18 +00:00
skrll 7270a09d72 Typos 2015-06-29 16:20:14 +00:00
skrll 8225e7146f s/the the/the/
Bump date.
2013-09-26 16:18:52 +00:00
wiz 7f89a551ef Bump date for previous. 2013-06-10 06:41:58 +00:00
mrg 018f384e6a mark several interfaces as internal, most of which have other exported
APIs for their use.
2013-06-10 05:11:20 +00:00
wiz 2a316cb9b8 Use correct macro. 2013-01-22 15:52:17 +00:00
jmcneill e488b1d802 document USBD_MPSAFE and USB_TASKQ_MPSAFE 2013-01-22 15:35:08 +00:00
mrg 2a9a6550b5 - remove some comments about only being relevant for usbmp.
- add documentation for usb_rem_task(), and clean up the task doc in
  general.  be clear about SMP issues for tasks
- bump date
2012-07-20 07:55:44 +00:00
mrg 4a00fabd03 remove a comment about usbmp. 2012-06-10 06:40:08 +00:00
wiz fc4d427c11 Remove superfluous Pp. New sentence, new line. Remove trailing whitespace. 2012-06-03 17:01:21 +00:00
mrg 57caaffef7 add doucmentation for usb_{add,rem,init}_task(). 2012-06-03 02:56:36 +00:00
mrg de6d466666 add documentation for:
- usbd_alloc_buffer
- usbd_free_buffe
- usbd_get_buffer
- usbd_do_request
- usbd_do_request_flags

begin to document the changes present on the USBMP branch:
- usbd_sync_transfer_sig
- usb_detach_wait
- usb_detach_broadcast

create a new section on device detachment.  XXX needs a code example.
2012-06-03 02:23:37 +00:00
mrg 343e545c3e gives pipes and transfers their own .Sh section. 2012-06-02 23:39:03 +00:00
mrg 2ae34fcc5d document usbd_open_pipe*(). fix some minor errors.
prepare to re-structure a lot of stuff.
2012-06-02 23:33:16 +00:00
mrg 9c94f403d6 greatly expand the discussion on transfers and provide most of the details
needed to alloc, setup, transfer and obtain the status of them.
this takes care of:
  - usbd_close_pipe
  - usbd_alloc_xfer
  - usbd_free_xfer
  - usbd_setup{,_default,_isoc}_xfer
  - usbd_transfer
  - usbd_{bulk,intr}_transfer
  - usbd_transfer_sync{,_sig}
  - usbd_get_xfer_status
as well as callback and request information.

update the list of functions missing real descriptions.  there are about
30 usbdi.h and 35 usbdi_util.h functions remaining.
2012-06-02 23:10:12 +00:00
mrg 8fb03546dc - add some comments for post-usbmp
- basic documentation for:
    usbd_clear_endpoint_toggle()
    usbd_device2interface_handle()
    usbd_interface2device_handle()
    usbd_pipe2device_handle()
    usbd_interface2endpoint_descriptor()
    usbd_endpoint_count()
- usbd_close_pipe() has documentation already
- bump date
2012-06-01 00:16:28 +00:00
wiz 144042a0cd Remove trailing whitespace. 2012-05-17 07:28:29 +00:00
mrg c344fad04f clarify some descriptions. document a couple more functions.
make a big commented list of the functions that are lacking real
descriptions.
2012-05-17 02:58:14 +00:00
mrg 47006ff476 fix a broken sentence. bump date. 2012-05-13 19:29:59 +00:00
mlelstv ec681a5cfa Fix tag for usbd_get_buffer 2012-05-13 12:10:18 +00:00
wiz 35ade9d47a Move DESCRIPTION below SYNOPSIS.
Remove function descriptions from SYNOPSIS.
Some cleanup while here.
XXX: most functions lack descriptions.
2012-05-13 11:57:39 +00:00
mrg 11f0cb34e4 convert the ugly .Bl/.El list of functions to a real one inside the
.Sh SYNOPSIS section.

XXX, the .Sh DESCRIPTION needs to move under the .Sh SYNOPSIS.
2012-05-13 10:57:09 +00:00
mrg 3f86678fb0 document a large chunk of the USB interface. some of this is kind of
generic and depends upon understanding USB itself (and since i don't
really that well, i might have gotten some wrong.)
2012-05-13 09:00:51 +00:00
njoly c7188eceb8 Use .In macro. 2011-10-20 12:14:12 +00:00
martin 11a6dbe728 Convert TNF licenses to new 2 clause variant 2008-04-30 13:10:46 +00:00
perry fd18408b9a u_intN_t -> uintN_t 2005-12-26 19:40:14 +00:00
wiz 770eef2122 New sentence, new line. 2002-10-14 13:43:14 +00:00
ross 4fa402f116 Generate <>& symbolically. I'm avoiding .../dist/... directories for now. 2002-02-13 08:17:26 +00:00
wiz 83d0300fdb Empty lines vs. .Pp cleanup, and sort sections. 2001-12-26 01:08:56 +00:00
wiz 342de5ede2 Fix typo and whitespaces. 2001-06-19 13:20:53 +00:00
augustss 97182e0962 Add a skeleton for the usbdi documentation.
This is still very incomplete.
1999-12-15 11:27:34 +00:00