drivers/wlan/third_party/broadcom/brcmfmac/cfg80211.h

/*
 * Copyright (c) 2010 Broadcom Corporation
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef BRCMFMAC_CFG80211_H
#define BRCMFMAC_CFG80211_H

#include <lib/sync/completion.h>
#include <threads.h>
#include <wlan/protocol/info.h>

#include <zircon/listnode.h>

/* for brcmu_d11inf */
#include "brcmu_d11.h"
#include "core.h"
#include "device.h"
#include "fwil_types.h"
#include "p2p.h"
#include "workqueue.h"

// clang-format off

#define WL_NUM_SCAN_MAX        10
#define WL_TLV_INFO_MAX        1024
#define WL_BSS_INFO_MAX        2048
#define WL_ASSOC_INFO_MAX      512 /* assoc related fil max buf */
#define WL_EXTRA_BUF_MAX       2048
#define WL_ROAM_TRIGGER_LEVEL  -75
#define WL_ROAM_DELTA          20

/* Keep BRCMF_ESCAN_BUF_SIZE below 64K (65536). Allocing over 64K can be
 * problematic on some systems and should be avoided.
 */
#define BRCMF_ESCAN_BUF_SIZE   65000
#define BRCMF_ESCAN_TIMER_INTERVAL_MS 10000 /* E-Scan timeout */

#define BRCMF_DISCONNECT_TIMEOUT  ZX_MSEC(50) /* Wait for disconnect to complete */

#define WL_ESCAN_ACTION_START      1
#define WL_ESCAN_ACTION_CONTINUE   2
#define WL_ESCAN_ACTION_ABORT      3

#define WL_AUTH_SHARED_KEY 1 /* d11 shared authentication */
#define IE_MAX_LEN 512

/* IE TLV processing */
#define TLV_LEN_OFF   1  /* length offset */
#define TLV_HDR_LEN   2  /* header length */
#define TLV_BODY_OFF  2  /* body offset */
#define TLV_OUI_LEN   3  /* oui id length */

/* 802.11 Mgmt Packet flags */
#define BRCMF_VNDR_IE_BEACON_FLAG     0x1
#define BRCMF_VNDR_IE_PRBRSP_FLAG     0x2
#define BRCMF_VNDR_IE_ASSOCRSP_FLAG   0x4
#define BRCMF_VNDR_IE_AUTHRSP_FLAG    0x8
#define BRCMF_VNDR_IE_PRBREQ_FLAG    0x10
#define BRCMF_VNDR_IE_ASSOCREQ_FLAG  0x20
/* vendor IE in IW advertisement protocol ID field */
#define BRCMF_VNDR_IE_IWAPID_FLAG    0x40
/* allow custom IE id */
#define BRCMF_VNDR_IE_CUSTOM_FLAG   0x100

/* P2P Action Frames flags (spec ordered) */
#define BRCMF_VNDR_IE_GONREQ_FLAG 0x001000
#define BRCMF_VNDR_IE_GONRSP_FLAG 0x002000
#define BRCMF_VNDR_IE_GONCFM_FLAG 0x004000
#define BRCMF_VNDR_IE_INVREQ_FLAG 0x008000
#define BRCMF_VNDR_IE_INVRSP_FLAG 0x010000
#define BRCMF_VNDR_IE_DISREQ_FLAG 0x020000
#define BRCMF_VNDR_IE_DISRSP_FLAG 0x040000
#define BRCMF_VNDR_IE_PRDREQ_FLAG 0x080000
#define BRCMF_VNDR_IE_PRDRSP_FLAG 0x100000

#define BRCMF_VNDR_IE_P2PAF_SHIFT 12

#define BRCMF_MAX_DEFAULT_KEYS 6

/* beacon loss timeout defaults */
#define BRCMF_DEFAULT_BCN_TIMEOUT_ROAM_ON  2
#define BRCMF_DEFAULT_BCN_TIMEOUT_ROAM_OFF 4

