Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752794AbbGQQNi (ORCPT ); Fri, 17 Jul 2015 12:13:38 -0400 Received: from mail-by2on0063.outbound.protection.outlook.com ([207.46.100.63]:43568 "EHLO na01-by2-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752266AbbGQQLh (ORCPT ); Fri, 17 Jul 2015 12:11:37 -0400 Authentication-Results: spf=fail (sender IP is 66.35.236.227) smtp.mailfrom=opensource.altera.com; vger.kernel.org; dkim=none (message not signed) header.d=none; Authentication-Results: linuxfoundation.org; dkim=none (message not signed) header.d=none; From: To: , , , , , CC: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , Petr Cvek , , , , Alan Tull Subject: [PATCH v9 4/7] staging: fpga manager: add sysfs interface document Date: Fri, 17 Jul 2015 10:51:14 -0500 Message-ID: <1437148277-5405-5-git-send-email-atull@opensource.altera.com> X-Mailer: git-send-email 1.7.9.5 In-Reply-To: <1437148277-5405-1-git-send-email-atull@opensource.altera.com> References: <1437148277-5405-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: DM2PR21CA0039.namprd21.prod.outlook.com (25.161.137.177) To CY1PR03MB1519.namprd03.prod.outlook.com (25.163.17.25) X-Microsoft-Exchange-Diagnostics-untrusted: 1;CY1PR03MB1519;2:VkEe8+IS39W9+4ZApjUIGPoV60NEny8uxeCT0tHSNtUnZW71VY4nAHtlRM3Kx1FU;3:vIMiDsnotn9TbgED6ryFzDcZnbGez1Cbc2wXwqiZPhC7/tMqNixOj2ZRLvAuM9zByomZJsb8l3Nr0NTflw4F5gXLlSa1A+gtwwFfu5Xhi/LEIJp4zy5jdABeqKdkoifpaPrFmVcUwAN8bM4wuOKlWg==;25:4EaYUvqVMBEjEi8wFfD3su2chzaxQgKA2RJ8oszKdCFt8Vjm9EQGI4C9uQ4T472CVk4N6OHLVce5ib+Eljq7eEAqBySl50bGqNEVSwnjXyfsIpNvsJg3WI5jjeWYmh3Nb94FTKI4QuoKoOCxpwg+7nYJa3VDH0j72fQOEzO6dlE5TYHzafvQkk+KM+gERyfemWtJP0Jjan7QdCbsMp8UVN415Si78A4XhmpREAVcYfUdjpk7WMGG+wdrDRlME2q5Pft0O34R2r0Xe9v0BDQWHQ==;20:H0tmvIaaSkFbnVSksqQ8IuFQrnSaoi8oe30OjtVKfdD3SwMcVmPzi7HmHzqOI1g6S/ykh3FqqWOgVcSVI6ZCmQtl48V1g5Fd9i44QPslimRrED5n+La63BwcFZt2tiu9zVxwKBEsAzeD/Vl1VrrrPPzHxJ2PsAtipe/BsruN3AA= X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:CY1PR03MB1519;UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BL2PR03MB115; CY1PR03MB1519: X-MS-Exchange-Organization-RulesExecuted 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:CY1PR03MB1519;BCL:0;PCL:0;RULEID:;SRVR:CY1PR03MB1519;BCL:0;PCL:0;RULEID:(601004)(5005006)(3002001);SRVR:BL2PR03MB115;BCL:0;PCL:0;RULEID:;SRVR:BL2PR03MB115; X-Microsoft-Exchange-Diagnostics-untrusted: 1;CY1PR03MB1519;4:PDZoAu6F/uj2oOT4PH6QAtpxu2U0/uWvjVDAlhnG5Dyf1WtKhrhppD5JXm5dbv6ew5U2/m7wFZRUSQquWzP028dpP5e4t7IGKgMFi+5IhRfUnlRsJV2Qxm1+gKf0VgotOYS5dp53Nk/KmdGIwtYqeTpPYnDLHh9W3+Bz1ofDHPaDsFThABK4KAAz+Y3iEjrHxOg9MQgXdtmu4pratSvpaGs3Yookp8eEE086DoH39PSiEiDfe36F3Qo8+CdEt8neV2zyKlPlbp8rCKkOAdhIKKBPmSv6ZOAk7j8ZcEgJlAg= X-Forefront-PRVS: 06400060E1 X-Forefront-Antispam-Report-Untrusted: SFV:NSPM;SFS:(10009020)(6009001)(50944005)(42186005)(19580405001)(19580395003)(229853001)(53416004)(46102003)(87976001)(122386002)(2201001)(86362001)(86152002)(33646002)(62966003)(50466002)(77156002)(92566002)(5001960100002)(2950100001)(48376002)(50226001)(107886002)(77096005)(5001770100001)(76176999)(47776003)(50986999)(5001920100001)(5003940100001)(189998001)(7059030)(4001430100001)(2101003);DIR:OUT;SFP:1101;SCL:1;SRVR:CY1PR03MB1519;H:linuxheads99.altera.com;FPR:;SPF:None;MLV:sfv;LANG:en; X-Microsoft-Exchange-Diagnostics-untrusted: 1;CY1PR03MB1519;23:JTfmqEWtiee5c1M3laFBrkkJkhPt3WGpgqmtTtJ3dfoYJsZ6C5PBr42uPzqLtdkkiCSne0m1LFtq/xNsPFSdvnCm2RepuoHXk5A4+KHtriKSOwNo4tcvcLzS58/Ry9AvT53tNTFNEebmlLRDl1PwOqbfKhxBRKII3po709yDJhi5XLKOPnH+hnTQe4+Bnhthv9CtjFngqth3yOorjEdhXPSWhf2v1I6Ej2/BLJ8K465PABOlPkP+ggJ28bpS5971035bTSzfCGoZS5XsxqDzWrh1t8unFcVlKTB3i0ZgCYGHTHTnicwCZQqjN/Q+7sHHjQddCQA3ywGLVDpByPBgONpJ6B4hMgrENRhs7p2+XMwX402FQ7LKSlLZkoyGNE9HtEl9F98pJmbFIIuudaZOl74qjh598NJ0JxSTWyDFrNcU4gY5b65gFckrAu+ykNqwNrSkaVS+a4IGVJqWejQO2va1HO2AIuZJQLVjz1EnFmnAXn+FB65vqn8i2MF3vhv7KvlI+RvlNjfgOHWqTmMFdkGI1Rx7IYvREuQ1BWLhRjITp7iUC+LfsYRK8Lbyg8u9+zwJqAo3Kw7bhDUbLZdWsAQ/Pcm8Z023AbzGihzldaLtE6CI1uwl/CJ5xZL1Y9gH2Pz+Gk3HENwQYajjHFCJ9CGzp2sG689oSyYQLR/U+JiF6ePvF6lqzwDylar6+AEMTTf0cBE78ui9BRFQdzLDR8iG97/bItgtpum4DaoNaOZVVaIqa9zsPvQUs4ZlwH0VXNM4nnf3CVzzOsbwXEMZKdLIMDfOhOyHSbkCmx1tGPI79DuNRRuJSowp8uhF03z19bwhdqIiP5bQDbIeKHVtRqBTlok6ELDv+EMGHOudh50YJLBL5FfvntndTw12gk3rJLe5ObSq9OrJ7RAtZoziRqdU56kShMsBFrVs4joxlLEZobTcA1ZY4/ppmdrQK2Q5 X-Microsoft-Exchange-Diagnostics-untrusted: 1;CY1PR03MB1519;5:/6FoUQmx1Lk5/txIxuI7+DzUCOuf/Pvk0kJFJt6PeMHTTJmq9jMlwOLtNOZIKxYjY/xMEGXJiEEMRTyU3WnB7hQCSnxZC4zNu39kgKm0q0AWxiDMoiBU5q8m8ru1u5/n2spTZEUaOu7jw0NNkqXGyw==;24:6euhUC9vkTdQktXsEo6trDylbdAFPYckX7xReU4NZpHoUC3sybIlVeJno7egdasdfuSXV+Ut16mtqYItpxVqsmTJVcri3JDoGYmZa3HwFNA=;20:+Xo77UB2YEvdZuUZd6yCh0UqDM53aO2ib90D5EHyyvGj9H0EXBB2tQn6Ri56aL4SHPQ0Or7/7dCsv8AWuhw9iXBPHzatpLbymr+5c8QUZ7dz/am7x3DRAcjqZm3eeGO6APFZVStQF4WsqhvlyW+st+iw8STsjE40JIXvnTARqMI= X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR03MB1519 X-EOPAttributedMessage: 0 X-MS-Exchange-Transport-CrossTenantHeadersStripped: BN1AFFO11FD011.protection.gbl X-Microsoft-Exchange-Diagnostics: 1;BN1AFFO11FD011;1:spdeqR9WfN2NvWcirQWIRgcbxS3UqOePpd0YL0DbnJqhTM53bshEGc9tQh3JTbrHNNaaFuSpBcVO8xWCwla0y1XEgZMi8M0un5kmpdBKDUpJku3q07qTtZZLaSRmuYXAGM3HfqBWwVEq5zj7R8LaBVIEQrZPl56pzrkcn1Jjr545M+lmZwUpOdmrYI1SnB3LO9jdgae50XZ61gy7c8/3k5jDIo6XoSQrHYiChKXEntap9i+sywj0RlF6Aoca5mW80u6ZQkJs919I1GTANUdzHvRxijYtsFXh3tNgTOxyzFxv8i4t5/EFLcHvocpYuNsSpct+b/p7SBUevwZ5VIaE31rpkJdS4cgm2GO/IItTSElIkgY42krHr8SszYSVJC8cZ+I/SdiECkQ8OobZFad581O0IyzN1WvAuxtfHoggtdDFYrF2oQZ+lndkWj7H2fng X-Forefront-Antispam-Report: CIP:66.35.236.227;CTRY:US;IPV:NLI;EFV:NLI;SFV:NSPM;SFS:(10009020)(6009001)(2980300002)(339900001)(199003)(50944005)(189002)(50986999)(105606002)(76176999)(19580405001)(6806004)(2201001)(77156002)(16796002)(48376002)(86152002)(86362001)(19580395003)(46102003)(2950100001)(122386002)(50466002)(5003940100001)(87936001)(92566002)(5001960100002)(77096005)(62966003)(50226001)(85426001)(106466001)(189998001)(5001770100001)(53416004)(107886002)(33646002)(229853001)(47776003)(7099028)(7059030)(2101003)(4001430100001);DIR:OUT;SFP:1101;SCL:1;SRVR:BL2PR03MB115;H:sj-itexedge03.altera.priv.altera.com;FPR:;SPF:Fail;MLV:sfv;A:0;MX:1;LANG:en; X-Microsoft-Exchange-Diagnostics: 1;BL2PR03MB115;2:a+ZI+5s8zWgHXvHXiYbtp0eTQaMN4sSbdOKuus1ga3wTiXIgKTk+vFehrsDQBlB0;3:AGB+gz6ejmhw9JqLT9ae35M1jrlCoqK7Imq40JCArfSz51IJfvLbNaQ4JuaEV7PDTMa6w+z7TIrTeejAOPpydrcvKDidcxzydmJ/9Dk6qEZPpmlOvx60FRTJ3+DZbPgihwn5YZPty5zgcQMRSaucdC4AUBwFFbIqruNnbd6sthRhuC5/t1UFDgfWFMx69z0mxCvbKWY7mpHvt2z3bOLM7waxWRTcLTuwrVBq98eJTcM=;25:yuONzKF4LM43AO69X2wEhmF0eQ4zkrcMoZy8NFN5AX2C25HHbb9Kml5rwqM6rCR5MEytUGRa6fVZYPVGYV2SuY2ddqtVMbXX5o0/9ILUxe2VAdsj1GpBhzKTuz79+mOKZH4DVj+hJQD/dbc4Ya+XzMymJxwqCXhmRlpCq4g0l/ZDcQXUYCDyG8905Gt5gdsGVe9aa2ClQYYTvVMb+IP9t7vxVDSswRVT+8USuy2F2Jhy2EAnofodGcMkFsJw5pfYCerxZk8QLFekARo1MvFMcg==;20:3pb4hDNoo81nc7JPFvIMmriIStNizdh9t7aWRl06U3hwmEyQ33pKDDA2IrEwvB7B+lgVHfR9/uaWfD+gN6VA1tjLZ/iKQH5KfdCycHp1lbZSThGmiU1s1sP1el+Sj+fhDELGIASRT61GYsjBVMau0dfuyuRFMZeh/KRrEkghEBA= BL2PR03MB115: X-MS-Exchange-Organization-RulesExecuted X-Microsoft-Exchange-Diagnostics: 1;BL2PR03MB115;4:ZWNaZKAB9qJ1QYHFLp5PjLtIZJQq1d25wzhvX1hd3Z1jSaqPrpoKp3qtRF7uubj6vsJPfIVMZ0juIA3a3g4ajcHNacmRAEM7fVqpkErTpiKjEMdwR/jjq5EkJzPvFs+31JY2y8Z00K5WWFVGP6mLRghi5cbDEsynyB2BYDRO/0/wQyiSjC7MxI8jfo8GqZe3mBW58/7q5lK5/t6E8dfAZRoprV/vct2MhF6mgovuwNgYMRCKhrUzlJTKdhtD8jsJ8y+qxNJqN7AoOpikqvE3qEglkGmBaWm0CUtkVSnKi9I= X-Forefront-PRVS: 06400060E1 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1;BL2PR03MB115;23:AWdcVTiDY929OtkLH3zCZjea0lFzsMER7GGGmY67LI?= =?us-ascii?Q?MfdJMeNGZMTyPsX+Cz8Ef8RNCdv5bpKK6WdOmU/IS4uFHcLPVzrg//yYKyPi?= =?us-ascii?Q?IsWIsqFLBr9ZYy7fhfN6/xhTExX7QGbuXsAUkaTNFeCWegvTr8E9ZlS8rkWU?= =?us-ascii?Q?ZQyXTyDwxPYiVevZJ5Z9trLfOurLt5TIwI0RcBrQNbdKOFUYbfkm5fRY7C3G?= =?us-ascii?Q?GLeqo7T0cjzNRT8N5SRN/7my2hzU+bEqOQNJpKQSLty9geaiOww49Dk2G/zu?= =?us-ascii?Q?uROMw1U6CLHm6J1D3ue/uksPeXRRrTvyuS7lVYhWWbpwJRkfaWDalnXoBSWB?= =?us-ascii?Q?mKNI/X2Yx/8sT2AIWGcnlJ2zdVhybq343LEbMueRsKNoSfFUqLl0j5yorY+8?= =?us-ascii?Q?7md90Hd5PWKTcTagGjYO0UZ1NDECrSniyDybrV+8PMnVYu4WXyPNpnhkd6pB?= =?us-ascii?Q?rxIIYOrligJo6B9dIf2LwfWrTyuz6+lvG06V1fhwLosViaWuWspfLoFCsMh6?= =?us-ascii?Q?Wy5SmgalxzF2sqPCcz6W/2MJi1qZjRrrEWmJnY00qlUQJeBShmur0H/3IQ57?= =?us-ascii?Q?jB6m32HaJW/dDUwLGW2PPShstrexRENEBDcAUkit0XlcXj8YHtSOUPHCIxn9?= =?us-ascii?Q?qcpjKsgXLkdqHjJRylqKSlZqahkpp1wTsfPoY2YHJaqvVPMKbWJ9j/IHH4Th?= =?us-ascii?Q?10NiGG8wSYmAj1Mls85usQxQWTLT/mHZ4A50ZYnToUY+l/8mtprzHfxX9mdS?= =?us-ascii?Q?29xcbuz6oyQbL1gEo7yJVXV5aSIDfzUDM5AFCDN6rzldQr5O3RuMS6BNGL5k?= =?us-ascii?Q?/MkNmB7D8e9hrKJGwSgQLwYxCNHc9GmaJPJKFyhbs029ah/9EBEO50xDja+a?= =?us-ascii?Q?kiGKdRDs7HFl7tB3Agqz+VjJzNIypxmUI/uzT6AmOt3CxzneRKt8Ssp5vPlw?= =?us-ascii?Q?gfO7kDavn7V4SUi5489EWCPRFncabwa3WInKVE0Ni7kgl0B80V8IjB4qAzgM?= =?us-ascii?Q?wNBb8ZNTUE0kVeBXikRY8DCFlg8vzxYv0JoGkXQeWgBKrFit8+/pOROHeM8K?= =?us-ascii?Q?WSkuHS6S+EYht1c1MRWCVJxnSy3rRX0jd7O3zLFOnJL5QtcA=3D=3D?= X-Microsoft-Exchange-Diagnostics: 1;BL2PR03MB115;5:WXklz22iUtyzp4sskPmNCm3gyJ4rBECgj9tjQ/X0JEA0kfj84M0jQ+7erI5YuScUy3wvFrkztawixv3RqbWNfNKrLVqBXdvKfsw9BE3khmH6ye4j+hve+0S19rA1qS9LZn8wwdwJIBXUJ18ycXMtdg==;24:co8sbkk00QRZMkjsM5Um5aCqk9xgF8qAU5ITWVO5J8J+oTU7CrBId2XR2AoTWmwIGM4tN5Q6nE8+mILmw1s7OB88M3NUDEMSy8cPx4oG79I=;20:uKiDJlDZi0LS14ubIFDZ+RSF6YI0pdoUNFnBHIS7ycFNQCSlsqFigDAuyIZJtM/a3Pt1Ef8oEWnjgBrfkmGiaqX41UFz7wcGprOh39SNxgekfZDzi5QGCoPGDvH6+alRE3O/K58gCEsQuDAU8kyjj+6u241CMcVDaL6TMcLK9UU= X-OriginatorOrg: opensource.altera.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Jul 2015 15:56:27.6203 (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: BL2PR03MB115 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2416 Lines: 64 From: Alan Tull Add documentation under drivers/staging for new fpga manager's sysfs interface. Signed-off-by: Alan Tull --- v5 : (actually second version, but keeping version numbers aligned with rest of patch series) Move document to drivers/staging/fpga/Documentation/ABI v6 : No change in this patch for v6 of the patch set v7 : No change in this patch for v7 of the patch set v8 : No change in this patch for v8 of the patch set v9 : Remove 'firmware' and 'reset' files Update state strings --- .../Documentation/ABI/sysfs-class-fpga-manager | 26 ++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager diff --git a/drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager b/drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager new file mode 100644 index 0000000..470905e --- /dev/null +++ b/drivers/staging/fpga/Documentation/ABI/sysfs-class-fpga-manager @@ -0,0 +1,26 @@ +What: /sys/class/fpga_manager//name +Date: July 2015 +KernelVersion: 4.2 +Contact: Alan Tull +Description: Name of low level fpga manager driver. + +What: /sys/class/fpga_manager//state +Date: July 2015 +KernelVersion: 4.2 +Contact: Alan Tull +Description: Read fpga manager state as a string. + Valid states may vary by manufacturer; superset is: + * unknown = can't determine state + * power off = FPGA power is off + * power up = FPGA reports power is up + * reset = FPGA held in reset state + * firmware request = firmware class request in progress + * firmware request error = firmware request failed + * write init = FPGA being prepared for programming + * write init error = Error while preparing FPGA for + programming + * write = FPGA ready to receive image data + * write error = Error while programming + * write complete = Doing post programming steps + * write complete error = Error while doing post programming + * operating = FPGA is programmed and operating -- 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/