You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The header for Arduino board-specific settings is variant.h,
not variants.h, so I modified it accordingly.
Signed-off-by: TOKITA Hiroshi <[email protected]>
Copy file name to clipboardExpand all lines: documentation/variants.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ target board. To add board support:
27
27
needs to be added it needs to be done in the `variants/` folder.
28
28
Add a folder inside of the variants folder that matches the name of your board.
29
29
2. Add an overlay file and a pinmap header file that match the name of the board.
30
-
3. Add your new headerfile to an `#ifdef` statement in the variants.h file.
30
+
3. Add your new headerfile to an `#ifdef` statement in the variant.h file.
31
31
32
32
An example of this structure is shown below.
33
33
@@ -37,13 +37,13 @@ variants/
37
37
│ ├── arduino_nano_33_ble.overlay
38
38
│ └── arduino_nano_33_ble_pinmap.h
39
39
├── CMakeLists.txt
40
-
└── variants.h
40
+
└── variant.h
41
41
42
42
```
43
43
44
-
- The top level consists of `CMakeLists.txt`, `variants.h` and the `<BOARD_NAME>` folder. Each of these files have a specific role to play.
44
+
- The top level consists of `CMakeLists.txt`, `variant.h` and the `<BOARD_NAME>` folder. Each of these files have a specific role to play.
45
45
- The `Cmakelists` help the compiler locate the proper directory to help find the proper header files that are board specific. You need to add the name using `zephyr_include_directories(BOARD_NAME)` to this file. Do note that this `BOARD_NAME` is the same as the name of your board's directory.
46
-
- `variants.h` contains the necessary `#includes` inorder to tell the source code about your board's pinmap.
46
+
- `variant.h` contains the necessary `#includes` inorder to tell the source code about your board's pinmap.
47
47
- The `<BOARD_NAME>` folder is where the overlay and pinmap file resides. Inorder to understand how to write DT overlays, lookup `Documentation/overlays.md`. To understand the `<boardname_pinmap.h>` file, go through the existing `variants/ARDUINO_NANO33BLE/arduino_nano_ble_sense_pinmap.h` which shows how to use the overlay nodes inside our C programs using zephyr macros like `GPIO_DT_SPEC_GET`. The zephyr-project documentation on this is pretty extensive as well and worth reading.
48
48
49
49
## Guide to Writing Overlays
@@ -193,7 +193,7 @@ One example of a change that you may find useful is mapping additional pins. For
193
193
example, the LEDs on the nRF52840 are not connected to any of the Arduino header
194
194
pins. To define a built-in LED for this board, a 22nd pin definition was added.
195
195
196
-
Your pinmap header file must be added to the variants.h file by adding three
196
+
Your pinmap header file must be added to the variant.h file by adding three
0 commit comments