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

Definition at line 49 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

Function Documentation#

zpal_reboot#

void zpal_reboot (void )

Perform a system reboot.

Parameters
N/A

Definition at line 58 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_initiate_shutdown_handler#

void zpal_initiate_shutdown_handler (void )

Prepare for shutdown handler.

Parameters
N/A

Definition at line 63 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_shutdown_handler#

void zpal_shutdown_handler (void )

Shutdown handler.

Parameters
N/A

Definition at line 68 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
N/A

Returns

  • Serial number length.


Definition at line 75 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
[out]serial_number

Serial number.


Definition at line 82 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_in_isr#

bool zpal_in_isr (void )

Check if in ISR context.

Parameters
N/A

Returns

  • True if the CPU is in handler mode (currently executing an interrupt handler). False if the CPU is in thread mode.


Definition at line 90 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_get_chip_type#

uint8_t zpal_get_chip_type (void )

Get chip type.

Parameters
N/A

Returns

  • Chip type.


Definition at line 97 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_get_chip_revision#

uint8_t zpal_get_chip_revision (void )

Get chip revision.

Parameters
N/A

Returns

  • Chip revision.


Definition at line 104 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_get_app_version#

uint32_t zpal_get_app_version (void )

Get application version.

Parameters
N/A

Returns

  • Application version.

Note

  • This function exists in PAL to allow use app version by external module (e.g. bootloader).


Definition at line 113 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
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).


Definition at line 122 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
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).


Definition at line 131 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
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).


Definition at line 140 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
[out]product_id

Product id.

Note

  • This function exists in PAL to allow use product id by external module (e.g. bootloader).


Definition at line 149 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_debug_init#

void zpal_debug_init (void )

Initialize debug output.

Parameters
N/A

Definition at line 154 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
[out]data

Pointer to debug data.

[in]length

Length of debug data.


Definition at line 162 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h

zpal_disable_interrupts#

void zpal_disable_interrupts (void )

Disable interrupts.

Parameters
N/A

Definition at line 167 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
N/A

Returns

  • Secure element type supported.


Definition at line 175 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
[in]attributes

of the key


Definition at line 184 of file /mnt/raid/workspaces/ws.WH1KakGoP/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.

Parameters
[in]attributes

of the key


Definition at line 193 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/PAL/inc/zpal_misc.h