Utility and convenience functions for EM35x microcontroller. See Common Microcontroller Functions for documentation.

License#

Copyright 2018 Silicon Laboratories Inc. www.silabs.com

The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code. 

/***************************************************************************/
#ifndef __EM3XX_MICRO_H__
#define __EM3XX_MICRO_H__

#ifndef DOXYGEN_SHOULD_SKIP_THIS

#ifndef __MICRO_H__
#error do not include this file directly - include micro/micro.h
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
#ifndef __EMBERSTATUS_TYPE__
#define __EMBERSTATUS_TYPE__
//This is necessary here because halSetRadioHoldOff returns an
//EmberStatus and not adding this typedef to this file breaks a
//whole lot of builds due to include mis-ordering
typedef uint8_t EmberStatus;
#endif //__EMBERSTATUS_TYPE__
#endif // DOXYGEN_SHOULD_SKIP_THIS

// Micro specific serial defines
#define EM_NUM_SERIAL_PORTS 4
#define EMBER_SPI_MASTER 4
#define EMBER_SPI_SLAVE 5
#define EMBER_I2C 6

// Define the priority registers of system handlers and interrupts.
// This example shows how to save the current ADC interrupt priority and
// then set it to 24:
//    uint8_t oldAdcPriority = INTERRUPT_PRIORITY_REGISTER(ADC);
//    INTERRUPT_PRIORITY_REGISTER(ADC) = 24;

