Home | History | Annotate | Line # | Download | only in ar5416
      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: ar5416_power.c,v 1.1.1.1 2008/12/11 04:46:48 alc Exp $
     18  */
     19 #include "opt_ah.h"
     20 
     21 #include "ah.h"
     22 #include "ah_internal.h"
     23 
     24 #include "ar5416/ar5416.h"
     25 #include "ar5416/ar5416reg.h"
     26 
     27 /*
     28  * Notify Power Mgt is enabled in self-generated frames.
     29  * If requested, force chip awake.
     30  *
     31  * Returns A_OK if chip is awake or successfully forced awake.
     32  *
     33  * WARNING WARNING WARNING
     34  * There is a problem with the chip where sometimes it will not wake up.
     35  */
     36 static HAL_BOOL
     37 ar5416SetPowerModeAwake(struct ath_hal *ah, int setChip)
     38 {
     39 #define	POWER_UP_TIME	200000
     40 	uint32_t val;
     41 	int i = 0;
     42 
     43 	if (setChip) {
     44 		/*
     45 		 * Do a Power-On-Reset if OWL is shutdown
     46 		 * the NetBSD driver  power-cycles the Cardbus slot
     47 		 * as part of the reset procedure.
     48 		 */
     49 		if ((OS_REG_READ(ah, AR_RTC_STATUS)
     50 			& AR_RTC_PM_STATUS_M) == AR_RTC_STATUS_SHUTDOWN) {
     51 			if (!ar5416SetResetReg(ah, HAL_RESET_POWER_ON))
     52 				goto bad;
     53 		}
     54 
     55 		OS_REG_SET_BIT(ah, AR_RTC_FORCE_WAKE, AR_RTC_FORCE_WAKE_EN);
     56 		OS_DELAY(50);   /* Give chip the chance to awake */
     57 
     58 		for (i = POWER_UP_TIME / 50; i != 0; i--) {
     59 			val = OS_REG_READ(ah, AR_RTC_STATUS) & AR_RTC_STATUS_M;
     60 			if (val == AR_RTC_STATUS_ON)
     61 				break;
     62 			OS_DELAY(50);
     63 			OS_REG_SET_BIT(ah, AR_RTC_FORCE_WAKE, AR_RTC_FORCE_WAKE_EN);
     64 		}
     65 	bad:
     66 		if (i == 0) {
     67 #ifdef AH_DEBUG
     68 			ath_hal_printf(ah, "%s: Failed to wakeup in %ums\n",
     69 				__func__, POWER_UP_TIME/1000);
     70 #endif
     71 			return AH_FALSE;
     72 		}
     73 	}
     74 
     75 	OS_REG_CLR_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
     76 	return AH_TRUE;
     77 #undef POWER_UP_TIME
     78 }
     79 
     80 /*
     81  * Notify Power Mgt is disabled in self-generated frames.
     82  * If requested, force chip to sleep.
     83  */
     84 static void
     85 ar5416SetPowerModeSleep(struct ath_hal *ah, int setChip)
     86 {
     87 	OS_REG_SET_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
     88 	if (setChip) {
     89 		/* Clear the RTC force wake bit to allow the mac to sleep */
     90 		OS_REG_CLR_BIT(ah, AR_RTC_FORCE_WAKE, AR_RTC_FORCE_WAKE_EN);
     91 		OS_REG_WRITE(ah, AR_RC, AR_RC_AHB|AR_RC_HOSTIF);
     92 		/* Shutdown chip. Active low */
     93 		OS_REG_CLR_BIT(ah, AR_RTC_RESET, AR_RTC_RESET_EN);
     94 	}
     95 }
     96 
     97 /*
     98  * Notify Power Management is enabled in self-generating
     99  * fames.  If request, set power mode of chip to
    100  * auto/normal.  Duration in units of 128us (1/8 TU).
    101  */
    102 static void
    103 ar5416SetPowerModeNetworkSleep(struct ath_hal *ah, int setChip)
    104 {
    105 	OS_REG_SET_BIT(ah, AR_STA_ID1, AR_STA_ID1_PWR_SAV);
    106 
    107 	if (setChip)
    108 		OS_REG_CLR_BIT(ah, AR_RTC_FORCE_WAKE, AR_RTC_FORCE_WAKE_EN);
    109 }
    110 
    111 /*
    112  * Set power mgt to the requested mode, and conditionally set
    113  * the chip as well
    114  */
    115 HAL_BOOL
    116 ar5416SetPowerMode(struct ath_hal *ah, HAL_POWER_MODE mode, int setChip)
    117 {
    118 	struct ath_hal_5212 *ahp = AH5212(ah);
    119 #ifdef AH_DEBUG
    120 	static const char* modes[] = {
    121 		"AWAKE",
    122 		"FULL-SLEEP",
    123 		"NETWORK SLEEP",
    124 		"UNDEFINED"
    125 	};
    126 #endif
    127 	int status = AH_TRUE;
    128 	if (!setChip)
    129 		return AH_TRUE;
    130 
    131 	HALDEBUG(ah, HAL_DEBUG_POWER, "%s: %s -> %s (%s)\n", __func__,
    132 	    modes[ahp->ah_powerMode], modes[mode], setChip ? "set chip " : "");
    133 	switch (mode) {
    134 	case HAL_PM_AWAKE:
    135 		status = ar5416SetPowerModeAwake(ah, setChip);
    136 		break;
    137 	case HAL_PM_FULL_SLEEP:
    138 		ar5416SetPowerModeSleep(ah, setChip);
    139 		break;
    140 	case HAL_PM_NETWORK_SLEEP:
    141 		ar5416SetPowerModeNetworkSleep(ah, setChip);
    142 		break;
    143 	default:
    144 		HALDEBUG(ah, HAL_DEBUG_ANY, "%s: unknown power mode 0x%x\n",
    145 		    __func__, mode);
    146 		return AH_FALSE;
    147 	}
    148 	ahp->ah_powerMode = mode;
    149 	return status;
    150 }
    151 
    152 /*
    153  * Return the current sleep mode of the chip
    154  */
    155 HAL_POWER_MODE
    156 ar5416GetPowerMode(struct ath_hal *ah)
    157 {
    158 	int mode = OS_REG_READ(ah, AR_RTC_STATUS);
    159 	switch (mode & AR_RTC_PM_STATUS_M) {
    160 	case AR_RTC_STATUS_ON:
    161 	case AR_RTC_STATUS_WAKEUP:
    162 		return HAL_PM_AWAKE;
    163 	case AR_RTC_STATUS_SLEEP:
    164 		return HAL_PM_NETWORK_SLEEP;
    165 	case AR_RTC_STATUS_SHUTDOWN:
    166 		return HAL_PM_FULL_SLEEP;
    167 	default:
    168 		HALDEBUG(ah, HAL_DEBUG_ANY,
    169 		    "%s: unknown power mode, RTC_STATUS 0x%x\n",
    170 		    __func__, mode);
    171 		return HAL_PM_UNDEFINED;
    172 	}
    173 }
    174