From patchwork Mon Oct 3 02:10:24 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Adit Ranadive X-Patchwork-Id: 9359917 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 1004C60459 for ; Mon, 3 Oct 2016 02:11:12 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0308E28977 for ; Mon, 3 Oct 2016 02:11:12 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id EC009289AD; Mon, 3 Oct 2016 02:11:11 +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=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BA5CB28977 for ; Mon, 3 Oct 2016 02:11:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751934AbcJCCLJ (ORCPT ); Sun, 2 Oct 2016 22:11:09 -0400 Received: from ex13-edg-ou-002.vmware.com ([208.91.0.190]:46304 "EHLO EX13-EDG-OU-002.vmware.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751998AbcJCCLH (ORCPT ); Sun, 2 Oct 2016 22:11:07 -0400 Received: from sc9-mailhost3.vmware.com (10.113.161.73) by EX13-EDG-OU-002.vmware.com (10.113.208.156) with Microsoft SMTP Server id 15.0.1156.6; Sun, 2 Oct 2016 19:10:33 -0700 Received: from EX13-CAS-008.vmware.com (smtp-inbound.vmware.com [10.113.191.58]) by sc9-mailhost3.vmware.com (Postfix) with ESMTP id 3FB9F404FC; Sun, 2 Oct 2016 19:11:06 -0700 (PDT) Received: from EX13-MBX-032.vmware.com (10.113.191.72) by EX13-MBX-007.vmware.com (10.113.191.27) with Microsoft SMTP Server (TLS) id 15.0.1156.6; Sun, 2 Oct 2016 19:11:06 -0700 Received: from EX13-CAS-002.vmware.com (10.113.191.52) by EX13-MBX-032.vmware.com (10.113.191.72) with Microsoft SMTP Server (TLS) id 15.0.1156.6; Sun, 2 Oct 2016 19:11:05 -0700 Received: from NAM01-SN1-obe.outbound.protection.outlook.com (10.113.170.11) by EX13-CAS-002.vmware.com (10.113.191.52) with Microsoft SMTP Server (TLS) id 15.0.1156.6 via Frontend Transport; Sun, 2 Oct 2016 19:11:05 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=onevmw.onmicrosoft.com; s=selector1-vmware-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=5GRUaBObD7K2w7+gnNp3IcsBfrXkv7Y/e9J/8skC1PM=; b=NwpkrMb73IBw7LfryBZP+j71OUrBVXaCiedy+UboEfGoy8Qg/hzFlGw5DlBRb5fnktiuwaI3Sdlgwl0wiN8qo734PqEYO7K/ezPlzDmJRIblV8t5uDCI4Zr5Tojj5OWqb2gPT/hsdrQDaLQcdQ0oYlgDwLDJJP5vO+BhzQrfmUw= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=aditr@vmware.com; Received: from promb-2s-dhcp95-136.eng.vmware.com (208.91.1.34) by DM2PR0501MB841.namprd05.prod.outlook.com (10.242.115.147) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.649.6; Mon, 3 Oct 2016 02:10:57 +0000 From: Adit Ranadive To: , , CC: Adit Ranadive , , , , Subject: [PATCH v6 04/16] IB/pvrdma: Add the paravirtual RDMA device specification Date: Sun, 2 Oct 2016 19:10:24 -0700 Message-ID: <91c11ca3f020a5be2621f03c294a02044ccfce7c.1475458407.git.aditr@vmware.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: MIME-Version: 1.0 X-Originating-IP: [208.91.1.34] X-ClientProxiedBy: CY1PR1101CA0039.namprd11.prod.outlook.com (10.169.17.49) To DM2PR0501MB841.namprd05.prod.outlook.com (10.242.115.147) X-MS-Office365-Filtering-Correlation-Id: b4748c2d-4a86-4637-efeb-08d3eb32841d X-Microsoft-Exchange-Diagnostics: 1; DM2PR0501MB841; 2:cZfaMWjct/c+dnsTdymH2DHucEyb8tUsQq6uAtWOrcrx0PER3JKH0CnPIsNNut6rPFp9FdHAXS6cShHcf4s5kUtpxzVkJxF9Ca60fnx5kVnQkPWRJtPL8Q4RSBJjMe65+wsOmrIHVzZrnQmxRwHZOjNbN0JWn/N4xzBgslS3IgfgueoWVT6pa6YYNGhQQPD8Ij7HcBnOUWhotzqfHhpoAw==; 3:Ypjx+nsxaJJiNZPyTQMWdNFnztUXKyDZfAvAX3bUmZBsTCtlAIsDoe3ublXG7+bGU+W6MVnhFREYmedbMw6/22P8231jIoSJPBph9E1qxtqA4QuoJrbZWcRe/AqNVXPWIgO7JKaDmX+NooadxuIhEw==; 25:paO1mGu4+J2DYM224Z6au4HhMwKHd3JWekM0rt5QkL/AxQOA8mbBhSqAEJ0fvR/jP3sWeVs1udzKBWkwi7ROtC2faaq5zcEzlUQzIEH0orYPPt4EQlQ72QvtW46fkYuNGcO49K83m/CUBsetmWXTGRI0isOJOQkhJCOizkFg2R9zb+F4GQhkTBrgzo9hDXYNIP7oMZLyya+uhNhQzrNs2GUrAO9IIlMCy3khh7lG0BXXQ4psnma/duNwFd0BocDSK4xD+2A+imFaHDdpNw131MfFuWfT1iz/QxGUxHFmiIcey8j2rOHgJaGYpuMlhDlgQAvpS7qEFdCOFNFhOa7yhFMWhYC/HmLcoa+RSPtbIQ5IfLno/W3sRvUBZOoeHD5Q0Yd1btoxkU+65GRZmjRxDItISmYFLZJK8t7iae7Hrhl3GQsPjGfWOmEnYh1DhXxW X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:DM2PR0501MB841; X-LD-Processed: b39138ca-3cee-4b4a-a4d6-cd83d9dd62f0,ExtAddr X-Microsoft-Exchange-Diagnostics: 1; DM2PR0501MB841; 31:ylxWjXBIPElHGXN2RP7ZfZSyGY43q1cSlNfgv81ZaHQwmz0vi2w7AsVuM7myWS+6JGxKYAK1NTdSsqwceeWwfzoTqAz+IAAEpnneiFETVWNGctNTvjyeXpGexpHypofFkfd5DPFYbjV4RC9f2gB2u4qe9XPdCOFfUhV91blqfPuvFI2RiZ5n3bjFlCdbIbvkNcezUIeQhitoY1haWCErzNcuZBDCMJ4NUvE7MHlC8PTsvfOc8R3WZcgSWkDDsSGA; 20:o5T0pfC8LYDbk7ITA5PdrHZy4FGCaQRne2F0HaYymPTSahfJclK9/I16xjdetyfMjjCG+q26qWDRDYTAR2tdc3+Tb8rJV785R63T3fVpyK6iuIXYdkH7tpY9DB0hjlmVsFeRenPLyyAmtQctE+5OY/lHrFW+mb0UQlNnkiqFwXqqMwPBrlijtK8U1RBCJNYriR4U80zoOrzGhDUIXeM/H01AG9owWrExSH3x+PzIr8A+ya1YDc7ychJ6UHBCRVVTQJFPAe1Hwh2bg1jrsg1PzdLoLa8AtFDbjU9m6MLPHwT25jh8tCJUyltqSpQK/SJP5vhaB8vrlFgWTZTwR00Bo8M1NlFfSoP3XSv0Q9zssC1MsIp7wDzLpeZwEmwJJYud1CT+r9UPAVgeM/zxMO0ddvGGjtCEouL6aa5+Ov09ftEgvLMieidMUjymgMQl43carzC2HPT3UorNO4f6JnTy9CYGed8ZboePnZCdsdeJ6T7iSm4qMQwQBNASfci1dZxL X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(250305191791016)(61668805478150)(22074186197030)(146099531331640); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040176)(601004)(2401047)(5005006)(8121501046)(10201501046)(3002001); SRVR:DM2PR0501MB841; BCL:0; PCL:0; RULEID:; SRVR:DM2PR0501MB841; X-Microsoft-Exchange-Diagnostics: 1; DM2PR0501MB841; 4:B6ShJjtyfsZxvY5jnnl2xBKqrI/PTQmEIA6hF+/Z3CwOm91dDzGC9QTWBpQ5cdRBaJ3E2F7qz4ntORGXBmj0/q9FhDYK5yhDvVV+q7LVcx4JdyRmYNEJ3BeIntJYbXGCP43+vv48+eQUz8PCv0gr8ZRFzy8hfZlCbqbO8gFiQoz76n0W+rF9NvOuLYA+tLsU1UAiFSqloM8P25R09JmhpfKnyRZDu6otC0bIHQuLuxKZC9p31c/3kj3wD/JAxdk9O1XMYkbierPjca31p1fB/ESkMjOIBxfQ2GIZIkzBdMyOLeMRNZY5+is+IgQzrRODSNAbC2Zlr4M5xaARXRmXIbmfR+YS9tsbWaSMvV5jnuyr5YRyw8yZ5rlLy2c9w+ybDYUoqhGbbkIbldWzEeyfv0muaIejSijlOGxxf0sqahEonv1v6WlBWBJXEMYBCmXMKYWTGh01bUKXxqIGPgU9TMJBUuqtKi3maQUIxFTome/X1JVlhzyPE0paCnewcS1r312myeeqq+wdJaTGROGMTU4zvMfurWIg0chTtPlzc1k= X-Forefront-PRVS: 008421A8FF X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6009001)(7916002)(189002)(199003)(5890100001)(97736004)(189998001)(42186005)(19580405001)(47776003)(8676002)(5001770100001)(33646002)(2906002)(19580395003)(15975445007)(77096005)(6862003)(50986999)(76176999)(106356001)(2950100002)(101416001)(5003940100001)(4326007)(5660300001)(107886002)(105586002)(92566002)(7846002)(7736002)(586003)(118296001)(229853001)(68736007)(4001430100002)(305945005)(2201001)(48376002)(6636002)(50466002)(66066001)(86362001)(50226002)(575784001)(6116002)(3846002)(81156014)(6666003)(36756003)(81166006)(7099028)(21314002)(2004002); DIR:OUT; SFP:1101; SCL:1; SRVR:DM2PR0501MB841; H:promb-2s-dhcp95-136.eng.vmware.com; FPR:; SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en; Received-SPF: None (EX13-EDG-OU-002.vmware.com: aditr@vmware.com does not designate permitted sender hosts) Received-SPF: None (protection.outlook.com: vmware.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; DM2PR0501MB841; 23:XFdt7VdvBxq7RvEDm9VwZ8Nhm+gQNfyKwJ9OdRMm?= =?us-ascii?Q?Z3leq2wCkuPxaa0xXF3c61bTfeuW6VlxwrbYXO23IzKStrs2FThstto3o2pB?= =?us-ascii?Q?jLUE0C6iQh1Pf4wIJGWt7UclXq2BEPvwcfy6qyj6aguL3Gaxiv1tBhdXITyn?= =?us-ascii?Q?V9GxYkp3ZJHLDZwHzHMFJEwkwUplgjQjPQ47U3Lukg6p29efoZc6FTOspE95?= =?us-ascii?Q?eVbwojvPIsxht6J7MJpcCoGtTKz11rpWZ/hvQQBv7Ujzw1Wfxmk1IbsadEUi?= =?us-ascii?Q?0mgvP8X1bDpKioS3DHQVsGLN4FEVxNkLA9DfXrDD8ahd9uNLu3NoqqvidPBU?= =?us-ascii?Q?kirtcWEBu8SFjL0iVs2tm7ZAzNhDjNJd/6VLB0itBkeHmGlX//2fHU7QIfUa?= =?us-ascii?Q?g0y+d+bEpn98Eefqnfu5bDTuBdW6yx5/tByHQdeD7oY0qNtYz9bvj4hxlX2T?= =?us-ascii?Q?Om29lrW8MhcA2RJWlHoPr5u15zXb0fdPmLwHraps6uMYqVPulGjyoL3uxhaQ?= =?us-ascii?Q?haCLcUq2BVpVDdmg2emLALqeEdJBO25t5dHBocyZmuxVGnh3r8mEgyfljkRI?= =?us-ascii?Q?S8Y1GWIc3B2i7eYSvzZ70QhSY0pC4Xc5hKFwE0sA+f2wHpeaykRGxsEA1MBD?= =?us-ascii?Q?IMgyOtribj1tW7TBNoSqbZXRshST5XZzX2xix5QnQUeC1YLK49Z2x6f9fDlj?= =?us-ascii?Q?8o+eTpkN32bJwzyF5fpTSkmMXajpoAUoq1ixRyb2rP+XGNholUzdRhrfZ8q/?= =?us-ascii?Q?sErgyw8ofX4Zs4f1o0HThq8vIxNNtb6vNyn8DrKgzHx/T7PBlo6tQlI/SDQr?= =?us-ascii?Q?EEgpZTy4UeZaQ8Ms7tSdGoRvLA1SSso7JQDbFj0B4bfoBKQTmW+h/R2E/d6M?= =?us-ascii?Q?tFcmFMMvA4EddHRUSNmEzbkEwiLwrNtpBQD6qYuAUNs2iMCkNABOt6OTr+Z2?= =?us-ascii?Q?j2sT7rpNdrGkh19aEnMwZ7wBc5AYruUM3YP947lPlHGDNFxVVjrZ8Ur2GkdC?= =?us-ascii?Q?IK+/OlWQvr0PYY0TxTPpLDFwtuA5h/qY8O2oUVEP10aLgkfYfDhhmegUxy0m?= =?us-ascii?Q?yJcVGqAOiaMH/JEdNmmmAbvHp4bfA1n8Ul6n3vU+UGiBFJSzFNHEoqbax26w?= =?us-ascii?Q?uTHleyhP8W1sv3RX9/dVL514sMdvhmJKuJTHO5waz2uB0bQMSBDmkIO921i9?= =?us-ascii?Q?d8on2jMLTMFtGncI41bBQ14r9YjEwyMZMJIx+ifKo5EKAwnbtVR8Q9fD92rC?= =?us-ascii?Q?/lEbud3kkZm7Hz8WDZXf6c4FFwnUU9aQp8C9PegIx81gh7F3rPtbHeQAXf+B?= =?us-ascii?Q?2kPT9fdFJJl8uKE01kSCfWK5AyPJppqOL4qWE3zRYzhZ?= X-Microsoft-Exchange-Diagnostics: 1; DM2PR0501MB841; 6:q3ZmU6H/xgnFtM9+G5zbAHMsyxgUPY3HyZoEfvXZHNDHBRptXJTKDG9VcirbeZ4E/nUIgDNkoR2R1k9aWs6lkeJQlmmuSTqxqlnwXx1MgTSaysGTTvajOrdetJYYbQg8KFaa+zaMx2ENcJVOPZbwUWnqJjG0JG14aZq0KetjgBqyGkrl2tKiivvQ85eXE2aXOK8AbiohKVeFq6ff7sPFHG02gpE8gXYe1eX6OTZtuAI/GmUMir5okkOZOciOWCXvZno0VslNt0yeJ85xKSrSdnHAjwjTmx20I7QyE6JmVbpoTI14Mv9YqYXDEUlPoKgI; 5:XmpJW5E7BdN11E5bU/UGSfV+hJf1zitjXRNqU2x1rQ5aVCZ1bJ7PP/okRva7BJmyd+i6+xXgV3h621EHXe1BCtKvXYUVSulVjsIbjsdLY+oFtqRrf5+EaY1QaBVWQLmlGBHhM1wSen8rhH0jpmBsXy8H1506gjF6gpHjEz91yQQ=; 24:t4NcEX+FlPwxe2F/Nty0DqpS6lOt5f5oqePH/UG1Z9lS7tApp7s+5nhST4LT1QJJ1hghq4lbIKRg/2OJ7cEoEUk13ShYGhbyw83q1wl7T/Y=; 7:sOZlik3XFvmZVCRgRc43ScVVJMfiBjJodFgajgT66mHQVjfPnj0UYDVIW8YVWHbfk3LdUTnu6tFiMX3IzRtBdRNa82M4bvt2qnOQQgpjuDi05PNbRYTQIOdUIkuHD9c4s4d37Kg0KuxxVvkylEJMoFO3wNhPmDHIdtixHcYtJnTNt8OoL9yQUhbM95pavG4cL1MadhG5vlFvcGypehb8iQihKEYKr9axzr2/6nAQHxmOdPfd5g1zb8p7K76P2utgIXEwMw+iucU5HhW9zjgI7ycAdQc98SKujSpl/uGj4hwA4uy6QRsLajZBYsDrqXvq0zvFrMG rzO1BJ7QNJshqag== SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; DM2PR0501MB841; 20:TO1BRFZ2JFkXSpyw1mLZ6XoTZ3qRqZYoWkFoNYE6CXrM1MD4AvuZPKhjN2bQwAK2PIKRlhHSKTrvOUPRJjgaG3cgos22tmAIuCH+zRsUw/ehKe1jVZWo76zxyeZVdUhc82sZoEHkCmgz625560166sYLQ5tnVStjpvjEAtojpzE= X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Oct 2016 02:10:57.7671 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM2PR0501MB841 Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP This patch describes the main specification of the underlying virtual RDMA device. The pvrdma_dev_api header file defines the Verbs commands and their parameters that can be issued to the device backend. Reviewed-by: Yuval Shaia Reviewed-by: Jorgen Hansen Reviewed-by: George Zhang Reviewed-by: Aditya Sarwade Reviewed-by: Bryan Tan Signed-off-by: Adit Ranadive --- Changes v5->v6: - Removed the pvrdma_defs.h file. The contents of that are placed in the pvrdma_dev_api header file. - Removed include of pvrdma_ib_verbs.h. Changes v4->v5: - Update include for headers moved to UAPI. - Removed __ prefix for unsigned vars. Changes v3->v4: - Removed explicit enum values. Changes v2->v3: - Defined 9 and 18 for page directory. - Stripped spaces in some comments. --- drivers/infiniband/hw/pvrdma/pvrdma_dev_api.h | 586 ++++++++++++++++++++++++++ 1 file changed, 586 insertions(+) create mode 100644 drivers/infiniband/hw/pvrdma/pvrdma_dev_api.h diff --git a/drivers/infiniband/hw/pvrdma/pvrdma_dev_api.h b/drivers/infiniband/hw/pvrdma/pvrdma_dev_api.h new file mode 100644 index 0000000..c067686 --- /dev/null +++ b/drivers/infiniband/hw/pvrdma/pvrdma_dev_api.h @@ -0,0 +1,586 @@ +/* + * Copyright (c) 2012-2016 VMware, Inc. All rights reserved. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of EITHER the GNU General Public License + * version 2 as published by the Free Software Foundation or the BSD + * 2-Clause License. This program is distributed in the hope that it + * will be useful, but WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED + * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + * See the GNU General Public License version 2 for more details at + * http://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html. + * + * You should have received a copy of the GNU General Public License + * along with this program available in the file COPYING in the main + * directory of this source tree. + * + * The BSD 2-Clause License + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above + * copyright notice, this list of conditions and the following + * disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials + * provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __PVRDMA_DEV_API_H__ +#define __PVRDMA_DEV_API_H__ + +#include + +#include "pvrdma_verbs.h" + +#define PVRDMA_VERSION 17 +#define PVRDMA_BOARD_ID 1 +#define PVRDMA_REV_ID 1 + +/* + * Masks and accessors for page directory, which is a two-level lookup: + * page directory -> page table -> page. Only one directory for now, but we + * could expand that easily. 9 bits for tables, 9 bits for pages, gives one + * gigabyte for memory regions and so forth. + */ + +#define PVRDMA_PDIR_SHIFT 18 +#define PVRDMA_PTABLE_SHIFT 9 +#define PVRDMA_PAGE_DIR_DIR(x) (((x) >> PVRDMA_PDIR_SHIFT) & 0x1) +#define PVRDMA_PAGE_DIR_TABLE(x) (((x) >> PVRDMA_PTABLE_SHIFT) & 0x1ff) +#define PVRDMA_PAGE_DIR_PAGE(x) ((x) & 0x1ff) +#define PVRDMA_PAGE_DIR_MAX_PAGES (1 * 512 * 512) +#define PVRDMA_MAX_FAST_REG_PAGES 128 + +/* + * Max MSI-X vectors. + */ + +#define PVRDMA_MAX_INTERRUPTS 3 + +/* Register offsets within PCI resource on BAR1. */ +#define PVRDMA_REG_VERSION 0x00 /* R: Version of device. */ +#define PVRDMA_REG_DSRLOW 0x04 /* W: Device shared region low PA. */ +#define PVRDMA_REG_DSRHIGH 0x08 /* W: Device shared region high PA. */ +#define PVRDMA_REG_CTL 0x0c /* W: PVRDMA_DEVICE_CTL */ +#define PVRDMA_REG_REQUEST 0x10 /* W: Indicate device request. */ +#define PVRDMA_REG_ERR 0x14 /* R: Device error. */ +#define PVRDMA_REG_ICR 0x18 /* R: Interrupt cause. */ +#define PVRDMA_REG_IMR 0x1c /* R/W: Interrupt mask. */ +#define PVRDMA_REG_MACL 0x20 /* R/W: MAC address low. */ +#define PVRDMA_REG_MACH 0x24 /* R/W: MAC address high. */ + +/* Object flags. */ +#define PVRDMA_CQ_FLAG_ARMED_SOL BIT(0) /* Armed for solicited-only. */ +#define PVRDMA_CQ_FLAG_ARMED BIT(1) /* Armed. */ +#define PVRDMA_MR_FLAG_DMA BIT(0) /* DMA region. */ +#define PVRDMA_MR_FLAG_FRMR BIT(1) /* Fast reg memory region. */ + +/* + * Atomic operation capability (masked versions are extended atomic + * operations. + */ + +#define PVRDMA_ATOMIC_OP_COMP_SWAP BIT(0) /* Compare and swap. */ +#define PVRDMA_ATOMIC_OP_FETCH_ADD BIT(1) /* Fetch and add. */ +#define PVRDMA_ATOMIC_OP_MASK_COMP_SWAP BIT(2) /* Masked compare and swap. */ +#define PVRDMA_ATOMIC_OP_MASK_FETCH_ADD BIT(3) /* Masked fetch and add. */ + +/* + * Base Memory Management Extension flags to support Fast Reg Memory Regions + * and Fast Reg Work Requests. Each flag represents a verb operation and we + * must support all of them to qualify for the BMME device cap. + */ + +#define PVRDMA_BMME_FLAG_LOCAL_INV BIT(0) /* Local Invalidate. */ +#define PVRDMA_BMME_FLAG_REMOTE_INV BIT(1) /* Remote Invalidate. */ +#define PVRDMA_BMME_FLAG_FAST_REG_WR BIT(2) /* Fast Reg Work Request. */ + +/* + * GID types. The interpretation of the gid_types bit field in the device + * capabilities will depend on the device mode. For now, the device only + * supports RoCE as mode, so only the different GID types for RoCE are + * defined. + */ + +#define PVRDMA_GID_TYPE_FLAG_ROCE_V1 BIT(0) +#define PVRDMA_GID_TYPE_FLAG_ROCE_V2 BIT(1) + +enum pvrdma_pci_resource { + PVRDMA_PCI_RESOURCE_MSIX, /* BAR0: MSI-X, MMIO. */ + PVRDMA_PCI_RESOURCE_REG, /* BAR1: Registers, MMIO. */ + PVRDMA_PCI_RESOURCE_UAR, /* BAR2: UAR pages, MMIO, 64-bit. */ + PVRDMA_PCI_RESOURCE_LAST, /* Last. */ +}; + +enum pvrdma_device_ctl { + PVRDMA_DEVICE_CTL_ACTIVATE, /* Activate device. */ + PVRDMA_DEVICE_CTL_QUIESCE, /* Quiesce device. */ + PVRDMA_DEVICE_CTL_RESET, /* Reset device. */ +}; + +enum pvrdma_intr_vector { + PVRDMA_INTR_VECTOR_RESPONSE, /* Command response. */ + PVRDMA_INTR_VECTOR_ASYNC, /* Async events. */ + PVRDMA_INTR_VECTOR_CQ, /* CQ notification. */ + /* Additional CQ notification vectors. */ +}; + +enum pvrdma_intr_cause { + PVRDMA_INTR_CAUSE_RESPONSE = (1 << PVRDMA_INTR_VECTOR_RESPONSE), + PVRDMA_INTR_CAUSE_ASYNC = (1 << PVRDMA_INTR_VECTOR_ASYNC), + PVRDMA_INTR_CAUSE_CQ = (1 << PVRDMA_INTR_VECTOR_CQ), +}; + +enum pvrdma_intr_type { + PVRDMA_INTR_TYPE_INTX, /* Legacy. */ + PVRDMA_INTR_TYPE_MSI, /* MSI. */ + PVRDMA_INTR_TYPE_MSIX, /* MSI-X. */ +}; + +enum pvrdma_gos_bits { + PVRDMA_GOS_BITS_UNK, /* Unknown. */ + PVRDMA_GOS_BITS_32, /* 32-bit. */ + PVRDMA_GOS_BITS_64, /* 64-bit. */ +}; + +enum pvrdma_gos_type { + PVRDMA_GOS_TYPE_UNK, /* Unknown. */ + PVRDMA_GOS_TYPE_LINUX, /* Linux. */ +}; + +enum pvrdma_device_mode { + PVRDMA_DEVICE_MODE_ROCE, /* RoCE. */ + PVRDMA_DEVICE_MODE_IWARP, /* iWarp. */ + PVRDMA_DEVICE_MODE_IB, /* InfiniBand. */ +}; + +struct pvrdma_gos_info { + u32 gos_bits:2; /* W: PVRDMA_GOS_BITS_ */ + u32 gos_type:4; /* W: PVRDMA_GOS_TYPE_ */ + u32 gos_ver:16; /* W: Guest OS version. */ + u32 gos_misc:10; /* W: Other. */ + u32 pad; /* Pad to 8-byte alignment. */ +}; + +struct pvrdma_device_caps { + u64 fw_ver; /* R: Query device. */ + __be64 node_guid; + __be64 sys_image_guid; + u64 max_mr_size; + u64 page_size_cap; + u64 atomic_arg_sizes; /* EX verbs. */ + u32 ex_comp_mask; /* EX verbs. */ + u32 device_cap_flags2; /* EX verbs. */ + u32 max_fa_bit_boundary; /* EX verbs. */ + u32 log_max_atomic_inline_arg; /* EX verbs. */ + u32 vendor_id; + u32 vendor_part_id; + u32 hw_ver; + u32 max_qp; + u32 max_qp_wr; + u32 device_cap_flags; + u32 max_sge; + u32 max_sge_rd; + u32 max_cq; + u32 max_cqe; + u32 max_mr; + u32 max_pd; + u32 max_qp_rd_atom; + u32 max_ee_rd_atom; + u32 max_res_rd_atom; + u32 max_qp_init_rd_atom; + u32 max_ee_init_rd_atom; + u32 max_ee; + u32 max_rdd; + u32 max_mw; + u32 max_raw_ipv6_qp; + u32 max_raw_ethy_qp; + u32 max_mcast_grp; + u32 max_mcast_qp_attach; + u32 max_total_mcast_qp_attach; + u32 max_ah; + u32 max_fmr; + u32 max_map_per_fmr; + u32 max_srq; + u32 max_srq_wr; + u32 max_srq_sge; + u32 max_uar; + u32 gid_tbl_len; + u16 max_pkeys; + u8 local_ca_ack_delay; + u8 phys_port_cnt; + u8 mode; /* PVRDMA_DEVICE_MODE_ */ + u8 atomic_ops; /* PVRDMA_ATOMIC_OP_* bits */ + u8 bmme_flags; /* FRWR Mem Mgmt Extensions */ + u8 gid_types; /* PVRDMA_GID_TYPE_FLAG_ */ + u8 reserved[4]; +}; + +struct pvrdma_ring_page_info { + u32 num_pages; /* Num pages incl. header. */ + u32 reserved; /* Reserved. */ + u64 pdir_dma; /* Page directory PA. */ +}; + +#pragma pack(push, 1) + +struct pvrdma_device_shared_region { + u32 driver_version; /* W: Driver version. */ + u32 pad; /* Pad to 8-byte align. */ + struct pvrdma_gos_info gos_info; /* W: Guest OS information. */ + u64 cmd_slot_dma; /* W: Command slot address. */ + u64 resp_slot_dma; /* W: Response slot address. */ + struct pvrdma_ring_page_info async_ring_pages; + /* W: Async ring page info. */ + struct pvrdma_ring_page_info cq_ring_pages; + /* W: CQ ring page info. */ + u32 uar_pfn; /* W: UAR pageframe. */ + u32 pad2; /* Pad to 8-byte align. */ + struct pvrdma_device_caps caps; /* R: Device capabilities. */ +}; + +#pragma pack(pop) + +/* Event types. Currently a 1:1 mapping with enum ib_event. */ +enum pvrdma_eqe_type { + PVRDMA_EVENT_CQ_ERR, + PVRDMA_EVENT_QP_FATAL, + PVRDMA_EVENT_QP_REQ_ERR, + PVRDMA_EVENT_QP_ACCESS_ERR, + PVRDMA_EVENT_COMM_EST, + PVRDMA_EVENT_SQ_DRAINED, + PVRDMA_EVENT_PATH_MIG, + PVRDMA_EVENT_PATH_MIG_ERR, + PVRDMA_EVENT_DEVICE_FATAL, + PVRDMA_EVENT_PORT_ACTIVE, + PVRDMA_EVENT_PORT_ERR, + PVRDMA_EVENT_LID_CHANGE, + PVRDMA_EVENT_PKEY_CHANGE, + PVRDMA_EVENT_SM_CHANGE, + PVRDMA_EVENT_SRQ_ERR, + PVRDMA_EVENT_SRQ_LIMIT_REACHED, + PVRDMA_EVENT_QP_LAST_WQE_REACHED, + PVRDMA_EVENT_CLIENT_REREGISTER, + PVRDMA_EVENT_GID_CHANGE, +}; + +/* Event queue element. */ +struct pvrdma_eqe { + u32 type; /* Event type. */ + u32 info; /* Handle, other. */ +}; + +/* CQ notification queue element. */ +struct pvrdma_cqne { + u32 info; /* Handle */ +}; + +enum { + PVRDMA_CMD_FIRST, + PVRDMA_CMD_QUERY_PORT = PVRDMA_CMD_FIRST, + PVRDMA_CMD_QUERY_PKEY, + PVRDMA_CMD_CREATE_PD, + PVRDMA_CMD_DESTROY_PD, + PVRDMA_CMD_CREATE_MR, + PVRDMA_CMD_DESTROY_MR, + PVRDMA_CMD_CREATE_CQ, + PVRDMA_CMD_RESIZE_CQ, + PVRDMA_CMD_DESTROY_CQ, + PVRDMA_CMD_CREATE_QP, + PVRDMA_CMD_MODIFY_QP, + PVRDMA_CMD_QUERY_QP, + PVRDMA_CMD_DESTROY_QP, + PVRDMA_CMD_CREATE_UC, + PVRDMA_CMD_DESTROY_UC, + PVRDMA_CMD_CREATE_BIND, + PVRDMA_CMD_DESTROY_BIND, + PVRDMA_CMD_MAX, +}; + +enum { + PVRDMA_CMD_FIRST_RESP = (1 << 31), + PVRDMA_CMD_QUERY_PORT_RESP = PVRDMA_CMD_FIRST_RESP, + PVRDMA_CMD_QUERY_PKEY_RESP, + PVRDMA_CMD_CREATE_PD_RESP, + PVRDMA_CMD_DESTROY_PD_RESP_NOOP, + PVRDMA_CMD_CREATE_MR_RESP, + PVRDMA_CMD_DESTROY_MR_RESP_NOOP, + PVRDMA_CMD_CREATE_CQ_RESP, + PVRDMA_CMD_RESIZE_CQ_RESP, + PVRDMA_CMD_DESTROY_CQ_RESP_NOOP, + PVRDMA_CMD_CREATE_QP_RESP, + PVRDMA_CMD_MODIFY_QP_RESP, + PVRDMA_CMD_QUERY_QP_RESP, + PVRDMA_CMD_DESTROY_QP_RESP, + PVRDMA_CMD_CREATE_UC_RESP, + PVRDMA_CMD_DESTROY_UC_RESP_NOOP, + PVRDMA_CMD_CREATE_BIND_RESP_NOOP, + PVRDMA_CMD_DESTROY_BIND_RESP_NOOP, + PVRDMA_CMD_MAX_RESP, +}; + +struct pvrdma_cmd_hdr { + u64 response; /* Key for response lookup. */ + u32 cmd; /* PVRDMA_CMD_ */ + u32 reserved; /* Reserved. */ +}; + +struct pvrdma_cmd_resp_hdr { + u64 response; /* From cmd hdr. */ + u32 ack; /* PVRDMA_CMD_XXX_RESP */ + u8 err; /* Error. */ + u8 reserved[3]; /* Reserved. */ +}; + +struct pvrdma_cmd_query_port { + struct pvrdma_cmd_hdr hdr; + u8 port_num; + u8 reserved[7]; +}; + +struct pvrdma_cmd_query_port_resp { + struct pvrdma_cmd_resp_hdr hdr; + struct pvrdma_port_attr attrs; +}; + +struct pvrdma_cmd_query_pkey { + struct pvrdma_cmd_hdr hdr; + u8 port_num; + u8 index; + u8 reserved[6]; +}; + +struct pvrdma_cmd_query_pkey_resp { + struct pvrdma_cmd_resp_hdr hdr; + u16 pkey; + u8 reserved[6]; +}; + +struct pvrdma_cmd_create_uc { + struct pvrdma_cmd_hdr hdr; + u32 pfn; /* UAR page frame number */ + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_uc_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 ctx_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_destroy_uc { + struct pvrdma_cmd_hdr hdr; + u32 ctx_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_pd { + struct pvrdma_cmd_hdr hdr; + u32 ctx_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_pd_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 pd_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_destroy_pd { + struct pvrdma_cmd_hdr hdr; + u32 pd_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_mr { + struct pvrdma_cmd_hdr hdr; + u64 start; + u64 length; + u64 pdir_dma; + u32 pd_handle; + u32 access_flags; + u32 flags; + u32 nchunks; +}; + +struct pvrdma_cmd_create_mr_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 mr_handle; + u32 lkey; + u32 rkey; + u8 reserved[4]; +}; + +struct pvrdma_cmd_destroy_mr { + struct pvrdma_cmd_hdr hdr; + u32 mr_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_cq { + struct pvrdma_cmd_hdr hdr; + u64 pdir_dma; + u32 ctx_handle; + u32 cqe; + u32 nchunks; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_cq_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 cq_handle; + u32 cqe; +}; + +struct pvrdma_cmd_resize_cq { + struct pvrdma_cmd_hdr hdr; + u32 cq_handle; + u32 cqe; +}; + +struct pvrdma_cmd_resize_cq_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 cqe; + u8 reserved[4]; +}; + +struct pvrdma_cmd_destroy_cq { + struct pvrdma_cmd_hdr hdr; + u32 cq_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_qp { + struct pvrdma_cmd_hdr hdr; + u64 pdir_dma; + u32 pd_handle; + u32 send_cq_handle; + u32 recv_cq_handle; + u32 srq_handle; + u32 max_send_wr; + u32 max_recv_wr; + u32 max_send_sge; + u32 max_recv_sge; + u32 max_inline_data; + u32 lkey; + u32 access_flags; + u16 total_chunks; + u16 send_chunks; + u16 max_atomic_arg; + u8 sq_sig_all; + u8 qp_type; + u8 is_srq; + u8 reserved[3]; +}; + +struct pvrdma_cmd_create_qp_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 qpn; + u32 max_send_wr; + u32 max_recv_wr; + u32 max_send_sge; + u32 max_recv_sge; + u32 max_inline_data; +}; + +struct pvrdma_cmd_modify_qp { + struct pvrdma_cmd_hdr hdr; + u32 qp_handle; + u32 attr_mask; + struct pvrdma_qp_attr attrs; +}; + +struct pvrdma_cmd_query_qp { + struct pvrdma_cmd_hdr hdr; + u32 qp_handle; + u32 attr_mask; +}; + +struct pvrdma_cmd_query_qp_resp { + struct pvrdma_cmd_resp_hdr hdr; + struct pvrdma_qp_attr attrs; +}; + +struct pvrdma_cmd_destroy_qp { + struct pvrdma_cmd_hdr hdr; + u32 qp_handle; + u8 reserved[4]; +}; + +struct pvrdma_cmd_destroy_qp_resp { + struct pvrdma_cmd_resp_hdr hdr; + u32 events_reported; + u8 reserved[4]; +}; + +struct pvrdma_cmd_create_bind { + struct pvrdma_cmd_hdr hdr; + u32 mtu; + u32 vlan; + u32 index; + u8 new_gid[16]; + u8 gid_type; + u8 reserved[3]; +}; + +struct pvrdma_cmd_destroy_bind { + struct pvrdma_cmd_hdr hdr; + u32 index; + u8 dest_gid[16]; + u8 reserved[4]; +}; + +union pvrdma_cmd_req { + struct pvrdma_cmd_hdr hdr; + struct pvrdma_cmd_query_port query_port; + struct pvrdma_cmd_query_pkey query_pkey; + struct pvrdma_cmd_create_uc create_uc; + struct pvrdma_cmd_destroy_uc destroy_uc; + struct pvrdma_cmd_create_pd create_pd; + struct pvrdma_cmd_destroy_pd destroy_pd; + struct pvrdma_cmd_create_mr create_mr; + struct pvrdma_cmd_destroy_mr destroy_mr; + struct pvrdma_cmd_create_cq create_cq; + struct pvrdma_cmd_resize_cq resize_cq; + struct pvrdma_cmd_destroy_cq destroy_cq; + struct pvrdma_cmd_create_qp create_qp; + struct pvrdma_cmd_modify_qp modify_qp; + struct pvrdma_cmd_query_qp query_qp; + struct pvrdma_cmd_destroy_qp destroy_qp; + struct pvrdma_cmd_create_bind create_bind; + struct pvrdma_cmd_destroy_bind destroy_bind; +}; + +union pvrdma_cmd_resp { + struct pvrdma_cmd_resp_hdr hdr; + struct pvrdma_cmd_query_port_resp query_port_resp; + struct pvrdma_cmd_query_pkey_resp query_pkey_resp; + struct pvrdma_cmd_create_uc_resp create_uc_resp; + struct pvrdma_cmd_create_pd_resp create_pd_resp; + struct pvrdma_cmd_create_mr_resp create_mr_resp; + struct pvrdma_cmd_create_cq_resp create_cq_resp; + struct pvrdma_cmd_resize_cq_resp resize_cq_resp; + struct pvrdma_cmd_create_qp_resp create_qp_resp; + struct pvrdma_cmd_query_qp_resp query_qp_resp; + struct pvrdma_cmd_destroy_qp_resp destroy_qp_resp; +}; + +#endif /* __PVRDMA_DEV_API_H__ */