contiki/cpu/stm32w108/hal/micro/micro-common.h
Simon Duquennoy ebc8d9fb1c Merge pull request #1344 from tsparber/fix-doxygen
doxygen: Fixed all warnings
2015-11-30 22:07:15 +01:00

157 lines
4.8 KiB
C

/** @file cpu/stm32w108/hal/micro/micro-common.h
* @brief Minimal Hal functions common across all microcontroller-specific files.
* See @ref micro for documentation.
*
* <!--(C) COPYRIGHT 2010 STMicroelectronics. All rights reserved. -->
*/
/**
* @addtogroup stm32w-cpu
* @{ */
/** @defgroup micro Micro
* Many of the supplied example applications use these microcontroller functions.
* See hal/micro/micro-common.h for source code.
*
*@{
*/
#ifndef MICRO_COMMON_H_
#define MICRO_COMMON_H_
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#ifndef __STSTATUS_TYPE__
#define __STSTATUS_TYPE__
//This is necessary here because halSleepForQsWithOptions returns an
//StStatus and not adding this typedef to this file breaks a
//whole lot of builds.
typedef uint8_t StStatus;
#endif //__STSTATUS_TYPE__
#endif // DOXYGEN_SHOULD_SKIP_THIS
/** @brief Initializes microcontroller-specific peripherals.
*/
void halInit(void);
/** @brief Restarts the microcontroller and therefore everything else.
*/
void halReboot(void);
/** @brief Powers up microcontroller peripherals and board peripherals.
*/
void halPowerUp(void);
/** @brief Powers down microcontroller peripherals and board peripherals.
*/
void halPowerDown(void);
/** @brief The value that must be passed as the single parameter to
* ::halInternalDisableWatchDog() in order to sucessfully disable the watchdog
* timer.
*/
#define MICRO_DISABLE_WATCH_DOG_KEY 0xA5
/** @brief Enables the watchdog timer.
*/
void halInternalEnableWatchDog(void);
/** @brief Disables the watchdog timer.
*
* @note To prevent the watchdog from being disabled accidentally,
* a magic key must be provided.
*
* @param magicKey A value (::MICRO_DISABLE_WATCH_DOG_KEY) that enables the function.
*/
void halInternalDisableWatchDog(uint8_t magicKey);
/** @brief Determines whether the watchdog has been enabled or disabled.
*
* @return A boolean value indicating if the watchdog is current enabled.
*/
boolean halInternalWatchDogEnabled( void );
/** @brief Enumerations for the possible microcontroller sleep modes.
*/
#ifdef DOXYGEN_SHOULD_SKIP_THIS
enum SleepModes
#else
typedef uint8_t SleepModes;
enum
#endif
{
/**
* Everything is active and running. In practice this mode is not
* used, but it is defined for completeness of information.
*/
SLEEPMODE_RUNNING = 0,
/**
* Oly the CPU is idled. The rest of the chip continues runing
* normally. The chip will wake from any interrupt.
*/
SLEEPMODE_IDLE = 1,
/**
* The sleep timer clock sources remain running. The RC is always
* running and the 32kHz XTAL depends on the board header. Wakeup
* is possible from both GPIO and the sleep timer. System time
* is maintained. The sleep timer is assumed to be configured
* properly for wake events.
*/
SLEEPMODE_WAKETIMER = 2,
/**
* The sleep timer clock sources remain running. The RC is always
* running and the 32kHz XTAL depends on the board header. Wakeup
* is possible from only GPIO. System time is maintained.
*/
SLEEPMODE_MAINTAINTIMER = 3,
/**
* The sleep timer clock sources (both RC and XTAL) are turned off.
* Wakeup is possible from only GPIO. System time is lost.
*/
SLEEPMODE_NOTIMER = 4,
};
/** @brief Blocks the current thread of execution for the specified
* amount of time, in microseconds.
*
* The function is implemented with cycle-counted busy loops
* and is intended to create the short delays required when interfacing with
* hardware peripherals.
*
* The accuracy of the timing provided by this function is not specified,
* but a general rule is that when running off of a crystal oscillator it will
* be within 10us. If the micro is running off of another type of oscillator
* (e.g. RC) the timing accuracy will potentially be much worse.
*
* @param us The specified time, in microseconds.
Values should be between 1 and 65535 microseconds.
*/
void halCommonDelayMicroseconds(uint16_t us);
/** @brief Request the appplication to enter in bootloader mode
*
* This function will check whwther the user flash contains the bootloader
* and if yes it will jump into it according to the user parameters.
*
*
* @param mode The bootloader mode, 0 UART mode, 1 RF mode. All other
* values are reserved
* @param channel The channel where the booloader will operate. 0 means
* default channel (only vaild for RF mode).
* @param panID The panID where the booloader will operate. 0xFFFF means
* default panID (only vaild for RF mode).
* @return An error code or it will never return.
*/
StStatus halBootloaderStart(uint8_t mode, uint8_t channel, uint16_t panID);
#ifdef CORTEXM3_STM32F103
#include "micro/cortexm3/stm32f103ret/micro-specific.h"
#endif
#ifdef CORTEXM3_STM32W108
#include "micro/cortexm3/micro-common.h"
#endif
#endif //MICRO_COMMON_H_
/** @} END micro group */
/** @} */