Re: [PATCH v5 01/10] gna: add PCI driver module

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 2336 bytes --]

On Thu, Oct 20, 2022 at 07:53:25PM +0200, Maciej Kwapulinski wrote:
> +IOCTL
> +-----
> +Intel(R) GNA driver controls the device through IOCTL interfaces.
> +Following IOCTL commands - handled by DRM framework - are supported:
> +
> +GNA_GET_PARAMETER gets driver and device capabilities.
> +
> +GNA_GEM_NEW acquires new 4KB page aligned memory region ready for DMA operations.
> +
> +GNA_GEM_FREE frees memory region back to system.
> +
> +GNA_COMPUTE submits a request to the device queue.
> +            Memory regions acquired by GNA_GEM_NEW are part of request.
> +
> +GNA_WAIT blocks and waits on the submitted request.
> +

Use bullet lists for ioctl list above (with minor wording improv on
the whole section):

---- >8 ----

diff --git a/Documentation/gpu/gna.rst b/Documentation/gpu/gna.rst
index 7f3b7ce7e8f722..9a896664a3c29f 100644
--- a/Documentation/gpu/gna.rst
+++ b/Documentation/gpu/gna.rst
@@ -32,21 +32,22 @@ Multiple processes can independently file many requests to the driver. These req
 processed in a FIFO manner. The hardware can process one request at a time by using a FIFO
 queue.
 
-IOCTL
+ioctl
 -----
-Intel(R) GNA driver controls the device through IOCTL interfaces.
-Following IOCTL commands - handled by DRM framework - are supported:
+Intel(R) GNA driver controls the device through ioctl interfaces.
+The following commands (handled by DRM framework) are supported:
 
-GNA_GET_PARAMETER gets driver and device capabilities.
+  * GNA_GET_PARAMETER gets driver and device capabilities.
 
-GNA_GEM_NEW acquires new 4KB page aligned memory region ready for DMA operations.
+  * GNA_GEM_NEW allocates new 4KB page of aligned memory region ready for DMA
+    operations.
 
-GNA_GEM_FREE frees memory region back to system.
+  * GNA_GEM_FREE frees memory region back to system.
 
-GNA_COMPUTE submits a request to the device queue.
-            Memory regions acquired by GNA_GEM_NEW are part of request.
+  * GNA_COMPUTE submits a request to the device queue. Memory regions allocated
+    by GNA_GEM_NEW become part of the request payload.
 
-GNA_WAIT blocks and waits on the submitted request.
+  * GNA_WAIT blocks and waits on the submitted request.
 
 GNA MMU
 -------

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]