no-OS
Functions | Variables
aducm3029_gpio.c File Reference

Implementation of GPIO driver for ADuCM302x. More...

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

Functions

int32_t aducm3029_gpio_get (struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
 Obtain the GPIO descriptor from the number specified in param. More...
 
int32_t aducm3029_gpio_get_optional (struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
 Get the value of an optional GPIO. More...
 
int32_t aducm3029_gpio_remove (struct no_os_gpio_desc *desc)
 Free the resources allocated by no_os_gpio_get(). More...
 
int32_t aducm3029_gpio_direction_input (struct no_os_gpio_desc *desc)
 Enable the input direction of the specified GPIO. More...
 
int32_t aducm3029_gpio_direction_output (struct no_os_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 aducm3029_gpio_get_direction (struct no_os_gpio_desc *desc, uint8_t *direction)
 Get the direction of the specified GPIO. More...
 
int32_t aducm3029_gpio_set_value (struct no_os_gpio_desc *desc, uint8_t value)
 Set the value of the specified GPIO. More...
 
int32_t aducm3029_gpio_get_value (struct no_os_gpio_desc *desc, uint8_t *value)
 Get the value of the specified GPIO. More...
 

Variables

const struct no_os_gpio_platform_ops aducm_gpio_ops
 ADuCM3029 platform specific GPIO platform ops structure. 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.

Function Documentation

◆ aducm3029_gpio_direction_input()

int32_t aducm3029_gpio_direction_input ( struct no_os_gpio_desc desc)

Enable the input direction of the specified GPIO.

Parameters
desc- The GPIO descriptor.
Returns
0 in case of success, -1 otherwise.

◆ aducm3029_gpio_direction_output()

int32_t aducm3029_gpio_direction_output ( struct no_os_gpio_desc desc,
uint8_t  value 
)

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

Parameters
desc- The GPIO descriptor.
value- The value. NO_OS_GPIO_HIGH or NO_OS_GPIO_LOW
Returns
0 in case of success, -1 otherwise.

◆ aducm3029_gpio_get()

int32_t aducm3029_gpio_get ( struct no_os_gpio_desc **  desc,
const struct no_os_gpio_init_param param 
)

Obtain the GPIO descriptor from the number specified in param.

Parameters
desc- Pointer to a structure were the descriptor will be stored.
param- Parameter describing the GPIO to be initialized
Returns
0 in case of success, -1 otherwise.

Deinitialize GPIO driver in case it was initialized by the GPIO IRQ driver

◆ aducm3029_gpio_get_direction()

int32_t aducm3029_gpio_get_direction ( struct no_os_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 NO_OS_GPIO_OUT or NO_OS_GPIO_IN
Returns
0 in case of success, -1 otherwise.

◆ aducm3029_gpio_get_optional()

int32_t aducm3029_gpio_get_optional ( struct no_os_gpio_desc **  desc,
const struct no_os_gpio_init_param param 
)

Get the value of an optional GPIO.

Parameters
desc- The GPIO descriptor.
param- GPIO Initialization parameters.
Returns
0 in case of success, -1 otherwise.

◆ aducm3029_gpio_get_value()

int32_t aducm3029_gpio_get_value ( struct no_os_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 NO_OS_GPIO_HIGH or NO_OS_GPIO_LOW
Returns
0 in case of success, -1 otherwise.

◆ aducm3029_gpio_remove()

int32_t aducm3029_gpio_remove ( struct no_os_gpio_desc desc)

Free the resources allocated by no_os_gpio_get().

Parameters
desc- The GPIO descriptor.
Returns
0 in case of success, -1 otherwise.

◆ aducm3029_gpio_set_value()

int32_t aducm3029_gpio_set_value ( struct no_os_gpio_desc desc,
uint8_t  value 
)

Set the value of the specified GPIO.

Parameters
desc- The GPIO descriptor.
value- The value: NO_OS_GPIO_HIGH, NO_OS_GPIO_LOW or NO_OS_GPIO_HIGH_Z Choosing NO_OS_GPIO_HIGH_Z will deactivate the input and output buffers.
Returns
0 in case of success, -1 otherwise.

Variable Documentation

◆ aducm_gpio_ops

const struct no_os_gpio_platform_ops aducm_gpio_ops
Initial value:
= {
.gpio_ops_get = &aducm3029_gpio_get,
.gpio_ops_get_optional = &aducm3029_gpio_get_optional,
.gpio_ops_remove = &aducm3029_gpio_remove,
.gpio_ops_direction_input = &aducm3029_gpio_direction_input,
.gpio_ops_direction_output = &aducm3029_gpio_direction_output,
.gpio_ops_get_direction = &aducm3029_gpio_get_direction,
.gpio_ops_set_value = &aducm3029_gpio_set_value,
.gpio_ops_get_value = &aducm3029_gpio_get_value
}

ADuCM3029 platform specific GPIO platform ops structure.

ADuCM3029 specific GPIO platform ops structure.

aducm3029_gpio_direction_output
int32_t aducm3029_gpio_direction_output(struct no_os_gpio_desc *desc, uint8_t value)
Enable the output direction of the specified GPIO and set the GPIO to the specified value.
Definition: aducm3029_gpio.c:160
aducm3029_gpio_remove
int32_t aducm3029_gpio_remove(struct no_os_gpio_desc *desc)
Free the resources allocated by no_os_gpio_get().
Definition: aducm3029_gpio.c:121
aducm3029_gpio_get_direction
int32_t aducm3029_gpio_get_direction(struct no_os_gpio_desc *desc, uint8_t *direction)
Get the direction of the specified GPIO.
Definition: aducm3029_gpio.c:192
aducm3029_gpio_direction_input
int32_t aducm3029_gpio_direction_input(struct no_os_gpio_desc *desc)
Enable the input direction of the specified GPIO.
Definition: aducm3029_gpio.c:141
aducm3029_gpio_get
int32_t aducm3029_gpio_get(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Obtain the GPIO descriptor from the number specified in param.
Definition: aducm3029_gpio.c:69
aducm3029_gpio_set_value
int32_t aducm3029_gpio_set_value(struct no_os_gpio_desc *desc, uint8_t value)
Set the value of the specified GPIO.
Definition: aducm3029_gpio.c:219
aducm3029_gpio_get_optional
int32_t aducm3029_gpio_get_optional(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Get the value of an optional GPIO.
Definition: aducm3029_gpio.c:105
aducm3029_gpio_get_value
int32_t aducm3029_gpio_get_value(struct no_os_gpio_desc *desc, uint8_t *value)
Get the value of the specified GPIO.
Definition: aducm3029_gpio.c:259