Skip to content

Commit 6c05cdb

Browse files
fabioestevamgregkh
authored andcommitted
usb: Restore the reference to ch9.h
Keep the textual reference to ch9.h as it was prior to commit caa93d9 ("usb: Fix up movement of USB core kerneldoc location"). As linux/usb/ch9.h does not contain comments anymore, explain that drivers/usb/common/common.c includes such header and provides declarations of a few utilities routines for manipulating the data types from ch9.h. Also mention that drivers/usb/common/debug.c contains some functions for creating debug output. Fixes: caa93d9 ("usb: Fix up movement of USB core kerneldoc location") Reported-by: Alan Stern <stern@rowland.harvard.edu> Suggested-by: Alan Stern <stern@rowland.harvard.edu> Acked-by: Alan Stern <stern@rowland.harvard.edu> Signed-off-by: Fabio Estevam <festevam@gmail.com> Link: https://lore.kernel.org/r/20210425153253.2542816-1-festevam@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 9cbc7eb commit 6c05cdb

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

  • Documentation/driver-api/usb

Documentation/driver-api/usb/usb.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,16 +109,19 @@ well as to make sure they aren't relying on some HCD-specific behavior.
109109
USB-Standard Types
110110
==================
111111

112-
In ``drivers/usb/common/common.c`` and ``drivers/usb/common/debug.c`` you
113-
will find the USB data types defined in chapter 9 of the USB specification.
114-
These data types are used throughout USB, and in APIs including this host
115-
side API, gadget APIs, usb character devices and debugfs interfaces.
112+
In ``include/uapi/linux/usb/ch9.h`` you will find the USB data types defined
113+
in chapter 9 of the USB specification. These data types are used throughout
114+
USB, and in APIs including this host side API, gadget APIs, usb character
115+
devices and debugfs interfaces. That file is itself included by
116+
``include/linux/usb/ch9.h``, which also contains declarations of a few
117+
utility routines for manipulating these data types; the implementations
118+
are in ``drivers/usb/common/common.c``.
116119

117120
.. kernel-doc:: drivers/usb/common/common.c
118121
:export:
119122

120-
.. kernel-doc:: drivers/usb/common/debug.c
121-
:export:
123+
In addition, some functions useful for creating debugging output are
124+
defined in ``drivers/usb/common/debug.c``.
122125

123126
Host-Side Data Types and Macros
124127
===============================

0 commit comments

Comments
 (0)