fmac_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __FMAC_API_H__
#define __FMAC_API_H__
 
#include "osal_api.h"
 
#include "host_rpu_umac_if.h"
#include "host_rpu_data_if.h"
#include "host_rpu_sys_if.h"
 
 
#include "system/fmac_structs.h"
#include "system/fmac_cmd.h"
#include "system/fmac_event.h"
#include "system/fmac_vif.h"
#include "system/fmac_bb.h"
#include "common/fmac_api_common.h"
 
 
 
struct nrf_wifi_fmac_priv *nrf_wifi_sys_fmac_init(struct nrf_wifi_data_config_params *data_config,
                                                  struct rx_buf_pool_params *rx_buf_pools,
                                                  struct nrf_wifi_fmac_callbk_fns *callbk_fns);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_scan(void *fmac_dev_ctx,
                                        unsigned char if_idx,
                                        struct nrf_wifi_umac_scan_info *scan_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_scan_res_get(void *fmac_dev_ctx,
                                                unsigned char if_idx,
                                                int scan_type);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_abort_scan(void *fmac_dev_ctx,
                                                unsigned char if_idx);
 
#if defined(NRF70_STA_MODE) || defined(__DOXYGEN__)
enum nrf_wifi_status nrf_wifi_sys_fmac_auth(void *fmac_dev_ctx,
                                        unsigned char if_idx,
                                        struct nrf_wifi_umac_auth_info *auth_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_deauth(void *fmac_dev_ctx,
                                          unsigned char if_idx,
                                          struct nrf_wifi_umac_disconn_info *deauth_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_assoc(void *fmac_dev_ctx,
                                         unsigned char if_idx,
                                         struct nrf_wifi_umac_assoc_info *assoc_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_disassoc(void *fmac_dev_ctx,
                                            unsigned char if_idx,
                                            struct nrf_wifi_umac_disconn_info *disassoc_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_add_key(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_key_info *key_info,
                                           const char *mac_addr);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_del_key(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_key_info *key_info,
                                           const char *mac_addr);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_key(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_key_info *key_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_bss(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_bss_info *bss_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_chg_bcn(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_set_beacon_info *data);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_start_ap(void *fmac_dev_ctx,
                                            unsigned char if_idx,
                                            struct nrf_wifi_umac_start_ap_info *ap_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_stop_ap(void *fmac_dev_ctx,
                                           unsigned char if_idx);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_p2p_dev_start(void *fmac_dev_ctx,
                                                 unsigned char if_idx);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_p2p_dev_stop(void *fmac_dev_ctx,
                                                unsigned char if_idx);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_p2p_roc_start(void *fmac_dev_ctx,
                                                 unsigned char if_idx,
                                                 struct remain_on_channel_info *roc_info);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_p2p_roc_stop(void *fmac_dev_ctx,
                                                unsigned char if_idx,
                                                unsigned long long cookie);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_mgmt_tx(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_mgmt_tx_info *mgmt_tx_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_del_sta(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_del_sta_info *del_sta_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_add_sta(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_add_sta_info *add_sta_info);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_chg_sta(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_chg_sta_info *chg_sta_info);
 
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_mgmt_frame_reg(void *fmac_dev_ctx,
                                                  unsigned char if_idx,
                                                  struct nrf_wifi_umac_mgmt_frame_info *frame_info);
 
#endif /* NRF70_STA_MODE */
enum nrf_wifi_status nrf_wifi_sys_fmac_mac_addr(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
                                            unsigned char *addr);
 
 
unsigned char nrf_wifi_sys_fmac_add_vif(void *fmac_dev_ctx,
                                    void *os_vif_ctx,
                                    struct nrf_wifi_umac_add_vif_info *vif_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_del_vif(void *fmac_dev_ctx,
                                           unsigned char if_idx);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_chg_vif(void *fmac_dev_ctx,
                                           unsigned char if_idx,
                                           struct nrf_wifi_umac_chg_vif_attr_info *vif_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_chg_vif_state(void *fmac_dev_ctx,
                                                 unsigned char if_idx,
                                                 struct nrf_wifi_umac_chg_vif_state_info *vif_info);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_vif_macaddr(void *fmac_dev_ctx,
                                                   unsigned char if_idx,
                                                   unsigned char *mac_addr);
 
enum nrf_wifi_status nrf_wifi_fmac_start_xmit(void *fmac_dev_ctx,
                                              unsigned char if_idx,
                                              void *netbuf);
 
enum nrf_wifi_status nrf_wifi_fmac_suspend(void *fmac_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_fmac_resume(void *fmac_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_get_tx_power(void *fmac_dev_ctx,
                                                unsigned int if_idx);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_get_channel(void *fmac_dev_ctx,
                                               unsigned int if_idx);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_get_station(void *fmac_dev_ctx,
                                               unsigned int if_idx,
                                               unsigned char *mac);
 
 
/* @brief Get interface statistics
 *
 * @param dev_ctx Pointer to the UMAC IF context for a RPU WLAN device.
 * @param if_idx VIF index.
 *
 * This function is used to send a command to:
 *          - Get interface statistics using interface index \p if_idx.
 *
 *@retval       NRF_WIFI_STATUS_SUCCESS On success
 *@retval       NRF_WIFI_STATUS_FAIL On failure to execute command
 */
enum nrf_wifi_status nrf_wifi_sys_fmac_get_interface(void *dev_ctx,
                                               unsigned int if_idx);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_power_save(void *fmac_dev_ctx,
                                                  unsigned char if_idx,
                                                  bool state);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_uapsd_queue(void *fmac_dev_ctx,
                                                   unsigned char if_idx,
                                                   unsigned int uapsd_queue);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_power_save_timeout(void *fmac_dev_ctx,
                                                          unsigned char if_idx,
                                                          int ps_timeout);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_qos_map(void *fmac_dev_ctx,
                                               unsigned char if_idx,
                                               struct nrf_wifi_umac_qos_map_info *qos_info);
 
enum nrf_wifi_status nrf_wifi_fmac_set_wowlan(void *fmac_dev_ctx,
                                              unsigned int var);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_get_wiphy(void *fmac_dev_ctx, unsigned char if_idx);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_register_frame(void *fmac_dev_ctx, unsigned char if_idx,
                                                  struct nrf_wifi_umac_mgmt_frame_info *frame_info);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_wiphy_params(void *fmac_dev_ctx,
                                                 unsigned char if_idx,
                                                 struct nrf_wifi_umac_set_wiphy_info *wiphy_info);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_twt_setup(void *fmac_dev_ctx,
                                             unsigned char if_idx,
                                             struct nrf_wifi_umac_config_twt_info *twt_info);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_twt_teardown(void *fmac_dev_ctx,
                                                unsigned char if_idx,
                                                struct nrf_wifi_umac_config_twt_info *twt_info);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_get_conn_info(void *fmac_dev_ctx,
                                                unsigned char if_idx);
 
struct nrf_wifi_fmac_dev_ctx *nrf_wifi_sys_fmac_dev_add(struct nrf_wifi_fmac_priv *fpriv,
                                                        void *os_dev_ctx);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_dev_init(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
#if defined(NRF_WIFI_LOW_POWER) || defined(__DOXYGEN__)
                                            int sleep_type,
#endif /* NRF_WIFI_LOW_POWER */
                                            unsigned int phy_calib,
                                            enum op_band op_band,
                                            bool beamforming,
                                            struct nrf_wifi_tx_pwr_ctrl_params *tx_pwr_ctrl_params,
                                            struct nrf_wifi_tx_pwr_ceil_params *tx_pwr_ceil_params,
                                            struct nrf_wifi_board_params *board_params,
                                            unsigned char *country_code);
 
 
void nrf_wifi_sys_fmac_dev_deinit(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx);
 
#ifdef NRF70_SR_COEX_SLEEP_CTRL_GPIO_CTRL
enum nrf_wifi_status nrf_wifi_coex_config_sleep_ctrl_gpio_ctrl(
                struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
                unsigned int alt_swctrl1_function_bt_coex_status1,
                unsigned int invert_bt_coex_grant_output);
#endif /* NRF70_SR_COEX_SLEEP_CTRL_GPIO_CTRL */
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_listen_interval(void *fmac_dev_ctx,
                                                        unsigned char if_idx,
                                                        unsigned short listen_interval);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_ps_wakeup_mode(void *fmac_dev_ctx,
                                                        unsigned char if_idx,
                                                        bool ps_wakeup_mode);
 
enum nrf_wifi_status nrf_wifi_sys_fmac_set_ps_exit_strategy(
                                                void *fmac_dev_ctx,
                                                unsigned char if_idx,
                                                unsigned int ps_exit_strategy);
 
#ifdef NRF70_RAW_DATA_TX
enum nrf_wifi_status nrf_wifi_fmac_start_rawpkt_xmit(void *dev_ctx,
                                                     unsigned char if_idx,
                                                     void *net_packet);
#endif /* NRF70_RAW_DATA_TX */
 
enum nrf_wifi_status nrf_wifi_check_mode_validity(unsigned char mode);
 
#if defined(NRF_WIFI_RPU_RECOVERY) || defined(__DOXYGEN__)
enum nrf_wifi_status nrf_wifi_sys_fmac_rpu_recovery_callback(void *mac_dev_ctx,
                                                void *event_data,
                                                unsigned int len);
#endif /* CONFIG_NRF_RPU_RECOVERY */
 
enum nrf_wifi_status nrf_wifi_sys_fmac_rf_params_get(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
                                                     struct nrf_wifi_phy_rf_params *rf_params);
#ifdef NRF70_SYSTEM_WITH_RAW_MODES
enum nrf_wifi_status nrf_wifi_sys_fmac_set_mode(void *dev_ctx,
                                                unsigned char if_idx,
                                                unsigned char mode);
#endif
 
#if defined(NRF70_RAW_DATA_TX) || defined(NRF70_RAW_DATA_RX)
enum nrf_wifi_status nrf_wifi_sys_fmac_set_channel(void *dev_ctx,
                                                   unsigned char if_idx,
                                                   unsigned int channel);
 
#endif /* NRF70_RAW_DATA_TX || NRF70_RAW_DATA_RX */
 
#if defined(NRF70_RAW_DATA_RX) || defined(NRF70_PROMISC_DATA_RX)
enum nrf_wifi_status nrf_wifi_sys_fmac_set_packet_filter(void *dev_ctx,
                                                         unsigned char filter,
                                                         unsigned char if_idx,
                                                         unsigned short buffer_size);
#endif /* NRF70_RAW_DATA_RX || NRF70_PROMISC_DATA_RX */
 
#if defined(NRF70_UTIL) || defined(__DOXYGEN__)
enum nrf_wifi_status nrf_wifi_sys_fmac_set_tx_rate(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
                                                   unsigned char rate_flag,
                                                   int data_rate);
#if defined(NRF_WIFI_LOW_POWER) || defined(__DOXYGEN__)
enum nrf_wifi_status nrf_wifi_sys_fmac_get_host_rpu_ps_ctrl_state(void *fmac_dev_ctx,
                                                                  int *rpu_ps_ctrl_state);
#endif /* NRF_WIFI_LOW_POWER */
#endif /* NRF70_UTIL */
 
enum nrf_wifi_status nrf_wifi_sys_fmac_conf_ltf_gi(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
                                                   unsigned char he_ltf,
                                                   unsigned char he_gi,
                                                   unsigned char enabled);
 
 
enum nrf_wifi_status nrf_wifi_sys_fmac_stats_get(struct nrf_wifi_fmac_dev_ctx *fmac_dev_ctx,
                                                 enum rpu_stats_type stats_type,
                                                 struct rpu_sys_op_stats *stats);
#ifdef NRF_WIFI_RX_BUFF_PROG_UMAC
enum nrf_wifi_status nrf_wifi_fmac_prog_rx_buf_info(void *fmac_dev_ctx,
                                               struct nrf_wifi_rx_buf *rx_buf,
                                               unsigned int num_buffs);
#endif /*NRF_WIFI_RX_BUFF_PROG_UMAC*/
 
#endif /* __FMAC_API_H__ */