xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/realtek/rtw88/ps.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
2*4882a593Smuzhiyun /* Copyright(c) 2018-2019  Realtek Corporation
3*4882a593Smuzhiyun  */
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include "main.h"
6*4882a593Smuzhiyun #include "reg.h"
7*4882a593Smuzhiyun #include "fw.h"
8*4882a593Smuzhiyun #include "ps.h"
9*4882a593Smuzhiyun #include "mac.h"
10*4882a593Smuzhiyun #include "coex.h"
11*4882a593Smuzhiyun #include "debug.h"
12*4882a593Smuzhiyun 
rtw_ips_pwr_up(struct rtw_dev * rtwdev)13*4882a593Smuzhiyun static int rtw_ips_pwr_up(struct rtw_dev *rtwdev)
14*4882a593Smuzhiyun {
15*4882a593Smuzhiyun 	int ret;
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun 	ret = rtw_core_start(rtwdev);
18*4882a593Smuzhiyun 	if (ret)
19*4882a593Smuzhiyun 		rtw_err(rtwdev, "leave idle state failed\n");
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun 	rtw_set_channel(rtwdev);
22*4882a593Smuzhiyun 	clear_bit(RTW_FLAG_INACTIVE_PS, rtwdev->flags);
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun 	return ret;
25*4882a593Smuzhiyun }
26*4882a593Smuzhiyun 
rtw_enter_ips(struct rtw_dev * rtwdev)27*4882a593Smuzhiyun int rtw_enter_ips(struct rtw_dev *rtwdev)
28*4882a593Smuzhiyun {
29*4882a593Smuzhiyun 	set_bit(RTW_FLAG_INACTIVE_PS, rtwdev->flags);
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun 	rtw_coex_ips_notify(rtwdev, COEX_IPS_ENTER);
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun 	rtw_core_stop(rtwdev);
34*4882a593Smuzhiyun 	rtw_hci_link_ps(rtwdev, true);
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun 	return 0;
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun 
rtw_restore_port_cfg_iter(void * data,u8 * mac,struct ieee80211_vif * vif)39*4882a593Smuzhiyun static void rtw_restore_port_cfg_iter(void *data, u8 *mac,
40*4882a593Smuzhiyun 				      struct ieee80211_vif *vif)
41*4882a593Smuzhiyun {
42*4882a593Smuzhiyun 	struct rtw_dev *rtwdev = data;
43*4882a593Smuzhiyun 	struct rtw_vif *rtwvif = (struct rtw_vif *)vif->drv_priv;
44*4882a593Smuzhiyun 	u32 config = ~0;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	rtw_vif_port_config(rtwdev, rtwvif, config);
47*4882a593Smuzhiyun }
48*4882a593Smuzhiyun 
rtw_leave_ips(struct rtw_dev * rtwdev)49*4882a593Smuzhiyun int rtw_leave_ips(struct rtw_dev *rtwdev)
50*4882a593Smuzhiyun {
51*4882a593Smuzhiyun 	int ret;
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun 	rtw_hci_link_ps(rtwdev, false);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	ret = rtw_ips_pwr_up(rtwdev);
56*4882a593Smuzhiyun 	if (ret) {
57*4882a593Smuzhiyun 		rtw_err(rtwdev, "failed to leave ips state\n");
58*4882a593Smuzhiyun 		return ret;
59*4882a593Smuzhiyun 	}
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 	rtw_iterate_vifs_atomic(rtwdev, rtw_restore_port_cfg_iter, rtwdev);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	rtw_coex_ips_notify(rtwdev, COEX_IPS_LEAVE);
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	return 0;
66*4882a593Smuzhiyun }
67*4882a593Smuzhiyun 
rtw_power_mode_change(struct rtw_dev * rtwdev,bool enter)68*4882a593Smuzhiyun void rtw_power_mode_change(struct rtw_dev *rtwdev, bool enter)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun 	u8 request, confirm, polling;
71*4882a593Smuzhiyun 	u8 polling_cnt;
72*4882a593Smuzhiyun 	u8 retry_cnt = 0;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	for (retry_cnt = 0; retry_cnt < 3; retry_cnt++) {
75*4882a593Smuzhiyun 		request = rtw_read8(rtwdev, rtwdev->hci.rpwm_addr);
76*4882a593Smuzhiyun 		confirm = rtw_read8(rtwdev, rtwdev->hci.cpwm_addr);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 		/* toggle to request power mode, others remain 0 */
79*4882a593Smuzhiyun 		request ^= request | BIT_RPWM_TOGGLE;
80*4882a593Smuzhiyun 		if (!enter) {
81*4882a593Smuzhiyun 			request |= POWER_MODE_ACK;
82*4882a593Smuzhiyun 		} else {
83*4882a593Smuzhiyun 			request |= POWER_MODE_LCLK;
84*4882a593Smuzhiyun 			if (rtw_fw_lps_deep_mode == LPS_DEEP_MODE_PG)
85*4882a593Smuzhiyun 				request |= POWER_MODE_PG;
86*4882a593Smuzhiyun 		}
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 		rtw_write8(rtwdev, rtwdev->hci.rpwm_addr, request);
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 		if (enter)
91*4882a593Smuzhiyun 			return;
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 		/* check confirm power mode has left power save state */
94*4882a593Smuzhiyun 		for (polling_cnt = 0; polling_cnt < 50; polling_cnt++) {
95*4882a593Smuzhiyun 			polling = rtw_read8(rtwdev, rtwdev->hci.cpwm_addr);
96*4882a593Smuzhiyun 			if ((polling ^ confirm) & BIT_RPWM_TOGGLE)
97*4882a593Smuzhiyun 				return;
98*4882a593Smuzhiyun 			udelay(100);
99*4882a593Smuzhiyun 		}
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 		/* in case of fw/hw missed the request, retry */
102*4882a593Smuzhiyun 		rtw_warn(rtwdev, "failed to leave deep PS, retry=%d\n",
103*4882a593Smuzhiyun 			 retry_cnt);
104*4882a593Smuzhiyun 	}
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	/* Hit here means that driver failed to change hardware power mode to
107*4882a593Smuzhiyun 	 * active state after retry 3 times. If the power state is locked at
108*4882a593Smuzhiyun 	 * Deep sleep, most of the hardware circuits is not working, even
109*4882a593Smuzhiyun 	 * register read/write. It should be treated as fatal error and
110*4882a593Smuzhiyun 	 * requires an entire analysis about the firmware/hardware
111*4882a593Smuzhiyun 	 */
112*4882a593Smuzhiyun 	WARN(1, "Hardware power state locked\n");
113*4882a593Smuzhiyun }
114*4882a593Smuzhiyun EXPORT_SYMBOL(rtw_power_mode_change);
115*4882a593Smuzhiyun 
__rtw_leave_lps_deep(struct rtw_dev * rtwdev)116*4882a593Smuzhiyun static void __rtw_leave_lps_deep(struct rtw_dev *rtwdev)
117*4882a593Smuzhiyun {
118*4882a593Smuzhiyun 	rtw_hci_deep_ps(rtwdev, false);
119*4882a593Smuzhiyun }
120*4882a593Smuzhiyun 
rtw_fw_leave_lps_state_check(struct rtw_dev * rtwdev)121*4882a593Smuzhiyun static void rtw_fw_leave_lps_state_check(struct rtw_dev *rtwdev)
122*4882a593Smuzhiyun {
123*4882a593Smuzhiyun 	int i;
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	/* Driver needs to wait for firmware to leave LPS state
126*4882a593Smuzhiyun 	 * successfully. Firmware will send null packet to inform AP,
127*4882a593Smuzhiyun 	 * and see if AP sends an ACK back, then firmware will restore
128*4882a593Smuzhiyun 	 * the REG_TCR register.
129*4882a593Smuzhiyun 	 *
130*4882a593Smuzhiyun 	 * If driver does not wait for firmware, null packet with
131*4882a593Smuzhiyun 	 * PS bit could be sent due to incorrect REG_TCR setting.
132*4882a593Smuzhiyun 	 *
133*4882a593Smuzhiyun 	 * In our test, 100ms should be enough for firmware to finish
134*4882a593Smuzhiyun 	 * the flow. If REG_TCR Register is still incorrect after 100ms,
135*4882a593Smuzhiyun 	 * just modify it directly, and throw a warn message.
136*4882a593Smuzhiyun 	 */
137*4882a593Smuzhiyun 	for (i = 0 ; i < LEAVE_LPS_TRY_CNT; i++) {
138*4882a593Smuzhiyun 		if (rtw_read32_mask(rtwdev, REG_TCR, BIT_PWRMGT_HWDATA_EN) == 0)
139*4882a593Smuzhiyun 			return;
140*4882a593Smuzhiyun 		msleep(20);
141*4882a593Smuzhiyun 	}
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	rtw_write32_mask(rtwdev, REG_TCR, BIT_PWRMGT_HWDATA_EN, 0);
144*4882a593Smuzhiyun 	rtw_warn(rtwdev, "firmware failed to restore hardware setting\n");
145*4882a593Smuzhiyun }
146*4882a593Smuzhiyun 
rtw_leave_lps_core(struct rtw_dev * rtwdev)147*4882a593Smuzhiyun static void rtw_leave_lps_core(struct rtw_dev *rtwdev)
148*4882a593Smuzhiyun {
149*4882a593Smuzhiyun 	struct rtw_lps_conf *conf = &rtwdev->lps_conf;
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	conf->state = RTW_ALL_ON;
152*4882a593Smuzhiyun 	conf->awake_interval = 1;
153*4882a593Smuzhiyun 	conf->rlbm = 0;
154*4882a593Smuzhiyun 	conf->smart_ps = 0;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	rtw_hci_link_ps(rtwdev, false);
157*4882a593Smuzhiyun 	rtw_fw_set_pwr_mode(rtwdev);
158*4882a593Smuzhiyun 	rtw_fw_leave_lps_state_check(rtwdev);
159*4882a593Smuzhiyun 
160*4882a593Smuzhiyun 	clear_bit(RTW_FLAG_LEISURE_PS, rtwdev->flags);
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 	rtw_coex_lps_notify(rtwdev, COEX_LPS_DISABLE);
163*4882a593Smuzhiyun }
164*4882a593Smuzhiyun 
__rtw_enter_lps_deep(struct rtw_dev * rtwdev)165*4882a593Smuzhiyun static void __rtw_enter_lps_deep(struct rtw_dev *rtwdev)
166*4882a593Smuzhiyun {
167*4882a593Smuzhiyun 	if (rtwdev->lps_conf.deep_mode == LPS_DEEP_MODE_NONE)
168*4882a593Smuzhiyun 		return;
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	if (!test_bit(RTW_FLAG_LEISURE_PS, rtwdev->flags)) {
171*4882a593Smuzhiyun 		rtw_dbg(rtwdev, RTW_DBG_PS,
172*4882a593Smuzhiyun 			"Should enter LPS before entering deep PS\n");
173*4882a593Smuzhiyun 		return;
174*4882a593Smuzhiyun 	}
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 	if (rtw_fw_lps_deep_mode == LPS_DEEP_MODE_PG)
177*4882a593Smuzhiyun 		rtw_fw_set_pg_info(rtwdev);
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 	rtw_hci_deep_ps(rtwdev, true);
180*4882a593Smuzhiyun }
181*4882a593Smuzhiyun 
rtw_enter_lps_core(struct rtw_dev * rtwdev)182*4882a593Smuzhiyun static void rtw_enter_lps_core(struct rtw_dev *rtwdev)
183*4882a593Smuzhiyun {
184*4882a593Smuzhiyun 	struct rtw_lps_conf *conf = &rtwdev->lps_conf;
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	conf->state = RTW_RF_OFF;
187*4882a593Smuzhiyun 	conf->awake_interval = 1;
188*4882a593Smuzhiyun 	conf->rlbm = 1;
189*4882a593Smuzhiyun 	conf->smart_ps = 2;
190*4882a593Smuzhiyun 
191*4882a593Smuzhiyun 	rtw_coex_lps_notify(rtwdev, COEX_LPS_ENABLE);
192*4882a593Smuzhiyun 
193*4882a593Smuzhiyun 	rtw_fw_set_pwr_mode(rtwdev);
194*4882a593Smuzhiyun 	rtw_hci_link_ps(rtwdev, true);
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun 	set_bit(RTW_FLAG_LEISURE_PS, rtwdev->flags);
197*4882a593Smuzhiyun }
198*4882a593Smuzhiyun 
__rtw_enter_lps(struct rtw_dev * rtwdev,u8 port_id)199*4882a593Smuzhiyun static void __rtw_enter_lps(struct rtw_dev *rtwdev, u8 port_id)
200*4882a593Smuzhiyun {
201*4882a593Smuzhiyun 	struct rtw_lps_conf *conf = &rtwdev->lps_conf;
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun 	if (test_bit(RTW_FLAG_LEISURE_PS, rtwdev->flags))
204*4882a593Smuzhiyun 		return;
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	conf->mode = RTW_MODE_LPS;
207*4882a593Smuzhiyun 	conf->port_id = port_id;
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun 	rtw_enter_lps_core(rtwdev);
210*4882a593Smuzhiyun }
211*4882a593Smuzhiyun 
__rtw_leave_lps(struct rtw_dev * rtwdev)212*4882a593Smuzhiyun static void __rtw_leave_lps(struct rtw_dev *rtwdev)
213*4882a593Smuzhiyun {
214*4882a593Smuzhiyun 	struct rtw_lps_conf *conf = &rtwdev->lps_conf;
215*4882a593Smuzhiyun 
216*4882a593Smuzhiyun 	if (test_and_clear_bit(RTW_FLAG_LEISURE_PS_DEEP, rtwdev->flags)) {
217*4882a593Smuzhiyun 		rtw_dbg(rtwdev, RTW_DBG_PS,
218*4882a593Smuzhiyun 			"Should leave deep PS before leaving LPS\n");
219*4882a593Smuzhiyun 		__rtw_leave_lps_deep(rtwdev);
220*4882a593Smuzhiyun 	}
221*4882a593Smuzhiyun 
222*4882a593Smuzhiyun 	if (!test_bit(RTW_FLAG_LEISURE_PS, rtwdev->flags))
223*4882a593Smuzhiyun 		return;
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 	conf->mode = RTW_MODE_ACTIVE;
226*4882a593Smuzhiyun 
227*4882a593Smuzhiyun 	rtw_leave_lps_core(rtwdev);
228*4882a593Smuzhiyun }
229*4882a593Smuzhiyun 
rtw_enter_lps(struct rtw_dev * rtwdev,u8 port_id)230*4882a593Smuzhiyun void rtw_enter_lps(struct rtw_dev *rtwdev, u8 port_id)
231*4882a593Smuzhiyun {
232*4882a593Smuzhiyun 	lockdep_assert_held(&rtwdev->mutex);
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun 	if (rtwdev->coex.stat.wl_force_lps_ctrl)
235*4882a593Smuzhiyun 		return;
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun 	__rtw_enter_lps(rtwdev, port_id);
238*4882a593Smuzhiyun 	__rtw_enter_lps_deep(rtwdev);
239*4882a593Smuzhiyun }
240*4882a593Smuzhiyun 
rtw_leave_lps(struct rtw_dev * rtwdev)241*4882a593Smuzhiyun void rtw_leave_lps(struct rtw_dev *rtwdev)
242*4882a593Smuzhiyun {
243*4882a593Smuzhiyun 	lockdep_assert_held(&rtwdev->mutex);
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun 	__rtw_leave_lps_deep(rtwdev);
246*4882a593Smuzhiyun 	__rtw_leave_lps(rtwdev);
247*4882a593Smuzhiyun }
248*4882a593Smuzhiyun 
rtw_leave_lps_deep(struct rtw_dev * rtwdev)249*4882a593Smuzhiyun void rtw_leave_lps_deep(struct rtw_dev *rtwdev)
250*4882a593Smuzhiyun {
251*4882a593Smuzhiyun 	lockdep_assert_held(&rtwdev->mutex);
252*4882a593Smuzhiyun 
253*4882a593Smuzhiyun 	__rtw_leave_lps_deep(rtwdev);
254*4882a593Smuzhiyun }
255