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.

Classes
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.

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

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_context

Valid pointer to PAL layer GPIO context

Return values

PAL_STATUS_SUCCESS	On successful execution
PAL_STATUS_FAILURE	On 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_context

Valid pointer to PAL layer GPIO context

Return values

PAL_STATUS_SUCCESS	On successful execution
PAL_STATUS_FAILURE	On 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_context

Valid 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_context

Valid pointer to PAL layer GPIO context