fmac_structs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __FMAC_STRUCTS_H__
#define __FMAC_STRUCTS_H__
 
#include "osal_api.h"
 
#include "host_rpu_umac_if.h"
#include "common/fmac_structs_common.h"
 
#define MAX_PEERS 5
#define MAX_SW_PEERS (MAX_PEERS + 1)
#define NRF_WIFI_AC_TWT_PRIORITY_EMERGENCY 0xFF
#define NRF_WIFI_MAGIC_NUM_RAWTX 0x12345678
 
 
enum nrf_wifi_fmac_ac {
        NRF_WIFI_FMAC_AC_BK,
        NRF_WIFI_FMAC_AC_BE,
        NRF_WIFI_FMAC_AC_VI,
        NRF_WIFI_FMAC_AC_VO,
        NRF_WIFI_FMAC_AC_MC,
        NRF_WIFI_FMAC_AC_MAX
};
 
 
enum nrf_wifi_fmac_if_op_state {
        NRF_WIFI_FMAC_IF_OP_STATE_DOWN,
        NRF_WIFI_FMAC_IF_OP_STATE_UP,
        NRF_WIFI_FMAC_IF_OP_STATE_INVALID
};
 
 
enum nrf_wifi_fmac_if_carr_state {
        NRF_WIFI_FMAC_IF_CARR_STATE_OFF,
        NRF_WIFI_FMAC_IF_CARR_STATE_ON,
        NRF_WIFI_FMAC_IF_CARR_STATE_INVALID
};
 
#if defined(NRF70_RAW_DATA_RX) || defined(NRF70_PROMISC_DATA_RX)
struct raw_rx_pkt_header {
        unsigned short frequency;
        signed short signal;
        unsigned char rate_flags;
        unsigned char rate;
};
#endif /* NRF70_RAW_DATA_RX || NRF70_PROMISC_DATA_RX */
 
struct nrf_wifi_fmac_callbk_fns {
        void (*rpu_recovery_callbk_fn)(void *os_vif_ctx,
                void *event_data,
                unsigned int event_len);
 
        void (*scan_start_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_umac_event_trigger_scan *scan_start_event,
                                     unsigned int event_len);
 
        void (*scan_done_callbk_fn)(void *os_vif_ctx,
                                    struct nrf_wifi_umac_event_trigger_scan *scan_done_event,
                                    unsigned int event_len);
 
        void (*scan_abort_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_umac_event_trigger_scan *scan_done_event,
                                     unsigned int event_len);
 
        void (*scan_res_callbk_fn)(void *os_vif_ctx,
                                   struct nrf_wifi_umac_event_new_scan_results *scan_res,
                                   unsigned int event_len,
                                   bool more_res);
 
        void (*disp_scan_res_callbk_fn)(void *os_vif_ctx,
                                  struct nrf_wifi_umac_event_new_scan_display_results *scan_res,
                                  unsigned int event_len,
                                  bool more_res);
 
#if defined(WIFI_MGMT_RAW_SCAN_RESULTS) || defined(__DOXYGEN__)
        void (*rx_bcn_prb_resp_callbk_fn)(void *os_vif_ctx,
                                          void *frm,
                                          unsigned short frequency,
                                          signed short signal);
#endif /* WIFI_MGMT_RAW_SCAN_RESULTS */
 
        void (*event_get_reg)(void *if_priv,
                struct nrf_wifi_reg *get_reg,
                unsigned int event_len);
 
#if defined(NRF70_STA_MODE) || defined(NRF70_RAW_DATA_RX) || defined(__DOXYGEN__)
        void (*set_if_callbk_fn)(void *os_vif_ctx,
                                 struct nrf_wifi_umac_event_set_interface *set_if_event,
                                 unsigned int event_len);
#endif
 
#if defined(NRF70_STA_MODE) || defined(__DOXYGEN__)
        enum nrf_wifi_status (*if_carr_state_chg_callbk_fn)(void *os_vif_ctx,
                                                            enum nrf_wifi_fmac_if_carr_state cs);
 
        void (*rx_frm_callbk_fn)(void *os_vif_ctx,
                                 void *frm);
 
        void (*auth_resp_callbk_fn)(void *os_vif_ctx,
                                    struct nrf_wifi_umac_event_mlme *auth_resp_event,
                                    unsigned int event_len);
 
        void (*assoc_resp_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_umac_event_mlme *assoc_resp_event,
                                     unsigned int event_len);
 
        void (*deauth_callbk_fn)(void *os_vif_ctx,
                                 struct nrf_wifi_umac_event_mlme *deauth_event,
                                 unsigned int event_len);
 
        void (*disassoc_callbk_fn)(void *os_vif_ctx,
                                   struct nrf_wifi_umac_event_mlme *disassoc_event,
                                   unsigned int event_len);
 
        void (*mgmt_rx_callbk_fn)(void *os_vif_ctx,
                                  struct nrf_wifi_umac_event_mlme *mgmt_rx_event,
                                  unsigned int event_len);
 
