Legacy HAL#
The Legacy HAL is an implementation of the Hardware Abstraction Layer (HAL) that was used by the Zigbee EmberZNet and Flex Connect stacks before their transition to the new component-based architecture (Zigbee version 7.0 and Connect version 3.0).
This component is not a complete duplicate of the old HAL. It only contains the most commonly used pieces to enable our networking stacks and sample applications and to support porting customer applications to the new component-based implementation. Currently, Zigbee and Connect sample applications are dependent on this component. Eventually, they will be ported to use new HAL components directly so that this component can become optional or be deprecated. Note
This component is only designed to be used with Zigbee and Connect stack applications. Do not use with any other stacks as it will likely introduce problems.
Modules#
Functions#
This function will get 16u ms tick data.
This function will get 32u ms tick data.
This function will get 64u ms tick data.
This function will get 16u quater second tick data.
This function will start system timer.
This function will delay an amount of time in us.
This function will delay an amount of time in ms.
This function will set state to idle for an amount of time in ms.
This function is halStackSymbolDelayAIsr.
This function is halStackProcessBootCount.
Call this function to get information about the external EEPROM and its capabilities.
Macros#
Definition of an EEPROM page size, in bytes.
Define the location of the first page in EEPROM.
Define the location of the image start in EEPROM as a function of the EEPROM_FIRST_PAGE and EEPROM_PAGE_SIZE.
Define EEPROM success status.
Define EEPROM error status.
Define EEPROM error mask.
Define EEPROM page boundary error.
Define EEPROM page size error.
Define EEPROM write data error.
Define EEPROM image too large error.
Define EEPROM invalid address error.
Define EEPROM chip initialization error.
Define EEPROM erase required error.
Define EEPROM error for no erase support.
The current version of the HalEepromInformationType data structure.
eeprom info major version
eeprom info major version mask
eeprom info min version with word size support
Eeprom capabilites mask that indicates the erase API is supported.
Eeprom capabilites mask that indicates page erasing is required before new data can be written to a device.
Eeprom capabilites mask that indicates that the write routine is blocking on this device.
Eeprom capabilites mask that indicates that the erase routine is blocking on this device.
Eeprom capabilities mask that indicateds that the partEraseTime field of HalEepromInformationType is in seconds instead of the usual millisecondss.
Function Documentation#
halCommonGetInt16uMillisecondTick#
uint16_t halCommonGetInt16uMillisecondTick (void )
This function will get 16u ms tick data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
halCommonGetInt32uMillisecondTick#
uint32_t halCommonGetInt32uMillisecondTick (void )
This function will get 32u ms tick data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
halCommonGetInt64uMillisecondTick#
uint64_t halCommonGetInt64uMillisecondTick (void )
This function will get 64u ms tick data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
halCommonGetInt16uQuarterSecondTick#
uint16_t halCommonGetInt16uQuarterSecondTick (void )
This function will get 16u quater second tick data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
halInternalStartSystemTimer#
uint16_t halInternalStartSystemTimer (void )
This function will start system timer.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
halCommonDelayMicroseconds#
void halCommonDelayMicroseconds (uint16_t us)
This function will delay an amount of time in us.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | us | second in us |
halCommonDelayMilliseconds#
void halCommonDelayMilliseconds (uint16_t ms)
This function will delay an amount of time in ms.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | ms | second in ms |
halCommonIdleForMilliseconds#
sl_status_t halCommonIdleForMilliseconds (uint32_t * duration)
This function will set state to idle for an amount of time in ms.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t * | N/A | duration | second in us |
Returns
sl_status_t
halStackSymbolDelayAIsr#
void halStackSymbolDelayAIsr (void )
This function is halStackSymbolDelayAIsr.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
halStackProcessBootCount#
void halStackProcessBootCount (void )
This function is halStackProcessBootCount.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
halEepromInfo#
const HalEepromInformationType * halEepromInfo (void )
Call this function to get information about the external EEPROM and its capabilities.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
The format of this call must not be altered. However, the content can be changed to work with a different device.
Returns
A pointer to a HalEepromInformationType data structure, or NULL if the driver does not support this API