From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751862AbdJEJQs (ORCPT ); Thu, 5 Oct 2017 05:16:48 -0400 Received: from mail-bn3nam01on0052.outbound.protection.outlook.com ([104.47.33.52]:2248 "EHLO NAM01-BN3-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751721AbdJEJQf (ORCPT ); Thu, 5 Oct 2017 05:16:35 -0400 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; nxp.com; dkim=none (message not signed) header.d=none;nxp.com; dmarc=fail action=none header.from=nxp.com; From: Razvan Stefanescu To: CC: , , , , , , , , , Subject: [PATCH v3 5/6] staging: fsl-dpaa2/ethsw: Add README Date: Thu, 5 Oct 2017 12:16:13 +0300 Message-ID: <1507194974-12050-6-git-send-email-razvan.stefanescu@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1507194974-12050-1-git-send-email-razvan.stefanescu@nxp.com> References: <1507194974-12050-1-git-send-email-razvan.stefanescu@nxp.com> X-EOPAttributedMessage: 0 X-Matching-Connectors: 131516685941813768;(91ab9b29-cfa4-454e-5278-08d120cd25b8);() X-Forefront-Antispam-Report: CIP:192.88.168.50;IPV:NLI;CTRY:US;EFV:NLI;SFV:NSPM;SFS:(10009020)(6009001)(336005)(7966004)(346002)(39860400002)(376002)(39380400002)(2980300002)(1110001)(1109001)(339900001)(199003)(189002)(54534003)(39060400002)(2950100002)(77096006)(76176999)(53936002)(8656003)(36756003)(68736007)(316002)(6666003)(6916009)(85426001)(105606002)(97736004)(498600001)(50986999)(16586007)(104016004)(5003940100001)(86362001)(50226002)(54906003)(189998001)(7416002)(5660300001)(8676002)(106466001)(81156014)(47776003)(356003)(81166006)(2906002)(4326008)(48376002)(305945005)(33646002)(8936002)(50466002)(2351001);DIR:OUT;SFP:1101;SCL:1;SRVR:BN6PR03MB2689;H:tx30smr01.am.freescale.net;FPR:;SPF:Fail;PTR:InfoDomainNonexistent;A:1;MX:1;LANG:en; X-Microsoft-Exchange-Diagnostics: 1;BN1AFFO11OLC001;1:GtUTAZjKM9YRWQDO1tLp+eSFWDZVxkYQnDK+4vixydCiRwTmShSevB7Jkb/dSv0TAC296/Z/VGGQ44OnAkVkjqmOLBIpWc/k9SHBg8XCuqtOKH7zQ2q/e8+zc7qnH+Ek MIME-Version: 1.0 Content-Type: text/plain X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 8e864742-0760-479f-d0ac-08d50bd1c60d X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(22001)(2017052603199)(201703131430075)(201703131517081);SRVR:BN6PR03MB2689; X-Microsoft-Exchange-Diagnostics: 1;BN6PR03MB2689;3:PcS57mJcl/fABnCRilUYrNYFF7RL+j43ArElWXGnv5BzMyq3PTrDWWGs0TWe+sXYFZTGUrx5tDA0v6eTuX9YTtVJ2Ge9tHL1ZoENzHqpeTusky+VHoIdeUs94J1lpXRPM9iif722cxRG+Z36vVJ404Jgc7dYDLQ/QMjVc5U1g8JwV2RHbOGih6qHGfJGM8dkVSNWqvpRXitPkJOuRPIstz+qta39ceNFFWN6Xsao7bdg9tCVdMvPMnppLIL8Q+7qxTIwmrw4s/6ZmAt6dfWCdQyXVn9PBiityquXn/urJ8AMnN6ecEyxUJe8ufvPEK0mF/g/zofGWJb0FmCi2Wr3fJzEiuWozAWm/EPqzQiqtK8=;25:dAv67W3uEg7eyr8f33RYdFTaCE8sHc9jqft7JKhY+S8To/kdXD1yxvPvpL6pNY0/qM+k8x2QY3TYCF9rzS2gv7oKBSyWVmH9IU0Gn+4Wd+5R2dzAxOZ7U+W4IHbJNHIMUldBNw+ypbe9JWVPlBs78WNnew0VS/WQri5rUIKvv4onnpmBkwHuL/2fQI+QYeIBEZVS7KAsPlWZyWwBbNO0P+9r7F9jSXgTzAPcJEmmgKuMasFcE34Z/X7vzZmTHa1erqqKH+j9PQjqW7xm2f9hDT3I12s8CKD2qyGSCMaZtV9p2hW7vT9/2IjHkHGzqbYTvYMr2t6NT1Mt/EeVSjjLNQ== X-MS-TrafficTypeDiagnostic: BN6PR03MB2689: X-Microsoft-Exchange-Diagnostics: 1;BN6PR03MB2689;31:Wtq5N6j5Ev5ADRUK0U0AzJIJ/D+R+HwSmABLah86+zrE2qVaO0cTgeDS8jSXaYPJp+DflxS/6y3PaTv0DhqxsA5moC1TChrmjys8bvzMnVCeTbTT/7lB3xEsgVyc7ftA6jtf2Wx9yfNQRNcijdw2874jf9zzlGnU7PmmH5TlJ6JQZGRJzQ/zT65zwQ5FZGk2itMXKEwd4gw9YGpyARLdUImJRvFviypsJ7GmLS9rAh8=;4:Wr4tl0tWW1NhubCcYgFcLdBKuVk58Ax01ydU+W2WH2N+zyEh4z5diLIMx5A0Xe2kHz2O0hNF1RDFVFbaUEbKeB4hhFxP2sg7Yt/qH7GeTFmfArks+xGUa6Qz+s+newE27Tq/YHazd7iKhNRV0RQm061bHALmEzQ4u4HYszQ00zMNBD6cAGcNDgnyZdh9FXmxpoW2O73YumcJY33r32gkAYqHCSuoF0cLIVA996ntQZ0yv+ZFsC2tMjF0RQzutoC9rUVFGKbiWoifEbrxBjIsddH0CEITzk8UJETil+GOEnnsxqf3ZHjzwi0f81Z9LmfHqTDRB8XjMEzKLwutqg7DoA== X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(227817650892897); X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-CFA-Test: BCL:0;PCL:0;RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6095135)(2401047)(5005006)(8121501046)(10201501046)(3002001)(100000703101)(100105400095)(93006095)(93001095)(6055026)(6096035)(20161123559100)(20161123556025)(201703131430075)(201703131441075)(201703131448075)(201703131433075)(201703161259150)(20161123561025)(20161123565025)(20161123563025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095);SRVR:BN6PR03MB2689;BCL:0;PCL:0;RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095);SRVR:BN6PR03MB2689; X-Forefront-PRVS: 04519BA941 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1;BN6PR03MB2689;23:mL8HRErm37ztqUjlUgK0cm0mDNs9SHSfpG+OxXnac?= =?us-ascii?Q?G8eiD84oCkAid84NDtzvjnYLONKVYHE7n+WsOkYHVkesQcvWztSoSZ9jenBA?= =?us-ascii?Q?QOgPjH++6LRHsL89mQNU34j7VsazHMrBh6IhAZ3BjRcpInXAfyJUsrfdTbEj?= =?us-ascii?Q?t4JIaS0jkYlGV7/dN55tKbI+kTj81boWeoLkII63qjAS/Ivn/Qu7m7C2Niy6?= =?us-ascii?Q?z2FzPItxH4XciXw1hPCdv3MrOwHnGgGm49fDSZUN9nIy6tVPWEUXhqluuUD3?= =?us-ascii?Q?9AAbYbC1oC51RekLFK8TDx97+2WLI5C3AxuTDkPinTJARUgLybZAgo01+CPL?= =?us-ascii?Q?iiSLxlejCsoY6v23i6MSdOqLApQlFKYBgLgNLPtd38ZDcRQs+ruo+Ky9Fn9/?= =?us-ascii?Q?dBjwbfqG3tpntTJpCNH2WJxv235bD9kRVkEK5IKdX4Iq0F1ynxCk0VWj3Gd3?= =?us-ascii?Q?Reclw9JWF04mSYHYS6Lvm1hThhJqoXrmx7PlJMAbG4cOZNYgcl4WgKStyrqx?= =?us-ascii?Q?UoAxwOKHp3tr5VSsMDVymSF2V14NmPhP12L+qXx9YhJl/hZ6DyL9tA+QMbaL?= =?us-ascii?Q?yBHf9n6Eh3OLONgTbgHwyyuEo0Z3DaM4Xm9wTtc60EImNqi0g3st1mYbJVoM?= =?us-ascii?Q?f2WKtz3iJczwJc2M8MnxnbOQ88Pc6q6Ku2bR2iRtyhoSwjW1Lpfk/w97JVfk?= =?us-ascii?Q?YV2p2liTKxLho12+IjX7memZAS4+fraiufMieFucS6D6yAeGzsTcp42RIDb4?= =?us-ascii?Q?FdqBRmxmXUGNZJx0a8DipmnwCthYzY2XH/CIaKAApzani890EXvEbGCMLcmV?= =?us-ascii?Q?uklY9ig7G9XtnnuwB5ENyIboJmukkeTZ7QtqMJdgGr5KZI0FYd6YWy3tSz6u?= =?us-ascii?Q?OGs3dH6hmtFIMgdJftYS6//djQESHvJkaf0wyYVXsBEfBWemc3RymBsv149i?= =?us-ascii?Q?AbjXATu6qKsDW9YL9pI6NSf9GYht/7B03Wv0hnB38tSQcjrlxRKCcd0mn4m/?= =?us-ascii?Q?r+Kra6ydF3R/rDxG2vuksBIlmdsHbrOatPil5JffHdL9TXdK02GQ6Uml7QVL?= =?us-ascii?Q?7YN+m1XgvCDXcaLmzZSe4FbNgjAwqbLZZFt4OphxiArxn1bPsOsDbVZTU4cZ?= =?us-ascii?Q?KRd9QJa59y2FDYr6M351YBD5MkKb8R3Vilu7nPjz2FEh0WwtLCfyNGuAS2Q9?= =?us-ascii?Q?UDumVvbQUC8uIdPrGq8IxNUnN13JtqnRCPY6LD5GQ4ur9ttfrN1B329zB5hT?= =?us-ascii?Q?tA9PssOvMN0eRSK9jE=3D?= X-Microsoft-Exchange-Diagnostics: 1;BN6PR03MB2689;6:cnWXj51vP00W7ADZJ29C+BcYpfoTMzl6BIx+wCWBVML96hKdA059QH88IMngEhSKCkcZOJRAIYbgnU+gbCILrl/LUVGkp8aLNclX3Nv0DB2dw3Sh8d7rgvQfFgglqZM3cO1CULm4erMYixDt4dWp0gpbuxOQAejQ8eu4aZIMZ9+GEPMhpPEnuy49KY+qcjAObdMuuAtlhnspYwjUpNnedkhzl8LkjCDA2GPbx4y+qRD3n8W+nM3/jV7PXocTGBeEJNaxtog3roptQBfPEVizfmU4yUp2k0k2lCupdpULv3KwD7dbRwPkTZ2uu7ZNW+jRMRDmkcwrv5cDG/Jsewrj9w==;5:9gHknc1TuV3QjM6VhNDHr64f+Eo3WKZrmv5KqvWOdotgBBjzOXOpoa8b9fdDhGEK6mbTC9vWKRM8AuO6ENOUf/dwkFQsMOnluGKv/OwYgnO/O/melEwMxfc5KV147jMhb1Ea4brSphASY4o6hHhjAg==;24:IZNDYZE16z9v9LrRVwF58u42sGSic0YO6XYMX1debwwZtsx0VT19Q3yncsOQwlWXJRd9li9hFNoDF5rKPvEL/7NtO5SQj7L6TmgTt8w0Evw=;7:PeUOLIJH+1HP+nqDS1RtsRUkWxlF11aJvYxlUq37YsGnQTY5Rkz07XUToQ7uBBcPTcmX0BqesN6+4RfbmrkxcQTHgRwIrIH8HtK80m/5Aq156FowghNd9claTXh1hoow9wfdo+6D1KAYOzj/xnbm6oPUF1Lq+rbYuKZpexaeTpHjh956s5BGxvYHZl4ylfq9jLuRBq2/kusi+Ioes5RahcXYJUoxok4RxhB1KoRW73Y= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Oct 2017 09:16:33.9629 (UTC) X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e;Ip=[192.88.168.50];Helo=[tx30smr01.am.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR03MB2689 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add a README file describing the driver architecture, components and interfaces. Signed-off-by: Razvan Stefanescu --- Changelog: v2: - no changes v3: - no changes drivers/staging/fsl-dpaa2/ethsw/README | 106 +++++++++++++++++++++++++++++++++ 1 file changed, 106 insertions(+) create mode 100644 drivers/staging/fsl-dpaa2/ethsw/README diff --git a/drivers/staging/fsl-dpaa2/ethsw/README b/drivers/staging/fsl-dpaa2/ethsw/README new file mode 100644 index 0000000..f6fc07f --- /dev/null +++ b/drivers/staging/fsl-dpaa2/ethsw/README @@ -0,0 +1,106 @@ +DPAA2 Ethernet Switch driver +============================ + +This file provides documentation for the DPAA2 Ethernet Switch driver + + +Contents +======== + Supported Platforms + Architecture Overview + Creating an Ethernet Switch + Features + + + Supported Platforms +=================== +This driver provides networking support for Freescale LS2085A, LS2088A +DPAA2 SoCs. + + +Architecture Overview +===================== +The Ethernet Switch in the DPAA2 architecture consists of several hardware +resources that provide the functionality. These are allocated and +configured via the Management Complex (MC) portals. MC abstracts most of +these resources as DPAA2 objects and exposes ABIs through which they can +be configured and controlled. + +For a more detailed description of the DPAA2 architecture and its object +abstractions see: + drivers/staging/fsl-mc/README.txt + +The Ethernet Switch is built on top of a Datapath Switch (DPSW) object. + +Configuration interface: + + --------------------- + | DPAA2 Switch driver | + --------------------- + . + . + ---------- + | DPSW API | + ---------- + . software + ================= . ============== + . hardware + --------------------- + | MC hardware portals | + --------------------- + . + . + ------ + | DPSW | + ------ + +Driver uses the switch device driver model and exposes each switch port as +a network interface, which can be included in a bridge. Traffic switched +between ports is offloaded into the hardware. Exposed network interfaces +are not used for I/O, they are used just for configuration. This +limitation is going to be addressed in the future. + +The DPSW can have ports connected to DPNIs or to PHYs via DPMACs. + + + [ethA] [ethB] [ethC] [ethD] [ethE] [ethF] + : : : : : : + : : : : : : +[eth drv] [eth drv] [ ethsw drv ] + : : : : : : kernel +======================================================================== + : : : : : : hardware + [DPNI] [DPNI] [============= DPSW =================] + | | | | | | + | ---------- | [DPMAC] [DPMAC] + ------------------------------- | | + | | + [PHY] [PHY] + +For a more detailed description of the Ethernet switch device driver model +see: + Documentation/networking/switchdev.txt + +Creating an Ethernet Switch +=========================== +A device is created for the switch objects probed on the MC bus. Each DPSW +has a number of properties which determine the configuration options and +associated hardware resources. + +A DPSW object (and the other DPAA2 objects needed for a DPAA2 switch) can +be added to a container on the MC bus in one of two ways: statically, +through a Datapath Layout Binary file (DPL) that is parsed by MC at boot +time; or created dynamically at runtime, via the DPAA2 objects APIs. + +Features +======== +Driver configures DPSW to perform hardware switching offload of +unicast/multicast/broadcast (VLAN tagged or untagged) traffic between its +ports. + +It allows configuration of hardware learning, flooding, multicast groups, +port VLAN configuration and STP state. + +Static entries can be added/removed from the FDB. + +Hardware statistics for each port are provided through ethtool -S option. -- 1.9.1