pal.h File Reference

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

#include "optiga_lib_types.h"

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.

Copyright

MIT License

Copyright (c) 2019 Infineon Technologies AG

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

\endcopyright

Author

Infineon Technologies AG

Macro Definition Documentation

PAL_STATUS_FAILURE

#define PAL_STATUS_FAILURE   (0x0001)

PAL API execution failed.

PAL_STATUS_I2C_BUSY

#define PAL_STATUS_I2C_BUSY   (0x0002)

PAL I2C is busy.

PAL_STATUS_INVALID_INPUT

#define PAL_STATUS_INVALID_INPUT   (0x0004)

PAL API execution with wrong input arguments provided.

PAL_STATUS_SUCCESS

#define PAL_STATUS_SUCCESS   (0x0000)

PAL API execution is successful.

Typedef Documentation

pal_status_t

typedef uint16_t pal_status_t

PAL return status.

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_SUCCESS	Returns when the PAL de-init it successful
PAL_STATUS_FAILURE	Returns 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_SUCCESS	Returns when the PAL init it successful
PAL_STATUS_FAILURE	Returns when the PAL init fails.