Commit 401c7be2 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Acked-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 79e0c2e6

Documentation/usb/bulk-streams.txt→Documentation/driver-api/usb/bulk-streams.rst

+9 −4
Original line number Diff line number Diff line 
USB bulk streams

~~~~~~~~~~~~~~~~



Background

==========
@@ -25,6 +28,8 @@ time. 
Driver implications

===================



::



  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,7 +73,7 @@ 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,

		struct usb_host_endpoint **eps, unsigned int num_eps,

Documentation/driver-api/usb/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ Linux USB API 
   usb

   gadget

   anchors

   bulk-streams

   writing_usb_driver

   writing_musb_glue_layer

CRA Git | Maintained and supported by SUSTech CRA and CCSE