From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (xvm-189-124.dc0.ghst.net [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 11550A09FF; Wed, 6 Jan 2021 06:07:50 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9709E16089F; Wed, 6 Jan 2021 06:07:49 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by mails.dpdk.org (Postfix) with ESMTP id 4784C16089E for ; Wed, 6 Jan 2021 06:07:48 +0100 (CET) IronPort-SDR: 3ZfTNzkvXcE1Iks14mmO4B4tdeEOdEIgRQAc14uffBoOpGvGIN9806zMzwBOrO+n0uXARUsKc1 eAqjgEqCOtGg== X-IronPort-AV: E=McAfee;i="6000,8403,9855"; a="164300570" X-IronPort-AV: E=Sophos;i="5.78,479,1599548400"; d="scan'208";a="164300570" Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 05 Jan 2021 21:07:46 -0800 IronPort-SDR: 30KoV0Dy6yoXluvrjkPsknmdqcXE8vs5IdwCQ22UsFbfrd08x+dnww+ZNTr2sxBYY1RwDwjj9s HsiAqqa1teGA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.78,479,1599548400"; d="scan'208";a="567308997" Received: from fmsmsx605.amr.corp.intel.com ([10.18.126.85]) by fmsmga006.fm.intel.com with ESMTP; 05 Jan 2021 21:07:46 -0800 Received: from fmsmsx612.amr.corp.intel.com (10.18.126.92) by fmsmsx605.amr.corp.intel.com (10.18.126.85) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Tue, 5 Jan 2021 21:07:46 -0800 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx612.amr.corp.intel.com (10.18.126.92) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5 via Frontend Transport; Tue, 5 Jan 2021 21:07:46 -0800 Received: from NAM11-BN8-obe.outbound.protection.outlook.com (104.47.58.177) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.1713.5; Tue, 5 Jan 2021 21:07:46 -0800 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=P6W1bNylByS/pAEQPhE/dtfer9/NAVcF8u2LPiNXUVAtjcCu7UTKn9vbNysbxDPbWgYavQD4H0Dcyw5VVXgyeKIDOAorJW54KeDUbmT7DumitCNsr4Sp49jE0/lrTsy214DR+6d2lE08unYHFKJPfHrsNLMCyWlCytYAOvXY+2B3W7W6mMWvwJfamG4uBop7i67vGsFQ1bFfK5JqUftoC/+OZgJLwI7oYD6i4L2rVJfjslsfpEL/2M17Av+TBx7X+z4jI1AexnUkJTVxCCuhK3zh30aGNke0eQmKeskUuq0Nz2psYTUQqTK9SFm8IZg8vSbLb1dBCavidQnYoEAReQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=cf2JZIUPch+QQgs4nj9mi4rrzSi33xU43tacNV9QDH8=; b=OUXtrk9byBKr44sx+yeV8VdN0Xw2hZ2IzUVFmOXGc/WpUAY8a3o0+ubzhIkE0FBZ2697Bg953ZeZSeYlqrjkLjwZjR8ykSb5ItI013BM6TSuelviV0sLlbNkL7xf+Ec0j5p5FNSjypW2SL5siuhf+SOcP8Ivdu6eAi4rmYGh24yUKEVHpTtrV0OE2QQPsJ0Din7w4r6GYsmnfJaKHGuU7z1iTmCymo+aQm2Ie7kSci40BRDLw4c+s55xaGFrGV2H98HqTAzQy5XS7vwSqfeMYmUhqMjVifkdFxEr4u7zzeimFS+98mcZw97cICGO+nbw6NAJwptGaYOPi7Xgn7CT0g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=cf2JZIUPch+QQgs4nj9mi4rrzSi33xU43tacNV9QDH8=; b=btzNi6eyang0wEFIvLFMCiaoY/50ehPyKB8+2FKxhGapBBxQOzIk4mpLHBo2TOa2LVx7caWnlIMOIBC3ekQfET8LjxC7L42SwReLScfpNJzxm8kPUyJ1QSO5p3Cy/N0ejNJb/zrlqAyouCIOJie4xxudaVcxpVlps3dNeFF77UE= Received: from MN2PR11MB3807.namprd11.prod.outlook.com (2603:10b6:208:f0::24) by MN2PR11MB3790.namprd11.prod.outlook.com (2603:10b6:208:f6::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3721.21; Wed, 6 Jan 2021 05:07:44 +0000 Received: from MN2PR11MB3807.namprd11.prod.outlook.com ([fe80::4d7f:d51:79bc:e596]) by MN2PR11MB3807.namprd11.prod.outlook.com ([fe80::4d7f:d51:79bc:e596%4]) with mapi id 15.20.3721.024; Wed, 6 Jan 2021 05:07:44 +0000 From: "Xing, Beilei" To: "Xia, Chenbo" , "dev@dpdk.org" , "thomas@monjalon.net" , "david.marchand@redhat.com" CC: "stephen@networkplumber.org" , "Liang, Cunming" , "Lu, Xiuchun" , "Li, Miao" , "Wu, Jingjing" Thread-Topic: [dpdk-dev] [PATCH 9/9] doc: add vfio-user library guide Thread-Index: AQHW1RN6Q0ztk43TWUOV/NU+TaeA4qoaKOug Date: Wed, 6 Jan 2021 05:07:44 +0000 Message-ID: References: <20201218073851.93609-1-chenbo.xia@intel.com> <20201218073851.93609-10-chenbo.xia@intel.com> In-Reply-To: <20201218073851.93609-10-chenbo.xia@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=intel.com; x-originating-ip: [192.102.204.36] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: a09675d7-752a-4e75-20a6-08d8b20100a8 x-ms-traffictypediagnostic: MN2PR11MB3790: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:6108; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 7Ja+0/Gguyf6001kU3x4KhIm3D86BQkOrYSMgkFyJUO38ws0/FTqKYbjIgeHAwEE40S6vaJ/b9O8bP5LFyJe6OpJeRBxWo2hyQc/Bj8KFxQPoUkZmCqPKvbGJgNcAHMeBxWlYkikaCC157fC4hI1vWLiiiMHjFGjj/4yfjL58z96yhwMMTA8Q6ZiI3oZGIv5MEnyDClKpZPjJ9qmSpGDh3SaDJ4arw8prMLb74qWY1JrBpvu/bVlgd9MDypI8G0woqxOZoDR0Y9+zrnGM0OzU+WsavaKQJpiWVDzG94fy6ksv3cI1T/QR/oM6LfR7Sl9YZYhTcGmsUTzEaU3M4E+Vc53K4RDPFTNeGWWZqrJt4OnXflVnqCi2M0cNS3FRH+5LuigO+0zGrD0ze/zP5Zs+Q== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:MN2PR11MB3807.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(396003)(39860400002)(376002)(366004)(346002)(136003)(66446008)(2906002)(66946007)(52536014)(64756008)(186003)(76116006)(5660300002)(83380400001)(66556008)(8676002)(86362001)(66476007)(9686003)(316002)(55016002)(8936002)(26005)(33656002)(110136005)(6506007)(54906003)(478600001)(53546011)(4326008)(107886003)(71200400001)(7696005); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata: =?us-ascii?Q?QMYJSw4UqmCAXLfHV9js2JKlYahDJyAA2P6Skpcb3lwAMMAVea7dbwUzDsPn?= =?us-ascii?Q?hls8p+fKNJa0hrYHLVaROFRNhJGW4T5JqyMnxsoZpBg0pzPp3/nCkCzIsUN8?= =?us-ascii?Q?R0bsMAhb6AdfkpDsShAdO4jWDivaaIaWGxAWdj2qAyuSKB5H/+ZLa+zCfWLr?= =?us-ascii?Q?7EaV62KZev1RCfOlqzPyQ0H7DnYaE1LUANgrQPx5+C7Bn7udHw6f6j30o1XX?= =?us-ascii?Q?GlrwQKwjvMJwkvuWghVWougEn04cO1zARyd5I8I+qjJOvzCJ5mmgqqtgNZqk?= =?us-ascii?Q?UVgfqfQLx9ehM2YU45prPCPUT+BKs0GT0bP7c2/2fd3pfkkrpgD0taEFdHHL?= =?us-ascii?Q?ET6tbaa5STSmsp+vTrJg8YTo3TQNLoHu8DTSD9XXPGj7ZGaRTIj8cx0mo34Y?= =?us-ascii?Q?3lHebc2C/JBjMEVtDu4851WWZJKbEcNsCzktdrJzJA0+cbibBmS+L9AxCp1Q?= =?us-ascii?Q?/HyLgechPnwj0iLxpfOOVWsOTHrNFrg37MOBWOsyEGB+NzvTLb80rP45wyqy?= =?us-ascii?Q?7I8pjIqXAOB2P3mJa32iyMDzN6J67rS3HGYEkQI1golEC/sFzSP03EPUxWVw?= =?us-ascii?Q?zEbPaiZVKBIljJBNn9ETlkBn3A3czV6u3q9Tu1EdQnplquvCrgv3lTzSn3cw?= =?us-ascii?Q?skJCOEdnGdhTZQTdRuaFWqCfFYH0SfBeR2/y1YBwfYr/gx7CxwRDnpTDEUcr?= =?us-ascii?Q?H0p3bP9Z89gw/ECcKPv0UprzlqKQ26S3yHY8fqnEfi0tr1R0zXt+m1ieMPag?= =?us-ascii?Q?cYeDpaZGuZ3lpOLHp8k76YYUyWFDq16ctZfHAIgGVrtpP4+yURJRaQdCHNly?= =?us-ascii?Q?xe7vdxh3G8IUNpyppSDiyAPhI0RIRdkNzplBxmMRssqeen6lTU+GJu9rZKzL?= =?us-ascii?Q?Z9pri9B/BSgUqsejOyFjzrNS9H964VT+10514a/CziKQAP9FSKSj0BAMFBMJ?= =?us-ascii?Q?+rrmp9jAN0f4LyUlBgJ0eDcYyk30SRsO8kAt7bqs0ic=3D?= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: MN2PR11MB3807.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: a09675d7-752a-4e75-20a6-08d8b20100a8 X-MS-Exchange-CrossTenant-originalarrivaltime: 06 Jan 2021 05:07:44.7015 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: hLGx4T/5Y+KG6dFYvc8WH9lQz2rxbiUJ2dam7qRXZwVIBu5qaJJ8kiERZyJrW+CJsyfiSi1qchCM52xxcRj/Bw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR11MB3790 X-OriginatorOrg: intel.com Subject: Re: [dpdk-dev] [PATCH 9/9] doc: add vfio-user library guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: dev On Behalf Of Chenbo Xia > Sent: Friday, December 18, 2020 3:39 PM > To: dev@dpdk.org; thomas@monjalon.net; david.marchand@redhat.com > Cc: stephen@networkplumber.org; Liang, Cunming > ; Lu, Xiuchun ; Li, Miao > ; Wu, Jingjing > Subject: [dpdk-dev] [PATCH 9/9] doc: add vfio-user library guide >=20 > Add vfio-user library guide and update release notes. >=20 > Signed-off-by: Chenbo Xia > Signed-off-by: Xiuchun Lu > --- > doc/guides/prog_guide/index.rst | 1 + > doc/guides/prog_guide/vfio_user_lib.rst | 215 ++++++++++++++++++++++++ > doc/guides/rel_notes/release_21_02.rst | 11 ++ > 3 files changed, 227 insertions(+) > create mode 100644 doc/guides/prog_guide/vfio_user_lib.rst >=20 > diff --git a/doc/guides/prog_guide/index.rst > b/doc/guides/prog_guide/index.rst index 45c7dec88d..f9847b1058 100644 > --- a/doc/guides/prog_guide/index.rst > +++ b/doc/guides/prog_guide/index.rst > @@ -70,3 +70,4 @@ Programmer's Guide > lto > profile_app > glossary > + vfio_user_lib > diff --git a/doc/guides/prog_guide/vfio_user_lib.rst > b/doc/guides/prog_guide/vfio_user_lib.rst > new file mode 100644 > index 0000000000..6daec4d8e5 > --- /dev/null > +++ b/doc/guides/prog_guide/vfio_user_lib.rst > @@ -0,0 +1,215 @@ > +.. SPDX-License-Identifier: BSD-3-Clause > + Copyright(c) 2020 Intel Corporation. > + > + > +3. Configure the device > + > +This step includes three APIs in Vfio User. > + > +* ``rte_vfio_user_dma_map(dev_id, mem, fds, num)`` > + > + This function maps DMA memory regions for the emulated device. > + > + ``mem`` specifies the information of DMA memory regions. > + > + ``fds`` specifies the file descriptors of the DMA memory regions. > + > + ``num`` specifies the number of the DMA memory regions. > + > +* ``rte_vfio_user_dma_map(dev_id, mem, num)`` Should be rte_vfio_user_dma_unmap here. > + > + This function unmaps DMA memory regions for the emulated device. > + > +* ``rte_vfio_user_set_irqs(dev_id, set)`` > + > + This function configure the interrupts for the emulated device. > + > + ``set`` specifies the configuration of interrupts. > + > +After the above three steps are done, users can easily use the emulated > +device (e.g., do I/O operations). > \ No newline at end of file > -- > 2.17.1