1/*
2 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
3 * Copyright (c) 2002-2008 Atheros Communications, Inc.
4 *
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 *
17 * $Id: ar5212_power.c,v 1.4 2008/11/10 04:08:03 sam Exp $
18 */
19#include "opt_ah.h"
20
21#ifdef AH_SUPPORT_AR5212
22
23#include "ah.h"
24#include "ah_internal.h"
25
26#include "ar5212/ar5212.h"
27#include "ar5212/ar5212reg.h"
28#include "ar5212/ar5212desc.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 */
39static HAL_BOOL
40ar5212SetPowerModeAwake(struct ath_hal *ah, int setChip)
41{
42#define AR_SCR_MASK \
43 (AR_SCR_SLDUR|AR_SCR_SLE|AR_SCR_SLE|AR_SCR_SLDTP|AR_SCR_SLDWP|\
44 AR_SCR_SLEPOL|AR_SCR_MIBIE)
45#define POWER_UP_TIME 2000
46 uint32_t scr, val;
47 int i;
48
49 if (setChip) {
50 /*
51 * Be careful setting the AWAKE mode. When we are called
52 * with the chip powered down the read returns 0xffffffff
53 * which when blindly written back with OS_REG_RMW_FIELD
54 * enables the MIB interrupt for the sleep performance
55 * counters. This can result in an interrupt storm when
56 * ANI is in operation as noone knows to turn off the MIB
57 * interrupt cause.
58 */
59 scr = OS_REG_READ(ah, AR_SCR);
60 if (scr & ~AR_SCR_MASK) {
61 HALDEBUG(ah, HAL_DEBUG_ANY,
62 "%s: bogus SCR 0x%x, PCICFG 0x%x\n",
63 __func__, scr, OS_REG_READ(ah, AR_PCICFG));
64 scr = 0;
65 }
66 scr = (scr &~ AR_SCR_SLE) | AR_SCR_SLE_WAKE;
67 OS_REG_WRITE(ah, AR_SCR, scr);
68 OS_DELAY(10); /* Give chip the chance to awake */
69
70 for (i = POWER_UP_TIME / 50; i != 0; i--) {
71 val = OS_REG_READ(ah, AR_PCICFG);
72 if ((val & AR_PCICFG_SPWR_DN) == 0)
73 break;
74 OS_DELAY(50);
75 OS_REG_WRITE(ah, AR_SCR, scr);
76 }
77 if (i == 0) {
78#ifdef AH_DEBUG
79 ath_hal_printf(ah, "%s: Failed to wakeup in %ums\n",
80 __func__, POWER_UP_TIME/50);
81#endif
82 return AH_FALSE;
83 }
84 }
85
86 OS_REG_CLR_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
87 return AH_TRUE;
88#undef POWER_UP_TIME
89#undef AR_SCR_MASK
90}
91
92/*
93 * Notify Power Mgt is disabled in self-generated frames.
94 * If requested, force chip to sleep.
95 */
96static void
97ar5212SetPowerModeSleep(struct ath_hal *ah, int setChip)
98{
99 OS_REG_SET_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
100 if (setChip)
101 OS_REG_RMW_FIELD(ah, AR_SCR, AR_SCR_SLE, AR_SCR_SLE_SLP);
102}
103
104/*
105 * Notify Power Management is enabled in self-generating
106 * fames. If request, set power mode of chip to
107 * auto/normal. Duration in units of 128us (1/8 TU).
108 */
109static void
110ar5212SetPowerModeNetworkSleep(struct ath_hal *ah, int setChip)
111{
112 OS_REG_SET_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
113 if (setChip)
114 OS_REG_RMW_FIELD(ah, AR_SCR, AR_SCR_SLE, AR_SCR_SLE_NORM);
115}
116
117/*
118 * Set power mgt to the requested mode, and conditionally set
119 * the chip as well
120 */
121HAL_BOOL
122ar5212SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode, int setChip)
123{
124 struct ath_hal_5212 *ahp = AH5212(ah);
125#ifdef AH_DEBUG
126 static const char* modes[] = {
127 "AWAKE",
128 "FULL-SLEEP",
129 "NETWORK SLEEP",
130 "UNDEFINED"
131 };
132#endif
133 int status = AH_TRUE;
134
135 HALDEBUG(ah, HAL_DEBUG_POWER, "%s: %s -> %s (%s)\n", __func__,
136 modes[ahp->ah_powerMode], modes[mode],
137 setChip ? "set chip " : "");
138 switch (mode) {
139 case HAL_PM_AWAKE:
140 status = ar5212SetPowerModeAwake(ah, setChip);
141 break;
142 case HAL_PM_FULL_SLEEP:
143 ar5212SetPowerModeSleep(ah, setChip);
144 break;
145 case HAL_PM_NETWORK_SLEEP:
146 ar5212SetPowerModeNetworkSleep(ah, setChip);
147 break;
148 default:
149 HALDEBUG(ah, HAL_DEBUG_ANY, "%s: unknown power mode %u\n",
150 __func__, mode);
151 return AH_FALSE;
152 }
153 ahp->ah_powerMode = mode;
154 return status;
155}
156
157/*
158 * Return the current sleep mode of the chip
159 */
160HAL_POWER_MODE
161ar5212GetPowerMode(struct ath_hal *ah)
162{
163 /* Just so happens the h/w maps directly to the abstracted value */
164 return MS(OS_REG_READ(ah, AR_SCR), AR_SCR_SLE);
165}
166
167#if 0
168/*
169 * Return the current sleep state of the chip
170 * TRUE = sleeping
171 */
172HAL_BOOL
173ar5212GetPowerStatus(struct ath_hal *ah)
174{
175 return (OS_REG_READ(ah, AR_PCICFG) & AR_PCICFG_SPWR_DN) != 0;
176}
177#endif
178#endif /* AH_SUPPORT_AR5212 */