/space/home/slher/rel/Beken/v6_4_5/macsw/modules/mac/src/mac.h

Go to the documentation of this file.

#ifndef _MAC_H_
#define _MAC_H_

/*
 * INCLUDE FILES
 ****************************************************************************************
 */
// standard includes
#include "co_int.h"
#include "co_bool.h"
#include "co_math.h"
#include "co_utils.h"
#include "compiler.h"
#include "mac_types.h"

// for memcmp
#include <string.h>


/*
 * DEFINES
 ****************************************************************************************
 */
#define TU_DURATION                     1024

#define MAC_BASIC_RATE                  0x80

#define WORD_ALIGN                      3

#define MAC_ADDR_CMP(addr1_ptr, addr2_ptr)                                              \
    ((*(((uint16_t*)(addr1_ptr)) + 0) == *(((uint16_t*)(addr2_ptr)) + 0)) &&            \
     (*(((uint16_t*)(addr1_ptr)) + 1) == *(((uint16_t*)(addr2_ptr)) + 1)) &&            \
     (*(((uint16_t*)(addr1_ptr)) + 2) == *(((uint16_t*)(addr2_ptr)) + 2)))

#define MAC_ADDR_CMP_PACKED(__a1, __a2)                                                 \
    (memcmp(__a1, __a2, MAC_ADDR_LEN) == 0)

#define MAC_ADDR_CPY(addr1_ptr, addr2_ptr)                                              \
    *(((uint16_t*)(addr1_ptr)) + 0) = *(((uint16_t*)(addr2_ptr)) + 0);                  \
    *(((uint16_t*)(addr1_ptr)) + 1) = *(((uint16_t*)(addr2_ptr)) + 1);                  \
    *(((uint16_t*)(addr1_ptr)) + 2) = *(((uint16_t*)(addr2_ptr)) + 2)

#define MAC_SSID_CMP(ssid1_ptr,ssid2_ptr)                                               \
    (((ssid1_ptr)->length == (ssid2_ptr)->length) &&                                    \
     (memcmp((&(ssid1_ptr)->array[0]), (&(ssid2_ptr)->array[0]), (ssid1_ptr)->length) == 0))

#define MAC_ADDR_GROUP(mac_addr_ptr) ((*((uint8_t *)(mac_addr_ptr))) & 1)

#define MAC_FRAME_LEN 512

struct mac_frame
{
    uint16_t length;
    uint8_t array[MAC_FRAME_LEN];
};

#define MAC_DEFAULT_KEY_COUNT 4
#define MAC_DEFAULT_MFP_KEY_COUNT 6

struct key_info_tag
{
    uint64_t rx_pn[TID_MAX];
    uint64_t tx_pn;
    union
    {
        struct
        {
            uint32_t tx_key[2];
            uint32_t rx_key[2];
        } mic;
        struct
        {
            uint32_t key[4];
        } mfp;
    }u;
    uint8_t cipher;
    uint8_t key_idx;
    uint8_t hw_key_idx;
    bool valid;
};

struct mac_htoprnelmt
{
    uint8_t     prim_channel;
    uint8_t     ht_oper_1;
    uint16_t    ht_oper_2;
    uint16_t    ht_oper_3;
    uint8_t     mcs_rate[MAX_MCS_LEN];

};

struct mac_mu_edca_param_set
{
    uint32_t        ac_param[AC_MAX];
    uint8_t         qos_info;
    uint8_t         param_set_cnt;
};

struct mac_edca_param_set
{
    uint32_t        ac_param[AC_MAX];
    uint8_t         qos_info;
    uint8_t         acm;
    uint8_t         param_set_cnt;
};

#define MAC_QOS_INFO_STA_UAPSD_ENABLED_VO      CO_BIT(0)
#define MAC_QOS_INFO_STA_UAPSD_ENABLED_VI      CO_BIT(1)
#define MAC_QOS_INFO_STA_UAPSD_ENABLED_BK      CO_BIT(2)
#define MAC_QOS_INFO_STA_UAPSD_ENABLED_BE      CO_BIT(3)
#define MAC_QOS_INFO_STA_UAPSD_ENABLED_ALL     0x0F
#define MAC_QOS_INFO_AP_UAPSD_ENABLED          CO_BIT(7)

// Protection Status field (Bit indexes, Masks, Offsets)
#define MAC_PROT_NONERP_PRESENT_BIT        CO_BIT(0)
#define MAC_PROT_USE_PROTECTION_BIT        CO_BIT(1)
#define MAC_PROT_BARKER_PREAMB_BIT         CO_BIT(2)
#define MAC_PROT_ERP_STATUS_MASK           (MAC_PROT_NONERP_PRESENT_BIT |                \
                                            MAC_PROT_USE_PROTECTION_BIT |                \
                                            MAC_PROT_BARKER_PREAMB_BIT)

/*
 * GLOBAL VARIABLES
 ****************************************************************************************
 */
extern const uint8_t mac_tid2ac[];

