no-OS
aducm3029_gpio.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file aducm3029/aducm3029_gpio.h
3  * @brief Header containing no_os_gpio_platform_ops used by the GPIO driver.
4  * @author Andrei Porumb (andrei.porumb@analog.com)
5 ********************************************************************************
6  * Copyright 2021(c) Analog Devices, Inc.
7  *
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * - Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * - Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * - Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  * - The use of this software may or may not infringe the patent rights
22  * of one or more patent holders. This license does not release you
23  * from the requirement that you obtain separate licenses from these
24  * patent holders to use this software.
25  * - Use of the software either in source or binary form, must be run
26  * on or directly connected to an Analog Devices Inc. component.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
29  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
30  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
34  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 *******************************************************************************/
39 #ifndef ADUCM3029_GPIO_H_
40 #define ADUCM3029_GPIO_H_
41 
42 
44 #define PIN(nb) (1u << ((nb) & 0x0F))
45 
46 #define PORT(nb) (((nb) & 0xF0) >> 4)
47 
51 extern const struct no_os_gpio_platform_ops aducm_gpio_ops;
52 
53 #endif // ADUCM3029_GPIO_H_
no_os_gpio_init_param
Structure holding the parameters for GPIO initialization.
Definition: no_os_gpio.h:85
NO_OS_GPIO_OUT
#define NO_OS_GPIO_OUT
Definition: no_os_gpio.h:53
aducm_gpio_ops
const struct no_os_gpio_platform_ops aducm_gpio_ops
ADuCM3029 specific GPIO platform ops structure.
Definition: aducm3029_gpio.c:290
NO_OS_GPIO_HIGH_Z
@ NO_OS_GPIO_HIGH_Z
Definition: no_os_gpio.h:125
NO_OS_GPIO_HIGH
@ NO_OS_GPIO_HIGH
Definition: no_os_gpio.h:123
no_os_gpio_init_param::number
int32_t number
Definition: no_os_gpio.h:89
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
NO_OS_GPIO_IN
#define NO_OS_GPIO_IN
Definition: no_os_gpio.h:54
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
NO_OS_GPIO_LOW
@ NO_OS_GPIO_LOW
Definition: no_os_gpio.h:121
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
no_os_error.h
Error codes definition.
PORT
#define PORT(nb)
Definition: aducm3029_gpio.h:46
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
no_os_gpio_desc
Structure holding the GPIO descriptor.
Definition: no_os_gpio.h:102
no_os_gpio_get
int32_t no_os_gpio_get(struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
Obtain the GPIO decriptor.
Definition: no_os_gpio.c:55
aducm_gpio_ops
const struct no_os_gpio_platform_ops aducm_gpio_ops
ADuCM3029 platform specific GPIO platform ops structure.
Definition: aducm3029_gpio.c:290
NULL
#define NULL
Definition: wrapper.h:64
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
no_os_gpio_platform_ops
Structure holding gpio function pointers that point to the platform specific function.
Definition: no_os_gpio.h:133
no_os_gpio.h
Header file of GPIO Interface.
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
no_os_gpio_platform_ops::gpio_ops_get
int32_t(* gpio_ops_get)(struct no_os_gpio_desc **, const struct no_os_gpio_init_param *)
Definition: no_os_gpio.h:135
aducm3029_gpio.h
PIN
@ PIN
Definition: t_ad9528.h:162
no_os_gpio_desc::number
int32_t number
Definition: no_os_gpio.h:106