Fixed line endings and SVN props with fixup.sh script
This commit is contained in:
skarg
@@ -1,169 +1,169 @@
|
||||
/**
|
||||
* \file
|
||||
*
|
||||
* \brief Sleep controller driver
|
||||
*
|
||||
* Copyright (c) 2010 Atmel Corporation. All rights reserved.
|
||||
*
|
||||
* \asf_license_start
|
||||
*
|
||||
* \page License
|
||||
*
|
||||
* 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. The name of Atmel may not be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* 4. This software may only be redistributed and used in connection with an
|
||||
* Atmel microcontroller product.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
||||
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
||||
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
|
||||
*
|
||||
* \asf_license_stop
|
||||
*
|
||||
*/
|
||||
#ifndef SLEEP_H
|
||||
#define SLEEP_H
|
||||
|
||||
#include <compiler.h>
|
||||
|
||||
/**
|
||||
* \defgroup sleep_group Sleep controller driver
|
||||
*
|
||||
* This is a low-level driver implementation for the AVR XMEGA sleep controller.
|
||||
*
|
||||
* \note To minimize the code overhead, these functions do not feature
|
||||
* interrupt-protected access since they are likely to be called inside
|
||||
* interrupt handlers or in applications where such protection is not
|
||||
* necessary. If such protection is needed, it must be ensured by the calling
|
||||
* code.
|
||||
*
|
||||
* \section xmega_sleep_quickstart_section Quick Start Guide
|
||||
* See \ref xmega_sleep_quickstart
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if defined(__ICCAVR__) || defined(__DOXYGEN__)
|
||||
# include <intrinsics.h>
|
||||
//! Macro for issuing the sleep instruction.
|
||||
# define sleep_enter() __sleep()
|
||||
|
||||
/**
|
||||
* \brief Enable sleep
|
||||
*/
|
||||
static inline void
|
||||
sleep_enable (void)
|
||||
{
|
||||
SLEEP.CTRL |= SLEEP_SEN_bm;
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Disable sleep
|
||||
*/
|
||||
static inline void
|
||||
sleep_disable (void)
|
||||
{
|
||||
SLEEP.CTRL &= ~SLEEP_SEN_bm;
|
||||
}
|
||||
|
||||
#elif defined(__GNUC__)
|
||||
# include <avr/sleep.h>
|
||||
# define sleep_enter() sleep_cpu()
|
||||
|
||||
#else
|
||||
# error Unsupported compiler.
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \brief Set new sleep mode
|
||||
*
|
||||
* \param mode Sleep mode, from the device IO header file.
|
||||
*/
|
||||
static inline void
|
||||
sleep_set_mode (enum SLEEP_SMODE_enum mode)
|
||||
{
|
||||
SLEEP.CTRL = mode | (SLEEP.CTRL & ~SLEEP_SMODE_gm);
|
||||
}
|
||||
|
||||
//! @}
|
||||
|
||||
/**
|
||||
* \page xmega_sleep_quickstart Quick Start Guide for the XMEGA Sleep Driver
|
||||
*
|
||||
* This is the quick start guide for the \ref sleep_group "Sleep Driver", with
|
||||
* step-by-step instructions on how to configure and use the driver for a
|
||||
* specific use case.
|
||||
*
|
||||
* The section described below can be copied into, e.g. the main application
|
||||
* loop or any other function that will need to control and execute different
|
||||
* sleep modes on the device.
|
||||
*
|
||||
* \section xmega_sleep_quickstart_basic Basic usage of the sleep driver
|
||||
* This use case will prepare the device to enter the Power Down sleep mode and
|
||||
* then enter the sleep mode. After waking up it will disable sleep.
|
||||
*
|
||||
* \section xmega_sleep_basic_usage Usage steps
|
||||
* \subsection xmega_sleep_basic_usage_code Example code
|
||||
* Add to, e.g., the main loop in the application C-file:
|
||||
* \code
|
||||
* sleep_set_mode(SLEEP_SMODE_PDOWN_gc);
|
||||
* sleep_enable();
|
||||
* sleep_enter();
|
||||
* sleep_disable();
|
||||
* \endcode
|
||||
*
|
||||
* \subsection xmega_sleep_basic_usage Workflow
|
||||
* -# Set what sleep mode to use, the different sleep modes can be found in the
|
||||
* device header file under the enum definition SLEEP_SMODE_enum:
|
||||
* - \code sleep_set_mode(SLEEP_SMODE_PDOWN_gc); \endcode
|
||||
* -# Enable that the device are allowed to go to sleep:
|
||||
* - \code sleep_enable(); \endcode
|
||||
* - \note This function has to be called in order for the device to go to
|
||||
* sleep. This is a safety feature to stop the device to go to sleep
|
||||
* unintentionally, even though it is possible to have this enabled at all times
|
||||
* it is recommended to enable sleep mode only when you intend to go to sleep
|
||||
* within a few clock cycles.
|
||||
* -# Enter sleep mode:
|
||||
* - \code sleep_enter(); \endcode
|
||||
* - \attention Make sure to enable global interrupt and the interrupt you
|
||||
* plan to use as wake-up source for your device, do also pay special
|
||||
* attention to what wake-up sources are available for the different sleep
|
||||
* modes. Failing to enable interrupts may result in indefinite sleep until
|
||||
* power is cycled!
|
||||
* -# When the device is woken from sleep it will execute the interrupt handler
|
||||
* related to the wakeup-source (interrupt source) and continue on the next line
|
||||
* of code after the \ref sleep_enter() call. Make sure to disable sleep when
|
||||
* waking up.
|
||||
* - \code sleep_disable(); \endcode
|
||||
*
|
||||
* \subsection xmega_sleep_basic_sleep_modes Sleep Modes
|
||||
* Possible sleep modes depend on the device that is used. Please refer to the
|
||||
* device datasheet and header file to find these definitions.
|
||||
*
|
||||
* As an example the ATxmega32A4U device has the following sleep modes:
|
||||
* - Idle sleep: SLEEP_SMODE_IDLE_gc
|
||||
* - Power Down: SLEEP_SMODE_PDOWN_gc
|
||||
* - Power Save: SLEEP_SMODE_PSAVE_gc
|
||||
* - Standby: SLEEP_SMODE_STDBY_gc
|
||||
* - Extended standby: SLEEP_SMODE_ESTDBY_gc
|
||||
*/
|
||||
|
||||
#endif /* SLEEP_H */
|
||||
/**
|
||||
* \file
|
||||
*
|
||||
* \brief Sleep controller driver
|
||||
*
|
||||
* Copyright (c) 2010 Atmel Corporation. All rights reserved.
|
||||
*
|
||||
* \asf_license_start
|
||||
*
|
||||
* \page License
|
||||
*
|
||||
* 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. The name of Atmel may not be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* 4. This software may only be redistributed and used in connection with an
|
||||
* Atmel microcontroller product.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
||||
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
||||
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
|
||||
*
|
||||
* \asf_license_stop
|
||||
*
|
||||
*/
|
||||
#ifndef SLEEP_H
|
||||
#define SLEEP_H
|
||||
|
||||
#include <compiler.h>
|
||||
|
||||
/**
|
||||
* \defgroup sleep_group Sleep controller driver
|
||||
*
|
||||
* This is a low-level driver implementation for the AVR XMEGA sleep controller.
|
||||
*
|
||||
* \note To minimize the code overhead, these functions do not feature
|
||||
* interrupt-protected access since they are likely to be called inside
|
||||
* interrupt handlers or in applications where such protection is not
|
||||
* necessary. If such protection is needed, it must be ensured by the calling
|
||||
* code.
|
||||
*
|
||||
* \section xmega_sleep_quickstart_section Quick Start Guide
|
||||
* See \ref xmega_sleep_quickstart
|
||||
* @{
|
||||
*/
|
||||
|
||||
#if defined(__ICCAVR__) || defined(__DOXYGEN__)
|
||||
# include <intrinsics.h>
|
||||
//! Macro for issuing the sleep instruction.
|
||||
# define sleep_enter() __sleep()
|
||||
|
||||
/**
|
||||
* \brief Enable sleep
|
||||
*/
|
||||
static inline void
|
||||
sleep_enable (void)
|
||||
{
|
||||
SLEEP.CTRL |= SLEEP_SEN_bm;
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Disable sleep
|
||||
*/
|
||||
static inline void
|
||||
sleep_disable (void)
|
||||
{
|
||||
SLEEP.CTRL &= ~SLEEP_SEN_bm;
|
||||
}
|
||||
|
||||
#elif defined(__GNUC__)
|
||||
# include <avr/sleep.h>
|
||||
# define sleep_enter() sleep_cpu()
|
||||
|
||||
#else
|
||||
# error Unsupported compiler.
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \brief Set new sleep mode
|
||||
*
|
||||
* \param mode Sleep mode, from the device IO header file.
|
||||
*/
|
||||
static inline void
|
||||
sleep_set_mode (enum SLEEP_SMODE_enum mode)
|
||||
{
|
||||
SLEEP.CTRL = mode | (SLEEP.CTRL & ~SLEEP_SMODE_gm);
|
||||
}
|
||||
|
||||
//! @}
|
||||
|
||||
/**
|
||||
* \page xmega_sleep_quickstart Quick Start Guide for the XMEGA Sleep Driver
|
||||
*
|
||||
* This is the quick start guide for the \ref sleep_group "Sleep Driver", with
|
||||
* step-by-step instructions on how to configure and use the driver for a
|
||||
* specific use case.
|
||||
*
|
||||
* The section described below can be copied into, e.g. the main application
|
||||
* loop or any other function that will need to control and execute different
|
||||
* sleep modes on the device.
|
||||
*
|
||||
* \section xmega_sleep_quickstart_basic Basic usage of the sleep driver
|
||||
* This use case will prepare the device to enter the Power Down sleep mode and
|
||||
* then enter the sleep mode. After waking up it will disable sleep.
|
||||
*
|
||||
* \section xmega_sleep_basic_usage Usage steps
|
||||
* \subsection xmega_sleep_basic_usage_code Example code
|
||||
* Add to, e.g., the main loop in the application C-file:
|
||||
* \code
|
||||
* sleep_set_mode(SLEEP_SMODE_PDOWN_gc);
|
||||
* sleep_enable();
|
||||
* sleep_enter();
|
||||
* sleep_disable();
|
||||
* \endcode
|
||||
*
|
||||
* \subsection xmega_sleep_basic_usage Workflow
|
||||
* -# Set what sleep mode to use, the different sleep modes can be found in the
|
||||
* device header file under the enum definition SLEEP_SMODE_enum:
|
||||
* - \code sleep_set_mode(SLEEP_SMODE_PDOWN_gc); \endcode
|
||||
* -# Enable that the device are allowed to go to sleep:
|
||||
* - \code sleep_enable(); \endcode
|
||||
* - \note This function has to be called in order for the device to go to
|
||||
* sleep. This is a safety feature to stop the device to go to sleep
|
||||
* unintentionally, even though it is possible to have this enabled at all times
|
||||
* it is recommended to enable sleep mode only when you intend to go to sleep
|
||||
* within a few clock cycles.
|
||||
* -# Enter sleep mode:
|
||||
* - \code sleep_enter(); \endcode
|
||||
* - \attention Make sure to enable global interrupt and the interrupt you
|
||||
* plan to use as wake-up source for your device, do also pay special
|
||||
* attention to what wake-up sources are available for the different sleep
|
||||
* modes. Failing to enable interrupts may result in indefinite sleep until
|
||||
* power is cycled!
|
||||
* -# When the device is woken from sleep it will execute the interrupt handler
|
||||
* related to the wakeup-source (interrupt source) and continue on the next line
|
||||
* of code after the \ref sleep_enter() call. Make sure to disable sleep when
|
||||
* waking up.
|
||||
* - \code sleep_disable(); \endcode
|
||||
*
|
||||
* \subsection xmega_sleep_basic_sleep_modes Sleep Modes
|
||||
* Possible sleep modes depend on the device that is used. Please refer to the
|
||||
* device datasheet and header file to find these definitions.
|
||||
*
|
||||
* As an example the ATxmega32A4U device has the following sleep modes:
|
||||
* - Idle sleep: SLEEP_SMODE_IDLE_gc
|
||||
* - Power Down: SLEEP_SMODE_PDOWN_gc
|
||||
* - Power Save: SLEEP_SMODE_PSAVE_gc
|
||||
* - Standby: SLEEP_SMODE_STDBY_gc
|
||||
* - Extended standby: SLEEP_SMODE_ESTDBY_gc
|
||||
*/
|
||||
|
||||
#endif /* SLEEP_H */
|
||||
|
||||
Reference in New Issue
Block a user