xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/microchip/wilc1000/hif.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2012 - 2018 Microchip Technology Inc., and its subsidiaries
4*4882a593Smuzhiyun  * All rights reserved.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #ifndef WILC_HIF_H
8*4882a593Smuzhiyun #define WILC_HIF_H
9*4882a593Smuzhiyun #include <linux/ieee80211.h>
10*4882a593Smuzhiyun #include "wlan_if.h"
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun enum {
13*4882a593Smuzhiyun 	WILC_IDLE_MODE = 0x0,
14*4882a593Smuzhiyun 	WILC_AP_MODE = 0x1,
15*4882a593Smuzhiyun 	WILC_STATION_MODE = 0x2,
16*4882a593Smuzhiyun 	WILC_GO_MODE = 0x3,
17*4882a593Smuzhiyun 	WILC_CLIENT_MODE = 0x4
18*4882a593Smuzhiyun };
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define WILC_MAX_NUM_PROBED_SSID		10
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define WILC_TX_MIC_KEY_LEN			8
23*4882a593Smuzhiyun #define WILC_RX_MIC_KEY_LEN			8
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #define WILC_ADD_STA_LENGTH			40
26*4882a593Smuzhiyun #define WILC_NUM_CONCURRENT_IFC			2
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun enum {
29*4882a593Smuzhiyun 	WILC_SET_CFG = 0,
30*4882a593Smuzhiyun 	WILC_GET_CFG
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define WILC_MAX_ASSOC_RESP_FRAME_SIZE   256
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun struct rf_info {
36*4882a593Smuzhiyun 	u8 link_speed;
37*4882a593Smuzhiyun 	s8 rssi;
38*4882a593Smuzhiyun 	u32 tx_cnt;
39*4882a593Smuzhiyun 	u32 rx_cnt;
40*4882a593Smuzhiyun 	u32 tx_fail_cnt;
41*4882a593Smuzhiyun };
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun enum host_if_state {
44*4882a593Smuzhiyun 	HOST_IF_IDLE			= 0,
45*4882a593Smuzhiyun 	HOST_IF_SCANNING		= 1,
46*4882a593Smuzhiyun 	HOST_IF_CONNECTING		= 2,
47*4882a593Smuzhiyun 	HOST_IF_WAITING_CONN_RESP	= 3,
48*4882a593Smuzhiyun 	HOST_IF_CONNECTED		= 4,
49*4882a593Smuzhiyun 	HOST_IF_P2P_LISTEN		= 5,
50*4882a593Smuzhiyun 	HOST_IF_FORCE_32BIT		= 0xFFFFFFFF
51*4882a593Smuzhiyun };
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun struct cfg_param_attr {
54*4882a593Smuzhiyun 	u32 flag;
55*4882a593Smuzhiyun 	u16 short_retry_limit;
56*4882a593Smuzhiyun 	u16 long_retry_limit;
57*4882a593Smuzhiyun 	u16 frag_threshold;
58*4882a593Smuzhiyun 	u16 rts_threshold;
59*4882a593Smuzhiyun };
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun enum cfg_param {
62*4882a593Smuzhiyun 	WILC_CFG_PARAM_RETRY_SHORT = BIT(0),
63*4882a593Smuzhiyun 	WILC_CFG_PARAM_RETRY_LONG = BIT(1),
64*4882a593Smuzhiyun 	WILC_CFG_PARAM_FRAG_THRESHOLD = BIT(2),
65*4882a593Smuzhiyun 	WILC_CFG_PARAM_RTS_THRESHOLD = BIT(3)
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun enum scan_event {
69*4882a593Smuzhiyun 	SCAN_EVENT_NETWORK_FOUND	= 0,
70*4882a593Smuzhiyun 	SCAN_EVENT_DONE			= 1,
71*4882a593Smuzhiyun 	SCAN_EVENT_ABORTED		= 2,
72*4882a593Smuzhiyun 	SCAN_EVENT_FORCE_32BIT		= 0xFFFFFFFF
73*4882a593Smuzhiyun };
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun enum conn_event {
76*4882a593Smuzhiyun 	CONN_DISCONN_EVENT_CONN_RESP		= 0,
77*4882a593Smuzhiyun 	CONN_DISCONN_EVENT_DISCONN_NOTIF	= 1,
78*4882a593Smuzhiyun 	CONN_DISCONN_EVENT_FORCE_32BIT		= 0xFFFFFFFF
79*4882a593Smuzhiyun };
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun enum {
82*4882a593Smuzhiyun 	WILC_HIF_SDIO = 0,
83*4882a593Smuzhiyun 	WILC_HIF_SPI = BIT(0)
84*4882a593Smuzhiyun };
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun enum {
87*4882a593Smuzhiyun 	WILC_MAC_STATUS_INIT = -1,
88*4882a593Smuzhiyun 	WILC_MAC_STATUS_DISCONNECTED = 0,
89*4882a593Smuzhiyun 	WILC_MAC_STATUS_CONNECTED = 1
90*4882a593Smuzhiyun };
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun struct wilc_rcvd_net_info {
93*4882a593Smuzhiyun 	s8 rssi;
94*4882a593Smuzhiyun 	u8 ch;
95*4882a593Smuzhiyun 	u16 frame_len;
96*4882a593Smuzhiyun 	struct ieee80211_mgmt *mgmt;
97*4882a593Smuzhiyun };
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun struct wilc_user_scan_req {
100*4882a593Smuzhiyun 	void (*scan_result)(enum scan_event evt,
101*4882a593Smuzhiyun 			    struct wilc_rcvd_net_info *info, void *priv);
102*4882a593Smuzhiyun 	void *arg;
103*4882a593Smuzhiyun 	u32 ch_cnt;
104*4882a593Smuzhiyun };
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun struct wilc_conn_info {
107*4882a593Smuzhiyun 	u8 bssid[ETH_ALEN];
108*4882a593Smuzhiyun 	u8 security;
109*4882a593Smuzhiyun 	enum authtype auth_type;
110*4882a593Smuzhiyun 	u8 ch;
111*4882a593Smuzhiyun 	u8 *req_ies;
112*4882a593Smuzhiyun 	size_t req_ies_len;
113*4882a593Smuzhiyun 	u8 *resp_ies;
114*4882a593Smuzhiyun 	u16 resp_ies_len;
115*4882a593Smuzhiyun 	u16 status;
116*4882a593Smuzhiyun 	void (*conn_result)(enum conn_event evt, u8 status, void *priv_data);
117*4882a593Smuzhiyun 	void *arg;
118*4882a593Smuzhiyun 	void *param;
119*4882a593Smuzhiyun };
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun struct wilc_remain_ch {
122*4882a593Smuzhiyun 	u16 ch;
123*4882a593Smuzhiyun 	u32 duration;
124*4882a593Smuzhiyun 	void (*expired)(void *priv, u64 cookie);
125*4882a593Smuzhiyun 	void *arg;
126*4882a593Smuzhiyun 	u32 cookie;
127*4882a593Smuzhiyun };
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun struct wilc;
130*4882a593Smuzhiyun struct host_if_drv {
131*4882a593Smuzhiyun 	struct wilc_user_scan_req usr_scan_req;
132*4882a593Smuzhiyun 	struct wilc_conn_info conn_info;
133*4882a593Smuzhiyun 	struct wilc_remain_ch remain_on_ch;
134*4882a593Smuzhiyun 	u64 p2p_timeout;
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	enum host_if_state hif_state;
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	u8 assoc_bssid[ETH_ALEN];
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	struct timer_list scan_timer;
141*4882a593Smuzhiyun 	struct wilc_vif *scan_timer_vif;
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	struct timer_list connect_timer;
144*4882a593Smuzhiyun 	struct wilc_vif *connect_timer_vif;
145*4882a593Smuzhiyun 
146*4882a593Smuzhiyun 	struct timer_list remain_on_ch_timer;
147*4882a593Smuzhiyun 	struct wilc_vif *remain_on_ch_timer_vif;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	bool ifc_up;
150*4882a593Smuzhiyun 	u8 assoc_resp[WILC_MAX_ASSOC_RESP_FRAME_SIZE];
151*4882a593Smuzhiyun };
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun struct wilc_vif;
154*4882a593Smuzhiyun int wilc_remove_wep_key(struct wilc_vif *vif, u8 index);
155*4882a593Smuzhiyun int wilc_set_wep_default_keyid(struct wilc_vif *vif, u8 index);
156*4882a593Smuzhiyun int wilc_add_wep_key_bss_sta(struct wilc_vif *vif, const u8 *key, u8 len,
157*4882a593Smuzhiyun 			     u8 index);
158*4882a593Smuzhiyun int wilc_add_wep_key_bss_ap(struct wilc_vif *vif, const u8 *key, u8 len,
159*4882a593Smuzhiyun 			    u8 index, u8 mode, enum authtype auth_type);
160*4882a593Smuzhiyun int wilc_add_ptk(struct wilc_vif *vif, const u8 *ptk, u8 ptk_key_len,
161*4882a593Smuzhiyun 		 const u8 *mac_addr, const u8 *rx_mic, const u8 *tx_mic,
162*4882a593Smuzhiyun 		 u8 mode, u8 cipher_mode, u8 index);
163*4882a593Smuzhiyun s32 wilc_get_inactive_time(struct wilc_vif *vif, const u8 *mac,
164*4882a593Smuzhiyun 			   u32 *out_val);
165*4882a593Smuzhiyun int wilc_add_rx_gtk(struct wilc_vif *vif, const u8 *rx_gtk, u8 gtk_key_len,
166*4882a593Smuzhiyun 		    u8 index, u32 key_rsc_len, const u8 *key_rsc,
167*4882a593Smuzhiyun 		    const u8 *rx_mic, const u8 *tx_mic, u8 mode,
168*4882a593Smuzhiyun 		    u8 cipher_mode);
169*4882a593Smuzhiyun int wilc_set_pmkid_info(struct wilc_vif *vif, struct wilc_pmkid_attr *pmkid);
170*4882a593Smuzhiyun int wilc_get_mac_address(struct wilc_vif *vif, u8 *mac_addr);
171*4882a593Smuzhiyun int wilc_set_join_req(struct wilc_vif *vif, u8 *bssid, const u8 *ies,
172*4882a593Smuzhiyun 		      size_t ies_len);
173*4882a593Smuzhiyun int wilc_disconnect(struct wilc_vif *vif);
174*4882a593Smuzhiyun int wilc_set_mac_chnl_num(struct wilc_vif *vif, u8 channel);
175*4882a593Smuzhiyun int wilc_get_rssi(struct wilc_vif *vif, s8 *rssi_level);
176*4882a593Smuzhiyun int wilc_scan(struct wilc_vif *vif, u8 scan_source, u8 scan_type,
177*4882a593Smuzhiyun 	      u8 *ch_freq_list, u8 ch_list_len,
178*4882a593Smuzhiyun 	      void (*scan_result_fn)(enum scan_event,
179*4882a593Smuzhiyun 				     struct wilc_rcvd_net_info *, void *),
180*4882a593Smuzhiyun 	      void *user_arg, struct cfg80211_scan_request *request);
181*4882a593Smuzhiyun int wilc_hif_set_cfg(struct wilc_vif *vif,
182*4882a593Smuzhiyun 		     struct cfg_param_attr *cfg_param);
183*4882a593Smuzhiyun int wilc_init(struct net_device *dev, struct host_if_drv **hif_drv_handler);
184*4882a593Smuzhiyun int wilc_deinit(struct wilc_vif *vif);
185*4882a593Smuzhiyun int wilc_add_beacon(struct wilc_vif *vif, u32 interval, u32 dtim_period,
186*4882a593Smuzhiyun 		    struct cfg80211_beacon_data *params);
187*4882a593Smuzhiyun int wilc_del_beacon(struct wilc_vif *vif);
188*4882a593Smuzhiyun int wilc_add_station(struct wilc_vif *vif, const u8 *mac,
189*4882a593Smuzhiyun 		     struct station_parameters *params);
190*4882a593Smuzhiyun int wilc_del_allstation(struct wilc_vif *vif, u8 mac_addr[][ETH_ALEN]);
191*4882a593Smuzhiyun int wilc_del_station(struct wilc_vif *vif, const u8 *mac_addr);
192*4882a593Smuzhiyun int wilc_edit_station(struct wilc_vif *vif, const u8 *mac,
193*4882a593Smuzhiyun 		      struct station_parameters *params);
194*4882a593Smuzhiyun int wilc_set_power_mgmt(struct wilc_vif *vif, bool enabled, u32 timeout);
195*4882a593Smuzhiyun int wilc_setup_multicast_filter(struct wilc_vif *vif, u32 enabled, u32 count,
196*4882a593Smuzhiyun 				u8 *mc_list);
197*4882a593Smuzhiyun int wilc_remain_on_channel(struct wilc_vif *vif, u64 cookie,
198*4882a593Smuzhiyun 			   u32 duration, u16 chan,
199*4882a593Smuzhiyun 			   void (*expired)(void *, u64),
200*4882a593Smuzhiyun 			   void *user_arg);
201*4882a593Smuzhiyun int wilc_listen_state_expired(struct wilc_vif *vif, u64 cookie);
202*4882a593Smuzhiyun void wilc_frame_register(struct wilc_vif *vif, u16 frame_type, bool reg);
203*4882a593Smuzhiyun int wilc_set_operation_mode(struct wilc_vif *vif, int index, u8 mode,
204*4882a593Smuzhiyun 			    u8 ifc_id);
205*4882a593Smuzhiyun int wilc_get_statistics(struct wilc_vif *vif, struct rf_info *stats);
206*4882a593Smuzhiyun int wilc_get_vif_idx(struct wilc_vif *vif);
207*4882a593Smuzhiyun int wilc_set_tx_power(struct wilc_vif *vif, u8 tx_power);
208*4882a593Smuzhiyun int wilc_get_tx_power(struct wilc_vif *vif, u8 *tx_power);
209*4882a593Smuzhiyun void wilc_scan_complete_received(struct wilc *wilc, u8 *buffer, u32 length);
210*4882a593Smuzhiyun void wilc_network_info_received(struct wilc *wilc, u8 *buffer, u32 length);
211*4882a593Smuzhiyun void wilc_gnrl_async_info_received(struct wilc *wilc, u8 *buffer, u32 length);
212*4882a593Smuzhiyun void *wilc_parse_join_bss_param(struct cfg80211_bss *bss,
213*4882a593Smuzhiyun 				struct cfg80211_crypto_settings *crypto);
214*4882a593Smuzhiyun #endif
215