From patchwork Mon Oct 12 19:54:59 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Murali Karicheri X-Patchwork-Id: 54817 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f198.google.com (mail-wi0-f198.google.com [209.85.212.198]) by patches.linaro.org (Postfix) with ESMTPS id E6F0322DB6 for ; Mon, 12 Oct 2015 19:55:52 +0000 (UTC) Received: by wicid10 with SMTP id id10sf14131052wic.2 for ; Mon, 12 Oct 2015 12:55:52 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:subject:date:message-id :mime-version:content-type:sender:precedence:list-id :x-original-sender:x-original-authentication-results:mailing-list :list-post:list-help:list-archive:list-unsubscribe; bh=8IBkq1PeXoTxPTGCzYN7IcX9MmOK43X078P2wxQqQCg=; b=IWnioySLkUWC3C+3s43n8oX/NJk7oT6Glot6+a50ULL7Se7hqeRX7SrrKk0vmJ2vl0 8Y3X6bVFaPxXcDTHalmkf2C6cblEwpXZ7ayzoi6glQfJLKN8mOES0MF6XMKBXEyzboPo 2vrNXXKhJEj2ld+IClmZs3dx1zkj6uuziLk2GLDE28vZnNy8ywuvigQObz+mZAIATbx9 UW7775kh+f/nDInkUvcHt4h+mzs2suRd1Ar8cE03FrcqH+PURlbFuzzUiBQ63UThZT7F pYg4JtcYpnRvfD7gbEy9UrYpKtAfNo/xK2JuODiQAJiHkgwwHaOToYv9JDdcHotYf947 Le3Q== X-Gm-Message-State: ALoCoQmanLQkrcPhdEhTY/a9lL/HC83Lf6FTUfaQF5qJYiAI3931RVzR6WUpfzPtVnhTrNweB39O X-Received: by 10.112.72.39 with SMTP id a7mr2387959lbv.1.1444679752201; Mon, 12 Oct 2015 12:55:52 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.25.141.198 with SMTP id p189ls604568lfd.79.gmail; Mon, 12 Oct 2015 12:55:52 -0700 (PDT) X-Received: by 10.112.125.231 with SMTP id mt7mr12951314lbb.87.1444679752038; Mon, 12 Oct 2015 12:55:52 -0700 (PDT) Received: from mail-lb0-f171.google.com (mail-lb0-f171.google.com. [209.85.217.171]) by mx.google.com with ESMTPS id 36si12413483lfy.6.2015.10.12.12.55.51 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 12 Oct 2015 12:55:52 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.171 as permitted sender) client-ip=209.85.217.171; Received: by lbcao8 with SMTP id ao8so153889955lbc.3 for ; Mon, 12 Oct 2015 12:55:51 -0700 (PDT) X-Received: by 10.112.130.70 with SMTP id oc6mr13520505lbb.32.1444679751915; Mon, 12 Oct 2015 12:55:51 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.59.35 with SMTP id w3csp1727295lbq; Mon, 12 Oct 2015 12:55:50 -0700 (PDT) X-Received: by 10.68.229.100 with SMTP id sp4mr36001695pbc.32.1444679750717; Mon, 12 Oct 2015 12:55:50 -0700 (PDT) Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id vi4si28479061pbc.209.2015.10.12.12.55.50; Mon, 12 Oct 2015 12:55:50 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752565AbbJLTzo (ORCPT + 30 others); Mon, 12 Oct 2015 15:55:44 -0400 Received: from bear.ext.ti.com ([192.94.94.41]:35178 "EHLO bear.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751526AbbJLTzl (ORCPT ); Mon, 12 Oct 2015 15:55:41 -0400 Received: from dlelxv90.itg.ti.com ([172.17.2.17]) by bear.ext.ti.com (8.13.7/8.13.7) with ESMTP id t9CJstFW027168; Mon, 12 Oct 2015 14:54:55 -0500 Received: from DFLE72.ent.ti.com (dfle72.ent.ti.com [128.247.5.109]) by dlelxv90.itg.ti.com (8.14.3/8.13.8) with ESMTP id t9CJstYO004291; Mon, 12 Oct 2015 14:54:55 -0500 Received: from dlep33.itg.ti.com (157.170.170.75) by DFLE72.ent.ti.com (128.247.5.109) with Microsoft SMTP Server id 14.3.224.2; Mon, 12 Oct 2015 14:54:55 -0500 Received: from ula0868495.am.dhcp.ti.com (ileax41-snat.itg.ti.com [10.172.224.153]) by dlep33.itg.ti.com (8.14.3/8.13.8) with ESMTP id t9CJssHi005398; Mon, 12 Oct 2015 14:54:54 -0500 From: Murali Karicheri To: , , , , , , , , , , , , Subject: [Resend: PATCH v2 1/4] Documentation: dt: soc: move driver description to a separate document Date: Mon, 12 Oct 2015 15:54:59 -0400 Message-ID: <1444679700-11451-1-git-send-email-m-karicheri2@ti.com> X-Mailer: git-send-email 1.9.1 MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: list List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: m-karicheri2@ti.com X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.217.171 as permitted sender) smtp.mailfrom=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 List-Post: , List-Help: , List-Archive: List-Unsubscribe: , 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 --- 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 @@ -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";