text: // SPDX-License-Identifier: ISC
  /*
   * Copyright (c) 2010 Broadcom Corporation
   */
  
  #ifndef BRCMFMAC_CFG80211_H
  #define BRCMFMAC_CFG80211_H
  
  /* for brcmu_d11inf */
  #include <brcmu_d11.h>
  
  #include "core.h"
  #include "fwil_types.h"
  #include "p2p.h"
  
  #define BRCMF_SCAN_IE_LEN_MAX		2048
  
  #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 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
  
  #define BRCMF_VIF_EVENT_TIMEOUT		msecs_to_jiffies(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 {
  	u32 frag_threshold;
  	u32 rts_threshold;
  	u32 retry_short;
  	u32 retry_long;
  };
  
  /* security information with currently associated ap */
  struct brcmf_cfg80211_security {
  	u32 wpa_versions;
  	u32 auth_type;
  	u32 cipher_pairwise;
  	u32 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
   */
  struct brcmf_cfg80211_profile {
  	u8 bssid[ETH_ALEN];
  	struct brcmf_cfg80211_security sec;
  	struct brcmf_wsec_key key[BRCMF_MAX_DEFAULT_KEYS];
  	enum brcmf_profile_fwsup use_fwsup;
  };
  
  /**
   * 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 {
  	u8  probe_req_ie[IE_MAX_LEN];
  	u8  probe_res_ie[IE_MAX_LEN];
  	u8  beacon_ie[IE_MAX_LEN];
  	u8  assoc_req_ie[IE_MAX_LEN];
  	u32 probe_req_ie_len;
  	u32 probe_res_ie_len;
  	u32 beacon_ie_len;
  	u32 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;
  	unsigned long sme_state;
  	struct vif_saved_ie saved_ie;
  	struct list_head list;
  	u16 mgmt_rx_reg;
  	bool mbss;
  	int is_11d;
  };
  
  /* association inform */
  struct brcmf_cfg80211_connect_info {
  	u8 *req_ie;
  	s32 req_ie_len;
  	u8 *resp_ie;
  	s32 resp_ie_len;
  };
  
  /* assoc ie length */
  struct brcmf_cfg80211_assoc_ielen_le {
  	__le32 req_len;
  	__le32 resp_len;
  };
  
  /* dongle escan state */
  enum wl_escan_state {
  	WL_ESCAN_STATE_IDLE,
  	WL_ESCAN_STATE_SCANNING
  };
  
  struct escan_info {
  	u32 escan_state;
  	u8 *escan_buf;
  	struct wiphy *wiphy;
  	struct brcmf_if *ifp;
  	s32 (*run)(struct brcmf_cfg80211_info *cfg, struct brcmf_if *ifp,
  		   struct cfg80211_scan_request *request);
  };
  
  /**
   * struct brcmf_cfg80211_vif_event - virtual interface event information.
   *
   * @vif_wq: waitqueue awaiting interface event from firmware.
   * @vif_event_lock: protects other members in this structure.
   * @vif_complete: completion for net attach.
   * @action: either add, change, or delete.
   * @vif: virtual interface object related to the event.
   */
  struct brcmf_cfg80211_vif_event {
  	wait_queue_head_t vif_wq;
  	spinlock_t vif_event_lock;
  	u8 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: wait queue to sync net detect data.
   * @nd_data_completed: completion for net detect data.
   * @nd_enabled: net detect enabled.
   */
  struct brcmf_cfg80211_wowl {
  	bool active;
  	u32 pre_pmmode;
  	struct cfg80211_wowlan_nd_match *nd;
  	struct cfg80211_wowlan_nd_info *nd_info;
  	wait_queue_head_t nd_data_wait;
  	bool nd_data_completed;
  	bool nd_enabled;
  };
  
  /**
   * 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.
   * @vif_list: linked list of vif instances.
   * @vif_cnt: number of vif instances.
   * @vif_event: vif event signalling.
   * @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;
  	struct cfg80211_scan_request *scan_request;
  	struct mutex usr_sync;
  	struct wl_cfg80211_bss_info *bss_info;
  	struct brcmf_cfg80211_connect_info conn_info;
  	struct brcmf_pmk_list_le pmk_list;
  	unsigned long scan_status;
  	struct brcmf_pub *pub;
  	u32 channel;
  	u32 int_escan_map;
  	bool ibss_starter;
  	bool pwr_save;
  	bool dongle_up;
  	bool scan_tried;
  	u8 *dcmd_buf;
  	u8 *extra_buf;
  	struct dentry *debugfsdir;
  	struct escan_info escan_info;
  	struct timer_list escan_timeout;
  	struct work_struct escan_timeout_work;
  	struct list_head vif_list;
  	struct brcmf_cfg80211_vif_event vif_event;
  	struct completion 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 {
  	u8 id;
  	u8 len;
  	u8 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)
  {
  	struct brcmf_pub *drvr = wiphy_priv(w);
  	return drvr->config;
  }
  
  static inline struct brcmf_cfg80211_info *wdev_to_cfg(struct wireless_dev *wd)
  {
  	return wiphy_to_cfg(wd->wiphy);
  }
  
  static inline struct brcmf_cfg80211_vif *wdev_to_vif(struct wireless_dev *wdev)
  {
  	return container_of(wdev, struct brcmf_cfg80211_vif, wdev);
  }
  
  static inline
  struct net_device *cfg_to_ndev(struct brcmf_cfg80211_info *cfg)
  {
  	return brcmf_get_ifp(cfg->pub, 0)->ndev;
  }
  
  static inline struct brcmf_cfg80211_info *ndev_to_cfg(struct net_device *ndev)
  {
  	return wdev_to_cfg(ndev->ieee80211_ptr);
  }
  
  static inline struct brcmf_cfg80211_profile *ndev_to_prof(struct net_device *nd)
  {
  	struct brcmf_if *ifp = netdev_priv(nd);
  	return &ifp->vif->profile;
  }
  
  static inline struct brcmf_cfg80211_vif *ndev_to_vif(struct net_device *ndev)
  {
  	struct brcmf_if *ifp = netdev_priv(ndev);
  	return ifp->vif;
  }
  
  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 cfg80211_ops *ops,
  						  bool p2pdev_forced);
  void brcmf_cfg80211_detach(struct brcmf_cfg80211_info *cfg);
  s32 brcmf_cfg80211_up(struct net_device *ndev);
  s32 brcmf_cfg80211_down(struct net_device *ndev);
  struct cfg80211_ops *brcmf_cfg80211_get_ops(struct brcmf_mp_device *settings);
  enum nl80211_iftype brcmf_cfg80211_get_iftype(struct brcmf_if *ifp);
  
  struct brcmf_cfg80211_vif *brcmf_alloc_vif(struct brcmf_cfg80211_info *cfg,
  					   enum nl80211_iftype type);
  void brcmf_free_vif(struct brcmf_cfg80211_vif *vif);
  
  s32 brcmf_vif_set_mgmt_ie(struct brcmf_cfg80211_vif *vif, s32 pktflag,
  			  const u8 *vndr_ie_buf, u32 vndr_ie_len);
  s32 brcmf_vif_clear_mgmt_ies(struct brcmf_cfg80211_vif *vif);
  u16 channel_to_chanspec(struct brcmu_d11inf *d11inf,
  			struct ieee80211_channel *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);
  bool brcmf_cfg80211_vif_event_armed(struct brcmf_cfg80211_info *cfg);
  int brcmf_cfg80211_wait_vif_event(struct brcmf_cfg80211_info *cfg,
  				  u8 action, ulong timeout);
  s32 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_cfg80211_free_netdev(struct net_device *ndev);
  
  #endif /* BRCMFMAC_CFG80211_H */
  