        void (*unprot_mlme_mgmt_rx_callbk_fn)(void *os_vif_ctx,
                                              struct nrf_wifi_umac_event_mlme *unprot_mlme_event,
                                              unsigned int event_len);
 
        void (*tx_pwr_get_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_umac_event_get_tx_power *info,
                                     unsigned int event_len);
 
        void (*chnl_get_callbk_fn)(void *os_vif_ctx,
                                   struct nrf_wifi_umac_event_get_channel *info,
                                   unsigned int event_len);
 
        void (*cookie_rsp_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_umac_event_cookie_rsp *cookie_rsp,
                                     unsigned int event_len);
 
        void (*tx_status_callbk_fn)(void *os_vif_ctx,
                                    struct nrf_wifi_umac_event_mlme *tx_status_event,
                                    unsigned int event_len);
 
        void (*roc_callbk_fn)(void *os_vif_ctx,
                              struct nrf_wifi_event_remain_on_channel *roc_event,
                              unsigned int event_len);
 
        void (*roc_cancel_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_event_remain_on_channel *roc_cancel_event,
                                     unsigned int event_len);
 
        void (*get_station_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_umac_event_new_station *info,
                                     unsigned int event_len);
 
        void (*get_interface_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_interface_info *info,
                                     unsigned int event_len);
 
        void (*mgmt_tx_status)(void *if_priv,
                                        struct nrf_wifi_umac_event_mlme *mlme_event,
                                        unsigned int event_len);
 
        void (*twt_config_callbk_fn)(void *if_priv,
                struct nrf_wifi_umac_cmd_config_twt *twt_config_event_info,
                unsigned int event_len);
 
        void (*twt_teardown_callbk_fn)(void *if_priv,
                struct nrf_wifi_umac_cmd_teardown_twt *twt_teardown_event_info,
                unsigned int event_len);
 
        void (*event_get_wiphy)(void *if_priv,
                struct nrf_wifi_event_get_wiphy *get_wiphy,
                unsigned int event_len);
 
        void (*twt_sleep_callbk_fn)(void *if_priv,
                struct nrf_wifi_umac_event_twt_sleep *twt_sleep_event_info,
                unsigned int event_len);
 
        void (*event_get_ps_info)(void *if_priv,
                struct nrf_wifi_umac_event_power_save_info *get_ps_config,
                unsigned int event_len);
 
        void (*get_conn_info_callbk_fn)(void *os_vif_ctx,
                                        struct nrf_wifi_umac_event_conn_info *info,
                                        unsigned int event_len);
 
        void (*process_rssi_from_rx)(void *os_vif_ctx,
                                     signed short signal);
#endif /* NRF70_STA_MODE */
#if defined(NRF70_RAW_DATA_RX) || defined(NRF70_PROMISC_DATA_RX)
        void (*sniffer_callbk_fn)(void *os_vif_ctx,
                                  void *frm,
                                  struct raw_rx_pkt_header *,
                                  bool pkt_free);
#endif /* NRF70_RAW_DATA_RX || NRF70_PROMISC_DATA_RX */
        void (*reg_change_callbk_fn)(void *os_vif_ctx,
                                     struct nrf_wifi_event_regulatory_change *reg_change,
                                     unsigned int event_len);
};
 
#if defined(NRF70_STA_MODE) || defined(__DOXYGEN__)
enum nrf_wifi_fmac_twt_state {
        NRF_WIFI_FMAC_TWT_STATE_SLEEP,
        NRF_WIFI_FMAC_TWT_STATE_AWAKE
};
#endif /* NRF70_STA_MODE */
 
#if defined(NRF70_STA_MODE) || defined(NRF70_RAW_DATA_RX) || defined(__DOXYGEN__)
struct peers_info {
        int peer_id;
        unsigned char if_idx;
        unsigned char ps_state;
        unsigned char is_legacy;
        unsigned char qos_supported;
        unsigned char pend_q_bmp __NRF_WIFI_ALIGN_4;
        unsigned char ra_addr[NRF_WIFI_ETH_ADDR_LEN] __NRF_WIFI_ALIGN_4;
        unsigned int pairwise_cipher;
        int ps_token_count;
        bool authorized;
};
 
struct tx_config {
        void *tx_lock;
        struct peers_info peers[MAX_SW_PEERS];
        unsigned int *send_pkt_coalesce_count_p;
        void *data_pending_txq[MAX_SW_PEERS][NRF_WIFI_FMAC_AC_MAX];
        void *wakeup_client_q;
        unsigned long *buf_pool_bmp_p;
        unsigned int outstanding_descs[NRF_WIFI_FMAC_AC_MAX];
        unsigned int curr_peer_opp[NRF_WIFI_FMAC_AC_MAX];
        unsigned int next_spare_desc_ac;
        struct tx_pkt_info *pkt_info_p;
        unsigned int spare_desc_queue_map;
#if defined(NRF70_TX_DONE_WQ_ENABLED) || defined(__DOXYGEN__)
        void *tx_done_tasklet_event_q;
#endif /* NRF70_TX_DONE_WQ_ENABLED */
};
#endif /* NRF70_STA_MODE || NRF70_RAW_DATA_RX */
 
struct nrf_wifi_sys_fmac_priv {
        struct nrf_wifi_fmac_callbk_fns callbk_fns;
        struct nrf_wifi_data_config_params data_config;
        struct rx_buf_pool_params rx_buf_pools[MAX_NUM_OF_RX_QUEUES];
        unsigned int rx_desc[MAX_NUM_OF_RX_QUEUES];
        unsigned int num_rx_bufs;
#if defined(NRF70_STA_MODE)
        unsigned char num_tx_tokens;
        unsigned char num_tx_tokens_per_ac;
        unsigned char num_tx_tokens_spare;
        unsigned int max_ampdu_len_per_token;
        unsigned int avail_ampdu_len_per_token;
#endif /* NRF70_STA_MODE */
};
 
#ifdef NRF70_RAW_DATA_TX
 
enum nrf_wifi_fmac_rawtx_mode {
        NRF_WIFI_FMAC_RAWTX_MODE_LEGACY,
        NRF_WIFI_FMAC_RAWTX_MODE_HT,
        NRF_WIFI_FMAC_RAWTX_MODE_VHT,
        NRF_WIFI_FMAC_RAWTX_MODE_HE_SU,
        NRF_WIFI_FMAC_RAWTX_MODE_HE_ER_SU,
        NRF_WIFI_FMAC_RAWTX_MODE_HE_TB,
        NRF_WIFI_FMAC_RAWTX_MODE_MAX
};
 
struct raw_tx_pkt_header {
        unsigned int magic_num;
        unsigned char data_rate;
        unsigned short packet_length;
        unsigned char tx_mode;
        unsigned char queue;
        unsigned char reserved[3];
} __attribute__((packed));
 
struct raw_tx_stats {
        unsigned int raw_pkts_from_stack;
        unsigned int raw_pkt_send_failure;
        unsigned int raw_pkt_send_success;;
};
#endif /* NRF70_RAW_DATA_TX */
 
struct nrf_wifi_sys_fmac_dev_ctx {
        struct nrf_wifi_fmac_vif_ctx *vif_ctx[MAX_NUM_VIFS];
#if defined(NRF70_RX_WQ_ENABLED)
        void *rx_tasklet;
        void *rx_tasklet_event_q;
#endif /* NRF70_RX_WQ_ENABLED */
        struct rpu_host_stats host_stats;
        unsigned char num_sta;
        unsigned char num_ap;
        struct nrf_wifi_fmac_buf_map_info *rx_buf_info;
#if defined(NRF70_STA_MODE) || defined(NRF70_RAW_DATA_RX)
        struct tx_config tx_config;
#endif
#if defined(NRF70_STA_MODE)
        struct nrf_wifi_fmac_buf_map_info *tx_buf_info;
        enum nrf_wifi_fmac_twt_state twt_sleep_status;
#if defined(NRF70_TX_DONE_WQ_ENABLED)
        void *tx_done_tasklet;
#endif /* NRF70_TX_DONE_WQ_ENABLED */
#endif /* NRF70_STA_MODE */
#ifdef NRF70_RAW_DATA_TX
        struct raw_tx_pkt_header raw_tx_config;
        struct raw_tx_stats raw_pkt_stats;
#endif /* NRF70_RAW_DATA_TX */
};
 
struct nrf_wifi_fmac_vif_ctx {
        struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx;
        void *os_vif_ctx;
        char mac_addr[NRF_WIFI_ETH_ADDR_LEN];
        int groupwise_cipher;
        bool ifflags;
        int if_type;
        unsigned char bssid[NRF_WIFI_ETH_ADDR_LEN];
        unsigned char mode;
#if defined(NRF70_RAW_DATA_TX) || defined(NRF70_RAW_DATA_RX)
        unsigned char channel;
        bool txinjection_mode;
#endif /* NRF70_RAW_DATA_TX || NRF70_RAW_DATA_RX */
#if defined(NRF70_RAW_DATA_RX) || defined(NRF70_PROMISC_DATA_RX)
        unsigned char packet_filter;
#endif /* NRF70_RAW_DATA_RX || NRF70_PROMISC_DATA_RX */
#ifdef NRF70_PROMISC_DATA_RX
        bool promisc_mode;
#endif /* NRF70_PROMISC_DATA_RX */
};
 
struct nrf_wifi_fmac_buf_map_info {
        bool mapped;
        unsigned long nwb;
};
 
 
struct rpu_sys_op_stats {
        struct rpu_host_stats host;
        struct rpu_sys_fw_stats fw;
};
 
#endif /* __FMAC_STRUCTS_H__ */