extern const uint8_t mac_ac2uapsd[];

extern const uint8_t mac_aci2ac[];

extern const uint8_t mac_ac2aci[];


extern const uint8_t mac_id2rate[];

extern const struct mac_addr mac_addr_bcst;


#define HE_MAC_CAPA_VAL_GET(he_cap, field)    co_val_get((he_cap)->mac_cap_info,         \
                                                         HE_MAC_CAPA_##field##_OFT,      \
                                                         HE_MAC_CAPA_##field##_WIDTH)

#define HE_MAC_CAPA_VAL_SET(he_cap, field, val) co_val_set((he_cap)->mac_cap_info,       \
                                                           HE_MAC_CAPA_##field##_OFT,    \
                                                           HE_MAC_CAPA_##field##_WIDTH,  \
                                                           HE_MAC_CAPA_##field##_##val)

#define HE_MAC_CAPA_BIT_IS_SET(he_cap, bit)   co_bit_is_set((he_cap)->mac_cap_info,      \
                                                            HE_MAC_CAPA_##bit##_POS)

#define HE_MAC_CAPA_BIT_SET(he_cap, bit)      co_bit_set((he_cap)->mac_cap_info,         \
                                                          HE_MAC_CAPA_##bit##_POS)

#define HE_MAC_CAPA_BIT_CLR(he_cap, bit)      co_bit_clr((he_cap)->mac_cap_info,         \
                                                         HE_MAC_CAPA_##bit##_POS)

#define HE_PHY_CAPA_VAL_GET(he_cap, field)    co_val_get((he_cap)->phy_cap_info,         \
                                                         HE_PHY_CAPA_##field##_OFT,      \
                                                         HE_PHY_CAPA_##field##_WIDTH)

#define HE_PHY_CAPA_VAL_SET(he_cap, field, val) co_val_set((he_cap)->phy_cap_info,       \
                                                           HE_PHY_CAPA_##field##_OFT,    \
                                                           HE_PHY_CAPA_##field##_WIDTH,  \
                                                           HE_PHY_CAPA_##field##_##val)

#define HE_PHY_CAPA_BIT_IS_SET(he_cap, bit)   co_bit_is_set((he_cap)->phy_cap_info,      \
                                                            HE_PHY_CAPA_##bit##_POS)

#define HE_PHY_CAPA_BIT_SET(he_cap, bit)      co_bit_set((he_cap)->phy_cap_info,         \
                                                         HE_PHY_CAPA_##bit##_POS)

#define HE_PHY_CAPA_BIT_CLR(he_cap, bit)      co_bit_clr((he_cap)->phy_cap_info,         \
                                                         HE_PHY_CAPA_##bit##_POS)

/*
 * FUNCTION DECLARATIONS
 ****************************************************************************************
 */
__INLINE bool mac_nontxed_bssid_get(uint8_t bssid_index,
                                    uint8_t max_bssid_ind,
                                    struct mac_addr const *ref_bssid,
                                    struct mac_addr *bssid)
{
    uint16_t mask;

    // Check if parameters are valid
    if (!bssid_index || (max_bssid_ind > 8))
        return false;

    // Compute the nonTransmitted BSSID. Its (48-max_bss_ind) LSB shall be
    // equal to the reference BSSID (48-max_bss_ind) LSB, and its max_bss_ind MSB
    // are equal to: ((max_bss_ind reference BSSID LSB) + bssid_index) % (2^max_bss_ind)
    mask = (CO_BIT(max_bssid_ind) - 1) << 8;
    *bssid = *ref_bssid;
    bssid->array[2] &= ~mask;
    bssid->array[2] |= (ref_bssid->array[2] + (bssid_index << 8)) & mask;

    return true;
}

 __INLINE void mac_ref_bssid_get(uint8_t bssid_index,
                                 uint8_t max_bssid_ind,
                                 struct mac_addr const *bssid,
                                 struct mac_addr *ref_bssid)
{
    uint16_t mask;

    // Compute the reference BSSID. Its (48-max_bss_ind) LSB shall be
    // equal to the nonTransmitted BSSID (48-max_bss_ind) LSB, and its max_bss_ind MSB
    // are equal to: ((max_bss_ind nonTransmitted BSSID LSB) - bssid_index) % (2^max_bss_ind)
    mask = (CO_BIT(max_bssid_ind) - 1) << 8;
    *ref_bssid = *bssid;
    ref_bssid->array[2] &= ~mask;
    ref_bssid->array[2] |= (bssid->array[2] - (bssid_index << 8)) & mask;
}

uint32_t mac_paid_gid_sta_compute(struct mac_addr const *mac_addr);

uint32_t mac_paid_gid_ap_compute(struct mac_addr const *mac_addr, uint16_t aid);

enum mac_akm_suite mac_akm_suite_value(uint32_t akm_suite);

enum mac_cipher_suite mac_cipher_suite_value(uint32_t cipher_suite);



#endif // _MAC_H_

---