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.
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.
Follows the same behavior as printf, allows vendors to use different backends for printing (UART, SWO, RTT, etc.)
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 |
49
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
Typedef Documentation#
zpal_soft_reset_info_t#
typedef uint16_t zpal_soft_reset_info_t
Manufacturer's reset information.
58
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_soft_reset_mfid_t#
typedef uint16_t zpal_soft_reset_mfid_t
Manufacturer ID used by zpal_reboot_with_info.
64
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
Variable Documentation#
ZPAL_RESET_REQUESTED_BY_SAPI#
const zpal_soft_reset_info_t ZPAL_RESET_REQUESTED_BY_SAPI
66
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
ZPAL_RESET_UNHANDLED_RADIO_EVENT#
const zpal_soft_reset_info_t ZPAL_RESET_UNHANDLED_RADIO_EVENT
67
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
ZPAL_RESET_RADIO_ASSERT#
const zpal_soft_reset_info_t ZPAL_RESET_RADIO_ASSERT
68
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
ZPAL_RESET_ASSERT_PTR#
const zpal_soft_reset_info_t ZPAL_RESET_ASSERT_PTR
69
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
ZPAL_RESET_EVENT_FLUSH_MEMORY#
const zpal_soft_reset_info_t ZPAL_RESET_EVENT_FLUSH_MEMORY
70
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
ZPAL_RESET_INFO_DEFAULT#
const zpal_soft_reset_info_t ZPAL_RESET_INFO_DEFAULT
71
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
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.
[in] | manufacturer_id | manufacturer ID identifier. |
[in] | reset_info | the information to pass to boot. |
79
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_initiate_shutdown_handler#
void zpal_initiate_shutdown_handler (void )
Prepare for shutdown handler.
N/A |
85
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_shutdown_handler#
void zpal_shutdown_handler (void )
Shutdown handler.
N/A |
90
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_serial_number_length#
size_t zpal_get_serial_number_length (void )
Get serial number length.
N/A |
Returns
Serial number length.
97
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_serial_number#
void zpal_get_serial_number (uint8_t * serial_number)
Get serial number.
[out] | serial_number | Serial number. |
104
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_in_isr#
bool zpal_in_isr (void )
Check if in ISR context.
N/A |
Returns
True if the CPU is in handler mode (currently executing an interrupt handler). False if the CPU is in thread mode.
112
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_chip_type#
uint8_t zpal_get_chip_type (void )
Get chip type.
N/A |
Returns
Chip type.
119
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_chip_revision#
uint8_t zpal_get_chip_revision (void )
Get chip revision.
N/A |
Returns
Chip revision.
126
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_app_version#
uint32_t zpal_get_app_version (void )
Get application version.
N/A |
Returns
Application version.
Note
This function exists in PAL to allow use app version by external module (e.g. bootloader).
135
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_app_version_major#
uint8_t zpal_get_app_version_major (void )
Get major part of application version.
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).
144
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_app_version_minor#
uint8_t zpal_get_app_version_minor (void )
Get minor part of application version.
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).
153
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_app_version_patch#
uint8_t zpal_get_app_version_patch (void )
Get patch part of application version.
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).
162
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_product_id#
void zpal_get_product_id (zpal_product_id_t * product_id)
Get product id.
[out] | product_id | Product id. |
Note
This function exists in PAL to allow use product id by external module (e.g. bootloader).
171
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_debug_init#
void zpal_debug_init (void )
Initialize debug output.
N/A |
176
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_debug_output#
void zpal_debug_output (const uint8_t * data, uint32_t length)
Output debug logs.
[out] | data | Pointer to debug data. |
[in] | length | Length of debug data. |
184
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_disable_interrupts#
void zpal_disable_interrupts (void )
Disable interrupts.
N/A |
189
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_get_secure_element_type#
zpal_chip_se_type_t zpal_get_secure_element_type (void )
Get secure element type supported in the chip.
N/A |
Returns
Secure element type supported.
197
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
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.
[in] | attributes | of the key |
206
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
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.
[in] | attributes | of the key |
215
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h
zpal_printf#
void zpal_printf (char * format, ... )
Follows the same behavior as printf, allows vendors to use different backends for printing (UART, SWO, RTT, etc.)
[in] | format | of the string to print, follows the same format as the standard printf |
N/A |
224
of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h