include: replace linux/module.h with "struct module" wherever possible
[linux-2.6/next.git] / drivers / net / wireless / rtlwifi / ps.c
bloba693feffbe72913a28411ffbff05d07a1748fce7
1 /******************************************************************************
3 * Copyright(c) 2009-2010 Realtek Corporation.
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
12 * more details.
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
18 * The full GNU General Public License is included in this distribution in the
19 * file called LICENSE.
21 * Contact Information:
22 * wlanfae <wlanfae@realtek.com>
23 * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
24 * Hsinchu 300, Taiwan.
26 * Larry Finger <Larry.Finger@lwfinger.net>
28 *****************************************************************************/
30 #include "wifi.h"
31 #include "base.h"
32 #include "ps.h"
34 bool rtl_ps_enable_nic(struct ieee80211_hw *hw)
36 struct rtl_priv *rtlpriv = rtl_priv(hw);
37 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
38 struct rtl_hal *rtlhal = rtl_hal(rtl_priv(hw));
40 /*<1> reset trx ring */
41 if (rtlhal->interface == INTF_PCI)
42 rtlpriv->intf_ops->reset_trx_ring(hw);
44 if (is_hal_stop(rtlhal))
45 RT_TRACE(rtlpriv, COMP_ERR, DBG_WARNING,
46 ("Driver is already down!\n"));
48 /*<2> Enable Adapter */
49 rtlpriv->cfg->ops->hw_init(hw);
50 RT_CLEAR_PS_LEVEL(ppsc, RT_RF_OFF_LEVL_HALT_NIC);
52 /*<3> Enable Interrupt */
53 rtlpriv->cfg->ops->enable_interrupt(hw);
55 /*<enable timer> */
56 rtl_watch_dog_timer_callback((unsigned long)hw);
58 return true;
60 EXPORT_SYMBOL(rtl_ps_enable_nic);
62 bool rtl_ps_disable_nic(struct ieee80211_hw *hw)
64 struct rtl_priv *rtlpriv = rtl_priv(hw);
66 /*<1> Stop all timer */
67 rtl_deinit_deferred_work(hw);
69 /*<2> Disable Interrupt */
70 rtlpriv->cfg->ops->disable_interrupt(hw);
71 tasklet_kill(&rtlpriv->works.irq_tasklet);
73 /*<3> Disable Adapter */
74 rtlpriv->cfg->ops->hw_disable(hw);
76 return true;
78 EXPORT_SYMBOL(rtl_ps_disable_nic);
80 bool rtl_ps_set_rf_state(struct ieee80211_hw *hw,
81 enum rf_pwrstate state_toset,
82 u32 changesource)
84 struct rtl_priv *rtlpriv = rtl_priv(hw);
85 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
86 bool actionallowed = false;
88 switch (state_toset) {
89 case ERFON:
90 ppsc->rfoff_reason &= (~changesource);
92 if ((changesource == RF_CHANGE_BY_HW) &&
93 (ppsc->hwradiooff)) {
94 ppsc->hwradiooff = false;
97 if (!ppsc->rfoff_reason) {
98 ppsc->rfoff_reason = 0;
99 actionallowed = true;
102 break;
104 case ERFOFF:
106 if ((changesource == RF_CHANGE_BY_HW)
107 && (ppsc->hwradiooff == false)) {
108 ppsc->hwradiooff = true;
111 ppsc->rfoff_reason |= changesource;
112 actionallowed = true;
113 break;
115 case ERFSLEEP:
116 ppsc->rfoff_reason |= changesource;
117 actionallowed = true;
118 break;
120 default:
121 RT_TRACE(rtlpriv, COMP_ERR, DBG_EMERG,
122 ("switch case not process\n"));
123 break;
126 if (actionallowed)
127 rtlpriv->cfg->ops->set_rf_power_state(hw, state_toset);
129 return actionallowed;
131 EXPORT_SYMBOL(rtl_ps_set_rf_state);
133 static void _rtl_ps_inactive_ps(struct ieee80211_hw *hw)
135 struct rtl_priv *rtlpriv = rtl_priv(hw);
136 struct rtl_hal *rtlhal = rtl_hal(rtl_priv(hw));
137 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
139 ppsc->swrf_processing = true;
141 if (ppsc->inactive_pwrstate == ERFON &&
142 rtlhal->interface == INTF_PCI) {
143 if ((ppsc->reg_rfps_level & RT_RF_OFF_LEVL_ASPM) &&
144 RT_IN_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM) &&
145 rtlhal->interface == INTF_PCI) {
146 rtlpriv->intf_ops->disable_aspm(hw);
147 RT_CLEAR_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM);
151 rtl_ps_set_rf_state(hw, ppsc->inactive_pwrstate, RF_CHANGE_BY_IPS);
153 if (ppsc->inactive_pwrstate == ERFOFF &&
154 rtlhal->interface == INTF_PCI) {
155 if (ppsc->reg_rfps_level & RT_RF_OFF_LEVL_ASPM &&
156 !RT_IN_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM)) {
157 rtlpriv->intf_ops->enable_aspm(hw);
158 RT_SET_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM);
162 ppsc->swrf_processing = false;
165 void rtl_ips_nic_off_wq_callback(void *data)
167 struct rtl_works *rtlworks =
168 container_of_dwork_rtl(data, struct rtl_works, ips_nic_off_wq);
169 struct ieee80211_hw *hw = rtlworks->hw;
170 struct rtl_priv *rtlpriv = rtl_priv(hw);
171 struct rtl_hal *rtlhal = rtl_hal(rtl_priv(hw));
172 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
173 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
174 enum rf_pwrstate rtstate;
176 if (mac->opmode != NL80211_IFTYPE_STATION) {
177 RT_TRACE(rtlpriv, COMP_ERR, DBG_WARNING,
178 ("not station return\n"));
179 return;
182 if (mac->link_state > MAC80211_NOLINK)
183 return;
185 if (is_hal_stop(rtlhal))
186 return;
188 if (rtlpriv->sec.being_setkey)
189 return;
191 if (ppsc->inactiveps) {
192 rtstate = ppsc->rfpwr_state;
195 *Do not enter IPS in the following conditions:
196 *(1) RF is already OFF or Sleep
197 *(2) swrf_processing (indicates the IPS is still under going)
198 *(3) Connectted (only disconnected can trigger IPS)
199 *(4) IBSS (send Beacon)
200 *(5) AP mode (send Beacon)
201 *(6) monitor mode (rcv packet)
204 if (rtstate == ERFON &&
205 !ppsc->swrf_processing &&
206 (mac->link_state == MAC80211_NOLINK) &&
207 !mac->act_scanning) {
208 RT_TRACE(rtlpriv, COMP_RF, DBG_TRACE,
209 ("IPSEnter(): Turn off RF.\n"));
211 ppsc->inactive_pwrstate = ERFOFF;
212 ppsc->in_powersavemode = true;
214 /*rtl_pci_reset_trx_ring(hw); */
215 _rtl_ps_inactive_ps(hw);
220 void rtl_ips_nic_off(struct ieee80211_hw *hw)
222 struct rtl_priv *rtlpriv = rtl_priv(hw);
225 *because when link with ap, mac80211 will ask us
226 *to disable nic quickly after scan before linking,
227 *this will cause link failed, so we delay 100ms here
229 queue_delayed_work(rtlpriv->works.rtl_wq,
230 &rtlpriv->works.ips_nic_off_wq, MSECS(100));
233 void rtl_ips_nic_on(struct ieee80211_hw *hw)
235 struct rtl_priv *rtlpriv = rtl_priv(hw);
236 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
237 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
238 enum rf_pwrstate rtstate;
240 if (mac->opmode != NL80211_IFTYPE_STATION)
241 return;
243 spin_lock(&rtlpriv->locks.ips_lock);
245 if (ppsc->inactiveps) {
246 rtstate = ppsc->rfpwr_state;
248 if (rtstate != ERFON &&
249 !ppsc->swrf_processing &&
250 ppsc->rfoff_reason <= RF_CHANGE_BY_IPS) {
252 ppsc->inactive_pwrstate = ERFON;
253 ppsc->in_powersavemode = false;
255 _rtl_ps_inactive_ps(hw);
259 spin_unlock(&rtlpriv->locks.ips_lock);
262 /*for FW LPS*/
265 *Determine if we can set Fw into PS mode
266 *in current condition.Return TRUE if it
267 *can enter PS mode.
269 static bool rtl_get_fwlps_doze(struct ieee80211_hw *hw)
271 struct rtl_priv *rtlpriv = rtl_priv(hw);
272 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
273 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
274 u32 ps_timediff;
276 ps_timediff = jiffies_to_msecs(jiffies -
277 ppsc->last_delaylps_stamp_jiffies);
279 if (ps_timediff < 2000) {
280 RT_TRACE(rtlpriv, COMP_POWER, DBG_LOUD,
281 ("Delay enter Fw LPS for DHCP, ARP,"
282 " or EAPOL exchanging state.\n"));
283 return false;
286 if (mac->link_state != MAC80211_LINKED)
287 return false;
289 if (mac->opmode == NL80211_IFTYPE_ADHOC)
290 return false;
292 return true;
295 /* Change current and default preamble mode.*/
296 static void rtl_lps_set_psmode(struct ieee80211_hw *hw, u8 rt_psmode)
298 struct rtl_priv *rtlpriv = rtl_priv(hw);
299 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
300 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
301 u8 rpwm_val, fw_pwrmode;
303 if (mac->opmode == NL80211_IFTYPE_ADHOC)
304 return;
306 if (mac->link_state != MAC80211_LINKED)
307 return;
309 if (ppsc->dot11_psmode == rt_psmode)
310 return;
312 /* Update power save mode configured. */
313 ppsc->dot11_psmode = rt_psmode;
316 *<FW control LPS>
317 *1. Enter PS mode
318 * Set RPWM to Fw to turn RF off and send H2C fw_pwrmode
319 * cmd to set Fw into PS mode.
320 *2. Leave PS mode
321 * Send H2C fw_pwrmode cmd to Fw to set Fw into Active
322 * mode and set RPWM to turn RF on.
325 if ((ppsc->fwctrl_lps) && ppsc->report_linked) {
326 bool fw_current_inps;
327 if (ppsc->dot11_psmode == EACTIVE) {
328 RT_TRACE(rtlpriv, COMP_RF, DBG_DMESG,
329 ("FW LPS leave ps_mode:%x\n",
330 FW_PS_ACTIVE_MODE));
332 rpwm_val = 0x0C; /* RF on */
333 fw_pwrmode = FW_PS_ACTIVE_MODE;
334 rtlpriv->cfg->ops->set_hw_reg(hw, HW_VAR_SET_RPWM,
335 (u8 *) (&rpwm_val));
336 rtlpriv->cfg->ops->set_hw_reg(hw,
337 HW_VAR_H2C_FW_PWRMODE,
338 (u8 *) (&fw_pwrmode));
339 fw_current_inps = false;
341 rtlpriv->cfg->ops->set_hw_reg(hw,
342 HW_VAR_FW_PSMODE_STATUS,
343 (u8 *) (&fw_current_inps));
345 } else {
346 if (rtl_get_fwlps_doze(hw)) {
347 RT_TRACE(rtlpriv, COMP_RF, DBG_DMESG,
348 ("FW LPS enter ps_mode:%x\n",
349 ppsc->fwctrl_psmode));
351 rpwm_val = 0x02; /* RF off */
352 fw_current_inps = true;
353 rtlpriv->cfg->ops->set_hw_reg(hw,
354 HW_VAR_FW_PSMODE_STATUS,
355 (u8 *) (&fw_current_inps));
356 rtlpriv->cfg->ops->set_hw_reg(hw,
357 HW_VAR_H2C_FW_PWRMODE,
358 (u8 *) (&ppsc->fwctrl_psmode));
360 rtlpriv->cfg->ops->set_hw_reg(hw,
361 HW_VAR_SET_RPWM,
362 (u8 *) (&rpwm_val));
363 } else {
364 /* Reset the power save related parameters. */
365 ppsc->dot11_psmode = EACTIVE;
371 /*Enter the leisure power save mode.*/
372 void rtl_lps_enter(struct ieee80211_hw *hw)
374 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
375 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
376 struct rtl_priv *rtlpriv = rtl_priv(hw);
378 if (!ppsc->fwctrl_lps)
379 return;
381 if (rtlpriv->sec.being_setkey)
382 return;
384 if (rtlpriv->link_info.busytraffic)
385 return;
387 /*sleep after linked 10s, to let DHCP and 4-way handshake ok enough!! */
388 if (mac->cnt_after_linked < 5)
389 return;
391 if (mac->opmode == NL80211_IFTYPE_ADHOC)
392 return;
394 if (mac->link_state != MAC80211_LINKED)
395 return;
397 spin_lock(&rtlpriv->locks.lps_lock);
399 /* Idle for a while if we connect to AP a while ago. */
400 if (mac->cnt_after_linked >= 2) {
401 if (ppsc->dot11_psmode == EACTIVE) {
402 RT_TRACE(rtlpriv, COMP_POWER, DBG_LOUD,
403 ("Enter 802.11 power save mode...\n"));
405 rtl_lps_set_psmode(hw, EAUTOPS);
409 spin_unlock(&rtlpriv->locks.lps_lock);
412 /*Leave the leisure power save mode.*/
413 void rtl_lps_leave(struct ieee80211_hw *hw)
415 struct rtl_priv *rtlpriv = rtl_priv(hw);
416 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
417 struct rtl_hal *rtlhal = rtl_hal(rtl_priv(hw));
419 spin_lock(&rtlpriv->locks.lps_lock);
421 if (ppsc->fwctrl_lps) {
422 if (ppsc->dot11_psmode != EACTIVE) {
424 /*FIX ME */
425 rtlpriv->cfg->ops->enable_interrupt(hw);
427 if (ppsc->reg_rfps_level & RT_RF_LPS_LEVEL_ASPM &&
428 RT_IN_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM) &&
429 rtlhal->interface == INTF_PCI) {
430 rtlpriv->intf_ops->disable_aspm(hw);
431 RT_CLEAR_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM);
434 RT_TRACE(rtlpriv, COMP_POWER, DBG_LOUD,
435 ("Busy Traffic,Leave 802.11 power save..\n"));
437 rtl_lps_set_psmode(hw, EACTIVE);
440 spin_unlock(&rtlpriv->locks.lps_lock);
443 /* For sw LPS*/
444 void rtl_swlps_beacon(struct ieee80211_hw *hw, void *data, unsigned int len)
446 struct rtl_priv *rtlpriv = rtl_priv(hw);
447 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
448 struct ieee80211_hdr *hdr = (void *) data;
449 struct ieee80211_tim_ie *tim_ie;
450 u8 *tim;
451 u8 tim_len;
452 bool u_buffed;
453 bool m_buffed;
455 if (mac->opmode != NL80211_IFTYPE_STATION)
456 return;
458 if (!rtlpriv->psc.swctrl_lps)
459 return;
461 if (rtlpriv->mac80211.link_state != MAC80211_LINKED)
462 return;
464 if (!rtlpriv->psc.sw_ps_enabled)
465 return;
467 if (rtlpriv->psc.fwctrl_lps)
468 return;
470 if (likely(!(hw->conf.flags & IEEE80211_CONF_PS)))
471 return;
473 /* check if this really is a beacon */
474 if (!ieee80211_is_beacon(hdr->frame_control))
475 return;
477 /* min. beacon length + FCS_LEN */
478 if (len <= 40 + FCS_LEN)
479 return;
481 /* and only beacons from the associated BSSID, please */
482 if (compare_ether_addr(hdr->addr3, rtlpriv->mac80211.bssid))
483 return;
485 rtlpriv->psc.last_beacon = jiffies;
487 tim = rtl_find_ie(data, len - FCS_LEN, WLAN_EID_TIM);
488 if (!tim)
489 return;
491 if (tim[1] < sizeof(*tim_ie))
492 return;
494 tim_len = tim[1];
495 tim_ie = (struct ieee80211_tim_ie *) &tim[2];
497 if (!WARN_ON_ONCE(!hw->conf.ps_dtim_period))
498 rtlpriv->psc.dtim_counter = tim_ie->dtim_count;
500 /* Check whenever the PHY can be turned off again. */
502 /* 1. What about buffered unicast traffic for our AID? */
503 u_buffed = ieee80211_check_tim(tim_ie, tim_len,
504 rtlpriv->mac80211.assoc_id);
506 /* 2. Maybe the AP wants to send multicast/broadcast data? */
507 m_buffed = tim_ie->bitmap_ctrl & 0x01;
508 rtlpriv->psc.multi_buffered = m_buffed;
510 /* unicast will process by mac80211 through
511 * set ~IEEE80211_CONF_PS, So we just check
512 * multicast frames here */
513 if (!m_buffed) {
514 /* back to low-power land. and delay is
515 * prevent null power save frame tx fail */
516 queue_delayed_work(rtlpriv->works.rtl_wq,
517 &rtlpriv->works.ps_work, MSECS(5));
518 } else {
519 RT_TRACE(rtlpriv, COMP_POWER, DBG_DMESG, ("u_bufferd: %x, "
520 "m_buffered: %x\n", u_buffed, m_buffed));
524 void rtl_swlps_rf_awake(struct ieee80211_hw *hw)
526 struct rtl_priv *rtlpriv = rtl_priv(hw);
527 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
528 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
530 if (!rtlpriv->psc.swctrl_lps)
531 return;
532 if (mac->link_state != MAC80211_LINKED)
533 return;
535 if (ppsc->reg_rfps_level & RT_RF_LPS_LEVEL_ASPM &&
536 RT_IN_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM)) {
537 rtlpriv->intf_ops->disable_aspm(hw);
538 RT_CLEAR_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM);
541 spin_lock(&rtlpriv->locks.lps_lock);
542 rtl_ps_set_rf_state(hw, ERFON, RF_CHANGE_BY_PS);
543 spin_unlock(&rtlpriv->locks.lps_lock);
546 void rtl_swlps_rfon_wq_callback(void *data)
548 struct rtl_works *rtlworks =
549 container_of_dwork_rtl(data, struct rtl_works, ps_rfon_wq);
550 struct ieee80211_hw *hw = rtlworks->hw;
552 rtl_swlps_rf_awake(hw);
555 void rtl_swlps_rf_sleep(struct ieee80211_hw *hw)
557 struct rtl_priv *rtlpriv = rtl_priv(hw);
558 struct rtl_mac *mac = rtl_mac(rtl_priv(hw));
559 struct rtl_ps_ctl *ppsc = rtl_psc(rtl_priv(hw));
560 u8 sleep_intv;
562 if (!rtlpriv->psc.sw_ps_enabled)
563 return;
565 if ((rtlpriv->sec.being_setkey) ||
566 (mac->opmode == NL80211_IFTYPE_ADHOC))
567 return;
569 /*sleep after linked 10s, to let DHCP and 4-way handshake ok enough!! */
570 if ((mac->link_state != MAC80211_LINKED) || (mac->cnt_after_linked < 5))
571 return;
573 if (rtlpriv->link_info.busytraffic)
574 return;
576 spin_lock(&rtlpriv->locks.lps_lock);
577 rtl_ps_set_rf_state(hw, ERFSLEEP, RF_CHANGE_BY_PS);
578 spin_unlock(&rtlpriv->locks.lps_lock);
580 if (ppsc->reg_rfps_level & RT_RF_OFF_LEVL_ASPM &&
581 !RT_IN_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM)) {
582 rtlpriv->intf_ops->enable_aspm(hw);
583 RT_SET_PS_LEVEL(ppsc, RT_PS_LEVEL_ASPM);
586 /* here is power save alg, when this beacon is DTIM
587 * we will set sleep time to dtim_period * n;
588 * when this beacon is not DTIM, we will set sleep
589 * time to sleep_intv = rtlpriv->psc.dtim_counter or
590 * MAX_SW_LPS_SLEEP_INTV(default set to 5) */
592 if (rtlpriv->psc.dtim_counter == 0) {
593 if (hw->conf.ps_dtim_period == 1)
594 sleep_intv = hw->conf.ps_dtim_period * 2;
595 else
596 sleep_intv = hw->conf.ps_dtim_period;
597 } else {
598 sleep_intv = rtlpriv->psc.dtim_counter;
601 if (sleep_intv > MAX_SW_LPS_SLEEP_INTV)
602 sleep_intv = MAX_SW_LPS_SLEEP_INTV;
604 /* this print should always be dtim_conter = 0 &
605 * sleep = dtim_period, that meaons, we should
606 * awake before every dtim */
607 RT_TRACE(rtlpriv, COMP_POWER, DBG_DMESG,
608 ("dtim_counter:%x will sleep :%d"
609 " beacon_intv\n", rtlpriv->psc.dtim_counter, sleep_intv));
611 /* we tested that 40ms is enough for sw & hw sw delay */
612 queue_delayed_work(rtlpriv->works.rtl_wq, &rtlpriv->works.ps_rfon_wq,
613 MSECS(sleep_intv * mac->vif->bss_conf.beacon_int - 40));
617 void rtl_swlps_wq_callback(void *data)
619 struct rtl_works *rtlworks = container_of_dwork_rtl(data,
620 struct rtl_works,
621 ps_work);
622 struct ieee80211_hw *hw = rtlworks->hw;
623 struct rtl_priv *rtlpriv = rtl_priv(hw);
624 bool ps = false;
626 ps = (hw->conf.flags & IEEE80211_CONF_PS);
628 /* we can sleep after ps null send ok */
629 if (rtlpriv->psc.state_inap) {
630 rtl_swlps_rf_sleep(hw);
632 if (rtlpriv->psc.state && !ps) {
633 rtlpriv->psc.sleep_ms = jiffies_to_msecs(jiffies -
634 rtlpriv->psc.last_action);
637 if (ps)
638 rtlpriv->psc.last_slept = jiffies;
640 rtlpriv->psc.last_action = jiffies;
641 rtlpriv->psc.state = ps;