SYSTEM

Internal system. More...

Collaboration diagram for SYSTEM:

Enumerations
enum	system_result_t {   SYSTEM_RESULT_OK ,   SYSTEM_RESULT_INVALID ,   SYSTEM_RESULT_UNSUPPORTED ,   SYSTEM_RESULT_ERR ,   TOTAL_SYSTEM_RESULT }
enum	system_power_mode_t {   SYSTEM_POWER_MODE_SLEEP ,   SYSTEM_POWER_MODE_IDLE ,   SYSTEM_POWER_MODE_SHUTDOWN ,   SYSTEM_POWER_MODE_DEEP_SLEEP ,   SYSTEM_POWER_MODE_STOP ,   TOTAL_SYSTEM_POWER_MODE }

Functions
system_result_t	hal_system_reset (void)
	Perform system reset.
system_result_t	hal_system_set_power_mode (system_power_mode_t mode)
	Put device into sleep mode.
uint32_t	hal_system_get_ticks (void)
	Get system ticks.
system_result_t	hal_system_get_serial_number (void *serial_number, const size_t len)
	Get device serial number from manufacturer.
system_result_t	hal_system_get_temp_celsius (float *temp)
	Get device internal temperature in degrees Celsius.

Detailed Description

Internal system.

Enumeration Type Documentation

system_power_mode_t

enum system_power_mode_t

#include <system/public_inc/hal_system.h>

Enumerator
SYSTEM_POWER_MODE_SLEEP
SYSTEM_POWER_MODE_IDLE
SYSTEM_POWER_MODE_SHUTDOWN
SYSTEM_POWER_MODE_DEEP_SLEEP
SYSTEM_POWER_MODE_STOP
TOTAL_SYSTEM_POWER_MODE

system_result_t

enum system_result_t

#include <system/public_inc/hal_system.h>

Enumerator
SYSTEM_RESULT_OK	No error.
SYSTEM_RESULT_INVALID	Operation invalid.
SYSTEM_RESULT_UNSUPPORTED	Operation not supported.
SYSTEM_RESULT_ERR	Error occurred.
TOTAL_SYSTEM_RESULT

Function Documentation

hal_system_get_serial_number()

system_result_t hal_system_get_serial_number	(	void *	serial_number,
		const size_t	len )

#include <system/public_inc/hal_system.h>

Get device serial number from manufacturer.

uint32_t serial_number[2U];
 
hal_system_get_serial_number( serial_number, sizeof( serial_number ) );

Parameters

[in,out]	serial_number	Device serial number buffer
[in]	len	Buffer size

Return values

SYSTEM_RESULT_OK	Success get device serial number
SYSTEM_RESULT_UNSUPPORTED	Operation not supported
SYSTEM_RESULT_ERR	Failed to get device serial number

hal_system_get_temp_celsius()

system_result_t hal_system_get_temp_celsius

(

float *

temp

)

#include <system/public_inc/hal_system.h>

Get device internal temperature in degrees Celsius.

float temp = 0.0f;
 
system_result_t result = hal_system_get_temp_celsius( &temp );

Parameters

[in,out]

temp

Temperature in degrees Celsius

Return values

SYSTEM_RESULT_OK	Success get internal temperature
SYSTEM_RESULT_UNSUPPORTED	Operation not supported
SYSTEM_RESULT_ERR	Failed to get internal temperature

hal_system_get_ticks()

uint32_t hal_system_get_ticks

(

void

)

#include <system/public_inc/hal_system.h>

Get system ticks.

uint32_t systick = hal_system_get_tick();

Returns

System tick since boot

hal_system_reset()

system_result_t hal_system_reset

(

void

)

#include <system/public_inc/hal_system.h>

Perform system reset.

system_result_t result = hal_system_reset();

Return values

SYSTEM_RESULT_UNSUPPORTED	Operation not supported
SYSTEM_RESULT_ERR	Failed to perform system reset

hal_system_set_power_mode()

system_result_t hal_system_set_power_mode

(

system_power_mode_t

mode

)

#include <system/public_inc/hal_system.h>

Put device into sleep mode.

hal_system_set_power_mode( SYSTEM_POWER_MODE_SLEEP );

Parameters

[in]

mode

Device power mode

Return values

SYSTEM_RESULT_OK	Success enter sleep mode
SYSTEM_RESULT_UNSUPPORTED	Operation not supported
SYSTEM_RESULT_ERR	Failed to enter sleep mode