> -----Original Message-----
> From: Akhil Goyal [mailto:[email protected]]
> Sent: Tuesday, October 3, 2017 2:14 PM
> To: [email protected]
> Cc: Doherty, Declan <[email protected]>; De Lara Guarch, Pablo
> <[email protected]>; [email protected]; Nicolau,
> Radu <[email protected]>; [email protected];
> [email protected]; [email protected]; [email protected];
> [email protected]; Mcnamara, John
> <[email protected]>; [email protected]
> 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 <[email protected]>
> Signed-off-by: Boris Pismenny <[email protected]>
> Signed-off-by: Radu Nicolau <[email protected]>
> Signed-off-by: Declan Doherty <[email protected]>
...
> +}
> 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);
