no-OS
Functions | Variables
altera_gpio.c File Reference

Implementation of Altera GPIO Generic Driver. More...

#include <stdlib.h>
#include <altera_avalon_spi_regs.h>
#include "no_os_gpio.h"
#include "gpio_extra.h"
#include "no_os_error.h"
#include "parameters.h"
Include dependency graph for altera_gpio.c:

Functions

int32_t altera_gpio_get (struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
 Obtain the GPIO decriptor. More...
 
int32_t altera_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 altera_gpio_remove (struct no_os_gpio_desc *desc)
 Free the resources allocated by no_os_gpio_get(). More...
 
int32_t altera_gpio_direction_input (struct no_os_gpio_desc *desc)
 Enable the input direction of the specified GPIO. More...
 
int32_t altera_gpio_direction_output (struct no_os_gpio_desc *desc, uint8_t value)
 Enable the output direction of the specified GPIO. More...
 
int32_t altera_gpio_get_direction (struct no_os_gpio_desc *desc, uint8_t *direction)
 Get the direction of the specified GPIO. More...
 
int32_t altera_gpio_set_value (struct no_os_gpio_desc *desc, uint8_t value)
 Set the value of the specified GPIO. More...
 
int32_t altera_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 altera_gpio_ops
 Altera platform specific GPIO platform ops structure. More...
 

Detailed Description

Implementation of Altera GPIO Generic Driver.

Author
Antoniu Miclaus (anton.nosp@m.iu.m.nosp@m.iclau.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

◆ altera_gpio_direction_input()

int32_t altera_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.

◆ altera_gpio_direction_output()

int32_t altera_gpio_direction_output ( struct no_os_gpio_desc desc,
uint8_t  value 
)

Enable the output direction of the specified GPIO.

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

◆ altera_gpio_get()

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

Obtain the GPIO decriptor.

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

◆ altera_gpio_get_direction()

int32_t altera_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- The direction. Example: NO_OS_GPIO_OUT NO_OS_GPIO_IN
Returns
0 in case of success, -1 otherwise.

◆ altera_gpio_get_optional()

int32_t altera_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.

◆ altera_gpio_get_value()

int32_t altera_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- The value. Example: NO_OS_GPIO_HIGH NO_OS_GPIO_LOW
Returns
0 in case of success, -1 otherwise.

◆ altera_gpio_remove()

int32_t altera_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.

◆ altera_gpio_set_value()

int32_t altera_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. Example: NO_OS_GPIO_HIGH NO_OS_GPIO_LOW
Returns
0 in case of success, -1 otherwise.

Variable Documentation

◆ altera_gpio_ops

const struct no_os_gpio_platform_ops altera_gpio_ops
Initial value:
= {
.gpio_ops_get = &altera_gpio_get,
.gpio_ops_get_optional = &altera_gpio_get_optional,
.gpio_ops_remove = &altera_gpio_remove,
.gpio_ops_direction_input = &altera_gpio_direction_input,
.gpio_ops_direction_output = &altera_gpio_direction_output,
.gpio_ops_get_direction = &altera_gpio_get_direction,
.gpio_ops_set_value = &altera_gpio_set_value,
.gpio_ops_get_value = &altera_gpio_get_value,
}

Altera platform specific GPIO platform ops structure.

Altera platform specific gpio platform ops structure.

altera_gpio_get_direction
int32_t altera_gpio_get_direction(struct no_os_gpio_desc *desc, uint8_t *direction)
Get the direction of the specified GPIO.
Definition: altera_gpio.c:162
altera_gpio_get
int32_t altera_gpio_get(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Obtain the GPIO decriptor.
Definition: altera_gpio.c:61
altera_gpio_direction_input
int32_t altera_gpio_direction_input(struct no_os_gpio_desc *desc)
Enable the input direction of the specified GPIO.
Definition: altera_gpio.c:131
altera_gpio_remove
int32_t altera_gpio_remove(struct no_os_gpio_desc *desc)
Free the resources allocated by no_os_gpio_get().
Definition: altera_gpio.c:116
altera_gpio_get_value
int32_t altera_gpio_get_value(struct no_os_gpio_desc *desc, uint8_t *value)
Get the value of the specified GPIO.
Definition: altera_gpio.c:225
altera_gpio_set_value
int32_t altera_gpio_set_value(struct no_os_gpio_desc *desc, uint8_t value)
Set the value of the specified GPIO.
Definition: altera_gpio.c:184
altera_gpio_direction_output
int32_t altera_gpio_direction_output(struct no_os_gpio_desc *desc, uint8_t value)
Enable the output direction of the specified GPIO.
Definition: altera_gpio.c:148
altera_gpio_get_optional
int32_t altera_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: altera_gpio.c:100