Board

---

The Board provides functions for controlling and getting information about board.

Required Header

#include <hal-device-board.h>

Overview

The Board provides the way to get device board information.

The Board functions provide board information including:

• Load/Unload for board hal-backend module
• Getter for device serial number
• Getter for device revision
• Setter for BOOT_SUCCESS flag
• Getter for boot mode
• Getter for boot reason
• Getter for current partition
• Setter for switch partition
• Getter/Setter for a/b partition cloned flag
• Getter/Setter for partition status
• Getter/Setter for upgrade progress status
• Getter/Setter for upgrade state
• Getter/Setter for upgrade type

For more information on the Board features and the macros, see HAL Board programming guides and tutorials.

Typedefs
typedef struct _hal_backend_device_board_funcs	hal_backend_device_board_funcs
	Structure for Board functions.

---

Data Structure Documentation

struct _hal_backend_device_board_funcs

Structure for Board functions.

Since:

HAL_MODULE_DEVICE_BOARD 1.0

Data Fields
int(*	get_device_serial_number )(char *buffer, const int max_len)
int(*	get_device_revision )(int *revision)
int(*	set_boot_success )(void)
int(*	clear_boot_mode )(void)
int(*	get_boot_mode )(char *buffer, const int max_len)
int(*	get_boot_reason )(char *buffer, const int max_len)
int(*	get_current_partition )(char *partition_ab)
int(*	switch_partition )(char partition_ab)
int(*	set_partition_ab_cloned )(void)
int(*	clear_partition_ab_cloned )(void)
int(*	get_partition_ab_cloned )(int *cloned)
int(*	set_partition_status )(char partition_ab, const char *status)
int(*	get_partition_status )(char partition_ab, char *buffer, const int max_len)
int(*	set_upgrade_progress_status )(int status)
int(*	get_upgrade_progress_status )(int *status)
int(*	set_upgrade_state )(char *state)
int(*	get_upgrade_state )(char *buffer, const int max_len)
int(*	set_upgrade_type )(char *type)
int(*	get_upgrade_type )(char *buffer, const int max_len)

---

Field Documentation

int(* _hal_backend_device_board_funcs::clear_boot_mode)(void)

Clear boot mode

int(* _hal_backend_device_board_funcs::clear_partition_ab_cloned)(void)

Clear a/b partition cloned flag

int(* _hal_backend_device_board_funcs::get_boot_mode)(char *buffer, const int max_len)

Get boot mode

int(* _hal_backend_device_board_funcs::get_boot_reason)(char *buffer, const int max_len)

Get boot reason

int(* _hal_backend_device_board_funcs::get_current_partition)(char *partition_ab)

Get current partition

int(* _hal_backend_device_board_funcs::get_device_revision)(int *revision)

Get revision of this device

int(* _hal_backend_device_board_funcs::get_device_serial_number)(char *buffer, const int max_len)

Get serial number of this device

int(* _hal_backend_device_board_funcs::get_partition_ab_cloned)(int *cloned)

Get a/b partition cloned flag

int(* _hal_backend_device_board_funcs::get_partition_status)(char partition_ab, char *buffer, const int max_len)

Get partition status

int(* _hal_backend_device_board_funcs::get_upgrade_progress_status)(int *status)

Get upgrade progress status

int(* _hal_backend_device_board_funcs::get_upgrade_state)(char *buffer, const int max_len)

Get upgrade state

int(* _hal_backend_device_board_funcs::get_upgrade_type)(char *buffer, const int max_len)

Get upgrade type

int(* _hal_backend_device_board_funcs::set_boot_success)(void)

Set boot success

int(* _hal_backend_device_board_funcs::set_partition_ab_cloned)(void)

Set a/b partition cloned flag

int(* _hal_backend_device_board_funcs::set_partition_status)(char partition_ab, const char *status)

Set partition status

int(* _hal_backend_device_board_funcs::set_upgrade_progress_status)(int status)

Set upgrade progress status

int(* _hal_backend_device_board_funcs::set_upgrade_state)(char *state)

Set upgrade state

int(* _hal_backend_device_board_funcs::set_upgrade_type)(char *type)

Set upgrade type

int(* _hal_backend_device_board_funcs::switch_partition)(char partition_ab)

Set to switch partition

---

Typedef Documentation

typedef struct _hal_backend_device_board_funcs hal_backend_device_board_funcs

Structure for Board functions.

Since:

HAL_MODULE_DEVICE_BOARD 1.0