[dpdk-dev] [PATCH v2 01/12] lib/rte_security: add security library

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal at nxp.com]
> Sent: Tuesday, October 3, 2017 2:14 PM
> To: dev at dpdk.org
> Cc: Doherty, Declan <declan.doherty at intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch at intel.com>; hemant.agrawal at nxp.com; Nicolau,
> Radu <radu.nicolau at intel.com>; borisp at mellanox.com;
> aviadye at mellanox.com; thomas at monjalon.net; sandeep.malik at nxp.com;
> jerin.jacob at caviumnetworks.com; Mcnamara, John
> <john.mcnamara at intel.com>; olivier.matz at 6wind.com
> Subject: [PATCH v2 01/12] lib/rte_security: add security library
> 
> rte_security library provides APIs for security session create/free for
> protocol offload or offloaded crypto operation to ethernet device.
> 
> Signed-off-by: Akhil Goyal <akhil.goyal at nxp.com>
> Signed-off-by: Boris Pismenny <borisp at mellanox.com>
> Signed-off-by: Radu Nicolau <radu.nicolau at intel.com>
> Signed-off-by: Declan Doherty <declan.doherty at intel.com>

...

> +}
> diff --git a/lib/librte_security/rte_security.h
> b/lib/librte_security/rte_security.h

...

When building the docs with "make-guides-html",
It is complaining about an item in this list:

lib/librte_security/rte_security.h:139: warning: Invalid list item found


> +/**
> + * IPsec Security Association option flags  */ struct
> +rte_security_ipsec_sa_options {
> +	/**< Extended Sequence Numbers (ESN)
> +	  *
> +	  * * 1: Use extended (64 bit) sequence numbers
> +	  * * 0: Use normal sequence numbers
> +	  */
> +	uint32_t esn : 1;
> +
> +	/**< UDP encapsulation
> +	  *
> +	  * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets
> can
> +	  *      traverse through NAT boxes.
> +	  * * 0: No UDP encapsulation
> +	  */
> +	uint32_t udp_encap : 1;

...

> +/**
> + *  Updates the buffer with device-specific defined metadata
> + *
> + * @param	id	security instance identifier id
> + * @param	sess	security session
> + * @param	m	packet mbuf to set metadata on.

Parameter is called "mb".

> + * @param	params	device-specific defined parameters required for
> metadata
> + *
> + * @return
> + *  - On success, zero.
> + *  - On failure, a negative value.
> + */
> +int
> +rte_security_set_pkt_metadata(uint16_t id,
> +			      struct rte_security_session *sess,
> +			      struct rte_mbuf *mb, void *params);