iot_hw.h File Reference

Define common APIs to get hardware ID and hardware revision. More...

Go to the source code of this file.

Macros
#define	IOT_HW_UNSUPPORTED   ( 0xFFFF )
	Error code returned by platform. More...

Functions
uint16_t	iot_hw_get_id (void)
	API to read hardware ID. More...
uint16_t	iot_hw_get_rev (void)
	API to read hardware revision. More...

Detailed Description

Define common APIs to get hardware ID and hardware revision.

Macro Definition Documentation

IOT_HW_UNSUPPORTED

#define IOT_HW_UNSUPPORTED   ( 0xFFFF )

Error code returned by platform.

We assume that neither hardware ID nor hardware revision number will ever be greater than 255 it means that API is not implemented or supported if API returns 0xFF

Function Documentation

iot_hw_get_id()

uint16_t iot_hw_get_id

(

void

)

API to read hardware ID.

Note

: the format and contents of this field are specific to each vendor. With the expectation that they will be unique for each board.

Returns

hardware ID number as unsigned byte

iot_hw_get_rev()

uint16_t iot_hw_get_rev

(

void

)

API to read hardware revision.

Note

: the format and contents of this field are specific to each vendor. With the expectation that they will be unique for each revision.

Returns

hardware revision number as unsigned byte