Received-SPF: pass (google.com: best guess record for domain of linux-crypto-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
From:   "Hook, Gary" <Gary.Hook@amd.com>
To:     "herbert@gondor.apana.org.au" <herbert@gondor.apana.org.au>,
        "corbet@lwn.net" <corbet@lwn.net>,
        "linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-crypto@vger.kernel.org" <linux-crypto@vger.kernel.org>,
        "davem@davemloft.net" <davem@davemloft.net>
Subject: [PATCH 3/3] crypto: doc - Fix formatting of new crypto engine content
Thread-Topic: [PATCH 3/3] crypto: doc - Fix formatting of new crypto engine
 content
Thread-Index: AQHVKsAhzQYljFA8HEerpaXh3eY2Gw==
Date:   Mon, 24 Jun 2019 19:07:56 +0000
Message-ID: <156140327467.29777.2980404770916038687.stgit@taos>
References: <156140322426.29777.8610751479936722967.stgit@taos>
In-Reply-To: <156140322426.29777.8610751479936722967.stgit@taos>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-messagesentrepresentingtype: 1
x-originating-ip: [165.204.78.1]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 1988cb91-604f-4a2b-e06a-08d6f8d743c5
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: BCL:0;PCL:0;RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600148)(711020)(4605104)(1401327)(4618075)(2017052603328)(7193020);SRVR:DM5PR12MB2471;
x-ms-traffictypediagnostic: DM5PR12MB2471:
x-microsoft-antispam-prvs: <DM5PR12MB2471971437819A4EDCC76E96FDE00@DM5PR12MB2471.namprd12.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:1443;
x-forefront-prvs: 007814487B
x-forefront-antispam-report: SFV:NSPM;SFS:(10009020)(7916004)(396003)(39860400002)(346002)(366004)(376002)(136003)(199004)(189003)(316002)(64756008)(66066001)(66446008)(186003)(5660300002)(68736007)(486006)(72206003)(6436002)(6512007)(14454004)(9686003)(476003)(86362001)(6486002)(99286004)(33716001)(446003)(14444005)(76176011)(3846002)(52116002)(6116002)(11346002)(2201001)(66556008)(25786009)(81156014)(8676002)(81166006)(110136005)(305945005)(7736002)(2501003)(103116003)(8936002)(478600001)(26005)(73956011)(66946007)(102836004)(2906002)(256004)(386003)(6506007)(71190400001)(71200400001)(66476007)(53936002);DIR:OUT;SFP:1101;SCL:1;SRVR:DM5PR12MB2471;H:DM5PR12MB1449.namprd12.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;A:1;MX:1;
received-spf: None (protection.outlook.com: amd.com does not designate
 permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam-message-info: tXNrZB35d6KEaWS1ztbz2FZlxn4FXHd3tE/avKo9C0w5iRCcoVxtZUXn8DHSCpiqfc26bMMKafclbzpic3FpuarxzGhuEba7EZeHYHzqCnMTUhdUKSTH7Wqdyqu8suvoGNuHKeFLIc73ZzfSJS1jUSllv4xj0Gu2RSy3lgia6uBe/gMsmZ6C0F/Ko50y9RBMzGLMHmSiGghVdK4uSfKeyhtolJkdsLpIctf5ijWm0oZ9mDNpUHMGS+C9t5LnTOMLLKLM0QRSrhcflsTYa7YPBfDoyInu5oTI6w9X7Oko/FX+/WCCwBi4tRyP0oLC+8vBjzwpUUnTgvPG93LTbbWXmYcN2mtIDOfl6zeH0nOEdI8eB26l3Ps80TW6WNfpOUuGr0WXiEp9cqW2N/LIwChbah1rcaFJuxNhMAKnPrmONsY=
Content-Type: text/plain; charset="us-ascii"
Content-ID: <3ADDB3C18D515143ADB1482D2612DA1E@namprd12.prod.outlook.com>
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1988cb91-604f-4a2b-e06a-08d6f8d743c5
X-MS-Exchange-CrossTenant-originalarrivaltime: 24 Jun 2019 19:07:56.0874
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: ghook@amd.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR12MB2471
Sender: linux-crypto-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-crypto.vger.kernel.org>
X-Mailing-List: linux-crypto@vger.kernel.org

Tidy up the formatting/grammar in crypto_engine.rst. Use lists where
appropriate.

Signed-off-by: Gary R Hook <gary.hook@amd.com>
---
 Documentation/crypto/crypto_engine.rst |  120 ++++++++++++++++++++++------=
----
 1 file changed, 82 insertions(+), 38 deletions(-)

diff --git a/Documentation/crypto/crypto_engine.rst b/Documentation/crypto/=
crypto_engine.rst
index 1d56221dfe35..18e3a9afa444 100644
--- a/Documentation/crypto/crypto_engine.rst
+++ b/Documentation/crypto/crypto_engine.rst
@@ -1,50 +1,94 @@
-=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
-CRYPTO ENGINE
+.. SPDX-License-Identifier: GPL-2.0
+
+Crypto Engine
 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
=20
 Overview
 --------
-The crypto engine API (CE), is a crypto queue manager.
+
+The crypto engine (CE) API is a crypto queue manager.
=20
 Requirement
 -----------
-You have to put at start of your tfm_ctx the struct crypto_engine_ctx::
=20
-  struct your_tfm_ctx {
-        struct crypto_engine_ctx enginectx;
-        ...
-  };
+You must put, at the start of your transform context your_tfm_ctx, the str=
ucture
+crypto_engine:
+
+::
=20
-Why: Since CE manage only crypto_async_request, it cannot know the underly=
ing
-request_type and so have access only on the TFM.
-So using container_of for accessing __ctx is impossible.
-Furthermore, the crypto engine cannot know the "struct your_tfm_ctx",
-so it must assume that crypto_engine_ctx is at start of it.
+
+	struct your_tfm_ctx {
+		struct crypto_engine engine;
+		...
+	};
+
+
+The crypto engine only manages asynchronous requests in the form of
+crypto_async_request. It cannot know the underlying request type and thus =
only
+has access to the transform structure. It is not possible to access the co=
ntext
+using container_of. In addition, the engine knows nothing about your
+structure "``struct your_tfm_ctx``". The engine assumes (requires) the pla=
cement
+of the known member ``struct crypto_engine`` at the beginning.
=20
 Order of operations
 -------------------
-You have to obtain a struct crypto_engine via crypto_engine_alloc_init().
-And start it via crypto_engine_start().
-
-Before transferring any request, you have to fill the enginectx.
-- prepare_request: (taking a function pointer) If you need to do some proc=
essing before doing the request
-- unprepare_request: (taking a function pointer) Undoing what's done in pr=
epare_request
-- do_one_request: (taking a function pointer) Do encryption for current re=
quest
-
-Note: that those three functions get the crypto_async_request associated w=
ith the received request.
-So your need to get the original request via container_of(areq, struct you=
rrequesttype_request, base);
-
-When your driver receive a crypto_request, you have to transfer it to
-the cryptoengine via one of:
-- crypto_transfer_ablkcipher_request_to_engine()
-- crypto_transfer_aead_request_to_engine()
-- crypto_transfer_akcipher_request_to_engine()
-- crypto_transfer_hash_request_to_engine()
-- crypto_transfer_skcipher_request_to_engine()
-
-At the end of the request process, a call to one of the following function=
 is needed:
-- crypto_finalize_ablkcipher_request
-- crypto_finalize_aead_request
-- crypto_finalize_akcipher_request
-- crypto_finalize_hash_request
-- crypto_finalize_skcipher_request
+
+You are required to obtain a struct crypto_engine via ``crypto_engine_allo=
c_init()``.
+Start it via ``crypto_engine_start()``. When finished with your work, shut=
 down the
+engine using ``crypto_engine_stop()`` and destroy the engine with
+``crypto_engine_exit()``.
+
+Before transferring any request, you have to fill the context enginectx by
+providing functions for the following:
+
+* ``prepare_crypt_hardware``: Called once before any prepare functions are
+  called.
+
+* ``unprepare_crypt_hardware``: Called once after all unprepare functions =
have
+  been called.
+
+* ``prepare_cipher_request``/``prepare_hash_request``: Called before each
+  corresponding request is performed. If some processing or other preparat=
ory
+  work is required, do it here.
+
+* ``unprepare_cipher_request``/``unprepare_hash_request``: Called after ea=
ch
+  request is handled. Clean up / undo what was done in the prepare functio=
n.
+
+* ``cipher_one_request``/``hash_one_request``: Handle the current request =
by
+  performing the operation.
+
+Note that these functions access the crypto_async_request structure
+associated with the received request. You are able to retrieve the origina=
l
+request by using:
+
+::
+
+
+	container_of(areq, struct yourrequesttype_request, base);
+
+
+
+When your driver receives a crypto_request, you must to transfer it to
+the crypto engine via one of:
+
+* ``crypto_transfer_ablkcipher_request_to_engine()``
+
+* ``crypto_transfer_aead_request_to_engine()``
+
+* ``crypto_transfer_akcipher_request_to_engine()``
+
+* ``crypto_transfer_hash_request_to_engine()``
+
+* ``crypto_transfer_skcipher_request_to_engine()``
+
+At the end of the request process, a call to one of the following function=
s is needed:
+
+* ``crypto_finalize_ablkcipher_request()``
+
+* ``crypto_finalize_aead_request()``
+
+* ``crypto_finalize_akcipher_request()``
+
+* ``crypto_finalize_hash_request()``
+
+* ``crypto_finalize_skcipher_request()``