Zpal-misc#
Defines a platform abstraction layer for the Z-Wave miscellaneous functions, not covered by other modules.
Modules#
Enumerations#
Defines for identifying the secure element type supported by the chip.
Typedefs#
Manufacturer's reset information.
Manufacturer ID used by zpal_reboot_with_info.
type to store a time in zpal format.
Variables#
Functions#
Perform a system reboot and provide information about the context.
Prepare for shutdown handler.
Shutdown handler.
Get serial number length.
Get serial number.
Check if in ISR context.
Get chip type.
Get chip revision.
Get application version.
Get major part of application version.
Get minor part of application version.
Get patch part of application version.
Get product id.
Initialize debug output.
Output debug logs.
Disable interrupts.
Get secure element type supported in the chip.
Set vendor specific location for storing keys persistently in wrapped or plain form based on the secure element type supported by the chip.
Set vendor specific location for storing keys in volatile memory, in wrapped or plain form based on the secure element type supported by the chip.
Enumeration Documentation#
zpal_chip_se_type_t#
zpal_chip_se_type_t
Defines for identifying the secure element type supported by the chip.
Enumerator | |
---|---|
ZPAL_CHIP_SE_UNKNOWN | |
ZPAL_CHIP_SE_MID | |
ZPAL_CHIP_SE_HIGH |
Typedef Documentation#
zpal_soft_reset_mfid_t#
typedef uint16_t zpal_soft_reset_mfid_t
Manufacturer ID used by zpal_reboot_with_info.
zpal_time_t#
typedef uint32_t zpal_time_t
type to store a time in zpal format.
This format of this data depend on the zpal, so the stack should never try to manipulate this data. TODO: how to make this definition configurable by the zpal?
Variable Documentation#
Function Documentation#
zpal_reboot_with_info#
void zpal_reboot_with_info (const zpal_soft_reset_mfid_t manufacturer_id, const zpal_soft_reset_info_t reset_info)
Perform a system reboot and provide information about the context.
Type | Direction | Argument Name | Description |
---|---|---|---|
const zpal_soft_reset_mfid_t | [in] | manufacturer_id | manufacturer ID identifier. |
const zpal_soft_reset_info_t | [in] | reset_info | the information to pass to boot. |
zpal_initiate_shutdown_handler#
void zpal_initiate_shutdown_handler (void )
Prepare for shutdown handler.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
zpal_shutdown_handler#
void zpal_shutdown_handler (void )
Shutdown handler.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
zpal_get_serial_number_length#
size_t zpal_get_serial_number_length (void )
Get serial number length.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Serial number length.
zpal_get_serial_number#
void zpal_get_serial_number (uint8_t * serial_number)
Get serial number.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t * | [out] | serial_number | Serial number. |
zpal_in_isr#
bool zpal_in_isr (void )
Check if in ISR context.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
True if the CPU is in handler mode (currently executing an interrupt handler). False if the CPU is in thread mode.
zpal_get_chip_type#
uint8_t zpal_get_chip_type (void )
Get chip type.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Chip type.
zpal_get_chip_revision#
uint8_t zpal_get_chip_revision (void )
Get chip revision.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Chip revision.
zpal_get_app_version#
uint32_t zpal_get_app_version (void )
Get application version.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Application version.
Note
This function exists in PAL to allow use app version by external module (e.g. bootloader).
zpal_get_app_version_major#
uint8_t zpal_get_app_version_major (void )
Get major part of application version.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Major part of application version.
Note
This function exists in PAL to allow use app version by external module (e.g. bootloader).
zpal_get_app_version_minor#
uint8_t zpal_get_app_version_minor (void )
Get minor part of application version.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Minor part of application version.
Note
This function exists in PAL to allow use app version by external module (e.g. bootloader).
zpal_get_app_version_patch#
uint8_t zpal_get_app_version_patch (void )
Get patch part of application version.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Patch part of application version.
Note
This function exists in PAL to allow use app version by external module (e.g. bootloader).
zpal_get_product_id#
void zpal_get_product_id (zpal_product_id_t * product_id)
Get product id.
Type | Direction | Argument Name | Description |
---|---|---|---|
zpal_product_id_t * | [out] | product_id | Product id. |
Note
This function exists in PAL to allow use product id by external module (e.g. bootloader).
zpal_debug_init#
void zpal_debug_init (void )
Initialize debug output.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
zpal_debug_output#
void zpal_debug_output (const uint8_t * data, uint32_t length)
Output debug logs.
Type | Direction | Argument Name | Description |
---|---|---|---|
const uint8_t * | [out] | data | Pointer to debug data. |
uint32_t | [in] | length | Length of debug data. |
zpal_disable_interrupts#
void zpal_disable_interrupts (void )
Disable interrupts.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
zpal_get_secure_element_type#
zpal_chip_se_type_t zpal_get_secure_element_type (void )
Get secure element type supported in the chip.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Returns
Secure element type supported.
zpal_psa_set_location_persistent_key#
void zpal_psa_set_location_persistent_key (const void * attributes)
Set vendor specific location for storing keys persistently in wrapped or plain form based on the secure element type supported by the chip.
Type | Direction | Argument Name | Description |
---|---|---|---|
const void * | [in] | attributes | of the key |
zpal_psa_set_location_volatile_key#
void zpal_psa_set_location_volatile_key (const void * attributes)
Set vendor specific location for storing keys in volatile memory, in wrapped or plain form based on the secure element type supported by the chip.
Type | Direction | Argument Name | Description |
---|---|---|---|
const void * | [in] | attributes | of the key |