// For Cortex-M3 faults and exceptions
#define HANDLER_PRIORITY_REGISTER(handler) \
  (*(((uint8_t *)SCS_SHPR_7to4_ADDR) + handler##_VECTOR_INDEX - 4))

// For EM3XX-specific interrupts
#define INTERRUPT_PRIORITY_REGISTER(interrupt) \
  (*(((uint8_t *)NVIC_IPR_3to0_ADDR) + interrupt##_VECTOR_INDEX - 16))

// The reset types of the EM300 series have both a base type and an
//  extended type.  The extended type is a 16-bit value which has the base
//  type in the upper 8-bits, and the extended classification in the
//  lower 8-bits
// For backwards compatibility with other platforms, only the base type is
//  returned by the halGetResetInfo() API.  For the full extended type, the
//  halGetExtendedResetInfo() API should be called.

#define RESET_BASE_TYPE(extendedType)   ((uint8_t)(((extendedType) >> 8) & 0xFF))
#define RESET_EXTENDED_FIELD(extendedType) ((uint8_t)((extendedType) & 0xFF))
#define RESET_VALID_SIGNATURE           (0xF00F)
#define RESET_INVALID_SIGNATURE         (0xC33C)

// Define the base reset cause types
#define RESET_BASE_DEF(basename, value, string)  RESET_##basename = value,
#define RESET_EXT_DEF(basename, extname, extvalue, string)     /*nothing*/
enum {
  #include "reset-def.h"
  NUM_RESET_BASE_TYPES
};

#undef RESET_BASE_DEF
#undef RESET_EXT_DEF

// Define the extended reset cause types
#define RESET_EXT_VALUE(basename, extvalue) \
  (((RESET_##basename) << 8) + extvalue)
#define RESET_BASE_DEF(basename, value, string)    /*nothing*/
#define RESET_EXT_DEF(basename, extname, extvalue, string) \
  RESET_##basename##_##extname = RESET_EXT_VALUE(basename, extvalue),
enum {
  #include "reset-def.h"
};

#undef RESET_EXT_VALUE
#undef RESET_BASE_DEF
#undef RESET_EXT_DEF

// These define the size of the GUARD region configured in the MPU that
// sits between the heap and the stack
#define HEAP_GUARD_REGION_SIZE       (SIZE_32B)
#define HEAP_GUARD_REGION_SIZE_BYTES (1 << (HEAP_GUARD_REGION_SIZE + 1))

// Define a value to fill the guard region between the heap and stack.
#define HEAP_GUARD_FILL_VALUE (0xE2E2E2E2U)

// Resize the CSTACK to add space to the 'heap' that exists below it
uint32_t halStackModifyCStackSize(int32_t stackSizeDeltaWords);

// Initialize the CSTACK/Heap region and the guard page in between them
void halInternalInitCStackRegion(void);

// Helper functions to get the location of the stack/heap
uint32_t halInternalGetCStackBottom(void);
uint32_t halInternalGetHeapTop(void);
uint32_t halInternalGetHeapBottom(void);

// Determines reset cause
void halInternalClassifyReset(void);

#endif // DOXYGEN_SHOULD_SKIP_THIS

#define STACK_VECTOR_INDEX          0U // special case: stack pointer at reset
#define RESET_VECTOR_INDEX          1U
#define NMI_VECTOR_INDEX            2U
#define HARD_FAULT_VECTOR_INDEX     3U
#define MEMORY_FAULT_VECTOR_INDEX   4U
#define BUS_FAULT_VECTOR_INDEX      5U
#define USAGE_FAULT_VECTOR_INDEX    6U
#define RESERVED07_VECTOR_INDEX     7U
#define RESERVED08_VECTOR_INDEX     8U
#define RESERVED09_VECTOR_INDEX     9U
#define RESERVED10_VECTOR_INDEX     10U
#define SVCALL_VECTOR_INDEX         11U
#define DEBUG_MONITOR_VECTOR_INDEX  12U
#define RESERVED13_VECTOR_INDEX     13U
#define PENDSV_VECTOR_INDEX         14U
#define SYSTICK_VECTOR_INDEX        15U
#define TIMER1_VECTOR_INDEX         16U
#define TIMER2_VECTOR_INDEX         17U
#define MANAGEMENT_VECTOR_INDEX     18U
#define BASEBAND_VECTOR_INDEX       19U
#define SLEEP_TIMER_VECTOR_INDEX    20U
#define SC1_VECTOR_INDEX            21U
#define SC2_VECTOR_INDEX            22U
#define SECURITY_VECTOR_INDEX       23U
#define MAC_TIMER_VECTOR_INDEX      24U
#define MAC_TX_VECTOR_INDEX         25U
#define MAC_RX_VECTOR_INDEX         26U
#define ADC_VECTOR_INDEX            27U
#define IRQA_VECTOR_INDEX           28U
#define IRQB_VECTOR_INDEX           29U
#define IRQC_VECTOR_INDEX           30U
#define IRQD_VECTOR_INDEX           31U
#define DEBUG_VECTOR_INDEX          32U
#define SC3_VECTOR_INDEX            33U
#define SC4_VECTOR_INDEX            34U
#define USB_VECTOR_INDEX            35U

#define VECTOR_TABLE_LENGTH         36U

void halInternalSysReset(uint16_t extendedCause);

uint16_t halGetExtendedResetInfo(void);

PGM_P halGetExtendedResetString(void);

//[[ ram vectors are not public
#ifndef DOXYGEN_SHOULD_SKIP_THIS

uint32_t halRegisterRamVector(uint8_t vectorNumber, uint32_t newVector);

uint32_t halUnRegisterRamVector(uint8_t vectorNumber);

#endif // DOXYGEN_SHOULD_SKIP_THIS
//]]

EmberStatus halSetRadioHoldOff(bool enable);

bool halGetRadioHoldOff(void);

void halStackRadioPowerDownBoard(void);

void halStackRadio2PowerDownBoard(void);

void halStackRadioPowerUpBoard(void);

void halStackRadio2PowerUpBoard(void);

void halStackRadioPowerMainControl(bool powerUp);

void halRadioPowerUpHandler(void);

void halRadioPowerDownHandler(void);

#include "micro-common.h"

#endif //__EM3XX_MICRO_H__

Vector Table Index Definitions#

These are numerical definitions for vector table. Indices 0 through 15 are Cortex-M3 standard exception vectors and indices 16 through 35 are EM3XX specific interrupt vectors.

#define
STACK_VECTOR_INDEX 0U

A numerical definition for a vector.

#define
RESET_VECTOR_INDEX 1U

A numerical definition for a vector.

#define
NMI_VECTOR_INDEX 2U

A numerical definition for a vector.

#define
HARD_FAULT_VECTOR_INDEX 3U

A numerical definition for a vector.

#define
MEMORY_FAULT_VECTOR_INDEX 4U

A numerical definition for a vector.

#define
BUS_FAULT_VECTOR_INDEX 5U

A numerical definition for a vector.

#define
USAGE_FAULT_VECTOR_INDEX 6U

A numerical definition for a vector.

#define
RESERVED07_VECTOR_INDEX 7U

A numerical definition for a vector.

#define
RESERVED08_VECTOR_INDEX 8U

A numerical definition for a vector.

#define
RESERVED09_VECTOR_INDEX 9U

A numerical definition for a vector.

#define
RESERVED10_VECTOR_INDEX 10U

A numerical definition for a vector.

#define
SVCALL_VECTOR_INDEX 11U

A numerical definition for a vector.

#define
DEBUG_MONITOR_VECTOR_INDEX 12U

A numerical definition for a vector.

#define
RESERVED13_VECTOR_INDEX 13U

A numerical definition for a vector.

#define
PENDSV_VECTOR_INDEX 14U

A numerical definition for a vector.

#define
SYSTICK_VECTOR_INDEX 15U

A numerical definition for a vector.

#define
TIMER1_VECTOR_INDEX 16U

A numerical definition for a vector.

#define
TIMER2_VECTOR_INDEX 17U

A numerical definition for a vector.

#define
MANAGEMENT_VECTOR_INDEX 18U

A numerical definition for a vector.

#define
BASEBAND_VECTOR_INDEX 19U

A numerical definition for a vector.

#define
SLEEP_TIMER_VECTOR_INDEX 20U

A numerical definition for a vector.

#define
SC1_VECTOR_INDEX 21U

A numerical definition for a vector.

#define
SC2_VECTOR_INDEX 22U

A numerical definition for a vector.

#define
SECURITY_VECTOR_INDEX 23U

A numerical definition for a vector.

#define
MAC_TIMER_VECTOR_INDEX 24U

A numerical definition for a vector.

#define
MAC_TX_VECTOR_INDEX 25U

A numerical definition for a vector.

#define
MAC_RX_VECTOR_INDEX 26U

A numerical definition for a vector.

#define
ADC_VECTOR_INDEX 27U

A numerical definition for a vector.

#define
IRQA_VECTOR_INDEX 28U

A numerical definition for a vector.

#define
IRQB_VECTOR_INDEX 29U

A numerical definition for a vector.

#define
IRQC_VECTOR_INDEX 30U

A numerical definition for a vector.

#define
IRQD_VECTOR_INDEX 31U

A numerical definition for a vector.

#define
DEBUG_VECTOR_INDEX 32U

A numerical definition for a vector.

#define
SC3_VECTOR_INDEX 33U

A numerical definition for a vector.

#define
SC4_VECTOR_INDEX 34U

A numerical definition for a vector.

#define
USB_VECTOR_INDEX 35U

A numerical definition for a vector.

#define
VECTOR_TABLE_LENGTH 36U

Number of vectors.

Functions#

void
halInternalSysReset(uint16_t extendedCause)

Records the specified reset cause then forces a reboot.

uint16_t
halGetExtendedResetInfo(void)

Returns the Extended Reset Cause information.

PGM_P
halGetExtendedResetString(void)

Calls halGetExtendedResetInfo() and supplies a string describing the extended cause of the reset. halGetResetString() should also be called to get the string for the base reset cause.

EmberStatus
halSetRadioHoldOff(bool enable)

Enables or disables Radio HoldOff support.

bool
halGetRadioHoldOff(void)

Returns whether Radio HoldOff has been enabled or not.

void
halStackRadioPowerDownBoard(void)

To assist with saving power when the radio automatically powers down, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerdown state. The pin state used is the state used by halInternalPowerDownBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function is often called from interrupt context.

void
halStackRadio2PowerDownBoard(void)

To assist with saving power when radio2 automatically powers down, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerdown state. The pin state used is the state used by halInternalPowerDownBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function is often called from interrupt context.

void
halStackRadioPowerUpBoard(void)

To assist with saving power when the radio automatically powers up, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerup state. The pin state used is the state used by halInternalPowerUpBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function can be called from interrupt context.

void
halStackRadio2PowerUpBoard(void)

To assist with saving power when radio2 automatically powers up, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerup state. The pin state used is the state used by halInternalPowerUpBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function can be called from interrupt context.

void
halStackRadioPowerMainControl(bool powerUp)

This function is called automatically by the stack prior to Radio power-up and after Radio power-down. It can be used to prepare for the radio being powered on and to clean up after it's been powered off. Unlike halStackRadioPowerUpBoard() and halStackRadioPowerDownBoard(), which can be called from interrupt context, this function is only called from main-line context.

void
halRadioPowerUpHandler(void)

Handler called in main context prior to radio being powered on.

void
halRadioPowerDownHandler(void)

Handler called in main context after radio has been powered off.

Vector Table Index Definitions Documentation#

STACK_VECTOR_INDEX#

#define STACK_VECTOR_INDEX
Value:
0U

A numerical definition for a vector.


Definition at line 135 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

RESET_VECTOR_INDEX#

#define RESET_VECTOR_INDEX
Value:
1U

A numerical definition for a vector.


Definition at line 136 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

NMI_VECTOR_INDEX#

#define NMI_VECTOR_INDEX
Value:
2U

A numerical definition for a vector.


Definition at line 137 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

HARD_FAULT_VECTOR_INDEX#

#define HARD_FAULT_VECTOR_INDEX
Value:
3U

A numerical definition for a vector.


Definition at line 138 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

MEMORY_FAULT_VECTOR_INDEX#

#define MEMORY_FAULT_VECTOR_INDEX
Value:
4U

A numerical definition for a vector.


Definition at line 139 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

BUS_FAULT_VECTOR_INDEX#

#define BUS_FAULT_VECTOR_INDEX
Value:
5U

A numerical definition for a vector.


Definition at line 140 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

USAGE_FAULT_VECTOR_INDEX#

#define USAGE_FAULT_VECTOR_INDEX
Value:
6U

A numerical definition for a vector.


Definition at line 141 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

RESERVED07_VECTOR_INDEX#

#define RESERVED07_VECTOR_INDEX
Value:
7U

A numerical definition for a vector.


Definition at line 142 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

RESERVED08_VECTOR_INDEX#

#define RESERVED08_VECTOR_INDEX
Value:
8U

A numerical definition for a vector.


Definition at line 143 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

RESERVED09_VECTOR_INDEX#

#define RESERVED09_VECTOR_INDEX
Value:
9U

A numerical definition for a vector.


Definition at line 144 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

RESERVED10_VECTOR_INDEX#

#define RESERVED10_VECTOR_INDEX
Value:
10U

A numerical definition for a vector.


Definition at line 145 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SVCALL_VECTOR_INDEX#

#define SVCALL_VECTOR_INDEX
Value:
11U

A numerical definition for a vector.


Definition at line 146 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

DEBUG_MONITOR_VECTOR_INDEX#

#define DEBUG_MONITOR_VECTOR_INDEX
Value:
12U

A numerical definition for a vector.


Definition at line 147 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

RESERVED13_VECTOR_INDEX#

#define RESERVED13_VECTOR_INDEX
Value:
13U

A numerical definition for a vector.


Definition at line 148 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

PENDSV_VECTOR_INDEX#

#define PENDSV_VECTOR_INDEX
Value:
14U

A numerical definition for a vector.


Definition at line 149 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SYSTICK_VECTOR_INDEX#

#define SYSTICK_VECTOR_INDEX
Value:
15U

A numerical definition for a vector.


Definition at line 150 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

TIMER1_VECTOR_INDEX#

#define TIMER1_VECTOR_INDEX
Value:
16U

A numerical definition for a vector.


Definition at line 151 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

TIMER2_VECTOR_INDEX#

#define TIMER2_VECTOR_INDEX
Value:
17U

A numerical definition for a vector.


Definition at line 152 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

MANAGEMENT_VECTOR_INDEX#

#define MANAGEMENT_VECTOR_INDEX
Value:
18U

A numerical definition for a vector.


Definition at line 153 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

BASEBAND_VECTOR_INDEX#

#define BASEBAND_VECTOR_INDEX
Value:
19U

A numerical definition for a vector.


Definition at line 154 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SLEEP_TIMER_VECTOR_INDEX#

#define SLEEP_TIMER_VECTOR_INDEX
Value:
20U

A numerical definition for a vector.


Definition at line 155 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SC1_VECTOR_INDEX#

#define SC1_VECTOR_INDEX
Value:
21U

A numerical definition for a vector.


Definition at line 156 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SC2_VECTOR_INDEX#

#define SC2_VECTOR_INDEX
Value:
22U

A numerical definition for a vector.


Definition at line 157 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SECURITY_VECTOR_INDEX#

#define SECURITY_VECTOR_INDEX
Value:
23U

A numerical definition for a vector.


Definition at line 158 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

MAC_TIMER_VECTOR_INDEX#

#define MAC_TIMER_VECTOR_INDEX
Value:
24U

A numerical definition for a vector.


Definition at line 159 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

MAC_TX_VECTOR_INDEX#

#define MAC_TX_VECTOR_INDEX
Value:
25U

A numerical definition for a vector.


Definition at line 160 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

MAC_RX_VECTOR_INDEX#

#define MAC_RX_VECTOR_INDEX
Value:
26U

A numerical definition for a vector.


Definition at line 161 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

ADC_VECTOR_INDEX#

#define ADC_VECTOR_INDEX
Value:
27U

A numerical definition for a vector.


Definition at line 162 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

IRQA_VECTOR_INDEX#

#define IRQA_VECTOR_INDEX
Value:
28U

A numerical definition for a vector.


Definition at line 163 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

IRQB_VECTOR_INDEX#

#define IRQB_VECTOR_INDEX
Value:
29U

A numerical definition for a vector.


Definition at line 164 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

IRQC_VECTOR_INDEX#

#define IRQC_VECTOR_INDEX
Value:
30U

A numerical definition for a vector.


Definition at line 165 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

IRQD_VECTOR_INDEX#

#define IRQD_VECTOR_INDEX
Value:
31U

A numerical definition for a vector.


Definition at line 166 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

DEBUG_VECTOR_INDEX#

#define DEBUG_VECTOR_INDEX
Value:
32U

A numerical definition for a vector.


Definition at line 167 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SC3_VECTOR_INDEX#

#define SC3_VECTOR_INDEX
Value:
33U

A numerical definition for a vector.


Definition at line 168 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

SC4_VECTOR_INDEX#

#define SC4_VECTOR_INDEX
Value:
34U

A numerical definition for a vector.


Definition at line 169 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

USB_VECTOR_INDEX#

#define USB_VECTOR_INDEX
Value:
35U

A numerical definition for a vector.


Definition at line 170 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

VECTOR_TABLE_LENGTH#

#define VECTOR_TABLE_LENGTH
Value:
36U

Number of vectors.


Definition at line 175 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

Function Documentation#

halInternalSysReset#

void halInternalSysReset (uint16_t extendedCause)

Records the specified reset cause then forces a reboot.

Parameters
N/AextendedCause

Definition at line 182 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halGetExtendedResetInfo#

uint16_t halGetExtendedResetInfo (void )

Returns the Extended Reset Cause information.

Parameters
N/A

Returns

  • A 16-bit code identifying the base and extended cause of the reset


Definition at line 189 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halGetExtendedResetString#

PGM_P halGetExtendedResetString (void )

Calls halGetExtendedResetInfo() and supplies a string describing the extended cause of the reset. halGetResetString() should also be called to get the string for the base reset cause.

Parameters
N/A

@appusage Useful for diagnostic printing of text just after program initialization.

Returns

  • A pointer to a program space string.


Definition at line 200 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halSetRadioHoldOff#

EmberStatus halSetRadioHoldOff (bool enable)

Enables or disables Radio HoldOff support.

Parameters
N/Aenable

When true, configures ::RHO_GPIO in BOARD_HEADER as an input which, when asserted, will prevent the radio from transmitting. When false, configures ::RHO_GPIO for its original default purpose.

Returns

  • EMBER_SUCCESS if Radio HoldOff was configured as desired or EMBER_BAD_ARGUMENT if requesting it be enabled but RHO has not been configured by the BOARD_HEADER.


Definition at line 252 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halGetRadioHoldOff#

bool halGetRadioHoldOff (void )

Returns whether Radio HoldOff has been enabled or not.

Parameters
N/A

Returns

  • true if Radio HoldOff has been enabled, false otherwise.


Definition at line 258 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halStackRadioPowerDownBoard#

void halStackRadioPowerDownBoard (void )

To assist with saving power when the radio automatically powers down, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerdown state. The pin state used is the state used by halInternalPowerDownBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function is often called from interrupt context.

Parameters
N/A

Definition at line 270 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halStackRadio2PowerDownBoard#

void halStackRadio2PowerDownBoard (void )

To assist with saving power when radio2 automatically powers down, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerdown state. The pin state used is the state used by halInternalPowerDownBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function is often called from interrupt context.

Parameters
N/A

Definition at line 282 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halStackRadioPowerUpBoard#

void halStackRadioPowerUpBoard (void )

To assist with saving power when the radio automatically powers up, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerup state. The pin state used is the state used by halInternalPowerUpBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function can be called from interrupt context.

Parameters
N/A

Definition at line 294 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halStackRadio2PowerUpBoard#

void halStackRadio2PowerUpBoard (void )

To assist with saving power when radio2 automatically powers up, this function allows the stack to tell the HAL to put pins specific to radio functionality in their powerup state. The pin state used is the state used by halInternalPowerUpBoard, but applied only to the pins identified in the global variable gpioRadioPowerBoardMask. The stack will automatically call this function as needed, but it will only change GPIO state based on gpioRadioPowerBoardMask. Most commonly, the bits set in gpioRadioPowerBoardMask petain to using a Front End Module. This function can be called from interrupt context.

Parameters
N/A

Definition at line 306 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halStackRadioPowerMainControl#

void halStackRadioPowerMainControl (bool powerUp)

This function is called automatically by the stack prior to Radio power-up and after Radio power-down. It can be used to prepare for the radio being powered on and to clean up after it's been powered off. Unlike halStackRadioPowerUpBoard() and halStackRadioPowerDownBoard(), which can be called from interrupt context, this function is only called from main-line context.

Parameters
N/ApowerUp

Definition at line 315 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halRadioPowerUpHandler#

void halRadioPowerUpHandler (void )

Handler called in main context prior to radio being powered on.

Parameters
N/A

Definition at line 320 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h

halRadioPowerDownHandler#

void halRadioPowerDownHandler (void )

Handler called in main context after radio has been powered off.

Parameters
N/A

Definition at line 325 of file /Users/vihuszar/Git/EmbeddedSoftware/super/platform/base/hal/micro/cortexm3/micro.h