[Resend:,v2,1/4] Documentation: dt: soc: move driver description to a separate document

Commit Message

Murali Karicheri Oct. 12, 2015, 7:54 p.m. UTC

Currently the DT bindings have details about the driver as well. This
patch moves this to a separate document for knav qmss driver so that
driver detail update can be done as needed without polluting the DT
bindings description.

Signed-off-by: Murali Karicheri <[e-mail]>
---
 Documentation/arm/keystone/knav-qmss.txt           | 24 ++++++++++++++++++++++
 .../bindings/soc/ti/keystone-navigator-qmss.txt    | 20 ++++--------------
 2 files changed, 28 insertions(+), 16 deletions(-)
 create mode 100644 Documentation/arm/keystone/knav-qmss.txt

Comments

Arnd Bergmann Oct. 13, 2015, 2:31 p.m. UTC | #1

On Monday 12 October 2015 15:54:59 Murali Karicheri wrote:
> Currently the DT bindings have details about the driver as well. This
> patch moves this to a separate document for knav qmss driver so that
> driver detail update can be done as needed without polluting the DT
> bindings description.
> 
> Signed-off-by: Murali Karicheri <[e-mail]>
> ---
>  Documentation/arm/keystone/knav-qmss.txt           | 24 ++++++++++++++++++++++
>  .../bindings/soc/ti/keystone-navigator-qmss.txt    | 20 ++++--------------
>  2 files changed, 28 insertions(+), 16 deletions(-)
>  create mode 100644 Documentation/arm/keystone/knav-qmss.txt
> 
> diff --git a/Documentation/arm/keystone/knav-qmss.txt b/Documentation/arm/keystone/knav-qmss.txt
> new file mode 100644
> index 0000000..79946d1
> --- /dev/null
> +++ b/Documentation/arm/keystone/knav-qmss.txt
>  
> +For details of the driver, please refer to
> +Documentation/arm/keystone/knav-qmss.txt
>  
>  Required properties:
>  - compatible   : Must be "ti,keystone-navigator-qmss";
> 

I'd actually not even put this sentence in: the binding is supposed
to describe the hardware, not the Linux implementation as you correctly
describe above, but I'd also try to not reference files that only
exist in the Linux kernel tree.

	Arnd

Patch

diff --git a/Documentation/arm/keystone/knav-qmss.txt b/Documentation/arm/keystone/knav-qmss.txt
new file mode 100644
index 0000000..79946d1
--- /dev/null
+++ b/Documentation/arm/keystone/knav-qmss.txt
@@ -0,0 +1,24 @@ 
+* Texas Instruments Keystone Navigator Queue Management SubSystem driver
+
+Driver source code path
+  drivers/soc/ti/knav_qmss.c
+  drivers/soc/ti/knav_qmss_acc.c
+
+The QMSS (Queue Manager Sub System) found on Keystone SOCs is one of
+the main hardware sub system which forms the backbone of the Keystone
+multi-core Navigator. QMSS consist of queue managers, packed-data structure
+processors(PDSP), linking RAM, descriptor pools and infrastructure
+Packet DMA.
+The Queue Manager is a hardware module that is responsible for accelerating
+management of the packet queues. Packets are queued/de-queued by writing or
+reading descriptor address to a particular memory mapped location. The PDSPs
+perform QMSS related functions like accumulation, QoS, or event management.
+Linking RAM registers are used to link the descriptors which are stored in
+descriptor RAM. Descriptor RAM is configurable as internal or external memory.
+The QMSS driver manages the PDSP setups, linking RAM regions,
+queue pool management (allocation, push, pop and notify) and descriptor
+pool management.
+
+knav qmss driver provides a set of APIs to drivers to open/close qmss queues,
+allocate descriptor pools, map the descriptors, push/pop to queues etc. For
+details of the available APIs, please refers to include/linux/soc/ti/knav_qmss.h
diff --git a/Documentation/devicetree/bindings/soc/ti/keystone-navigator-qmss.txt b/Documentation/devicetree/bindings/soc/ti/keystone-navigator-qmss.txt
index d8e8cdb..2cecea1 100644
--- a/Documentation/devicetree/bindings/soc/ti/keystone-navigator-qmss.txt
+++ b/Documentation/devicetree/bindings/soc/ti/keystone-navigator-qmss.txt
@@ -1,20 +1,8 @@ 
-* Texas Instruments Keystone Navigator Queue Management SubSystem driver
-
-The QMSS (Queue Manager Sub System) found on Keystone SOCs is one of
-the main hardware sub system which forms the backbone of the Keystone
-multi-core Navigator. QMSS consist of queue managers, packed-data structure
-processors(PDSP), linking RAM, descriptor pools and infrastructure
-Packet DMA.
-The Queue Manager is a hardware module that is responsible for accelerating
-management of the packet queues. Packets are queued/de-queued by writing or
-reading descriptor address to a particular memory mapped location. The PDSPs
-perform QMSS related functions like accumulation, QoS, or event management.
-Linking RAM registers are used to link the descriptors which are stored in
-descriptor RAM. Descriptor RAM is configurable as internal or external memory.
-The QMSS driver manages the PDSP setups, linking RAM regions,
-queue pool management (allocation, push, pop and notify) and descriptor
-pool management.
+* Texas Instruments Keystone Navigator (knav) Queue Management SubSystem driver
+  DT bindings
 
+For details of the driver, please refer to
+Documentation/arm/keystone/knav-qmss.txt
 
 Required properties:
 - compatible	: Must be "ti,keystone-navigator-qmss";