Swatantra-66 opened a new pull request, #20624:
URL: https://github.com/apache/nuttx/pull/20624
## Summary
This PR migrates the legacy monospaced `README.txt` for the **NXP Freedom
K64F (FRDM-K64F)** development board (MK64FN1M0VLL12 microcontroller) into
standard Sphinx rST documentation format in `index.rst`, removing the `..
include:: README.txt :literal:` raw inclusion stub and deleting the legacy
`README.txt`.
Part of **Issue #11077** (*Documentation: port remaining README.txt in
platforms*) and **Issue #15737** (*NuttX-13.0.0 Release Notes*).
### Key Contents & Additions:
1. **Overview & MCU Hardware Specifications**:
- NXP Kinetis MK64FN1M0VLL12 MCU (32-bit ARM Cortex-M4 with
single-precision hardware FPU running up to 120 MHz, 1 MB Flash, 256 KB SRAM).
- Board features: OpenSDAv2 debug interface, MicroSD card slot, 10/100
Ethernet, FXOS8700CQ 6-axis motion sensor, and Arduino R3 compatible header
footprint.
2. **Pin Mapping & Hardware Tables**:
- Tricolor (RGB) user LED table: Red on `PTB22`, Blue on `PTB21`, Green
on `PTE26` (active low).
- LED status machine table under `CONFIG_ARCH_LEDS` (idle green
statically ON, kernel panic flashing red at 2 Hz).
- User pushbuttons: `SW2` (`PTC6` / LLWU_P10) and `SW3` (`PTA4` / NMI /
LLWU_P3).
- Serial console pinouts: Default OpenSDAv2 VCOM on `UART0` (`PTB16` RX /
`PTB17` TX) at 115200 8N1, and Arduino shield console on `UART3` (`PTC16` RX /
`PTC17` TX).
3. **Ethernet (KSZ8081RNA PHY) & Networking**:
- Comprehensive RMII signal mapping table between MCU and KSZ8081 PHY.
- Highlights the critical hardware requirement for the internal MDIO
pull-up resistor via `CONFIG_KINETIS_ENET_MDIOPULLUP=y`.
4. **MicroSD Storage (SDHC)**:
- Pinout mapping table for the 4-bit SDIO interface and card-detection
switch on `PTE6`.
5. **Flashing & Debugging Guides**:
- OpenSDAv2 Mass Storage Device (MSD) drag-and-drop programming (`cp
nuttx.bin /media/$USER/FRDM-K64F/`).
- Run-control flashing and GDB server debugging via `pyOCD` and `OpenOCD`
(CMSIS-DAP).
- Notes on Segger J-Link OpenSDA firmware.
6. **Board Configurations**:
- `nsh`: Basic interactive shell over OpenSDA UART0 VCOM.
- `netnsh`: 10/100 Mbps Ethernet network stack with TCP/IP, UDP, ICMP
ping, TFTP, wget, and Telnet daemon. Documented asynchronous background thread
initialization (`CONFIG_NETINIT_THREAD=y`) and PHY link monitoring
(`CONFIG_NETDEV_PHY_IOCTL=y`).
- `cdcacm`: NSH shell over OpenSDA UART0 with native USB CDC/ACM device
on `/dev/ttyACM0` via `sercon`/`serdis`, PWM, and SDHC support.
- `demo`: Comprehensive feature demonstration with NSH, onboard
FXOS8700CQ sensor example (`examples/fxos8700cq`), PWM, Ethernet, and SDHC.
Addresses #11077
Part of #15737
## Impact
- **Documentation only**: Zero functional impact on RTOS kernel, drivers, or
build logic.
- Replaces raw monospaced `.. include:: README.txt :literal:` with
structured, hyperlinked Sphinx rST.
- Removes legacy `README.txt`.
## Testing
- Validated rST syntax and table alignment with `docutils` (0 errors, 0
warnings).
- Verified defconfigs for `freedom-k64f:nsh`, `netnsh`, `cdcacm`, and `demo`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
