Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753778AbbHMRne (ORCPT ); Thu, 13 Aug 2015 13:43:34 -0400 Received: from mail-bn1bon0084.outbound.protection.outlook.com ([157.56.111.84]:24736 "EHLO na01-bn1-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1753689AbbHMRn1 (ORCPT ); Thu, 13 Aug 2015 13:43:27 -0400 Authentication-Results: spf=fail (sender IP is 66.35.236.227) smtp.mailfrom=opensource.altera.com; ettus.com; dkim=none (message not signed) header.d=none; Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=atull@opensource.altera.com; From: To: , , , , , CC: Moritz Fischer , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , Petr Cvek , , , Alan Tull Subject: [PATCH v10 5/8] staging: usage documentation for simple fpga bus Date: Thu, 13 Aug 2015 12:37:29 -0500 Message-ID: <1439487452-23977-7-git-send-email-atull@opensource.altera.com> X-Mailer: git-send-email 1.7.9.5 In-Reply-To: <1439487452-23977-1-git-send-email-atull@opensource.altera.com> References: <1439487452-23977-1-git-send-email-atull@opensource.altera.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [64.129.157.38] X-ClientProxiedBy: CY1PR13CA0115.namprd13.prod.outlook.com (25.164.65.41) To BN3PR03MB1510.namprd03.prod.outlook.com (25.163.35.149) X-Microsoft-Exchange-Diagnostics-untrusted: 1;BN3PR03MB1510;2:Ne4c7ctmh68xMZH/7Yi8RbPvZ5AGi8KhPifHW1oeVvY1S1tydetIAyuK2Y1CQQmE25hyHv7BVisetV1Kty/3oIG79Xw7sIxMXS8c2hNE+YkRENFcAoGew6QgvvSdFnMpb9dj+kmO4YcDmag8ffIoUNb8pNEqj++7Xg/LF8UyIiw=;3:88G2OzaDk5nuZapYYeeJoMEubg7rVuvGcRyd6g0Yvfg8OGCYhLq/bhps44KiYXQZQcS5Tuq6NfzGmo+T2tMryKyAxplaoYHZpRH8BS3lJ29vN0rI6k9GGHn91L/HyQgTc5RIRF7VCKMli/6mFvmWaw==;25:HxPQI5njvD9bZV4jTF1CFWjL+YM5XIxyCXFRbQR34eaDNq+341mQuU9dkrCwa/SOqFE6YX3mFqRaC9GrA+RkQdCuaO5rJfRUeHzHLHFurSb9P7rrHu7n8YGuyg7dZ4gFNCBcKbunrJDZBv/uAaMB++5t1iJytJBJDJe/EQcAQX6e30glUECka/ZY90/WTSRCsrnOcngIp2lG+LDnXX4lZxWupWizPHd6cHK20NefGmkjDXfPrhHijHyn1istrz+LD5zC1pcjYK1nL6ZTrIc2QQ==;20:Ky0lf6V2Qm9w0rKH7+9lwhoqtr+5osYqsh1wWjoZwAfgOmZEo9tqPeqJteDdKWYHo47UUpH7XpwC8hWpU7aJyOHYHfon2+W4TvZT1wctIz1lkRlaaLq9AAVIyKWpnWf1mmdZ+kQV7scnO47W1HT6++gEhj8mM6MURPWhuF0sum8= X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BN3PR03MB1510;UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BY1PR03MB1499;UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BY1PR03MB1449; X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:;UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0;PCL:0;RULEID:(601004)(5005006)(3002001);SRVR:BN3PR03MB1510;BCL:0;PCL:0;RULEID:;SRVR:BN3PR03MB1510;BCL:0;PCL:0;RULEID:(601004)(5005006)(3002001);SRVR:BY1PR03MB1499;BCL:0;PCL:0;RULEID:;SRVR:BY1PR03MB1499; X-Microsoft-Exchange-Diagnostics-untrusted: 1;BN3PR03MB1510;4:Gf/6bigxp0VA6NslfxfWJdf+Jj8jk/QLeaeDVi9pDNECyRgoTzGdwf9rk4PGzEhXJgVzxhtnfEJwCYdx0P3a32m8Ydj+D9jFxnmveVULsosjxOhmcmBP7sfP5Cv/jucgi790m/RnW+dmMIuBoYT9vGWtMfY3+dvIzTab7PUUto8RdHXW5UiDH5Obz6JIP/FrV6TYdlDuLDJABKelaEFSLGT9s1EyJRwtWVNVmW76yUCxh6DY6L3rAgfe0yA6PYCsGw/h4hZfHiubeic68vP4G/tRMGOANYjrmxlCm42dXe4= X-Forefront-PRVS: 0667289FF8 X-Forefront-Antispam-Report-Untrusted: SFV:NSPM;SFS:(10009020)(6009001)(199003)(189002)(50986999)(86362001)(87976001)(48376002)(50466002)(77156002)(101416001)(2950100001)(76176999)(5003940100001)(122386002)(69596002)(53416004)(42186005)(62966003)(97736004)(40100003)(229853001)(189998001)(5001960100002)(81156007)(107886002)(50226001)(5001860100001)(86152002)(4001540100001)(64706001)(66066001)(2201001)(47776003)(5001920100001)(5001770100001)(46102003)(19580395003)(68736005)(33646002)(92566002)(77096005)(19580405001)(106356001)(105586002)(5001830100001)(7059030)(2101003)(4001430100001);DIR:OUT;SFP:1101;SCL:1;SRVR:BN3PR03MB1510;H:linuxheads99.altera.com;FPR:;SPF:None;PTR:InfoNoRecords;A:0;MX:1;LANG:en; X-Microsoft-Exchange-Diagnostics-untrusted: =?us-ascii?Q?1;BN3PR03MB1510;23:BmLXvuOnRqlcJtCGkP1K10u8c+Xif/n7Lwh6AkXUu?= =?us-ascii?Q?FAYV91UdSDV05l6Dnpmkv67ugRZm1ldt5r82PKN0rtct948gksub8wFzOgcj?= =?us-ascii?Q?kWWKnxIc7MfH4aWhzTYDO9840B5IxlDpHEvsNisOoEKAXhWdAaao1wie+QUp?= =?us-ascii?Q?t3rROkElvgPRNfpN5/BfP2noULJXmIRjRUjAiXoLCCIZRYnk4AeRz2AbMpP3?= =?us-ascii?Q?HSr+Dl7q94VAcixcL1wJDU4jMJPxD3ftBV90HSkyqlmlLrQj4YrSZN5XbARc?= =?us-ascii?Q?iqCt5kuGVK7ukQhemcYaQsAtujwSKeu1wQC2qTOnRI9XZUVcGqih8J+qL4Q/?= =?us-ascii?Q?D2nLqaSXoH0bn2Ah2EUAW/uoLqi/+CJZXsKGaGElU5HtlZjpYPyau2Bgggcs?= =?us-ascii?Q?kxPwuYszoLyF2siHIqydgQ3OBcegram7QgRaDI/pKs9cd5KXyUK17YzCLtXI?= =?us-ascii?Q?YxvdRtPBAN7aKCjqLpEnK1D6FkT8vH+t3lfFvXMnX2xCHepiY5xPYhRoXQED?= =?us-ascii?Q?1vCjZBwc70Xx04hkOswx9IrdVfVR5ae9+LPocz6FqzHLacZ/lZIvPI+6JDIS?= =?us-ascii?Q?j3XxOiB+0hzWdkezq6yN8ogmZQDiniktPiE/6pHFktCNek/FfRWpi64zupwA?= =?us-ascii?Q?t/Zak3nM/tTc6uI52bJ+E6JdgXj+hqWssh3902PlL4EmwpMGacsvLlY3qwiH?= =?us-ascii?Q?UiUER1KEBYEn+fj8Op7HF42hri2WfSKhuhvETaFgvKeD2KCf/PfbFRzmpKMn?= =?us-ascii?Q?BpmltplzmwhVfKvr74fY9GMh4Xybu0BhpP0nnlMTwM866XnFd7FaQ+LRQM38?= =?us-ascii?Q?HOj/XtSVNyCJCpXDMXproSJUM3C4YDpcnxqx61tYJLJpmgfGw5GIYEVOT9vP?= =?us-ascii?Q?bRJcxjD0cN8QQysS4g7X4aKeyvjfp82lOXN6FkaawfPEGDiroc9S/u27i5gW?= =?us-ascii?Q?kb0564t2pgdGRVJtCbex8CDO9y2wEBrtvlx8ITbrLClEZtbwIa0G3D5FIMG5?= =?us-ascii?Q?dRDvRIBjfCIP2xvR/Q58kbTZMir5T55JWCBQ6jhSYfv0EJLThAMiHHlWRHxf?= =?us-ascii?Q?zcX/gIcnXK0dJUv1IKAtExCv2WvVbGYqnARCAvEgj9jIYpVoBmfJkd5UdZyl?= =?us-ascii?Q?kkERhuw6eR/E1GdDJsPEoM2QmAJb5PxYHHJor4/9CiLbR6bIGXb80M77l97b?= =?us-ascii?Q?3JWpjRyUQNeMm/1RrjGQUtZ9qEh9ZseUMI8tz95K1SQyJfsXYTEMebYLep/H?= =?us-ascii?Q?WGc+KeuogYb0hrxdioCpf73zT35glR87is25Cbr?= X-Microsoft-Exchange-Diagnostics-untrusted: 1;BN3PR03MB1510;5:WxUcQ2sUTgFcplcD0M4EC0AxENrQ4ml4479IMS2Zi4vCXimTv52AqAutZvEj/ZhCXv6MoOjoIS7Zv1qlYDTUfIVtJbpKZNA/6knwEsRptLugskIycOthVVk2LS2jV7GOEswHxeSNmnahuvt7d5JZmg==;24:N/r+G20qoVHXZ/qvGCNDaRHollIf3roRzkA8jE2AR4gHaXrHOY9VFe1jtBU6FEMxuAH9UIwSDWSSQIPmDTb8fkf+4lXuQlGGOqktBqcDVs4=;20:TiyRCgHwrSBeu2Qz9oN/l4xNimyxgDhzWj89x9kuDA5UkWNIRcyZw8JTCX4aSwExlYM+oQ+uCIfAZAzBWeZ/E9NuIa7YaJBS/9hhSwwixMTOzyLiy5apEsZqW6rVI4dvd4PKDhmKOGWso/AiFIam3Kw0egkelAKQDgkBBBW9Yv4= SpamDiagnosticOutput: 1:23 SpamDiagnosticMetadata: NSPM SpamDiagnosticOutput: 1:23 SpamDiagnosticMetadata: NSPM X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR03MB1510 X-EOPAttributedMessage: 0 X-MS-Exchange-Transport-CrossTenantHeadersStripped: BN1AFFO11FD034.protection.gbl X-Microsoft-Exchange-Diagnostics: 1;BN1AFFO11FD034;1:Ok3d7MrFRyXvGCfaUOjCoGsS1N1UsFikm/NQaN0CXDLpC8MH9npmHHdtF07l1zjXo80UeSoRU23W/MsC4JvZV2eV3uno7G/+fqlvUlv/53N9HXDJ/YH8sXwSc2Ru+4Frn3KyqPpEdwZW4cHcgSYvoKYdR7Z257ldU/jyIgf7Eq2kakiicApiRKdtzS2KS4cWSZyH7Oam0HsPHeJfKq7iJ4X1CsmvFZMwBn8VRxvKzCmKkzYpejZ7znPsJBofT2u7TNUlkggf0u/+BgtEoVSiNNsQPvjrACD8fBeBa1L+Ru/OlgMYzEb/m8YX7hDs6aux3TJiyr/UkWKFPf3sbR5ya9HrZCmBfxhgHNr8ticmIeh/UeAgdHjOwcQ56AKAtTxcnukagrIWidR4B77GvnXZng== X-Forefront-Antispam-Report: CIP:66.35.236.227;CTRY:US;IPV:NLI;EFV:NLI;SFV:NSPM;SFS:(10009020)(6009001)(2980300002)(3050300001)(339900001)(189002)(199003)(87936001)(107886002)(86362001)(86152002)(5001860100001)(2201001)(48376002)(81156007)(5001830100001)(189998001)(46102003)(5001960100002)(92566002)(97736004)(6070500001)(47776003)(6806004)(64706001)(19580405001)(66066001)(19580395003)(5001770100001)(4001540100001)(33646002)(50226001)(53416004)(50466002)(16796002)(122386002)(85426001)(106466001)(50986999)(105606002)(77156002)(76176999)(229853001)(62966003)(21840400001)(2950100001)(5003940100001)(77096005)(68736005)(40100003)(7099028)(7059030)(2101003)(4001430100001);DIR:OUT;SFP:1101;SCL:1;SRVR:BY1PR03MB1499;H:sj-itexedge03.altera.priv.altera.com;FPR:;SPF:Fail;PTR:InfoDomainNonexistent;MX:1;A:0;LANG:en; X-Microsoft-Exchange-Diagnostics: 1;BY1PR03MB1499;2:HaqT9F6EpAlRRERrMVgjeh9w9My62aVHNtgCXBYIh+SLFXMDwAg2N5brus2hZ7LhF1u8ykHg5eLczaZoYYNs2hg1Ys9BOwUI1RdhMYtNuoSQN1gvw0GNjkR/Wa/32rjo/32IViTfvnF9mGbDEYxGuFLOfdLF0UD/ORct7Sj6n1c=;3:QJ734zuaaZ3tCpl5B7PGalw9FuWhMJ9HqECgecod+IuTKZ43E1UazTwuK+Ui6Es5IcshndorJ9/h9+veWeI/UjMr/ZD5phuHNN3Gp7xznlWAbG/8UmpbkKTgeh1RwI04wGZcJ+cUS85qpL/T5Ra1qQXFRS3tVdXSFVhCIonY0313b/1NBLHyLucPLhvJAY4I6jDW4dtG30RCjvsoEKeSorKbLMbi+inxuvHKEH3kcEU=;25:tFSXNhSByqmujfW4F01ncjIy/rz5tq1g6rOeDfvxrJEJGhKFkqHByBXHjT/TdIf47Q0qSVcZh79CBhqGx1a7sqfaCi7KPlGfeaxyrV8vbJcjdS8YovH6n+G2Vp7bhYLRcJNKip/5W8vKxMB4klazATtcd3HXvS2llpBOFwglNfulGhA0fUVgBbGFm5Q2oVxg3ACSJx3dq9YWKm5pA/ePyQUgb6+GdINpSQxFHIjtfCbDrjVyKM7XnZtRDOi+Ei9WAU5fCvdNwHgMCJQ7FaZEOg==;20:xoZHUF9oaKc07p3eeBiQLdpJ93AavxPR0iDxtxqql7NcaKkyDhwqy5m5Pwl+dQzm94vJJw8x66NVbuFKJRpRT1xG0UGbaVDAcNRI4debYyhei6klFdxMvv42NB/BR0x+t4J59JjdrBwPOuDZs3EdFzqPzc7n7JVAcBITYw1NEJ0= X-Microsoft-Exchange-Diagnostics: 1;BY1PR03MB1499;4:BUFB6vrOT0VGu+BDtGLXvcsN2F6ygLE3Kp55WEo7i6wa09HT/kfMMUcnXRYjRHcK/CvNEWylGuBZBES+rptCYC515zmD6/Jsrw/Bd1OjE8Sko7dF1f4qyKoeaJNW9o5B0gkLe61Vusvf3079G69QV6XXbawINfTzflV7U0gxb0WXs05bxECSHRdeulhGPu/nHO67QZyYH/ghQY0DfB4EOyHARumsSxcOH+byBANvnhJgLlfYZ6onVjf5pDyY/Tvnvv8O4f9yR1a3Wz5X/HxmCtz297YBZdx+S9dTd3ROTQA= X-Forefront-PRVS: 0667289FF8 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1;BY1PR03MB1499;23:FKGSTmXvamRl20avo88D2gS2GHktK73SCNWqWCJXJ?= =?us-ascii?Q?rAQcOmckJD8jzTyLcMFvrWloi+Fhp5hBHNjKqsWzi6xBgaD95jGlrSejqoD4?= =?us-ascii?Q?O6jnnkOi2O8aOVYPBQt+NKJpRxhocB0hwW+3dDR7BCBADOt6XRQ3qlc/SLc0?= =?us-ascii?Q?roV/h3rWQ/2VhxrRUmua08p2NV2eR9qlgV6TrDfc0U/HHfUiRSBa9zL9XxeX?= =?us-ascii?Q?l7BGrQvQ3G5ybnhRyGlhfQVsEZUumyBhsWb7eiST2X1gkV5A7DtjPDABLJWL?= =?us-ascii?Q?8CwJkhbIk+366Un5Mue2AhsfVnc6m1Wd+JT/3IqFLfn+MTMS0eDUYC3W7HM2?= =?us-ascii?Q?8kN8DmwR7j0ZYXEeX07UbwWulPkNjTTWoZ+Z5b3Mt48Bwbty+0jdUl5Pi3km?= =?us-ascii?Q?ui8jiL07WuEVl5cY0M4iYqaz3s5sQ7m3kwl+mnV7+ZmvicM3A4wHxBR65uuM?= =?us-ascii?Q?N6oc8bHhgRYUl/OMWDzf/7s73yILtRnSJ9vHiAmHkjtsFcUXjsn8/gEVtPvy?= =?us-ascii?Q?b2RopXA2ZiCvZwfCXJiuiqpkLbnEiCT1dWUM77G5kG7fNzsYHKRMkpQ6rkpH?= =?us-ascii?Q?EboNfz8YcbSCIcFcdfIwiqrBF7NssAlwrnlT7e1egvzi1WK8rtxCM2EbODiO?= =?us-ascii?Q?KkoAfm4cP86RquITaQqhC2wNhJCX/FdsDYzrj7WIDNXXehJbs6MdtYJWawIT?= =?us-ascii?Q?3LrfyYkHlM9YzRY3GfMGvs/AogINgc51Zf3OYZTwRfDilTYLhYjkjvjmk0Bs?= =?us-ascii?Q?cYpD6j6ra7Iyqd8q05rxDTiKwfdR8Ws1jmB/7bJvFXXW8UB5OpM56CCo/QpD?= =?us-ascii?Q?MCrTOFrySO+q27pRjgOk0/EfJObEHtAt3YX+oroIKGhKDFTxnlY2j7DzaNs/?= =?us-ascii?Q?/Dw0yeT41z+kg0mhjd3cEbNs9QMmnm7ySdi0+WK8288+m8RspC5T2V8UKUMV?= =?us-ascii?Q?bV3yV69HFyzrxM71SQxd7RMtVpmdiNx9eVUD7KtEHehj1OoZXHpTVcGLdvRE?= =?us-ascii?Q?qbG/bsg3g4LgO0MprpKLKQoeSaahvg62kab0/qq5L1ESzJJ1h4nobWvcNcAp?= =?us-ascii?Q?urU1Rt9tiEVVUOc00ZOc8djetnaZFQ6IynDv/RXxn5e7qZYHsTU1SpAytocW?= =?us-ascii?Q?6HaTvQ4gafbIPrXXdZN+bzeb2Z936UqLc7610EQSllF9b05/Jas/hvd/ULii?= =?us-ascii?Q?H2/aeYbvDFVoiSTHCp4nx+rjjDKVVgjQBYutY1Wg34fSI0+74KGnm3922X2K?= =?us-ascii?Q?7qIik5xdwQoQs3nY5bhVkZwi6I51u1MVuRFLFtUikfKcovQvspVcfoznaNrT?= =?us-ascii?Q?xj7glVy/HMbxd5fzdVc3b6aEfR8fpa9zG+oG3UWUSkRmeSBXGKqYyWPjml+i?= =?us-ascii?Q?665tlVisrtLsZq7+Q7p1ioq4jc=3D?= X-Microsoft-Exchange-Diagnostics: 1;BY1PR03MB1499;5:f8AN6vTBIUXqd2q/cbEkrfTVG/vEdcVWDt6CSJ0Jp+aWvczLGpoKuNEG1gBbgzjYH71YiwkrCqZFNUApuSF/H18vdAD1vZjhl0XE8jcTLl1tXkVrIojVVh3ImSHB7Zdoj49N3FuJBkN6tnNW3OMvmA==;24:TjTfPbcpjtPYm3NPH7PXmmsk2aD/WQbSKZJMihkgIYRty8Y8QXboeYscUPwuX3muaPdopa4SYPmUf8zDb0vOPs92na/Z8FsBUR6sq5brvlA=;20:3d37LMItGPWbGaSK7zrQPjA3eTrnueDTScX4gRbxdzoNTKEFlBxVKOSDK5XN+FeB3mP7sUUVC7fVSK4MaUORJz8CWKnyCCiAxeczuCHYS9k9bb7nlhMSS7p4qNZMNFTlN29SxVIf/YVxBqByZIanMgtsVhKqHkruWMFfaqtNDeg= X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Aug 2015 17:43:21.3906 (UTC) X-MS-Exchange-CrossTenant-Id: fbd72e03-d4a5-4110-adce-614d51f2077a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=fbd72e03-d4a5-4110-adce-614d51f2077a;Ip=[66.35.236.227];Helo=[sj-itexedge03.altera.priv.altera.com] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY1PR03MB1499 X-Microsoft-Exchange-Diagnostics: 1;BY1PR03MB1449;2:HWNKXAtgDdKgWLJAoXuPLaHoqT2lRHABASLONx2yVCDHdsWUTdYXxuWxB2hyGdTfe8XF752OVDn1NYfoA8EG/g9rymLv+cGZB3/Y7KQ8Jn2WnvNT+bvlBxDTP0QEea3+sLhHeAGhWOwNvMuQig1xQqRdOcgV3NUg0yWAHH4hPiY=;3:bUczpb/dG9OjT7YlfaIA/luGCijMiCsI5UTrqh4yyspbM0hIa0mEgR+P4kX5eTiHcNc3BrXHuKTMJMzQfmCLFB4vz5ZS6KcqWeybeV/KJg0AU0FEhfpT9yv8e4HNvToUJrkKMc4AoBPKTia0XLNqJTU/AU/bmi45mqD9HWRBCp91jquAZ81oN6mG0Nchg1j2AXTSXo8cSyaq+ugddSfnuqWB5VdUf1ZbkYLbf/+b+2s=;25:3APgfurQ6xGSjHQKyy0MzYiuxOGOryhkFoW/IoG2rOfJQcGrExvYIWPgUIEnxQ83lOXn1793aDUNJchTzfsdtkrjgk0nqZCWRBH+fPW3wot4W6ExkTNIFFoJxUsPsSO1qFNsxyzzlv0xkhemBD7Ne48rhhiLYZJaV3+wXRsAUwITYjr75Sci0oSMy98TU0MI2f8/TmNJ0aF1vOOn5uRzkHf4Y6MhNOxpPMXAL1QR9vNn7DAkco7Exzfazr4k2vwmPKud6iJkuaPZxUjtN934jg==;23:QRyJ5KmTeRo+zPflBt8oUMOfmVzNc33tZ941cRHEY3F29YoqMVGvwHz5kdIV1P6gQAvq/+RDd5+6jd2PMj0fr7v/cDGqAZMTMDgIXCMJ2H4zhlb8TNU6FybF0QYd4+1OGbGHgCIdSgLa9L7y9a39M9LXCu5oIPEiAYFtLgTOfSCNmcIZbcRW0Py/Ort9S/En6s6ieuA7ByLZzP5En+eifvvYnIJS5UAUL8mtM5+1gHseinmmQW++QRJ1Emgsa/O4 X-OriginatorOrg: opensource.altera.com Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 3388 Lines: 89 From: Alan Tull Add a document spelling out usage of the simple fpga bus. Signed-off-by: Alan Tull --- v9: Initial version of this patch in patchset v10: s/fpga/FPGA/g improve formatting some rewriting move to staging/simple-fpga-bus --- .../Documentation/simple-fpga-bus.txt | 58 ++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 drivers/staging/simple-fpga-bus/Documentation/simple-fpga-bus.txt diff --git a/drivers/staging/simple-fpga-bus/Documentation/simple-fpga-bus.txt b/drivers/staging/simple-fpga-bus/Documentation/simple-fpga-bus.txt new file mode 100644 index 0000000..c96d705 --- /dev/null +++ b/drivers/staging/simple-fpga-bus/Documentation/simple-fpga-bus.txt @@ -0,0 +1,58 @@ +Simple FPGA Bus + +Alan Tull 2015 + +Overview +======== + +The simple FPGA bus adds device tree overlay support for FPGA's. Loading a +DT overlay will result in the FPGA getting an image loaded, its bridges will +be released, and the DT populated for nodes below the simple-fpga-bus. This +results in drivers getting probed for the hardware that just got added. This +is intended to support the FPGA usage where the FPGA has hardware that +requires drivers. Removing the overlay will result in the drivers getting +removed and the bridges being disabled. + +The simple FPGA bus will need to disable and enable bridges that will only +affect the child devices that are below the bus. These are pointed to by +phandles to their resets. If partial reconfiguration is to be done, then +bridges will need to be added within the FPGA design to protect the rest of the +bus when one part of the FPGA design is being reconfigured. + + +Sequence +======== + +Load the DT overlay. One way to do that from user space is to use Pantelis' +DT-Overlay configfs interface. + +This causes the simple FPGA bus go be probed and will do the following: + 1. Disable the FPGA bridges. + 2. Call the FPGA manager core to program the FPGA. + 3. Release the FPGA bridges. + 4. Call of_platform_populate resulting in device drivers getting probed. + + +Requirements +============ + + 1. An FPGA image that has a hardware block or blocks that use drivers that are + supported in the kernel. + 2. A device tree overlay (example is in the simple-fpga-bus bindings document). + 3. A FPGA manager driver supporting writing the FPGA. + 4. FPGA bridge resets supported as reset controllers. + +The DT overlay includes bindings (documented in bindings/simple-fpga-bus.txt) +that specify: + * Which FPGA manager to use. + * Which image file to load. + * Flags indicating whether this this image is for full reconfiguration or + partial. + * A list of resets that control the FPGA bridges. + * Child nodes specifying the devices that will be added with appropriate + compatible strings, etc. + +Since this code uses the firmware interface to get the image and DT overlay, +they currently have to be files on the file system. It doesn't have to be that +way forever as DT bindings could be added to point to other sources for the +image. -- 1.7.9.5 -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/