Zpal-misc#

Defines a platform abstraction layer for the Z-Wave miscellaneous functions, not covered by other modules.

Modules#

zpal_product_id_t

Enumerations#

enum

zpal_chip_se_type_t {

ZPAL_CHIP_SE_UNKNOWN

ZPAL_CHIP_SE_MID

ZPAL_CHIP_SE_HIGH

}

Defines for identifying the secure element type supported by the chip.

Functions#

void

zpal_reboot(void)

Perform a system reboot.

void

zpal_initiate_shutdown_handler(void)

Prepare for shutdown handler.

void

zpal_shutdown_handler(void)

Shutdown handler.

size_t

zpal_get_serial_number_length(void)

Get serial number length.

void

zpal_get_serial_number(uint8_t *serial_number)

Get serial number.

bool

zpal_in_isr(void)

Check if in ISR context.

uint8_t

zpal_get_chip_type(void)

Get chip type.

uint8_t

zpal_get_chip_revision(void)

Get chip revision.

uint32_t

zpal_get_app_version(void)

Get application version.

uint8_t

zpal_get_app_version_major(void)

Get major part of application version.

uint8_t

zpal_get_app_version_minor(void)

Get minor part of application version.

uint8_t

zpal_get_app_version_patch(void)

Get patch part of application version.

void

zpal_get_product_id(zpal_product_id_t *product_id)

Get product id.

void

zpal_debug_init(void)

Initialize debug output.

void

zpal_debug_output(const uint8_t *data, uint32_t length)

Output debug logs.

void

zpal_disable_interrupts(void)

Disable interrupts.

zpal_chip_se_type_t

zpal_get_secure_element_type(void)

Get secure element type supported in the chip.

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.

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.

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

Function Documentation#

zpal_reboot#

void zpal_reboot (void )

Perform a system reboot.

Parameters

Type	Direction	Argument Name	Description
void	N/A

zpal_initiate_shutdown_handler#

void zpal_initiate_shutdown_handler (void )

Prepare for shutdown handler.

Parameters

Type	Direction	Argument Name	Description
void	N/A

zpal_shutdown_handler#

void zpal_shutdown_handler (void )

Shutdown handler.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

Type	Direction	Argument Name	Description
const void *	[in]	attributes	of the key