pico_gpio.c File Reference

Implementation of pico gpio functionality. More...

#include "no_os_util.h"
#include "no_os_error.h"
#include "no_os_alloc.h"
#include "pico_gpio.h"
#include "hardware/gpio.h"

Include dependency graph for pico_gpio.c:

Functions
int32_t	pico_gpio_get (struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
	Obtain the GPIO descriptor.
int32_t	pico_gpio_get_optional (struct no_os_gpio_desc **desc, const struct no_os_gpio_init_param *param)
	Get the value of an optional GPIO.
int32_t	pico_gpio_remove (struct no_os_gpio_desc *desc)
	Free the resources allocated by no_os_gpio_get().
int32_t	pico_gpio_direction_input (struct no_os_gpio_desc *desc)
	Enable the input direction of the specified GPIO.
int32_t	pico_gpio_direction_output (struct no_os_gpio_desc *desc, uint8_t value)
	Enable the output direction of the specified GPIO.
int32_t	pico_gpio_get_direction (struct no_os_gpio_desc *desc, uint8_t *direction)
	Get the direction of the specified GPIO.
int32_t	pico_gpio_set_value (struct no_os_gpio_desc *desc, uint8_t value)
	Set the value of the specified GPIO.
int32_t	pico_gpio_get_value (struct no_os_gpio_desc *desc, uint8_t *value)
	Get the value of the specified GPIO.

Variables
const struct no_os_gpio_platform_ops	pico_gpio_ops
	pico platform specific GPIO platform ops structure

Detailed Description

Implementation of pico gpio functionality.

Author

RBolboac (ramon.nosp@m.a.bo.nosp@m.lboac.nosp@m.a@an.nosp@m.alog..nosp@m.com)

Copyright 2022(c) Analog Devices, Inc.

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

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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

pico_gpio_direction_input()

int32_t pico_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, error code otherwise.

pico_gpio_direction_output()

int32_t pico_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, error code otherwise.

pico_gpio_get()

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

Obtain the GPIO descriptor.

Parameters

desc	- The GPIO descriptor.
param	- GPIO initialization parameters

Returns

0 in case of success, error code otherwise.

Here is the caller graph for this function:

pico_gpio_get_direction()

int32_t pico_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, error code otherwise.

pico_gpio_get_optional()

int32_t pico_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, error code otherwise.

pico_gpio_get_value()

int32_t pico_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, error code otherwise.

pico_gpio_remove()

int32_t pico_gpio_remove

(

struct no_os_gpio_desc *

desc

)

Free the resources allocated by no_os_gpio_get().

Parameters

desc	- The GPIO descriptor.

Returns

0.

pico_gpio_set_value()

int32_t pico_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, error code otherwise.

Variable Documentation

pico_gpio_ops

const struct no_os_gpio_platform_ops pico_gpio_ops

Initial value:

= {
    .gpio_ops_get = &pico_gpio_get,
    .gpio_ops_get_optional = &pico_gpio_get_optional,
    .gpio_ops_remove = &pico_gpio_remove,
    .gpio_ops_direction_input = &pico_gpio_direction_input,
    .gpio_ops_direction_output = &pico_gpio_direction_output,
    .gpio_ops_get_direction = &pico_gpio_get_direction,
    .gpio_ops_set_value = &pico_gpio_set_value,
    .gpio_ops_get_value = &pico_gpio_get_value,
}

pico platform specific GPIO platform ops structure

pico platform specific gpio platform ops structure