From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751267AbdJBIgt (ORCPT ); Mon, 2 Oct 2017 04:36:49 -0400 Received: from mail-sn1nam01on0043.outbound.protection.outlook.com ([104.47.32.43]:28160 "EHLO NAM01-SN1-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751291AbdJBIgl (ORCPT ); Mon, 2 Oct 2017 04:36:41 -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 v2 5/6] staging: fsl-dpaa2/ethsw: Add README Date: Mon, 2 Oct 2017 11:36:19 +0300 Message-ID: <1506933380-12641-6-git-send-email-razvan.stefanescu@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1506933380-12641-1-git-send-email-razvan.stefanescu@nxp.com> References: <1506933380-12641-1-git-send-email-razvan.stefanescu@nxp.com> X-EOPAttributedMessage: 0 X-Matching-Connectors: 131514069997676256;(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)(346002)(376002)(39380400002)(39860400002)(2980300002)(1110001)(1109001)(339900001)(189002)(199003)(54534003)(50466002)(5003940100001)(4326008)(5660300001)(104016004)(39060400002)(53936002)(7416002)(50226002)(305945005)(6916009)(50986999)(76176999)(6666003)(2906002)(47776003)(105606002)(36756003)(8656003)(2351001)(85426001)(2950100002)(48376002)(68736007)(189998001)(33646002)(86362001)(498600001)(356003)(81166006)(316002)(54906003)(16586007)(97736004)(8936002)(77096006)(106466001)(81156014)(8676002);DIR:OUT;SFP:1101;SCL:1;SRVR:CY1PR03MB2363;H:tx30smr01.am.freescale.net;FPR:;SPF:Fail;PTR:InfoDomainNonexistent;MX:1;A:1;LANG:en; X-Microsoft-Exchange-Diagnostics: 1;BY2FFO11FD029;1:6yTMdiaRmVMxKEqoZ4PSALgGnYouFnHLuDke/Jt/B6jyXl5rxiZ9OzIBF4u3FN+isxmJpZBsvxoX+xAI6XraK/+BGmVYE8213I6+ngW9JT1oPg2TL5AlZT49BcCd2kdH MIME-Version: 1.0 Content-Type: text/plain X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 77b32fd3-04f9-4262-5bd8-08d50970b391 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(22001)(2017052603199)(201703131430075)(201703131517081);SRVR:CY1PR03MB2363; X-Microsoft-Exchange-Diagnostics: 1;CY1PR03MB2363;3:5YMw1PuaK9M0aCCvDYhbV8wfsknNrs9bYc643Oz7zFDVAnDa4SypfGOtTY7OJH2b4dC+ZCIwbBEMEFpkNnmjrIWhzQ9H87A8ceDFECh0D8bFIWGDwjbT9QHk7+D62PGStwMoGJa0/uwE3jvcTv4pSQoFJ30oFg3d7vLbGkMp1J6wL/rz6BOcUr1aVBdJjPa4aa14BXI2GYKFK1Bj1Uq4vl2MBw5EL0ogJlKxv5N3449RU/JFM0QuSX4aMoCZKL4NM53/6R/fj9SIKk1MepDqdscBfmcCPeO59bQES870YbC1rGYCDWRzB7GK5kVQZw79unpY932KPGFxjqpmjqJ92VgNUiFAS4R/kQT2jncZebA=;25:AgkFJDQK78RxsGgs9OyT3u/4pf1k2lgN74IzPLKDnJ03p7xNW6FzosEee+5PtHbpBptnLBD7GjMM1RbY0sGommJqoKQxNB+MkKA6/Fa8V1+uX1bF5UFn52GL5obfeEmpZlnsOH6u3ONBiPkTxB89wynWIAfE0Afxg18Uowmm2udChGLUFd+ygs2p37UEIYjpuGe41xWojiAG/QsS3XJmiX7CvSM5rmlSkr+91kYorMKyzlZ8vu/IhEv4CiWZ80/bxiOovKw4tIw5Uzz6XfYZI0jQxpGaDLroX1rS5v3oa7fCmEd6oera+wp/4ErtTANNu44+xK9aPU6MzDXIOjUaPw== X-MS-TrafficTypeDiagnostic: CY1PR03MB2363: X-Microsoft-Exchange-Diagnostics: 1;CY1PR03MB2363;31:QAfMgUKMqziLWd0/WBzLyFQzpZvIZJYVRdvJAcTMA31hH1vtaVEB6YeWdWN88I2uiw713KiS3SNZAFmXzPmcpV6s/RNzNFB6h7oRM+GJyDryd31zLM8I4v+ifjiDhjtf+3u1dMI8xLpIxNb84itP/eIOQ+Rxq8/LqhmDgAcVKVZIZLy1VQrP+OWjqTIlHb/oNNxHm4+tiO/hLiJvuLWPUDDp+94VIBFfPSRoVY9E/vY=;4:FJeq7pP8LTH+Sc4fGTxoTFXgybWDk4Hw/6OpW7OJPs93lUo2FEoeySbHYE/hRCcBuIGFm5DI3uUNL1SZ3XYMKpVN2GrFodNQe+hyveT68QHDWhnRP/M1yJIB3NlAjkud+ObahV0eSsK6HmxiRvi9gL0DjIPS1EEYaxR1/3hQmy3TbyouJnC7jLlj8WQ6e47KFzdUq0zWXVeWGnN/OLaUArKxeqiX6TSfT1gjLefszHUepaUsPIZ2ZS0x+68rvSBsWZ5d/Z9zWEDHs5MYdTupUc5zzVu8asIQDQPc6QO3QsOmxWSVcB8z+uAJX7H65Q4PfvPnHpiGnbgzbpWCJXbP/Q== 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)(3002001)(10201501046)(93006095)(93001095)(100000703101)(100105400095)(6055026)(6096035)(20161123559100)(20161123556025)(201703131430075)(201703131448075)(201703131433075)(201703161259150)(201703151042153)(20161123561025)(20161123563025)(20161123565025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095);SRVR:CY1PR03MB2363;BCL:0;PCL:0;RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095);SRVR:CY1PR03MB2363; X-Forefront-PRVS: 0448A97BF2 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1;CY1PR03MB2363;23:UcuVgs84+NxsmOKHtVNMjBZfnH2VRRnQ++kW5T4/D?= =?us-ascii?Q?XbZHmF3vwWkK0ICDVB5PdFkch0EGoVuOFYgSPefI6bSAmcXZUTU6nDI/9q/e?= =?us-ascii?Q?inzARMXVJumXrdtC+ZsXjf4ElUIdmIRiMnZ5/GmjwMmLRAGG66aGSR2ghm3D?= =?us-ascii?Q?cua0Zri9xEZ19ggAxUe9nazG5blj80s5IZkynkl4xUuxP6MxHYclCrSHtNbK?= =?us-ascii?Q?y/PVXMJxoJKlhlZ5uC5K6PBxKDnL/RldwiHzSHI71dLYHOirbk4J/oNneqCO?= =?us-ascii?Q?i3pPS+AdzHqgd46TzU1iWc4wPDFddGQ8oRAyRJKfG8x2Y1AUZekQlsQnelgd?= =?us-ascii?Q?nz1l5jrQfuMtvfqd3E5faQea/PRDHcUbt2aV4bDAqsB0+FgWKLAY5Ulqa9GS?= =?us-ascii?Q?BWoqeydu/4gqDBoGBoDo4oZWWibAr1s+d8XWtzmfwhGM0JW/I6CjrJKllgjX?= =?us-ascii?Q?AvbKZtBIdM59QUOJ1Ee7KPyuPaWLBUBTkdY4jcs/cpdnG1lMYP8gKX1XXssY?= =?us-ascii?Q?FWadBMdlrwLcrxaNGuUSentZnqZNl8WlKXMaG2nDOquPBQfryV0tE8JNDiAe?= =?us-ascii?Q?eb9pdLZLHr9jfTCuJIDesin/x5fia2/7mS+mPL8KsvSyfkDmJrrTJwuPRDzn?= =?us-ascii?Q?+9cMLD8CZqgK3blQ1ocG+acikXIBEPG8p1hMzvF8BEJ16imras4hpUbOJi8u?= =?us-ascii?Q?N/VWsLaGF8MuW0hzKi9KhmkUomk04kpjP1IDCdGeO8+z9LrNuD7l6kFkYj7F?= =?us-ascii?Q?C9vvi/BbOFprAbh2GJcQuj0KD3P6Jqgij6Zu495Sq81ryj9mqd/1Zw35ztYD?= =?us-ascii?Q?MlMVnwUq0MBqKcCoKYvjoLFTEv8U5R3+Zox9U3fAG5tpL6b+HAV+Ieqj4gT9?= =?us-ascii?Q?MBbFK2/qYVojPX8ZfO/DayIZw2jm/xyLSeSUyylwLNTFcioCaDrUouG4FBM/?= =?us-ascii?Q?MlkF0rN6G3iWP9xz4CZW5g+qOIecg4ofEc33PE+bzwHCxgA5ZhgWuGYjGtdc?= =?us-ascii?Q?Mqj6kORxpl1zMuodEmf4GAlFC89+9XQOmYJjHmRA1OeNiqE/Ms47BmZ8cvhR?= =?us-ascii?Q?WBhmvfe4FoWSGsDkY7Nm4Udzuiiy4JpaFP1aOGoLckKRQeMbbANc2u3GTgEl?= =?us-ascii?Q?SfW+LpCaepzKOzgCYW68XSmTdRvaTQZ/xhNukM6vr/PxNBPNoOw/n/Fk46G8?= =?us-ascii?Q?Ns7jryJDQVmFuDt/DOScCwjUsWFoLFiyqqMKiDBG9tNIrL9Vy5yfLacsQ=3D?= =?us-ascii?Q?=3D?= X-Microsoft-Exchange-Diagnostics: 1;CY1PR03MB2363;6:/JdFZVDzv3v21cx9rOUP0lYHsJKN+xMC3MvM84uP96I9ZGrpGagbe7RjRx2iWXhQJp2llj2ChPDaDCRqO5pT7azSViU24uNHlMCaJn6q7AtBEoyXL6vjBKMNNf5pUBbx3A3N1IHs5Juqp34hrFUhdo/CmS5d5Quj4JJrgEnRVr1KVIPVKi6Z6he31kE/MD536+T2qmKb1ghFVTJsoTau1ATp12rJw3KlSgn/1gxEU9OY5VXfDXpukeLXDmQBbo2BmAAatbM0VCAMvMBa8Kd8r06nt3Wl+oCbz+j9SSt5Y2DZKQieiGBulM15gY8Nvl30qbxnYyZY3K7/foUNvrmRjg==;5:UtvHmERbMZM8fzd0AJzslVUjHDUVxzvggR52FXXdfEYCSjBNuR7ZJPQn8gqDKSubtsOK6ZJsxjjzWfwMCQ5gR/AG74IhSAx3gHLA/OM9WGKShkT8ii4h89YVoYyzhpo3TU6Ju/lYDW32pnNtEkHmmg==;24:7stC91dggfnKFcF86/z6JYC74K+srqEPzN+BynlFN3IxWRYVdQVDQlVVQx03hsYE8ty1NcpNkDkepaxp7WaHxNlH02uMBhLCi3VOdnSabGM=;7:RISlfonBRWAQtsn/prYHCgWBLx6VqxgkV4NejjMTiMWay+RpQiwODwiIWjqEdZ/Hjjaf9OZ8oVLhVpXPVA6jBQ5ZDU8RWm8Gd73oXFL+o5PahVwwvnkn+FQ8I+Hnv+4rPOZ/StM3HUY4zIAlftfrYgfPn2Nyr05TFF/PDTfhCvtUIL+5nQNTSYOqPSnIE+RagBtEpvCIdgumdFYOYktq3iG6J0/lZMLfc65lp0aW2kQ= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Oct 2017 08:36:39.4400 (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: CY1PR03MB2363 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 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