android_kernel_modules_leno.../wlan/PRIVATE/bcm43xx/src/dhd_pno.h

251 lines
7.2 KiB
C

/*
* Header file of Broadcom Dongle Host Driver (DHD)
* Prefered Network Offload code and Wi-Fi Location Service(WLS) code.
* Copyright (C) 1999-2013, Broadcom Corporation
*
* Unless you and Broadcom execute a separate written software license
* agreement governing use of this software, this software is licensed to you
* under the terms of the GNU General Public License version 2 (the "GPL"),
* available at http://www.broadcom.com/licenses/GPLv2.php, with the
* following added to such license:
*
* As a special exception, the copyright holders of this software give you
* permission to link this software with independent modules, and to copy and
* distribute the resulting executable under terms of your choice, provided that
* you also meet, for each linked independent module, the terms and conditions of
* the license of that module. An independent module is a module which is not
* derived from this software. The special exception does not apply to any
* modifications of the software.
*
* Notwithstanding the above, under no circumstances may you combine this
* software in any way with any other Broadcom software provided under a license
* other than the GPL, without Broadcom's express prior written consent.
*
* $Id: dhd_pno.h 419969 2013-08-23 18:54:36Z $
*/
#ifndef __DHD_PNO_H__
#define __DHD_PNO_H__
#define PNO_TLV_PREFIX 'S'
#define PNO_TLV_VERSION '1'
#define PNO_TLV_SUBTYPE_LEGACY_PNO '2'
#define PNO_TLV_RESERVED '0'
#define PNO_BATCHING_SET "SET"
#define PNO_BATCHING_GET "GET"
#define PNO_BATCHING_STOP "STOP"
#define PNO_PARAMS_DELIMETER " "
#define PNO_PARAM_CHANNEL_DELIMETER ","
#define PNO_PARAM_VALUE_DELLIMETER '='
#define PNO_PARAM_SCANFREQ "SCANFREQ"
#define PNO_PARAM_BESTN "BESTN"
#define PNO_PARAM_MSCAN "MSCAN"
#define PNO_PARAM_CHANNEL "CHANNEL"
#define PNO_PARAM_RTT "RTT"
#define PNO_TLV_TYPE_SSID_IE 'S'
#define PNO_TLV_TYPE_TIME 'T'
#define PNO_TLV_FREQ_REPEAT 'R'
#define PNO_TLV_FREQ_EXPO_MAX 'M'
#define MAXNUM_SSID_PER_ADD 16
#define MAXNUM_PNO_PARAMS 2
#define PNO_TLV_COMMON_LENGTH 1
#define DEFAULT_BATCH_MSCAN 16
#define RESULTS_END_MARKER "----\n"
#define SCAN_END_MARKER "####\n"
#define AP_END_MARKER "====\n"
enum scan_status {
/* SCAN ABORT by other scan */
PNO_STATUS_ABORT,
/* RTT is presence or not */
PNO_STATUS_RTT_PRESENCE,
/* Disable PNO by Driver */
PNO_STATUS_DISABLE,
/* NORMAL BATCHING GET */
PNO_STATUS_NORMAL,
/* WLC_E_PFN_BEST_BATCHING */
PNO_STATUS_EVENT,
PNO_STATUS_MAX
};
#define PNO_STATUS_ABORT_MASK 0x0001
#define PNO_STATUS_RTT_MASK 0x0002
#define PNO_STATUS_DISABLE_MASK 0x0004
#define PNO_STATUS_OOM_MASK 0x0010
enum index_mode {
INDEX_OF_LEGACY_PARAMS,
INDEX_OF_BATCH_PARAMS,
INDEX_OF_HOTLIST_PARAMS,
INDEX_MODE_MAX
};
enum dhd_pno_status {
DHD_PNO_DISABLED,
DHD_PNO_ENABLED,
DHD_PNO_SUSPEND
};
typedef struct cmd_tlv {
char prefix;
char version;
char subtype;
char reserved;
} cmd_tlv_t;
typedef enum dhd_pno_mode {
/* Wi-Fi Legacy PNO Mode */
DHD_PNO_NONE_MODE = 0,
DHD_PNO_LEGACY_MODE = (1 << (0)),
/* Wi-Fi Android BATCH SCAN Mode */
DHD_PNO_BATCH_MODE = (1 << (1)),
/* Wi-Fi Android Hotlist SCAN Mode */
DHD_PNO_HOTLIST_MODE = (1 << (2))
} dhd_pno_mode_t;
struct dhd_pno_ssid {
uint32 SSID_len;
uchar SSID[DOT11_MAX_SSID_LEN];
struct list_head list;
};
struct dhd_pno_bssid {
struct ether_addr macaddr;
/* Bit4: suppress_lost, Bit3: suppress_found */
uint16 flags;
struct list_head list;
};
typedef struct dhd_pno_bestnet_entry {
struct ether_addr BSSID;
uint8 SSID_len;
uint8 SSID[DOT11_MAX_SSID_LEN];
int8 RSSI;
uint8 channel;
uint32 timestamp;
uint16 rtt0; /* distance_cm based on RTT */
uint16 rtt1; /* distance_cm based on sample standard deviation */
unsigned long recorded_time;
struct list_head list;
} dhd_pno_bestnet_entry_t;
#define BESTNET_ENTRY_SIZE (sizeof(dhd_pno_bestnet_entry_t))
typedef struct dhd_pno_bestnet_header {
struct dhd_pno_bestnet_header *next;
uint8 reason;
uint32 tot_cnt;
uint32 tot_size;
struct list_head entry_list;
} dhd_pno_best_header_t;
#define BEST_HEADER_SIZE (sizeof(dhd_pno_best_header_t))
typedef struct dhd_pno_scan_results {
dhd_pno_best_header_t *bestnetheader;
uint8 cnt_header;
struct list_head list;
} dhd_pno_scan_results_t;
#define SCAN_RESULTS_SIZE (sizeof(dhd_pno_scan_results_t))
struct dhd_pno_get_batch_info {
/* info related to get batch */
char *buf;
bool batch_started;
uint32 tot_scan_cnt;
uint32 expired_tot_scan_cnt;
uint32 top_node_cnt;
uint32 bufsize;
uint32 bytes_written;
int reason;
struct list_head scan_results_list;
struct list_head expired_scan_results_list;
};
struct dhd_pno_legacy_params {
uint16 scan_fr;
uint16 chan_list[WL_NUMCHANNELS];
uint16 nchan;
int pno_repeat;
int pno_freq_expo_max;
int nssid;
struct list_head ssid_list;
};
struct dhd_pno_batch_params {
int32 scan_fr;
uint8 bestn;
uint8 mscan;
uint8 band;
uint16 chan_list[WL_NUMCHANNELS];
uint16 nchan;
uint16 rtt;
struct dhd_pno_get_batch_info get_batch;
};
struct dhd_pno_hotlist_params {
uint8 band;
int32 scan_fr;
uint16 chan_list[WL_NUMCHANNELS];
uint16 nchan;
uint16 nbssid;
struct list_head bssid_list;
};
typedef union dhd_pno_params {
struct dhd_pno_legacy_params params_legacy;
struct dhd_pno_batch_params params_batch;
struct dhd_pno_hotlist_params params_hotlist;
} dhd_pno_params_t;
typedef struct dhd_pno_status_info {
dhd_pub_t *dhd;
struct work_struct work;
struct mutex pno_mutex;
struct completion get_batch_done;
bool wls_supported; /* wifi location service supported or not */
enum dhd_pno_status pno_status;
enum dhd_pno_mode pno_mode;
dhd_pno_params_t pno_params_arr[INDEX_MODE_MAX];
struct list_head head_list;
} dhd_pno_status_info_t;
/* wrapper functions */
extern int
dhd_dev_pno_enable(struct net_device *dev, int enable);
extern int
dhd_dev_pno_stop_for_ssid(struct net_device *dev);
extern int
dhd_dev_pno_set_for_ssid(struct net_device *dev, wlc_ssid_t* ssids_local, int nssid,
uint16 scan_fr, int pno_repeat, int pno_freq_expo_max, uint16 *channel_list, int nchan);
extern int
dhd_dev_pno_set_for_batch(struct net_device *dev,
struct dhd_pno_batch_params *batch_params);
extern int
dhd_dev_pno_get_for_batch(struct net_device *dev, char *buf, int bufsize);
extern int
dhd_dev_pno_stop_for_batch(struct net_device *dev);
extern int
dhd_dev_pno_set_for_hotlist(struct net_device *dev, wl_pfn_bssid_t *p_pfn_bssid,
struct dhd_pno_hotlist_params *hotlist_params);
/* dhd pno fuctions */
extern int dhd_pno_stop_for_ssid(dhd_pub_t *dhd);
extern int dhd_pno_enable(dhd_pub_t *dhd, int enable);
extern int dhd_pno_set_for_ssid(dhd_pub_t *dhd, wlc_ssid_t* ssid_list, int nssid,
uint16 scan_fr, int pno_repeat, int pno_freq_expo_max, uint16 *channel_list, int nchan);
extern int dhd_pno_set_for_batch(dhd_pub_t *dhd, struct dhd_pno_batch_params *batch_params);
extern int dhd_pno_get_for_batch(dhd_pub_t *dhd, char *buf, int bufsize, int reason);
extern int dhd_pno_stop_for_batch(dhd_pub_t *dhd);
extern int dhd_pno_set_for_hotlist(dhd_pub_t *dhd, wl_pfn_bssid_t *p_pfn_bssid,
struct dhd_pno_hotlist_params *hotlist_params);
extern int dhd_pno_stop_for_hotlist(dhd_pub_t *dhd);
extern int dhd_pno_event_handler(dhd_pub_t *dhd, wl_event_msg_t *event, void *event_data);
extern int dhd_pno_init(dhd_pub_t *dhd);
extern int dhd_pno_deinit(dhd_pub_t *dhd);
#endif /* __DHD_PNO_H__ */