1 /******************************************************************************
3 * Copyright(c) 2007 - 2012 Realtek Corporation. All rights reserved.
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.
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
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
19 ******************************************************************************/
20 #ifndef __RTW_PWRCTRL_H_
21 #define __RTW_PWRCTRL_H_
23 #include <osdep_service.h>
24 #include <drv_types.h>
38 #define XMIT_ALIVE BIT(0)
39 #define RECV_ALIVE BIT(1)
40 #define CMD_ALIVE BIT(2)
41 #define EVT_ALIVE BIT(3)
60 BIT[3] = Protocol PS state, 0: register active state,
61 1: register sleep state
66 #define PS_LCLK (PS_DPS)
67 #define PS_RF_OFF BIT(1)
68 #define PS_ALL_ON BIT(2)
69 #define PS_ST_ACTIVE BIT(3)
71 #define PS_ISR_ENABLE BIT(4)
72 #define PS_IMR_ENABLE BIT(5)
74 #define PS_TOGGLE BIT(7)
76 #define PS_STATE_MASK (0x0F)
77 #define PS_STATE_HW_MASK (0x07)
78 #define PS_SEQ_MASK (0xc0)
80 #define PS_STATE(x) (PS_STATE_MASK & (x))
81 #define PS_STATE_HW(x) (PS_STATE_HW_MASK & (x))
82 #define PS_SEQ(x) (PS_SEQ_MASK & (x))
84 #define PS_STATE_S0 (PS_DPS)
85 #define PS_STATE_S1 (PS_LCLK)
86 #define PS_STATE_S2 (PS_RF_OFF)
87 #define PS_STATE_S3 (PS_ALL_ON)
88 #define PS_STATE_S4 ((PS_ST_ACTIVE) | (PS_ALL_ON))
90 #define PS_IS_RF_ON(x) ((x) & (PS_ALL_ON))
91 #define PS_IS_ACTIVE(x) ((x) & (PS_ST_ACTIVE))
92 #define CLR_PS_STATE(x) ((x) = ((x) & (0xF0)))
94 struct reportpwrstate_parm {
96 unsigned char state; /* the CPWM value */
100 static inline void _init_pwrlock(struct semaphore *plock)
105 static inline void _enter_pwrlock(struct semaphore *plock)
107 _rtw_down_sema(plock);
110 static inline void _exit_pwrlock(struct semaphore *plock)
115 #define LPS_DELAY_TIME 1*HZ /* 1 sec */
117 #define EXE_PWR_NONE 0x01
118 #define EXE_PWR_IPS 0x02
119 #define EXE_PWR_LPS 0x04
122 enum rt_rf_power_state {
123 rf_on, /* RF is on after RFSleep or RFOff */
124 rf_sleep, /* 802.11 Power Save mode */
125 rf_off, /* HW/SW Radio OFF or Inactive Power Save */
126 /* Add the new RF state above this line===== */
130 /* RF Off Level for IPS or HW/SW radio off */
131 #define RT_RF_OFF_LEVL_ASPM BIT(0) /* PCI ASPM */
132 #define RT_RF_OFF_LEVL_CLK_REQ BIT(1) /* PCI clock request */
133 #define RT_RF_OFF_LEVL_PCI_D3 BIT(2) /* PCI D3 mode */
134 #define RT_RF_OFF_LEVL_HALT_NIC BIT(3) /* NIC halt, re-init hw param*/
135 #define RT_RF_OFF_LEVL_FREE_FW BIT(4) /* FW free, re-download the FW*/
136 #define RT_RF_OFF_LEVL_FW_32K BIT(5) /* FW in 32k */
137 #define RT_RF_PS_LEVEL_ALWAYS_ASPM BIT(6) /* Always enable ASPM and Clock
138 * Req in initialization. */
139 #define RT_RF_LPS_DISALBE_2R BIT(30) /* When LPS is on, disable 2R
140 * if no packet is RX or TX. */
141 #define RT_RF_LPS_LEVEL_ASPM BIT(31) /* LPS with ASPM */
143 #define RT_IN_PS_LEVEL(ppsc, _PS_FLAG) \
144 ((ppsc->cur_ps_level & _PS_FLAG) ? true : false)
145 #define RT_CLEAR_PS_LEVEL(ppsc, _PS_FLAG) \
146 (ppsc->cur_ps_level &= (~(_PS_FLAG)))
147 #define RT_SET_PS_LEVEL(ppsc, _PS_FLAG) \
148 (ppsc->cur_ps_level |= _PS_FLAG)
150 enum _PS_BBRegBackup_ {
158 enum { /* for ips_mode */
164 struct pwrctrl_priv {
165 struct semaphore lock;
166 volatile u8 rpwm; /* requested power state for fw */
167 volatile u8 cpwm; /* fw current power state. updated when
168 * 1. read from HCPWM 2. driver lowers power level */
169 volatile u8 tog; /* toggling */
170 volatile u8 cpwm_tog; /* toggling */
177 struct work_struct cpwm_event;
182 u8 reg_pdnmode; /* powerdown mode */
192 u8 ips_mode_req; /* used to accept the mode setting request,
193 * will update to ipsmode later */
194 uint bips_processing;
195 unsigned long ips_deny_time; /* will deny IPS when system time less than this */
196 u8 ps_processing; /* temp used to mark whether in rtw_ps_processor */
201 u8 bFwCurrentInPSMode;
202 u32 DelayLPSLastTimeStamp;
204 s32 pnp_current_pwr_state;
207 u8 bInternalAutoSuspend;
209 u8 bSupportRemoteWakeup;
210 struct timer_list pwr_state_check_timer;
211 int pwr_state_check_interval;
212 u8 pwr_state_check_cnts;
216 enum rt_rf_power_state rf_pwrstate;/* cur power state */
217 enum rt_rf_power_state change_rfpwrstate;
220 u8 bHWPowerdown;/* if support hw power down */
224 unsigned long PS_BBRegBackup[PSBBREG_TOTALCNT];
227 #define rtw_get_ips_mode_req(pwrctrlpriv) \
228 (pwrctrlpriv)->ips_mode_req
230 #define rtw_ips_mode_req(pwrctrlpriv, ips_mode) \
231 ((pwrctrlpriv)->ips_mode_req = (ips_mode))
233 #define RTW_PWR_STATE_CHK_INTERVAL 2000
235 #define _rtw_set_pwr_state_check_timer(pwrctrlpriv, ms) \
236 mod_timer(&pwrctrlpriv->pwr_state_check_timer, \
237 jiffies + msecs_to_jiffies(ms))
239 #define rtw_set_pwr_state_check_timer(pwrctrl) \
240 _rtw_set_pwr_state_check_timer((pwrctrl), \
241 (pwrctrl)->pwr_state_check_interval)
243 void rtw_init_pwrctrl_priv(struct adapter *adapter);
245 void rtw_set_ps_mode(struct adapter *adapter, u8 ps_mode, u8 smart_ps,
247 void rtw_set_rpwm(struct adapter *adapter, u8 val8);
248 void LeaveAllPowerSaveMode(struct adapter *adapter);
249 void ips_enter(struct adapter *padapter);
250 int ips_leave(struct adapter *padapter);
252 void rtw_ps_processor(struct adapter *padapter);
254 enum rt_rf_power_state RfOnOffDetect(struct adapter *iadapter);
256 s32 LPS_RF_ON_check(struct adapter *adapter, u32 delay_ms);
257 void LPS_Enter(struct adapter *adapter);
258 void LPS_Leave(struct adapter *adapter);
260 int _rtw_pwr_wakeup(struct adapter *adapter, u32 ips_defer_ms,
262 #define rtw_pwr_wakeup(adapter) \
263 _rtw_pwr_wakeup(adapter, RTW_PWR_STATE_CHK_INTERVAL, __func__)
264 #define rtw_pwr_wakeup_ex(adapter, ips_deffer_ms) \
265 _rtw_pwr_wakeup(adapter, ips_deffer_ms, __func__)
266 int rtw_pm_set_ips(struct adapter *adapter, u8 mode);
267 int rtw_pm_set_lps(struct adapter *adapter, u8 mode);
269 #endif /* __RTL871X_PWRCTRL_H_ */