:orphan: .. index:: pair: group; ARL table configuration .. _doxid-group__tapi__conf__arl: ARL table configuration ======================= .. toctree:: :hidden: enum_arl_entry_type.rst struct_arl_entry_t.rst Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`arl_entry_type` :ref:`arl_entry_type`; typedef struct :ref:`arl_entry_t` :ref:`arl_entry_t`; // enums enum :ref:`arl_entry_type`; // structs struct :ref:`arl_entry_t`; // global functions typedef :ref:`TAILQ_HEAD`(arl_table_t, :ref:`arl_entry_t`); static void :ref:`tapi_mac_next`(uint8_t* mac); static bool :ref:`tapi_mac_is_broadcast`(const uint8_t* mac); static bool :ref:`tapi_mac_is_multicast`(const uint8_t* mac); int :ref:`tapi_cfg_arl_get_table`(const char* ta, bool sync, arl_table_t* p_table); int :ref:`tapi_cfg_arl_del_entry`(const char* ta, :ref:`arl_entry_type` type, unsigned int port_num, const uint8_t* mac_addr, const char* vlan_name); int :ref:`tapi_cfg_arl_add_entry`(const char* ta, :ref:`arl_entry_type` type, unsigned int port_num, const uint8_t* mac_addr, const char* vlan_name); int :ref:`tapi_cfg_arl_get_entry`(const char* oid, :ref:`arl_entry_t`* p); void :ref:`tapi_arl_free_entry`(:ref:`arl_entry_t`* p); void :ref:`tapi_arl_free_table`(arl_table_t* p_table); :ref:`arl_entry_t`* :ref:`tapi_arl_find`(const arl_table_t* p_table, const uint8_t* mac, const char* vlan, unsigned int port, enum :ref:`arl_entry_type` type); void :ref:`tapi_arl_print_table`(const arl_table_t* p_table); // macros #define :ref:`DEFAULT_VLAN_NAME` .. _details-group__tapi__conf__arl: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Typedefs -------- .. index:: pair: typedef; arl_entry_type .. _doxid-group__tapi__conf__arl_1gafeb8bb687faab7e229e66338bd4a05e4: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`arl_entry_type` arl_entry_type Types of ARL entries .. index:: pair: typedef; arl_entry_t .. _doxid-group__tapi__conf__arl_1ga7ad2bfbdf39eedf363421b6a5defe335: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`arl_entry_t` arl_entry_t ARL table entry structure Global Functions ---------------- .. index:: pair: function; TAILQ_HEAD .. _doxid-group__tapi__conf__arl_1ga5a3b8665a8fb86993ca4b19326d0a287: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef TAILQ_HEAD(arl_table_t, :ref:`arl_entry_t`) ARL table head .. index:: pair: function; tapi_mac_next .. _doxid-group__tapi__conf__arl_1ga4cb22796fc4c12f5423861c72899b925: .. ref-code-block:: cpp :class: doxyrest-title-code-block static void tapi_mac_next(uint8_t* mac) Update MAC address to sequntially next. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - mac - - MAC address .. index:: pair: function; tapi_mac_is_broadcast .. _doxid-group__tapi__conf__arl_1ga6623883913d73378e6f5cae13aa1e265: .. ref-code-block:: cpp :class: doxyrest-title-code-block static bool tapi_mac_is_broadcast(const uint8_t* mac) Is MAC address broadcast? c true broadcast c false not broadcast .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - mac - .. index:: pair: function; tapi_mac_is_multicast .. _doxid-group__tapi__conf__arl_1ga421a337ff3168bb6eb3255a78b9463ec: .. ref-code-block:: cpp :class: doxyrest-title-code-block static bool tapi_mac_is_multicast(const uint8_t* mac) Is MAC address multicast? c true multicast c false not multicast .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - mac - .. index:: pair: function; tapi_cfg_arl_get_table .. _doxid-group__tapi__conf__arl_1gaea396657851f87323bcfea351866f431: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_arl_get_table(const char* ta, bool sync, arl_table_t* p_table) Get ARL table from TA. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - sync - - synchronize tree before get * - p_table - - pointer to head of ARL table (initialized as empty in the function) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_cfg_arl_del_entry .. _doxid-group__tapi__conf__arl_1ga285f4b2c65c212ba3f64d72b3a5afcc9: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_arl_del_entry(const char* ta, :ref:`arl_entry_type` type, unsigned int port_num, const uint8_t* mac_addr, const char* vlan_name) Delete an ARL entry from ARL table .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - type - - Entry type (static/dynamic) * - port_num - - Bridge port number of the new ARL entry * - mac_addr - - MAC address of the ARL entry * - vlan_name - - VLAN name associated with the ARL entry .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_arl_add_entry .. _doxid-group__tapi__conf__arl_1ga54cd9a08c2d132860cc4232435c3b5c5: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_arl_add_entry(const char* ta, :ref:`arl_entry_type` type, unsigned int port_num, const uint8_t* mac_addr, const char* vlan_name) Add a new ARL entry in ARL table .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - - Test agent name * - type - - Entry type (static/dynamic) * - port_num - - Bridge port number of the new ARL entry * - mac_addr - - MAC address of the ARL entry * - vlan_name - - VLAN name associated with the ARL entry .. rubric:: Returns: Status of the operation .. index:: pair: function; tapi_cfg_arl_get_entry .. _doxid-group__tapi__conf__arl_1ga9d917ae8c3be8eff23da2826139feee0: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_cfg_arl_get_entry(const char* oid, :ref:`arl_entry_t`* p) Get ARL table entry from TA. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - oid - - ARL table OID * - p - - pointer to ARL entry .. rubric:: Returns: Status code. .. index:: pair: function; tapi_arl_free_entry .. _doxid-group__tapi__conf__arl_1gaaaad6cea4e4dd2a225e03399705746eb: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_arl_free_entry(:ref:`arl_entry_t`* p) Free resources allocated inside ARL entry. DO NOT free memory used by ARL entry itself. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - p - - pointer to ARL entry .. index:: pair: function; tapi_arl_free_table .. _doxid-group__tapi__conf__arl_1ga1f056049c4f2536b5d18ecea20807f6a: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_arl_free_table(arl_table_t* p_table) Free resources allocated for ARL table. DO NOT free memory used by ARL table head. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - p_table - - pointer to ARL table .. index:: pair: function; tapi_arl_find .. _doxid-group__tapi__conf__arl_1gae7534c91eee83a72790ef8ce36d7a3be: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`arl_entry_t`* tapi_arl_find(const arl_table_t* p_table, const uint8_t* mac, const char* vlan, unsigned int port, enum :ref:`arl_entry_type` type) Find ARL entry with specified fields. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - p_table - - ARL table * - mac - - ARL MAC address * - vlan - - name of VLAN * - port - - ARL port * - type - - type of ARL entry .. rubric:: Returns: Pointer to ARL entry or NULL .. index:: pair: function; tapi_arl_print_table .. _doxid-group__tapi__conf__arl_1gaf3eb5066ef62973dc35807e4eca0078e: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_arl_print_table(const arl_table_t* p_table) Dump the content of ARL table into log file. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - p_table - - ARL table Macros ------ .. index:: pair: define; DEFAULT_VLAN_NAME .. _doxid-group__tapi__conf__arl_1gafb9d7d5fe4ec4bd09ebf22295c64063e: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define DEFAULT_VLAN_NAME Default VLAN name used on the Switch