no-OS
Macros | Functions
gpio.c File Reference

Implementation of GPIO driver for ADuCM302x. More...

#include "error.h"
#include "gpio.h"
#include <drivers/gpio/adi_gpio.h>
#include <stdlib.h>
Include dependency graph for gpio.c:

Macros

#define PIN(nb)   (1u << ((nb) & 0x0F))
 
#define PORT(nb)   (((nb) & 0xF0) >> 4)
 

Functions

int32_t gpio_get (struct gpio_desc **desc, const struct gpio_init_param *param)
 Obtain the GPIO descriptor from the number specified in param. More...
 
int32_t gpio_get_optional (struct gpio_desc **desc, const struct gpio_init_param *param)
 Get the value of an optional GPIO. More...
 
int32_t gpio_remove (struct gpio_desc *desc)
 Free the resources allocated by gpio_get(). More...
 
int32_t gpio_direction_input (struct gpio_desc *desc)
 Enable the input direction of the specified GPIO. More...
 
int32_t gpio_direction_output (struct gpio_desc *desc, uint8_t value)
 Enable the output direction of the specified GPIO and set the GPIO to the specified value. More...
 
int32_t gpio_get_direction (struct gpio_desc *desc, uint8_t *direction)
 Get the direction of the specified GPIO. More...
 
int32_t gpio_set_value (struct gpio_desc *desc, uint8_t value)
 Set the value of the specified GPIO. More...
 
int32_t gpio_get_value (struct gpio_desc *desc, uint8_t *value)
 Get the value of the specified GPIO. More...
 

Detailed Description

Implementation of GPIO driver for ADuCM302x.

Author
Mihail Chindris (mihai.nosp@m.l.ch.nosp@m.indri.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright 2019(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ PIN

#define PIN (   nb)    (1u << ((nb) & 0x0F))

Get GPIO pin from GPIO number

◆ PORT

#define PORT (   nb)    (((nb) & 0xF0) >> 4)

Get GPIO port from GPIO number

Function Documentation

◆ gpio_direction_input()

int32_t gpio_direction_input ( struct gpio_desc desc)

Enable the input direction of the specified GPIO.

Parameters
desc- The GPIO descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ gpio_direction_output()

int32_t gpio_direction_output ( struct gpio_desc desc,
uint8_t  value 
)

Enable the output direction of the specified GPIO and set the GPIO to the specified value.

Enable the output direction of the specified GPIO.

Parameters
desc- The GPIO descriptor.
value- The value. GPIO_HIGH or GPIO_LOW
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ gpio_get()

int32_t gpio_get ( struct gpio_desc **  desc,
const struct gpio_init_param param 
)

Obtain the GPIO descriptor from the number specified in param.

Obtain the GPIO decriptor.

Parameters
desc- Pointer to a structure were the descriptor will be stored.
param- Parameter describing the GPIO to be initialized
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ gpio_get_direction()

int32_t gpio_get_direction ( struct gpio_desc desc,
uint8_t *  direction 
)

Get the direction of the specified GPIO.

Parameters
desc- The GPIO descriptor.
direction- Variable where to store the direction. Will be set to GPIO_OUT or GPIO_IN
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ gpio_get_optional()

int32_t gpio_get_optional ( struct gpio_desc **  desc,
const struct gpio_init_param param 
)

Get the value of an optional GPIO.

Parameters
desc- The GPIO descriptor.
param- GPIO Initialization parameters.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ gpio_get_value()

int32_t gpio_get_value ( struct gpio_desc desc,
uint8_t *  value 
)

Get the value of the specified GPIO.

Parameters
desc- The GPIO descriptor.
value- Variable where to store the direction. Will be set to GPIO_HIGH or GPIO_LOW
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ gpio_remove()

int32_t gpio_remove ( struct gpio_desc desc)

Free the resources allocated by gpio_get().

Parameters
desc- The GPIO descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function:

◆ gpio_set_value()

int32_t gpio_set_value ( struct gpio_desc desc,
uint8_t  value 
)

Set the value of the specified GPIO.

Parameters
desc- The GPIO descriptor.
value- The value: GPIO_HIGH, GPIO_LOW or GPIO_HIGH_Z Choosing GPIO_HIGH_Z will deactivate the input and output buffers.
Returns
SUCCESS in case of success, FAILURE otherwise.
Here is the caller graph for this function: