OPTIGA™ Trust M
Host Library Documentation
pal.h File Reference

This file provides the prototype declarations of platform abstraction layer. More...

Include dependency graph for pal.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

#define PAL_STATUS_SUCCESS   (0x0000)
 PAL API execution is successful. More...
 
#define PAL_STATUS_FAILURE   (0x0001)
 PAL API execution failed. More...
 
#define PAL_STATUS_I2C_BUSY   (0x0002)
 PAL I2C is busy. More...
 
#define PAL_STATUS_INVALID_INPUT   (0x0004)
 PAL API execution with wrong input arguments provided. More...
 
typedef uint16_t pal_status_t
 PAL return status. More...
 
LIBRARY_EXPORTS pal_status_t pal_init (void)
 Initializes the PAL layer. More...
 
LIBRARY_EXPORTS pal_status_t pal_deinit (void)
 De-Initializes the PAL layer. More...
 

Detailed Description

This file provides the prototype declarations of platform abstraction layer.

Author
Infineon Technologies AG

Definition in file pal.h.

Macro Definition Documentation

◆ PAL_STATUS_FAILURE

#define PAL_STATUS_FAILURE   (0x0001)

PAL API execution failed.

Definition at line 50 of file pal.h.

◆ PAL_STATUS_I2C_BUSY

#define PAL_STATUS_I2C_BUSY   (0x0002)

PAL I2C is busy.

Definition at line 52 of file pal.h.

◆ PAL_STATUS_INVALID_INPUT

#define PAL_STATUS_INVALID_INPUT   (0x0004)

PAL API execution with wrong input arguments provided.

Definition at line 54 of file pal.h.

◆ PAL_STATUS_SUCCESS

#define PAL_STATUS_SUCCESS   (0x0000)

PAL API execution is successful.

Definition at line 48 of file pal.h.

Typedef Documentation

◆ pal_status_t

typedef uint16_t pal_status_t

PAL return status.

Definition at line 60 of file pal.h.

Function Documentation

◆ pal_deinit()

LIBRARY_EXPORTS pal_status_t pal_deinit ( void  )

De-Initializes the PAL layer.

De-Initializes the PAL layer

Precondition
  • None
Note
  • None
Return values
PAL_STATUS_SUCCESSReturns when the PAL de-init it successful
PAL_STATUS_FAILUREReturns when the PAL de-init fails.

◆ pal_init()

LIBRARY_EXPORTS pal_status_t pal_init ( void  )

Initializes the PAL layer.

Initializes the PAL layer

Precondition
  • None
Note
  • None
Return values
PAL_STATUS_SUCCESSReturns when the PAL init it successful
PAL_STATUS_FAILUREReturns when the PAL init fails.