API Reference Manual 1.51.0
Loading...
Searching...
No Matches
odp_ipsec_capability_t Struct Reference

IPSEC capability. More...

#include <ipsec_types.h>

Collaboration diagram for odp_ipsec_capability_t:
[legend]

Data Fields

uint32_t max_num_sa
 Maximum number of IPSEC SAs.
 
odp_support_t op_mode_sync
 Synchronous IPSEC operation mode (ODP_IPSEC_OP_MODE_SYNC) support.
 
odp_support_t op_mode_async
 Asynchronous IPSEC operation mode (ODP_IPSEC_OP_MODE_ASYNC) support.
 
odp_support_t op_mode_inline_in
 Inline inbound IPSEC operation mode (ODP_IPSEC_OP_MODE_INLINE) support.
 
odp_support_t op_mode_inline_out
 Inline outgoing IPSEC operation mode (ODP_IPSEC_OP_MODE_INLINE) support.
 
odp_support_t proto_ah
 IP Authenticated Header (ODP_IPSEC_AH) support.
 
odp_support_t frag_after
 Fragment after IPsec support.
 
odp_support_t frag_before
 Fragment before IPsec support.
 
odp_support_t pipeline_cls
 Support of pipelined classification (ODP_IPSEC_PIPELINE_CLS) of resulting inbound packets.
 
odp_support_t retain_header
 Support of retaining outer headers (retain_outer) in inbound inline processed packets.
 
odp_ipsec_out_op_capability_t out_op
 Outbound operation specific capabilities.
 
odp_proto_chksums_t chksums_in
 Inner packet checksum check offload support in inbound direction.
 
uint32_t max_cls_cos
 Maximum number of different destination CoSes in classification pipelining.
 
odp_bool_t queue_type_sched
 Scheduled queue support.
 
odp_bool_t queue_type_plain
 Plain queue support.
 
uint32_t max_queues
 Maximum number of different destination queues.
 
odp_pktin_vector_capability_t vector
 Support for returning completion packets as vectors.
 
uint32_t max_antireplay_ws
 Maximum anti-replay window size.
 
odp_crypto_cipher_algos_t ciphers
 Supported cipher algorithms.
 
odp_crypto_auth_algos_t auths
 Supported authentication algorithms.
 
odp_support_t inline_ipsec_tm
 Support of traffic manager (TM) after inline outbound IPSEC processing.
 
odp_ipsec_test_capability_t test
 IPSEC TEST capabilities.
 
odp_reass_capability_t reassembly
 Post-IPsec reassembly capability.
 
odp_bool_t reass_async
 Support of reassembly after inbound processing in odp_ipsec_in_enq()
 
odp_bool_t reass_inline
 Support of reassembly after inline inbound IPsec processing.
 

Detailed Description

IPSEC capability.

Examples
ipsec_api/odp_ipsec.c, odp_ipsec.c, odp_ipsecfwd.c, and odp_sysinfo.c.

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

Field Documentation

◆ max_num_sa

uint32_t odp_ipsec_capability_t::max_num_sa

Maximum number of IPSEC SAs.

Examples
odp_ipsecfwd.c, and odp_sysinfo.c.

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

◆ op_mode_sync

odp_support_t odp_ipsec_capability_t::op_mode_sync

Synchronous IPSEC operation mode (ODP_IPSEC_OP_MODE_SYNC) support.

Examples
odp_sysinfo.c.

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

◆ op_mode_async

odp_support_t odp_ipsec_capability_t::op_mode_async

Asynchronous IPSEC operation mode (ODP_IPSEC_OP_MODE_ASYNC) support.

Examples
odp_sysinfo.c.

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

◆ op_mode_inline_in

odp_support_t odp_ipsec_capability_t::op_mode_inline_in

Inline inbound IPSEC operation mode (ODP_IPSEC_OP_MODE_INLINE) support.

Examples
odp_sysinfo.c.

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

◆ op_mode_inline_out

odp_support_t odp_ipsec_capability_t::op_mode_inline_out

Inline outgoing IPSEC operation mode (ODP_IPSEC_OP_MODE_INLINE) support.

Examples
odp_sysinfo.c.

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

◆ proto_ah

odp_support_t odp_ipsec_capability_t::proto_ah

IP Authenticated Header (ODP_IPSEC_AH) support.

Examples
odp_ipsec.c, and odp_sysinfo.c.

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

◆ frag_after

odp_support_t odp_ipsec_capability_t::frag_after

