Skip to content

Commit 654d794

Browse files
committed
include: devicetree: gpio: add doxygen group for GPIO pin headers macros
Add a Doxygen group for the GPIO pin headers macros and initially document Arduino Uno (R3) header pin constants. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 822ea37 commit 654d794

File tree

2 files changed

+43
-23
lines changed

2 files changed

+43
-23
lines changed

include/zephyr/devicetree/gpio.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ extern "C" {
2222
* @ingroup devicetree
2323
* @ingroup gpio_interface
2424
* @{
25+
*
26+
* @defgroup devicetree-gpio-pin-headers GPIO pin headers
27+
* @brief Constants for pins exposed on common GPIO pin headers
28+
* @{
29+
* @}
2530
*/
2631

2732
/**
Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,48 @@
1-
/**
1+
/*
22
* Copyright (c) 2025 TOKITA Hiroshi
33
*
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66

7+
/**
8+
* @file
9+
* @brief Arduino Uno (R3) header pin constants
10+
* @ingroup arduino-header-r3
11+
*/
12+
713
#ifndef ZEPHYR_INCLUDE_DT_BINDINGS_GPIO_ARDUINO_HEADER_R3_H_
814
#define ZEPHYR_INCLUDE_DT_BINDINGS_GPIO_ARDUINO_HEADER_R3_H_
915

10-
#define ARDUINO_HEADER_R3_A0 0
11-
#define ARDUINO_HEADER_R3_A1 1
12-
#define ARDUINO_HEADER_R3_A2 2
13-
#define ARDUINO_HEADER_R3_A3 3
14-
#define ARDUINO_HEADER_R3_A4 4
15-
#define ARDUINO_HEADER_R3_A5 5
16-
#define ARDUINO_HEADER_R3_D0 6
17-
#define ARDUINO_HEADER_R3_D1 7
18-
#define ARDUINO_HEADER_R3_D2 8
19-
#define ARDUINO_HEADER_R3_D3 9
20-
#define ARDUINO_HEADER_R3_D4 10
21-
#define ARDUINO_HEADER_R3_D5 11
22-
#define ARDUINO_HEADER_R3_D6 12
23-
#define ARDUINO_HEADER_R3_D7 13
24-
#define ARDUINO_HEADER_R3_D8 14
25-
#define ARDUINO_HEADER_R3_D9 15
26-
#define ARDUINO_HEADER_R3_D10 16
27-
#define ARDUINO_HEADER_R3_D11 17
28-
#define ARDUINO_HEADER_R3_D12 18
29-
#define ARDUINO_HEADER_R3_D13 19
30-
#define ARDUINO_HEADER_R3_D14 20
31-
#define ARDUINO_HEADER_R3_D15 21
16+
/**
17+
* @defgroup arduino-header-r3 Arduino Uno (R3) header
18+
* @brief Constants for pins exposed on Arduino Uno (R3) header
19+
* @ingroup devicetree-gpio-pin-headers
20+
* @{
21+
*/
22+
23+
#define ARDUINO_HEADER_R3_A0 0 /**< Analog pin 0 (A0) */
24+
#define ARDUINO_HEADER_R3_A1 1 /**< Analog pin 1 (A1) */
25+
#define ARDUINO_HEADER_R3_A2 2 /**< Analog pin 2 (A2) */
26+
#define ARDUINO_HEADER_R3_A3 3 /**< Analog pin 3 (A3) */
27+
#define ARDUINO_HEADER_R3_A4 4 /**< Analog pin 4 (A4) */
28+
#define ARDUINO_HEADER_R3_A5 5 /**< Analog pin 5 (A5) */
29+
#define ARDUINO_HEADER_R3_D0 6 /**< Digital pin 0 (D0) */
30+
#define ARDUINO_HEADER_R3_D1 7 /**< Digital pin 1 (D1) */
31+
#define ARDUINO_HEADER_R3_D2 8 /**< Digital pin 2 (D2) */
32+
#define ARDUINO_HEADER_R3_D3 9 /**< Digital pin 3 (D3) */
33+
#define ARDUINO_HEADER_R3_D4 10 /**< Digital pin 4 (D4) */
34+
#define ARDUINO_HEADER_R3_D5 11 /**< Digital pin 5 (D5) */
35+
#define ARDUINO_HEADER_R3_D6 12 /**< Digital pin 6 (D6) */
36+
#define ARDUINO_HEADER_R3_D7 13 /**< Digital pin 7 (D7) */
37+
#define ARDUINO_HEADER_R3_D8 14 /**< Digital pin 8 (D8) */
38+
#define ARDUINO_HEADER_R3_D9 15 /**< Digital pin 9 (D9) */
39+
#define ARDUINO_HEADER_R3_D10 16 /**< Digital pin 10 (D10) */
40+
#define ARDUINO_HEADER_R3_D11 17 /**< Digital pin 11 (D11) */
41+
#define ARDUINO_HEADER_R3_D12 18 /**< Digital pin 12 (D12) */
42+
#define ARDUINO_HEADER_R3_D13 19 /**< Digital pin 13 (D13) */
43+
#define ARDUINO_HEADER_R3_D14 20 /**< Digital pin 14 (D14) */
44+
#define ARDUINO_HEADER_R3_D15 21 /**< Digital pin 15 (D15) */
45+
46+
/** @} */
3247

3348
#endif /* ZEPHYR_INCLUDE_DT_BINDINGS_GPIO_ARDUINO_HEADER_R3_H_ */

0 commit comments

Comments
 (0)