// clang-format on

#define BRCMF_VIF_EVENT_TIMEOUT_MSEC (1500)

/**
 * enum brcmf_scan_status - scan engine status
 *
 * @BRCMF_SCAN_STATUS_BUSY: scanning in progress on dongle.
 * @BRCMF_SCAN_STATUS_ABORT: scan being aborted on dongle.
 * @BRCMF_SCAN_STATUS_SUPPRESS: scanning is suppressed in driver.
 */
enum brcmf_scan_status {
    BRCMF_SCAN_STATUS_BUSY,
    BRCMF_SCAN_STATUS_ABORT,
    BRCMF_SCAN_STATUS_SUPPRESS,
};

/* dongle configuration */
struct brcmf_cfg80211_conf {
    uint32_t frag_threshold;
    uint32_t rts_threshold;
    uint32_t retry_short;
    uint32_t retry_long;
};

/* security information with currently associated ap */
struct brcmf_cfg80211_security {
    uint32_t wpa_versions;
    uint32_t auth_type;
    uint32_t cipher_pairwise;
    uint32_t cipher_group;
};

enum brcmf_profile_fwsup {
    BRCMF_PROFILE_FWSUP_NONE,
    BRCMF_PROFILE_FWSUP_PSK,
    BRCMF_PROFILE_FWSUP_1X
};

/**
 * struct brcmf_cfg80211_profile - profile information.
 *
 * @bssid: bssid of joined/joining ibss.
 * @sec: security information.
 * @key: key information.
 * @use_fwsup: use firmware supplicant.
 * @beacon_period: in AP mode, beacon period in TUs.
 */
struct brcmf_cfg80211_profile {
    uint8_t bssid[ETH_ALEN];
    struct brcmf_cfg80211_security sec;
    struct brcmf_wsec_key key[BRCMF_MAX_DEFAULT_KEYS];
    enum brcmf_profile_fwsup use_fwsup;

    // AP-specific
    uint32_t beacon_period;
};

/**
 * enum brcmf_vif_status - bit indices for vif status.
 *
 * @BRCMF_VIF_STATUS_READY: ready for operation.
 * @BRCMF_VIF_STATUS_CONNECTING: connect/join in progress.
 * @BRCMF_VIF_STATUS_CONNECTED: connected/joined successfully.
 * @BRCMF_VIF_STATUS_DISCONNECTING: disconnect/disable in progress.
 * @BRCMF_VIF_STATUS_AP_CREATED: AP operation started.
 * @BRCMF_VIF_STATUS_EAP_SUCCUSS: EAPOL handshake successful.
 * @BRCMF_VIF_STATUS_ASSOC_SUCCESS: successful SET_SSID received.
 */
enum brcmf_vif_status {
    BRCMF_VIF_STATUS_READY,
    BRCMF_VIF_STATUS_CONNECTING,
    BRCMF_VIF_STATUS_CONNECTED,
    BRCMF_VIF_STATUS_DISCONNECTING,
    BRCMF_VIF_STATUS_AP_CREATED,
    BRCMF_VIF_STATUS_EAP_SUCCESS,
    BRCMF_VIF_STATUS_ASSOC_SUCCESS,
};

/**
 * struct vif_saved_ie - holds saved IEs for a virtual interface.
 *
 * @probe_req_ie: IE info for probe request.
 * @probe_res_ie: IE info for probe response.
 * @beacon_ie: IE info for beacon frame.
 * @probe_req_ie_len: IE info length for probe request.
 * @probe_res_ie_len: IE info length for probe response.
 * @beacon_ie_len: IE info length for beacon frame.
 */
struct vif_saved_ie {
    uint8_t probe_req_ie[IE_MAX_LEN];
    uint8_t probe_res_ie[IE_MAX_LEN];
    uint8_t beacon_ie[IE_MAX_LEN];
    uint8_t assoc_req_ie[IE_MAX_LEN];
    uint32_t probe_req_ie_len;
    uint32_t probe_res_ie_len;
    uint32_t beacon_ie_len;
    uint32_t assoc_req_ie_len;
};

/**
 * struct brcmf_cfg80211_vif - virtual interface specific information.
 *
 * @ifp: lower layer interface pointer
 * @wdev: wireless device.
 * @profile: profile information.
 * @sme_state: SME state using enum brcmf_vif_status bits.
 * @list: linked list.
 * @mgmt_rx_reg: registered rx mgmt frame types.
 * @mbss: Multiple BSS type, set if not first AP (not relevant for P2P).
 */
struct brcmf_cfg80211_vif {
    struct brcmf_if* ifp;
    struct wireless_dev wdev;
    struct brcmf_cfg80211_profile profile;
    atomic_ulong sme_state;
    struct vif_saved_ie saved_ie;
    struct list_node list;
    uint16_t mgmt_rx_reg;
    bool mbss;
    int is_11d;
};

/* association inform */
struct brcmf_cfg80211_connect_info {
    uint8_t* req_ie;
    int32_t req_ie_len;
    uint8_t* resp_ie;
    int32_t resp_ie_len;
};

/* assoc ie length */
struct brcmf_cfg80211_assoc_ielen_le {
    uint32_t req_len;
    uint32_t resp_len;
};

/* dongle escan state */
enum wl_escan_state { WL_ESCAN_STATE_IDLE, WL_ESCAN_STATE_SCANNING };

struct escan_info {
    uint32_t escan_state;
    uint8_t* escan_buf;
    struct wiphy* wiphy;
    struct brcmf_if* ifp;
    zx_status_t (*run)(struct brcmf_cfg80211_info* cfg, struct brcmf_if* ifp,
                       wlanif_scan_req_t* request);
};

/**
 * struct brcmf_cfg80211_vif_event - virtual interface event information.
 *
 * @vif_event_wait: Completion awaiting interface event from firmware.
 * @vif_event_lock: protects other members in this structure.
 * @action: either add, change, or delete.
 * @vif: virtual interface object related to the event.
 */
struct brcmf_cfg80211_vif_event {
    sync_completion_t vif_event_wait;
    mtx_t vif_event_lock;
    uint8_t action;
    struct brcmf_cfg80211_vif* vif;
};

/**
 * struct brcmf_cfg80211_wowl - wowl related information.
 *
 * @active: set on suspend, cleared on resume.
 * @pre_pmmode: firmware PM mode at entering suspend.
 * @nd: net dectect data.
 * @nd_info: helper struct to pass to cfg80211.
 * @nd_data_wait: Completion to sync net detect data.
 * @nd_enabled: net detect enabled.
 */
struct brcmf_cfg80211_wowl {
    bool active;
    uint32_t pre_pmmode;
    struct cfg80211_wowlan_nd_match* nd;
    struct cfg80211_wowlan_nd_info* nd_info;
    sync_completion_t nd_data_wait;
    bool nd_enabled;
};

enum brcmf_disconnect_mode {
    BRCMF_DISCONNECT_DEAUTH,
    BRCMF_DISCONNECT_DISASSOC
};

/**
 * struct brcmf_cfg80211_info - dongle private data of cfg80211 interface
 *
 * @wiphy: wiphy object for cfg80211 interface.
 * @ops: pointer to copy of ops as registered with wiphy object.
 * @conf: dongle configuration.
 * @p2p: peer-to-peer specific information.
 * @btcoex: Bluetooth coexistence information.
 * @scan_request: cfg80211 scan request object.
 * @usr_sync: mainly for dongle up/down synchronization.
 * @bss_list: bss_list holding scanned ap information.
 * @bss_info: bss information for cfg80211 layer.
 * @conn_info: association info.
 * @pmk_list: wpa2 pmk list.
 * @scan_status: scan activity on the dongle.
 * @pub: common driver information.
 * @channel: current channel.
 * @int_escan_map: bucket map for which internal e-scan is done.
 * @ibss_starter: indicates this sta is ibss starter.
 * @pwr_save: indicate whether dongle to support power save mode.
 * @dongle_up: indicate whether dongle up or not.
 * @roam_on: on/off switch for dongle self-roaming.
 * @scan_tried: indicates if first scan attempted.
 * @dcmd_buf: dcmd buffer.
 * @extra_buf: mainly to grab assoc information.
 * @debugfsdir: debugfs folder for this device.
 * @escan_info: escan information.
 * @escan_timeout: Timer for catch scan timeout.
 * @escan_timeout_work: scan timeout worker.
 * @disconnect_mode: indicates type of disconnect requested (BRCMF_DISCONNECT_*)
 * @disconnect_timeout: timer for disconnection completion.
 * @disconnect_timeout_work: associated work structure for disassociation timer.
 * @vif_list: linked list of vif instances.
 * @vif_cnt: number of vif instances.
 * @vif_event: vif event signalling.
 * @vif_event_pending_action: If vif_event is set, this is what it's waiting for.
 * @wowl: wowl related information.
 * @pno: information of pno module.
 */
struct brcmf_cfg80211_info {
    struct wiphy* wiphy;
    struct cfg80211_ops* ops;
    struct brcmf_cfg80211_conf* conf;
    struct brcmf_p2p_info p2p;
    struct brcmf_btcoex_info* btcoex;
    wlanif_scan_req_t* scan_request;
    mtx_t usr_sync;
    struct wl_cfg80211_bss_info* bss_info;
    struct brcmf_cfg80211_connect_info conn_info;
    struct brcmf_pmk_list_le pmk_list;
    atomic_ulong scan_status;
    struct brcmf_pub* pub;
    uint32_t channel;
    uint32_t int_escan_map;
    bool ibss_starter;
    bool pwr_save;
    bool dongle_up;
    bool scan_tried;
    uint8_t* dcmd_buf;
    uint8_t* extra_buf;
    zx_handle_t debugfsdir;
    struct escan_info escan_info;
    brcmf_timer_info_t escan_timeout;
    struct work_struct escan_timeout_work;
    uint8_t disconnect_mode;
    brcmf_timer_info_t disconnect_timeout;
    struct work_struct disconnect_timeout_work;
    struct list_node vif_list;
    struct brcmf_cfg80211_vif_event vif_event;
    uint8_t vif_event_pending_action;
    sync_completion_t vif_disabled;
    struct brcmu_d11inf d11inf;
    struct brcmf_assoclist_le assoclist;
    struct brcmf_cfg80211_wowl wowl;
    struct brcmf_pno_info* pno;
};

/**
 * struct brcmf_tlv - tag_ID/length/value_buffer tuple.
 *
 * @id: tag identifier.
 * @len: number of bytes in value buffer.
 * @data: value buffer.
 */
struct brcmf_tlv {
    uint8_t id;
    uint8_t len;
    uint8_t data[1];
};

static inline struct wiphy* cfg_to_wiphy(struct brcmf_cfg80211_info* cfg) {
    return cfg->wiphy;
}

static inline struct brcmf_cfg80211_info* wiphy_to_cfg(struct wiphy* w) {
    return w->cfg80211_info;
}

static inline struct brcmf_cfg80211_info* wdev_to_cfg(struct wireless_dev* wd) {
    return wd->cfg80211_info;
}

static inline struct net_device* cfg_to_ndev(struct brcmf_cfg80211_info* cfg) {
    struct brcmf_cfg80211_vif* vif;
    vif = list_peek_head_type(&cfg->vif_list, struct brcmf_cfg80211_vif, list);
    return vif->wdev.netdev;
}

static inline struct brcmf_cfg80211_info* ndev_to_cfg(struct net_device* ndev) {
    return wdev_to_cfg(ndev->ieee80211_ptr);
}

static inline struct wiphy* ndev_to_wiphy(struct net_device* ndev) {
    return ndev->ieee80211_ptr->wiphy;
}

static inline struct net_device* wiphy_to_ndev(struct wiphy* wiphy) {
    return cfg_to_ndev(wiphy_to_cfg(wiphy));
}

static inline struct brcmf_if* ndev_to_if(struct net_device* ndev) {
    return ndev->priv;
}

static inline struct brcmf_if* cfg_to_if(struct brcmf_cfg80211_info* cfg) {
    return cfg_to_ndev(cfg)->priv;
}

static inline struct brcmf_cfg80211_vif* ndev_to_vif(struct net_device* ndev) {
    return ndev_to_if(ndev)->vif;
}

static inline struct wireless_dev* ndev_to_wdev(struct net_device* ndev) {
    return &ndev_to_vif(ndev)->wdev;
}

static inline struct brcmf_cfg80211_profile* ndev_to_prof(struct net_device* ndev) {
    return &ndev_to_vif(ndev)->profile;
}

static inline struct brcmf_cfg80211_connect_info* cfg_to_conn(struct brcmf_cfg80211_info* cfg) {
    return &cfg->conn_info;
}

struct brcmf_cfg80211_info* brcmf_cfg80211_attach(struct brcmf_pub* drvr,
                                                  struct brcmf_device* busdev,
                                                  bool p2pdev_forced);
void brcmf_cfg80211_detach(struct brcmf_cfg80211_info* cfg);
zx_status_t brcmf_cfg80211_up(struct net_device* ndev);
zx_status_t brcmf_cfg80211_down(struct net_device* ndev);
uint16_t brcmf_cfg80211_get_iftype(struct brcmf_if* ifp);

zx_status_t brcmf_alloc_vif(struct brcmf_cfg80211_info* cfg, uint16_t type,
                            struct brcmf_cfg80211_vif** vif_out);
void brcmf_free_vif(struct brcmf_cfg80211_vif* vif);

zx_status_t brcmf_vif_set_mgmt_ie(struct brcmf_cfg80211_vif* vif, int32_t pktflag,
                                  const uint8_t* vndr_ie_buf, uint32_t vndr_ie_len);
zx_status_t brcmf_vif_clear_mgmt_ies(struct brcmf_cfg80211_vif* vif);
uint16_t channel_to_chanspec(struct brcmu_d11inf* d11inf, wlan_channel_t* ch);
bool brcmf_get_vif_state_any(struct brcmf_cfg80211_info* cfg, unsigned long state);
void brcmf_cfg80211_arm_vif_event(struct brcmf_cfg80211_info* cfg, struct brcmf_cfg80211_vif* vif,
                                  uint8_t pending_action);
void brcmf_cfg80211_disarm_vif_event(struct brcmf_cfg80211_info* cfg);
bool brcmf_cfg80211_vif_event_armed(struct brcmf_cfg80211_info* cfg);
zx_status_t brcmf_cfg80211_wait_vif_event(struct brcmf_cfg80211_info* cfg, zx_duration_t timeout);
zx_status_t brcmf_notify_escan_complete(struct brcmf_cfg80211_info* cfg, struct brcmf_if* ifp,
                                        bool aborted, bool fw_abort);
void brcmf_set_mpc(struct brcmf_if* ndev, int mpc);
void brcmf_abort_scanning(struct brcmf_cfg80211_info* cfg);
void brcmf_free_net_device_vif(struct net_device* ndev);

zx_status_t brcmf_phy_create_iface(void* ctx, uint16_t role, uint16_t* iface_id);
void brcmf_cfg80211_rx(struct brcmf_if* ifp, struct brcmf_netbuf* packet);

// TODO: Move to core.h
zx_status_t brcmf_netdev_open(struct net_device* ndev);

#endif /* BRCMFMAC_CFG80211_H */