Re: [PATCH v2 11/11] doc: add new crypto session information

["Mcnamara, John" <john.mcnamara@intel.com>]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Friday, June 30, 2017 6:10 PM
> To: Doherty, Declan <declan.doherty@intel.com>;
> zbigniew.bodek@caviumnetworks.com; jerin.jacob@caviumnetworks.com;
> akhil.goyal@nxp.com; hemant.agrawal@nxp.com; Trahe, Fiona
> <fiona.trahe@intel.com>; Griffin, John <john.griffin@intel.com>; Jain,
> Deepak K <deepak.k.jain@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> Mrozowicz, SlawomirX <slawomirx.mrozowicz@intel.com>
> Subject: [dpdk-dev] [PATCH v2 11/11] doc: add new crypto session
> information
> 
> Modified cryptodev library section in Programmer's Guide, with the recent
> changes in the rypto sessions.


s/rypto/crypto/




> 
> Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

> ...

> +The Crypto device framework provides APIs to allocate and initizalize
> +sessions for crypto devices, where sessions are mempool objects.
> +It is the application responsability to create and manage the session
> mempools.

s/application/application's/
s/responsability/responsibility/

> +This approach allows for different scenarios such as having a single
> +session mempool for all crypto devices (where the the mempool object

s/the the/the/

> +size is big enough to hold the private session of any crypto device),
> +as well as having multiple session mempools of different sizes for better
> memory usage.
> +


> +An application could use ``rte_cryptodev_get_private_session_size()``
> +to get the private session size of given crypto device. This function

s/could/can/ is probably better.
s/given/a given/

> +would allow an application to calculate the max device session size of
> +all crypto devices to create a single session mempool.
> +If instead an application creates multiple session mempools, the Crypto
> +device framework also provides
> +``rte_cryptodev_get_header_session_size`` to get the size of an
> uninitialized session.
> +
> +Once the session mempools have been created,
> +``rte_cryptodev_sym_session_create()``
> +is used to allocate an uninitialized session from the given mempool.
> +The session then must be initialized ``rte_cryptodev_sym_session_init()``
> +for each of the crypto devices to be used with. A symmetric transform

Probably better as: 

    The session then must be initialized using ``rte_cryptodev_sym_session_init()``
    for each of the required crypto devices. A symmetric transform

> +chain is used to specify the operation and its parameters. See the
> +section below for details on transforms.
> +
> +Unused session should be free using ``rte_cryptodev_sym_session_free``
> +which returns them to their mempool.

s/free/freed/


Apart from these small changes which could be made inline:

Acked-by: John McNamara <john.mcnamara@intel.com>