diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-04-05 10:23:03 -0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-04-11 14:38:56 -0600 |
| commit | 401c7be2bad9eea68c1a660d54d1caa00b3098e4 (patch) | |
| tree | f74c39efc2bf7e91483f0bab5d2cad0169c2d443 | |
| parent | 79e0c2e6d4a382a7ac80cf082e3ca60bd42ab475 (diff) | |
| download | linux-stable-401c7be2bad9eea68c1a660d54d1caa00b3098e4.tar.gz | |
usb/bulk-streams.txt: convert to ReST and add to driver-api book
This document describe some USB core functions. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/driver-api/usb/bulk-streams.rst (renamed from Documentation/usb/bulk-streams.txt) | 13 | ||||
| -rw-r--r-- | Documentation/driver-api/usb/index.rst | 1 |
2 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/usb/bulk-streams.txt b/Documentation/driver-api/usb/bulk-streams.rst index ffc02021863e..99b515babdeb 100644 --- a/Documentation/usb/bulk-streams.txt +++ b/Documentation/driver-api/usb/bulk-streams.rst @@ -1,3 +1,6 @@ +USB bulk streams +~~~~~~~~~~~~~~~~ + Background ========== @@ -25,7 +28,9 @@ time. Driver implications =================== -int usb_alloc_streams(struct usb_interface *interface, +:: + + int usb_alloc_streams(struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, unsigned int num_streams, gfp_t mem_flags); @@ -53,7 +58,7 @@ controller driver, and may change in the future. Picking new Stream IDs to use -============================ +============================= Stream ID 0 is reserved, and should not be used to communicate with devices. If usb_alloc_streams() returns with a value of N, you may use streams 1 though N. @@ -68,9 +73,9 @@ Clean up ======== If a driver wishes to stop using streams to communicate with the device, it -should call +should call:: -void usb_free_streams(struct usb_interface *interface, + void usb_free_streams(struct usb_interface *interface, struct usb_host_endpoint **eps, unsigned int num_eps, gfp_t mem_flags); diff --git a/Documentation/driver-api/usb/index.rst b/Documentation/driver-api/usb/index.rst index 5dfb04b2d730..6fe7611f7332 100644 --- a/Documentation/driver-api/usb/index.rst +++ b/Documentation/driver-api/usb/index.rst @@ -7,6 +7,7 @@ Linux USB API usb gadget anchors + bulk-streams writing_usb_driver writing_musb_glue_layer |