gitproxy/RTLPlayground
1
0 Fork 0
mirror of https://github.com/logicog/RTLPlayground.git synced 2026-10-29 17:54:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update adding-a-device.md

Browse Source
This commit is contained in:
hlyi authored and GitHub committed 2026-10-14 00:22:08 -05:00
1 parent 813a62ca7d
commit e890e429a5
1 file changed
+2 -10
Download Patch File Download Diff File Expand all files Collapse all files
doc/adding-a-device.md
+2 -10
View File
@@ -1,17 +1,12 @@
# Adding a new device # Adding a new device
A device is supported by adding one board definition under `machine/`. A device is supported by adding one board definition under `machine/`.
the build selects the definition by name, and CI compiles every file it finds. the build selects the definition by name.
``` ```
make MACHINE=<NAME> make MACHINE=<NAME>
``` ```
`MACHINE=<NAME>` selects `machine/<NAME>.c` and is passed on to the compiler as
both `-DMACHINE_<NAME>` (for the `#if defined(MACHINE_...)` blocks in the rest
of the firmware) and `-DMACHINE_NAME=<NAME>` (which `machine.h` uses to include
`machine/<NAME>.h`). The two always take the same value, so they cannot drift.
## What a new device consists of ## What a new device consists of
| File | Purpose | | File | Purpose |
@@ -39,8 +34,6 @@ the template:
``` ```
The header is what the UI and the CLI print; `machine.h` includes it by name. The header is what the UI and the CLI print; `machine.h` includes it by name.
Nothing else belongs here — the machine is selected by the build, not by a
`#define` in the header.
> [!NOTE] > [!NOTE]
> `machine_name` is a `char[30]` and `MACHINE_MODEL` is copied into it at > `machine_name` is a `char[30]` and `MACHINE_MODEL` is copied into it at
@@ -136,8 +129,7 @@ ln -s KP_9000_6XHML_X2.c machine/MY_BOARD_1_0.c
The new board still needs `machine/MY_BOARD_1_0.h` with its own The new board still needs `machine/MY_BOARD_1_0.h` with its own
`MACHINE_MODEL`, because `MACHINE_MODEL` is what distinguishes the products. `MACHINE_MODEL`, because `MACHINE_MODEL` is what distinguishes the products.
Existing examples: `machine/PCB_K0402WS_V3.c`, `machine/KP_9000_9XHML_X_V3_2.c` Existing examples: `machine/PCB_K0402WS_V3.c`, `machine/KP_9000_9XHML_X_V3_2.c`
and the six `KP_9000_*` revision variants. `git ls-files -s machine` shows these and the six `KP_9000_*` revision variants.
as mode `120000`.
Two files that differ only in whitespace or comments are duplicates and should Two files that differ only in whitespace or comments are duplicates and should
be collapsed this way. be collapsed this way.