1 /******************************************************************************
2 *
3 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License as
7 * published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17 *
18 *
19 ******************************************************************************/
20 #ifndef __RTW_PWRCTRL_H_
21 #define __RTW_PWRCTRL_H_
22
23
24 #define FW_PWR0 0
25 #define FW_PWR1 1
26 #define FW_PWR2 2
27 #define FW_PWR3 3
28
29
30 #define HW_PWR0 7
31 #define HW_PWR1 6
32 #define HW_PWR2 2
33 #define HW_PWR3 0
34 #define HW_PWR4 8
35
36 #define FW_PWRMSK 0x7
37
38
39 #define XMIT_ALIVE BIT(0)
40 #define RECV_ALIVE BIT(1)
41 #define CMD_ALIVE BIT(2)
42 #define EVT_ALIVE BIT(3)
43 #ifdef CONFIG_BT_COEXIST
44 #define BTCOEX_ALIVE BIT(4)
45 #endif // CONFIG_BT_COEXIST
46
47 #ifdef CONFIG_WOWLAN
48 #define MAX_WKFM_NUM 16 /* Frame Mask Cam number for pattern match */
49 #define MAX_WKFM_SIZE 16 /* (16 bytes for WKFM bit mask, 16*8 = 128 bits) */
50 #define MAX_WKFM_PATTERN_SIZE 128
51 #define WKFMCAM_ADDR_NUM 6
52 #define WKFMCAM_SIZE 24 /* each entry need 6*4 bytes */
53 enum pattern_type {
54 PATTERN_BROADCAST = 0,
55 PATTERN_MULTICAST,
56 PATTERN_UNICAST,
57 PATTERN_VALID,
58 PATTERN_INVALID,
59 };
60
61 typedef struct rtl_priv_pattern {
62 int len;
63 char content[MAX_WKFM_PATTERN_SIZE];
64 char mask[MAX_WKFM_SIZE];
65 } rtl_priv_pattern_t;
66
67 struct rtl_wow_pattern {
68 u16 crc;
69 u8 type;
70 u32 mask[4];
71 };
72 #endif /* CONFIG_WOWLAN */
73
74 enum Power_Mgnt
75 {
76 PS_MODE_ACTIVE = 0 ,
77 PS_MODE_MIN ,
78 PS_MODE_MAX ,
79 PS_MODE_DTIM , //PS_MODE_SELF_DEFINED
80 PS_MODE_VOIP ,
81 PS_MODE_UAPSD_WMM ,
82 PS_MODE_UAPSD ,
83 PS_MODE_IBSS ,
84 PS_MODE_WWLAN ,
85 PM_Radio_Off ,
86 PM_Card_Disable ,
87 PS_MODE_NUM,
88 };
89
90 #ifdef CONFIG_PNO_SUPPORT
91 #define MAX_PNO_LIST_COUNT 16
92 #define MAX_SCAN_LIST_COUNT 14 //2.4G only
93 #define MAX_HIDDEN_AP 8 //8 hidden AP
94 #endif
95
96 /*
97 BIT[2:0] = HW state
98 BIT[3] = Protocol PS state, 0: register active state , 1: register sleep state
99 BIT[4] = sub-state
100 */
101
102 #define PS_DPS BIT(0)
103 #define PS_LCLK (PS_DPS)
104 #define PS_RF_OFF BIT(1)
105 #define PS_ALL_ON BIT(2)
106 #define PS_ST_ACTIVE BIT(3)
107
108 #define PS_ISR_ENABLE BIT(4)
109 #define PS_IMR_ENABLE BIT(5)
110 #define PS_ACK BIT(6)
111 #define PS_TOGGLE BIT(7)
112
113 #define PS_STATE_MASK (0x0F)
114 #define PS_STATE_HW_MASK (0x07)
115 #define PS_SEQ_MASK (0xc0)
116
117 #define PS_STATE(x) (PS_STATE_MASK & (x))
118 #define PS_STATE_HW(x) (PS_STATE_HW_MASK & (x))
119 #define PS_SEQ(x) (PS_SEQ_MASK & (x))
120
121 #define PS_STATE_S0 (PS_DPS)
122 #define PS_STATE_S1 (PS_LCLK)
123 #define PS_STATE_S2 (PS_RF_OFF)
124 #define PS_STATE_S3 (PS_ALL_ON)
125 #define PS_STATE_S4 ((PS_ST_ACTIVE) | (PS_ALL_ON))
126
127
128 #define PS_IS_RF_ON(x) ((x) & (PS_ALL_ON))
129 #define PS_IS_ACTIVE(x) ((x) & (PS_ST_ACTIVE))
130 #define CLR_PS_STATE(x) ((x) = ((x) & (0xF0)))
131
132
133 struct reportpwrstate_parm {
134 unsigned char mode;
135 unsigned char state; //the CPWM value
136 unsigned short rsvd;
137 };
138
139
140 typedef _sema _pwrlock;
141
142
_init_pwrlock(_pwrlock * plock)143 __inline static void _init_pwrlock(_pwrlock *plock)
144 {
145 _rtw_init_sema(plock, 1);
146 }
147
_free_pwrlock(_pwrlock * plock)148 __inline static void _free_pwrlock(_pwrlock *plock)
149 {
150 _rtw_free_sema(plock);
151 }
152
153
_enter_pwrlock(_pwrlock * plock)154 __inline static void _enter_pwrlock(_pwrlock *plock)
155 {
156 _rtw_down_sema(plock);
157 }
158
159
_exit_pwrlock(_pwrlock * plock)160 __inline static void _exit_pwrlock(_pwrlock *plock)
161 {
162 _rtw_up_sema(plock);
163 }
164
165 #define LPS_DELAY_TIME 1*HZ // 1 sec
166
167 #define EXE_PWR_NONE 0x01
168 #define EXE_PWR_IPS 0x02
169 #define EXE_PWR_LPS 0x04
170
171 // RF state.
172 typedef enum _rt_rf_power_state
173 {
174 rf_on, // RF is on after RFSleep or RFOff
175 rf_sleep, // 802.11 Power Save mode
176 rf_off, // HW/SW Radio OFF or Inactive Power Save
177 //=====Add the new RF state above this line=====//
178 rf_max
179 }rt_rf_power_state;
180
181 // RF Off Level for IPS or HW/SW radio off
182 #define RT_RF_OFF_LEVL_ASPM BIT(0) // PCI ASPM
183 #define RT_RF_OFF_LEVL_CLK_REQ BIT(1) // PCI clock request
184 #define RT_RF_OFF_LEVL_PCI_D3 BIT(2) // PCI D3 mode
185 #define RT_RF_OFF_LEVL_HALT_NIC BIT(3) // NIC halt, re-initialize hw parameters
186 #define RT_RF_OFF_LEVL_FREE_FW BIT(4) // FW free, re-download the FW
187 #define RT_RF_OFF_LEVL_FW_32K BIT(5) // FW in 32k
188 #define RT_RF_PS_LEVEL_ALWAYS_ASPM BIT(6) // Always enable ASPM and Clock Req in initialization.
189 #define RT_RF_LPS_DISALBE_2R BIT(30) // When LPS is on, disable 2R if no packet is received or transmittd.
190 #define RT_RF_LPS_LEVEL_ASPM BIT(31) // LPS with ASPM
191
192 #define RT_IN_PS_LEVEL(ppsc, _PS_FLAG) ((ppsc->cur_ps_level & _PS_FLAG) ? _TRUE : _FALSE)
193 #define RT_CLEAR_PS_LEVEL(ppsc, _PS_FLAG) (ppsc->cur_ps_level &= (~(_PS_FLAG)))
194 #define RT_SET_PS_LEVEL(ppsc, _PS_FLAG) (ppsc->cur_ps_level |= _PS_FLAG)
195
196 // ASPM OSC Control bit, added by Roger, 2013.03.29.
197 #define RT_PCI_ASPM_OSC_IGNORE 0 // PCI ASPM ignore OSC control in default
198 #define RT_PCI_ASPM_OSC_ENABLE BIT0 // PCI ASPM controlled by OS according to ACPI Spec 5.0
199 #define RT_PCI_ASPM_OSC_DISABLE BIT1 // PCI ASPM controlled by driver or BIOS, i.e., force enable ASPM
200
201
202 enum _PS_BBRegBackup_ {
203 PSBBREG_RF0 = 0,
204 PSBBREG_RF1,
205 PSBBREG_RF2,
206 PSBBREG_AFE0,
207 PSBBREG_TOTALCNT
208 };
209
210 enum { // for ips_mode
211 IPS_NONE=0,
212 IPS_NORMAL,
213 IPS_LEVEL_2,
214 IPS_NUM
215 };
216
217 // Design for pwrctrl_priv.ips_deny, 32 bits for 32 reasons at most
218 typedef enum _PS_DENY_REASON
219 {
220 PS_DENY_DRV_INITIAL = 0,
221 PS_DENY_SCAN,
222 PS_DENY_JOIN,
223 PS_DENY_DISCONNECT,
224 PS_DENY_SUSPEND,
225 PS_DENY_IOCTL,
226 PS_DENY_MGNT_TX,
227 PS_DENY_DRV_REMOVE = 30,
228 PS_DENY_OTHERS = 31
229 } PS_DENY_REASON;
230
231 #ifdef CONFIG_PNO_SUPPORT
232 typedef struct pno_nlo_info
233 {
234 u32 fast_scan_period; //Fast scan period
235 u8 ssid_num; //number of entry
236 u8 hidden_ssid_num;
237 u32 slow_scan_period; //slow scan period
238 u32 fast_scan_iterations; //Fast scan iterations
239 u8 ssid_length[MAX_PNO_LIST_COUNT]; //SSID Length Array
240 u8 ssid_cipher_info[MAX_PNO_LIST_COUNT]; //Cipher information for security
241 u8 ssid_channel_info[MAX_PNO_LIST_COUNT]; //channel information
242 u8 loc_probe_req[MAX_HIDDEN_AP]; //loc_probeReq
243 }pno_nlo_info_t;
244
245 typedef struct pno_ssid {
246 u32 SSID_len;
247 u8 SSID[32];
248 } pno_ssid_t;
249
250 typedef struct pno_ssid_list {
251 pno_ssid_t node[MAX_PNO_LIST_COUNT];
252 }pno_ssid_list_t;
253
254 typedef struct pno_scan_channel_info
255 {
256 u8 channel;
257 u8 tx_power;
258 u8 timeout;
259 u8 active; //set 1 means active scan, or pasivite scan.
260 }pno_scan_channel_info_t;
261
262 typedef struct pno_scan_info
263 {
264 u8 enableRFE; //Enable RFE
265 u8 period_scan_time; //exclusive with fast_scan_period and slow_scan_period
266 u8 periodScan; //exclusive with fast_scan_period and slow_scan_period
267 u8 orig_80_offset; //original channel 80 offset
268 u8 orig_40_offset; //original channel 40 offset
269 u8 orig_bw; //original bandwidth
270 u8 orig_ch; //original channel
271 u8 channel_num; //number of channel
272 u64 rfe_type; //rfe_type && 0x00000000000000ff
273 pno_scan_channel_info_t ssid_channel_info[MAX_SCAN_LIST_COUNT];
274 }pno_scan_info_t;
275 #endif //CONFIG_PNO_SUPPORT
276
277 struct pwrctrl_priv
278 {
279 _pwrlock lock;
280 _pwrlock check_32k_lock;
281 volatile u8 rpwm; // requested power state for fw
282 volatile u8 cpwm; // fw current power state. updated when 1. read from HCPWM 2. driver lowers power level
283 volatile u8 tog; // toggling
284 volatile u8 cpwm_tog; // toggling
285
286 u8 pwr_mode;
287 u8 smart_ps;
288 u8 bcn_ant_mode;
289 u8 dtim;
290
291 u32 alives;
292 _workitem cpwm_event;
293 #ifdef CONFIG_LPS_RPWM_TIMER
294 u8 brpwmtimeout;
295 _workitem rpwmtimeoutwi;
296 _timer pwr_rpwm_timer;
297 #endif // CONFIG_LPS_RPWM_TIMER
298 u8 bpower_saving; //for LPS/IPS
299
300 u8 b_hw_radio_off;
301 u8 reg_rfoff;
302 u8 reg_pdnmode; //powerdown mode
303 u32 rfoff_reason;
304
305 //RF OFF Level
306 u32 cur_ps_level;
307 u32 reg_rfps_level;
308
309 uint ips_enter_cnts;
310 uint ips_leave_cnts;
311 uint lps_enter_cnts;
312 uint lps_leave_cnts;
313
314 u8 ips_mode;
315 u8 ips_org_mode;
316 u8 ips_mode_req; // used to accept the mode setting request, will update to ipsmode later
317 uint bips_processing;
318 u32 ips_deny_time; /* will deny IPS when system time is smaller than this */
319 u8 pre_ips_type;// 0: default flow, 1: carddisbale flow
320
321 // ps_deny: if 0, power save is free to go; otherwise deny all kinds of power save.
322 // Use PS_DENY_REASON to decide reason.
323 // Don't access this variable directly without control function,
324 // and this variable should be protected by lock.
325 u32 ps_deny;
326
327 u8 ps_processing; /* temporarily used to mark whether in rtw_ps_processor */
328
329 u8 fw_psmode_iface_id;
330 u8 bLeisurePs;
331 u8 LpsIdleCount;
332 u8 power_mgnt;
333 u8 org_power_mgnt;
334 u8 bFwCurrentInPSMode;
335 u32 DelayLPSLastTimeStamp;
336 s32 pnp_current_pwr_state;
337 u8 pnp_bstop_trx;
338
339
340 u8 bInternalAutoSuspend;
341 u8 bInSuspend;
342 #ifdef CONFIG_BT_COEXIST
343 u8 bAutoResume;
344 u8 autopm_cnt;
345 #endif
346 u8 bSupportRemoteWakeup;
347 u8 wowlan_wake_reason;
348 u8 wowlan_ap_mode;
349 u8 wowlan_mode;
350 u8 wowlan_p2p_mode;
351 u8 wowlan_pno_enable;
352 #ifdef CONFIG_GPIO_WAKEUP
353 u8 is_high_active;
354 #endif /* CONFIG_GPIO_WAKEUP */
355 #ifdef CONFIG_WOWLAN
356 u8 wowlan_txpause_status;
357 u8 wowlan_pattern;
358 u8 wowlan_pattern_idx;
359 u64 wowlan_fw_iv;
360 struct rtl_priv_pattern patterns[MAX_WKFM_NUM];
361 #ifdef CONFIG_PNO_SUPPORT
362 u8 pno_in_resume;
363 u8 pno_inited;
364 pno_nlo_info_t *pnlo_info;
365 pno_scan_info_t *pscan_info;
366 pno_ssid_list_t *pno_ssid_list;
367 #endif /* CONFIG_PNO_SUPPORT */
368 #endif /* CONFIG_WOWLAN */
369 _timer pwr_state_check_timer;
370 int pwr_state_check_interval;
371 u8 pwr_state_check_cnts;
372
373 int ps_flag; /* used by autosuspend */
374
375 rt_rf_power_state rf_pwrstate;//cur power state, only for IPS
376 //rt_rf_power_state current_rfpwrstate;
377 rt_rf_power_state change_rfpwrstate;
378
379 u8 bHWPowerdown; /* power down mode selection. 0:radio off, 1:power down */
380 u8 bHWPwrPindetect; /* come from registrypriv.hwpwrp_detect. enable power down function. 0:disable, 1:enable */
381 u8 bkeepfwalive;
382 u8 brfoffbyhw;
383 unsigned long PS_BBRegBackup[PSBBREG_TOTALCNT];
384
385 #ifdef CONFIG_RESUME_IN_WORKQUEUE
386 struct workqueue_struct *rtw_workqueue;
387 _workitem resume_work;
388 #endif
389
390 #ifdef CONFIG_HAS_EARLYSUSPEND
391 struct early_suspend early_suspend;
392 u8 do_late_resume;
393 #endif //CONFIG_HAS_EARLYSUSPEND
394
395 #ifdef CONFIG_ANDROID_POWER
396 android_early_suspend_t early_suspend;
397 u8 do_late_resume;
398 #endif
399
400 #ifdef CONFIG_INTEL_PROXIM
401 u8 stored_power_mgnt;
402 #endif
403 };
404
405 #define rtw_get_ips_mode_req(pwrctl) \
406 (pwrctl)->ips_mode_req
407
408 #define rtw_ips_mode_req(pwrctl, ips_mode) \
409 (pwrctl)->ips_mode_req = (ips_mode)
410
411 #define RTW_PWR_STATE_CHK_INTERVAL 2000
412
413 #define _rtw_set_pwr_state_check_timer(pwrctl, ms) \
414 do { \
415 /*DBG_871X("%s _rtw_set_pwr_state_check_timer(%p, %d)\n", __FUNCTION__, (pwrctl), (ms));*/ \
416 _set_timer(&(pwrctl)->pwr_state_check_timer, (ms)); \
417 } while(0)
418
419 #define rtw_set_pwr_state_check_timer(pwrctl) \
420 _rtw_set_pwr_state_check_timer((pwrctl), (pwrctl)->pwr_state_check_interval)
421
422 extern void rtw_init_pwrctrl_priv(_adapter *adapter);
423 extern void rtw_free_pwrctrl_priv(_adapter * adapter);
424
425 #ifdef CONFIG_LPS_LCLK
426 s32 rtw_register_task_alive(PADAPTER, u32 task);
427 void rtw_unregister_task_alive(PADAPTER, u32 task);
428 extern s32 rtw_register_tx_alive(PADAPTER padapter);
429 extern void rtw_unregister_tx_alive(PADAPTER padapter);
430 extern s32 rtw_register_rx_alive(PADAPTER padapter);
431 extern void rtw_unregister_rx_alive(PADAPTER padapter);
432 extern s32 rtw_register_cmd_alive(PADAPTER padapter);
433 extern void rtw_unregister_cmd_alive(PADAPTER padapter);
434 extern s32 rtw_register_evt_alive(PADAPTER padapter);
435 extern void rtw_unregister_evt_alive(PADAPTER padapter);
436 extern void cpwm_int_hdl(PADAPTER padapter, struct reportpwrstate_parm *preportpwrstate);
437 extern void LPS_Leave_check(PADAPTER padapter);
438 #endif
439
440 extern void LeaveAllPowerSaveMode(PADAPTER Adapter);
441 extern void LeaveAllPowerSaveModeDirect(PADAPTER Adapter);
442 #ifdef CONFIG_IPS
443 void _ips_enter(_adapter * padapter);
444 void ips_enter(_adapter * padapter);
445 int _ips_leave(_adapter * padapter);
446 int ips_leave(_adapter * padapter);
447 #endif
448
449 void rtw_ps_processor(_adapter*padapter);
450
451 #ifdef CONFIG_AUTOSUSPEND
452 int autoresume_enter(_adapter* padapter);
453 #endif
454 #ifdef SUPPORT_HW_RFOFF_DETECTED
455 rt_rf_power_state RfOnOffDetect(IN PADAPTER pAdapter );
456 #endif
457
458
459 int rtw_fw_ps_state(PADAPTER padapter);
460
461 #ifdef CONFIG_LPS
462 s32 LPS_RF_ON_check(PADAPTER padapter, u32 delay_ms);
463 void LPS_Enter(PADAPTER padapter, const char *msg);
464 void LPS_Leave(PADAPTER padapter, const char *msg);
465 void traffic_check_for_leave_lps(PADAPTER padapter, u8 tx, u32 tx_packets);
466 void rtw_set_ps_mode(PADAPTER padapter, u8 ps_mode, u8 smart_ps, u8 bcn_ant_mode, const char *msg);
467 void rtw_set_fw_in_ips_mode(PADAPTER padapter, u8 enable);
468 void rtw_set_rpwm(_adapter * padapter, u8 val8);
469 #endif
470
471 #ifdef CONFIG_RESUME_IN_WORKQUEUE
472 void rtw_resume_in_workqueue(struct pwrctrl_priv *pwrpriv);
473 #endif //CONFIG_RESUME_IN_WORKQUEUE
474
475 #if defined(CONFIG_HAS_EARLYSUSPEND ) || defined(CONFIG_ANDROID_POWER)
476 bool rtw_is_earlysuspend_registered(struct pwrctrl_priv *pwrpriv);
477 bool rtw_is_do_late_resume(struct pwrctrl_priv *pwrpriv);
478 void rtw_set_do_late_resume(struct pwrctrl_priv *pwrpriv, bool enable);
479 void rtw_register_early_suspend(struct pwrctrl_priv *pwrpriv);
480 void rtw_unregister_early_suspend(struct pwrctrl_priv *pwrpriv);
481 #else
482 #define rtw_is_earlysuspend_registered(pwrpriv) _FALSE
483 #define rtw_is_do_late_resume(pwrpriv) _FALSE
484 #define rtw_set_do_late_resume(pwrpriv, enable) do {} while (0)
485 #define rtw_register_early_suspend(pwrpriv) do {} while (0)
486 #define rtw_unregister_early_suspend(pwrpriv) do {} while (0)
487 #endif /* CONFIG_HAS_EARLYSUSPEND || CONFIG_ANDROID_POWER */
488
489 u8 rtw_interface_ps_func(_adapter *padapter,HAL_INTF_PS_FUNC efunc_id,u8* val);
490 void rtw_set_ips_deny(_adapter *padapter, u32 ms);
491 int _rtw_pwr_wakeup(_adapter *padapter, u32 ips_deffer_ms, const char *caller);
492 #define rtw_pwr_wakeup(adapter) _rtw_pwr_wakeup(adapter, RTW_PWR_STATE_CHK_INTERVAL, __FUNCTION__)
493 #define rtw_pwr_wakeup_ex(adapter, ips_deffer_ms) _rtw_pwr_wakeup(adapter, ips_deffer_ms, __FUNCTION__)
494 int rtw_pm_set_ips(_adapter *padapter, u8 mode);
495 int rtw_pm_set_lps(_adapter *padapter, u8 mode);
496
497 void rtw_ps_deny(PADAPTER padapter, PS_DENY_REASON reason);
498 void rtw_ps_deny_cancel(PADAPTER padapter, PS_DENY_REASON reason);
499 u32 rtw_ps_deny_get(PADAPTER padapter);
500
501 #if defined(CONFIG_WOWLAN)
502 void rtw_get_current_ip_address(PADAPTER padapter, u8 *pcurrentip);
503 void rtw_get_sec_iv(PADAPTER padapter, u8 *pcur_dot11txpn, u8 *StaAddr);
504 void rtw_set_sec_pn(_adapter *padapter);
505 bool rtw_check_pattern_valid(u8 *input, u8 len);
506 bool rtw_write_to_frame_mask(_adapter *adapter, u8 idx,
507 struct rtl_wow_pattern *content);
508
509 bool rtw_read_from_frame_mask(_adapter *adapter, u8 idx);
510 void rtw_dump_priv_pattern(_adapter *adapter, u8 idx);
511 void rtw_clean_pattern(_adapter *adapter);
512 #endif /* CONFIG_WOWLAN */
513 #endif //__RTL871X_PWRCTRL_H_
514
515