numam-dpdk/drivers/net/atlantic/rte_pmd_atlantic.h
Ferruh Yigit 61ede39537 drivers/net: fix exposing internal headers
Using '__rte_internal' tag in 'rte_ethdev_driver.h' causing build error
for applications and examples. Because they don't define
'ALLOW_INTERNAL_API' flag and '__rte_internal' causes the error.
This patch is preparation for future '__rte_internal' usage.

At first place, applications/examples should not include
'rte_ethdev_driver.h', this is happening because of PMD public header
files include 'rte_ethdev_driver.h' by mistake.

Updated PMD public header files to not include internal header files.

But for unit test application, 'app/test', enable accessing internal
APIs, since some unit tests need them.

Fixes: ffc905f3b8 ("ethdev: separate driver APIs")
Fixes: ec0dec44ec ("net/atlantic: enable MACsec configuration")
Cc: stable@dpdk.org

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2020-07-11 06:18:54 +02:00

145 lines
3.7 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2018 Aquantia Corporation
*/
/**
* @file rte_pmd_atlantic.h
* atlantic PMD specific functions.
*
**/
#ifndef _PMD_ATLANTIC_H_
#define _PMD_ATLANTIC_H_
#include <rte_compat.h>
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Enable MACsec offload.
*
* @param port
* The port identifier of the Ethernet device.
* @param encr
* 1 - Enable encryption (encrypt and add integrity signature).
* 0 - Disable encryption (only add integrity signature).
* @param repl_prot
* 1 - Enable replay protection.
* 0 - Disable replay protection.
* @return
* - (0) if successful.
* - (-ENODEV) if *port* invalid.
* - (-ENOTSUP) if hardware doesn't support this feature.
*/
__rte_experimental
int rte_pmd_atl_macsec_enable(uint16_t port, uint8_t encr, uint8_t repl_prot);
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Disable MACsec offload.
*
* @param port
* The port identifier of the Ethernet device.
* @return
* - (0) if successful.
* - (-ENODEV) if *port* invalid.
* - (-ENOTSUP) if hardware doesn't support this feature.
*/
__rte_experimental
int rte_pmd_atl_macsec_disable(uint16_t port);
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Configure Tx SC (Secure Connection).
*
* @param port
* The port identifier of the Ethernet device.
* @param mac
* The MAC address on the local side.
* @return
* - (0) if successful.
* - (-ENODEV) if *port* invalid.
* - (-ENOTSUP) if hardware doesn't support this feature.
*/
__rte_experimental
int rte_pmd_atl_macsec_config_txsc(uint16_t port, uint8_t *mac);
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Configure Rx SC (Secure Connection).
*
* @param port
* The port identifier of the Ethernet device.
* @param mac
* The MAC address on the remote side.
* @param pi
* The PI (port identifier) on the remote side.
* @return
* - (0) if successful.
* - (-ENODEV) if *port* invalid.
* - (-ENOTSUP) if hardware doesn't support this feature.
*/
__rte_experimental
int rte_pmd_atl_macsec_config_rxsc(uint16_t port, uint8_t *mac, uint16_t pi);
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Enable Tx SA (Secure Association).
*
* @param port
* The port identifier of the Ethernet device.
* @param idx
* The SA to be enabled (0 or 1).
* @param an
* The association number on the local side.
* @param pn
* The packet number on the local side.
* @param key
* The key on the local side.
* @return
* - (0) if successful.
* - (-ENODEV) if *port* invalid.
* - (-ENOTSUP) if hardware doesn't support this feature.
* - (-EINVAL) if bad parameter.
*/
__rte_experimental
int rte_pmd_atl_macsec_select_txsa(uint16_t port, uint8_t idx, uint8_t an,
uint32_t pn, uint8_t *key);
/**
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
*
* Enable Rx SA (Secure Association).
*
* @param port
* The port identifier of the Ethernet device.
* @param idx
* The SA to be enabled (0 or 1)
* @param an
* The association number on the remote side.
* @param pn
* The packet number on the remote side.
* @param key
* The key on the remote side.
* @return
* - (0) if successful.
* - (-ENODEV) if *port* invalid.
* - (-ENOTSUP) if hardware doesn't support this feature.
* - (-EINVAL) if bad parameter.
*/
__rte_experimental
int rte_pmd_atl_macsec_select_rxsa(uint16_t port, uint8_t idx, uint8_t an,
uint32_t pn, uint8_t *key);
#endif /* _PMD_ATLANTIC_H_ */