786aa19cbd
Bug fixes include: - keep interrupts disabled during lpm_sleep() so that we don't miss any interrupts we may have been expecting - check that the pending etimer isn't already expired (and don't sleep at all if it is) - check that the about-to-be scheduled rtimer wakeup is neither too far into the future nor too close into the future (or even in the past) before actually setting the interrupt (should fix #1509); If the time is out of bounds we use a default min or max value instead. - Correctly handle LPM_MODE_MAX_SUPPORTED set to zero (and added a macro for the zero value) so that sleeping can be disabled altogether - If no etimer is set, we specify a wakeup time which is reasonably far into the future instead of setting none at all (this will save on power consumption whenever no etimers are set). Also did a bit of refactoring in that some long functions were broken into multiple functions.
161 lines
6.6 KiB
C
161 lines
6.6 KiB
C
/*
|
|
* Copyright (c) 2014, Texas Instruments Incorporated - http://www.ti.com/
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holder nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
/*---------------------------------------------------------------------------*/
|
|
/**
|
|
* \addtogroup cc26xx
|
|
* @{
|
|
*
|
|
* \defgroup cc26xx-lpm CC13xx/CC26xx Low-Power management
|
|
*
|
|
* CC13xx/CC26xx low-power operation
|
|
*
|
|
* @{
|
|
*
|
|
* \file
|
|
* Header file for the management of CC13xx/CC26xx low-power operation
|
|
*/
|
|
/*---------------------------------------------------------------------------*/
|
|
#ifndef LPM_H_
|
|
#define LPM_H_
|
|
/*---------------------------------------------------------------------------*/
|
|
#include "pwr_ctrl.h"
|
|
|
|
#include <stdint.h>
|
|
/*---------------------------------------------------------------------------*/
|
|
#define LPM_MODE_AWAKE 0
|
|
#define LPM_MODE_SLEEP 1
|
|
#define LPM_MODE_DEEP_SLEEP 2
|
|
#define LPM_MODE_SHUTDOWN 3
|
|
|
|
#define LPM_MODE_MAX_SUPPORTED LPM_MODE_DEEP_SLEEP
|
|
/*---------------------------------------------------------------------------*/
|
|
#define LPM_DOMAIN_NONE 0
|
|
#define LPM_DOMAIN_SERIAL PRCM_DOMAIN_SERIAL
|
|
#define LPM_DOMAIN_PERIPH PRCM_DOMAIN_PERIPH
|
|
/*---------------------------------------------------------------------------*/
|
|
typedef struct lpm_registered_module {
|
|
struct lpm_registered_module *next;
|
|
uint8_t (*request_max_pm)(void);
|
|
void (*shutdown)(uint8_t mode);
|
|
void (*wakeup)(void);
|
|
uint32_t domain_lock;
|
|
} lpm_registered_module_t;
|
|
/*---------------------------------------------------------------------------*/
|
|
/**
|
|
* \brief Declare a variable to be used in order to get notifications from LPM
|
|
* \param n the variable name to be declared
|
|
* \param m A pointer to a function which will tell the LPM module the max
|
|
* PM this module is willing to handle. This function will return
|
|
* LPM_MODE_SLEEP, LPM_MODE_DEEP_SLEEP etc. The LPM module will ask all
|
|
* registered modules and will trigger the highest LPM permitted
|
|
* \param s A pointer to a function which will receive a notification just
|
|
* before entering the low power mode. The callee can prepare for the
|
|
* imminent LPM state. The argument to this function will be the
|
|
* upcoming low power mode. This function can e.g. turn off a
|
|
* peripheral before the LPM module shuts down the power domain.
|
|
* \param w A pointer to a function which will be called just after we have
|
|
* woken up. This can be used to e.g. turn a peripheral back on. This
|
|
* function is in charge of turning power domains back on. This
|
|
* function will normally be called within an interrupt context.
|
|
* \param l Power domain locks, if any are required. The module can request
|
|
* that the SERIAL or PERIPH PD be kept powered up at the transition
|
|
* to deep sleep. This field can be a bitwise OR of LPM_DOMAIN_x, so
|
|
* if required multiple domains can be kept powered.
|
|
*/
|
|
#define LPM_MODULE(n, m, s, w, l) static lpm_registered_module_t n = \
|
|
{ NULL, m, s, w, l }
|
|
/*---------------------------------------------------------------------------*/
|
|
/**
|
|
* \brief Drop the cortex to sleep / deep sleep and shut down peripherals
|
|
*
|
|
* Whether the cortex will drop to sleep or deep sleep is configurable. The
|
|
* exact peripherals which will be shut down is also configurable
|
|
*/
|
|
void lpm_drop(void);
|
|
|
|
/**
|
|
* \brief Enter sleep mode
|
|
*/
|
|
void lpm_sleep(void);
|
|
|
|
/**
|
|
* \brief Put the chip in shutdown power mode
|
|
* \param wakeup_pin The GPIO pin which will wake us up. Must be IOID_0 etc...
|
|
* \param io_pull Pull configuration for the shutdown pin: IOC_NO_IOPULL,
|
|
* IOC_IOPULL_UP or IOC_IOPULL_DOWN
|
|
* \param wake_on High or Low (IOC_WAKE_ON_LOW or IOC_WAKE_ON_HIGH)
|
|
*/
|
|
void lpm_shutdown(uint32_t wakeup_pin, uint32_t io_pull, uint32_t wake_on);
|
|
|
|
/**
|
|
* \brief Register a module for LPM notifications.
|
|
* \param module A pointer to the data structure with the module definition
|
|
*
|
|
* When the LPM module is about to drop to some low power mode, it will first
|
|
* notify all modules about this.
|
|
*
|
|
* This function must not be called before the module has been initialised
|
|
* with lpm_init(). The code does not perform checks: This is the caller's
|
|
* responsibility.
|
|
*/
|
|
void lpm_register_module(lpm_registered_module_t *module);
|
|
|
|
/**
|
|
* \brief Unregister a module from LPM notifications.
|
|
* \param module A pointer to the data structure with the module definition
|
|
*
|
|
* When a previously registered module is no longer interested in LPM
|
|
* notifications, this function can be used to unregister it.
|
|
*/
|
|
void lpm_unregister_module(lpm_registered_module_t *module);
|
|
|
|
/**
|
|
* \brief Initialise the low-power mode management module
|
|
*/
|
|
void lpm_init(void);
|
|
|
|
/**
|
|
* \brief Sets an IOID to a default state
|
|
* \param ioid IOID_0...
|
|
*
|
|
* This will set ioid to sw control, input, no pull. Input buffer and output
|
|
* driver will both be disabled
|
|
*
|
|
* The function will do nothing if ioid == IOID_UNUSED, so the caller does not
|
|
* have to check board configuration before calling this.
|
|
*/
|
|
void lpm_pin_set_default_state(uint32_t ioid);
|
|
/*---------------------------------------------------------------------------*/
|
|
#endif /* LPM_H_ */
|
|
/*---------------------------------------------------------------------------*/
|
|
/**
|
|
* @}
|
|
* @}
|
|
*/
|