xref: /freebsd/sys/dev/ath/ath_hal/ar5312/ar5312_power.c (revision 02e9120893770924227138ba49df1edb3896112a)
1 /*-
2  * SPDX-License-Identifier: ISC
3  *
4  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
5  * Copyright (c) 2002-2008 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 #include "opt_ah.h"
20 
21 #ifdef AH_SUPPORT_AR5312
22 
23 #include "ah.h"
24 #include "ah_internal.h"
25 
26 #include "ar5312/ar5312.h"
27 #include "ar5312/ar5312reg.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  */
39 static HAL_BOOL
40 ar5312SetPowerModeAwake(struct ath_hal *ah, int setChip)
41 {
42         /* No need for this at the moment for APs */
43 	return AH_TRUE;
44 }
45 
46 /*
47  * Notify Power Mgt is disabled in self-generated frames.
48  * If requested, force chip to sleep.
49  */
50 static void
51 ar5312SetPowerModeSleep(struct ath_hal *ah, int setChip)
52 {
53         /* No need for this at the moment for APs */
54 }
55 
56 /*
57  * Notify Power Management is enabled in self-generating
58  * fames.  If request, set power mode of chip to
59  * auto/normal.  Duration in units of 128us (1/8 TU).
60  */
61 static void
62 ar5312SetPowerModeNetworkSleep(struct ath_hal *ah, int setChip)
63 {
64         /* No need for this at the moment for APs */
65 }
66 
67 /*
68  * Set power mgt to the requested mode, and conditionally set
69  * the chip as well
70  */
71 HAL_BOOL
72 ar5312SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode, int setChip)
73 {
74 #ifdef AH_DEBUG
75 	static const char* modes[] = {
76 		"AWAKE",
77 		"FULL-SLEEP",
78 		"NETWORK SLEEP",
79 		"UNDEFINED"
80 	};
81 #endif
82 	int status = AH_TRUE;
83 
84 	HALDEBUG(ah, HAL_DEBUG_POWER, "%s: %s -> %s (%s)\n", __func__,
85 		modes[ah->ah_powerMode], modes[mode],
86 		setChip ? "set chip " : "");
87 	switch (mode) {
88 	case HAL_PM_AWAKE:
89 		status = ar5312SetPowerModeAwake(ah, setChip);
90 		break;
91 	case HAL_PM_FULL_SLEEP:
92 		ar5312SetPowerModeSleep(ah, setChip);
93 		break;
94 	case HAL_PM_NETWORK_SLEEP:
95 		ar5312SetPowerModeNetworkSleep(ah, setChip);
96 		break;
97 	default:
98 		HALDEBUG(ah, HAL_DEBUG_POWER, "%s: unknown power mode %u\n",
99 		    __func__, mode);
100 		return AH_FALSE;
101 	}
102 	ah->ah_powerMode = mode;
103 	return status;
104 }
105 
106 /*
107  * Return the current sleep mode of the chip
108  */
109 uint32_t
110 ar5312GetPowerMode(struct ath_hal *ah)
111 {
112 	return HAL_PM_AWAKE;
113 }
114 
115 /*
116  * Return the current sleep state of the chip
117  * TRUE = sleeping
118  */
119 HAL_BOOL
120 ar5312GetPowerStatus(struct ath_hal *ah)
121 {
122         return 0;		/* Currently, 5312 is never in sleep mode. */
123 }
124 #endif /* AH_SUPPORT_AR5312 */
125