From patchwork Fri Apr 28 09:50:27 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ioana Ciocoi Radulescu X-Patchwork-Id: 9704431 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 7502B602BF for ; Fri, 28 Apr 2017 10:06:50 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6224D28602 for ; Fri, 28 Apr 2017 10:06:50 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5542528668; Fri, 28 Apr 2017 10:06:50 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=2.0 tests=BAD_ENC_HEADER,BAYES_00, DKIM_SIGNED,DKIM_VALID autolearn=unavailable version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [65.50.211.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id CC4FC28602 for ; Fri, 28 Apr 2017 10:06:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-ID:Date:Subject:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=nli9HOkPcMVozm2amd7+jP5TacCvGiXE8vUmx2EQu+c=; b=OBtdZ5Uwr+gmXa 67cll7+bH03oNvM099tVMZpj+ZK/HDSIcW2qswdFwkPOQ7XaIlEY7dlVXo+jq+2sgy45r9TQAIWRr kMSeMo6uxpIOxKst4wHdz/PTFRkI3txdguML0o924r6jvE9afPA5HODIiBt52Me1EMjoJT5feKZha bOLTN1QWOatcA9EvfBAvCOsGgO8+bTSH3e9YQMY2Kl9WdlJPvnF2nviqlHZXS0Sg8zaJrhJ3F4lBe ooqRXgj8eVPbz7/PAcM193FllLs4KQovwuUepmhUFxA/LirG8Ln3oIWSorsQazS7rXyAIYCaWjwOv 9WidwXOQ/m35eDLGrvvw==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.87 #1 (Red Hat Linux)) id 1d42nY-0004ev-Ge; Fri, 28 Apr 2017 10:06:48 +0000 Received: from mail-bn3nam01on0054.outbound.protection.outlook.com ([104.47.33.54] helo=NAM01-BN3-obe.outbound.protection.outlook.com) by bombadil.infradead.org with esmtps (Exim 4.87 #1 (Red Hat Linux)) id 1d42YH-0001uM-1b for linux-arm-kernel@lists.infradead.org; Fri, 28 Apr 2017 09:51:10 +0000 Received: from DM5PR03CA0024.namprd03.prod.outlook.com (10.175.104.34) by BY2PR0301MB0599.namprd03.prod.outlook.com (10.160.125.21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1034.10; Fri, 28 Apr 2017 09:50:36 +0000 Received: from BN1BFFO11FD014.protection.gbl (2a01:111:f400:7c10::1:194) by DM5PR03CA0024.outlook.office365.com (2603:10b6:3:118::34) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1061.12 via Frontend Transport; Fri, 28 Apr 2017 09:50:36 +0000 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; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Received: from tx30smr01.am.freescale.net (192.88.168.50) by BN1BFFO11FD014.mail.protection.outlook.com (10.58.144.77) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.1047.9 via Frontend Transport; Fri, 28 Apr 2017 09:50:36 +0000 Received: from rhuath.am.freescale.net (rhuath.am.freescale.net [10.81.117.102]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v3S9oYob012229; Fri, 28 Apr 2017 02:50:35 -0700 From: Ioana Radulescu To: Subject: [PATCH v3 2/9] staging: fsl-dpaa2/eth: Add Ethernet driver overview document Date: Fri, 28 Apr 2017 04:50:27 -0500 Message-ID: <20170428095034.8842-3-ruxandra.radulescu@nxp.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170428095034.8842-1-ruxandra.radulescu@nxp.com> References: <20170428095034.8842-1-ruxandra.radulescu@nxp.com> X-EOPAttributedMessage: 0 X-Matching-Connectors: 131378466364075512; (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)(39400400002)(39840400002)(39860400002)(39380400002)(39450400003)(39850400002)(39410400002)(2980300002)(1110001)(1109001)(339900001)(199003)(189002)(9170700003)(53936002)(2950100002)(48376002)(8676002)(6916009)(2906002)(6666003)(104016004)(36756003)(33646002)(1076002)(2351001)(106466001)(105606002)(8936002)(50466002)(76176999)(77096006)(7416002)(50226002)(81166006)(54906002)(8656002)(4326008)(189998001)(305945005)(50986999)(47776003)(39060400002)(85426001)(5003940100001)(356003)(110136004)(38730400002)(5660300001)(86362001); DIR:OUT; SFP:1101; SCL:1; SRVR:BY2PR0301MB0599; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; MLV:ovrnspm; A:1; MX:1; PTR:InfoDomainNonexistent; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1BFFO11FD014; 1:+0BFeZn8UGJ3vJ/IitselAfKF1C5WH0dozpjJywFSzYy3ImzNd+SOUG6oMmTETuxvlYGeGgggMy4g9W/CYEV3CTvWTpFjFzaryUmT4EZK1CAkQvTXBm34zLfMlgAcoaYaNHLgi9IvhdmVMzB+EBl4dEkq9WTexNTof55Z5U3bTbpGaG9YwAVsbqJ+ynsCblMBLo/zIhItqZb0A9FnummpNQBIxl9VgUiU+N32RYRyGRNlXje1Vi2hf8pwbkKn4134UVBP644QeQ1BMY0kV67stZCWPblq8glLEUIrujbSvPXEMz9d4Ko6CYN97d/sfG4Y6oMxPjyebS9RCNSg7AJwmf9hj0cUpNQAoD96mfF5pTUlehxkMeld9tNpllYfeYBsQFHPTEk7Vyk/cZEBs4H6TIYoUqedZDIAiOwmUVEN1YYmeozf5uqZV5CsbHOSAl2iIO83ywRC183oZuAPk636lu9YKnuJmQaCRPtqZQeuGC/cdFCgC5DzuiKjZGjbJZwkqXIz4Y2nRncu15mfBOfuNUUBWCujyzG73F6/pNpABrK7Wmuq7IRIdfqOy5KJ0du+YNjt/2dJLRIBwfHvdvYlHKZiblNHvck2sjEKhcF0eyUh4fLpBb6y56+8LAN+YtVT6VnSRY6aUHkmnIxYGc8JflvBYvCGrFHsK47VLvbALoJ/1ZwnUot7QA5MTVwf9DqY2UnRsjTTV5kI+Hvv+WuoNAyeXNMANVCE8VF6kpskFs= MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: b20235de-9130-440b-22f0-08d48e1c0528 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(201703131430075)(201703131517081); SRVR:BY2PR0301MB0599; X-Microsoft-Exchange-Diagnostics: 1; BY2PR0301MB0599; 3:xeX34tCBhR54Mbh2wFpzdYFDJEIuCoOI9KLFenIlHvpM2WjfJ08q7XVZzf3JifDoSHBH8tegoOIMYiwvWY0KhMmJ1pvFab8S5qf4PvjQF2b8PU+G2HJUMOF7wTJodDjQ97r4fSchexiHBMi0/9FjE250RSV8Gcu1ivanYcOw4azjZs4zC3l04RzHr1Fc01/1A4Ph4LXQcFBgBWp9pIW8m9XzBMoibhTZB5mOLSy45SOdciYh2sfeH/k0hGLzXX5EW0yOpHpJCHXDkA3E31VLhg1q5DCXQ1l/1cPLRerBE1h/AqQlZuTTH29A4XkzlvrIbBcdNbkabKx7bCPYX+W4yKenSi0R/7DUizXJuUcaUrGLqlOEri3NUwCaZsKIZUIj/kptQTSeyh+76l15Yl8j7fZPj8sJ75tupuvam8ZqIEtXMKM/qu2RIbm+lK7CqWLt; 25:CC7d+awA1wqQL2skXmPL345/jcLn4Xxo3OpDvaHFVZOZqZHbk2sUIkivYP4pr6eL4DVKaIljaw/BaqdeO9VxKYmLyTeGdxfbBnKmRkCwNFdm/ZCJzTZIXxd42jeYoCuE0RYhz0VuWG4R/He5ln996UeJX06OphqcLw4cMc6gwLowGyOZzpxi/uiV3mFeLdKUMXYL797zSCL3tqgX4WqxFDmxvTSqmNSja0XwU9L7FjLSlZoYwb4jXFaUORunn51d1SHKbyM5S9ZbvaqUqfc/go/mG2rUvcCh6eCTHWZHktT585XVzmi5R6/PzFLYPD/5XEuqzUi97SOqx8+2sfcMgxgMlHWbM9INDxDNzSQEZx5EDfccTSTZIP00qolLTHjOKfojEG5Db6OdD9s+n06WW+s/IQLyNQfP4rocWzrk2fQ72aGpmrmKHQsWghURczNUfNW4qLnI9C/m54FXpoVAyA== X-Microsoft-Exchange-Diagnostics: 1; BY2PR0301MB0599; 31:c6V6LP6I3vEjYHp4/PIhN9/uaG8bq5XBF5f4GkSb3db0scH0EvrLIOGRraiCbz4/4MdOpWZfPpBpqUlm3nsh6XgmECcUp2o2Vflr77sugxi+WwcVjCmACYbW76+A1bw3lQr9zFbWxDAMXk78r0P00zxh/FgYn/kGOur3+wiWClTRunMdD8FNQXmbKD2bjR9/7hC2eg2bOhh/7I+WfdGXByhkBeOOIOftD9IQEhLvWo1NaaAZ2g2F1beRHjs41Gak7zoGqPVVggQDYr8dAfW3Sg== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(227817650892897); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095135)(601004)(2401047)(13015025)(5005006)(8121501046)(13017025)(13024025)(13023025)(13018025)(10201501046)(93006095)(93001095)(3002001)(6055026)(6096035)(201703131430075)(201703131433075)(201703131441075)(201703131448075)(201703161259150)(20161123565025)(20161123556025)(20161123561025)(20161123563025); SRVR:BY2PR0301MB0599; BCL:0; PCL:0; RULEID:(400006); SRVR:BY2PR0301MB0599; X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; BY2PR0301MB0599; 4:qBNlmD1HClpN51151NVbt86kzI2yqKcqe1G36gqu?= =?us-ascii?Q?mx/9hTOQ93DuRithD/udTv6ZEDZYf8op7OXoc1XXpvCHeXGO9iBS8gq5cnWw?= =?us-ascii?Q?EdLsuka8hgMPihAWaUTnqVH2XDn2VBKnzn0VnYQmdzH+sdX0F5Iu+47tmt68?= =?us-ascii?Q?VH1wALf58Bvg0YCznvK06ZxIcYEBePvtK/0QMHjIstt5pXvFxYTU1v6JuAnX?= =?us-ascii?Q?rn8l7f7RRF0P1viIcKBmF+DLrE5oQgBYlJGjHnix43vYJ/+fj+ZYfLTb4G2q?= =?us-ascii?Q?wsHkBfulgLonNQW9Xfmqp+RPZ1J9zuAznLVw88uchlY36kEv04T6RA8lglSH?= =?us-ascii?Q?ACm+Bmi0qZZb6SuEOejYnft1V4dQHvpQY1HdOOufJO1JlsN2MidoVLc+Qn7r?= =?us-ascii?Q?rxwmQ4eB/+Tvire3Fot6NpD6eLTdCZmxygchgE//Fu6YOCHfeuJIAKyprY54?= =?us-ascii?Q?q+QBFUQ7/vinUS7Na5HFIuIbTj7PziMQttobVmfnx8tn4cvc4dCkNIznc16M?= =?us-ascii?Q?4VNAGgOLXCjrFrRDyCeY/PYm6IRwzRbE0ZRXP1JLRpWgvZ0TOO2hHs8Dp4h8?= =?us-ascii?Q?WtKrwWVlX8CJRIpP3STqHBXhL224191sEvjVYYedCxwgaHCQM3b2V6tEzJWQ?= =?us-ascii?Q?cHkjaIEjWtLMh2JQwyXSRvmqFkUCG9uRS4Z330wMehWV2X93JNKMhF8j4hYa?= =?us-ascii?Q?o6Os36xJM7tNjQo03bcMNWGTu5+vJvqu7Sc/Br+8kISHAiRu8xqFlwsMQyCm?= =?us-ascii?Q?wgUdKcUbTYPyY8v77emQndUw/2n46FYZzxeu0TomUIr2RbxfcpryTdMzemEG?= =?us-ascii?Q?cx8r7XRHNhnd7Ps85reJG62xjB3i++1r+eKMyrDHSFPqNoHpNyseIq+08lYW?= =?us-ascii?Q?nnERuimaqjHA0kU+CQaT0DZbZ4lxs4Uo4S4gfzzjE2UfsXpV7RNbXwuFpRgK?= =?us-ascii?Q?rQWtn4qH1dTiE8tyng/xHKOkZD40vGiZObJXj4S/PA=3D=3D?= X-Forefront-PRVS: 029174C036 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; BY2PR0301MB0599; 23:ocQr1KYN/5iew12TvutlD0/4B2lWlX6lRXgaBxL?= =?us-ascii?Q?jtUZaKhTgDeA5E+l8NML0v+dWX6wHQLfY+kjMFKasp5+GLVe4N57hRE+hQ0H?= =?us-ascii?Q?LkIG8Q9je2jkFSS+3nZIBjN0EPU8VrRCXYfZRmGllQGJ5WWTEGUQCMagt4V5?= =?us-ascii?Q?LAsL6aODBZ+3zwes1mbEdtW7oOMb+8VDU/0ZAnMo70TeeicYsXDTya6LXvEn?= =?us-ascii?Q?OclHospK8jlJk8qoI2FMnzEWmRBmGK9WxJXZVRac3egGeB6vIH8BfJSyV02a?= =?us-ascii?Q?Zu2Pd77io7PFuPcMWZRvjVqD7gO5vUzXQONFal3XD2IUSMlutj3v2YfCciR4?= =?us-ascii?Q?uRbtDcuBRTbyLVZL3VqfNlS+If1v6njFbiztkUuIakPlPXy4YNG8uvcB2BdV?= =?us-ascii?Q?o5XQpcYJVtOlhD8EUyk/6Q14LqnGehYZ/wWm+sSx0eaHZ3n2qDgKJ8qFcBjv?= =?us-ascii?Q?k/pEuIbhwaWiWgagp2T5k3rlCbQ/J6TocDYBjn5C5u+oOODiupSvhK+9b0nI?= =?us-ascii?Q?CyX9gLsJ1iWB4PJclARHTNiPYmpPL+Z2IxRm/mWnTKJK+I2yFYBAkoPgpa5v?= =?us-ascii?Q?ned4HUGmIGw9GAe67sfwXyF+6x+FEbOjXqsk5DXHsCQK9U/O5gM02x9PVSzC?= =?us-ascii?Q?3N/SFJmgdNA2wAKxYMoPXbU6hTRJ2SrpVAVu3trMrLzxxgDfCTYbQJDkz+Ke?= =?us-ascii?Q?LZSIVAHprjYBsbulVPD7t3u0SuarNBITYo4r6bhFWjDItSkUtGieKxREpDp6?= =?us-ascii?Q?FX68M9RkXq439CYX5vfo6p09ivF5JoVyp7sTAyfeY4dWW37uvgFA8ENw7Mgq?= =?us-ascii?Q?/fBUrMCGc4PfBZOt4qMULlI1vBVsn6KmmGwu40SECdEdBPPOwH5NSAhvIpJQ?= =?us-ascii?Q?uDCmR811IeMxNr8YBdUS5fceDUD/Y86cgIyLQhxdR6FEi71zKTAFHT3Y9syf?= =?us-ascii?Q?rhbvuCORkoMmWlaAr4XEyyslcA6dI+cDIsOHJTpbdlR/Qpf4ZIzxXAfELJ0G?= =?us-ascii?Q?3dX1UQ9opuJKq5tnuOZqE58EOTzaQn0aFhHHDJiqTwsSp5zEpx24YsJ3GMCR?= =?us-ascii?Q?82zzSFZQZS8CssHZWERmI+YuBQWZNRRAmCkojzc82rkVlPI+4/sKPYOf+AdZ?= =?us-ascii?Q?AiyEJDXQU3F+OmRzFcfaF56feXVh6vyr09hQNCkAnk6+6tlIHvpiO5wkGlEW?= =?us-ascii?Q?vZY4sI2d4L75jQQB4Q9VA5EUra+qmzqQj4wLlltoZEEHYVYpE4Xm6T/PW+LY?= =?us-ascii?Q?piebH04iGWeAJrpPi2F0NfR7iXKbrF9KLa0N6knLF?= X-Microsoft-Exchange-Diagnostics: 1; BY2PR0301MB0599; 6:XHb+kwSORyDwDiu6FsCDc9Go8AOlAnTcQ3CwnZJJF7rSXwDWuMtVTFqeo/HEKuUwIBr+f9L7Z0fX9ybDLcuF0N4nW6u8gTmgStSKiXKalRSe0e6nqj8pgaMjnmz7sWjTHM3R7HbOm6Pxm9/rEPBEFk+jTjaL4Wu0zndxL+my/yCflEFL9irsxxEq5WhnkPWtclQhP6rj9k1C+lMshcWnLV0uTO3okvmt09ZhJ3lh/pDYihNuJTEbhqiCmQvgeIEtoXQ3ceBxCMV2yCDq8lqH5r36C9vF+GEjQcQljSEIIrm4g+0MU9yvk651PqI9tKzjpgb4KnZ2zPYpDl8I7iKBZHfN4Tew6mgu/EgAxDXyZ2OrqJz4Z0oAYKLpwFUBAEKj3u9oe/VMMKICfsiPqGLtxgNFtA0wooGDPfifHRgc3jsfugWRLvtDPy0OkRV+8vqlWvj5x2SOReMV6QIEjpEWRlhnwdySnKODarAIJgcglOx4Y8o0dFJRtKj8s2f2kf0ExXhQK+pXWG+fwzJvT83zaw==; 5:b3Cy1C6GrUPaNJzVTta6hPGoFBBjsO55p9lQTgWWFgLJP/CUx9gHmQmwbBoteOK6+ykGP56f8SXFfyBuEZYY9z2PfPsL0tsiWUlpDYZ28f7WKlFiwcMcAE3On0Uan4Kyk+SXjni+4YB5DHw2tprSvqs2d5J7AE9hp0Ntmwr4b7IjXBv38Cfpwzv6Zt5ndcRJ; 24:MYIu2kXINDcZqQrR+b98egbXNW4CdmUnjmtNIEPP9XD6NYp2Xy3Y4wG86aztSUPbSplC5Ue5fMf7RbJ1gvtgKsfhYVvwC6BRdDZJwpt/Uc4= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BY2PR0301MB0599; 7:JdLQZ3Ypc0KmJRNbLJoh5B2f5WG1zu6LfttmupCEiOjAarz8hbLhveMfIj/bzEL3ls/h20ggJ+4MBJtp4oyzCHrCFMtGwoMAcQ/TPdcBZOBCHWD56AmYYpWwA2hoAsDyfH6Yf44gm49SBCv33hmqAjOjlbud/N3eONKMAxjlpD7I+mBR5D5e1uure9PeUvcStq3lUmKiDU4ayXO9vdRlse0oQqms95NMNb4FRyoTXEORC32EQ+75JSZDD0x7yZlaE7iMle3a/zwkIv8SbUBHW0cooZgIhwFaT90WgwovqQnTcr8ZpJwFi6NZrvzWPx/8vf03LGlem0mH6aC+EvqZTg== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Apr 2017 09:50:36.0331 (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: BY2PR0301MB0599 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20170428_025101_332626_185D1EC2 X-CRM114-Status: GOOD ( 14.63 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: devel@driverdev.osuosl.org, stuyoder@gmail.com, arnd@arndb.de, haiying.wang@nxp.com, roy.pledge@nxp.com, ruxandra.radulescu@nxp.com, alexandru.marginean@nxp.com, linux-kernel@vger.kernel.org, agraf@suse.de, bogdan.hamciuc@nxp.com, bogdan.purcareata@nxp.com, linux-arm-kernel@lists.infradead.org, laurentiu.tudor@nxp.com Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+patchwork-linux-arm=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP Add a README file describing the driver architecture, components and I/O interface. Signed-off-by: Ioana Radulescu --- v3: no changes v2: no changes drivers/staging/fsl-dpaa2/ethernet/README | 186 ++++++++++++++++++++++++++++++ 1 file changed, 186 insertions(+) create mode 100644 drivers/staging/fsl-dpaa2/ethernet/README diff --git a/drivers/staging/fsl-dpaa2/ethernet/README b/drivers/staging/fsl-dpaa2/ethernet/README new file mode 100644 index 000000000000..410952ecf657 --- /dev/null +++ b/drivers/staging/fsl-dpaa2/ethernet/README @@ -0,0 +1,186 @@ +Freescale DPAA2 Ethernet driver +=============================== + +This file provides documentation for the Freescale DPAA2 Ethernet driver. + + +Contents +======== + Supported Platforms + Architecture Overview + Creating a Network Interface + Features & Offloads + + +Supported Platforms +=================== +This driver provides networking support for Freescale DPAA2 SoCs, e.g. +LS2080A, LS2088A, LS1088A. + + +Architecture Overview +===================== +Unlike regular NICs, in the DPAA2 architecture there is no single hardware block +representing network interfaces; instead, several separate hardware resources +concur to provide the networking functionality: + - network interfaces + - queues, channels + - buffer pools + - MAC/PHY + +All hardware resources are allocated and configured through 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. A few +hardware resources, like queues, do not have a corresponding MC object and +are treated as internal resources of other objects. + +For a more detailed description of the DPAA2 architecture and its object +abstractions see: + drivers/staging/fsl-mc/README.txt + +Each Linux net device is built on top of a Datapath Network Interface (DPNI) +object and uses Buffer Pools (DPBPs), I/O Portals (DPIOs) and Concentrators +(DPCONs). + +Configuration interface: + + ----------------------- + | DPAA2 Ethernet Driver | + ----------------------- + . . . + . . . + . . . . . . . . . . . . + . . . + . . . + ---------- ---------- ----------- + | DPBP API | | DPNI API | | DPCON API | + ---------- ---------- ----------- + . . . software +=========== . ========== . ============ . =================== + . . . hardware + ------------------------------------------ + | MC hardware portals | + ------------------------------------------ + . . . + . . . + ------ ------ ------- + | DPBP | | DPNI | | DPCON | + ------ ------ ------- + +The DPNIs are network interfaces without a direct one-on-one mapping to PHYs. +DPBPs represent hardware buffer pools. Packet I/O is performed in the context +of DPCON objects, using DPIO portals for managing and communicating with the +hardware resources. + +Datapath (I/O) interface: + + ----------------------------------------------- + | DPAA2 Ethernet Driver | + ----------------------------------------------- + | ^ ^ | | + | | | | | + enqueue| dequeue| data | dequeue| seed | + (Tx) | (Rx, TxC)| avail.| request| buffers| + | | notify| | | + | | | | | + V | | V V + ----------------------------------------------- + | DPIO Driver | + ----------------------------------------------- + | | | | | software + | | | | | ================ + | | | | | hardware + ----------------------------------------------- + | I/O hardware portals | + ----------------------------------------------- + | ^ ^ | | + | | | | | + | | | V | + V | ================ V + ---------------------- | ------------- + queues ---------------------- | | Buffer pool | + ---------------------- | ------------- + ======================= + Channel + +Datapath I/O (DPIO) portals provide enqueue and dequeue services, data +availability notifications and buffer pool management. DPIOs are shared between +all DPAA2 objects (and implicitly all DPAA2 kernel drivers) that work with data +frames, but must be affine to the CPUs for the purpose of traffic distribution. + +Frames are transmitted and received through hardware frame queues, which can be +grouped in channels for the purpose of hardware scheduling. The Ethernet driver +enqueues TX frames on egress queues and after transmission is complete a TX +confirmation frame is sent back to the CPU. + +When frames are available on ingress queues, a data availability notification +is sent to the CPU; notifications are raised per channel, so even if multiple +queues in the same channel have available frames, only one notification is sent. +After a channel fires a notification, is must be explicitly rearmed. + +Each network interface can have multiple Rx, Tx and confirmation queues affined +to CPUs, and one channel (DPCON) for each CPU that services at least one queue. +DPCONs are used to distribute ingress traffic to different CPUs via the cores' +affine DPIOs. + +The role of hardware buffer pools is storage of ingress frame data. Each network +interface has a privately owned buffer pool which it seeds with kernel allocated +buffers. + + +DPNIs are decoupled from PHYs; a DPNI can be connected to a PHY through a DPMAC +object or to another DPNI through an internal link, but the connection is +managed by MC and completely transparent to the Ethernet driver. + + --------- --------- --------- + | eth if1 | | eth if2 | | eth ifn | + --------- --------- --------- + . . . + . . . + . . . + --------------------------- + | DPAA2 Ethernet Driver | + --------------------------- + . . . + . . . + . . . + ------ ------ ------ ------- + | DPNI | | DPNI | | DPNI | | DPMAC |----+ + ------ ------ ------ ------- | + | | | | | + | | | | ----- + =========== ================== | PHY | + ----- + +Creating a Network Interface +============================ +A net device is created for each DPNI object probed on the MC bus. Each DPNI has +a number of properties which determine the network interface configuration +options and associated hardware resources. + +DPNI objects (and the other DPAA2 objects needed for a network interface) 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 & Offloads +=================== +Hardware checksum offloading is supported for TCP and UDP over IPv4/6 frames. +The checksum offloads can be independently configured on RX and TX through +ethtool. + +Hardware offload of unicast and multicast MAC filtering is supported on the +ingress path and permanently enabled. + +Scatter-gather frames are supported on both RX and TX paths. On TX, SG support +is configurable via ethtool; on RX it is always enabled. + +The DPAA2 hardware can process jumbo Ethernet frames of up to 10K bytes. + +The Ethernet driver defines a static flow hashing scheme that distributes +traffic based on a 5-tuple key: src IP, dst IP, IP proto, L4 src port, +L4 dst port. No user configuration is supported for now. + +Hardware specific statistics for the network interface as well as some +non-standard driver stats can be consulted through ethtool -S option.