docs: Add initial board docs for Tiva arch #3604
Conversation
|
@v01d I would like your thoughts here, the dk-tm4c129x has a lot of great information, but it seems like it is 20% about the board 40% about the architecture and 40% about NuttX. Seems like we should maybe pull most of this out into its own documentation sections? Especially around the networking and sensor stuff. |
| ========== | ||
| Peripheral | ||
| ========== | ||
| GPIO | ||
| ADC | ||
| EEPROM | ||
| FLASH | ||
| HCIUART | ||
| I2C | ||
| MPU | ||
| PWM | ||
| QENCODER | ||
| SERIAL | ||
| SSI | ||
| TIMER | ||
| ETHERNET | ||
| WDT | ||
| I2S | ||
| USB | ||
| ========== |
There was a problem hiding this comment.
For other platforms this is a table with two more columns indicating support and any notes. It is better if we maintain format across documents, even if in this case everything is supported.
There was a problem hiding this comment.
I have no idea really what all is all supported. I think we need to make some progress getting all of these moved over though because right now it looks like 5 boards or so are supported total.
There was a problem hiding this comment.
I can update the peripheral support columns later
| GPIO | ||
| ----------- |
There was a problem hiding this comment.
Place holder, I just don't know what to write since I know very little about this arch.
| SimpleLink Sub-1 GHz CC1310 wireless MCU LaunchPad development kit | ||
|
|
||
| `TI LaunchXL-CC1310 <https://www.ti.com/tool/LAUNCHXL-CC1310>`_ |
There was a problem hiding this comment.
Integrate link in previous line. If you have a board picture, it would be good to add.
| DIO6_RLED CR2 High output illuminates | ||
| ========= ==== ======================== | ||
|
|
||
| If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in |
There was a problem hiding this comment.
use backticks for config terms and filenames.
| ========= ==== ======================== | ||
| DIO7_GLED CR1 High output illuminates | ||
| DIO6_RLED CR2 High output illuminates | ||
| ========= ==== ======================== |
There was a problem hiding this comment.
Add a header to indicate what the columns are?
| =========== ==== =============================== | ||
| DIO13_BTN1 SW1 Low input sensed when depressed | ||
| DIO14_BTN2 SW2 Low input sensed when depressed | ||
| =========== ==== =============================== |
Yes, I would split it as you suggest. Feel free to redistribute the content as you see fit (you can see other boards/soc docs to see what kind of content is placed in each case). |
|
This PR has been waiting a while; I think it improves the Tiva docs, though I'm not sure why the oocd.sh script and a few per-board README.txt are being deleted. I get that much of the information in them has moved to central documentation, but perhaps the README.txt files should stay and just tell people where to find the central docs? Other than that I think it is an improvement and should be merged soon if possible. |
It is not needed anymore openocd has board support and the updated docs refer to this. and a few per-board README.txt are being deleted. I get that much of the information in them has moved to central documentation, but perhaps the README.txt files should stay and just tell people where to find the central docs? Why should we have it in two places? Then we have to keep them linked. Idk I really wanted to just do a first pass of moving all the docs over but I do not have the time to at the same time improve all of them. |
Fair enough. Should this be merged or do you wish to keep the PR open to work on it more? |
|
Hi @btashton @Ouss4 @protobits, are there any objections to merging this PR? (I would like to apply the few suggested changes first.) Thanks! |
|
@hartmannathan fine by me. |
Co-authored-by: Matias N. <[email protected]>
Co-authored-by: Abdelatif Guettouche <[email protected]>
Co-authored-by: Abdelatif Guettouche <[email protected]>
Co-authored-by: Abdelatif Guettouche <[email protected]>
|
Ok it just needs to be rebased and marked as not a draft... |
Summary
Initial stab at updating the Tiva arch docs.