API Reference Manual  1.45.0
odp_ipsec_out_inline_param_t Struct Reference

Outbound inline IPSEC operation parameters. More...

#include <ipsec_types.h>

Collaboration diagram for odp_ipsec_out_inline_param_t:
[legend]

Data Fields

odp_pktio_t pktio
 Packet output interface for inline outbound operation without TM. More...
 
odp_tm_queue_t tm_queue
 TM queue for inline outbound operation. More...
 
struct {
   const uint8_t *   ptr
 Points to first byte of outer headers to be copied in front of the outgoing IPSEC packet. More...
 
   uint32_t   len
 Outer header length in bytes.
 
outer_hdr
 Outer headers for inline output operation. More...
 

Detailed Description

Outbound inline IPSEC operation parameters.

Examples
ipsec_api/odp_ipsec.c.

Definition at line 1338 of file api/spec/ipsec_types.h.

Field Documentation

◆ pktio

odp_pktio_t odp_ipsec_out_inline_param_t::pktio

Packet output interface for inline outbound operation without TM.

Outbound inline IPSEC operation uses this packet IO interface to output the packet after a successful IPSEC transformation. The pktio must have been configured to operate in inline IPSEC mode.

The pktio must not have been configured with ODP_PKTOUT_MODE_TM. For IPSEC inline output to TM enabled interfaces set this field to ODP_PKTIO_INVALID and specify the TM queue to be used through the tm_queue parameter. Inline IPSEC output through TM can be done only if the platform has inline_ipsec_tm capability.

Examples
ipsec_api/odp_ipsec.c.

Definition at line 1351 of file api/spec/ipsec_types.h.

◆ tm_queue

odp_tm_queue_t odp_ipsec_out_inline_param_t::tm_queue

TM queue for inline outbound operation.

TM queue to be used for inline IPSEC output when pktio field is ODP_PKTIO_INVALID, indicating use of TM. Otherwise ignored.

See also
odp_ipsec_capability()

Definition at line 1360 of file api/spec/ipsec_types.h.

◆ ptr

const uint8_t* odp_ipsec_out_inline_param_t::ptr

Points to first byte of outer headers to be copied in front of the outgoing IPSEC packet.

Implementation copies the headers during odp_ipsec_out_inline() call.

Null value indicates that the outer headers are in the packet data, starting at L2 offset and ending at the byte before L3 offset. In this case, value of 'len' field must be greater than zero and set to L3 offset minus L2 offset.

Examples
ipsec_api/odp_ipsec.c.

Definition at line 1377 of file api/spec/ipsec_types.h.

◆ 

struct { ... } odp_ipsec_out_inline_param_t::outer_hdr

Outer headers for inline output operation.

Outbound inline IPSEC operation uses this information to prepend outer headers to the IPSEC packet before sending it out.

Examples
ipsec_api/odp_ipsec.c.

The documentation for this struct was generated from the following file: