xref: /freebsd/sys/dev/ath/ath_hal/ar5211/ar5211_power.c (revision 63a938566d524836885917d95bd491aa4400b181)
1 /*-
2  * SPDX-License-Identifier: ISC
3  *
4  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
5  * Copyright (c) 2002-2006 Atheros Communications, Inc.
6  *
7  * Permission to use, copy, modify, and/or distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  *
19  * $FreeBSD$
20  */
21 #include "opt_ah.h"
22 
23 #include "ah.h"
24 #include "ah_internal.h"
25 
26 #include "ar5211/ar5211.h"
27 #include "ar5211/ar5211reg.h"
28 #include "ar5211/ar5211desc.h"
29 
30 /*
31  * Notify Power Mgt is enabled in self-generated frames.
32  * If requested, force chip awake.
33  *
34  * Returns A_OK if chip is awake or successfully forced awake.
35  *
36  * WARNING WARNING WARNING
37  * There is a problem with the chip where sometimes it will not wake up.
38  */
39 static HAL_BOOL
40 ar5211SetPowerModeAwake(struct ath_hal *ah, int setChip)
41 {
42 #define	POWER_UP_TIME	2000
43 	uint32_t val;
44 	int i;
45 
46 	if (setChip) {
47 		OS_REG_RMW_FIELD(ah, AR_SCR, AR_SCR_SLE, AR_SCR_SLE_WAKE);
48 		OS_DELAY(10);	/* Give chip the chance to awake */
49 
50 		for (i = POWER_UP_TIME / 200; i != 0; i--) {
51 			val = OS_REG_READ(ah, AR_PCICFG);
52 			if ((val & AR_PCICFG_SPWR_DN) == 0)
53 				break;
54 			OS_DELAY(200);
55 			OS_REG_RMW_FIELD(ah, AR_SCR, AR_SCR_SLE,
56 				AR_SCR_SLE_WAKE);
57 		}
58 		if (i == 0) {
59 #ifdef AH_DEBUG
60 			ath_hal_printf(ah, "%s: Failed to wakeup in %ums\n",
61 				__func__, POWER_UP_TIME/20);
62 #endif
63 			return AH_FALSE;
64 		}
65 	}
66 
67 	OS_REG_CLR_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
68 	return AH_TRUE;
69 #undef POWER_UP_TIME
70 }
71 
72 /*
73  * Notify Power Mgt is disabled in self-generated frames.
74  * If requested, force chip to sleep.
75  */
76 static void
77 ar5211SetPowerModeSleep(struct ath_hal *ah, int setChip)
78 {
79 	OS_REG_SET_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
80 	if (setChip)
81 		OS_REG_RMW_FIELD(ah, AR_SCR, AR_SCR_SLE, AR_SCR_SLE_SLP);
82 }
83 
84 /*
85  * Notify Power Management is enabled in self-generating
86  * fames.  If request, set power mode of chip to
87  * auto/normal.  Duration in units of 128us (1/8 TU).
88  */
89 static void
90 ar5211SetPowerModeNetworkSleep(struct ath_hal *ah, int setChip)
91 {
92 	OS_REG_SET_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
93 	if (setChip)
94 		OS_REG_RMW_FIELD(ah, AR_SCR, AR_SCR_SLE, AR_SCR_SLE_NORM);
95 }
96 
97 HAL_BOOL
98 ar5211SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode, int setChip)
99 {
100 #ifdef AH_DEBUG
101 	static const char* modes[] = {
102 		"AWAKE",
103 		"FULL-SLEEP",
104 		"NETWORK SLEEP",
105 		"UNDEFINED"
106 	};
107 #endif
108 	int status = AH_TRUE;
109 
110 	HALDEBUG(ah, HAL_DEBUG_POWER, "%s: %s -> %s (%s)\n", __func__,
111 		modes[ah->ah_powerMode], modes[mode],
112 		setChip ? "set chip " : "");
113 	switch (mode) {
114 	case HAL_PM_AWAKE:
115 		if (setChip)
116 			ah->ah_powerMode = mode;
117 		status = ar5211SetPowerModeAwake(ah, setChip);
118 		break;
119 	case HAL_PM_FULL_SLEEP:
120 		ar5211SetPowerModeSleep(ah, setChip);
121 		if (setChip)
122 			ah->ah_powerMode = mode;
123 		break;
124 	case HAL_PM_NETWORK_SLEEP:
125 		ar5211SetPowerModeNetworkSleep(ah, setChip);
126 		if (setChip)
127 			ah->ah_powerMode = mode;
128 		break;
129 	default:
130 		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: unknown power mode %u\n",
131 		    __func__, mode);
132 		return AH_FALSE;
133 	}
134 	return status;
135 }
136 
137 HAL_POWER_MODE
138 ar5211GetPowerMode(struct ath_hal *ah)
139 {
140 	/* Just so happens the h/w maps directly to the abstracted value */
141 	return MS(OS_REG_READ(ah, AR_SCR), AR_SCR_SLE);
142 }
143