Skip to content

Commit f393f83

Browse files
committed
include: drivers: gpio: gpio_utils doxygen improvements
add a missing doc + actually show up the utilities from the gpio_utils.h header file in the doxygen documentation. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
1 parent 235704f commit f393f83

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

include/zephyr/drivers/gpio/gpio_utils.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,20 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
/**
8+
* @file
9+
* @brief Header file for GPIO utility functions
10+
* @ingroup gpio_interface
11+
*/
712

813
#ifndef ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_
914
#define ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_
1015

16+
/**
17+
* @addtogroup gpio_interface
18+
* @{
19+
*/
20+
1121
#include <stdbool.h>
1222
#include <stdint.h>
1323
#include <errno.h>
@@ -22,6 +32,12 @@
2232
extern "C" {
2333
#endif
2434

35+
/**
36+
* @brief Makes a bitmask of allowed GPIOs from a number of GPIOs.
37+
*
38+
* @param ngpios number of GPIOs
39+
* @return the bitmask of allowed gpios
40+
*/
2541
#define GPIO_PORT_PIN_MASK_FROM_NGPIOS(ngpios) \
2642
((gpio_port_pins_t)(((uint64_t)1 << (ngpios)) - 1U))
2743

@@ -109,4 +125,8 @@ static inline void gpio_fire_callbacks(sys_slist_t *list,
109125
}
110126
#endif
111127

128+
/**
129+
* @}
130+
*/
131+
112132
#endif /* ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_ */

0 commit comments

Comments
 (0)