Re: [PATCH 5/5] usb: xhci: dbc: Document describe about dbc raw interface

[Greg KH <gregkh@linuxfoundation.org>]

On Fri, Jun 07, 2019 at 12:03:06PM +0530, Prabhat Chand Pandey wrote:
> This patch have explaination about the new DBC interface called
> dbc raw interface. This cover the capability, target setup and
> use case info.
> 
> Signed-off-by: Prabhat Chand Pandey <prabhat.chand.pandey@intel.com>
> ---

I want to see this signed off by Mathias first, before I review it...

>  Documentation/usb/dbc_raw.rst | 136 ++++++++++++++++++++++++++++++++++
>  Documentation/usb/index.rst   |  16 ++++
>  2 files changed, 152 insertions(+)
>  create mode 100644 Documentation/usb/dbc_raw.rst
>  create mode 100644 Documentation/usb/index.rst
> 
> diff --git a/Documentation/usb/dbc_raw.rst b/Documentation/usb/dbc_raw.rst
> new file mode 100644
> index 000000000000..b7d472a478f5
> --- /dev/null
> +++ b/Documentation/usb/dbc_raw.rst
> @@ -0,0 +1,136 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +======================================
> +This described about DBC RAW Interface
> +======================================
> +
> +:Author: Prabhat Chand Pandey <prabhat.chand.pandey@intel.com>
> +
> +Content
> +========
> +
> +- DBC Overview
> +- Motivation
> +- DBC RAW Capabilities
> +- Target Build Setup
> +- Target Test Setup
> +- Host Target Connection
> +- Experiment Test Result
> +- DBC TTY Use Cases
> +- DBC RAW Use Cases
> +- Conclusion
> +
> +DBC Overview
> +-------------
> +xDBC stands for the USB Debug capability provided extensible Host Controller
> +Interface. Universal Serial Bus is a host controlled Bus. Host Controller is
> +a hardware whose functionality is to manage usb bus and usb host ports. It is
> +responsible for initiating and managing all usb transfers. Extensible Host
> +Controller Interface (xHCI) is a register-level interface which provides a
> +mechanism by which the host controller (xHC) can communicate with the Operating
> +System of the host computer.

No need to capatalize Operating System.

> In addition to exposing register interfaces
> +essential for proper functioning of the xHC it also supports many extended
> +capabilities which can optionally be implemented by xHC.
> +
> +It includes Extended Power Management Capability, I/O Virtualization capability
> +USB Legacy support capability among many others.

What is "It" here?


> --- /dev/null
> +++ b/Documentation/usb/index.rst
> @@ -0,0 +1,16 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +===============================
> +Welcome to USB's documentation!
> +===============================
> +
> +.. toctree::
> +
> +   dbc_raw
> +
> +.. only::  subproject and html
> +
> +   Indices
> +   =======
> +
> +   * :ref:`genindex`

USB has more documentation than just this one file :(

greg k-h