Commit Graph

41 Commits

Author SHA1 Message Date
raiden00pl 55170d2ca2 Documentation: replace m2r2 with myst-parser
sphinx recommends myst-parser for markdown conversion:
https://www.sphinx-doc.org/en/master/usage/markdown.html

m2r2 is not supported for Python versions >= 3.12 so
we can't build Documentation for example on latest Arch Linux

by the way myst-parser detected a bad link to SECURITY.md that is now fixed
2024-08-30 01:14:36 +08:00
raiden00pl b7f94fbf22 Documentation: various cosmetic changes 2023-10-30 20:29:54 +08:00
Filipe Cavalcanti b7288c4db9 Gathering community recommendations
testing badges

Converted legacy readme from .md to .rst

Revert "Converted legacy readme from .md to .rst"

This reverts commit e33fef7a5aaa5dd377f87b90a667a2704b9fb834.
2023-10-28 13:55:56 +08:00
raiden00pl 8f7be6ce27 Documentation: move nxwidgets to applications as it is apps-side lib 2023-10-27 13:21:40 -03:00
raiden00pl d72c6802c1 Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
raiden00pl 88b7ce80a0 Documentation: add missing platforms to platforms/ and remove introduction/platforms 2023-10-22 19:06:44 +08:00
Lee Lup Yuen a59673b526 boards/risc-v: Add support for PINE64 Star64 JH7110 SBC
This PR adds support for PINE64 Star64 64-bit RISC-V SBC, based on StarFive JH7110 SoC. Most of the code is derived from NuttX for QEMU RISC-V (Kernel Mode). [The source files are explained in the articles here](https://github.com/lupyuen/nuttx-star64)

Modified Files:

boards/Kconfig: Added Star64 board

New Files in boards/risc-v/jh7110/star64:

src/jh7110_appinit.c: Startup Code

include/board.h: Star64 Definitions

include/board_memorymap.h: Memory Map

src/etc/init.d/rc.sysinit, rcS: Startup Script

src/.gitignore: Ignore the tmp filesystem

scripts/ld.script: Linker Script

scripts/Make.defs: Star64 Makefile

src/Makefile: Star64 Makefile

Kconfig: Star64 Config

configs/nsh/defconfig: NSH Build Config

Updated Documentation:

introduction/detailed_support.rst: Added StarFive JH7110 SoC and Star64 SBC

platforms/risc-v/jh7110/index.rst: New page for StarFive JH7110 SoC

platforms/risc-v/jh7110/boards/star64/index.rst: Building and booting NuttX for Star64
2023-08-07 01:08:35 -07:00
Lucas Saavedra Vaz c702223fab Documentation: Improve pages for ESP boards 2023-03-25 12:23:35 +02:00
Lee Lup Yuen c2d75c930b arm64/a64: Add drivers for PIO and LEDs
This PR adds the drivers for Allwinner A64 PIO (Programmable I/O) and PinePhone LEDs (Red / Green / Blue).

The PIO Driver is based on the NuttX PIO Driver for Allwinner A10: [`arch/arm/src/a1x/a1x_pio.c`](https://github.com/apache/nuttx/blob/master/arch/arm/src/a1x/a1x_pio.c)

-   `arch/arm64/src/a64/Make.defs`: Add PIO Driver to Makefile

-   `boards/Kconfig`: Add `ARCH_HAVE_LEDS` to PinePhone

-   `boards/arm64/a64/pinephone/src/pinephone.h`: Define PinePhone LEDs

-   `boards/arm64/a64/pinephone/src/pinephone_boardinit.c`: Start Auto LEDs

-   `boards/arm64/a64/pinephone/src/pinephone_bringup.c`: Start User LEDs

-   `boards/arm64/a64/pinephone/src/Makefile`: Add LED Driver to Makefile

-   `boards/arm64/a64/pinephone/configs/nsh/defconfig`: Add `CONFIG_USERLED` to `nsh` config

-   `arch/arm64/src/a64/a64_pio.c`, `a64_pio.h`: Allwinner A64 PIO Driver

-   `arch/arm64/src/a64/hardware/a64_memorymap.h`: PIO Memory Map

-   `arch/arm64/src/a64/hardware/a64_pio.h`: PIO Definitions

-   `boards/arm64/a64/pinephone/include/board.h`: Define PinePhone LEDs

-   `boards/arm64/a64/pinephone/src/pinephone_autoleds.c`: Driver for Auto LEDs

-   `boards/arm64/a64/pinephone/src/pinephone_userleds.c`: Driver for User LEDs

-   `introduction/supported_platforms.rst`: Add Allwinner A64 as Supported Platform

-   `platforms/arm/a64/boards/pinephone/index.rst`: Add PIO and LEDs to PinePhone
2022-12-06 18:14:39 +08:00
Nathan Hartman 03802dad13 NuttX graduated the Incubator; update repository links 2022-11-26 11:58:15 -08:00
Lee Lup Yuen b31054b1e3 arch/arm64: Add support for PINE64 PinePhone
This PR adds support for PINE64 PinePhone and the Allwinner A64 SoC (based on Arm Cortex-A53).

With this PR, PinePhone boots successfully to nsh (via microSD Card) and runs console apps.

-   `arch/arm64/Kconfig`: Added Allwinner A64 SoC

-   `boards/Kconfig`: Added PINE64 PinePhone

-   `arch/arm64/src/a64/Kconfig`: New Kconfig for Allwinner A64 SoC

-   `boards/arm64/a64/pinephone/Kconfig`: New Kconfig for PINE64 PinePhone

-   `src/a64/a64_boot.c`, `a64_boot.h`: Boot functions for Allwinner A64

-   `src/a64/a64_lowputc.S`: Low-level console output

-   `src/a64/a64_serial.c`, `a64_serial.h`: A64 Serial Driver

-   `src/a64/chip.h`: A64 SoC Definitions

-   `include/a64/chip.h`: A64 Memory Map, Generic Interrupt Controller

-   `include/a64/irq.h`: A64 Interrupts

-   `src/a64/Make.defs`: Source files for A64

-   `configs/nsh/defconfig`: Board Configuration for `pinephone:nsh`

-   `src/pinephone_appinit.c`: Init PinePhone

-   `src/pinephone_boardinit.c`: Init PinePhone

-   `src/pinephone_bringup.c`: Start PinePhone Drivers

-   `src/pinephone.h`: PinePhone Declarations

-   `include/board_memorymap.h`: PinePhone Memory Map

-   `scripts/dramboot.ld`: PinePhone Linker Script

-   `scripts/Make.defs`: Source files for PinePhone

-   `src/Makefile`: PinePhone Makefile

-   `platforms/arm/a64/boards/pinephone/index.rst`: Building and booting NuttX on PinePhone

-   `platforms/arm/a64/index.rst`: Overview of Allwinner A64

-   `introduction/supported_platforms.rst`: Added Allwinner A64

-   `introduction/detailed_support.rst`: Added Allwinner A64
2022-11-25 17:19:48 +08:00
Tiago Medicci Serrano 998b726c4b documentation: update esp32[-s2] documentation about I2S/audio support 2022-11-07 13:46:44 +08:00
Tiago Medicci Serrano b16ed003f1 documentation: add documentation for ESP32-S2/S3/C3
Add documentation for ESP32-S2 and ESP32-S2 Saola 1 board
Add links to already existing ESP32-S3 documentation
Add links to already existing ESP32-C3 documentation
2022-10-22 15:18:35 +08:00
Tiago Medicci Serrano fc9b9f70ac xtensa/esp32: add documentation of the I2S/audio support on ESP32 2022-09-30 17:23:17 -03:00
Nathan Hartman b04ae46ea6 boards/arm/tiva: Add tm4c129e-launchpad
* boards/arm/tiva/tm4c129e-launchpad: New subdirectory providing
  board support for the Texas Instruments TM4C Crypto Connected
  LaunchPad, or more correctly the EK-TM4C129EXL.

* Documentation/introduction/detailed_support.rst,
  Documentation/introduction/supported_platforms.rst,
  boards/README.txt: Document the additional board support.

* boards/Kconfig:
  (ARCH_BOARD_TM4C129E_LAUNCHPAD): New config.
  (ARCH_BOARD): Add tm4c129e-launchpad.
  (Board-Specific Options): Source the board-specific Kconfig
   boards/arm/tiva/tm4c129e-launchpad/Kconfig when selected.
2022-09-07 14:15:48 +08:00
Xiang Xiao 1d1bdd85a3 Remove the double blank line from source files
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2022-02-20 20:10:14 +01:00
Nathan Hartman 26f09cec6d Documentation: Fix a few typos.
* Documentation/contributing/documentation.rst
    * Documentation/guides/tasktraceuser.rst
    * Documentation/guides/drivers.rst
    * Documentation/quickstart/running.rst
    * Documentation/quickstart/compiling.rst
    * Documentation/components/drivers/character/watchdog.rst
    * Documentation/components/drivers/character/foc.rst
    * Documentation/components/nxgraphics/nxtk.rst
    * Documentation/applications/nsh/login.rst
    * Documentation/introduction/detailed_support.rst
    * Documentation/introduction/resources.rst
    * Documentation/reference/user/01_task_control.rst
    * Documentation/reference/os/wqueue.rst

      Fix some misspelled words.

      Many of these were caught by codespell.
2021-04-28 17:00:23 -03:00
Byron Ellacott 9d4742af00 Add experimental support for an eZ80 toolchain using llvm and GNU binutils.
An additional fix for the RTC driver to lock the RTC after setting values instead of unlocking it is included.
2021-04-27 21:18:48 -03:00
Nathan Hartman c869bc5348 docs and comments: Update stale references to COPYING
Since 7a046358d9 the top-level COPYING
file has been deleted and replaced by DISCLAIMER, LICENSE, and NOTICE
files. However, some references to the old COPYING file remained in
Kconfig help text and documentation.

Documentation/contributing/coding_style.rst:
Documentation/introduction/about.rst:
boards/arm/lpc17xx_40xx/olimex-lpc1766stk/README.txt:
boards/arm/sam34/arduino-due/README.txt:
boards/arm/sam34/sam4l-xplained/README.txt:
boards/arm/sama5/giant-board/README.md:
boards/arm/sama5/sama5d2-xult/README.txt:
boards/arm/sama5/sama5d4-ek/README.txt:
boards/arm/samd2l2/samd20-xplained/README.txt:
boards/arm/samd2l2/samd21-xplained/README.txt:
boards/arm/samd2l2/saml21-xplained/README.txt:
boards/arm/stm32/hymini-stm32v/README.txt:
boards/arm/stm32/stm3210e-eval/README.txt:
fs/fat/Kconfig:
libs/libc/string/Kconfig:

    * Updates stale references to the old top-level COPYING file to
      either LICENSE or NOTICE (or both), as appropriate in each
      instance.
2021-04-01 21:10:56 -05:00
raiden00pl 8bf3c5efb9 boards/stm32: add initial support for b-g431b-esc1 board 2021-03-20 21:07:20 -03:00
Xiang Xiao c047c1412f Remove all gap8(risc-v) arch and board source code
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-03-11 10:51:11 -08:00
Xiang Xiao c54d617f2c Remove nr5m100(risc-v) arch and board source code
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-03-11 10:51:11 -08:00
Abdelatif Guettouche 452b52a61e boards/xtensa/esp32/common: Fix functions' descriptions.
Signed-off-by: Abdelatif Guettouche <abdelatif.guettouche@espressif.com>
2020-12-10 12:31:17 -06:00
raiden00pl 0c05f2ea38 stm32: add stm32g43x support and nucleo-g431rb board 2020-12-09 09:43:25 -03:00
Michal Lenc 2de4b68389 Docs and README: Add Teensy-4 BSP
Signed-off-by: Michal Lenc <lencmich@fel.cvut.cz>
2020-12-04 10:18:41 -08:00
Matias N ce146e91ef Documentation: remove empty subheading 2020-11-21 18:09:19 -08:00
Matias N c6270b552b Documentation: remove TODO 2020-11-21 18:09:19 -08:00
Matias N aabb30a103 documentation: change non-working URL 2020-10-25 12:25:34 -03:00
Brennan Ashton 23cd1e030e Docs: Fix broken links and references in docs
Also add to the CI a problem matcher to better report issues

Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-10-22 10:22:11 -03:00
Xiang Xiao eb4121ce38 Change all 'Nuttx' to 'NuttX'
Unify the naming convention

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-20 01:45:06 -07:00
Xiang Xiao e53779065e Documentation: Fix the broken link in introduction/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao 652241a411 Documentation: Format introduction/supported_platforms.rst
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao 8a7982bec0 Documentation: Change 32bit arch to 64bit arch
since NuttX support at least 64bit x86 and riscv now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Diego Herranz 77160c7a32 Documentation: replace bitbucket links with github ones
bitbucket.org/nuttx/nuttx/src/ replaced with github.com/apache/incubator-nuttx/blob/
2020-10-18 12:22:54 -04:00
Adam Feuer d32abc164a updated readmes to reflect giant-board support
- also changed most Atmel references to Microchip
  since Microchip has acquired Atmel
2020-09-16 15:56:32 -06:00
Brennan Ashton 4cb193d530 Docs: Update links to old website and wiki
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-08-30 19:16:30 -03:00
Adam Feuer d655f47d13 convert INVIOLABLES.txt to markdown, add to docs 2020-08-25 16:03:42 -07:00
Matias N 896ba15f01 support specifying top alignment for tables 2020-08-24 10:29:55 -07:00
Adam Feuer 8e56cf8d92 added hyperlinks to supported platforms page
- and fixed formatting in detailed support to
  enable hyperlinks to section headers

Squashed commit of the following:

commit 59e31d2ac13255f35f21d49c407494af23f16f6e
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 19:01:58 2020 -0700

    removed formatting |br|s, will use css

    - to line up columns

commit bcee59a14180bad6823e82990be52bc626e85911
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 18:55:57 2020 -0700

    remove migration not complete message

commit bc23b19ef65bdc13f3df04aae1693c61aa4abe04
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 18:16:07 2020 -0700

    table formatting adjustments

commit c6fdc907825a31218d2bdcbe1c1079e197779f02
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 16:03:07 2020 -0700

    fixing table formatting

commit c84d5e41a553e7a108b23d610e71f41ff6f5b751
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 15:35:16 2020 -0700

    trying to fix table formatting

commit 0d036dd2f309ad93f31a43c7f668befb6032c458
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 15:28:02 2020 -0700

    hyperlinks for supported boards for TI

commit e30840123f6ec2e7edb8335a165f9527919fefcc
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 15:13:40 2020 -0700

    links for supported boards by manufacturer - STM32

commit 7b5faf61901fc0fc3b945dbda4697a2d3f266126
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 14:13:18 2020 -0700

    supported boards by manufacturer hyperlinks nxp

    - nxp/freescale

commit 34c5c9b15908ffea7f8467c709fd0a5379e950ae
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sun Aug 16 13:52:18 2020 -0700

    hyperlinks for supported boards by manufacturer

    - up to atmel

commit 351718d5edbb7b736067cfcb74270992fcc55102
Author: Adam Feuer <adam@adamfeuer.com>
Date:   Sat Aug 15 20:57:38 2020 -0700

    add hyperlinks for supported platforms by cpu core
2020-08-24 10:29:55 -07:00
Matias N 4a38a15332 convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-24 10:29:55 -07:00
Matias N 4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00