Fragment after IPsec support.

Examples
odp_sysinfo.c.

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

◆ frag_before

odp_support_t odp_ipsec_capability_t::frag_before

Fragment before IPsec support.

Examples
odp_sysinfo.c.

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

◆ pipeline_cls

odp_support_t odp_ipsec_capability_t::pipeline_cls

Support of pipelined classification (ODP_IPSEC_PIPELINE_CLS) of resulting inbound packets.

Examples
odp_sysinfo.c.

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

◆ retain_header

odp_support_t odp_ipsec_capability_t::retain_header

Support of retaining outer headers (retain_outer) in inbound inline processed packets.

Examples
odp_sysinfo.c.

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

◆ out_op

odp_ipsec_out_op_capability_t odp_ipsec_capability_t::out_op

Outbound operation specific capabilities.

Examples
odp_sysinfo.c.

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

◆ chksums_in

odp_proto_chksums_t odp_ipsec_capability_t::chksums_in

Inner packet checksum check offload support in inbound direction.

Examples
odp_sysinfo.c.

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

◆ max_cls_cos

uint32_t odp_ipsec_capability_t::max_cls_cos

Maximum number of different destination CoSes in classification pipelining.

The same CoS may be used for many SAs. This is equal or less than 'max_cos' capability in classifier API.

Examples
odp_sysinfo.c.

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

◆ queue_type_sched

odp_bool_t odp_ipsec_capability_t::queue_type_sched

Scheduled queue support.

0: Scheduled queues are not supported either as IPsec SA destination queues or as IPsec default queue 1: Scheduled queues are supported as both IPsec SA destination queues and IPsec default queue

See also
odp_ipsec_sa_param_t
Examples
ipsec_api/odp_ipsec.c, odp_ipsec.c, and odp_sysinfo.c.

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

◆ queue_type_plain

odp_bool_t odp_ipsec_capability_t::queue_type_plain

Plain queue support.

0: Plain queues are not supported either as IPsec SA destination queues or as IPsec default queue 1: Plain queues are supported as both IPsec SA destination queues and IPsec default queue

See also
odp_ipsec_sa_param_t
Examples
ipsec_api/odp_ipsec.c, odp_ipsec.c, and odp_sysinfo.c.

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

◆ max_queues

uint32_t odp_ipsec_capability_t::max_queues

Maximum number of different destination queues.

The same queue may be used for many SAs.

Examples
odp_ipsecfwd.c, and odp_sysinfo.c.

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

◆ vector

odp_pktin_vector_capability_t odp_ipsec_capability_t::vector

Support for returning completion packets as vectors.

Examples
odp_ipsec.c, and odp_sysinfo.c.

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

◆ max_antireplay_ws

uint32_t odp_ipsec_capability_t::max_antireplay_ws

Maximum anti-replay window size.

Examples
odp_sysinfo.c.

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

◆ ciphers

odp_crypto_cipher_algos_t odp_ipsec_capability_t::ciphers

Supported cipher algorithms.

Examples
odp_ipsecfwd.c, and odp_sysinfo.c.

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

◆ auths

odp_crypto_auth_algos_t odp_ipsec_capability_t::auths

Supported authentication algorithms.

Examples
odp_ipsecfwd.c, and odp_sysinfo.c.

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

◆ inline_ipsec_tm

odp_support_t odp_ipsec_capability_t::inline_ipsec_tm

Support of traffic manager (TM) after inline outbound IPSEC processing.

On unsupported platforms, application is not allowed to use a TM enabled pktio (ODP_PKTOUT_MODE_TM) with outbound inline IPSEC.

See also
odp_pktio_open(), odp_pktio_param_t
Examples
odp_sysinfo.c.

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

◆ test

odp_ipsec_test_capability_t odp_ipsec_capability_t::test

IPSEC TEST capabilities.

See also
odp_ipsec_test_sa_update()
Examples
odp_sysinfo.c.

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

◆ reassembly

odp_reass_capability_t odp_ipsec_capability_t::reassembly

Post-IPsec reassembly capability.

Examples
odp_sysinfo.c.

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

◆ reass_async

odp_bool_t odp_ipsec_capability_t::reass_async

Support of reassembly after inbound processing in odp_ipsec_in_enq()

Examples
odp_sysinfo.c.

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

◆ reass_inline

odp_bool_t odp_ipsec_capability_t::reass_inline

Support of reassembly after inline inbound IPsec processing.

Examples
odp_sysinfo.c.

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


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