This is an automated email from the ASF dual-hosted git repository. simbit18 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/nuttx.git
commit 4b18a8e715917fca9f31abc3f92524631516c29b Author: Matteo Golin <[email protected]> AuthorDate: Thu Feb 12 11:56:00 2026 -0500 docs/chipkit-wifire: Migrate README.txt to RST Migrate legacy README.txt docs to RST format. Signed-off-by: Matteo Golin <[email protected]> --- .../mips/pic32mz/boards/chipkit-wifire/README.txt | 104 ---------------- .../boards/chipkit-wifire/chipkit-wifire.jpg | Bin 0 -> 41816 bytes .../mips/pic32mz/boards/chipkit-wifire/index.rst | 131 ++++++++++++++++++++- 3 files changed, 127 insertions(+), 108 deletions(-) diff --git a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/README.txt b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/README.txt deleted file mode 100644 index 0c7289cf51d..00000000000 --- a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/README.txt +++ /dev/null @@ -1,104 +0,0 @@ -README -====== - - chipKIT Wi-FIRE board - (https://chipkit.net/wiki/index.php?title=ChipKIT_Wi-Fire) features - the Microchip PIC32MZ2048EFG100 MCU, Microchip MRF24WG0MA Wi-Fi module, - USB 2.0 Full-Speed / Hi-Speed OTG controller, Micro SD card connector etc. - The PIC32MZ2048EFG100 is a 200 MHz 32-bit MIPS M5150 operation with 2MB Flash - memory and 512KB RAM. - -Contents -======== - - - Toolchain - - Building NuttX for the chipKIT Wi-FIRE board - - Programming Flash - - Serial console - -Toolchain -========= - - The following Toolchain options have been tested and confirmed to work: - - CONFIG_MIPS32_TOOLCHAIN_PINGUINOL - Pinquino Toolchain - for Linux - CONFIG_MIPS32_TOOLCHAIN_SOURCERY_CODEBENCH_LITE - Sourcery CodeBench Lite - Toolchain for Linux - - Pinquino Toolchain can be downloaded here: - - https://github.com/PinguinoIDE/pinguino-compilers - - Sourcery CodeBench Lite Toolchain for Linux can be downloaded and - installed as follows: - - $ wget https://sourcery.mentor.com/GNUToolchain/package12725/public/mips-sde-elf/mips-2014.05-24-mips-sde-elf-i686-pc-linux-gnu.tar.bz2 - $ sudo tar xvjf mips-2014.05-24-mips-sde-elf-i686-pc-linux-gnu.tar.bz2 \ - -C /usr/local - -Building NuttX for the chipKIT Wi-FIRE board -============================================ - - $ cd nuttx - $ make apps_distclean - $ make distclean - $ ./tools/configure.sh -l chipkit-wifire:nsh - $ make - -Programming Flash -================= - - CAUTION: - - Currently the pre-installed bootloader of the chipKIT Wi-FIRE board - is not supported in this NuttX configuration. Doing the following - steps will erase the factory installed bootloader in the Flash - memory! If you are going to recover the bootloader later on your - chipKIT Wi-FIRE board, the original chipKIT bootloader can be found here: - https://reference.digilentinc.com/_media/chipkit_wifire/chipkit-wifire-v01000303.zip - - Flash memory can be programmed with a PICkit 2 programmer via the - 6-pin ICSP connector JP1 of chipKIT Wi-FIRE board. - - A program is needed to interface to the PICkit 2. One such program - is the pic32prog utility: - https://github.com/sergev/pic32prog.git - - It is recommended to configure udev rules so that root privileges - are not needed to use pic32prog; root privileges will only be needed - for this one-time setup: - - 1. On most Linux distributions, add the user to the plugdev group: - - $ sudo useradd -G plugdev $(whoami) - - 2. Create the file /etc/udev/rules.d/60-pickit.rules with this - content (from http://kair.us/projects/pickitminus/): - - # PICkit 2 - ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="0033", MODE="0660", GROUP="plugdev" - - # PICkit 3 - ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="900a", MODE="0660", GROUP="plugdev" - - 3. Restart udev (or restart the computer): - - Debian: $ sudo udevadm trigger - Arch: $ sudo udevadm control --reload && sudo udevadm trigger - - 4. If PICkit was already plugged into USB, unplug and replug it. - - Now NuttX can be flashed to the board as follows: - - $ pic32prog nuttx.hex - -Serial console -============== - - Connect USB cable from your PC to connector J1 (labeled "UART") of - the chipKIT Wi-FIRE board. - Then use some serial console client (minicom, picocom, teraterm, etc) - configured to 115200 8n1 without software or hardware flow control. - - Reset the board and you should see NuttX starting in the serial. diff --git a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/chipkit-wifire.jpg b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/chipkit-wifire.jpg new file mode 100644 index 00000000000..17a3954ab30 Binary files /dev/null and b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/chipkit-wifire.jpg differ diff --git a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst index 1609295a6d3..6418cb5ca39 100644 --- a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst +++ b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst @@ -1,8 +1,131 @@ +=============== +chipKIT Wi-FIRE +=============== + +.. tags:: arch:mips, chip:pic32mz + +.. figure:: chipkit-wifire.jpg + :figwidth: 40% + :align: center + :alt: The chipKIT Wi-FIRE development board + + The chipKIT Wi-FIRE development board + +This the documentation page for NuttX support of the `chipKIT Wi-FIRE board +<https://chipkit.net/wiki/index.php?title=ChipKIT_Wi-Fire>`_. + +Features +======== + +* Microchip PIC32MZ2048EFG100 MCU @200MHz +* Microchip MRF24WG0MA Wi-Fi module +* USB 2.0 +* Full-Speed / Hi-Speed OTG controller, +* Micro SD card connector +* 32-bit MIPS M5150 operation +* 2MB flash memory +* 512KB RAM + +Installation +============ + +The following toolchain options have been tested and confirmed to work: + +* ``CONFIG_MIPS32_TOOLCHAIN_PINGUINOL``: Pinquino Toolchain for Linux +* ``CONFIG_MIPS32_TOOLCHAIN_SOURCERY_CODEBENCH_LITE``: Sourcery CodeBench Lite + Toolchain for Linux + +Pinquino Toolchain can be downloaded here: +https://github.com/PinguinoIDE/pinguino-compilers + +Sourcery CodeBench Lite Toolchain for Linux can be downloaded and +installed as follows: + +.. code:: console + + $ wget https://sourcery.mentor.com/GNUToolchain/package12725/public/mips-sde-elf/mips-2014.05-24-mips-sde-elf-i686-pc-linux-gnu.tar.bz2 + $ sudo tar xvjf mips-2014.05-24-mips-sde-elf-i686-pc-linux-gnu.tar.bz2 \ + -C /usr/local + +Flashing +======== + +.. warning:: + + Currently the pre-installed bootloader of the chipKIT Wi-FIRE board is not + supported in this NuttX configuration. Doing the following steps will erase + the factory installed bootloader in the Flash memory! If you are going to + recover the bootloader later on your chipKIT Wi-FIRE board, the original + chipKIT bootloader can be found here: + https://reference.digilentinc.com/_media/chipkit_wifire/chipkit-wifire-v01000303.zip + +Flash memory can be programmed with a PICkit 2 programmer via the 6-pin ICSP +connector JP1 of chipKIT Wi-FIRE board. + +A program is needed to interface to the PICkit 2. One such program is the +pic32prog utility: https://github.com/sergev/pic32prog.git + +It is recommended to configure udev rules so that root privileges are not needed +to use pic32prog; root privileges will only be needed for this one-time setup: + +1. On most Linux distributions, add the user to the plugdev group: + + .. code:: console + + $ sudo useradd -G plugdev $(whoami) + +2. Create the file /etc/udev/rules.d/60-pickit.rules with this content (from + http://kair.us/projects/pickitminus/): + + .. code:: text + + # PICkit 2 + ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="0033", MODE="0660", GROUP="plugdev" + + # PICkit 3 + ATTRS{idVendor}=="04d8", ATTRS{idProduct}=="900a", MODE="0660", GROUP="plugdev" + +3. Restart udev (or restart the computer): + + On Debian: + + .. code:: console + + $ sudo udevadm trigger + + On Arch: + + .. code:: console + + $ sudo udevadm control --reload && sudo udevadm trigger + +4. If PICkit was already plugged into USB, unplug and replug it. Now NuttX can + be flashed to the board as follows: + + .. code:: console + + $ pic32prog nuttx.hex + +Configurations ============== -chipkit-wifire -============== -.. include:: README.txt - :literal: +You can use the following command to configure the NuttX build, where +``<config>`` is one of the configurations listed below: + +.. code:: console + + $ ./tools/configure.sh -l chipkit-wifire:nsh + +nsh +--- + +Basic serial console access to the NSH shell. + +.. note:: + Connect USB cable from your PC to connector J1 (labeled "UART") of + the chipKIT Wi-FIRE board. + Then use some serial console client (minicom, picocom, teraterm, etc) + configured to 115200 8n1 without software or hardware flow control. + Reset the board and you should see NuttX starting in the serial.
