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>
This commit is contained in:
Mauro Carvalho Chehab 2017-04-05 10:23:03 -03:00 committed by Jonathan Corbet
parent 79e0c2e6d4
commit 401c7be2ba
2 changed files with 10 additions and 4 deletions

View File

@ -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);

View File

@ -7,6 +7,7 @@ Linux USB API
usb
gadget
anchors
bulk-streams
writing_usb_driver
writing_musb_glue_layer