optiga/include/optiga/pal/pal_logger.h File Reference

This file provides the prototypes declarations for pal logger. More...

#include "optiga/pal/pal.h"

Include dependency graph for optiga/include/optiga/pal/pal_logger.h:

Go to the source code of this file.

Data Structures
struct	pal_logger
	PAL logger context structure. More...
typedef struct pal_logger	pal_logger_t
	PAL logger context structure. More...
pal_status_t	pal_logger_init (void *p_logger_context)
	Initializes the logger port. More...
pal_status_t	pal_logger_deinit (void *p_logger_context)
	De-Initializes the logger port. More...
pal_status_t	pal_logger_write (void *p_logger_context, const uint8_t *p_log_data, uint32_t log_data_length)
	Writes to logger port. More...
pal_status_t	pal_logger_read (void *p_logger_context, uint8_t *p_log_data, uint32_t log_data_length)
	Read to logger port. More...

Detailed Description

This file provides the prototypes declarations for pal logger.

Author

Infineon Technologies AG

Definition in file optiga/include/optiga/pal/pal_logger.h.

Typedef Documentation

pal_logger_t

typedef struct pal_logger pal_logger_t

PAL logger context structure.

Function Documentation

pal_logger_deinit()

pal_status_t pal_logger_deinit

(

void *

p_logger_context

)

De-Initializes the logger port.

De-Initializes the logger port.

• Clears the structure low level logging.
  

Precondition

• None.

Note

• None

Parameters

[in]

p_logger_context

Valid pointer to the PAL logger context that should be initialized

Return values

PAL_STATUS_SUCCESS	In case of successfully written to logger
PAL_STATUS_FAILURE	In case of failure while writing to logger

pal_logger_init()

pal_status_t pal_logger_init

(

void *

p_logger_context

)

Initializes the logger port.

Initializes the logger port.

• Creates and initializes structure low level logging.
  

Precondition

• None.

Note

• None

Parameters

[in]

p_logger_context

Valid pointer to the PAL logger context that should be initialized

Return values

PAL_STATUS_SUCCESS	In case of successfully written to logger
PAL_STATUS_FAILURE	In case of failure while writing to logger

pal_logger_read()

pal_status_t pal_logger_read	(	void *	p_logger_context,
		uint8_t *	p_log_data,
		uint32_t	log_data_length
	)

Read to logger port.

Reads to logger port.

• Invokes the platform dependent function to log the information provided.
  

Precondition

• The pal_logger is initialized if required.

Note

• None

Parameters

[in]	p_logger_context	Valid pointer to the PAL logger context that should be initialized
[in]	p_log_data	Pointer to the log data (data to be logged)
[in]	log_data_length	Length of data to be logged.

Return values

PAL_STATUS_SUCCESS	In case of successfully read to logger
PAL_STATUS_FAILURE	In case of failure while read to logger

pal_logger_write()

pal_status_t pal_logger_write	(	void *	p_logger_context,
		const uint8_t *	p_log_data,
		uint32_t	log_data_length
	)

Writes to logger port.

Writes to logger port.

• Invokes the platform dependent function to log the information provided.
  

Precondition

• The pal_logger is initialized if required.

Note

• None

Parameters

[in]	p_logger_context	Valid pointer to the PAL logger context that should be initialized
[in]	p_log_data	Pointer to the log data (data to be logged)
[in]	log_data_length	Length of data to be logged.

Return values

PAL_STATUS_SUCCESS	In case of successfully written to logger
PAL_STATUS_FAILURE	In case of failure while writing to logger