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

This file provides the prototype declarations of PAL GPIO. More...

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

Go to the source code of this file.

Data Structures

struct  pal_gpio
 Structure defines the PAL GPIO configuration. More...
 
typedef struct pal_gpio pal_gpio_t
 Structure defines the PAL GPIO configuration. More...
 
LIBRARY_EXPORTS void pal_gpio_set_high (const pal_gpio_t *p_gpio_context)
 Function to transmit and receive a packet. More...
 
LIBRARY_EXPORTS void pal_gpio_set_low (const pal_gpio_t *p_gpio_context)
 Sets the GPIO pin to Low state. More...
 
LIBRARY_EXPORTS pal_status_t pal_gpio_init (const pal_gpio_t *p_gpio_context)
 Function to initialize GPIO. More...
 
LIBRARY_EXPORTS pal_status_t pal_gpio_deinit (const pal_gpio_t *p_gpio_context)
 Function to de-initialize GPIO. More...
 

Detailed Description

This file provides the prototype declarations of PAL GPIO.

Author
Infineon Technologies AG

Definition in file pal_gpio.h.

Typedef Documentation

◆ pal_gpio_t

typedef struct pal_gpio pal_gpio_t

Structure defines the PAL GPIO configuration.

Function Documentation

◆ pal_gpio_deinit()

LIBRARY_EXPORTS pal_status_t pal_gpio_deinit ( const pal_gpio_t p_gpio_context)

Function to de-initialize GPIO.

Function to de-initialize GPIO.

Precondition
  • None
Note
  • None
Parameters
[in]p_gpio_contextValid pointer to PAL layer GPIO context
Return values
PAL_STATUS_SUCCESSOn successful execution
PAL_STATUS_FAILUREOn failure

◆ pal_gpio_init()

LIBRARY_EXPORTS pal_status_t pal_gpio_init ( const pal_gpio_t p_gpio_context)

Function to initialize GPIO.

Function to initialize GPIO.

Precondition
  • None
Note
  • None
Parameters
[in]p_gpio_contextValid pointer to PAL layer GPIO context
Return values
PAL_STATUS_SUCCESSOn successful execution
PAL_STATUS_FAILUREOn failure

◆ pal_gpio_set_high()

LIBRARY_EXPORTS void pal_gpio_set_high ( const pal_gpio_t p_gpio_context)

Function to transmit and receive a packet.

Function to transmit and receive a packet.

  • The API sets the pin high, only if the pin is assigned to a valid GPIO context
    Otherwise the API returns without any failure status
Precondition
  • None
Note
  • None
Parameters
[in]p_gpio_contextValid pointer to PAL layer GPIO context

◆ pal_gpio_set_low()

LIBRARY_EXPORTS void pal_gpio_set_low ( const pal_gpio_t p_gpio_context)

Sets the GPIO pin to Low state.

Sets the GPIO pin to Low state.

  • The API set the pin low, only if the pin is assigned to a valid GPIO context.
    Otherwise the API returns without any failure status.
Precondition
  • None
Note
  • None
Parameters
[in]p_gpio_contextValid pointer to PAL layer GPIO context