Re: [PATCH 7/7] vfio/sdmdev: add user sample

From: Randy Dunlap <rdunlap@infradead.org>
To: Kenneth Lee <nek.in.cn@gmail.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Herbert Xu <herbert@gondor.apana.org.au>,
	"David S . Miller" <davem@davemloft.net>,
	Joerg Roedel <joro@8bytes.org>,
	Alex Williamson <alex.williamson@redhat.com>,
	Kenneth Lee <liguozhu@hisilicon.com>,
	Hao Fang <fanghao11@huawei.com>,
	Zhou Wang <wangzhou1@hisilicon.com>,
	Zaibo Xu <xuzaibo@huawei.com>,
	Philippe Ombredanne <pombredanne@nexb.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Thomas Gleixner <tglx@linutronix.de>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-crypto@vger.kernel.org, iommu@lists.linux-foundation.org,
	kvm@vger.kernel.org, linux-accelerators@lists.ozlabs.org,
	Lu Baolu <baolu.lu@linux.intel.com>,
	Sanjay Kumar <sanjay.k.kumar@intel.com>
Cc: linuxarm@huawei.com
Subject: Re: [PATCH 7/7] vfio/sdmdev: add user sample
Date: Sun, 2 Sep 2018 19:25:12 -0700	[thread overview]
Message-ID: <ff75ff6a-2cd8-b25e-8d19-52e8f57141da@infradead.org> (raw)
In-Reply-To: <20180903005204.26041-8-nek.in.cn@gmail.com>

On 09/02/2018 05:52 PM, Kenneth Lee wrote:
> From: Kenneth Lee <liguozhu@hisilicon.com>
> 
> This is the sample code to demostrate how WrapDrive user application
> should be.
> 
> It contains:
> 
> 1. wd.[ch], the common library to provide WrapDrive interface.

                                            WarpDrive

> 2. drv/*, the user driver to access the hardware upon spimdev
> 3. test/*, the test application to use WrapDrive interface to access the

                                         WarpDrive

>    hardware queue(s) of the accelerator.
> 
> The Hisilicon HIP08 ZIP accelerator is used in this sample.
> 
> Signed-off-by: Zaibo Xu <xuzaibo@huawei.com>
> Signed-off-by: Kenneth Lee <liguozhu@hisilicon.com>
> Signed-off-by: Hao Fang <fanghao11@huawei.com>
> Signed-off-by: Zhou Wang <wangzhou1@hisilicon.com>
> ---
>  samples/warpdrive/AUTHORS              |   2 +
>  samples/warpdrive/ChangeLog            |   1 +
>  samples/warpdrive/Makefile.am          |   9 +
>  samples/warpdrive/NEWS                 |   1 +
>  samples/warpdrive/README               |  32 +++
>  samples/warpdrive/autogen.sh           |   3 +
>  samples/warpdrive/cleanup.sh           |  13 ++
>  samples/warpdrive/configure.ac         |  52 +++++
>  samples/warpdrive/drv/hisi_qm_udrv.c   | 223 ++++++++++++++++++
>  samples/warpdrive/drv/hisi_qm_udrv.h   |  53 +++++
>  samples/warpdrive/test/Makefile.am     |   7 +
>  samples/warpdrive/test/comp_hw.h       |  23 ++
>  samples/warpdrive/test/test_hisi_zip.c | 206 +++++++++++++++++
>  samples/warpdrive/wd.c                 | 309 +++++++++++++++++++++++++
>  samples/warpdrive/wd.h                 | 154 ++++++++++++
>  samples/warpdrive/wd_adapter.c         |  74 ++++++
>  samples/warpdrive/wd_adapter.h         |  43 ++++
>  17 files changed, 1205 insertions(+)
>  create mode 100644 samples/warpdrive/AUTHORS
>  create mode 100644 samples/warpdrive/ChangeLog
>  create mode 100644 samples/warpdrive/Makefile.am
>  create mode 100644 samples/warpdrive/NEWS
>  create mode 100644 samples/warpdrive/README
>  create mode 100755 samples/warpdrive/autogen.sh
>  create mode 100755 samples/warpdrive/cleanup.sh
>  create mode 100644 samples/warpdrive/configure.ac
>  create mode 100644 samples/warpdrive/drv/hisi_qm_udrv.c
>  create mode 100644 samples/warpdrive/drv/hisi_qm_udrv.h
>  create mode 100644 samples/warpdrive/test/Makefile.am
>  create mode 100644 samples/warpdrive/test/comp_hw.h
>  create mode 100644 samples/warpdrive/test/test_hisi_zip.c
>  create mode 100644 samples/warpdrive/wd.c
>  create mode 100644 samples/warpdrive/wd.h
>  create mode 100644 samples/warpdrive/wd_adapter.c
>  create mode 100644 samples/warpdrive/wd_adapter.h

> diff --git a/samples/warpdrive/README b/samples/warpdrive/README
> new file mode 100644
> index 000000000000..3adf66b112fc
> --- /dev/null
> +++ b/samples/warpdrive/README
> @@ -0,0 +1,32 @@
> +WD User Land Demonstration
> +==========================
> +
> +This directory contains some applications and libraries to demonstrate how a
> +
> +WrapDrive application can be constructed.

   WarpDrive

> +
> +
> +As a demo, we try to make it simple and clear for understanding. It is not
> +
> +supposed to be used in business scenario.
> +
> +
> +The directory contains the following elements:
> +
> +wd.[ch]
> +	A demonstration WrapDrive fundamental library which wraps the basic

	                WarpDrive

> +	operations to the WrapDrive-ed device.

                          WarpDrive

> +
> +wd_adapter.[ch]
> +	User driver adaptor for wd.[ch]
> +
> +wd_utils.[ch]
> +	Some utitlities function used by WD and its drivers
> +
> +drv/*
> +	User drivers. It helps to fulfill the semantic of wd.[ch] for
> +	particular hardware
> +
> +test/*
> +	Test applications to use the wrapdrive library

	                             warpdrive

-- 
~Randy