mimxrt: Initial documentation for the mimxrt port. #7494
Conversation
98f45ff to
bd0a296
Compare
cf84ec4 to
e2d42be
Compare
|
Is this ready for final review, or do you want to wait until other features are implemented? |
docs/mimxrt/general.rst
Outdated
|
|
||
| Note | ||
| Most of the controllers do not have internal flash memory. Therefore | ||
| their flash capacity is dependent on an external flash chip! |
There was a problem hiding this comment.
In general I suggest that exclamation marks are not used in documentation unless really warranted.
There was a problem hiding this comment.
OK. Will be changed.
That is definitely an interim state, but I made it to show the Pin assignments of Devices like UART, SPI, I2C and PWM to pins. These are documented for Teensy, but not for the MIMXRT EVK boards. It contains some documentation about features in progress to get publish, like SDCard and PWM, and also the tiny DHT support addition which I have ready but did not send a PR yet. I'm preparing another "various" PR for collected small additions. |
b6ece64 to
6b03dba
Compare
ec15d77 to
257e958
Compare
813d446 to
97e2d46
Compare
59e04ef to
26ea6cb
Compare
26ea6cb to
5e5a9ba
Compare
The ARCH MIX board exposes the Ethernet Pins at it's connectors. Therefore the software is configured for using a LAN8720 PHY device. Breakout boards with the LAN8720 are available widespread for a low price. The documentation about Pin/GPIO assignment and firmare upload can be found in PR micropython#7494.
ac1cd8f to
41cb752
Compare
eab6e6c to
fc30b2e
Compare
|
In this PR there are
|
|
Thank you for all the review work. You cleaned up many PRs and notes piling up since long. I recall some like the one about the "low hanging fruits", which seemed out of reach for me when reading it the first time. |
And rearrange the files and links. Remove for now the file for the Encoder, such that the documentation matches the actual port.
And fix a formatting error in machine.PWM.rst.
Only few boards support it.
After it was changed in the code.
|
@dpgeorge About moving network.LANmimxrt.rst file: There is no network.LAN,rst file. There is a network.rst file, describing an abstract class, and a set of specific files for CC3, WIZNET5K, WLAN, WLANWiPy. The LANmimxrt.rst file follows that structure. |
Since it contains all the pin assignment tables, it fits better there.
OK, then this network.LANmimxrt.rst file can be renamed to network.LAN.rst and form the basis of the docs for that class. |
Editorial change: Move the MIMXRT specific sentence to the end of the section.
|
Done & updated in the repository. |
|
Squashed and merged in 7a447e0, with minor changes:
One thing I would say is that the quickref is too long. I think the tables of pins (eg for PWM) could go elsewhere, eg in a specific file with pinouts for each board. But that's not a critical thing. Anyway, this is a good addition, thank you! |
|
Thank you very much for merging. I'll split the quickref up with the next change. |
While the mimxrt port is made as compatible as possible to the mainline of ports, some aspects are slightly different. These documentation pages address some of them. If consists mainly of a quickref, the introduction and the 'general' pages. More to follow.
Note: I2C is already mentioned, even if it not yet merged. And SDCard as well, which is in good shape and under test and refinement now.