gpio.h File Reference

Cortex-M4 specific GPIO HAL interface. More...

#include "utils/gpio_types.h"

Include dependency graph for gpio.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	hal_gpio_setmode (hal_gpio_pin pin, hal_gpio_mode mode, hal_gpio_pullup_pulldown pupd)
	Set the mode of a GPIO pin.
hal_gpio_mode	hal_gpio_getmode (hal_gpio_pin pin)
	Get the current mode of a GPIO pin.
void	hal_gpio_digitalwrite (hal_gpio_pin pin, hal_gpio_state state)
	Write a digital state to a GPIO pin.
hal_gpio_state	hal_gpio_digitalread (hal_gpio_pin pin)
	Read the digital state from a GPIO pin.
void	hal_gpio_enable_rcc (hal_gpio_pin pin)
	Enable the RCC clock for a specific GPIO pin's port.
void	hal_gpio_set_alternate_function (hal_gpio_pin pin, hal_gpio_alternate_function_t alt_fn)
	Set the alternate function for a GPIO pin.
void	hal_gpio_set_output_type (hal_gpio_pin pin, hal_gpio_output_type otyper)
	Set the output type for a GPIO pin.
void	hal_gpio_set_output_speed (hal_gpio_pin pin, hal_gpio_output_speed speed)
	Set the output speed for a GPIO pin.

Detailed Description

Cortex-M4 specific GPIO HAL interface.

This header defines the function prototypes for configuring and controlling GPIO pins on Cortex-M4 microcontrollers. Functions include setting pin modes, reading and writing digital states, enabling clocks, and configuring alternate functions, output type, and speed.

Copyright

© NAVROBOTEC PVT. LTD.

Function Documentation

hal_gpio_digitalread()

hal_gpio_state hal_gpio_digitalread

(

hal_gpio_pin

pin

)

Read the digital state from a GPIO pin.

Parameters

pin	The GPIO pin to read.

Returns

The current digital state of the pin (HIGH/LOW).

Read the digital state from a GPIO pin.

Parameters

pin	Pin identifier.

Returns

Current pin state (high or low).

hal_gpio_digitalwrite()

void hal_gpio_digitalwrite	(	hal_gpio_pin	pin,
		hal_gpio_state	state )

Write a digital state to a GPIO pin.

Parameters

pin	The GPIO pin to write.
state	The digital state to set (HIGH/LOW).

Write a digital state to a GPIO pin.

Parameters

pin	Pin identifier.
state	Desired pin state (high or low). // Example: Set PA5 high hal_gpio_digitalwrite(PA5, HAL_GPIO_HIGH);

hal_gpio_enable_rcc()

void hal_gpio_enable_rcc

(

hal_gpio_pin

pin

)

Enable the RCC clock for a specific GPIO pin's port.

Parameters

pin	The GPIO pin whose port clock is to be enabled.

Enable the RCC clock for a specific GPIO pin's port.

Parameters

pin	Pin identifier.

Note

This function is usually called automatically by other GPIO functions, but can be called manually if required.

hal_gpio_getmode()

hal_gpio_mode hal_gpio_getmode

(

hal_gpio_pin

pin

)

Get the current mode of a GPIO pin.

Parameters

pin	The GPIO pin to query.

Returns

The current mode of the pin.

Parameters

pin	Pin identifier.

Returns

The current GPIO mode of the pin.

hal_gpio_set_alternate_function()

void hal_gpio_set_alternate_function	(	hal_gpio_pin	pin,
		hal_gpio_alternate_function_t	alt_fn )

Set the alternate function for a GPIO pin.

Parameters

pin	The GPIO pin to configure.
alt_fn	The alternate function to assign to the pin.

Set the alternate function for a GPIO pin.

Parameters

pin	Pin identifier.
alt_fn	Alternate function number/type.

Note

This function will internally set the pin mode to alternate function mode.

// Example: Set PA2 to USART2_TX alternate function
hal_gpio_set_alternate_function(PA2, HAL_GPIO_AF_USART2);

hal_gpio_set_output_speed()

void hal_gpio_set_output_speed	(	hal_gpio_pin	pin,
		hal_gpio_output_speed	speed )

Set the output speed for a GPIO pin.

Parameters

pin	The GPIO pin to configure.
speed	The output speed (low, medium, high, very high).

hal_gpio_set_output_type()

void hal_gpio_set_output_type	(	hal_gpio_pin	pin,
		hal_gpio_output_type	otyper )

Set the output type for a GPIO pin.

Parameters

pin	The GPIO pin to configure.
otyper	The output type (push-pull or open-drain).

hal_gpio_setmode()

void hal_gpio_setmode	(	hal_gpio_pin	pin,
		hal_gpio_mode	mode,
		hal_gpio_pullup_pulldown	pupd )

Set the mode of a GPIO pin.

Parameters

pin	The GPIO pin to configure.
mode	The desired mode (input, output, alternate function, analog).
pupd	Pull-up/pull-down configuration for the pin.

Set the mode of a GPIO pin.

Parameters

pin	Pin identifier.
mode	GPIO mode (input, output, alternate function, analog).
pupd	Pull-up/pull-down configuration.

Note

This function automatically enables the RCC clock for the GPIO port.

// Example: Configure PA5 as output with no pull-up/pull-down
hal_gpio_setmode(PA5, HAL_GPIO_MODE_OUTPUT, HAL_GPIO_NO_PULL);