From f6ecf80ebb34f0351bb16e10b46300af8f330761 Mon Sep 17 00:00:00 2001 From: Vinicius May Date: Wed, 30 Sep 2026 17:55:03 +0200 Subject: [PATCH] Documentation: brand new layout for NuttX documentation. The documentation grew one page at a time, so the tree follows the history of who wrote what and not the shape of NuttX. Scheduling is spread over three places, a driver page can sit above the subsystem that owns it, and the front page lists everything at the same level. That is a lot to face when all you want to know is where the scheduler lives. This change files every page under the code it describes. It is a move, not a rewrite: outside the ten pages named below, every page keeps the text that is already in master, and no page's text is deleted. What it does: * Groups the table of contents into nine chapters. * Moves the OS subsystems under os/: scheduling, memory, drivers, filesystem, networking, IPC, interrupts, libs, time. * Renames the platform pages to the names the source tree uses, and derives their tags from the tree instead of by hand. * Splits guides/ by subject. * Adds Documentation/redirects.py, with a rule for every page that left its old path, so old URLs keep working. The redirect page also carries a link's #anchor across to the new page. Ten pages have text that is new or rewritten. Nine of them are the landing page of a chapter, which has to exist for the new structure: index the front page os/index OS Design os/scheduling/index Scheduling os/interrupts/index Interrupts os/ipc/index IPC os/time/index Time and timers about/index About developing/index Developing NuttX ReleaseNotes/index Release notes The tenth is os/libs/libbuiltin, the only page here with technical content: libs/libbuiltin/ had no page at all. Five SVG diagrams come with these pages, hand-written XML with no editor metadata. Nothing outside Documentation/ is touched. How it was checked: * Sphinx builds with -W: no warnings, and no document left outside a toctree. * A script, offered in the PR, proves the narrow claim this rests on. For every page outside the ten named above it erases what a move touches -- link target, path, tag line, toctree block, table border -- from the whole old text and the whole new text, and requires the two to be byte for byte identical. It also requires every sentence of a deleted page to turn up somewhere, and every page that left its old path to have a redirect, from a URL that existed, to where its content went. It exits non-zero and names the page if any of that is not true, and it tests added pages too, so forgetting to declare one cannot make it pass. * An independent audit checked 133 factual claims on these ten pages against the tree, one shell command per claim: 130 confirmed, 1 refuted and fixed here, 2 not checkable. * tools/checkpatch.sh is clean over the range. The diff is large because moving a page changes every link that points to it. Most of it is pure renames, and board pages that gained one tag line. Assisted-by: Claude:claude-opus-5 --- Documentation/Pipfile | 1 + Documentation/Pipfile.lock | 11 +- .../{NuttX-0.1.0 => NuttX-0.1.0.md} | 2 +- .../{NuttX-0.1.1 => NuttX-0.1.1.md} | 2 +- .../{NuttX-0.1.2 => NuttX-0.1.2.md} | 2 +- .../{NuttX-0.2.1 => NuttX-0.2.1.md} | 2 +- .../{NuttX-0.2.2 => NuttX-0.2.2.md} | 2 +- .../{NuttX-0.2.3 => NuttX-0.2.3.md} | 2 +- .../{NuttX-0.2.4 => NuttX-0.2.4.md} | 2 +- .../{NuttX-0.2.5 => NuttX-0.2.5.md} | 2 +- .../{NuttX-0.2.6 => NuttX-0.2.6.md} | 2 +- .../{NuttX-0.2.7 => NuttX-0.2.7.md} | 2 +- .../{NuttX-0.2.8 => NuttX-0.2.8.md} | 2 +- .../{NuttX-0.2.9 => NuttX-0.2.9.md} | 4 +- .../{NuttX-0.3.0 => NuttX-0.3.0.md} | 2 +- .../{NuttX-0.3.1 => NuttX-0.3.1.md} | 2 +- .../{NuttX-0.3.10 => NuttX-0.3.10.md} | 2 +- .../{NuttX-0.3.11 => NuttX-0.3.11.md} | 2 +- .../{NuttX-0.3.12 => NuttX-0.3.12.md} | 2 +- .../{NuttX-0.3.13 => NuttX-0.3.13.md} | 2 +- .../{NuttX-0.3.14 => NuttX-0.3.14.md} | 2 +- .../{NuttX-0.3.15 => NuttX-0.3.15.md} | 2 +- .../{NuttX-0.3.16 => NuttX-0.3.16.md} | 4 +- .../{NuttX-0.3.17 => NuttX-0.3.17.md} | 2 +- .../{NuttX-0.3.18 => NuttX-0.3.18.md} | 2 +- .../{NuttX-0.3.19 => NuttX-0.3.19.md} | 2 +- .../{NuttX-0.3.2 => NuttX-0.3.2.md} | 2 +- .../{NuttX-0.3.3 => NuttX-0.3.3.md} | 2 +- .../{NuttX-0.3.4 => NuttX-0.3.4.md} | 2 +- .../{NuttX-0.3.5 => NuttX-0.3.5.md} | 2 +- .../{NuttX-0.3.6 => NuttX-0.3.6.md} | 2 +- .../{NuttX-0.3.7 => NuttX-0.3.7.md} | 2 +- .../{NuttX-0.3.8 => NuttX-0.3.8.md} | 2 +- .../{NuttX-0.3.9 => NuttX-0.3.9.md} | 2 +- .../{NuttX-0.4.0 => NuttX-0.4.0.md} | 2 +- .../{NuttX-0.4.1 => NuttX-0.4.1.md} | 2 +- .../{NuttX-0.4.10 => NuttX-0.4.10.md} | 2 +- .../{NuttX-0.4.11 => NuttX-0.4.11.md} | 2 +- .../{NuttX-0.4.12 => NuttX-0.4.12.md} | 2 +- .../{NuttX-0.4.13 => NuttX-0.4.13.md} | 2 +- .../{NuttX-0.4.2 => NuttX-0.4.2.md} | 2 +- .../{NuttX-0.4.3 => NuttX-0.4.3.md} | 2 +- .../{NuttX-0.4.4 => NuttX-0.4.4.md} | 2 +- .../{NuttX-0.4.5 => NuttX-0.4.5.md} | 2 +- .../{NuttX-0.4.6 => NuttX-0.4.6.md} | 2 +- .../{NuttX-0.4.7 => NuttX-0.4.7.md} | 2 +- .../{NuttX-0.4.8 => NuttX-0.4.8.md} | 2 +- .../{NuttX-0.4.9 => NuttX-0.4.9.md} | 2 +- .../{NuttX-10.0.0 => NuttX-10.0.0.md} | 2 +- .../{NuttX-10.1.0 => NuttX-10.1.0.md} | 158 ++--- .../{NuttX-10.2.0 => NuttX-10.2.0.md} | 168 ++--- .../{NuttX-10.3.0 => NuttX-10.3.0.md} | 126 ++-- .../{NuttX-11.0.0 => NuttX-11.0.0.md} | 36 +- .../{NuttX-12.0.0 => NuttX-12.0.0.md} | 42 +- .../{NuttX-12.1.0 => NuttX-12.1.0.md} | 2 +- .../{NuttX-12.10.0 => NuttX-12.10.0.md} | 2 +- .../{NuttX-12.11.0 => NuttX-12.11.0.md} | 2 +- .../{NuttX-12.12.0 => NuttX-12.12.0.md} | 2 +- .../{NuttX-12.13.0 => NuttX-12.13.0.md} | 2 +- .../{NuttX-12.2.0 => NuttX-12.2.0.md} | 2 +- .../{NuttX-12.2.1 => NuttX-12.2.1.md} | 2 +- .../{NuttX-12.3.0 => NuttX-12.3.0.md} | 2 +- .../{NuttX-12.4.0 => NuttX-12.4.0.md} | 2 +- .../{NuttX-12.5.0 => NuttX-12.5.0.md} | 2 +- .../{NuttX-12.5.1 => NuttX-12.5.1.md} | 2 +- .../{NuttX-12.6.0 => NuttX-12.6.0.md} | 2 +- .../{NuttX-12.7.0 => NuttX-12.7.0.md} | 2 +- .../{NuttX-12.8.0 => NuttX-12.8.0.md} | 2 +- .../{NuttX-12.9.0 => NuttX-12.9.0.md} | 2 +- .../{NuttX-13.0.0 => NuttX-13.0.0.md} | 2 +- .../{NuttX-13.0.1 => NuttX-13.0.1.md} | 2 +- .../{NuttX-4.14 => NuttX-4.14.md} | 2 +- .../ReleaseNotes/{NuttX-5.0 => NuttX-5.0.md} | 2 +- .../ReleaseNotes/{NuttX-5.1 => NuttX-5.1.md} | 2 +- .../{NuttX-5.10 => NuttX-5.10.md} | 2 +- .../{NuttX-5.11 => NuttX-5.11.md} | 2 +- .../{NuttX-5.12 => NuttX-5.12.md} | 2 +- .../{NuttX-5.13 => NuttX-5.13.md} | 2 +- .../{NuttX-5.14 => NuttX-5.14.md} | 2 +- .../{NuttX-5.15 => NuttX-5.15.md} | 2 +- .../{NuttX-5.16 => NuttX-5.16.md} | 2 +- .../{NuttX-5.17 => NuttX-5.17.md} | 2 +- .../{NuttX-5.18 => NuttX-5.18.md} | 2 +- .../{NuttX-5.19 => NuttX-5.19.md} | 2 +- .../ReleaseNotes/{NuttX-5.2 => NuttX-5.2.md} | 2 +- .../ReleaseNotes/{NuttX-5.3 => NuttX-5.3.md} | 2 +- .../ReleaseNotes/{NuttX-5.4 => NuttX-5.4.md} | 2 +- .../ReleaseNotes/{NuttX-5.5 => NuttX-5.5.md} | 2 +- .../ReleaseNotes/{NuttX-5.6 => NuttX-5.6.md} | 2 +- .../ReleaseNotes/{NuttX-5.7 => NuttX-5.7.md} | 2 +- .../ReleaseNotes/{NuttX-5.8 => NuttX-5.8.md} | 2 +- .../ReleaseNotes/{NuttX-5.9 => NuttX-5.9.md} | 2 +- .../ReleaseNotes/{NuttX-6.0 => NuttX-6.0.md} | 2 +- .../ReleaseNotes/{NuttX-6.1 => NuttX-6.1.md} | 2 +- .../{NuttX-6.10 => NuttX-6.10.md} | 2 +- .../{NuttX-6.11 => NuttX-6.11.md} | 2 +- .../{NuttX-6.12 => NuttX-6.12.md} | 2 +- .../{NuttX-6.13 => NuttX-6.13.md} | 2 +- .../{NuttX-6.14 => NuttX-6.14.md} | 2 +- .../{NuttX-6.15 => NuttX-6.15.md} | 2 +- .../{NuttX-6.16 => NuttX-6.16.md} | 2 +- .../{NuttX-6.17 => NuttX-6.17.md} | 2 +- .../{NuttX-6.18 => NuttX-6.18.md} | 2 +- .../{NuttX-6.19 => NuttX-6.19.md} | 2 +- .../ReleaseNotes/{NuttX-6.2 => NuttX-6.2.md} | 2 +- .../{NuttX-6.20 => NuttX-6.20.md} | 2 +- .../{NuttX-6.21 => NuttX-6.21.md} | 2 +- .../{NuttX-6.22 => NuttX-6.22.md} | 2 +- .../{NuttX-6.23 => NuttX-6.23.md} | 2 +- .../{NuttX-6.24 => NuttX-6.24.md} | 2 +- .../{NuttX-6.25 => NuttX-6.25.md} | 2 +- .../{NuttX-6.26 => NuttX-6.26.md} | 2 +- .../{NuttX-6.27 => NuttX-6.27.md} | 2 +- .../{NuttX-6.28 => NuttX-6.28.md} | 2 +- .../{NuttX-6.29 => NuttX-6.29.md} | 2 +- .../ReleaseNotes/{NuttX-6.3 => NuttX-6.3.md} | 2 +- .../{NuttX-6.30 => NuttX-6.30.md} | 2 +- .../{NuttX-6.31 => NuttX-6.31.md} | 2 +- .../{NuttX-6.32 => NuttX-6.32.md} | 2 +- .../ReleaseNotes/{NuttX-6.4 => NuttX-6.4.md} | 2 +- .../ReleaseNotes/{NuttX-6.5 => NuttX-6.5.md} | 2 +- .../ReleaseNotes/{NuttX-6.6 => NuttX-6.6.md} | 2 +- .../ReleaseNotes/{NuttX-6.7 => NuttX-6.7.md} | 2 +- .../ReleaseNotes/{NuttX-6.8 => NuttX-6.8.md} | 2 +- .../ReleaseNotes/{NuttX-6.9 => NuttX-6.9.md} | 2 +- .../ReleaseNotes/{NuttX-7.1 => NuttX-7.1.md} | 2 +- .../{NuttX-7.10 => NuttX-7.10.md} | 2 +- .../{NuttX-7.11 => NuttX-7.11.md} | 2 +- .../{NuttX-7.12 => NuttX-7.12.md} | 2 +- .../{NuttX-7.13 => NuttX-7.13.md} | 2 +- .../{NuttX-7.14 => NuttX-7.14.md} | 2 +- .../{NuttX-7.15 => NuttX-7.15.md} | 2 +- .../{NuttX-7.16 => NuttX-7.16.md} | 2 +- .../{NuttX-7.17 => NuttX-7.17.md} | 2 +- .../{NuttX-7.18 => NuttX-7.18.md} | 6 +- .../{NuttX-7.19 => NuttX-7.19.md} | 2 +- .../ReleaseNotes/{NuttX-7.2 => NuttX-7.2.md} | 2 +- .../{NuttX-7.20 => NuttX-7.20.md} | 2 +- .../{NuttX-7.21 => NuttX-7.21.md} | 4 +- .../{NuttX-7.22 => NuttX-7.22.md} | 2 +- .../{NuttX-7.23 => NuttX-7.23.md} | 2 +- .../{NuttX-7.24 => NuttX-7.24.md} | 2 +- .../{NuttX-7.25 => NuttX-7.25.md} | 2 +- .../{NuttX-7.26 => NuttX-7.26.md} | 2 +- .../{NuttX-7.27 => NuttX-7.27.md} | 2 +- .../{NuttX-7.28 => NuttX-7.28.md} | 2 +- .../{NuttX-7.29 => NuttX-7.29.md} | 2 +- .../ReleaseNotes/{NuttX-7.3 => NuttX-7.3.md} | 2 +- .../{NuttX-7.30 => NuttX-7.30.md} | 2 +- .../{NuttX-7.31 => NuttX-7.31.md} | 2 +- .../ReleaseNotes/{NuttX-7.4 => NuttX-7.4.md} | 2 +- .../ReleaseNotes/{NuttX-7.5 => NuttX-7.5.md} | 2 +- .../ReleaseNotes/{NuttX-7.6 => NuttX-7.6.md} | 2 +- .../ReleaseNotes/{NuttX-7.7 => NuttX-7.7.md} | 2 +- .../ReleaseNotes/{NuttX-7.8 => NuttX-7.8.md} | 2 +- .../ReleaseNotes/{NuttX-7.9 => NuttX-7.9.md} | 2 +- .../ReleaseNotes/{NuttX-8.1 => NuttX-8.1.md} | 2 +- .../ReleaseNotes/{NuttX-8.2 => NuttX-8.2.md} | 2 +- .../{NuttX-9.0.0 => NuttX-9.0.0.md} | 2 +- .../{NuttX-9.1.0 => NuttX-9.1.0.md} | 4 +- Documentation/ReleaseNotes/index.rst | 188 ++++++ Documentation/_extensions/tags_overview.py | 369 +++++++++++ Documentation/_static/custom.css | 267 ++++++++ Documentation/_templates/layout.html | 38 +- Documentation/_templates/redirect.html | 5 + Documentation/about/index.rst | 16 + .../examples/baromonitor/index.rst | 2 +- .../applications/examples/fb/index.rst | 2 +- .../applications/examples/nxflatxip/index.rst | 4 +- .../applications/games/cgol/index.rst | 2 +- .../applications/mlearning/index.rst | 2 +- .../applications/netutils/rexecd/index.rst | 2 +- .../applications/system/critmon/index.rst | 2 +- .../applications/system/ptpd/index.rst | 2 +- .../applications/system/syslogd/index.rst | 4 +- .../applications/system/xipfs/index.rst | 2 +- .../testing/cxx-oot-build/index.rst | 2 +- .../applications/testing/unity/index.rst | 2 +- .../applications/testing/xipfs/index.rst | 2 +- Documentation/applications/tools/index.rst | 2 +- .../drivers/character/leds/index.rst | 10 - Documentation/components/index.rst | 28 +- .../components/tools/mksyscall-cvsparser.rst | 2 +- Documentation/conf.py | 43 +- .../doc_templates/board-tags-example.txt | 1 + Documentation/debugging/tasktraceinternal.rst | 4 +- Documentation/developing/index.rst | 21 + ...uilding_nuttx_with_app_out_of_src_tree.rst | 4 +- .../guides/{ => build}/building_uclibcpp.rst | 0 .../guides/{ => build}/cpp_cmake.rst | 0 .../{ => build}/custom_app_directories.rst | 0 .../guides/{ => build}/customapps.rst | 0 .../guides/{ => build}/integrate_newlib.rst | 0 .../guides/{ => build}/nix_flake.rst | 0 .../{ => build}/platform_directories.rst | 2 +- .../armv7m_runtimestackcheck.rst | 0 .../changing_systemclockconfig.rst | 2 +- .../port_drivers_to_stm32f7.rst | 0 .../{ => chip-specific}/semihosting.rst | 0 .../smaller_vector_tables.rst | 0 .../{ => chip-specific}/stm32_ports.rst | 0 .../guides/{ => chip-specific}/stm32ccm.rst | 0 .../{ => chip-specific}/stm32nullpointer.rst | 0 .../fork_vfork_migration.rst | 0 .../kernel_threads_with_custom_stacks.rst | 0 .../{ => concurrency}/nestedinterrupts.rst | 0 .../signal_events_interrupt_handlers.rst | 4 +- .../signaling_sem_priority_inheritance.rst | 0 .../thread_local_storage.rst | 0 .../{ => concurrency}/usingkernelthreads.rst | 0 .../versioning_and_task_names.rst | 0 .../zerolatencyinterrupts.rst | 0 .../guides/{ => drivers}/devicetree.rst | 0 .../guides/{ => drivers}/drivers.rst | 0 .../{ => drivers}/logging_rambuffer.rst | 0 Documentation/guides/{ => drivers}/lwl.rst | 0 .../guides/{ => drivers}/ofloader.rst | 0 .../guides/{ => drivers}/reading_can_msgs.rst | 0 Documentation/guides/{ => drivers}/rndis.rst | 0 .../guides/{ => drivers}/usbtrace.rst | 0 .../guides/{ => filesystem}/automounter.rst | 0 .../guides/{ => filesystem}/etcromfs.rst | 0 .../guides/{ => filesystem}/ram_rom_disks.rst | 0 Documentation/guides/index.rst | 166 +++-- .../guides/{ => languages}/pysimcoder.rst | 6 +- Documentation/guides/{ => languages}/rust.rst | 0 .../guides/{ => networking}/ipv6.rst | 0 Documentation/guides/{ => networking}/nfs.rst | 0 .../nsh_network_link_management.rst | 0 .../guides/{ => networking}/testingtcpip.rst | 0 .../{ => nsh}/multiple_nsh_sessions.rst | 0 .../{ => nsh}/remove_device_drivers_nsh.rst | 2 +- .../case-studies}/bcm2711-rpi4b.rst | 0 .../case-studies}/port_arm_cm4.rst | 4 +- .../guides/{ => porting}/customboards.rst | 2 +- .../{ => porting}/include_files_board_h.rst | 0 Documentation/guides/{ => porting}/port.rst | 56 +- .../{ => porting}/port_bootsequence.rst | 2 +- .../port_relatedkernelconfigrations.rst | 0 .../specialstuff_in_nuttxheaderfiles.rst | 0 .../{ => programs}/fully_linked_elf.rst | 4 +- .../{ => programs}/partially_linked_elf.rst | 4 +- .../guides/{ => programs}/protected_build.rst | 0 .../updating_release_system_elf.rst | 0 .../guides/{ => security}/fortify.rst | 0 Documentation/guides/{ => security}/optee.rst | 0 .../guides/{ => simulation}/qemu_tips.rst | 0 .../guides/{ => simulation}/renode.rst | 0 .../guides/{ => simulation}/simulator.rst | 0 Documentation/implementation/index.rst | 35 +- .../implementation/make_build_system.rst | 2 +- Documentation/index.rst | 151 ++++- Documentation/introduction/about.rst | 14 +- Documentation/introduction/index.rst | 2 + .../{reference => }/os/app_vs_os.rst | 0 .../os/arch.rst => os/arch/arch_api.rst} | 0 .../os/board.rst => os/arch/board_api.rst} | 0 .../{components => os}/arch/index.rst | 8 +- .../{components => os}/audio/index.rst | 2 +- .../binfmt.rst => os/binfmt/index.rst} | 6 + .../kernel_modules_vs_shared_libraries.rst | 0 .../{components => os/binfmt}/nxflat.rst | 4 +- Documentation/os/build_modes.rst | 208 +++++++ Documentation/os/build_modes.svg | 88 +++ .../{components => os}/concurrency/index.rst | 2 +- .../concurrency/seqcount/index.rst | 0 .../{reference => }/os/conventions.rst | 0 Documentation/{components => os}/crypto.rst | 0 .../drivers/block/index.rst | 0 .../drivers/block/ramdisk.rst | 0 .../drivers/character/1wire.rst | 0 .../drivers/character/aie.rst | 0 .../character/analog/adc/adc1242/index.rst | 0 .../character/analog/adc/ads1115/index.rst | 0 .../character/analog/adc/ads7828/index.rst | 0 .../character/analog/adc/hx711/index.rst | 0 .../drivers/character/analog/adc/index.rst | 0 .../character/analog/adc/ltc1867l/index.rst | 0 .../character/analog/adc/max1161x/index.rst | 0 .../character/analog/adc/mcp3008/index.rst | 0 .../character/analog/adc/pga11x/index.rst | 0 .../character/analog/dac/dac7554/index.rst | 0 .../character/analog/dac/dac7571/index.rst | 0 .../drivers/character/analog/dac/index.rst | 0 .../character/analog/dac/mcp47x6/index.rst | 0 .../character/analog/dac/mcp48xx/index.rst | 0 .../character/analog/dac/stm32h7/index.rst | 4 +- .../drivers/character/analog/index.rst | 0 .../drivers/character/analog/pot/index.rst | 0 .../drivers/character/bch.rst | 0 .../drivers/character/can.rst | 2 +- .../drivers/character/contactless.rst | 0 .../drivers/character/crypto/index.rst | 0 .../drivers/character/crypto/se05x.rst | 0 .../drivers/character/eeprom.rst | 0 .../drivers/character/efuse.rst | 0 .../drivers/character/gpio.rst | 2 +- .../drivers/character/i2s.rst | 0 .../drivers/character/index.rst | 0 .../character/input/images/keypad-example.png | 0 .../drivers/character/input/images/mpr121.png | Bin .../drivers/character/input/index.rst | 0 .../character/input/keypad-keyboard.rst | 0 .../drivers/character/input/keypad.rst | 0 .../drivers/character/input/mpr121.rst | 0 .../drivers/character/input/sbutton.rst | 0 .../drivers/character/input/st7123.rst | 0 .../drivers/character/ipcc.rst | 0 .../drivers/character/leds/index.rst} | 7 + .../drivers/character/leds/ktd2052.rst | 0 .../drivers/character/leds/userled.rst | 0 .../drivers/character/leds/ws2812.rst | 0 .../drivers/character/loop.rst | 0 .../drivers/character/math.rst | 0 .../drivers/character/modem.rst | 0 .../drivers/character/motor/foc.rst | 0 .../drivers/character/motor/index.rst | 0 .../drivers/character/note.rst | 0 .../drivers/character/nullzero.rst | 0 .../drivers/character/quadrature.rst | 0 .../drivers/character/rc.rst | 0 .../drivers/character/rf.rst | 0 .../drivers/character/serial.rst | 0 .../drivers/character/timers/capture.rst | 0 .../drivers/character/timers/dshot.rst | 0 .../drivers/character/timers/index.rst | 0 .../drivers/character/timers/oneshot.rst | 0 .../drivers/character/timers/pulsecount.rst | 0 .../drivers/character/timers/pwm.rst | 0 .../drivers/character/timers/rtc.rst | 0 .../drivers/character/timers/timer.rst | 0 .../drivers/character/timers/timer.svg | 0 .../drivers/character/timers/watchdog.rst | 0 .../drivers/character/touchscreen.rst | 0 .../drivers/character/wireless/index.rst | 0 .../character/wireless/lpwan/SX1262.jpg | Bin .../character/wireless/lpwan/command_run0.jpg | Bin .../character/wireless/lpwan/index.rst | 0 .../character/wireless/lpwan/lora_gw.rst | 0 .../character/wireless/lpwan/sx126x.rst | 0 .../character/wireless/lpwan/sx127x.rst | 0 .../wireless/wireless_ioctl_white.drawio.png | Bin .../drivers}/device_drivers.rst | 0 .../drivers}/device_nodes.rst | 0 .../drivers}/drivers_design.rst | 0 .../{components => os}/drivers/index.rst | 130 ++-- .../{implementation => os/drivers}/ioctl.rst | 0 .../drivers/special/audio.rst | 0 .../drivers/special/clk.rst | 0 .../drivers/special/devfreq.rst | 0 .../drivers/special/devicetree.rst | 0 .../drivers/special/devmem.rst | 0 .../drivers/special/dma.rst | 0 .../drivers/special/framebuffer.rst | 0 .../drivers/special/i2c.rst | 0 .../drivers/special/i3c.rst | 0 .../drivers/special/image/syslog-overview.png | Bin .../drivers/special/index.rst | 1 + .../drivers/special/ioexpander.rst | 0 .../drivers/special/lcd.rst | 0 .../drivers/special/mmcsd.rst | 0 .../drivers/special/mtd/devices/at24xx.rst | 0 .../drivers/special/mtd/devices/at25.rst | 0 .../drivers/special/mtd/devices/at25ee.rst | 0 .../drivers/special/mtd/devices/at45db.rst | 0 .../drivers/special/mtd/devices/gd25.rst | 0 .../drivers/special/mtd/devices/gd55.rst | 0 .../drivers/special/mtd/devices/gd5f.rst | 0 .../drivers/special/mtd/devices/is25xp.rst | 0 .../drivers/special/mtd/devices/m25px.rst | 0 .../drivers/special/mtd/devices/mx25l.rst | 0 .../drivers/special/mtd/devices/mx25r.rst | 0 .../drivers/special/mtd/devices/mx35.rst | 0 .../drivers/special/mtd/devices/n25q.rst | 0 .../drivers/special/mtd/devices/s25fl1.rst | 0 .../drivers/special/mtd/devices/sst25.rst | 0 .../drivers/special/mtd/devices/sst26.rst | 0 .../drivers/special/mtd/devices/sst39vf.rst | 0 .../drivers/special/mtd/devices/w25n.rst | 0 .../drivers/special/mtd/devices/w25q.rst | 0 .../drivers/special/mtd/index.rst | 0 .../drivers/special/mtd/mtd_open_flow.png | Bin .../drivers/special/net/ethernet.rst | 0 .../drivers/special/net/index.rst | 0 .../drivers/special/net/vlan.rst | 0 .../drivers/special/pci/index.rst | 0 .../drivers/special/pinctrl.rst | 0 .../drivers/special/pipes.rst | 0 .../special/power/battery/fakegauge.rst | 0 .../drivers/special/power/index.rst | 5 + .../drivers/special/power/pm/index.rst | 0 .../drivers/special/power/pm/pm.png | Bin .../special/power}/power_management.rst | 0 .../drivers/special/power/regulator.rst | 0 .../drivers/special/ptp.rst | 0 .../drivers/special/regmap.rst | 0 .../drivers/special/reset.rst | 0 .../drivers/special/rpmsg/concepts.rst | 0 .../drivers/special/rpmsg/index.rst | 0 .../drivers/special/rpmsg/rpmsg_dump.rst | 0 .../drivers/special/rpmsg/rpmsg_ping.rst | 0 .../drivers/special/rpmsg/rpmsg_port.rst | 0 .../drivers/special/rpmsg/rpmsg_port_uart.rst | 0 .../drivers/special/rptun/api_reference.rst | 0 .../drivers/special/rptun/architecture.rst | 0 .../drivers/special/rptun/driver_porting.rst | 0 .../drivers/special/rptun/index.rst | 0 .../drivers/special/rptun/resource_table.rst | 0 .../drivers/special/rwbuffer.rst | 0 .../drivers/special/sdio.rst | 0 .../drivers/special/segger.rst | 0 .../drivers/special/sensors.rst | 0 .../drivers/special/sensors/adt7320.rst | 0 .../drivers/special/sensors/adxl345.rst | 0 .../drivers/special/sensors/adxl362.rst | 0 .../drivers/special/sensors/adxl367.rst | 0 .../drivers/special/sensors/adxl372.rst | 0 .../drivers/special/sensors/aht10.rst | 0 .../drivers/special/sensors/ak09912.rst | 0 .../special/sensors/gnss_lowerhalf.rst | 4 +- .../drivers/special/sensors/l86xxx.rst | 4 +- .../drivers/special/sensors/lis2mdl.rst | 2 +- .../drivers/special/sensors/lsm330.rst | 0 .../drivers/special/sensors/lsm6ds3trc.rst | 2 +- .../drivers/special/sensors/lsm6dso32.rst | 2 +- .../drivers/special/sensors/mcp9600.rst | 2 +- .../drivers/special/sensors/mpl115a.rst | 0 .../drivers/special/sensors/mpu6050.rst | 2 +- .../drivers/special/sensors/nau7802.rst | 2 +- .../drivers/special/sensors/qmi8658.rst | 2 +- .../special/sensors/sensor_driver_model.png | Bin .../special/sensors/sensor_monitor.rst | 0 .../special/sensors/sensors_cluster.rst | 0 .../special/sensors/sensors_legacy.rst | 0 .../drivers/special/sensors/sensors_uorb.rst | 2 +- .../drivers/special/sensors/sht4x.rst | 2 +- .../drivers/special/sensors/tc74.rst | 2 +- .../drivers/special/sensors/tmp112.rst | 2 +- .../drivers/special/spi.rst | 0 .../drivers/special/syslog.rst | 2 +- .../drivers/special/syslog_design.rst} | 11 - .../drivers/special/sysview.png | Bin .../drivers/special/usbdev.rst | 0 .../drivers/special/usbhost.rst | 0 .../drivers/special/usbmisc.rst | 0 .../drivers/special/usbmonitor.rst | 0 ...monitor_wireshark_linux_example_adb.pcapng | Bin ...usbmonitor_wireshark_linux_example_adb.png | Bin .../drivers/special/usrsock.rst | 0 .../drivers/special/uvc.rst | 0 .../drivers/special/vhost/framework.rst | 0 .../drivers/special/vhost/index.rst | 0 .../drivers/special/video.rst | 0 .../drivers/special/virtio/framework.rst | 0 .../drivers/special/virtio/index.rst | 0 .../drivers/special/wireless.rst | 0 .../drivers/special/wireless/rn2xx3.rst | 0 .../drivers/thermal/index.rst | 0 .../{implementation => os/drivers}/usb.rst | 0 .../{components => os}/filesystem/aio.rst | 0 .../{components => os}/filesystem/binfs.rst | 0 .../filesystem}/chroot.rst | 0 .../{components => os}/filesystem/cromfs.rst | 0 .../{components => os}/filesystem/fat.rst | 0 .../filesystem}/file_descriptors.rst | 0 .../filesystem}/file_permission.rst | 4 +- .../{components => os}/filesystem/hostfs.rst | 0 .../filesystem/how_nxffs_works.rst | 0 .../{components => os}/filesystem/index.rst | 37 +- .../{components => os}/filesystem/inotify.rst | 0 .../filesystem/littlefs.rst | 0 .../{components => os}/filesystem/mmap.rst | 0 .../{components => os}/filesystem/mnemofs.rst | 0 .../{components => os}/filesystem/nfs.rst | 0 .../{components => os}/filesystem/nuttxfs.rst | 0 .../filesystem/nuttxfs/nuttxfs_page_0.png | Bin .../filesystem/nuttxfs/nuttxfs_page_1.png | Bin .../filesystem/nuttxfs/nuttxfs_page_2.png | Bin .../filesystem/nuttxfs/nuttxfs_page_3.png | Bin .../{components => os}/filesystem/nxffs.rst | 0 .../filesystem/nxffs/nxffs_page_0.png | Bin .../filesystem/nxffs/nxffs_page_1.png | Bin .../filesystem/nxffs/nxffs_page_2.png | Bin .../{components => os}/filesystem/nxflat.rst | 4 +- .../filesystem/nxflat/nxflat-addressing.png | Bin .../filesystem/partition.rst | 0 .../{components => os}/filesystem/procfs.rst | 0 .../filesystem/profiler.rst | 0 .../filesystem/pseudofs.rst | 0 .../{components => os}/filesystem/romfs.rst | 0 .../{components => os}/filesystem/rpmsgfs.rst | 0 .../{components => os}/filesystem/shmfs.rst | 0 .../{components => os}/filesystem/smartfs.rst | 0 .../filesystem/special_files_dev_num.rst | 0 .../{components => os}/filesystem/spiffs.rst | 0 .../{components => os}/filesystem/tmpfs.rst | 0 .../{components => os}/filesystem/unionfs.rst | 0 .../{components => os}/filesystem/userfs.rst | 0 .../{components => os}/filesystem/v9fs.rst | 0 .../{components => os}/filesystem/xipfs.rst | 0 .../{components => os}/filesystem/zipfs.rst | 0 .../graphics}/GraphicsInterfaces.png | Bin .../graphics}/NXOrganization.png | Bin .../graphics}/NuttXScreenShot.jpg | Bin .../nxgraphics => os/graphics}/appendix.rst | 0 .../graphics}/framebuffer_char_driver.rst | 2 +- .../nxgraphics => os/graphics}/index.rst | 0 .../nxgraphics => os/graphics}/nx.rst | 0 .../nxgraphics => os/graphics}/nxcursor.rst | 0 .../nxgraphics => os/graphics}/nxfonts.rst | 0 .../nxgraphics => os/graphics}/nxgl.rst | 0 .../nxgraphics => os/graphics}/nxtk.rst | 0 .../graphics}/nxwm_threading.rst | 0 .../nxwm_theading_model_page_0.png | Bin .../nxwm_theading_model_page_1.png | Bin .../nxwm_theading_model_page_2.png | Bin .../nxwm_theading_model_page_3.png | Bin .../nxwm_theading_model_page_4.png | Bin .../nxgraphics => os/graphics}/sample.rst | 0 Documentation/os/index.rst | 136 +++++ .../interrupts}/bottomhalf_interrupt.rst | 0 .../interrupts}/critical_sections.rst | 8 +- Documentation/os/interrupts/index.rst | 45 ++ .../interrupts}/interrupt_controls.rst | 0 .../os/interrupts/interrupt_flow.svg | 69 +++ .../{reference/os => os/ipc}/events.rst | 0 Documentation/os/ipc/index.rst | 59 ++ .../{reference/os => os/ipc}/mutex.rst | 0 .../ipc}/signal_handlers.rst | 0 .../{implementation => os/libs}/crc.rst | 0 .../{components => os}/libs/index.rst | 6 + Documentation/os/libs/libbuiltin.rst | 54 ++ .../{components => os}/libs/libc/index.rst | 0 .../{components => os}/libs/libc/search.rst | 0 .../{components => os}/libs/libc/stdbit.rst | 0 .../{components => os}/libs/libc/stream.rst | 0 .../{components => os}/libs/libc/zoneinfo.rst | 0 .../{components => os}/libs/libdsp.rst | 0 .../{components => os}/libs/libm.rst | 0 .../{components => os}/libs/libnx/index.rst | 0 .../{components => os}/libs/libnx/nxfonts.rst | 0 .../{components => os}/libs/libxx.rst | 0 .../{reference/os => os/memory}/addrenv.rst | 0 .../{components/mm => os/memory}/index.rst | 20 +- .../{reference/os => os/memory}/iob.rst | 0 .../memory}/memory_configurations.rst | 204 ------- .../{components => os/memory}/paging.rst | 0 .../{components/mm => os/memory}/shm.rst | 0 .../networking}/delay_act_and_tcp_perf.rst | 0 .../net => os/networking}/index.rst | 43 +- .../net => os/networking}/ipfilter.rst | 0 .../net => os/networking}/mdio.rst | 0 .../{components/net => os/networking}/nat.rst | 0 .../net => os/networking}/netdev.rst | 0 .../net => os/networking}/netdriver.rst | 0 .../net => os/networking}/netguardsize.rst | 0 .../net => os/networking}/netlink.rst | 0 .../os => os/networking}/newreno.rst | 0 .../{components/net => os/networking}/pkt.rst | 0 .../net => os/networking}/sixlowpan.rst | 0 .../net => os/networking}/slip.rst | 0 .../net => os/networking}/socketcan.rst | 0 .../networking}/tcp_network_perf.rst | 0 .../networking}/tcp_state_machine.rst | 0 .../net => os/networking}/wqueuedeadlocks.rst | 0 Documentation/{reference => }/os/notifier.rst | 0 Documentation/{reference => }/os/nuttx.rst | 0 Documentation/{components => os}/openamp.rst | 0 .../scheduling}/cancellation_points.rst | 0 .../scheduling}/context_switches.rst | 0 .../scheduling}/disabling_interrupts.png | Bin .../scheduling}/disabling_preemption.png | Bin Documentation/os/scheduling/index.rst | 239 ++++++++ .../kernel_threads_vs_pthreads.rst | 0 .../scheduling}/normal_interrupt.png | Bin .../scheduling}/nuttx_tasking.rst | 14 +- Documentation/os/scheduling/policies.svg | 82 +++ .../scheduling}/preemption_latency.rst | 0 .../scheduling}/processes_vs_tasks.rst | 0 .../{implementation => os/scheduling}/smp.rst | 15 - .../scheduling}/task_exit_sequence.png | Bin Documentation/os/scheduling/task_states.svg | 78 +++ .../scheduling}/tasks_vs_threads.rst | 0 .../{implementation => os/scheduling}/tls.rst | 0 .../scheduling}/user_identity.rst | 0 .../os => os/scheduling}/wqueue.rst | 0 Documentation/{components => os}/syscall.rst | 2 +- Documentation/os/system_map.svg | 91 +++ Documentation/os/time/index.rst | 50 ++ .../time}/oneshot_timers_and_cpu_load.rst | 0 .../time}/short_delay.png | Bin .../time}/short_time_delays.rst | 0 .../{reference/os => os/time}/sleep.rst | 0 .../time}/tickless_os.rst | 0 .../{reference/os => os/time}/time_clock.rst | 0 Documentation/{components => os}/video.rst | 0 Documentation/{components => os}/wireless.rst | 0 .../arm/a1x/boards/pcduino-a10/index.rst | 2 + .../am335x/boards/beaglebone-black/index.rst | 2 + .../arm/am335x/boards/beaglebone/index.rst | 2 +- .../arm/am67/boards/t3-gem-o1/index.rst | 2 +- .../arm/at32/boards/at32f437-mini/index.rst | 2 + .../arm/c5471/boards/c5471evm/index.rst | 2 + .../arm/cxd56xx/boards/spresense/index.rst | 2 +- .../arm/dm320/boards/ntosd-dm320/index.rst | 2 + .../arm/efm32/boards/efm32-g8xx-stk/index.rst | 2 + .../efm32/boards/efm32gg-stk3700/index.rst | 2 + .../boards/olimex-efm32g880f128-stk/index.rst | 2 + .../arm/eoss3/boards/quickfeather/index.rst | 2 + .../boards/fvp-armv8r-aarch32/index.rst | 2 + .../boards/gd32f450zk-aiotbox/index.rst | 2 + .../gd32f4/boards/gd32f450zk-eval/index.rst | 2 + .../gd32f4/boards/gd32f470ik-eval/index.rst | 2 + .../boards/gd32f470zk-aiotbox/index.rst | 2 + .../gd32f4/boards/gd32f470zk-eval/index.rst | 2 + .../arm/ht32f491x3/boards/esk32/index.rst | 2 +- .../arm/imx6/boards/sabre-6quad/index.rst | 2 + .../arm/imx9/boards/imx93-qsb/index.rst | 2 +- .../arm/imx9/boards/imx95-evk/index.rst | 2 + .../arm/imx9/boards/mr-navq95b/index.rst | 2 +- .../imxrt/boards/arcx-socket-grid/index.rst | 2 + .../arm/imxrt/boards/fmu-v6xrt/index.rst | 2 +- .../arm/imxrt/boards/imxrt1020-evk/index.rst | 2 + .../arm/imxrt/boards/imxrt1050-evk/index.rst | 2 + .../arm/imxrt/boards/imxrt1060-evk/index.rst | 2 + .../arm/imxrt/boards/imxrt1064-evk/index.rst | 2 + .../arm/imxrt/boards/imxrt1170-evk/index.rst | 2 + .../arm/imxrt/boards/imxrt1180-evk/index.rst | 2 +- .../arm/imxrt/boards/teensy-4.x/index.rst | 2 + .../arm/kinetis/boards/freedom-k28f/index.rst | 2 + .../arm/kinetis/boards/freedom-k64f/index.rst | 2 + .../arm/kinetis/boards/freedom-k66f/index.rst | 2 + .../arm/kinetis/boards/kwikstik-k40/index.rst | 2 + .../arm/kinetis/boards/teensy-3.x/index.rst | 2 + .../arm/kinetis/boards/twr-k60n512/index.rst | 2 + .../arm/kinetis/boards/twr-k64f120m/index.rst | 2 + .../arm/kl/boards/freedom-kl25z/index.rst | 2 + .../arm/kl/boards/freedom-kl26z/index.rst | 2 + .../arm/kl/boards/teensy-lc/index.rst | 2 + .../lc823450/boards/lc823450-xgevk/index.rst | 2 + .../boards/lincoln60/README.txt | 0 .../boards/lincoln60/index.rst | 2 + .../boards/lpc4088-devkit/README.txt | 0 .../boards/lpc4088-quickstart/README.txt | 0 .../boards/lpcxpresso-lpc1768/README.txt | 0 .../boards/lpcxpresso-lpc1768/index.rst | 2 + .../boards/lx_cpu/README.txt | 0 .../boards/lx_cpu/index.rst | 2 + .../boards/mbed/README.txt | 0 .../boards/mbed/index.rst | 2 + .../boards/mcb1700/README.txt | 0 .../boards/mcb1700/index.rst | 2 + .../boards/olimex-lpc1766stk/README.txt | 0 .../boards/olimex-lpc1766stk/index.rst | 2 + .../boards/open1788/README.txt | 0 .../boards/open1788/index.rst | 2 + .../boards/pnev5180b/README.txt | 0 .../boards/pnev5180b/index.rst | 2 + .../boards/u-blox-c027/README.txt | 0 .../boards/u-blox-c027/index.rst | 2 + .../boards/zkit-arm-1769/README.txt | 0 .../boards/zkit-arm-1769/index.rst | 2 + .../arm/{lpc17xx => lpc17xx_40xx}/index.rst | 5 + .../index.rst => lpc17xx_40xx/lpc40xx.rst} | 6 - .../lpc214x/boards/mcu123-lpc214x/index.rst | 2 + .../arm/lpc214x/boards/zp214xpa/index.rst | 2 + .../lpc2378/boards/olimex-lpc2378/index.rst | 2 + .../arm/lpc31xx/boards/ea3131/index.rst | 4 +- .../arm/lpc31xx/boards/ea3152/index.rst | 2 + .../lpc31xx/boards/olimex-lpc-h3131/index.rst | 2 + .../lpc43xx/boards/lpc4370-link2/index.rst | 2 + .../boards/lpcxpresso-lpc54628/index.rst | 2 + .../max326xx/boards/max32660-evsys/index.rst | 2 + .../arm/moxart/boards/moxa/index.rst | 2 + .../arm/mps/boards/mps2-an500/index.rst | 2 + .../{mps2-an512 => mps2-an521}/index.rst | 2 + .../arm/mps/boards/mps3-an547/index.rst | 2 + .../arm/mx8mp/boards/verdin-mx8mp/index.rst | 2 + .../arm/n32h7/boards/n32h762iil7/index.rst | 2 +- .../boards/arduino-nano-33ble-rev2/index.rst | 2 +- .../nrf52/boards/arduino-nano-33ble/index.rst | 2 +- .../nrf52-feather/{intex.rst => index.rst} | 2 +- .../arm/nrf52/boards/nrf52832-dk/index.rst | 2 +- .../arm/nrf52/boards/nrf52832-mdk/index.rst | 2 +- .../nrf52/boards/nrf52832-sparkfun/index.rst | 2 +- .../arm/nrf52/boards/nrf52840-dk/index.rst | 2 +- .../nrf52/boards/nrf52840-dongle/index.rst | 2 +- .../nrf52/boards/nrf9160-dk-nrf52/index.rst | 2 +- .../arm/nrf52/boards/thingy52/index.rst | 2 +- .../arm/nrf52/boards/thingy91-nrf52/index.rst | 2 +- .../arm/nrf52/boards/xiao-nrf52840/index.rst | 2 +- .../nrf53/boards/nrf5340-audio-dk/index.rst | 2 +- .../arm/nrf53/boards/nrf5340-dk/index.rst | 2 +- .../arm/nrf53/boards/thingy53/index.rst | 2 +- .../arm/nrf91/boards/nrf9160-dk/index.rst | 2 +- .../arm/nrf91/boards/thingy91/index.rst | 2 +- .../arm/nuc1xx/boards/nutiny-nuc120/index.rst | 2 + .../arm/phy62xx/boards/phy6222/index.rst | 2 + .../arm/qemu/boards/qemu-armv7a/index.rst | 2 + .../arm/qemu/boards/qemu-armv7r/index.rst | 2 + .../arduino-r4-minima/arduino-r4-minima.png | Bin .../boards/arduino-r4-minima/index.rst | 2 + .../boards/xiao-ra4m1/index.rst | 2 + .../boards/xiao-ra4m1/xiao-ra4m1.jpg | Bin .../platforms/arm/{ra4m1 => ra4}/index.rst | 0 .../boards/adafruit-feather-rp2040/index.rst | 2 +- .../rp2040/boards/adafruit-kb2040/index.rst | 2 +- .../boards/adafruit-qt-py-rp2040/index.rst | 2 +- .../rp2040/boards/pimoroni-tiny2040/index.rst | 2 +- .../boards/raspberrypi-pico-w/index.rst | 2 +- .../rp2040/boards/raspberrypi-pico/index.rst | 2 +- .../rp2040/boards/seeed-xiao-rp2040/index.rst | 2 +- .../rp2040/boards/w5500-evb-pico/index.rst | 2 +- .../waveshare-rp2040-lcd-1.28/index.rst | 2 +- .../boards/waveshare-rp2040-zero/index.rst | 2 +- Documentation/platforms/arm/rp2040/index.rst | 2 +- .../boards/pimoroni-pico-2-plus/index.rst | 4 +- .../boards/pimoroni-pico-plus-2-w/index.rst | 2 +- .../boards/raspberrypi-pico-2/index.rst | 2 +- .../arm/rp23xx/boards/xiao-rp2350/index.rst | 2 +- Documentation/platforms/arm/rp23xx/index.rst | 2 +- .../rtl8720f/boards/rtl8720f_evb/index.rst | 2 +- .../arm/rtl8721dx/boards/pke8721daf/index.rst | 2 +- .../rtl8721f/boards/rtl8721f_evb/index.rst | 2 +- .../s32k1xx/boards/rddrone-bms772/index.rst | 2 + .../arm/s32k1xx/boards/s32k118evb/index.rst | 2 + .../arm/s32k1xx/boards/s32k144evb/index.rst | 2 + .../arm/s32k1xx/boards/s32k146evb/index.rst | 2 + .../arm/s32k1xx/boards/s32k148evb/index.rst | 2 + .../arm/s32k1xx/boards/ucans32k146/index.rst | 2 + .../arm/s32k3xx/boards/mr-canhubk3/index.rst | 2 + .../arm/s32k3xx/boards/s32k344evb/index.rst | 2 + .../arm/sam34/boards/arduino-due/index.rst | 2 + .../sam34/boards/flipnclick-sam3x/index.rst | 2 + .../arm/sam34/boards/sam3u-ek/index.rst | 2 + .../arm/sam34/boards/sam4cmp-db/index.rst | 2 + .../arm/sam34/boards/sam4e-ek/index.rst | 2 + .../arm/sam34/boards/sam4l-xplained/index.rst | 2 + .../sam34/boards/sam4s-xplained-pro/index.rst | 2 + .../arm/sam34/boards/sam4s-xplained/index.rst | 2 + .../arm/sama5/boards/giant-board/index.rst | 2 + .../arm/sama5/boards/jupiter-nano/index.rst | 2 + .../arm/sama5/boards/sama5d2-xult/index.rst | 2 + .../sama5/boards/sama5d3-xplained/index.rst | 2 + .../arm/sama5/boards/sama5d3x-ek/index.rst | 2 + .../arm/sama5/boards/sama5d4-ek/index.rst | 2 + .../arm/samd2l2/boards/arduino-m0/index.rst | 2 + .../samd2l2/boards/circuit-express/index.rst | 2 + .../samd2l2/boards/samd20-xplained/index.rst | 2 + .../samd2l2/boards/samd21-xplained/index.rst | 2 + .../samd2l2/boards/saml21-xplained/index.rst | 2 + .../samd2l2/boards/xiao-seeeduino/index.rst | 2 + .../arm/samd5e5/boards/metro-m4/index.rst | 2 + .../boards/same54-xplained-pro/index.rst | 2 + .../boards/pic32czca70-curiosity/index.rst | 2 + .../arm/samv7/boards/same70-qmtech/index.rst | 2 + .../samv7/boards/same70-xplained/index.rst | 2 + .../arm/samv7/boards/samv71-xult/index.rst | 2 + .../stm32c0/boards/nucleo-c071rb/index.rst | 2 +- .../stm32c0/boards/nucleo-c092rc/index.rst | 2 +- .../stm32c5/boards/nucleo-c562re/index.rst | 2 +- .../stm32f0/boards/nucleo-f072rb/index.rst | 2 +- .../stm32f0/boards/nucleo-f091rc/index.rst | 2 +- .../boards/stm32f051-discovery/index.rst | 2 +- .../boards/stm32f072-discovery/index.rst | 2 +- .../arm/stm32f1/boards/cloudctrl/index.rst | 2 +- .../stm32f1/boards/et-stm32-stamp/index.rst | 2 +- .../arm/stm32f1/boards/fire-stm32v2/index.rst | 2 +- .../{hymini-stm32 => hymini-stm32v}/index.rst | 2 +- .../arm/stm32f1/boards/maple/index.rst | 2 +- .../stm32f1/boards/nucleo-f103rb/index.rst | 2 +- .../stm32f1/boards/olimexino-stm32/index.rst | 2 +- .../arm/stm32f1/boards/shenzhou/index.rst | 2 +- .../stm32f1/boards/stm3210e-eval/index.rst | 2 +- .../arm/stm32f1/boards/stm32_tiny/index.rst | 2 +- .../stm32f1/boards/stm32butterfly2/index.rst | 2 +- .../boards/stm32f103-minimum/index.rst | 2 +- .../stm32f1/boards/stm32vldiscovery/index.rst | 2 +- .../boards/viewtool-stm32f107/index.rst | 2 +- .../arm/stm32f2/boards/emw3162/index.rst | 2 +- .../stm32f2/boards/nucleo-f207zg/index.rst | 2 +- .../boards/olimex-stm32-p207/index.rst | 2 +- .../arm/stm32f2/boards/photon/index.rst | 2 +- .../stm32f2/boards/stm3220g-eval/index.rst | 2 +- .../stm32f3/boards/nucleo-f302r8/index.rst | 2 +- .../stm32f3/boards/nucleo-f303re/index.rst | 2 +- .../stm32f3/boards/nucleo-f303ze/index.rst | 2 +- .../stm32f3/boards/nucleo-f334r8/index.rst | 2 +- .../stm32f3/boards/stm32f334-disco/index.rst | 2 +- .../stm32f3/boards/stm32f3discovery/index.rst | 2 +- .../arm/stm32f4/boards/axoloti/index.rst | 2 +- .../stm32f4/boards/clicker2-stm32/index.rst | 2 +- .../stm32f4/boards/mikroe-stm32f4/index.rst | 2 +- .../stm32f4/boards/nucleo-f401re/index.rst | 2 +- .../stm32f4/boards/nucleo-f410rb/index.rst | 2 +- .../stm32f4/boards/nucleo-f411re/index.rst | 2 +- .../stm32f4/boards/nucleo-f412zg/index.rst | 2 +- .../stm32f4/boards/nucleo-f429zi/index.rst | 2 +- .../stm32f4/boards/nucleo-f446re/index.rst | 2 +- .../arm/stm32f4/boards/odrive36/index.rst | 2 +- .../boards/olimex-stm32-e407/index.rst | 2 +- .../boards/olimex-stm32-h405/index.rst | 2 +- .../boards/olimex-stm32-h407/index.rst | 2 +- .../boards/olimex-stm32-p407/index.rst | 2 +- .../arm/stm32f4/boards/omnibusf4/index.rst | 2 +- .../stm32f4/boards/stm3240g-eval/index.rst | 2 +- .../boards/stm32f401rc-rs485/index.rst | 4 +- .../boards/stm32f411-minimum/index.rst | 2 +- .../stm32f4/boards/stm32f411e-disco/index.rst | 2 +- .../stm32f4/boards/stm32f429i-disco/index.rst | 2 +- .../stm32f4/boards/stm32f4discovery/index.rst | 4 +- Documentation/platforms/arm/stm32f4/index.rst | 2 +- .../stm32f7/boards/nucleo-f722ze/index.rst | 2 +- .../stm32f7/boards/nucleo-f746zg/index.rst | 2 +- .../stm32f7/boards/nucleo-f767zi/index.rst | 2 +- .../stm32f7/boards/steval-eth001v1/index.rst | 2 +- .../arm/stm32f7/boards/stm32f746-ws/index.rst | 2 +- .../stm32f7/boards/stm32f746g-disco/index.rst | 2 +- .../stm32f7/boards/stm32f769i-disco/index.rst | 2 +- .../boards/stm32f777zit6-meadow/index.rst | 2 +- .../stm32g0/boards/nucleo-g070rb/index.rst | 2 +- .../stm32g0/boards/nucleo-g071rb/index.rst | 2 +- .../stm32g0/boards/nucleo-g0b1re/index.rst | 3 + .../stm32g0/boards/stm32g071b-disco/index.rst | 2 +- .../arm/stm32g4/boards/b-g431b-esc1/index.rst | 2 +- .../stm32g4/boards/b-g474e-dpow1/index.rst | 2 +- .../stm32g4/boards/nucleo-g431kb/index.rst | 2 +- .../stm32g4/boards/nucleo-g431rb/index.rst | 2 +- .../stm32g4/boards/nucleo-g474re/index.rst | 2 +- .../stm32h5/boards/nucleo-h503rb/index.rst | 2 +- .../stm32h5/boards/nucleo-h533re/index.rst | 2 +- .../stm32h5/boards/nucleo-h563zi/index.rst | 2 +- Documentation/platforms/arm/stm32h5/index.rst | 2 +- .../boards/devebox-stm32h743/index.rst | 2 +- .../boards/linum-stm32h753bi/index.rst | 2 +- .../stm32h7/boards/nucleo-h723zg/index.rst | 2 +- .../stm32h7/boards/nucleo-h743zi/index.rst | 2 +- .../stm32h7/boards/nucleo-h743zi2/index.rst | 2 +- .../stm32h7/boards/nucleo-h745zi/index.rst | 2 +- .../stm32h7/boards/nucleo-h753zi/index.rst | 2 +- .../stm32h7/boards/nucleo-h7s3l8/index.rst | 2 +- .../arm/stm32h7/boards/openh743i/index.rst | 2 +- .../arm/stm32h7/boards/portenta-h7/index.rst | 2 + .../stm32h7/boards/stm32h745i-disco/index.rst | 2 +- .../stm32h7/boards/stm32h747i-disco/index.rst | 2 +- .../stm32h7/boards/weact-stm32h743/index.rst | 2 +- .../stm32h7/boards/weact-stm32h750/index.rst | 2 +- Documentation/platforms/arm/stm32h7/index.rst | 2 +- .../stm32l0/boards/b-l072z-lrwan1/index.rst | 2 +- .../stm32l0/boards/nucleo-l073rz/index.rst | 2 +- .../stm32l0/boards/stm32l0538-disco/index.rst | 2 +- .../stm32l1/boards/nucleo-l152re/index.rst | 2 +- .../stm32l1/boards/stm32ldiscovery/index.rst | 2 +- .../stm32l4/boards/b-l475e-iot01a/index.rst | 2 +- .../stm32l4/boards/nucleo-l432kc/index.rst | 2 +- .../stm32l4/boards/nucleo-l452re/index.rst | 2 +- .../stm32l4/boards/nucleo-l476rg/index.rst | 2 +- .../stm32l4/boards/nucleo-l496zg/index.rst | 2 +- .../stm32l4/boards/steval-stlcs01v1/index.rst | 2 +- .../stm32l4/boards/stm32l476-mdk/index.rst | 2 +- .../boards/stm32l476vg-disco/index.rst | 2 +- .../boards/stm32l4r9ai-disco/index.rst | 2 +- .../stm32l5/boards/nucleo-l552ze/index.rst | 2 +- .../stm32l5/boards/stm32l562e-dk/index.rst | 2 +- .../stm32n6/boards/nucleo-n657x0-q/index.rst | 2 +- .../stm32u0/boards/nucleo-u083rc/index.rst | 2 +- .../stm32u0/boards/stm32u083c-dk/index.rst | 2 +- .../stm32u3/boards/nucleo-u3c5zi-q/index.rst | 2 +- .../stm32u5/boards/b-u585i-iot02a/index.rst | 2 +- .../stm32u5/boards/nucleo-u5a5zj-q/index.rst | 2 +- .../arm/stm32wb/boards/flipperzero/index.rst | 2 +- .../stm32wb/boards/nucleo-wb55rg/index.rst | 2 +- .../stm32wl5/boards/nucleo-wl55jc/index.rst | 2 +- .../arm/tiva/boards/lm3s6965-ek/index.rst | 2 + .../tiva/boards/tm4c123g-launchpad/index.rst | 4 +- .../arm/xmc4/boards/xmc4500-relax/index.rst | 2 + .../arm/xmc4/boards/xmc4700-relax/index.rst | 2 + .../arm64/a527/boards/avaota-a1/index.rst | 2 +- .../arm64/a64/boards/pinephone/index.rst | 2 +- .../arm64/am62x/boards/beagleplay/index.rst | 2 +- .../am62x/boards/pocketbeagle2/index.rst | 2 +- .../bcm2711/boards/raspberrypi-4b/index.rst | 2 +- .../platforms/arm64/bcm2711/index.rst | 2 +- .../arm64/fvp-v8r/boards/fvp-armv8r/index.rst | 2 +- .../arm64/imx8/boards/imx8qm-mek/index.rst | 2 +- .../arm64/imx9/boards/imx93-evk/index.rst | 2 +- .../arm64/imx9/boards/imx95-a55-evk/index.rst | 2 +- .../arm64/qemu/boards/qemu-armv8a/index.rst | 2 +- .../arm64/rk3399/boards/nanopi_m4/index.rst | 2 +- .../rk3399/boards/pinephonepro/index.rst | 2 +- .../rk3588/boards/orangepi-5-pro/index.rst | 2 +- .../platforms/arm64/rk3588/index.rst | 2 +- .../arm64/zynq-mpsoc/boards/zcu111/index.rst | 2 +- .../avr/at32uc3/boards/avr32dev1/index.rst | 2 +- .../at90usb/boards/micropendous3/index.rst | 2 +- .../avr/at90usb/boards/teensy-2.0/index.rst | 2 +- .../atmega/atmega128/boards/amber/index.rst | 2 +- .../boards/mega1284p-xplained/index.rst | 2 + .../atmega1284p/boards/moteino-mega/index.rst | 2 +- .../boards/arduino-mega2560/index.rst | 2 +- .../boards/elegoo-mega2560r3/index.rst | 2 +- Documentation/platforms/avr/atmega/index.rst | 2 +- .../avr/avrdx/boards/breadxavr/index.rst | 2 + .../platforms/avr/avrdx/docs/up_udelay.rst | 2 +- .../avr/common/context-switch-notes.rst | 2 +- .../hc/m9s12/boards/demo9s12ne64/index.rst | 2 +- .../hc/m9s12/boards/ne64badge/index.rst | 2 +- Documentation/platforms/hc/m9s12/index.rst | 2 +- Documentation/platforms/index.rst | 2 +- .../{mips-creator-ci20 => ci20}/ci20.jpg | Bin .../{mips-creator-ci20 => ci20}/index.rst | 2 +- .../mips/pic32mx/boards/mirtoo/index.rst | 2 + .../boards/pic32mx-starterkit/index.rst | 2 + .../mips/pic32mx/boards/pic32mx7mmb/index.rst | 2 + .../pic32mx/boards/sure-pic32mx/index.rst | 2 + .../mips/pic32mx/boards/ubw32/index.rst | 2 + .../pic32mz/boards/chipkit-wifire/index.rst | 2 +- .../boards/flipnclick-pic32mz/index.rst | 2 +- .../boards/pic32mz-starterkit/index.rst | 2 +- .../platforms/{misco => misoc}/index.rst | 0 .../lm32/boards/misoc/index.rst | 2 + .../platforms/{misco => misoc}/lm32/index.rst | 0 .../or1k/mor1kx/boards/or1k/index.rst | 2 + .../renesas/m16c/boards/skp16c26/index.rst | 2 +- .../rx65n/boards/rx65n-grrose/index.rst | 2 +- .../rx65n/boards/rx65n-rsk2mb/index.rst | 2 +- .../renesas/sh1/boards/us7032evb1/index.rst | 2 +- .../boards/lichee-rv-86-panel/index.rst | 2 + .../risc-v/bl602/boards/bl602evb/index.rst | 2 + .../risc-v/bl808/boards/ox64/index.rst | 2 + .../risc-v/c906/boards/smartl-c906/index.rst | 2 +- .../eic7700x/boards/eic7700-evb/index.rst | 2 +- .../eic7700x/boards/starpro64/index.rst | 2 +- .../platforms/risc-v/eic7700x/index.rst | 2 +- .../esp32c3-legacy-devkit-rust-1/index.rst | 2 +- .../boards/esp32c3-legacy-devkit/index.rst | 2 + .../esp32c3/boards/esp32-c3-zero/index.rst | 2 +- .../esp32c3/boards/esp32c3-devkit/index.rst | 2 + .../boards/esp32c3-supermini/index.rst | 2 +- .../esp32c3/boards/esp32c3-xiao/index.rst | 8 +- .../esp32c6/boards/esp32c6-devkitc/index.rst | 2 + .../esp32c6/boards/esp32c6-devkitm/index.rst | 2 + .../esp32c6/boards/esp32c6-xiao/index.rst | 2 + .../platforms/risc-v/esp32c6/index.rst | 2 +- .../esp32h2/boards/esp32h2-devkit/index.rst | 2 + .../esp32p4-function-ev-board/index.rst | 2 +- .../esp32p4/boards/esp32p4-tab5/index.rst | 2 +- .../platforms/risc-v/esp32p4/index.rst | 4 +- .../fe310/boards/hifive1-revb/index.rst | 2 +- .../gd32vw55x/boards/gd32vw553-hmq/index.rst | 2 + .../boards/gd32vw553k-start/index.rst | 2 + .../hpm6000/boards/hpm6360evk/index.rst | 2 + .../hpm6750/boards/hpm6750evk2/index.rst | 2 +- .../risc-v/jh7110/boards/star64/index.rst | 2 + .../risc-v/k210/boards/maix-bit/index.rst | 2 +- .../risc-v/k230/boards/canmv230/index.rst | 4 +- .../risc-v/litex/boards/arty_a7/index.rst | 2 +- .../risc-v/mpfs/boards/icicle/index.rst | 2 + .../risc-v/qemu-rv/boards/rv-virt/index.rst | 2 + .../boards/raspberrypi-pico-2-rv/index.rst | 2 +- .../platforms/risc-v/rp23xx-rv/index.rst | 2 +- .../rv32m1/boards/rv32m1-vega/index.rst | 2 +- .../risc-v/sg2000/boards/milkv_duos/index.rst | 2 + .../platforms/sim/sim/boards/sim/index.rst | 2 +- .../sparc/bm3803/boards/xx3803/index.rst | 2 + .../sparc/bm3823/boards/xx3823/index.rst | 2 + .../sparc/s698pm/boards/s698pm-dkit/index.rst | 2 + .../index.rst | 2 + .../boards/triboard_tc4x9_com/index.rst | 2 + .../tricore/{tc4d9 => tc4da}/index.rst | 0 .../x86/qemu/boards/qemu-i486/index.rst | 2 + .../platforms/x86_64/intel64/index.rst | 6 - .../boards/qemu-intel64/index.rst | 2 + Documentation/platforms/x86_64/qemu/index.rst | 12 + .../esp32/boards/esp32-2432S028/index.rst | 2 +- .../esp32/boards/esp32-audio-kit/index.rst | 2 +- .../esp32/boards/esp32-devkitc/index.rst | 2 +- .../esp32/boards/esp32-ethernet-kit/index.rst | 2 +- .../xtensa/esp32/boards/esp32-lyrat/index.rst | 2 +- .../esp32/boards/esp32-pico-kit/index.rst | 2 +- .../esp32/boards/esp32-wrover-kit/index.rst | 2 +- .../esp32/boards/heltec_wifi_lora32/index.rst | 2 +- .../platforms/xtensa/esp32/index.rst | 4 +- .../esp32s2/boards/esp32s2-kaluga-1/index.rst | 2 +- .../esp32s2/boards/esp32s2-saola-1/index.rst | 2 +- .../platforms/xtensa/esp32s2/index.rst | 6 +- .../esp32s3/boards/esp32s3-8048S043/index.rst | 2 +- .../esp32s3/boards/esp32s3-devkit/index.rst | 2 +- .../esp32s3/boards/esp32s3-eye/index.rst | 2 +- .../esp32s3/boards/esp32s3-korvo-2/index.rst | 2 +- .../esp32s3/boards/esp32s3-lcd-ev/index.rst | 2 +- .../esp32s3/boards/esp32s3-lhcbit/index.rst | 2 +- .../boards/esp32s3-m5-cardputer/index.rst | 2 +- .../boards/esp32s3-touch-lcd7/index.rst | 2 +- .../boards/esp32s3-ws-lcd128/index.rst | 2 +- .../esp32s3/boards/esp32s3-xiao/index.rst | 2 +- .../boards/lckfb-szpi-esp32s3/index.rst | 2 +- .../platforms/xtensa/esp32s3/index.rst | 2 +- .../z16/z16f/boards/z16f2800100zcog/index.rst | 2 + .../z80/ez80/boards/ez80f910200kitg/index.rst | 2 + .../z80/ez80/boards/ez80f910200zco/index.rst | 2 + .../z80/ez80/boards/makerlisp/index.rst | 2 + .../platforms/z80/ez80/boards/z20x/index.rst | 2 + .../platforms/z80/z180/boards/p112/index.rst | 2 + .../z80/z8/boards/z8encore000zco/index.rst | 2 + .../z80/z8/boards/z8f64200100kit/index.rst | 2 + .../platforms/z80/z80/boards/z80sim/index.rst | 2 + Documentation/quickstart/organization.rst | 22 +- Documentation/redirects.py | 572 ++++++++++++++++++ Documentation/reference/os/index.rst | 15 - .../reference/user/01_task_control.rst | 2 +- Documentation/reference/user/13_boardctl.rst | 2 +- Documentation/reference/user/14_logging.rst | 2 +- Documentation/testing/ntfc.rst | 2 +- 1014 files changed, 4228 insertions(+), 1339 deletions(-) rename Documentation/ReleaseNotes/{NuttX-0.1.0 => NuttX-0.1.0.md} (97%) rename Documentation/ReleaseNotes/{NuttX-0.1.1 => NuttX-0.1.1.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.1.2 => NuttX-0.1.2.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.1 => NuttX-0.2.1.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.2 => NuttX-0.2.2.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.3 => NuttX-0.2.3.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.4 => NuttX-0.2.4.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.5 => NuttX-0.2.5.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.6 => NuttX-0.2.6.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.2.7 => NuttX-0.2.7.md} (97%) rename Documentation/ReleaseNotes/{NuttX-0.2.8 => NuttX-0.2.8.md} (97%) rename Documentation/ReleaseNotes/{NuttX-0.2.9 => NuttX-0.2.9.md} (94%) rename Documentation/ReleaseNotes/{NuttX-0.3.0 => NuttX-0.3.0.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.1 => NuttX-0.3.1.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.10 => NuttX-0.3.10.md} (97%) rename Documentation/ReleaseNotes/{NuttX-0.3.11 => NuttX-0.3.11.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.12 => NuttX-0.3.12.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.13 => NuttX-0.3.13.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.3.14 => NuttX-0.3.14.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.3.15 => NuttX-0.3.15.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.16 => NuttX-0.3.16.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.17 => NuttX-0.3.17.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.18 => NuttX-0.3.18.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.3.19 => NuttX-0.3.19.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.3.2 => NuttX-0.3.2.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.3 => NuttX-0.3.3.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.3.4 => NuttX-0.3.4.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.5 => NuttX-0.3.5.md} (97%) rename Documentation/ReleaseNotes/{NuttX-0.3.6 => NuttX-0.3.6.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.3.7 => NuttX-0.3.7.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.3.8 => NuttX-0.3.8.md} (96%) rename Documentation/ReleaseNotes/{NuttX-0.3.9 => NuttX-0.3.9.md} (97%) rename Documentation/ReleaseNotes/{NuttX-0.4.0 => NuttX-0.4.0.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.1 => NuttX-0.4.1.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.10 => NuttX-0.4.10.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.11 => NuttX-0.4.11.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.12 => NuttX-0.4.12.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.13 => NuttX-0.4.13.md} (99%) rename Documentation/ReleaseNotes/{NuttX-0.4.2 => NuttX-0.4.2.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.3 => NuttX-0.4.3.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.4 => NuttX-0.4.4.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.5 => NuttX-0.4.5.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.6 => NuttX-0.4.6.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.7 => NuttX-0.4.7.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.8 => NuttX-0.4.8.md} (98%) rename Documentation/ReleaseNotes/{NuttX-0.4.9 => NuttX-0.4.9.md} (97%) rename Documentation/ReleaseNotes/{NuttX-10.0.0 => NuttX-10.0.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-10.1.0 => NuttX-10.1.0.md} (98%) rename Documentation/ReleaseNotes/{NuttX-10.2.0 => NuttX-10.2.0.md} (97%) rename Documentation/ReleaseNotes/{NuttX-10.3.0 => NuttX-10.3.0.md} (98%) rename Documentation/ReleaseNotes/{NuttX-11.0.0 => NuttX-11.0.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.0.0 => NuttX-12.0.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.1.0 => NuttX-12.1.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.10.0 => NuttX-12.10.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.11.0 => NuttX-12.11.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.12.0 => NuttX-12.12.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.13.0 => NuttX-12.13.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.2.0 => NuttX-12.2.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.2.1 => NuttX-12.2.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.3.0 => NuttX-12.3.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.4.0 => NuttX-12.4.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.5.0 => NuttX-12.5.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.5.1 => NuttX-12.5.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.6.0 => NuttX-12.6.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.7.0 => NuttX-12.7.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.8.0 => NuttX-12.8.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-12.9.0 => NuttX-12.9.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-13.0.0 => NuttX-13.0.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-13.0.1 => NuttX-13.0.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-4.14 => NuttX-4.14.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.0 => NuttX-5.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.1 => NuttX-5.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.10 => NuttX-5.10.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.11 => NuttX-5.11.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.12 => NuttX-5.12.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.13 => NuttX-5.13.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.14 => NuttX-5.14.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.15 => NuttX-5.15.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.16 => NuttX-5.16.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.17 => NuttX-5.17.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.18 => NuttX-5.18.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.19 => NuttX-5.19.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.2 => NuttX-5.2.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.3 => NuttX-5.3.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.4 => NuttX-5.4.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.5 => NuttX-5.5.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.6 => NuttX-5.6.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.7 => NuttX-5.7.md} (98%) rename Documentation/ReleaseNotes/{NuttX-5.8 => NuttX-5.8.md} (99%) rename Documentation/ReleaseNotes/{NuttX-5.9 => NuttX-5.9.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.0 => NuttX-6.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.1 => NuttX-6.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.10 => NuttX-6.10.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.11 => NuttX-6.11.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.12 => NuttX-6.12.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.13 => NuttX-6.13.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.14 => NuttX-6.14.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.15 => NuttX-6.15.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.16 => NuttX-6.16.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.17 => NuttX-6.17.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.18 => NuttX-6.18.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.19 => NuttX-6.19.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.2 => NuttX-6.2.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.20 => NuttX-6.20.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.21 => NuttX-6.21.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.22 => NuttX-6.22.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.23 => NuttX-6.23.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.24 => NuttX-6.24.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.25 => NuttX-6.25.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.26 => NuttX-6.26.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.27 => NuttX-6.27.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.28 => NuttX-6.28.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.29 => NuttX-6.29.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.3 => NuttX-6.3.md} (98%) rename Documentation/ReleaseNotes/{NuttX-6.30 => NuttX-6.30.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.31 => NuttX-6.31.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.32 => NuttX-6.32.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.4 => NuttX-6.4.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.5 => NuttX-6.5.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.6 => NuttX-6.6.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.7 => NuttX-6.7.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.8 => NuttX-6.8.md} (99%) rename Documentation/ReleaseNotes/{NuttX-6.9 => NuttX-6.9.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.1 => NuttX-7.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.10 => NuttX-7.10.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.11 => NuttX-7.11.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.12 => NuttX-7.12.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.13 => NuttX-7.13.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.14 => NuttX-7.14.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.15 => NuttX-7.15.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.16 => NuttX-7.16.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.17 => NuttX-7.17.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.18 => NuttX-7.18.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.19 => NuttX-7.19.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.2 => NuttX-7.2.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.20 => NuttX-7.20.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.21 => NuttX-7.21.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.22 => NuttX-7.22.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.23 => NuttX-7.23.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.24 => NuttX-7.24.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.25 => NuttX-7.25.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.26 => NuttX-7.26.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.27 => NuttX-7.27.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.28 => NuttX-7.28.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.29 => NuttX-7.29.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.3 => NuttX-7.3.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.30 => NuttX-7.30.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.31 => NuttX-7.31.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.4 => NuttX-7.4.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.5 => NuttX-7.5.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.6 => NuttX-7.6.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.7 => NuttX-7.7.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.8 => NuttX-7.8.md} (99%) rename Documentation/ReleaseNotes/{NuttX-7.9 => NuttX-7.9.md} (99%) rename Documentation/ReleaseNotes/{NuttX-8.1 => NuttX-8.1.md} (99%) rename Documentation/ReleaseNotes/{NuttX-8.2 => NuttX-8.2.md} (99%) rename Documentation/ReleaseNotes/{NuttX-9.0.0 => NuttX-9.0.0.md} (99%) rename Documentation/ReleaseNotes/{NuttX-9.1.0 => NuttX-9.1.0.md} (99%) create mode 100644 Documentation/ReleaseNotes/index.rst create mode 100644 Documentation/_extensions/tags_overview.py create mode 100644 Documentation/_templates/redirect.html create mode 100644 Documentation/about/index.rst delete mode 100644 Documentation/components/drivers/character/leds/index.rst create mode 100644 Documentation/contributing/doc_templates/board-tags-example.txt create mode 100644 Documentation/developing/index.rst rename Documentation/guides/{ => build}/building_nuttx_with_app_out_of_src_tree.rst (98%) rename Documentation/guides/{ => build}/building_uclibcpp.rst (100%) rename Documentation/guides/{ => build}/cpp_cmake.rst (100%) rename Documentation/guides/{ => build}/custom_app_directories.rst (100%) rename Documentation/guides/{ => build}/customapps.rst (100%) rename Documentation/guides/{ => build}/integrate_newlib.rst (100%) rename Documentation/guides/{ => build}/nix_flake.rst (100%) rename Documentation/guides/{ => build}/platform_directories.rst (99%) rename Documentation/guides/{ => chip-specific}/armv7m_runtimestackcheck.rst (100%) rename Documentation/guides/{ => chip-specific}/changing_systemclockconfig.rst (99%) rename Documentation/guides/{ => chip-specific}/port_drivers_to_stm32f7.rst (100%) rename Documentation/guides/{ => chip-specific}/semihosting.rst (100%) rename Documentation/guides/{ => chip-specific}/smaller_vector_tables.rst (100%) rename Documentation/guides/{ => chip-specific}/stm32_ports.rst (100%) rename Documentation/guides/{ => chip-specific}/stm32ccm.rst (100%) rename Documentation/guides/{ => chip-specific}/stm32nullpointer.rst (100%) rename Documentation/guides/{ => concurrency}/fork_vfork_migration.rst (100%) rename Documentation/guides/{ => concurrency}/kernel_threads_with_custom_stacks.rst (100%) rename Documentation/guides/{ => concurrency}/nestedinterrupts.rst (100%) rename Documentation/guides/{ => concurrency}/signal_events_interrupt_handlers.rst (98%) rename Documentation/guides/{ => concurrency}/signaling_sem_priority_inheritance.rst (100%) rename Documentation/guides/{ => concurrency}/thread_local_storage.rst (100%) rename Documentation/guides/{ => concurrency}/usingkernelthreads.rst (100%) rename Documentation/guides/{ => concurrency}/versioning_and_task_names.rst (100%) rename Documentation/guides/{ => concurrency}/zerolatencyinterrupts.rst (100%) rename Documentation/guides/{ => drivers}/devicetree.rst (100%) rename Documentation/guides/{ => drivers}/drivers.rst (100%) rename Documentation/guides/{ => drivers}/logging_rambuffer.rst (100%) rename Documentation/guides/{ => drivers}/lwl.rst (100%) rename Documentation/guides/{ => drivers}/ofloader.rst (100%) rename Documentation/guides/{ => drivers}/reading_can_msgs.rst (100%) rename Documentation/guides/{ => drivers}/rndis.rst (100%) rename Documentation/guides/{ => drivers}/usbtrace.rst (100%) rename Documentation/guides/{ => filesystem}/automounter.rst (100%) rename Documentation/guides/{ => filesystem}/etcromfs.rst (100%) rename Documentation/guides/{ => filesystem}/ram_rom_disks.rst (100%) rename Documentation/guides/{ => languages}/pysimcoder.rst (98%) rename Documentation/guides/{ => languages}/rust.rst (100%) rename Documentation/guides/{ => networking}/ipv6.rst (100%) rename Documentation/guides/{ => networking}/nfs.rst (100%) rename Documentation/guides/{ => networking}/nsh_network_link_management.rst (100%) rename Documentation/guides/{ => networking}/testingtcpip.rst (100%) rename Documentation/guides/{ => nsh}/multiple_nsh_sessions.rst (100%) rename Documentation/guides/{ => nsh}/remove_device_drivers_nsh.rst (99%) rename Documentation/guides/{porting-case-studies => porting/case-studies}/bcm2711-rpi4b.rst (100%) rename Documentation/guides/{porting-case-studies => porting/case-studies}/port_arm_cm4.rst (99%) rename Documentation/guides/{ => porting}/customboards.rst (98%) rename Documentation/guides/{ => porting}/include_files_board_h.rst (100%) rename Documentation/guides/{ => porting}/port.rst (75%) rename Documentation/guides/{ => porting}/port_bootsequence.rst (97%) rename Documentation/guides/{ => porting}/port_relatedkernelconfigrations.rst (100%) rename Documentation/guides/{ => porting}/specialstuff_in_nuttxheaderfiles.rst (100%) rename Documentation/guides/{ => programs}/fully_linked_elf.rst (99%) rename Documentation/guides/{ => programs}/partially_linked_elf.rst (99%) rename Documentation/guides/{ => programs}/protected_build.rst (100%) rename Documentation/guides/{ => programs}/updating_release_system_elf.rst (100%) rename Documentation/guides/{ => security}/fortify.rst (100%) rename Documentation/guides/{ => security}/optee.rst (100%) rename Documentation/guides/{ => simulation}/qemu_tips.rst (100%) rename Documentation/guides/{ => simulation}/renode.rst (100%) rename Documentation/guides/{ => simulation}/simulator.rst (100%) rename Documentation/{reference => }/os/app_vs_os.rst (100%) rename Documentation/{reference/os/arch.rst => os/arch/arch_api.rst} (100%) rename Documentation/{reference/os/board.rst => os/arch/board_api.rst} (100%) rename Documentation/{components => os}/arch/index.rst (98%) rename Documentation/{components => os}/audio/index.rst (99%) rename Documentation/{components/binfmt.rst => os/binfmt/index.rst} (99%) rename Documentation/{implementation => os/binfmt}/kernel_modules_vs_shared_libraries.rst (100%) rename Documentation/{components => os/binfmt}/nxflat.rst (99%) create mode 100644 Documentation/os/build_modes.rst create mode 100644 Documentation/os/build_modes.svg rename Documentation/{components => os}/concurrency/index.rst (98%) rename Documentation/{components => os}/concurrency/seqcount/index.rst (100%) rename Documentation/{reference => }/os/conventions.rst (100%) rename Documentation/{components => os}/crypto.rst (100%) rename Documentation/{components => os}/drivers/block/index.rst (100%) rename Documentation/{components => os}/drivers/block/ramdisk.rst (100%) rename Documentation/{components => os}/drivers/character/1wire.rst (100%) rename Documentation/{components => os}/drivers/character/aie.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/adc1242/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/ads1115/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/ads7828/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/hx711/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/ltc1867l/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/max1161x/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/mcp3008/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/adc/pga11x/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/dac/dac7554/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/dac/dac7571/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/dac/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/dac/mcp47x6/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/dac/mcp48xx/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/dac/stm32h7/index.rst (99%) rename Documentation/{components => os}/drivers/character/analog/index.rst (100%) rename Documentation/{components => os}/drivers/character/analog/pot/index.rst (100%) rename Documentation/{components => os}/drivers/character/bch.rst (100%) rename Documentation/{components => os}/drivers/character/can.rst (99%) rename Documentation/{components => os}/drivers/character/contactless.rst (100%) rename Documentation/{components => os}/drivers/character/crypto/index.rst (100%) rename Documentation/{components => os}/drivers/character/crypto/se05x.rst (100%) rename Documentation/{components => os}/drivers/character/eeprom.rst (100%) rename Documentation/{components => os}/drivers/character/efuse.rst (100%) rename Documentation/{components => os}/drivers/character/gpio.rst (99%) rename Documentation/{components => os}/drivers/character/i2s.rst (100%) rename Documentation/{components => os}/drivers/character/index.rst (100%) rename Documentation/{components => os}/drivers/character/input/images/keypad-example.png (100%) rename Documentation/{components => os}/drivers/character/input/images/mpr121.png (100%) rename Documentation/{components => os}/drivers/character/input/index.rst (100%) rename Documentation/{components => os}/drivers/character/input/keypad-keyboard.rst (100%) rename Documentation/{components => os}/drivers/character/input/keypad.rst (100%) rename Documentation/{components => os}/drivers/character/input/mpr121.rst (100%) rename Documentation/{components => os}/drivers/character/input/sbutton.rst (100%) rename Documentation/{components => os}/drivers/character/input/st7123.rst (100%) rename Documentation/{components => os}/drivers/character/ipcc.rst (100%) rename Documentation/{reference/os/led.rst => os/drivers/character/leds/index.rst} (98%) rename Documentation/{components => os}/drivers/character/leds/ktd2052.rst (100%) rename Documentation/{components => os}/drivers/character/leds/userled.rst (100%) rename Documentation/{components => os}/drivers/character/leds/ws2812.rst (100%) rename Documentation/{components => os}/drivers/character/loop.rst (100%) rename Documentation/{components => os}/drivers/character/math.rst (100%) rename Documentation/{components => os}/drivers/character/modem.rst (100%) rename Documentation/{components => os}/drivers/character/motor/foc.rst (100%) rename Documentation/{components => os}/drivers/character/motor/index.rst (100%) rename Documentation/{components => os}/drivers/character/note.rst (100%) rename Documentation/{components => os}/drivers/character/nullzero.rst (100%) rename Documentation/{components => os}/drivers/character/quadrature.rst (100%) rename Documentation/{components => os}/drivers/character/rc.rst (100%) rename Documentation/{components => os}/drivers/character/rf.rst (100%) rename Documentation/{components => os}/drivers/character/serial.rst (100%) rename Documentation/{components => os}/drivers/character/timers/capture.rst (100%) rename Documentation/{components => os}/drivers/character/timers/dshot.rst (100%) rename Documentation/{components => os}/drivers/character/timers/index.rst (100%) rename Documentation/{components => os}/drivers/character/timers/oneshot.rst (100%) rename Documentation/{components => os}/drivers/character/timers/pulsecount.rst (100%) rename Documentation/{components => os}/drivers/character/timers/pwm.rst (100%) rename Documentation/{components => os}/drivers/character/timers/rtc.rst (100%) rename Documentation/{components => os}/drivers/character/timers/timer.rst (100%) rename Documentation/{components => os}/drivers/character/timers/timer.svg (100%) rename Documentation/{components => os}/drivers/character/timers/watchdog.rst (100%) rename Documentation/{components => os}/drivers/character/touchscreen.rst (100%) rename Documentation/{components => os}/drivers/character/wireless/index.rst (100%) rename Documentation/{components => os}/drivers/character/wireless/lpwan/SX1262.jpg (100%) rename Documentation/{components => os}/drivers/character/wireless/lpwan/command_run0.jpg (100%) rename Documentation/{components => os}/drivers/character/wireless/lpwan/index.rst (100%) rename Documentation/{components => os}/drivers/character/wireless/lpwan/lora_gw.rst (100%) rename Documentation/{components => os}/drivers/character/wireless/lpwan/sx126x.rst (100%) rename Documentation/{components => os}/drivers/character/wireless/lpwan/sx127x.rst (100%) rename Documentation/{components => os}/drivers/character/wireless/wireless_ioctl_white.drawio.png (100%) rename Documentation/{implementation => os/drivers}/device_drivers.rst (100%) rename Documentation/{implementation => os/drivers}/device_nodes.rst (100%) rename Documentation/{implementation => os/drivers}/drivers_design.rst (100%) rename Documentation/{components => os}/drivers/index.rst (68%) rename Documentation/{implementation => os/drivers}/ioctl.rst (100%) rename Documentation/{components => os}/drivers/special/audio.rst (100%) rename Documentation/{components => os}/drivers/special/clk.rst (100%) rename Documentation/{components => os}/drivers/special/devfreq.rst (100%) rename Documentation/{components => os}/drivers/special/devicetree.rst (100%) rename Documentation/{components => os}/drivers/special/devmem.rst (100%) rename Documentation/{components => os}/drivers/special/dma.rst (100%) rename Documentation/{components => os}/drivers/special/framebuffer.rst (100%) rename Documentation/{components => os}/drivers/special/i2c.rst (100%) rename Documentation/{components => os}/drivers/special/i3c.rst (100%) rename Documentation/{components => os}/drivers/special/image/syslog-overview.png (100%) rename Documentation/{components => os}/drivers/special/index.rst (98%) rename Documentation/{components => os}/drivers/special/ioexpander.rst (100%) rename Documentation/{components => os}/drivers/special/lcd.rst (100%) rename Documentation/{components => os}/drivers/special/mmcsd.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/at24xx.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/at25.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/at25ee.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/at45db.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/gd25.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/gd55.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/gd5f.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/is25xp.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/m25px.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/mx25l.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/mx25r.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/mx35.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/n25q.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/s25fl1.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/sst25.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/sst26.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/sst39vf.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/w25n.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/devices/w25q.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/index.rst (100%) rename Documentation/{components => os}/drivers/special/mtd/mtd_open_flow.png (100%) rename Documentation/{components => os}/drivers/special/net/ethernet.rst (100%) rename Documentation/{components => os}/drivers/special/net/index.rst (100%) rename Documentation/{components => os}/drivers/special/net/vlan.rst (100%) rename Documentation/{components => os}/drivers/special/pci/index.rst (100%) rename Documentation/{components => os}/drivers/special/pinctrl.rst (100%) rename Documentation/{components => os}/drivers/special/pipes.rst (100%) rename Documentation/{components => os}/drivers/special/power/battery/fakegauge.rst (100%) rename Documentation/{components => os}/drivers/special/power/index.rst (75%) rename Documentation/{components => os}/drivers/special/power/pm/index.rst (100%) rename Documentation/{components => os}/drivers/special/power/pm/pm.png (100%) rename Documentation/{implementation => os/drivers/special/power}/power_management.rst (100%) rename Documentation/{components => os}/drivers/special/power/regulator.rst (100%) rename Documentation/{components => os}/drivers/special/ptp.rst (100%) rename Documentation/{components => os}/drivers/special/regmap.rst (100%) rename Documentation/{components => os}/drivers/special/reset.rst (100%) rename Documentation/{components => os}/drivers/special/rpmsg/concepts.rst (100%) rename Documentation/{components => os}/drivers/special/rpmsg/index.rst (100%) rename Documentation/{components => os}/drivers/special/rpmsg/rpmsg_dump.rst (100%) rename Documentation/{components => os}/drivers/special/rpmsg/rpmsg_ping.rst (100%) rename Documentation/{components => os}/drivers/special/rpmsg/rpmsg_port.rst (100%) rename Documentation/{components => os}/drivers/special/rpmsg/rpmsg_port_uart.rst (100%) rename Documentation/{components => os}/drivers/special/rptun/api_reference.rst (100%) rename Documentation/{components => os}/drivers/special/rptun/architecture.rst (100%) rename Documentation/{components => os}/drivers/special/rptun/driver_porting.rst (100%) rename Documentation/{components => os}/drivers/special/rptun/index.rst (100%) rename Documentation/{components => os}/drivers/special/rptun/resource_table.rst (100%) rename Documentation/{components => os}/drivers/special/rwbuffer.rst (100%) rename Documentation/{components => os}/drivers/special/sdio.rst (100%) rename Documentation/{components => os}/drivers/special/segger.rst (100%) rename Documentation/{components => os}/drivers/special/sensors.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/adt7320.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/adxl345.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/adxl362.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/adxl367.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/adxl372.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/aht10.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/ak09912.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/gnss_lowerhalf.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/l86xxx.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/lis2mdl.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/lsm330.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/lsm6ds3trc.rst (99%) rename Documentation/{components => os}/drivers/special/sensors/lsm6dso32.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/mcp9600.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/mpl115a.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/mpu6050.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/nau7802.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/qmi8658.rst (98%) rename Documentation/{components => os}/drivers/special/sensors/sensor_driver_model.png (100%) rename Documentation/{components => os}/drivers/special/sensors/sensor_monitor.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/sensors_cluster.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/sensors_legacy.rst (100%) rename Documentation/{components => os}/drivers/special/sensors/sensors_uorb.rst (99%) rename Documentation/{components => os}/drivers/special/sensors/sht4x.rst (97%) rename Documentation/{components => os}/drivers/special/sensors/tc74.rst (94%) rename Documentation/{components => os}/drivers/special/sensors/tmp112.rst (96%) rename Documentation/{components => os}/drivers/special/spi.rst (100%) rename Documentation/{components => os}/drivers/special/syslog.rst (99%) rename Documentation/{implementation/syslog.rst => os/drivers/special/syslog_design.rst} (99%) rename Documentation/{components => os}/drivers/special/sysview.png (100%) rename Documentation/{components => os}/drivers/special/usbdev.rst (100%) rename Documentation/{components => os}/drivers/special/usbhost.rst (100%) rename Documentation/{components => os}/drivers/special/usbmisc.rst (100%) rename Documentation/{components => os}/drivers/special/usbmonitor.rst (100%) rename Documentation/{components => os}/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng (100%) rename Documentation/{components => os}/drivers/special/usbmonitor_wireshark_linux_example_adb.png (100%) rename Documentation/{components => os}/drivers/special/usrsock.rst (100%) rename Documentation/{components => os}/drivers/special/uvc.rst (100%) rename Documentation/{components => os}/drivers/special/vhost/framework.rst (100%) rename Documentation/{components => os}/drivers/special/vhost/index.rst (100%) rename Documentation/{components => os}/drivers/special/video.rst (100%) rename Documentation/{components => os}/drivers/special/virtio/framework.rst (100%) rename Documentation/{components => os}/drivers/special/virtio/index.rst (100%) rename Documentation/{components => os}/drivers/special/wireless.rst (100%) rename Documentation/{components => os}/drivers/special/wireless/rn2xx3.rst (100%) rename Documentation/{components => os}/drivers/thermal/index.rst (100%) rename Documentation/{implementation => os/drivers}/usb.rst (100%) rename Documentation/{components => os}/filesystem/aio.rst (100%) rename Documentation/{components => os}/filesystem/binfs.rst (100%) rename Documentation/{implementation => os/filesystem}/chroot.rst (100%) rename Documentation/{components => os}/filesystem/cromfs.rst (100%) rename Documentation/{components => os}/filesystem/fat.rst (100%) rename Documentation/{implementation => os/filesystem}/file_descriptors.rst (100%) rename Documentation/{implementation => os/filesystem}/file_permission.rst (97%) rename Documentation/{components => os}/filesystem/hostfs.rst (100%) rename Documentation/{components => os}/filesystem/how_nxffs_works.rst (100%) rename Documentation/{components => os}/filesystem/index.rst (99%) rename Documentation/{components => os}/filesystem/inotify.rst (100%) rename Documentation/{components => os}/filesystem/littlefs.rst (100%) rename Documentation/{components => os}/filesystem/mmap.rst (100%) rename Documentation/{components => os}/filesystem/mnemofs.rst (100%) rename Documentation/{components => os}/filesystem/nfs.rst (100%) rename Documentation/{components => os}/filesystem/nuttxfs.rst (100%) rename Documentation/{components => os}/filesystem/nuttxfs/nuttxfs_page_0.png (100%) rename Documentation/{components => os}/filesystem/nuttxfs/nuttxfs_page_1.png (100%) rename Documentation/{components => os}/filesystem/nuttxfs/nuttxfs_page_2.png (100%) rename Documentation/{components => os}/filesystem/nuttxfs/nuttxfs_page_3.png (100%) rename Documentation/{components => os}/filesystem/nxffs.rst (100%) rename Documentation/{components => os}/filesystem/nxffs/nxffs_page_0.png (100%) rename Documentation/{components => os}/filesystem/nxffs/nxffs_page_1.png (100%) rename Documentation/{components => os}/filesystem/nxffs/nxffs_page_2.png (100%) rename Documentation/{components => os}/filesystem/nxflat.rst (98%) rename Documentation/{components => os}/filesystem/nxflat/nxflat-addressing.png (100%) rename Documentation/{components => os}/filesystem/partition.rst (100%) rename Documentation/{components => os}/filesystem/procfs.rst (100%) rename Documentation/{components => os}/filesystem/profiler.rst (100%) rename Documentation/{components => os}/filesystem/pseudofs.rst (100%) rename Documentation/{components => os}/filesystem/romfs.rst (100%) rename Documentation/{components => os}/filesystem/rpmsgfs.rst (100%) rename Documentation/{components => os}/filesystem/shmfs.rst (100%) rename Documentation/{components => os}/filesystem/smartfs.rst (100%) rename Documentation/{components => os}/filesystem/special_files_dev_num.rst (100%) rename Documentation/{components => os}/filesystem/spiffs.rst (100%) rename Documentation/{components => os}/filesystem/tmpfs.rst (100%) rename Documentation/{components => os}/filesystem/unionfs.rst (100%) rename Documentation/{components => os}/filesystem/userfs.rst (100%) rename Documentation/{components => os}/filesystem/v9fs.rst (100%) rename Documentation/{components => os}/filesystem/xipfs.rst (100%) rename Documentation/{components => os}/filesystem/zipfs.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/GraphicsInterfaces.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/NXOrganization.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/NuttXScreenShot.jpg (100%) rename Documentation/{components/nxgraphics => os/graphics}/appendix.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/framebuffer_char_driver.rst (99%) rename Documentation/{components/nxgraphics => os/graphics}/index.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nx.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxcursor.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxfonts.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxgl.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxtk.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxwm_threading.rst (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxwm_threading_model/nxwm_theading_model_page_0.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxwm_threading_model/nxwm_theading_model_page_1.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxwm_threading_model/nxwm_theading_model_page_2.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxwm_threading_model/nxwm_theading_model_page_3.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/nxwm_threading_model/nxwm_theading_model_page_4.png (100%) rename Documentation/{components/nxgraphics => os/graphics}/sample.rst (100%) create mode 100644 Documentation/os/index.rst rename Documentation/{implementation => os/interrupts}/bottomhalf_interrupt.rst (100%) rename Documentation/{implementation => os/interrupts}/critical_sections.rst (98%) create mode 100644 Documentation/os/interrupts/index.rst rename Documentation/{implementation => os/interrupts}/interrupt_controls.rst (100%) create mode 100644 Documentation/os/interrupts/interrupt_flow.svg rename Documentation/{reference/os => os/ipc}/events.rst (100%) create mode 100644 Documentation/os/ipc/index.rst rename Documentation/{reference/os => os/ipc}/mutex.rst (100%) rename Documentation/{implementation => os/ipc}/signal_handlers.rst (100%) rename Documentation/{implementation => os/libs}/crc.rst (100%) rename Documentation/{components => os}/libs/index.rst (96%) create mode 100644 Documentation/os/libs/libbuiltin.rst rename Documentation/{components => os}/libs/libc/index.rst (100%) rename Documentation/{components => os}/libs/libc/search.rst (100%) rename Documentation/{components => os}/libs/libc/stdbit.rst (100%) rename Documentation/{components => os}/libs/libc/stream.rst (100%) rename Documentation/{components => os}/libs/libc/zoneinfo.rst (100%) rename Documentation/{components => os}/libs/libdsp.rst (100%) rename Documentation/{components => os}/libs/libm.rst (100%) rename Documentation/{components => os}/libs/libnx/index.rst (100%) rename Documentation/{components => os}/libs/libnx/nxfonts.rst (100%) rename Documentation/{components => os}/libs/libxx.rst (100%) rename Documentation/{reference/os => os/memory}/addrenv.rst (100%) rename Documentation/{components/mm => os/memory}/index.rst (98%) rename Documentation/{reference/os => os/memory}/iob.rst (100%) rename Documentation/{implementation => os/memory}/memory_configurations.rst (82%) rename Documentation/{components => os/memory}/paging.rst (100%) rename Documentation/{components/mm => os/memory}/shm.rst (100%) rename Documentation/{components/net => os/networking}/delay_act_and_tcp_perf.rst (100%) rename Documentation/{components/net => os/networking}/index.rst (98%) rename Documentation/{components/net => os/networking}/ipfilter.rst (100%) rename Documentation/{components/net => os/networking}/mdio.rst (100%) rename Documentation/{components/net => os/networking}/nat.rst (100%) rename Documentation/{components/net => os/networking}/netdev.rst (100%) rename Documentation/{components/net => os/networking}/netdriver.rst (100%) rename Documentation/{components/net => os/networking}/netguardsize.rst (100%) rename Documentation/{components/net => os/networking}/netlink.rst (100%) rename Documentation/{reference/os => os/networking}/newreno.rst (100%) rename Documentation/{components/net => os/networking}/pkt.rst (100%) rename Documentation/{components/net => os/networking}/sixlowpan.rst (100%) rename Documentation/{components/net => os/networking}/slip.rst (100%) rename Documentation/{components/net => os/networking}/socketcan.rst (100%) rename Documentation/{components/net => os/networking}/tcp_network_perf.rst (100%) rename Documentation/{components/net => os/networking}/tcp_state_machine.rst (100%) rename Documentation/{components/net => os/networking}/wqueuedeadlocks.rst (100%) rename Documentation/{reference => }/os/notifier.rst (100%) rename Documentation/{reference => }/os/nuttx.rst (100%) rename Documentation/{components => os}/openamp.rst (100%) rename Documentation/{implementation => os/scheduling}/cancellation_points.rst (100%) rename Documentation/{implementation => os/scheduling}/context_switches.rst (100%) rename Documentation/{implementation => os/scheduling}/disabling_interrupts.png (100%) rename Documentation/{implementation => os/scheduling}/disabling_preemption.png (100%) create mode 100644 Documentation/os/scheduling/index.rst rename Documentation/{implementation => os/scheduling}/kernel_threads_vs_pthreads.rst (100%) rename Documentation/{implementation => os/scheduling}/normal_interrupt.png (100%) rename Documentation/{implementation => os/scheduling}/nuttx_tasking.rst (99%) create mode 100644 Documentation/os/scheduling/policies.svg rename Documentation/{implementation => os/scheduling}/preemption_latency.rst (100%) rename Documentation/{implementation => os/scheduling}/processes_vs_tasks.rst (100%) rename Documentation/{implementation => os/scheduling}/smp.rst (99%) rename Documentation/{implementation => os/scheduling}/task_exit_sequence.png (100%) create mode 100644 Documentation/os/scheduling/task_states.svg rename Documentation/{implementation => os/scheduling}/tasks_vs_threads.rst (100%) rename Documentation/{implementation => os/scheduling}/tls.rst (100%) rename Documentation/{implementation => os/scheduling}/user_identity.rst (100%) rename Documentation/{reference/os => os/scheduling}/wqueue.rst (100%) rename Documentation/{components => os}/syscall.rst (99%) create mode 100644 Documentation/os/system_map.svg create mode 100644 Documentation/os/time/index.rst rename Documentation/{implementation => os/time}/oneshot_timers_and_cpu_load.rst (100%) rename Documentation/{implementation => os/time}/short_delay.png (100%) rename Documentation/{implementation => os/time}/short_time_delays.rst (100%) rename Documentation/{reference/os => os/time}/sleep.rst (100%) rename Documentation/{implementation => os/time}/tickless_os.rst (100%) rename Documentation/{reference/os => os/time}/time_clock.rst (100%) rename Documentation/{components => os}/video.rst (100%) rename Documentation/{components => os}/wireless.rst (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/lincoln60/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/lincoln60/index.rst (57%) rename Documentation/platforms/arm/{lpc40xx => lpc17xx_40xx}/boards/lpc4088-devkit/README.txt (100%) rename Documentation/platforms/arm/{lpc40xx => lpc17xx_40xx}/boards/lpc4088-quickstart/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/lpcxpresso-lpc1768/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/lpcxpresso-lpc1768/index.rst (65%) rename Documentation/platforms/arm/{lpc40xx => lpc17xx_40xx}/boards/lx_cpu/README.txt (100%) rename Documentation/platforms/arm/{lpc40xx => lpc17xx_40xx}/boards/lx_cpu/index.rst (83%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/mbed/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/mbed/index.rst (81%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/mcb1700/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/mcb1700/index.rst (55%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/olimex-lpc1766stk/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/olimex-lpc1766stk/index.rst (64%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/open1788/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/open1788/index.rst (56%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/pnev5180b/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/pnev5180b/index.rst (57%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/u-blox-c027/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/u-blox-c027/index.rst (59%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/zkit-arm-1769/README.txt (100%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/boards/zkit-arm-1769/index.rst (61%) rename Documentation/platforms/arm/{lpc17xx => lpc17xx_40xx}/index.rst (99%) rename Documentation/platforms/arm/{lpc40xx/index.rst => lpc17xx_40xx/lpc40xx.rst} (90%) rename Documentation/platforms/arm/mps/boards/{mps2-an512 => mps2-an521}/index.rst (96%) rename Documentation/platforms/arm/nrf52/boards/nrf52-feather/{intex.rst => index.rst} (96%) rename Documentation/platforms/arm/{ra4m1 => ra4}/boards/arduino-r4-minima/arduino-r4-minima.png (100%) rename Documentation/platforms/arm/{ra4m1 => ra4}/boards/arduino-r4-minima/index.rst (99%) rename Documentation/platforms/arm/{ra4m1 => ra4}/boards/xiao-ra4m1/index.rst (98%) rename Documentation/platforms/arm/{ra4m1 => ra4}/boards/xiao-ra4m1/xiao-ra4m1.jpg (100%) rename Documentation/platforms/arm/{ra4m1 => ra4}/index.rst (100%) rename Documentation/platforms/arm/stm32f1/boards/{hymini-stm32 => hymini-stm32v}/index.rst (99%) rename Documentation/platforms/mips/jz4780/boards/{mips-creator-ci20 => ci20}/ci20.jpg (100%) rename Documentation/platforms/mips/jz4780/boards/{mips-creator-ci20 => ci20}/index.rst (97%) rename Documentation/platforms/{misco => misoc}/index.rst (100%) rename Documentation/platforms/{misco => misoc}/lm32/boards/misoc/index.rst (98%) rename Documentation/platforms/{misco => misoc}/lm32/index.rst (100%) rename Documentation/platforms/tricore/tc397/boards/{kit_a2g_tc397_tft => a2g-tc397-5v-tft}/index.rst (97%) rename Documentation/platforms/tricore/{tc4d9 => tc4da}/boards/triboard_tc4x9_com/index.rst (96%) rename Documentation/platforms/tricore/{tc4d9 => tc4da}/index.rst (100%) rename Documentation/platforms/x86_64/{intel64 => qemu}/boards/qemu-intel64/index.rst (99%) create mode 100644 Documentation/platforms/x86_64/qemu/index.rst create mode 100644 Documentation/redirects.py diff --git a/Documentation/Pipfile b/Documentation/Pipfile index daaaf3c1fa8..53e3b6e219f 100644 --- a/Documentation/Pipfile +++ b/Documentation/Pipfile @@ -20,3 +20,4 @@ sphinx-design = "*" sphinx-collapse = "*" MarkupSafe = "*" sphinxcontrib-plantuml = "*" +sphinx-reredirects = "*" diff --git a/Documentation/Pipfile.lock b/Documentation/Pipfile.lock index 0343ff1cdc2..d244e68ea6b 100644 --- a/Documentation/Pipfile.lock +++ b/Documentation/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "c3e9083ad4009c6152921cc3a66a940f1d5c532734fd2966870b833bca8e7b3e" + "sha256": "2427e139cd829e796455b87b44b8d8698fae764025ac98722fa344f12b925c40" }, "pipfile-spec": 6, "requires": {}, @@ -645,6 +645,15 @@ "markers": "python_version >= '3.9'", "version": "==0.6.1" }, + "sphinx-reredirects": { + "hashes": [ + "sha256:b8effdb31a069823cd8b5b029bfe1e04ac584615a0ebea35c5a8c8daf05a354b", + "sha256:f27995e233a62336fc254330543d8b0f779ec83089da36274e27f5a5f2d5f529" + ], + "index": "pypi", + "markers": "python_version >= '3.5'", + "version": "==0.1.4" + }, "sphinx-rtd-theme": { "hashes": [ "sha256:1785824ae8e6632060490f67cf3a72d404a85d2d9fc26bce3619944de5682b89", diff --git a/Documentation/ReleaseNotes/NuttX-0.1.0 b/Documentation/ReleaseNotes/NuttX-0.1.0.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.1.0 rename to Documentation/ReleaseNotes/NuttX-0.1.0.md index 414f2530142..caeea18f54e 100644 --- a/Documentation/ReleaseNotes/NuttX-0.1.0 +++ b/Documentation/ReleaseNotes/NuttX-0.1.0.md @@ -1,5 +1,5 @@ NuttX-0.1.0 ------------ +=========== This is the initial. This initial includes the complete NuttX RTOS with support for the Linux user mode simulation and the TI TMS320C5471 diff --git a/Documentation/ReleaseNotes/NuttX-0.1.1 b/Documentation/ReleaseNotes/NuttX-0.1.1.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.1.1 rename to Documentation/ReleaseNotes/NuttX-0.1.1.md index 923cfd70c98..c47bd585d1d 100644 --- a/Documentation/ReleaseNotes/NuttX-0.1.1 +++ b/Documentation/ReleaseNotes/NuttX-0.1.1.md @@ -1,5 +1,5 @@ NuttX-0.1.1 ------------ +=========== This is the second release of NuttX. This release includes the following. See the ChangeLog for more detailed description of the changes. diff --git a/Documentation/ReleaseNotes/NuttX-0.1.2 b/Documentation/ReleaseNotes/NuttX-0.1.2.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.1.2 rename to Documentation/ReleaseNotes/NuttX-0.1.2.md index a46d2fc8c7a..fb9098a44f6 100644 --- a/Documentation/ReleaseNotes/NuttX-0.1.2 +++ b/Documentation/ReleaseNotes/NuttX-0.1.2.md @@ -1,5 +1,5 @@ NuttX-0.1.2 ------------ +=========== This is the third release of NuttX. This release is primarily a bugfix release with minimal new features. See diff --git a/Documentation/ReleaseNotes/NuttX-0.2.1 b/Documentation/ReleaseNotes/NuttX-0.2.1.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.2.1 rename to Documentation/ReleaseNotes/NuttX-0.2.1.md index 116f6a0393a..a061f8d1b2a 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.1 +++ b/Documentation/ReleaseNotes/NuttX-0.2.1.md @@ -1,5 +1,5 @@ NuttX-0.2.1 ------------ +=========== This is the fourth release of NuttX. This release adds adds support for a new platform, restructures many header files, diff --git a/Documentation/ReleaseNotes/NuttX-0.2.2 b/Documentation/ReleaseNotes/NuttX-0.2.2.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.2.2 rename to Documentation/ReleaseNotes/NuttX-0.2.2.md index cbf310f331e..8d70ee3d804 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.2 +++ b/Documentation/ReleaseNotes/NuttX-0.2.2.md @@ -1,5 +1,5 @@ NuttX-0.2.2 ------------- +============ This is the fifth release of NuttX. There is no major new functionality in this release. This release adds support diff --git a/Documentation/ReleaseNotes/NuttX-0.2.3 b/Documentation/ReleaseNotes/NuttX-0.2.3.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.2.3 rename to Documentation/ReleaseNotes/NuttX-0.2.3.md index 8004c924591..28f3b3c65d2 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.3 +++ b/Documentation/ReleaseNotes/NuttX-0.2.3.md @@ -1,5 +1,5 @@ NuttX-0.2.3 ------------- +============ This is the sixth release of NuttX. This release is primarily a bugfix release. Numerous problems were fixed diff --git a/Documentation/ReleaseNotes/NuttX-0.2.4 b/Documentation/ReleaseNotes/NuttX-0.2.4.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.2.4 rename to Documentation/ReleaseNotes/NuttX-0.2.4.md index e354bd3efad..48702f2c79e 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.4 +++ b/Documentation/ReleaseNotes/NuttX-0.2.4.md @@ -1,5 +1,5 @@ NuttX-0.2.4 ------------- +============ This is the 7th release of NuttX. This release is only to roll out build changes to better support different SoC's that use the same diff --git a/Documentation/ReleaseNotes/NuttX-0.2.5 b/Documentation/ReleaseNotes/NuttX-0.2.5.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.2.5 rename to Documentation/ReleaseNotes/NuttX-0.2.5.md index b3aea48896f..9b863a86f22 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.5 +++ b/Documentation/ReleaseNotes/NuttX-0.2.5.md @@ -1,5 +1,5 @@ NuttX-0.2.5 ------------- +============ This is the 8th release of NuttX. This release includes: diff --git a/Documentation/ReleaseNotes/NuttX-0.2.6 b/Documentation/ReleaseNotes/NuttX-0.2.6.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.2.6 rename to Documentation/ReleaseNotes/NuttX-0.2.6.md index 34ec8855563..d7f69719720 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.6 +++ b/Documentation/ReleaseNotes/NuttX-0.2.6.md @@ -1,5 +1,5 @@ NuttX-0.2.6 ------------ +=========== This is the 9th release of NuttX. This is primarily a bugfix release to correct a number of problems introduced diff --git a/Documentation/ReleaseNotes/NuttX-0.2.7 b/Documentation/ReleaseNotes/NuttX-0.2.7.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.2.7 rename to Documentation/ReleaseNotes/NuttX-0.2.7.md index 464c1de9876..76cc94ab6e1 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.7 +++ b/Documentation/ReleaseNotes/NuttX-0.2.7.md @@ -1,5 +1,5 @@ NuttX-0.2.7 ------------ +=========== This is the 10th release of NuttX. This is primarily a bugfix release to correct a number of problems reported to me (thanks diff --git a/Documentation/ReleaseNotes/NuttX-0.2.8 b/Documentation/ReleaseNotes/NuttX-0.2.8.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.2.8 rename to Documentation/ReleaseNotes/NuttX-0.2.8.md index 39bdd604487..f8e084f88f8 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.8 +++ b/Documentation/ReleaseNotes/NuttX-0.2.8.md @@ -1,5 +1,5 @@ NuttX-0.2.8 ------------ +=========== This is the 11th release of NuttX. This release: (1) corrects important bugs in opendir() and realloc() diff --git a/Documentation/ReleaseNotes/NuttX-0.2.9 b/Documentation/ReleaseNotes/NuttX-0.2.9.md similarity index 94% rename from Documentation/ReleaseNotes/NuttX-0.2.9 rename to Documentation/ReleaseNotes/NuttX-0.2.9.md index 39bdd604487..25535cb25f5 100644 --- a/Documentation/ReleaseNotes/NuttX-0.2.9 +++ b/Documentation/ReleaseNotes/NuttX-0.2.9.md @@ -1,5 +1,5 @@ -NuttX-0.2.8 ------------ +NuttX-0.2.9 +=========== This is the 11th release of NuttX. This release: (1) corrects important bugs in opendir() and realloc() diff --git a/Documentation/ReleaseNotes/NuttX-0.3.0 b/Documentation/ReleaseNotes/NuttX-0.3.0.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.0 rename to Documentation/ReleaseNotes/NuttX-0.3.0.md index d06b959f38c..2b061f31d1a 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.0 +++ b/Documentation/ReleaseNotes/NuttX-0.3.0.md @@ -1,5 +1,5 @@ NuttX-0.3.0 ------------ +=========== This is the 12th release of NuttX. This release includes the initial integration of a network subsystem and the uIP TCP/IP stack into NuttX diff --git a/Documentation/ReleaseNotes/NuttX-0.3.1 b/Documentation/ReleaseNotes/NuttX-0.3.1.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.1 rename to Documentation/ReleaseNotes/NuttX-0.3.1.md index f0ce43b6262..d0b0b8cab9c 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.1 +++ b/Documentation/ReleaseNotes/NuttX-0.3.1.md @@ -1,5 +1,5 @@ NuttX-0.3.1 ------------ +=========== This is the 13th release of NuttX and the second release containing the integration of a network subsystem and the uIP TCP/IP, UDP, and diff --git a/Documentation/ReleaseNotes/NuttX-0.3.10 b/Documentation/ReleaseNotes/NuttX-0.3.10.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.3.10 rename to Documentation/ReleaseNotes/NuttX-0.3.10.md index 064267e233b..681944ef2ba 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.10 +++ b/Documentation/ReleaseNotes/NuttX-0.3.10.md @@ -1,5 +1,5 @@ NuttX-0.3.10 ------------- +============ This is the 22nd release of NuttX. This is an important bug fix release. This release incorporates fixes to correct critical list diff --git a/Documentation/ReleaseNotes/NuttX-0.3.11 b/Documentation/ReleaseNotes/NuttX-0.3.11.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.11 rename to Documentation/ReleaseNotes/NuttX-0.3.11.md index 29a304e09ac..32673824bae 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.11 +++ b/Documentation/ReleaseNotes/NuttX-0.3.11.md @@ -1,5 +1,5 @@ NuttX-0.3.11 ------------- +============ This is the 23rd release of NuttX. This is another important bugfix release. This releases fixes several bugs: diff --git a/Documentation/ReleaseNotes/NuttX-0.3.12 b/Documentation/ReleaseNotes/NuttX-0.3.12.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.12 rename to Documentation/ReleaseNotes/NuttX-0.3.12.md index ad759ea94a4..a6e5801126c 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.12 +++ b/Documentation/ReleaseNotes/NuttX-0.3.12.md @@ -1,5 +1,5 @@ NuttX-0.3.12 ------------- +============ This is the 24th release of NuttX. This release includes some minor bugfixes as well as a few new features. Bugs fixed include: diff --git a/Documentation/ReleaseNotes/NuttX-0.3.13 b/Documentation/ReleaseNotes/NuttX-0.3.13.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.3.13 rename to Documentation/ReleaseNotes/NuttX-0.3.13.md index 1f217fe57bf..d03773c6120 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.13 +++ b/Documentation/ReleaseNotes/NuttX-0.3.13.md @@ -1,5 +1,5 @@ NuttX-0.3.13 ------------- +============ This is the 25th release of NuttX. This release includes some important bugfixes as well as a few new features. Bugs fixed diff --git a/Documentation/ReleaseNotes/NuttX-0.3.14 b/Documentation/ReleaseNotes/NuttX-0.3.14.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.3.14 rename to Documentation/ReleaseNotes/NuttX-0.3.14.md index 1d026516795..e86db013134 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.14 +++ b/Documentation/ReleaseNotes/NuttX-0.3.14.md @@ -1,5 +1,5 @@ NuttX-0.3.14 ------------ +=========== This is the 26th release of NuttX. This release includes some important bugfixes as well as a few new features. Critical bugs diff --git a/Documentation/ReleaseNotes/NuttX-0.3.15 b/Documentation/ReleaseNotes/NuttX-0.3.15.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.15 rename to Documentation/ReleaseNotes/NuttX-0.3.15.md index f7edfd79848..d746ec70c4c 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.15 +++ b/Documentation/ReleaseNotes/NuttX-0.3.15.md @@ -1,5 +1,5 @@ NuttX-0.3.15 ------------ +=========== This is the 27th release of NuttX. This release includes some new features: diff --git a/Documentation/ReleaseNotes/NuttX-0.3.16 b/Documentation/ReleaseNotes/NuttX-0.3.16.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.16 rename to Documentation/ReleaseNotes/NuttX-0.3.16.md index 897f2eeccc6..a3e9e1ea376 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.16 +++ b/Documentation/ReleaseNotes/NuttX-0.3.16.md @@ -1,5 +1,5 @@ NuttX-0.3.16 ------------ +=========== This is the 28th release of NuttX. This release includes the first support for USB in NuttX. A set of USB APIs were added to support @@ -41,6 +41,7 @@ UPDATE This release does not build for the ARM target when USB is disabled. Here is the fix: +```diff Index: arch/arm/src/common/up_internal.h =================================================================== RCS file: /cvsroot/nuttx/nuttx/arch/arm/src/common/up_internal.h,v @@ -58,3 +59,4 @@ extern void up_usbuninitialize(void); #endif #endif /* __ASSEMBLY__ */ +``` diff --git a/Documentation/ReleaseNotes/NuttX-0.3.17 b/Documentation/ReleaseNotes/NuttX-0.3.17.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.17 rename to Documentation/ReleaseNotes/NuttX-0.3.17.md index 9be4ee14ace..d53e9bf1630 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.17 +++ b/Documentation/ReleaseNotes/NuttX-0.3.17.md @@ -1,5 +1,5 @@ NuttX-0.3.17 ------------- +============ This is the 29th release of NuttX. This release includes the additional support for USB in NuttX. The following new features diff --git a/Documentation/ReleaseNotes/NuttX-0.3.18 b/Documentation/ReleaseNotes/NuttX-0.3.18.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.3.18 rename to Documentation/ReleaseNotes/NuttX-0.3.18.md index 6c07af796af..a254414ac59 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.18 +++ b/Documentation/ReleaseNotes/NuttX-0.3.18.md @@ -1,5 +1,5 @@ NuttX-0.3.18 ------------- +============ This is the 30th release of NuttX. This release includes two partially completed ports, several new features, and a couple of diff --git a/Documentation/ReleaseNotes/NuttX-0.3.19 b/Documentation/ReleaseNotes/NuttX-0.3.19.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.3.19 rename to Documentation/ReleaseNotes/NuttX-0.3.19.md index 432b2e063de..a8897d0c151 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.19 +++ b/Documentation/ReleaseNotes/NuttX-0.3.19.md @@ -1,5 +1,5 @@ NuttX-0.3.19 ------------- +============ This is the 31st release of NuttX. This release includes the following new feature: diff --git a/Documentation/ReleaseNotes/NuttX-0.3.2 b/Documentation/ReleaseNotes/NuttX-0.3.2.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.2 rename to Documentation/ReleaseNotes/NuttX-0.3.2.md index 0f281f3b124..ebd020658d3 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.2 +++ b/Documentation/ReleaseNotes/NuttX-0.3.2.md @@ -1,5 +1,5 @@ NuttX-0.3.2 ------------ +=========== This is the 14th release of NuttX and the 3rd release containing the integration of a network subsystem and the uIP TCP/IP, UDP, and diff --git a/Documentation/ReleaseNotes/NuttX-0.3.3 b/Documentation/ReleaseNotes/NuttX-0.3.3.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.3.3 rename to Documentation/ReleaseNotes/NuttX-0.3.3.md index fdf8d7772e5..a4bc1bbdf84 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.3 +++ b/Documentation/ReleaseNotes/NuttX-0.3.3.md @@ -1,5 +1,5 @@ NuttX-0.3.3 ------------ +=========== This is the 15th release of NuttX and the 4th release containing the integration of a network subsystem and the uIP TCP/IP, UDP, and diff --git a/Documentation/ReleaseNotes/NuttX-0.3.4 b/Documentation/ReleaseNotes/NuttX-0.3.4.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.4 rename to Documentation/ReleaseNotes/NuttX-0.3.4.md index 30008178ce3..b5d2e18cff1 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.4 +++ b/Documentation/ReleaseNotes/NuttX-0.3.4.md @@ -1,5 +1,5 @@ NuttX-0.3.4 ------------ +=========== This is the 16th release of NuttX and the 5th release containing the integration of a network subsystem and the uIP TCP/IP, UDP, and diff --git a/Documentation/ReleaseNotes/NuttX-0.3.5 b/Documentation/ReleaseNotes/NuttX-0.3.5.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.3.5 rename to Documentation/ReleaseNotes/NuttX-0.3.5.md index 54136fd7d75..49cbe877044 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.5 +++ b/Documentation/ReleaseNotes/NuttX-0.3.5.md @@ -1,5 +1,5 @@ NuttX-0.3.5 ------------ +=========== This is the 17th release of NuttX this release is primarily a bug-fix release and intended to synchronize with the current CVS contents. See diff --git a/Documentation/ReleaseNotes/NuttX-0.3.6 b/Documentation/ReleaseNotes/NuttX-0.3.6.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.3.6 rename to Documentation/ReleaseNotes/NuttX-0.3.6.md index 9ec31340e35..c22aeb6f5c2 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.6 +++ b/Documentation/ReleaseNotes/NuttX-0.3.6.md @@ -1,5 +1,5 @@ NuttX-0.3.6 ------------ +=========== This is the 18th release of NuttX. This release contains on a few changes. The primary purpose of this release is to synchronize with diff --git a/Documentation/ReleaseNotes/NuttX-0.3.7 b/Documentation/ReleaseNotes/NuttX-0.3.7.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.3.7 rename to Documentation/ReleaseNotes/NuttX-0.3.7.md index 2eeabf4d8c5..faf81bb1b74 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.7 +++ b/Documentation/ReleaseNotes/NuttX-0.3.7.md @@ -1,5 +1,5 @@ NuttX-0.3.7 ------------ +=========== This is the 19th release of NuttX. This release includes the preliminary port of NuttX to the ZiLOG z16f 16-bit microcontroller. diff --git a/Documentation/ReleaseNotes/NuttX-0.3.8 b/Documentation/ReleaseNotes/NuttX-0.3.8.md similarity index 96% rename from Documentation/ReleaseNotes/NuttX-0.3.8 rename to Documentation/ReleaseNotes/NuttX-0.3.8.md index 5b6c4d06647..03e11b5b827 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.8 +++ b/Documentation/ReleaseNotes/NuttX-0.3.8.md @@ -1,5 +1,5 @@ NuttX-0.3.8 ------------ +=========== This is the 20th release of NuttX. This is a minor bugfix release. It corrects a few minor problems, adds a few minor features, and diff --git a/Documentation/ReleaseNotes/NuttX-0.3.9 b/Documentation/ReleaseNotes/NuttX-0.3.9.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.3.9 rename to Documentation/ReleaseNotes/NuttX-0.3.9.md index e3d90da61ae..5b9338c0542 100644 --- a/Documentation/ReleaseNotes/NuttX-0.3.9 +++ b/Documentation/ReleaseNotes/NuttX-0.3.9.md @@ -1,5 +1,5 @@ NuttX-0.3.9 ------------ +=========== This is the 21st release of NuttX. This is a minor future enhancement release. This release includes support for the ZiLOG Z8Encore! micro- diff --git a/Documentation/ReleaseNotes/NuttX-0.4.0 b/Documentation/ReleaseNotes/NuttX-0.4.0.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.0 rename to Documentation/ReleaseNotes/NuttX-0.4.0.md index 320958a2933..3fee49c23b6 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.0 +++ b/Documentation/ReleaseNotes/NuttX-0.4.0.md @@ -1,5 +1,5 @@ NuttX-0.4.0 ------------ +=========== This is the 32nd release of NuttX. This release adds graphics support and a tiny windowing subsystem. That new graphics subsystem diff --git a/Documentation/ReleaseNotes/NuttX-0.4.1 b/Documentation/ReleaseNotes/NuttX-0.4.1.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.1 rename to Documentation/ReleaseNotes/NuttX-0.4.1.md index d18724ec844..3130d085526 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.1 +++ b/Documentation/ReleaseNotes/NuttX-0.4.1.md @@ -1,5 +1,5 @@ NuttX-0.4.1 ------------ +=========== This is the 33rd release of NuttX. This is a minor bugfix release. The primary reason for this release is to correct numerous build diff --git a/Documentation/ReleaseNotes/NuttX-0.4.10 b/Documentation/ReleaseNotes/NuttX-0.4.10.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.10 rename to Documentation/ReleaseNotes/NuttX-0.4.10.md index be7d8b96a40..bbc4631410a 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.10 +++ b/Documentation/ReleaseNotes/NuttX-0.4.10.md @@ -1,5 +1,5 @@ NuttX-0.4.10 ------------- +============ This is the 42nd release of NuttX. This released focused on the port of Jeff Poskanzer's THTTPD HTTP server (see diff --git a/Documentation/ReleaseNotes/NuttX-0.4.11 b/Documentation/ReleaseNotes/NuttX-0.4.11.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.11 rename to Documentation/ReleaseNotes/NuttX-0.4.11.md index 79f57789ad9..259aa3833b3 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.11 +++ b/Documentation/ReleaseNotes/NuttX-0.4.11.md @@ -1,5 +1,5 @@ NuttX-0.4.11 ------------- +============ This is the 43rd release of NuttX. This release of NuttX incorporates the verified port of Jeff Poskanzer's THTTPD HTTP server (see diff --git a/Documentation/ReleaseNotes/NuttX-0.4.12 b/Documentation/ReleaseNotes/NuttX-0.4.12.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.12 rename to Documentation/ReleaseNotes/NuttX-0.4.12.md index 4820f86bed5..1681c7e746b 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.12 +++ b/Documentation/ReleaseNotes/NuttX-0.4.12.md @@ -1,5 +1,5 @@ NuttX-0.4.12 ------------- +============ This is the 44th release of NuttX. This release adds basic support for the STMicro STM32, Cortex-M3 MCU. The specific port is to the diff --git a/Documentation/ReleaseNotes/NuttX-0.4.13 b/Documentation/ReleaseNotes/NuttX-0.4.13.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-0.4.13 rename to Documentation/ReleaseNotes/NuttX-0.4.13.md index 444e10590f2..ef44548a635 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.13 +++ b/Documentation/ReleaseNotes/NuttX-0.4.13.md @@ -1,5 +1,5 @@ NuttX-0.4.13 ------------- +============ This is the 45th release of NuttX. The release extends the support for the STMicro STM32 microcontroller. Minimal support for the diff --git a/Documentation/ReleaseNotes/NuttX-0.4.2 b/Documentation/ReleaseNotes/NuttX-0.4.2.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.2 rename to Documentation/ReleaseNotes/NuttX-0.4.2.md index f7fc79f2291..52bda378565 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.2 +++ b/Documentation/ReleaseNotes/NuttX-0.4.2.md @@ -1,5 +1,5 @@ NuttX-0.4.2 ------------ +=========== This is the 34th release of NuttX. This release adds no new OS features but does include support for two new architectures: diff --git a/Documentation/ReleaseNotes/NuttX-0.4.3 b/Documentation/ReleaseNotes/NuttX-0.4.3.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.3 rename to Documentation/ReleaseNotes/NuttX-0.4.3.md index 51ac2b6553a..ba2e1f8ad62 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.3 +++ b/Documentation/ReleaseNotes/NuttX-0.4.3.md @@ -1,5 +1,5 @@ NuttX-0.4.3 ------------ +=========== This is the 35th release of NuttX. This release one important new OS feature and corrects and extends the eZ80 port: diff --git a/Documentation/ReleaseNotes/NuttX-0.4.4 b/Documentation/ReleaseNotes/NuttX-0.4.4.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.4 rename to Documentation/ReleaseNotes/NuttX-0.4.4.md index c1958c65347..4a435a7b853 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.4 +++ b/Documentation/ReleaseNotes/NuttX-0.4.4.md @@ -1,5 +1,5 @@ NuttX-0.4.4 ------------ +=========== This is the 36th release of NuttX. This release focuses on bugfixes and extending and verifying certain networking features. diff --git a/Documentation/ReleaseNotes/NuttX-0.4.5 b/Documentation/ReleaseNotes/NuttX-0.4.5.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.5 rename to Documentation/ReleaseNotes/NuttX-0.4.5.md index 8f8d455804e..d57e3ed0d70 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.5 +++ b/Documentation/ReleaseNotes/NuttX-0.4.5.md @@ -1,5 +1,5 @@ NuttX-0.4.5 ------------ +=========== This is the 37th release of NuttX. This release focuses on a few new features. diff --git a/Documentation/ReleaseNotes/NuttX-0.4.6 b/Documentation/ReleaseNotes/NuttX-0.4.6.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.6 rename to Documentation/ReleaseNotes/NuttX-0.4.6.md index dada9c01c43..e98edef3cce 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.6 +++ b/Documentation/ReleaseNotes/NuttX-0.4.6.md @@ -1,5 +1,5 @@ NuttX-0.4.6 ------------ +=========== This is the 38th release of NuttX. The release features support for the Micromint Eagle-100 development board. This board is based diff --git a/Documentation/ReleaseNotes/NuttX-0.4.7 b/Documentation/ReleaseNotes/NuttX-0.4.7.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.7 rename to Documentation/ReleaseNotes/NuttX-0.4.7.md index 7547f3573c6..f2ccb4d9c01 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.7 +++ b/Documentation/ReleaseNotes/NuttX-0.4.7.md @@ -1,5 +1,5 @@ NuttX-0.4.7 ------------ +=========== This is the 39th release of NuttX. This release focuses on cleaning up and extending the Eagle100/LM3S6918 port released in nuttx-0.4.6 diff --git a/Documentation/ReleaseNotes/NuttX-0.4.8 b/Documentation/ReleaseNotes/NuttX-0.4.8.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-0.4.8 rename to Documentation/ReleaseNotes/NuttX-0.4.8.md index 1c99484a28e..1419de5934c 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.8 +++ b/Documentation/ReleaseNotes/NuttX-0.4.8.md @@ -1,5 +1,5 @@ NuttX-0.4.8 ------------ +=========== This is the 40th release of NuttX. This release adds: diff --git a/Documentation/ReleaseNotes/NuttX-0.4.9 b/Documentation/ReleaseNotes/NuttX-0.4.9.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-0.4.9 rename to Documentation/ReleaseNotes/NuttX-0.4.9.md index 94525859c15..37f6e8a45c1 100644 --- a/Documentation/ReleaseNotes/NuttX-0.4.9 +++ b/Documentation/ReleaseNotes/NuttX-0.4.9.md @@ -1,5 +1,5 @@ NuttX-0.4.9 ------------ +=========== This is the 41st release of NuttX. This release adds: diff --git a/Documentation/ReleaseNotes/NuttX-10.0.0 b/Documentation/ReleaseNotes/NuttX-10.0.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-10.0.0 rename to Documentation/ReleaseNotes/NuttX-10.0.0.md index 690a5d11295..0020de59a3b 100644 --- a/Documentation/ReleaseNotes/NuttX-10.0.0 +++ b/Documentation/ReleaseNotes/NuttX-10.0.0.md @@ -1,5 +1,5 @@ NuttX-10.0.0 ------------- +============ ## Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-10.1.0 b/Documentation/ReleaseNotes/NuttX-10.1.0.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-10.1.0 rename to Documentation/ReleaseNotes/NuttX-10.1.0.md index b5e434fdba0..301ddef458c 100644 --- a/Documentation/ReleaseNotes/NuttX-10.1.0 +++ b/Documentation/ReleaseNotes/NuttX-10.1.0.md @@ -1,9 +1,9 @@ NuttX-10.1.0 ------------- +============ -# What's New In This Release +## What's New In This Release -## Highlights +### Highlights * Better separation between kernel and userspace. * Heap and stack management improvements. @@ -16,14 +16,14 @@ NuttX-10.1.0 * Thousands of NuttX files converted to Apache 2.0 License with permission of their authors. * Improved listing of 3rd party licenses used in NuttX (see LICENSE, NOTICE, and DISCLAIMER-WIP files). -## Major Changes to Core OS +### Major Changes to Core OS -### New Features +#### New Features * [#2324](https://github.com/apache/nuttx/pull/2324) audio: libsamplerate: add initial audio Sample Rate Converter * [#2820](https://github.com/apache/nuttx/pull/2820) arch, boards, drivers, include, sched, wireless: Change spinlock APIs. * [#2885](https://github.com/apache/nuttx/pull/2885) Ensure the kernel component don't call userspace API -### Bug Fixes +#### Bug Fixes * [#1852](https://github.com/apache/nuttx/pull/1852) sysconf: add _SC_PAGESIZE sysconf support * [#1922](https://github.com/apache/nuttx/pull/1922) sched: nxtask_start should call entry point directly for kernel thread * [#1994](https://github.com/apache/nuttx/pull/1994) libc: Don't fclose and fopen file in freopen @@ -133,16 +133,16 @@ NuttX-10.1.0 * [#3445](https://github.com/apache/nuttx/pull/3445) libc: update stream getoffset to handle write case * [#3447](https://github.com/apache/nuttx/pull/2450) libc: correct zoneinfo genromfs source directory -## Major Changes to the Build System +### Major Changes to the Build System -### New Features +#### New Features * [#1834](https://github.com/apache/nuttx/pull/1834) License/authorship handling scripts * [#2107](https://github.com/apache/nuttx/pull/2107) build: Makefile should reference CONFIG_HOST_xxx * [#2392](https://github.com/apache/nuttx/pull/2392) configure.sh: support custom board build config with absolute path * [#2824](https://github.com/apache/nuttx/pull/2824) build/esp32: Create Flash size configuration and a new DOWNLOAD make target * [#3317](https://github.com/apache/nuttx/pull/3317) tols: Update python scripts to py3 and lint all of them against Black -### Bug Fixes +#### Bug Fixes * [#1890](https://github.com/apache/nuttx/pull/1890) make/expression: improving up asm/C/C++ compile times(make with multi-jobs only) * [#1940](https://github.com/apache/nuttx/pull/1940) cygwin build - path issue fix for Renesas arch * [#2032](https://github.com/apache/nuttx/pull/2032) build: Change .external_dummy to dummy @@ -171,9 +171,9 @@ NuttX-10.1.0 * [#3017](https://github.com/apache/nuttx/pull/3017) tools: esp32: [Config.mk](http://Config.mk): Revert part of "Don't abort make when QEMU script fails" * [#3094](https://github.com/apache/nuttx/pull/3094) tools: version.sh: Fix PATCH including extra version -## Architectural Support +### Architectural Support -### New Architectures +#### New Architectures * [#1995](https://github.com/apache/nuttx/pull/1995) arch: Add custom arch chip build support * [#2161](https://github.com/apache/nuttx/pull/2161) Added Support for more TI Tiva Microcontrollers: TM4C123GH6PZ, TM4C123GH6PGE, TM4C129ENCPDT, and TM4C129ENCZAD. * [#2566](https://github.com/apache/nuttx/pull/2566) arch/risc-v: Add BL602 support @@ -181,9 +181,9 @@ NuttX-10.1.0 * [#3001](https://github.com/apache/nuttx/pull/3001) arch:riscv64:basic porting for C906 * [#3023](https://github.com/apache/nuttx/pull/3023) Remove nr5m100 and gap8 support -### Architectures with significant improvements +#### Architectures with significant improvements -#### ARM +##### ARM * [#2042](https://github.com/apache/nuttx/pull/2042) Fix interrupt stack handlings for ARM SMP * [#2061](https://github.com/apache/nuttx/pull/2061) Refactor arm interrupt stack related code * [#2309](https://github.com/apache/nuttx/pull/2309) Fix armv7-a L2CC and apply the code to the sabre-6quad board @@ -192,7 +192,7 @@ NuttX-10.1.0 * [#2944](https://github.com/apache/nuttx/pull/2944) armv8-m: Fix EXC_RETURN for non-secure usage * [#2990](https://github.com/apache/nuttx/pull/2990) arch/armv7-m: Adds dwt helper functions for controlling watchpoints i… -#### BL602 +##### BL602 * [#2614](https://github.com/apache/nuttx/pull/2614) bl602: Update register maps and lower half drivers * [#2633](https://github.com/apache/nuttx/pull/2633) BL602: Add support for system reset modes * [#2655](https://github.com/apache/nuttx/pull/2655) arch/risc-v/bl602 : add pwm onshot watchdog driver @@ -203,11 +203,11 @@ NuttX-10.1.0 * [#2836](https://github.com/apache/nuttx/pull/2836) :risc-v:bl602:add support for elf file apps * [#2991](https://github.com/apache/nuttx/pull/2991) risc-v/bl602: Add wifi and ble support -#### CXD56XX +##### CXD56XX * [#2750](https://github.com/apache/nuttx/pull/2750) arch: cxd56xx: Add i2c bitbang lower driver * [#2830](https://github.com/apache/nuttx/pull/2830) Driver-specific spinlock for cxd56_serial.c -#### ESP32 +##### ESP32 * [#1893](https://github.com/apache/nuttx/pull/1893) Add ESP32 WiFi adapter and driver * [#1942](https://github.com/apache/nuttx/pull/1942) Implement BASIC reset logic * [#1945](https://github.com/apache/nuttx/pull/1945) Added Timer Support @@ -242,7 +242,7 @@ NuttX-10.1.0 * [#3048](https://github.com/apache/nuttx/pull/3048) timer driver refactor * [#3233](https://github.com/apache/nuttx/pull/3233) Bugfixes and Improvements for SPI DMA Exchange function -#### ESP32C3 +##### ESP32C3 * [#2870](https://github.com/apache/nuttx/pull/2870) Support for ESP32-C3 GPIO Driver * [#2875](https://github.com/apache/nuttx/pull/2875) risc-v/esp32c3: Add support for Main System Watchdog Timer * [#2901](https://github.com/apache/nuttx/pull/2901) esp32c3: Add system reset. @@ -255,17 +255,17 @@ NuttX-10.1.0 * [#3126](https://github.com/apache/nuttx/pull/3126) risc-v/esp32-c3: Add support to SPI Flash * [#3160](https://github.com/apache/nuttx/pull/3160) riscv/esp32c3: Add standard C atomic function -#### IMX6 +##### IMX6 * [#2595](https://github.com/apache/nuttx/pull/2595) Add imx_enet driver -#### IMXRT +##### IMXRT * [#2212](https://github.com/apache/nuttx/pull/2212) imxrt: adds support for WDOG1 * [#2354](https://github.com/apache/nuttx/pull/2354) imxrt: Added support for DP83825I PHY * [#2461](https://github.com/apache/nuttx/pull/2461) imxrt: Added NETDEV_LATEINIT option for Ethernet * [#2471](https://github.com/apache/nuttx/pull/2471) imxrt: Support serial single-wire mode and fix parity settings * [#2929](https://github.com/apache/nuttx/pull/2929) imxrt: changes to FlexCAN driver support -#### NRF52 +##### NRF52 * [#2148](https://github.com/apache/nuttx/pull/2148) nrf52_wdt: split into low-level API and watchdog driver lower-half * [#2149](https://github.com/apache/nuttx/pull/2149) nrf52832: add errata mitigation code for various RADIO issues * [#2182](https://github.com/apache/nuttx/pull/2182) nrf52: support configuring no console/serial @@ -280,7 +280,7 @@ NuttX-10.1.0 * [#2735](https://github.com/apache/nuttx/pull/2735) nRF52: add support for building SoftDevice BLE controller * [#2756](https://github.com/apache/nuttx/pull/2756) nrf52: add stackcheck support -#### RP2040 +##### RP2040 * [#2916](https://github.com/apache/nuttx/pull/2916) rp2040: Raspberry Pi Pico SMP support * [#2927](https://github.com/apache/nuttx/pull/2927) rp2040: Fix LDFLAGS for boot stage2 * [#2952](https://github.com/apache/nuttx/pull/2952) rp2040: Add I2C driver support @@ -288,10 +288,10 @@ NuttX-10.1.0 * [#3002](https://github.com/apache/nuttx/pull/3002) rp2040: SPI driver DMA transfer support * [#3057](https://github.com/apache/nuttx/pull/3057) rp2040: Fix SPI halfword DMA transfer -#### S32K1XX +##### S32K1XX * [#2900](https://github.com/apache/nuttx/pull/2900) s32k1xx: Support ramfunc -#### STM32 +##### STM32 * [#2010](https://github.com/apache/nuttx/pull/2010) arch/arm/src/stm32h7/stm32_spi.c: fixed build issue when SPI is configured * [#2095](https://github.com/apache/nuttx/pull/2095) arch: stm32: fix otghs logic to support interface requests * [#2177](https://github.com/apache/nuttx/pull/2177) FLASH waiting cycles are configured based on HCLK. @@ -304,11 +304,11 @@ NuttX-10.1.0 * [#2477](https://github.com/apache/nuttx/pull/2477) STM32 FLASH latency is calculated based on Vin * [#2985](https://github.com/apache/nuttx/pull/2985) stm32 Ethernet hardening -#### STM32F7 +##### STM32F7 * [#2209](https://github.com/apache/nuttx/pull/2209) stm32f7/stm32_serial.c: fix console re-initialisation if DMA enabled * [#3489](https://github.com/apache/nuttx/pull/3489) stm32f7: Freeze tickless timer during debug halt. -#### STM32H7 +##### STM32H7 * [#2880](https://github.com/apache/nuttx/pull/2880) stm32h7: add definitions for DAC * [#2955](https://github.com/apache/nuttx/pull/2955) stm32h7:Add DBGMCU missing from master * [#2994](https://github.com/apache/nuttx/pull/2994) stm32h7: Allow custom clock configuration to use stdclockconfig @@ -317,23 +317,23 @@ NuttX-10.1.0 * [#3458](https://github.com/apache/nuttx/pull/3458) stm32h7: Adds stm32_dbgmcu.h to match stm32f7 port * [#3461](https://github.com/apache/nuttx/pull/3461) stm32h7: Expose flash lock, unlock, and write protect functions to boards -#### STM32L4 +##### STM32L4 * [#2068](https://github.com/apache/nuttx/pull/2068) STM32L4: Improvements on ADC driver * [#2178](https://github.com/apache/nuttx/pull/2178) STM32L4 ADC driver: external event configuration * [#2220](https://github.com/apache/nuttx/pull/2220) STM32L4 TIMER: Add some helper functions * [#2232](https://github.com/apache/nuttx/pull/2232) STM32L4 ADC: Add injected channel support. -#### STM32L5 +##### STM32L5 * [#3090](https://github.com/apache/nuttx/pull/3090) stm32l5: Optional LSE xtal drive strength ramp-up -#### Renesas RX65N +##### Renesas RX65N * [#2469](https://github.com/apache/nuttx/pull/2469) USB Host Driver Support -#### Risc-V +##### Risc-V * [#2470](https://github.com/apache/nuttx/pull/2470) risc-v: Introduce basic setjmp support * [#2918](https://github.com/apache/nuttx/pull/2918) risc-v: up_sigdeliver missing fpu contexts. -#### RV64 +##### RV64 * [#2928](https://github.com/apache/nuttx/pull/2928) rv64:add API up_copyfullstate for later FPU support * [#3018](https://github.com/apache/nuttx/pull/3018) rv64:c906:enable DP FPU support * [#3073](https://github.com/apache/nuttx/pull/3073) rv64:c906:demo protect build without the PMP @@ -341,14 +341,14 @@ NuttX-10.1.0 * [#3098](https://github.com/apache/nuttx/pull/3098) rv64:fix 64bit data type and instruction for FPU handlers * [#3203](https://github.com/apache/nuttx/pull/3203) rv64:c906:add risc-v PMP and change mem map for protect build. -#### Xtensa +##### Xtensa * [#1933](https://github.com/apache/nuttx/pull/1933) Add support to PSRAM using SPIRAM interface * [#2014](https://github.com/apache/nuttx/pull/2014) Add the optional interrupt stack to the Xtensa architecture * [#2352](https://github.com/apache/nuttx/pull/2352) Print the bakctrace on assertions * [#2504](https://github.com/apache/nuttx/pull/2504) Get full backtrace from interrupts. * [#3015](https://github.com/apache/nuttx/pull/3015) hostfs: Make host_stat populate st_size -### Minor changes +#### Minor changes * [#1904](https://github.com/apache/nuttx/pull/1904) xtensa: ESP32: Fixed the type of cpuint variables in esp32_emac.c * [#1943](https://github.com/apache/nuttx/pull/1943) xtensa: ESP32: Fix and clean some corners of GPIOs configuration. @@ -500,9 +500,9 @@ NuttX-10.1.0 * [#3492](https://github.com/apache/nuttx/pull/3492) risc-v: riscv_initialize.c: Add telnet_initialize to riscv's up_initialize * [#2868](https://github.com/apache/nuttx/pull/2868) xtensa: Fix xtensa stack coloring -## Simulator +### Simulator -### New Features +#### New Features * [#2129](https://github.com/apache/nuttx/pull/2129) add "nimble" config, to test nimBLE on top of bthcisock * [#2130](https://github.com/apache/nuttx/pull/2130) rpproxy/rpserver: force use 'CONFIG_SIM_M32' for 64bit system. * [#2158](https://github.com/apache/nuttx/pull/2158) linux I2C bus support in sim @@ -520,7 +520,7 @@ NuttX-10.1.0 * [#3231](https://github.com/apache/nuttx/pull/3231) add the simulated lower-half FOC device * [#3478](https://github.com/apache/nuttx/pull/3478) refactor signal handling -### Bug Fixes +#### Bug Fixes * [#2109](https://github.com/apache/nuttx/pull/2109) Revert "arch/sim: Make the SIGUSR1 host signal use the NuttX irq logic" * [#2246](https://github.com/apache/nuttx/pull/2246) boards/sim/sim/sim/src/sim_touchscreen.c: add missing nx_disconnect * [#2259](https://github.com/apache/nuttx/pull/2259) boards/sim: add atexit(2) into naming list @@ -529,9 +529,9 @@ NuttX-10.1.0 * [#3176](https://github.com/apache/nuttx/pull/3176) sim: fix signal deliver calling error on sim platform * [#3205](https://github.com/apache/nuttx/pull/3205) sim: do not exit simulator on up_assert (just let the task exit) -## Documentation +### Documentation -### New Features +#### New Features * [#1955](https://github.com/apache/nuttx/pull/1955) Add documentation for note filters and task trace guides * [#1959](https://github.com/apache/nuttx/pull/1959) Documentation for the Timer Driver * [#2268](https://github.com/apache/nuttx/pull/2268) Documentation for Watchdog Timer Driver @@ -545,7 +545,7 @@ NuttX-10.1.0 * [#3138](https://github.com/apache/nuttx/pull/3138) Adding CMake based C++ project example in documentation * [#3490](https://github.com/apache/nuttx/pull/3490) Documentation/esp32: Add supported peripherals -### Improvements +#### Improvements * [#2021](https://github.com/apache/nuttx/pull/2021) Correct the links in Documentation folder * [#2024](https://github.com/apache/nuttx/pull/2024) Fix broken documentation links * [#2026](https://github.com/apache/nuttx/pull/2026) Documentation: Remove all tail spaces from *.rst and *.html @@ -565,9 +565,9 @@ NuttX-10.1.0 * [#3271](https://github.com/apache/nuttx/pull/3271) docs and comments: Update stale references to COPYING * [#3470](https://github.com/apache/nuttx/pull/3470) Documentation: migrate ESP32 README to docs -## Driver Support +### Driver Support -### New Driver Support +#### New Driver Support * [#1936](https://github.com/apache/nuttx/pull/1936) note: Add task trace support * [#1989](https://github.com/apache/nuttx/pull/1989) sensors: Support fxos8700cq motion I2C sensor * [#2091](https://github.com/apache/nuttx/pull/2091) usbdev: add Android Debug Bridge driver @@ -582,7 +582,7 @@ NuttX-10.1.0 * [#3230](https://github.com/apache/nuttx/pull/3230) motor: add generic upper-half driver for Field Oriented Control (FOC) * [#3474](https://github.com/apache/nuttx/pull/3474) sensors: Adds driver for hyt271 sensore module -### Bug Fixes +#### Bug Fixes * [#2036](https://github.com/apache/nuttx/pull/2036) serial: break from read after closing * [#2039](https://github.com/apache/nuttx/pull/2039) sensors: add unified management for sensor * [#2070](https://github.com/apache/nuttx/pull/2070) bluetooth: support HCI/L2CAP sockets, support HCI RAW channel @@ -658,9 +658,9 @@ NuttX-10.1.0 * [#3475](https://github.com/apache/nuttx/pull/3214) input: Add INPUT_TOUCHSCREEN config * [#3482](https://github.com/apache/nuttx/pull/3482) input: Rename config from INPUT classes -## Board Support +### Board Support -### New Board Support +#### New Board Support * [#2054](https://github.com/apache/nuttx/pull/2054) configure.sh: update custom board config build support * [#2463](https://github.com/apache/nuttx/pull/2463) boards: Added Teensy-4.x BSP * [#2503](https://github.com/apache/nuttx/pull/2503) Re-organise ESP32 boards and introduce two more(ESP-WROVER-KIT and the ESP32-Ethernet-Kit) @@ -671,24 +671,24 @@ NuttX-10.1.0 * [#3217](https://github.com/apache/nuttx/pull/3217) board: Add support for nucleo-h743i2 * [#3234](https://github.com/apache/nuttx/pull/3234) boards/stm32/common: add support for IHM07M1 and IHM08M1 boards -### Boards With Significant Improvements +#### Boards With Significant Improvements -#### ARM +##### ARM -#### BL602 +##### BL602 * [#2764](https://github.com/apache/nuttx/pull/2764) boards: bl602evb flash and debug notes -#### C906 +##### C906 * [#3027](https://github.com/apache/nuttx/pull/3027) board:rv64:c906:support the ELF apps -#### CXD56 +##### CXD56 * [#1939](https://github.com/apache/nuttx/pull/1939) Add cxd56xx intstack for SMP * [#3016](https://github.com/apache/nuttx/pull/3016) spresense:rndis_smp * [#3024](https://github.com/apache/nuttx/pull/3024) Spesense CPU activity LED support * [#3084](https://github.com/apache/nuttx/pull/3084) cxd56_gnss: Add missing include header for cxd56_gnss.c * [#3085](https://github.com/apache/nuttx/pull/3085) cxd56_cpu1signal: Fix an issue that gnss does not work -#### ESP32 +##### ESP32 * [#2507](https://github.com/apache/nuttx/pull/2507) boards/arm/stm32: add common and stm32f103-minimum support for WS2812 * [#2753](https://github.com/apache/nuttx/pull/2753) esp32: Enable renew for "wapi" configs * [#2864](https://github.com/apache/nuttx/pull/2864) Add wapi_smp to test Wi-Fi in SMP mode @@ -707,21 +707,21 @@ NuttX-10.1.0 * [#3270](https://github.com/apache/nuttx/pull/3270) xtensa/esp32: Refactor register access functions on SPI driver * [#3303](https://github.com/apache/nuttx/pull/3303) esp32-devkitc: Add BMP180 sensor support -#### ESP32C3 +##### ESP32C3 * [#2879](https://github.com/apache/nuttx/pull/2879) risc-v/esp32c3: Enable stdio buffering for esp32c3-devkit NSH config * [#2897](https://github.com/apache/nuttx/pull/2897) boards/esp32c3: Add tmpfs mounting when bringing up * [#3074](https://github.com/apache/nuttx/pull/3074) esp32c3-devkit: Use nx_mount to avoid overriding errno * [#3261](https://github.com/apache/nuttx/pull/3261) esp32-c3: Add support to RNG peripheral -#### IMX6 +##### IMX6 * [#2997](https://github.com/apache/nuttx/pull/2997) boards: sabre-6quad: Add netnsh_smp configuration -#### IMXRT +##### IMXRT * [#2004](https://github.com/apache/nuttx/pull/2004) FlexCAN driver for i.MX RT1060 MCU * [#2526](https://github.com/apache/nuttx/pull/2526) boards/arm/imxrt/teensy-4.x: CDC-ACM console support * [#2588](https://github.com/apache/nuttx/pull/2588) teensy-4.x Support for ST7789 controller -#### KINETIS +##### KINETIS * [#1969](https://github.com/apache/nuttx/pull/1969) freedom-k64f: Init PWM only if enabled * [#1977](https://github.com/apache/nuttx/pull/1977) freedom-k64f: Support raw binary firmware format * [#1980](https://github.com/apache/nuttx/pull/1980) freedom-k64f: Add renew DHCP client for netnsh @@ -733,13 +733,13 @@ NuttX-10.1.0 * [#2047](https://github.com/apache/nuttx/pull/2047) freedom-k64f: Add I2C to demo image * [#2847](https://github.com/apache/nuttx/pull/2847) board/freedom-k64f: Add usbdev support with cdcacm example -#### LPC17XX_40XX +##### LPC17XX_40XX * [#3239](https://github.com/apache/nuttx/pull/3239) board/arm/lpc17xx_40xx/mbed: Add userleds driver support -#### NRF52 +##### NRF52 * [#2706](https://github.com/apache/nuttx/pull/2706) board/nrf52-feather: Add simple i2c test configuration -#### RP2040 +##### RP2040 * [#2884](https://github.com/apache/nuttx/pull/2884) Update raspi-pico * [#2894](https://github.com/apache/nuttx/pull/2894) boards: raspberrypi-pico: Add nshsram defconfig for SRAM build * [#3014](https://github.com/apache/nuttx/pull/3014) BMP180 sensor support to RP2040 @@ -747,10 +747,10 @@ NuttX-10.1.0 * [#3030](https://github.com/apache/nuttx/pull/3030) boards/raspberrypi-pico: Support ENC28J60 SPI ethernet board * [#3067](https://github.com/apache/nuttx/pull/3067) boards/raspberrypi-pico: Pico Display Pack (ST7789 LCD) support -#### SAM34 +##### SAM34 * [#2464](https://github.com/apache/nuttx/pull/2464) Added: MT29F2G Nand Flash block driver for sam4s-xplained-pro -#### STM32 +##### STM32 * [#2433](https://github.com/apache/nuttx/pull/2433) Add 2.4 Inch TFT LCD Shield ILI9341 for nucleo-l152re, 8080 MCU 8-bit * [#2505](https://github.com/apache/nuttx/pull/2505) boards/arm/stm32/stm32f103-minimum: cleanup * [#3053](https://github.com/apache/nuttx/pull/3053) Nucleo-F446RE: added support for CAN driver @@ -761,56 +761,56 @@ NuttX-10.1.0 * [#3225](https://github.com/apache/nuttx/pull/3225) stm32/stm32_adc: various improvements for ADC * [#3232](https://github.com/apache/nuttx/pull/3232) stm32/stm32_foc.c: add the lower-half FOC device support -#### STM32F4 +##### STM32F4 * [#2553](https://github.com/apache/nuttx/pull/2553) boards: stm32f4discovery: Add adb configuration * [#2699](https://github.com/apache/nuttx/pull/2699) boards/stm32f4discovery: Add a LWL board profile and improve the README.txt * [#3052](https://github.com/apache/nuttx/pull/3052) Add support to LCD ST7789 on STM32F4Discovery * [#3056](https://github.com/apache/nuttx/pull/3056) Add LCD1602 Backpack to common board -#### STM32F7 +##### STM32F7 * [#3218](https://github.com/apache/nuttx/pull/3218) Integration of pysimCoder with NUTTX -#### STM32H7 +##### STM32H7 * [#2353](https://github.com/apache/nuttx/pull/2353) Fix of the OTG FS HOST for nucleo-h743zi -#### STM32L4 +##### STM32L4 * [#2009](https://github.com/apache/nuttx/pull/2842) Added STM32L432KC DAC support * [#2837](https://github.com/apache/nuttx/pull/2837) Add missing I2C3 support on nucleo-l432kc board * [#2842](https://github.com/apache/nuttx/pull/2842) board: nucleo-l432kc: Add missing i2c_master_s definition -#### TIVA +##### TIVA * [#2684](https://github.com/apache/nuttx/pull/2684) boards: lm3s6965-ek: Add iperf to discover/defconfig -#### XTENSA +##### XTENSA -### **Minor Board Changes** +#### **Minor Board Changes** * [#2558](https://github.com/apache/nuttx/pull/2558) boards: Remove CINCPATH and CXXINCPATH -#### ARM +##### ARM * [#2079](https://github.com/apache/nuttx/pull/2079) Stm32 oled fixes pr * [#2360](https://github.com/apache/nuttx/pull/2360) stm32/stm32ldiscovery: modernize board init little bit * [#2500](https://github.com/apache/nuttx/pull/2500) stm32/common: devpath not long enough for apa102 and veml6070 -#### CXD56 +##### CXD56 * [#2193](https://github.com/apache/nuttx/pull/2193) cxd56xx: Remove HOSTCC and HOSTCFLAGS from Make.defs -#### Xtensa +##### Xtensa * [#2127](https://github.com/apache/nuttx/pull/2127) esp32: Added Userled support * [#2802](https://github.com/apache/nuttx/pull/2802) ESP32: Refactor of POSTBUILD action * [#3263](https://github.com/apache/nuttx/pull/3263) esp32: Move the WLAN initialisation to the common directory. * [#3288](https://github.com/apache/nuttx/pull/3288) esp32-wrover-kit: Don't use User GPIO Subsystem to control LED * [#3442](https://github.com/apache/nuttx/pull/3442) esp32 boards: BUTTON_BOOT should use PULLUP instead PULLDOWN -## File System +### File System -### Significant Improvements +#### Significant Improvements * [#2598](https://github.com/apache/nuttx/pull/2598) fs/epoll: add asynchronous epoll control support * [#2841](https://github.com/apache/nuttx/pull/2841) fs: procfs meminfo improvements * [#2957](https://github.com/apache/nuttx/pull/2957) fs: mqueue: add poll support * [#3045](https://github.com/apache/nuttx/pull/3045) fs: Allocate file/socket dynamically * [#3212](https://github.com/apache/nuttx/pull/3212) fs/lfs: Update version to 2.4.0 -### Bug Fixes +#### Bug Fixes * [#2073](https://github.com/apache/nuttx/pull/2073) fs: epoll_create: modify return value for epoll_create1 * [#2260](https://github.com/apache/nuttx/pull/2260) fs: eventfd: remove the unique minor limit * [#2317](https://github.com/apache/nuttx/pull/2317) fs: flashback to release all file descriptors in group to increase debugging time. @@ -846,9 +846,9 @@ NuttX-10.1.0 * [#3444](https://github.com/apache/nuttx/pull/3444) fs/romfs: fix open zero-byte file fail issue * [#3491](https://github.com/apache/nuttx/pull/3491) fs: vfs: adjust the error code of write to be consistent with read -## Networking +### Networking -### Significant Improvements +#### Significant Improvements * [#2414](https://github.com/apache/nuttx/pull/2414) net: tcp: implement the fast retransmit * [#2415](https://github.com/apache/nuttx/pull/2415) net: gmp: add MULTICAST_TTL support * [#2417](https://github.com/apache/nuttx/pull/2417) net: wireless: add country code control support @@ -861,7 +861,7 @@ NuttX-10.1.0 * [#3113](https://github.com/apache/nuttx/pull/3113) net: usrsock: add send multi-elements support * [#3257](https://github.com/apache/nuttx/pull/3257) net: tcp: support bind the same port with different domain -### Bug Fixes +#### Bug Fixes * [#1589](https://github.com/apache/nuttx/pull/1589) net: tcp: fix tcp socket close timeout if loss wireless connection * [#2075](https://github.com/apache/nuttx/pull/2075) net: TCP-stack fix for stalled tcp sockets due to broken keepalive * [#2121](https://github.com/apache/nuttx/pull/2121) net: devif: devif_callback.c: remove harmful debug check @@ -896,13 +896,13 @@ NuttX-10.1.0 * [#3254](https://github.com/apache/nuttx/pull/3254) net: arp: Fix arp * [#3319](https://github.com/apache/nuttx/pull/3319) tcp_netpoll.c: Fix a performance issue with CONFIG_NET_TCP_WRITE_BUFFERS -# Security Issues Fixed In This Release +## Security Issues Fixed In This Release -# Compatibility Concerns +## Compatibility Concerns -## Changes to Build System +### Changes to Build System -### Change CFLAGS, CPPFLAGS, CXXFLAGS, and AFLAGS from Recursive to Simple Assignment +#### Change CFLAGS, CPPFLAGS, CXXFLAGS, and AFLAGS from Recursive to Simple Assignment [PR-1890](https://github.com/apache/nuttx/pull/1890) (commit [2caf3a69e3d60ec550980f7ba897c732e7a39df7](https://github.com/apache/nuttx/pull/1890/commits/2caf3a69e3d60ec550980f7ba897c732e7a39df7)) @@ -931,7 +931,7 @@ CPPFLAGS := $(ARCHINCLUDES) $(ARCHDEFINES) $(EXTRAFLAGS) AFLAGS := $(CFLAGS) -D__ASSEMBLY__ ``` -### Not Necessary to Define `__NuttX__` in Make.defs +#### Not Necessary to Define `__NuttX__` in Make.defs [PR-2192](https://github.com/apache/nuttx/pull/2192) (commit [9208176f600d0d04446531909bf05710716a5ee4](https://github.com/apache/nuttx/commit/9208176f600d0d04446531909bf05710716a5ee4)) diff --git a/Documentation/ReleaseNotes/NuttX-10.2.0 b/Documentation/ReleaseNotes/NuttX-10.2.0.md similarity index 97% rename from Documentation/ReleaseNotes/NuttX-10.2.0 rename to Documentation/ReleaseNotes/NuttX-10.2.0.md index 34464152415..248aea8cb88 100644 --- a/Documentation/ReleaseNotes/NuttX-10.2.0 +++ b/Documentation/ReleaseNotes/NuttX-10.2.0.md @@ -1,11 +1,11 @@ NuttX-10.2.0 ------------- +============ -# What's new in this release +## What's new in this release -## Major Changes to Core OS +### Major Changes to Core OS -### New Features +#### New Features * [#3708](https://github.com/apache/nuttx/pull/3708) openamp: Update to 2020.10.0 official release * [#3709](https://github.com/apache/nuttx/pull/3709) Update libcxx to 12.0.0 release * [#3674](https://github.com/apache/nuttx/pull/3674) libc/termios: Implement TCSADRAIN and TCSAFLUSH for tcsetattr @@ -39,7 +39,7 @@ NuttX-10.2.0 * [#4096](https://github.com/apache/nuttx/pull/4096) mm: Simplify the semaphore handling * [#4100](https://github.com/apache/nuttx/pull/4100) Implement utime and futimes -### Bug Fixes +#### Bug Fixes * [#4615](https://github.com/apache/nuttx/pull/4615) sched/signal: Correct kill with cancellation * [#4619](https://github.com/apache/nuttx/pull/4619) sched: Fix CPU affinity issues in SMP * [#3626](https://github.com/apache/nuttx/pull/3626) libc: Move pthread stuff to userspace @@ -117,9 +117,9 @@ NuttX-10.2.0 * [#3908](https://github.com/apache/nuttx/pull/3908) crypto/random_pool.c: Correct indexing on void pointer * [#3817](https://github.com/apache/nuttx/pull/3817) audio: various fixes -## Major Changes to the Build System +### Major Changes to the Build System -### New Features +#### New Features * [#4525](https://github.com/apache/nuttx/pull/4525) mkromfsimg: Add optional rcS file path * [#4491](https://github.com/apache/nuttx/pull/4491) checkpatch.sh: add check gerrit Change-Id support * [#3716](https://github.com/apache/nuttx/pull/3716) tools: Add a bash completion script for the configure tool     @@ -127,7 +127,7 @@ NuttX-10.2.0 * [#4203](https://github.com/apache/nuttx/pull/4203) tools: Add armv7-a support to nuttx-gdbinit * [#3705](https://github.com/apache/nuttx/pull/3705) docker: add ninja-build -### Bug Fixes +#### Bug Fixes * [#4418](https://github.com/apache/nuttx/pull/4418) compiler.h: add __builtin_offsetof instead of offsetof * [#3815](https://github.com/apache/nuttx/pull/3815) tools/mksyscall: Fix build break of syscall instrumentation wrapper * [#4461](https://github.com/apache/nuttx/pull/4461) tools/ci: Minor improvements to CI build script @@ -137,18 +137,18 @@ NuttX-10.2.0 * [#4423](https://github.com/apache/nuttx/pull/4423) board: Enable CONFIG_LIBCXXABI when CONFIG_LIBCXX is enabled * [#4196](https://github.com/apache/nuttx/pull/4196) tools: Fix nuttx-gdbinit -## Architectural Support +### Architectural Support -### New Architecture +#### New Architecture -#### MIPS +##### MIPS -##### PIC32 +###### PIC32 * [#4252](https://github.com/apache/nuttx/pull/4252) pic32mz: added support for PIC32MZ2048EFG MCU -### Architectures with significant improvements +#### Architectures with significant improvements -#### ARM +##### ARM * [#4522](https://github.com/apache/nuttx/pull/4522) arch/arm: Add ARCH_CORTEXM55 Kconfig for cortex-m55 * [#3759](https://github.com/apache/nuttx/pull/3759) arm/v7-a/fpu: add VFP-v3 D32 support   * [#4536](https://github.com/apache/nuttx/pull/4536) arch/arm: correct the function name from arm_getsp() to up_getsp() @@ -171,18 +171,18 @@ NuttX-10.2.0 * [#4227](https://github.com/apache/nuttx/pull/4227) pwm: add option to break the loops when using multiple PWM channels * [#4261](https://github.com/apache/nuttx/pull/4261) EXC_SECURE and SECURE_STACK just can clear at TRUSTZONE_NONSECURE -#### CXD56XX +##### CXD56XX * [#4557](https://github.com/apache/nuttx/pull/4557) arch: cxd56xx: Replace the critical section with spinlock in cxd56_serial.c * [#3743](https://github.com/apache/nuttx/pull/3743) arch: arm: cxd56xx: Update cxd56xx drivers * [#3845](https://github.com/apache/nuttx/pull/3845) Fix spresense with elf -#### LPC17XX_40XX +##### LPC17XX_40XX * [#4072](https://github.com/apache/nuttx/pull/4072) lpc17xx: Added WDT driver. * [#4316](https://github.com/apache/nuttx/pull/4316) lpc17_40: Fixed I2C port sanity check. * [#4148](https://github.com/apache/nuttx/pull/4148) lpc17_40: style fix in WDT definitions. * [#4107](https://github.com/apache/nuttx/pull/4107) lpc17_40: Fixed progmem driver. -#### STM32 +##### STM32 * [#3761](https://github.com/apache/nuttx/pull/3761) ET-STM32 Stamp: An STM32F103RET6 target for NuttX * [#4350](https://github.com/apache/nuttx/pull/4350) arch/arm/src/stm32l4/Kconfig: add new STM32L4+ chip types * [#4310](https://github.com/apache/nuttx/pull/4310) arch/stm32: improvements for qencoder @@ -193,39 +193,39 @@ NuttX-10.2.0 * [#4163](https://github.com/apache/nuttx/pull/4163) Files for pysimCoder * [#4151](https://github.com/apache/nuttx/pull/4151) Change DAC driver to support STM32G4 DAC -#### STM32L4 +##### STM32L4 * [#3668](https://github.com/apache/nuttx/pull/3668) arch/arm/src/stm32l4/hardware/stm32l4xrxx: pinmap alternative function for SPI2   * [#4468](https://github.com/apache/nuttx/pull/4468) arch/arm/src/stm32l4: fix STM32L4+ option bytes memory address * [#4501](https://github.com/apache/nuttx/pull/4501) arch/arm/src/stm32l4: add control for Vddio2 independent I/Os supply valid * [#4469](https://github.com/apache/nuttx/pull/4469) arch/arm/src/stm32l4/stm32l4_flash.c: fix FLASH_CONFIG_I to use dual-bank access -#### STM32L5 +##### STM32L5 -#### S32K1XX +##### S32K1XX * [#3850](https://github.com/apache/nuttx/pull/3850) UCANS32K146 add support for B revision * [#4493](https://github.com/apache/nuttx/pull/4493) Fix error in s32k118_pinmux.h * [#3795](https://github.com/apache/nuttx/pull/3795) S32K1XX LSPI Double word up to 64 bits support -#### IMX6 +##### IMX6 * [#3777](https://github.com/apache/nuttx/pull/3777) arch: imx6: Add termios support to imx6 -#### IMXRT +##### IMXRT * [#3988](https://github.com/apache/nuttx/pull/3988) arch/arm/src/imxrt/imxrt_flexpwm.c: fix mistake in submodules address offset * [#4431](https://github.com/apache/nuttx/pull/4431) i.MX RT: Changes to FlexCAN driver and Teensy 4.x CAN configuration * [#4285](https://github.com/apache/nuttx/pull/4285) arch/arm/src/imxrt/imxrt_flexpwm.c: Set LDOK bits after all channels are set * [#4138](https://github.com/apache/nuttx/pull/4138) i.MX RT: added support for Tickless OS -#### RP2040 +##### RP2040 * [#4049](https://github.com/apache/nuttx/pull/4049) Raspipico smp * [#4251](https://github.com/apache/nuttx/pull/4251) raspberrypi-pico: add support for lcd_dev * [#4002](https://github.com/apache/nuttx/pull/4002) Kinetis Replace DMA with a proper eDMA driver and use it on SPI and Serial -#### RTL8720C +##### RTL8720C * [#4076](https://github.com/apache/nuttx/pull/4076) AmebaZ2: Add soc src code -#### NRF52 +##### NRF52 -#### STM32H7/STM32F7 +##### STM32H7/STM32F7 * [#4331](https://github.com/apache/nuttx/pull/4331) arch/arm/stm32h7: dma and serial: add TRBUFF flag. * [#4441](https://github.com/apache/nuttx/pull/4441) arch/arm/stm32f7/stm32_irq: Fix format strings * [#4098](https://github.com/apache/nuttx/pull/4098) stm32h7 Ethernet add yield and timeout to not hog CPU @@ -236,11 +236,11 @@ NuttX-10.2.0 * [#3976](https://github.com/apache/nuttx/pull/3976) STM32F7 SDMMC fixes * [#3924](https://github.com/apache/nuttx/pull/3924) stm32h7 fix for adc to handle overrun and the DR's fifo -#### Renesas +##### Renesas * [#4230](https://github.com/apache/nuttx/pull/4230) renesas/rx65n: add long type for all PRI*PTR * [#3989](https://github.com/apache/nuttx/pull/3989) Renesas/RX added setjmp and placeholder ioctl -#### Risc-V +##### Risc-V * [#3770](https://github.com/apache/nuttx/pull/3770) Add support for PolarFire SoC and icicle board * [#3997](https://github.com/apache/nuttx/pull/3997) risc-v/bl602: update wifi firmware version * [#4381](https://github.com/apache/nuttx/pull/4381) arch/riscv/assert: enhance the assert dump @@ -257,14 +257,14 @@ NuttX-10.2.0 * [#4384](https://github.com/apache/nuttx/pull/4384) Mpfs core pwm * [#4507](https://github.com/apache/nuttx/pull/4507) various MPFS fixes -#### ESP32-C3 +##### ESP32-C3 * [#3853](https://github.com/apache/nuttx/pull/3853) arch/risc-v/esp32c3: add esp32c3_modtext to allow ELF loading -#### BL602 +##### BL602 * [#3784](https://github.com/apache/nuttx/pull/3784) risc-v/bl602: Add RTC driver * [#4607](https://github.com/apache/nuttx/pull/4607) Open ble controller adaptation code -#### Xtensa +##### Xtensa * [#4280](https://github.com/apache/nuttx/pull/4280) arch:xtensa: add new GNU toolchain for xtensa. * [#4478](https://github.com/apache/nuttx/pull/4478) arch: xtensa: add xtensa cache support * [#4547](https://github.com/apache/nuttx/pull/4547) arch:xtensa: add full bactrace support @@ -273,20 +273,20 @@ NuttX-10.2.0 * [#4458](https://github.com/apache/nuttx/pull/4458) arch:xtensa: add xtensa mpu support * [#3762](https://github.com/apache/nuttx/pull/3762) xtensa: #ifdef SYMBOL is always true if SYMBOL defined as 0 -#### ESP32 +##### ESP32 * [#4638](https://github.com/apache/nuttx/pull/4638) esp32xx_rom.ld: Strongly declare some of the libgcc.a functions that are ROM resident * [#4417](https://github.com/apache/nuttx/pull/4417) arch/esp32: Properly handle GPIO interrupt in SMP. * [#4234](https://github.com/apache/nuttx/pull/4234) espressif/esp32/esp32s2/esp32c3: Disable wdt on initialization. -#### X86_64 +##### X86_64 * [#4447](https://github.com/apache/nuttx/pull/4447) Fix x86_64 -### General changes +#### General changes * [#4233](https://github.com/apache/nuttx/pull/4233) board/ctrl: Add BOARDIOC_BOOT_IMAGE for booting a new application image * [#4191](https://github.com/apache/nuttx/pull/4191) Add BOARDCTL_SWITCH_BOOT to support switch boot system * [#4089](https://github.com/apache/nuttx/pull/4089) board/ctrl: add BOARDCTL_UNIQUEKEY support -## Simulator +### Simulator * [#3921](https://github.com/apache/nuttx/pull/3921) sim: Use cc as linker, which usually aliases to either GCC or Clang * [#4108](https://github.com/apache/nuttx/pull/4108) boards/sim: enable nxlooper for alsa config * [#4222](https://github.com/apache/nuttx/pull/4222) sim/cmdline: save boot cmdline @@ -305,14 +305,14 @@ NuttX-10.2.0 * [#3689](https://github.com/apache/nuttx/pull/3689) Apps Issue #246: Replace romdisk_register() with boardctl(BOARDIOC_ROMDISK) * [#4465](https://github.com/apache/nuttx/pull/4465) feature: driver: Add a Linux SPI into simulator. -## Documentation +### Documentation -### New Features +#### New Features * [#3634](https://github.com/apache/nuttx/pull/3634) Documentation/platforms: added documentation for imxrt10xx boards * [#4470](https://github.com/apache/nuttx/pull/4470) Doc: Add initial documentation to the simulator * [#4419](https://github.com/apache/nuttx/pull/4419) doc/esp32: Add instructions to use softap -### Improvements +#### Improvements * [#3782](https://github.com/apache/nuttx/pull/3782) spi: Improve SPI Slave interface documentation * [#4390](https://github.com/apache/nuttx/pull/4390) Documentation: Update ESP32-C3 supported peripheral list. * [#3702](https://github.com/apache/nuttx/pull/3702) Documentation/esp32c3: Fix a couple of issues from #3700 @@ -328,9 +328,9 @@ NuttX-10.2.0 * [#4298](https://github.com/apache/nuttx/pull/4298) Doc/FAQ: Add more entries about board initialization * [#4297](https://github.com/apache/nuttx/pull/4297) Documentation/FAQ: Why /dev/ttySx is not created -### Driver Support +#### Driver Support -### Bug Fixes +#### Bug Fixes * [#3842](https://github.com/apache/nuttx/pull/3842) Added automatic log rotation, when log file is opened. * [#3837](https://github.com/apache/nuttx/pull/3837) SYSLOG channel add functions return handle to the channel. * [#3848](https://github.com/apache/nuttx/pull/3848) Syslog file rotations number is configurable. @@ -406,7 +406,7 @@ NuttX-10.2.0 * [#4039](https://github.com/apache/nuttx/pull/4039) Add putarea() method for st7789 * [#3754](https://github.com/apache/nuttx/pull/3754) wireless/bluetooth: decoupling bt_driver_s and bt_buf_s -### New Driver Support +#### New Driver Support * [#3727](https://github.com/apache/nuttx/pull/3727) Add basic support for MCP23017 I/O Expander * [#3859](https://github.com/apache/nuttx/pull/3859) Add Holtek HT16K33 14-segment display driver * [#4641](https://github.com/apache/nuttx/pull/4641) drivers/mtd/m25px.c: add support for MT25Q256 SPI NOR @@ -414,34 +414,34 @@ NuttX-10.2.0 * [#4373](https://github.com/apache/nuttx/pull/4373) Add support for 3-phase Hall effect sensor driver * [#4490](https://github.com/apache/nuttx/pull/4490) add support for power management ic axp202 -## Board Support +### Board Support -### New Board Support +#### New Board Support -### Boards With Significant Improvements +#### Boards With Significant Improvements -#### ARM +##### ARM -#### CXD56 +##### CXD56 * [#3833](https://github.com/apache/nuttx/pull/3833) Spresense new memorymap * [#4526](https://github.com/apache/nuttx/pull/4526) Rearch video * [#3973](https://github.com/apache/nuttx/pull/3973) boards: spresense: Update rndis and rndis_smp for workaround * [#3744](https://github.com/apache/nuttx/pull/3744) boards: cxd56xx: Update drivers on spresense board -#### IMX6 +##### IMX6 * [#3733](https://github.com/apache/nuttx/pull/3733) imx6 elf support -#### IMXRT +##### IMXRT * [#3982](https://github.com/apache/nuttx/pull/3982) boards/arm/imxrt/teensy-4.x: added board level support for GPIO driver * [#3929](https://github.com/apache/nuttx/pull/3929) Added encoder support for Teensy 4.x * [#3980](https://github.com/apache/nuttx/pull/3980) FlexPWM support for iMXRT MCU * [#4581](https://github.com/apache/nuttx/pull/4581) Fixed imxrt flexcan driver compilation error (incorrect variable scope) -#### LPC17XX_40XX +##### LPC17XX_40XX -#### NRF52 +##### NRF52 -#### RP2040 +##### RP2040 * [#3917](https://github.com/apache/nuttx/pull/3917) arm/rp2040:USB device controller support * [#3857](https://github.com/apache/nuttx/pull/3857) boards: rp2040: Add user gpio driver * [#3996](https://github.com/apache/nuttx/pull/3996) Support for Waveshare Pico-LCD-1.x module @@ -449,7 +449,7 @@ NuttX-10.2.0 * [#4204](https://github.com/apache/nuttx/pull/4204) added st7735 LCD based support * [#4289](https://github.com/apache/nuttx/pull/4289) Fixing BMP180 and INA219 in RP2040 -#### S32K1XX +##### S32K1XX * [#4643](https://github.com/apache/nuttx/pull/4643) S32K1xx arch: Add (optional) support for SPI native/hardware chip select * [#4634](https://github.com/apache/nuttx/pull/4634) S32K1XX arch: gpioread may also be used for output pins * [#4592](https://github.com/apache/nuttx/pull/4592) S32K1XX: Add LPI2C slave support @@ -460,11 +460,11 @@ NuttX-10.2.0 * [#4508](https://github.com/apache/nuttx/pull/4508) s32k1xx: added way to get the reset cause in a proc fs * [#4560](https://github.com/apache/nuttx/pull/4560) RDDRONE-UAVCAN / UCANS32K146 boards cleanup & update -#### SAM34 +##### SAM34 * [#3732](https://github.com/apache/nuttx/pull/3732) board: Add support for Adafruit Circuit Express * [#3840](https://github.com/apache/nuttx/pull/3840) Add ST7789 LCD controller support for SAMV71 XPlained Ultra board -#### STM32 +##### STM32 * [#3944](https://github.com/apache/nuttx/pull/3944) boards/arm/stm32/nucleo-f446re: added support for DAC driver * [#3880](https://github.com/apache/nuttx/pull/3880) boards/arm/stm32/nucleo-f446re: added support for GPIO driver * [#3909](https://github.com/apache/nuttx/pull/3909) Added basic support for nucleo-g431kb board. @@ -486,12 +486,12 @@ NuttX-10.2.0 * [#3952](https://github.com/apache/nuttx/pull/3952) SDIO IO_RW_EXTENDED command (CMD53) related fixes * [#4597](https://github.com/apache/nuttx/pull/4597) Add LCD backpack support for ESP32 (devkit-c). -#### STM32L4 +##### STM32L4 * [#4534](https://github.com/apache/nuttx/pull/4534) STM32L4 LPUART support -#### STM32F4 +##### STM32F4 -#### STM32F7 / STM32H7 +##### STM32F7 / STM32H7  * [#3646](https://github.com/apache/nuttx/pull/3646) boards/stm32f7: Add i2c and mpu60x0 support to nucleo-144 and fix bitmask bug in mpu60x0 * [#3650](https://github.com/apache/nuttx/pull/3650) stm32{H7|F7} Disables/Enabled the use of GPIO_OTG_ID pin * [#3669](https://github.com/apache/nuttx/pull/3669) STM32 {F7|H7} Use 250 Ms Data path timeout, regardless of Card Clock frequency @@ -499,18 +499,18 @@ NuttX-10.2.0 * [#4524](https://github.com/apache/nuttx/pull/4524) stm32*7/stm32_serial.c: Don't fake a TX interrupt when interrupts are not suppressed * [#4598](https://github.com/apache/nuttx/pull/4598) stm32h7:DMA_TRBUFF is DMA_SCR_TRBUFF -#### KINETIS +##### KINETIS * [#4190](https://github.com/apache/nuttx/pull/4190) kinetis lpserial add RX DMA -#### ARM -#### AVR32 +##### ARM +##### AVR32 * [#3684](https://github.com/apache/nuttx/pull/) avr32dev1: USART1 RX: Reassign pin -#### MIPS -#### PIC32 +##### MIPS +##### PIC32 * [#4264](https://github.com/apache/nuttx/pull/) boards: added a basic support for chipKIT Wi-FIRE board -#### RISC-V +##### RISC-V * [#3846](https://github.com/apache/nuttx/pull/3846) risc-v/rv32m1: Basic port to rv32m1 ri5cy * [#4146](https://github.com/apache/nuttx/pull/4146) risc-v/bl602: add boardctl support * [#3911](https://github.com/apache/nuttx/pull/3911) Add i2c driver to PolarFire SoC and Icicle board @@ -519,12 +519,12 @@ NuttX-10.2.0 * [#3920](https://github.com/apache/nuttx/pull/3920) add dma support for PolarFire SoC * [#4569](https://github.com/apache/nuttx/pull/4569) MPFS emmcsd -#### BL602 +##### BL602 * [#4010](https://github.com/apache/nuttx/pull/4010) boards/bl602: Fix uart_nx.c:419: undefined reference to `uart_bth4_register -#### C906 +##### C906 -#### ESP32-C3 +##### ESP32-C3 * [#3794](https://github.com/apache/nuttx/pull/3794) risc-v/esp32c3: Support ESP32-C3 RTC driver * [#3883](https://github.com/apache/nuttx/pull/3883) risc-v/esp32c3: Support ESP32-C3 RSA accelerator * [#3881](https://github.com/apache/nuttx/pull/3881) risc-v/esp32c3: Support ESP32-C3 efuse @@ -569,7 +569,7 @@ NuttX-10.2.0 * [#4169](https://github.com/apache/nuttx/pull/4169) risc-v/esp32-c3: Makes output readable and rmv unnecessary var. * [#4314](https://github.com/apache/nuttx/pull/4314) risc-v/esp32-c3: Complete the support for RWDT -#### XTENSA +##### XTENSA * [#4590](https://github.com/apache/nuttx/pull/4590) [Xtensa/RISC-V] Remove FAR and CODE qualifiers from arch-specific files * [#4187](https://github.com/apache/nuttx/pull/4187) Fix xtensa_btdump() to look at the exception frame * [#4556](https://github.com/apache/nuttx/pull/4556) xtensa:backtrace: flush to stack when in interrupt @@ -579,7 +579,7 @@ NuttX-10.2.0 * [#4311](https://github.com/apache/nuttx/pull/4311) xtensa:coproc: fix XTENSA_CP_ALLSET error in some case * [#3768](https://github.com/apache/nuttx/pull/3768) xtensa: Fixes names of architecture serial functions -#### ESP32 +##### ESP32 * [#3940](https://github.com/apache/nuttx/pull/3940) xtensa/esp32: Support ESP32 RTC driver * [#4003](https://github.com/apache/nuttx/pull/4003) xtensa/esp32: Adds support for SERIAL_TXDMA. * [#3912](https://github.com/apache/nuttx/pull/3912) xtensa/esp32: Adds I2C polled support. @@ -630,9 +630,9 @@ NuttX-10.2.0 * [#3960](https://github.com/apache/nuttx/pull/3960) xtensa/esp32: Refactor the text heap and add RTC memory to it * [#4646](https://github.com/apache/nuttx/pull/4646) Add example to use BLE and WiFi at same time -## File System +### File System -### Bug Fixes +#### Bug Fixes * [#3653](https://github.com/apache/nuttx/pull/3653) fs:cromf Use inttypes in printing macros * [#4573](https://github.com/apache/nuttx/pull/4573) fs:procfs: add waiting_paging_fill state names * [#3745](https://github.com/apache/nuttx/pull/3745) fs/vfs/fs_select.c: Fix select() to return EINVAL when nfds is negative @@ -677,11 +677,11 @@ NuttX-10.2.0 * [#4290](https://github.com/apache/nuttx/pull/4290) cmd/df: Fix the abnormal output after off_t change * [#4133](https://github.com/apache/nuttx/pull/4133) profs: Print StackAlloc by procfs_snprintf -### Significant Improvements +#### Significant Improvements -## Networking +### Networking -### Improvements +#### Improvements * [#4538](https://github.com/apache/nuttx/pull/4538) sys/socket/scm: add more socket message control helper * [#4080](https://github.com/apache/nuttx/pull/4080) net/socket: add SO_SNDBUF support * [#4116](https://github.com/apache/nuttx/pull/4116) net: Add file_socket function @@ -699,7 +699,7 @@ NuttX-10.2.0 * [#4540](https://github.com/apache/nuttx/pull/4540) net/local: add FIONSPACE support * [#4593](https://github.com/apache/nuttx/pull/4593) net/local: add socket message control support -### Bug Fixes +#### Bug Fixes * [#4602](https://github.com/apache/nuttx/pull/4602) net/dup: only start tcp monitor on INET domain * [#4649](https://github.com/apache/nuttx/pull/4649) net: always compile listen.c and accept.c when enable CONFIG_NET * [#4603](https://github.com/apache/nuttx/pull/4603) [SECURITY]net/tcp: sanity check for the listen address @@ -744,11 +744,11 @@ NuttX-10.2.0 * [#4480](https://github.com/apache/nuttx/pull/4480) net: utils: Remove critical section for SMP in net_lock.c * [#3919](https://github.com/apache/nuttx/pull/3919) tcp iob throttling related fixes -# Security Issues Fixed In This Release +## Security Issues Fixed In This Release -# Compatibility Concerns +## Compatibility Concerns -## Changes to Kconfig +### Changes to Kconfig The names of some Kconfig settings have been changed to improve the naming consistency. Here is the list: @@ -777,7 +777,7 @@ See PR-4266 https://github.com/apache/nuttx/pull/4266 and PR-4267 https://github See also PR-820 https://github.com/apache/nuttx-apps/pull/820 and PR-821 https://github.com/apache/nuttx-apps/pull/821 in the NuttX apps repository. -## Changes to MTD subsystem +### Changes to MTD subsystem MTDIOC_XIPBASE, MTDIOC_FLUSH and MTDIOC_PARTINFO is removed and replace with BIOC_XIPBASE, BIOC_FLUSH and BIOC_PARTINFO: @@ -786,15 +786,15 @@ MTDIOC_XIPBASE, MTDIOC_FLUSH and MTDIOC_PARTINFO is removed and replace with BIO See PR-4325 https://github.com/apache/nuttx/pull/4325 -## Changes to Build System +### Changes to Build System -### LD Now Called Through GCC +#### LD Now Called Through GCC When building NuttX with GCC toolchains, the linker is now called through $(CROSSDEV)gcc rather than $(CROSSDEV)ld. This requires all linker options to be prefixed with `-Wl,` (dash, capital W, lower-case L, comma). All boards in the NuttX tree have been updated, but any custom out-of-tree boards will need to apply this change in the relevant parts of their build scripts. The reason for this change is that GNU Binutils 2.36.x has added new error checking on command line arguments. This has had the effect that the NuttX build suddenly broke on host OS distributions that updated to the 2.36.x release line. Reports included Arch, Manjaro, and Ubuntu. Other host OSes are likely to be affected as well. -#### Symptoms +##### Symptoms Your toolchain and board are affected if you see errors from LD like: @@ -808,7 +808,7 @@ or (following this change in NuttX) errors from GCC like: arm-none-eabi-gcc: error: unrecognized command line option '--gc-sections'; did you mean '--data-sections'? ``` -#### What to change +##### What to change The most common change expected to affect most boards: @@ -884,7 +884,7 @@ $(LIBPATHS) "-(" $(LDLIBS) "-)" $(LDFLAGS) -Map="$(TOPDIR)$(DELIM)nuttx.map" In general, any command line options destined for LD must be prefixed with `-Wl,` (dash, capital W, lower-case L, comma) since they are now being passed through GCC. -#### Examples +##### Examples Change: @@ -968,7 +968,7 @@ to: LD = $(CROSSDEV)gcc ``` -#### References +##### References * Git commit # 45672c269db13f59bdaa417e564837e8bbb6c8c1 in the NuttX main repository: - https://github.com/apache/nuttx/commit/45672c269db13f59bdaa417e564837e8bbb6c8c1 diff --git a/Documentation/ReleaseNotes/NuttX-10.3.0 b/Documentation/ReleaseNotes/NuttX-10.3.0.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-10.3.0 rename to Documentation/ReleaseNotes/NuttX-10.3.0.md index 6f52463e516..4a7bc7a2bbe 100644 --- a/Documentation/ReleaseNotes/NuttX-10.3.0 +++ b/Documentation/ReleaseNotes/NuttX-10.3.0.md @@ -1,11 +1,11 @@ NuttX-10.3.0 ------------- +============ -# What's New In This Release +## What's New In This Release -## Major Changes to Core OS +### Major Changes to Core OS -### New Features +#### New Features * [#5524](https://github.com/apache/nuttx/pull/5524) mm: iob: add support of alloc with timeout iob_timedalloc()  * [#4743](https://github.com/apache/nuttx/pull/4743) mm: Support the kernel address sanitizer  @@ -18,7 +18,7 @@ NuttX-10.3.0 * [#5366](https://github.com/apache/nuttx/pull/5366) binfmt: libelf: Implement sh_addralign handling * [#4871](https://github.com/apache/nuttx/pull/4871) binfmt: elf: add bare metal coredump support  -### Bug Fixes +#### Bug Fixes * [#5503](https://github.com/apache/nuttx/pull/5503) Replece clock_gettime with clock_systime_timespec if suitable  * [#5721](https://github.com/apache/nuttx/pull/5721) Remove the unnecessary code from nx_start @@ -160,16 +160,16 @@ NuttX-10.3.0 * [#5171](https://github.com/apache/nuttx/pull/5171) sched: semaphore: release all semaphores' holder that the task held when exit  * [#5063](https://github.com/apache/nuttx/pull/5063) sched: wqueue: fix NO leave_critical_section() when only CONFIG_SCHED_HPWORK  -## Major Changes to the Build System +### Major Changes to the Build System -### New Features +#### New Features * [#5638](https://github.com/apache/nuttx/pull/5638) tools: add parsememdump.py to parse memdump info(by cmd: memdump all)  * [#5622](https://github.com/apache/nuttx/pull/5622) tools: add rustfmt to checkpatch  * [#4925](https://github.com/apache/nuttx/pull/4925) tools: Add size report script * [#5153](https://github.com/apache/nuttx/pull/5153) tools: mpfs: prepare OpenSBI image  -### Bug Fixes +#### Bug Fixes * [#5362](https://github.com/apache/nuttx/pull/5362) tools: mkromfsimg.sh: add attribute to set minimum 4 bytes aignment for romfs image data  * [#4794](https://github.com/apache/nuttx/pull/4794) tools: mkconfig: Handle string with escape character correctly  @@ -200,9 +200,9 @@ NuttX-10.3.0 * [#5055](https://github.com/apache/nuttx/pull/5055) tools: Improve Makefile.[unix|win]::context's dependencies  * [#5163](https://github.com/apache/nuttx/pull/5163) tools: Rename Makefile.* to have the .mk extension  -## Architectural Support +### Architectural Support -### New Architecture Support +#### New Architecture Support * [#4897](https://github.com/apache/nuttx/pull/4897) arch: arm: phy62xx: Phyplus release 1.2  * [#5470](https://github.com/apache/nuttx/pull/5470) arch: arm: STM32U5 Architecture Support  @@ -210,7 +210,7 @@ NuttX-10.3.0 * [#5352](https://github.com/apache/nuttx/pull/5352) arch: xtensa: Add initial support for ESP32-S3  * [#5241](https://github.com/apache/nuttx/pull/5241) arch: sparc: Port nuttx to sparc-v8 -### Architecture with Significant Improvements +#### Architecture with Significant Improvements * [#5468](https://github.com/apache/nuttx/pull/5468) arch: Add xxx_tcbinfo.c to SoC level Make.defs  * [#5482](https://github.com/apache/nuttx/pull/5482) arch: Replace nx_vsyslog with vsyslog  @@ -246,7 +246,7 @@ NuttX-10.3.0 * [#5120](https://github.com/apache/nuttx/pull/5120) arch: signal: signal handler may cause task's state error  * [#4993](https://github.com/apache/nuttx/pull/4993) arch: tls: restore C89 compatibility for TLS  -#### ARM +##### ARM * [#4816](https://github.com/apache/nuttx/pull/4816) arch: arm: Remove EXPERIMENTAL from ARCH_TRUSTZONE_XXX  * [#5562](https://github.com/apache/nuttx/pull/5562) arch: arm: add BUILD_KERNEL code in arm: arm_vectors.S  @@ -290,51 +290,51 @@ NuttX-10.3.0 * [#4957](https://github.com/apache/nuttx/pull/4957) arch: arm: cortex-m: hardfault: add usage/bus-fault handler  * [#4965](https://github.com/apache/nuttx/pull/4965) arch: arm: cortex-m23: remove mem-fault select from armv8-m baseline  -#### EFM32 +##### EFM32 * [#5587](https://github.com/apache/nuttx/pull/5587) arch: arm: efm32: Garbage configuration setting in EFM32 code  -#### IMX6 +##### IMX6 * [#5633](https://github.com/apache/nuttx/pull/5633) arch: arm: imx6: Fix imx6  * [#5639](https://github.com/apache/nuttx/pull/5639) arch: arm: imx6: Add the pgheap for imx6  -#### IMXRT +##### IMXRT * [#4784](https://github.com/apache/nuttx/pull/4784) arch: arm: imxrt: fixes  * [#4717](https://github.com/apache/nuttx/pull/4717) arch: arm: imxrt: rename imxrt_lowputc to arm_lowputc and drop CONFIG_DEBUG_FEATURES  -#### LC823450 +##### LC823450 * [#4951](https://github.com/apache/nuttx/pull/4951) arch: arm: lc823450: Replace the critical section with spinlock in lc823450_serial.c  -#### NRF52 +##### NRF52 * [#5025](https://github.com/apache/nuttx/pull/5025) arch: arm: nrf52: Fixes for NRF52 SoftDevice Controller  * [#5032](https://github.com/apache/nuttx/pull/5032) arch: arm: nrf52: NRF52_SDC_LE_CODED_PHY not available for nrf52832  * [#5031](https://github.com/apache/nuttx/pull/5031) arch: arm: nrf52: small improvements for softdevice  -#### PHY62XX +##### PHY62XX * [#5642](https://github.com/apache/nuttx/pull/5642) arch: arm: phy62xx: remove unused private header  -#### RP2040 +##### RP2040 * [#4786](https://github.com/apache/nuttx/pull/4786) arch: arm: rp2040: support I2C_RESET  -#### RTL8720C +##### RTL8720C * [#5552](https://github.com/apache/nuttx/pull/5552) arch: arm: rtl8720c: Remove the unused Toolchain.defs  -#### S32K1XX +##### S32K1XX * [#5220](https://github.com/apache/nuttx/pull/5220) arch: arm: s32k1xx: implement uniqueid  -#### SAM34 +##### SAM34 * [#5700](https://github.com/apache/nuttx/pull/5700) arch: arm: sam34: sam_dmac.c: Fix compilation error  -#### SAMV7 +##### SAMV7 * [#5513](https://github.com/apache/nuttx/pull/5513) arch: arm: samv7: fix peripheral id shift during transmit xdma configuration  * [#5413](https://github.com/apache/nuttx/pull/5413) arch: arm: samv7: sam_progmem: insert DMB instruction into data write loop  @@ -352,7 +352,7 @@ NuttX-10.3.0 * [#4899](https://github.com/apache/nuttx/pull/4899) arch: arm: samv7: fix page size flash writing for page unaligned addresses  * [#5393](https://github.com/apache/nuttx/pull/5393) arch: arm: samv7: fix leaving from critical section in HSMCI callback  -#### STM32 +##### STM32 * [#5206](https://github.com/apache/nuttx/pull/5206) arch: arm: stm32: add FDCAN support  * [#5169](https://github.com/apache/nuttx/pull/5169) arch: arm: stm32: add SocketCAN support  @@ -382,13 +382,13 @@ NuttX-10.3.0 * [#5666](https://github.com/apache/nuttx/pull/5666) arch: arm: stm32l4: stm32l4+ might need flash data cache corruption workaround  * [#4975](https://github.com/apache/nuttx/pull/4975) arch: arm: stm32l4: stm32l4_pwm.c: fix printf format  -#### CEVA +##### CEVA * [#5520](https://github.com/apache/nuttx/pull/5520) arch: ceva: update the code to the latest mainline  * [#5568](https://github.com/apache/nuttx/pull/5568) arch: ceva: Replace OUTDIR with TOPDIR  * [#5727](https://github.com/apache/nuttx/pull/5727) arch: ceva: Move the idle stack initialization to up_initial_state  -#### SIM +##### SIM * [#5696](https://github.com/apache/nuttx/pull/5696) arch: sim: add all symbols support  * [#5641](https://github.com/apache/nuttx/pull/5641) arch: sim: add loop thread to handle dev loops  @@ -424,7 +424,7 @@ NuttX-10.3.0 * [#5260](https://github.com/apache/nuttx/pull/5260) arch: sim: up_touchscreen: update up_touchscreen, using touch_upperhalf  * [#5226](https://github.com/apache/nuttx/pull/5226) arch: sim: netdev: eliminated RX data stream congestion in case of high TX network traffic  -#### RISC-V +##### RISC-V * [#5619](https://github.com/apache/nuttx/pull/5619) arch: espressif: Fix SCHED_CPULOAD feature using Oneshot Timer  * [#4728](https://github.com/apache/nuttx/pull/4728) arch: espressif: Rename MTD-related configs to become more intuitive  @@ -468,7 +468,7 @@ NuttX-10.3.0 * [#5210](https://github.com/apache/nuttx/pull/5210) arch: risc-v: Refine exception_common  * [#5236](https://github.com/apache/nuttx/pull/5236) arch: risc-v: Refine riscv_cpuindex.c  -#### BL602 +##### BL602 * [#5316](https://github.com/apache/nuttx/pull/5316) arch: risc-v: bl602: Fix broken bl602 flash due to partition_table being incorrectly marked as unused  * [#5221](https://github.com/apache/nuttx/pull/5221) arch: risc-v: bl602: Rename bl602_entry.S to bl602_head.S  @@ -477,7 +477,7 @@ NuttX-10.3.0 * [#5131](https://github.com/apache/nuttx/pull/5131) arch: risc-v: bl602: Fix preprocessing directives for uart flow control  * [#5093](https://github.com/apache/nuttx/pull/5093) arch: risc-v: bl602: Use userspace chosen channel numbers when starting bl602 pwm  -#### ESP32C3 +##### ESP32C3 * [#5129](https://github.com/apache/nuttx/pull/5129) arch: risc-v: esp32c3: SPI flash MTD device uses all flash space  * [#4771](https://github.com/apache/nuttx/pull/4771) arch: risc-v: esp32c3: Remove the DMA test included in the driver along with its defconfig.  @@ -503,7 +503,7 @@ NuttX-10.3.0 * [#5124](https://github.com/apache/nuttx/pull/5124) arch: risc-v: esp32s2/esp32c3: Remove unavailable support for ROM Basic Console  * [#5133](https://github.com/apache/nuttx/pull/5133) arch: risc-v: esp32s2/esp32c3: Add support for enabling hardware Flash Encryption on boot -#### MPFS +##### MPFS * [#4877](https://github.com/apache/nuttx/pull/4877) arch: risc-v: mpfs: Add spi cs control for mpfs  * [#5289](https://github.com/apache/nuttx/pull/5289) arch: risc-v: mpfs: bootloader entrypoints  @@ -534,12 +534,12 @@ NuttX-10.3.0 * [#5683](https://github.com/apache/nuttx/pull/5683) arch: risc-v/xtensa: correct dumpstate xcp size  * [#5717](https://github.com/apache/nuttx/pull/5717) Revert "arch: risc-v: Correct FPU register save area in riscv_copystate"  -#### SPARC +##### SPARC * [#5394](https://github.com/apache/nuttx/pull/5394) arch: sparc: adaptive patch  * [#5521](https://github.com/apache/nuttx/pull/5521) arch: sparc: Replace adj_stack_ptr with stack_base_ptr  -#### XTENSA +##### XTENSA * [#4688](https://github.com/apache/nuttx/pull/4688) arch: xtensa: Kconfig: add quotes in source to clean warnings from setconfig  * [#5738](https://github.com/apache/nuttx/pull/5738) arch: xtensa: Save exception cause and vaddr into the user frame  @@ -562,7 +562,7 @@ NuttX-10.3.0 * [#5679](https://github.com/apache/nuttx/pull/5679) arch: xtensa: xtensa_user_handler.S: Store EXCCAUSE and EXCVADDR into the user frame. * [#5000](https://github.com/apache/nuttx/pull/5000) arch: xtensa: correct the interrupt stack on irq handler  -#### ESP32 +##### ESP32 * [#5056](https://github.com/apache/nuttx/pull/5056) arch: xtensa: esp32: Add WiFi/BLE Coexistence support   * [#5187](https://github.com/apache/nuttx/pull/5187) arch: xtensa: esp32: Add PWM support using the LEDC peripheral  @@ -583,7 +583,7 @@ NuttX-10.3.0 * [#4867](https://github.com/apache/nuttx/pull/4867) arch: xtensa: esp32: Fix retrieving GPIOs' IRQ number and peripheral ID in SMP.  * [#4769](https://github.com/apache/nuttx/pull/4769) arch: xtensa: esp32: Make ESP32_BT_RESERVE_DRAM default to 0 again if Bluetooth is not enabled.  -#### ESP32S2 +##### ESP32S2 * [#5213](https://github.com/apache/nuttx/pull/5213) arch: xtensa: esp32s2: Fix some wrong definitions related to IRQ management  * [#5212](https://github.com/apache/nuttx/pull/5212) arch: xtensa: esp32s2: Fix data cache option in menuconfig  @@ -593,7 +593,7 @@ NuttX-10.3.0 * [#5698](https://github.com/apache/nuttx/pull/5698) arch: xtensa: esp32s2: Add support for Main System Watchdog Timers  * [#4703](https://github.com/apache/nuttx/pull/4703) arch: xtensa: esp32s2: Add RNG driver support and board profile example  -#### ESP32S3 +##### ESP32S3 * [#5665](https://github.com/apache/nuttx/pull/5665) arch: xtensa: esp32s3: Add SPI-Flash support  * [#5699](https://github.com/apache/nuttx/pull/5699) arch: xtensa: esp32s3: Enable SMP support  @@ -607,14 +607,14 @@ NuttX-10.3.0 * [#5608](https://github.com/apache/nuttx/pull/5608) arch: xtensa: esp32s3: Add support for Oneshot timer  * [#5722](https://github.com/apache/nuttx/pull/5722) arch: xtensa: esp32s3: Stall Timer ISR when core 1 is temporarily stalled  -#### Z80 +##### Z80 * [#5726](https://github.com/apache/nuttx/pull/5726) arch: z[80|16]: Move up_getsp declaration to arch.h  * [#5344](https://github.com/apache/nuttx/pull/5344) arch: z80: fix garbage collector option to linker for ez80  -## Driver Support +### Driver Support -### Drivers With Significant Improvements +#### Drivers With Significant Improvements * [#5256](https://github.com/apache/nuttx/pull/5256) drivers: Add usbdev serial use boardid  * [#5728](https://github.com/apache/nuttx/pull/5728) drivers: Merge the common driver initialization into one place  @@ -720,7 +720,7 @@ NuttX-10.3.0 * [#4778](https://github.com/apache/nuttx/pull/4778) drivers: wireless: bcm43xxx: corrected SDIO_CCCR_HIGHSPEED_SHS bit handling  * [#5497](https://github.com/apache/nuttx/pull/5497) drivers: wireless: Fix gs2200m_ioctl_accept()  -### New Driver Support +#### New Driver Support * [#5002](https://github.com/apache/nuttx/pull/5002) drivers: analog: add mcp48xx dac support  * [#5376](https://github.com/apache/nuttx/pull/5376) drivers: i2c: Add TCA9548A I2C Multiplexer  @@ -733,16 +733,16 @@ NuttX-10.3.0 * [#5258](https://github.com/apache/nuttx/pull/5258) drivers: input: add touchscreen uinput driver  * [#5327](https://github.com/apache/nuttx/pull/5327) drivers: segger: add Segger System View support  -## Board Support +### Board Support -### New Board Support +#### New Board Support * [#5363](https://github.com/apache/nuttx/pull/5363) boards: arm: phy62xx: add phyplus_rel_1.4  * [#4916](https://github.com/apache/nuttx/pull/4916) boards: arm: samv7: add support for SAME70 QMTECH board  * [#5195](https://github.com/apache/nuttx/pull/5195) boards: arm: rp2040: add support for Pimoroni Tiny 2040 board * [#4851](https://github.com/apache/nuttx/pull/4851) boards: risc-v: mpfs: Add support for Aries M100PFSMVP board  -### Boards With Significant Improvements +#### Boards With Significant Improvements * [#5553](https://github.com/apache/nuttx/pull/5553) boards: Add -fno-common to ARCHCFLAGS and ARCHCXXFLAGS  * [#5330](https://github.com/apache/nuttx/pull/5330) boards: Board.mk: Make romfs_img 4 byte aligned  @@ -757,36 +757,36 @@ NuttX-10.3.0 * [#5557](https://github.com/apache/nuttx/pull/5557) boards: Replace CONFIG_CYGWIN_WINTOOL with CONVERT_PATH  * [#5282](https://github.com/apache/nuttx/pull/5282) boards: Update board Make.defs -#### CXD56 +##### CXD56 * [#5440](https://github.com/apache/nuttx/pull/5440) boards: arm: cxd56xx: audio: Support I2S input  * [#4996](https://github.com/apache/nuttx/pull/4996) boards: arm: cxd56xx: spresense: Adjust CONFIG_FAT_MAXFNAME and CONFIG_NAME_MAX  * [#4969](https://github.com/apache/nuttx/pull/4969) boards: arm: cxd56xx: spresense: Update smp/defconfig  -#### IMX6 +##### IMX6 * [#5652](https://github.com/apache/nuttx/pull/5652) boards: arm: imx6: sabre-6quad: Add knsh  * [#5485](https://github.com/apache/nuttx/pull/5485) boards: arm: imx6: sabre-6quad: Add -fno-common to Make.defs * [#5724](https://github.com/apache/nuttx/pull/5724) boards: arm: imx6: sabre-6quad: Add CONFIG_DEBUG_FULLOPT=y to knsh/defconfig  -#### IMXRT +##### IMXRT * [#5670](https://github.com/apache/nuttx/pull/5670) boards: arm: imxrt: fix userled config in appinit  * [#5682](https://github.com/apache/nuttx/pull/5682) boards: arm: imxrt: userleds: Teensy 4.x board LED is active high  -#### LC823450 +##### LC823450 * [#4947](https://github.com/apache/nuttx/pull/4947) boards: arm: lc823450: lc823450-xgevk: Update bt/defconfig for SMP    -#### NRF52 +##### NRF52 * [#5023](https://github.com/apache/nuttx/pull/5023) boards: arm: nrf52: nrf52832-dk/nrf52840-dk: add procfs and sdc support  -#### PHY62XX +##### PHY62XX * [#5669](https://github.com/apache/nuttx/pull/5669) boards: arm: phy62xx: phy6222: remove -nostartfiles -nodefaultlibs  -#### SAMV7 +##### SAMV7 * [#5406](https://github.com/apache/nuttx/pull/5406) boards: arm: samv7: disable systick no matter if ARMV7M_SYSTICK is enabled or not * [#5710](https://github.com/apache/nuttx/pull/5710) boards: arm: samv7: rework linker script usage logic to allow custom linker scripts  @@ -808,7 +808,7 @@ NuttX-10.3.0 * [#4906](https://github.com/apache/nuttx/pull/4906) boards: arm: same70-xplained: fix usage of SAMV71XULT instead of SAME70XPLAINED  * [#4915](https://github.com/apache/nuttx/pull/4915) boards: arm: same70-xplained: MCUboot related improvements  -#### STM32 +##### STM32 * [#5011](https://github.com/apache/nuttx/pull/5011) boards: arm: stm32: emw3162: enabled internal pull-up resistors on SDIO bus  * [#4750](https://github.com/apache/nuttx/pull/4750) boards: arm: stm32: Normalize FOC related project  @@ -826,19 +826,19 @@ NuttX-10.3.0 * [#5009](https://github.com/apache/nuttx/pull/5009) boards: arm: stm32: nucleo-f4x1re: Correct issues with userled support on the Nucleo F4x1RE.  * [#5130](https://github.com/apache/nuttx/pull/5130) boards: arm: stm32: photon: added configuration to measure wlan performance  -#### STM32H7 +##### STM32H7 * [#5697](https://github.com/apache/nuttx/pull/5697) boards: arm: stm32[f7|l4]: fix SPI chip select GPIO access  * [#4827](https://github.com/apache/nuttx/pull/4827) boards: arm: stm32h7: nucleo-h743zi: add board_reset function  -#### TIVA +##### TIVA * [#5664](https://github.com/apache/nuttx/pull/5664) boards: arm: tiva: ekk-lm3s9b96: Remove unused mmcsd option  * [#5595](https://github.com/apache/nuttx/pull/5595) boards: arm: tiva: lm3s6965-ek: Add qemu-kostest   * [#5597](https://github.com/apache/nuttx/pull/5597) boards: arm: tiva: lm3s6965-ek: Fix qemu-kostest  * [#5597](https://github.com/apache/nuttx/pull/5597) boards: arm: tiva: lm3s6965-ek: Fix qemu-kostest  -#### RISC-V +##### RISC-V * [#5134](https://github.com/apache/nuttx/pull/5134) boards: risc-v: hifive1-revb: Enable some nsh commands in nsh/defconfig  * [#4675](https://github.com/apache/nuttx/pull/4675) boards: risc-v: k210: Add initial gpio user space support  @@ -849,7 +849,7 @@ NuttX-10.3.0 * [#5500](https://github.com/apache/nuttx/pull/5500) boards: risc-v: bl602: Remove -D__NuttX__ from Makefile  * [#5515](https://github.com/apache/nuttx/pull/5515) boards: risc-v: rv-virt: Supports FPU test and ostest in both rv32/rv64  -#### SIM +##### SIM * [#5544](https://github.com/apache/nuttx/pull/5544) boards: sim: Add missing options to sim:vncserver  * [#5559](https://github.com/apache/nuttx/pull/5559) boards: sim: Rename ARCHCPUFLAGS[XX] to ARCHC[XX]FLAGS  @@ -863,11 +863,11 @@ NuttX-10.3.0 * [#5121](https://github.com/apache/nuttx/pull/5121) boards: sim: recovered eth0 interface in sim:tcpblaster configuration  * [#5383](https://github.com/apache/nuttx/pull/5383) boards: sim: Make.defs: CELFFLAGS += -mcmodel=large  -#### SPARC +##### SPARC * [#5644](https://github.com/apache/nuttx/pull/5644) boards: sparc: Remove HOSTCC related flags from Make.defs  -#### XTENSA +##### XTENSA * [#4719](https://github.com/apache/nuttx/pull/4719) boards: xtensa: esp32: Refactor SPI Flash File system mount options on menuconfig  * [#5596](https://github.com/apache/nuttx/pull/5596) boards: xtensa: esp32: Update esp-wireless-drivers-3rdparty  @@ -877,9 +877,9 @@ NuttX-10.3.0 * [#5654](https://github.com/apache/nuttx/pull/5654) boards: xtensa: esp32-devkitc: Increase INIT_STACKSIZE to 3072 in smp/defconfig  * [#5075](https://github.com/apache/nuttx/pull/5075) boards: xtensa: esp32-devkitc: Change CONFIG_USER_ENTRYPOINT to CONFIG_INIT_ENTRYPOINT  -## File System +### File System -### Bug Fixes +#### Bug Fixes * [#4694](https://github.com/apache/nuttx/pull/4694) fs: littlefs: fix rmdir can remove a file * [#4722](https://github.com/apache/nuttx/pull/4722) fs: mqueue: fix memory leak cause by lost inode_release  @@ -891,7 +891,7 @@ NuttX-10.3.0 * [#5172](https://github.com/apache/nuttx/pull/5172) fs: procfs: fix readdir loss last character * [#4968](https://github.com/apache/nuttx/pull/4968) fs: fat: Use uint16_t instead of wchar_t  -### Significant Improvements +#### Significant Improvements * [#5108](https://github.com/apache/nuttx/pull/5108) fs: change fs strncpy to strlcpy to avoid losing'\0'  * [#5460](https://github.com/apache/nuttx/pull/5460) fs: epoll_fd: support dup file descriptor @@ -913,9 +913,9 @@ NuttX-10.3.0 * [#5224](https://github.com/apache/nuttx/pull/5224) fs: vfs: Do not require write-access for fsync  * [#4767](https://github.com/apache/nuttx/pull/4767) fs: vfs: sanity check for parameter:length  -## Networking +### Networking -### Improvements +#### Improvements * [#5254](https://github.com/apache/nuttx/pull/5254) net: unify FAR keyword usage for all net buffer memory mapped buffers  * [#5049](https://github.com/apache/nuttx/pull/5049) net: Update IFF_RUNNING flag by netdev_carrier_on and netdev_carrier_off  @@ -953,7 +953,7 @@ NuttX-10.3.0 * [#5156](https://github.com/apache/nuttx/pull/5156) net: usrsock: add support for CONFIG_NET_ALLOC_CONNS  * [#5045](https://github.com/apache/nuttx/pull/5045) net: usrsock: increase the sendto() length limit to UINT32_MAX  -### Bug Fixes +#### Bug Fixes * [#5480](https://github.com/apache/nuttx/pull/5480) net: can: can_setsockopt.c: fix assertion, value can be NULL  * [#5141](https://github.com/apache/nuttx/pull/5141) net: can: SocketCAN: minor fixes  @@ -982,7 +982,7 @@ NuttX-10.3.0 * [#4890](https://github.com/apache/nuttx/pull/4890) net: udp/icmp: correct the unreadchable handling  * [#5154](https://github.com/apache/nuttx/pull/5154) net: usrsock: replace xid type to uint64_t to avoid limitation of connections  -## Security Issues Fixed In This Release +### Security Issues Fixed In This Release Compatibility Concerns Renamed Kconfigs diff --git a/Documentation/ReleaseNotes/NuttX-11.0.0 b/Documentation/ReleaseNotes/NuttX-11.0.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-11.0.0 rename to Documentation/ReleaseNotes/NuttX-11.0.0.md index 0ff8bfb459b..a1144200a85 100644 --- a/Documentation/ReleaseNotes/NuttX-11.0.0 +++ b/Documentation/ReleaseNotes/NuttX-11.0.0.md @@ -1,9 +1,9 @@ NuttX-11.0.0 ------------- +============ -# What's New In This Release +## What's New In This Release -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#5978](https://github.com/apache/nuttx/pull/5978) nuttx: unify FAR attribute usage across the code * [#6064](https://github.com/apache/nuttx/pull/6064) sched/environ: Ensure tg_envp terminated by double @@ -145,9 +145,9 @@ NuttX-11.0.0 * [#6205](https://github.com/apache/nuttx/pull/6205) binfmt/libelf: Fix function description field * [#6190](https://github.com/apache/nuttx/pull/6190) binfmt_execmodule: Use heap size getter for print -# Major Changes to the Build System +## Major Changes to the Build System -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#6015](https://github.com/apache/nuttx/pull/6015) configure.sh: Make top Make.defs symlink to board Make.defs instead * [#6014](https://github.com/apache/nuttx/pull/6014) checkpatch.sh: add -m option to enable/disable Change-Id check @@ -165,9 +165,9 @@ NuttX-11.0.0 * [#6232](https://github.com/apache/nuttx/pull/6232) tools/nxstyle: Add the suffix white list * [#6180](https://github.com/apache/nuttx/pull/6180) tools/testbuild.sh: Don't skip configure and distclean -# Architectural Support +## Architectural Support -## New Architecture Support +### New Architecture Support * [#6179](https://github.com/apache/nuttx/pull/6179) tlsr82: first commit of telink tlsr82xx chip port * [#6687](https://github.com/apache/nuttx/pull/6687) Add support for NXP S32K3XX MCU family and boards @@ -176,7 +176,7 @@ NuttX-11.0.0 * [#6418](https://github.com/apache/nuttx/pull/6418) Eps32 Lilygo t5v2 BSP * [#6478](https://github.com/apache/nuttx/pull/6478) arch: arm64: ARMv8-A support for NuttX -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#6188](https://github.com/apache/nuttx/pull/6188) arch: Move -fstack-protector-all and -finstrument-functions from Make.defs to Toolchain.defs * [#6200](https://github.com/apache/nuttx/pull/6200) arch: Add gcov related config for arm/risc-v/xtensa @@ -524,9 +524,9 @@ NuttX-11.0.0 * [#5988](https://github.com/apache/nuttx/pull/5988) arch/sim: support simulator keyboard devices * [#6043](https://github.com/apache/nuttx/pull/6043) sim: bt: Add specific bluetooth HCI number id -# Driver Support +## Driver Support -## New Driver Support +### New Driver Support * [#6030](https://github.com/apache/nuttx/pull/6030) Add Sensirion's SCD41 driver and minor fix * [#6412](https://github.com/apache/nuttx/pull/6412) drivers/sensors: add driver for as5048a magnetic encoder @@ -540,7 +540,7 @@ NuttX-11.0.0 * [#6408](https://github.com/apache/nuttx/pull/6408) e-ink ssd1680 driver * [#6353](https://github.com/apache/nuttx/pull/6353) Add driver for WIZnet W5500 Ethernet controller -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#6068](https://github.com/apache/nuttx/pull/6068) driver/mmcsdio: do not hold the semaphore on interrupt context * [#6019](https://github.com/apache/nuttx/pull/6019) power/governor: Remove the duplicated function prototype @@ -630,8 +630,8 @@ NuttX-11.0.0 * [#6344](https://github.com/apache/nuttx/pull/6344) Video: various updates * [#6320](https://github.com/apache/nuttx/pull/6320) use rmutex inside of all repeated implementation -# Board Support -## New Board Support +## Board Support +### New Board Support * [#6216](https://github.com/apache/nuttx/pull/6216) Nucleo G474RE board support including USB Full Speed Device * [#6754](https://github.com/apache/nuttx/pull/6754) NXP S32K1XX: add initial support for NXP RDDRONE-BMS772 board @@ -647,7 +647,7 @@ NuttX-11.0.0 * [#6266](https://github.com/apache/nuttx/pull/6266) Nucleo f401 re oled * [#6592](https://github.com/apache/nuttx/pull/6592) boards: add initial support for stm32l0538-disco -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#6684](https://github.com/apache/nuttx/pull/6684) Enable to test C++ static object in ELF * [#6036](https://github.com/apache/nuttx/pull/6036) arch, boards: cxd56xx: Minor update for spresense @@ -711,9 +711,9 @@ NuttX-11.0.0 * [#6585](https://github.com/apache/nuttx/pull/6585) esp32s3-devkit: Add support to ST7735 SPI LCD * [#6648](https://github.com/apache/nuttx/pull/6648) Added Adafruit QT Py RP2040 board and made UART, SPI, and I2C configuration more flexible -# File System +## File System -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#6726](https://github.com/apache/nuttx/pull/6726) vfs: Remove the unnecessary check when CONFIG_DEBUG_MM enable * [#6007](https://github.com/apache/nuttx/pull/6007) fs/vfs: fix st_mode mask check @@ -761,9 +761,9 @@ NuttX-11.0.0 * [#6681](https://github.com/apache/nuttx/pull/6681) unlink: don't do unlink with inode_semtake * [#6637](https://github.com/apache/nuttx/pull/6637) mtd/smartfs: Fix uninitialized variable -# Networking +## Networking -## Bug Fixes and Improvements +### Bug Fixes and Improvements * [#5967](https://github.com/apache/nuttx/pull/5967) net:fix coverity warning * [#5972](https://github.com/apache/nuttx/pull/5972) net/utils: fix IPv4 checksum calculation diff --git a/Documentation/ReleaseNotes/NuttX-12.0.0 b/Documentation/ReleaseNotes/NuttX-12.0.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.0.0 rename to Documentation/ReleaseNotes/NuttX-12.0.0.md index c02e67eb3c6..b991fca8639 100644 --- a/Documentation/ReleaseNotes/NuttX-12.0.0 +++ b/Documentation/ReleaseNotes/NuttX-12.0.0.md @@ -1,9 +1,9 @@ NuttX-12.0.0 ------------- +============ -# What's New In This Release +## What's New In This Release -## Core OS Improvements +### Core OS Improvements  * [#7493](https://github.com/apache/incubator-nuttx/pull/7493) sched: clock: adjust clock function to support tick  * [#7200](https://github.com/apache/incubator-nuttx/pull/7200) sched: clock: Rename g_system_timer to g_system_ticks @@ -139,7 +139,7 @@ NuttX-12.0.0  * [#7310](https://github.com/apache/incubator-nuttx/pull/7310) libc: stdio: fix ungetc operation  * [#7715](https://github.com/apache/incubator-nuttx/pull/7715) libc: stream: add putc interface for mtd/blk stream.  * [#7694](https://github.com/apache/incubator-nuttx/pull/7694) libc: stream: Remove \n special handle from syslogstream_putc - * [#7772](https://github.com/apache/incubator-nuttx/pull/7772) libc: stream: Rename [lib_stream_](put|get) to [lib_stream_](putc|getc) + * [#7772](https://github.com/apache/incubator-nuttx/pull/7772) libc: stream: Rename \[lib_stream_](put|get) to \[lib_stream_](putc|getc)  * [#7348](https://github.com/apache/incubator-nuttx/pull/7348) libc: strftime: Added support for the %w format specifier.  * [#7455](https://github.com/apache/incubator-nuttx/pull/7455) libc: time: fix regression in clock_calendar2utc  * [#7440](https://github.com/apache/incubator-nuttx/pull/7440) libc: time: mktime normalize struct tm @@ -174,7 +174,7 @@ NuttX-12.0.0  * [#6981](https://github.com/apache/incubator-nuttx/pull/6981) up_nputs: fix AddressSanitizer: global-buffer-overflow problem  * [#7420](https://github.com/apache/incubator-nuttx/pull/7420) Update errno to match asm-generic -## Build System Improvements +### Build System Improvements  * [#7419](https://github.com/apache/incubator-nuttx/pull/7419) Makefile: Remove INCDIROPT  * [#7118](https://github.com/apache/incubator-nuttx/pull/7118) Remove EXPERIMENTAL from some long existent config @@ -200,15 +200,15 @@ NuttX-12.0.0  * [#7560](https://github.com/apache/incubator-nuttx/pull/7560) tools: Fix some build error  * [#7529](https://github.com/apache/incubator-nuttx/pull/7529) tools: Fix some configure error in Windows native build -## Architectural Support -### New Architecture Support +### Architectural Support +#### New Architecture Support  * [#7011](https://github.com/apache/incubator-nuttx/pull/7011) arch: arm: add chip GD32F450 of GD32MCU   * [#7125](https://github.com/apache/incubator-nuttx/pull/7125) arch: arm: initial support for NRF5340   * [#7443](https://github.com/apache/incubator-nuttx/pull/7443) arch: sparc: add initial support for S698PM chip and SMP  * [#7692](https://github.com/apache/incubator-nuttx/pull/7692) arch: arm: arm64: Add support for PINE64 PinePhone -### Architecture Improvements +#### Architecture Improvements  * [#7804](https://github.com/apache/incubator-nuttx/pull/7804) arch: arch_alarm: don't init local variable for fpu test case fail  * [#7160](https://github.com/apache/incubator-nuttx/pull/7160) arch: Change the linker generated symbols from uint32_t to uint8_t * @@ -447,8 +447,8 @@ NuttX-12.0.0  * [#7641](https://github.com/apache/incubator-nuttx/pull/7641) arch: xtensa: esp32s2: i2s: implement I2S receiver module  * [#7799](https://github.com/apache/incubator-nuttx/pull/7799) arch: xtensa: esp32-s3: Add support for Protected Mode -## Driver Support -### New Driver Support +### Driver Support +#### New Driver Support  * [#7042](https://github.com/apache/incubator-nuttx/pull/7042) drivers: Add rpmsgmtd support  * [#7466](https://github.com/apache/incubator-nuttx/pull/7466) drivers: sensors: add LTR308 ambient light sensor @@ -458,7 +458,7 @@ NuttX-12.0.0  * [#7678](https://github.com/apache/incubator-nuttx/pull/7678) drivers: segger: Add Segger RTT stream support  * [#7609](https://github.com/apache/incubator-nuttx/pull/7609) drivers: mtd: add support for mx25l16 serial flash -### Drivers With Significant Improvements +#### Drivers With Significant Improvements  * [#7429](https://github.com/apache/incubator-nuttx/pull/7429) drivers: audio: add i2s_mclkfrequency method to the I2S lower half  * [#7225](https://github.com/apache/incubator-nuttx/pull/7225) drivers: btuart driver improvement @@ -531,8 +531,8 @@ NuttX-12.0.0  * [#7374](https://github.com/apache/incubator-nuttx/pull/7374) drivers: wireless: bcm43xxx: correct auth status if PSK is invalid  * [#7543](https://github.com/apache/incubator-nuttx/pull/7543) drivers: wireless: lpwan/sx127x: correct device unlock interface to nxmutex_unlock() -## Board Support -### New Board Support +### Board Support +#### New Board Support  * [#6850](https://github.com/apache/incubator-nuttx/pull/6850) boards: arm: rp2040: Added support for Raspberry Pi Pico W  * [#7418](https://github.com/apache/incubator-nuttx/pull/7418) boards: arm: stm32wb: Flipper Zero initial support @@ -543,7 +543,7 @@ NuttX-12.0.0  * [#7169](https://github.com/apache/incubator-nuttx/pull/7169) boards: xtensa: initial support for the ESP32-LyraT  * [#7073](https://github.com/apache/incubator-nuttx/pull/7073) boards: xtensa: ttgo_lora_esp32: Add support to SX1276 -### Boards With Significant Improvements +#### Boards With Significant Improvements  * [#7330](https://github.com/apache/incubator-nuttx/pull/7330) boards: Change CONFIG_SYSTEM_NSH_SYMTAB to CONFIG_NSH_SYMTAB  * [#7245](https://github.com/apache/incubator-nuttx/pull/7245) boards: Change the linker generated symbols from uint32_t to uint8_t array @@ -634,7 +634,7 @@ NuttX-12.0.0  * [#7559](https://github.com/apache/incubator-nuttx/pull/7559) boards: xtensa: esp32-lyrat: Remove CONFIG_MM_CIRCBUF=y from audio config -## File System Improvements +### File System Improvements  * [#6932](https://github.com/apache/incubator-nuttx/pull/6932) fs: aio: fix typo ail  * [#6803](https://github.com/apache/incubator-nuttx/pull/6803) fs: directory: Using file api to implement operations on directories @@ -674,12 +674,12 @@ NuttX-12.0.0  * [#7742](https://github.com/apache/incubator-nuttx/pull/7742) fs: vfs: timerfd_create: initial reference count to zero  * [#7035](https://github.com/apache/incubator-nuttx/pull/7035) fs: vfs: fs_open.c: Improve documentation blocks of functions -## Networking -### New Features +### Networking +#### New Features  * [#7562](https://github.com/apache/incubator-nuttx/pull/7562) net: Add Network Address Translation (NAT) for NuttX -### Improvements +#### Improvements  * [#7828](https://github.com/apache/incubator-nuttx/pull/7828) net: Adjust ioctl function of cellular  * [#7821](https://github.com/apache/incubator-nuttx/pull/7821) net: Add mtu set and interface name set in ioctl @@ -780,9 +780,9 @@ NuttX-12.0.0  * [#7576](https://github.com/apache/incubator-nuttx/pull/7576) net: rpmsg: add lock to poll & poll_notify   * [#6978](https://github.com/apache/incubator-nuttx/pull/6978) net: Align the prototype of sock_intf_s::si_ioctl with file_operations::ioctl -## Security Issues Fixed In This Release -## Compatibility Concerns -## API Changes +### Security Issues Fixed In This Release +### Compatibility Concerns +### API Changes Default Semaphore Protocol Changed When NuttX is built with priority inheritance (CONFIG_PRIORITY_INHERITANCE), priority inheritance can be enabled or disabled per semaphore and care must be taken to make the correct choice based on how each semaphore is used. diff --git a/Documentation/ReleaseNotes/NuttX-12.1.0 b/Documentation/ReleaseNotes/NuttX-12.1.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.1.0 rename to Documentation/ReleaseNotes/NuttX-12.1.0.md index 44300d8c1a8..1934a57d80f 100644 --- a/Documentation/ReleaseNotes/NuttX-12.1.0 +++ b/Documentation/ReleaseNotes/NuttX-12.1.0.md @@ -1,5 +1,5 @@ NuttX-12.1.0 ------------- +============ What's New In This Release diff --git a/Documentation/ReleaseNotes/NuttX-12.10.0 b/Documentation/ReleaseNotes/NuttX-12.10.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.10.0 rename to Documentation/ReleaseNotes/NuttX-12.10.0.md index bd7576e06f5..4ae456fb30d 100644 --- a/Documentation/ReleaseNotes/NuttX-12.10.0 +++ b/Documentation/ReleaseNotes/NuttX-12.10.0.md @@ -1,5 +1,5 @@ NuttX-12.10.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.11.0 b/Documentation/ReleaseNotes/NuttX-12.11.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.11.0 rename to Documentation/ReleaseNotes/NuttX-12.11.0.md index 3036af24e33..f5f7496119f 100644 --- a/Documentation/ReleaseNotes/NuttX-12.11.0 +++ b/Documentation/ReleaseNotes/NuttX-12.11.0.md @@ -1,5 +1,5 @@ NuttX-12.11.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.12.0 b/Documentation/ReleaseNotes/NuttX-12.12.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.12.0 rename to Documentation/ReleaseNotes/NuttX-12.12.0.md index 48b02cc8d07..530895516e1 100644 --- a/Documentation/ReleaseNotes/NuttX-12.12.0 +++ b/Documentation/ReleaseNotes/NuttX-12.12.0.md @@ -1,5 +1,5 @@ NuttX-12.12.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.13.0 b/Documentation/ReleaseNotes/NuttX-12.13.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.13.0 rename to Documentation/ReleaseNotes/NuttX-12.13.0.md index 571b4b19686..17f7a6a7e49 100644 --- a/Documentation/ReleaseNotes/NuttX-12.13.0 +++ b/Documentation/ReleaseNotes/NuttX-12.13.0.md @@ -1,5 +1,5 @@ NuttX-12.13.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.2.0 b/Documentation/ReleaseNotes/NuttX-12.2.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.2.0 rename to Documentation/ReleaseNotes/NuttX-12.2.0.md index 817b406d1d6..d745afba491 100644 --- a/Documentation/ReleaseNotes/NuttX-12.2.0 +++ b/Documentation/ReleaseNotes/NuttX-12.2.0.md @@ -1,5 +1,5 @@ NuttX-12.2.0 ------------- +============ What's New In This Release diff --git a/Documentation/ReleaseNotes/NuttX-12.2.1 b/Documentation/ReleaseNotes/NuttX-12.2.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.2.1 rename to Documentation/ReleaseNotes/NuttX-12.2.1.md index f01ce0b77c4..d4e4a6bec29 100644 --- a/Documentation/ReleaseNotes/NuttX-12.2.1 +++ b/Documentation/ReleaseNotes/NuttX-12.2.1.md @@ -1,5 +1,5 @@ NuttX-12.2.1 ------------- +============ What's New In This Release Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.3.0 b/Documentation/ReleaseNotes/NuttX-12.3.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.3.0 rename to Documentation/ReleaseNotes/NuttX-12.3.0.md index 2a6e3e63673..8929b53ed99 100644 --- a/Documentation/ReleaseNotes/NuttX-12.3.0 +++ b/Documentation/ReleaseNotes/NuttX-12.3.0.md @@ -1,5 +1,5 @@ NuttX-12.3.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.4.0 b/Documentation/ReleaseNotes/NuttX-12.4.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.4.0 rename to Documentation/ReleaseNotes/NuttX-12.4.0.md index 8ccd34085ff..f1b2e26a82f 100644 --- a/Documentation/ReleaseNotes/NuttX-12.4.0 +++ b/Documentation/ReleaseNotes/NuttX-12.4.0.md @@ -1,5 +1,5 @@ NuttX-12.4.0 ------------- +============ What's New In This Release Improvements to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.5.0 b/Documentation/ReleaseNotes/NuttX-12.5.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.5.0 rename to Documentation/ReleaseNotes/NuttX-12.5.0.md index 67caeb8d298..f45d723bb3e 100644 --- a/Documentation/ReleaseNotes/NuttX-12.5.0 +++ b/Documentation/ReleaseNotes/NuttX-12.5.0.md @@ -1,5 +1,5 @@ NuttX-12.5.0 ------------- +============ What's New In This Release Improvements to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.5.1 b/Documentation/ReleaseNotes/NuttX-12.5.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.5.1 rename to Documentation/ReleaseNotes/NuttX-12.5.1.md index 1b1360b38d0..fbc3c2094be 100644 --- a/Documentation/ReleaseNotes/NuttX-12.5.1 +++ b/Documentation/ReleaseNotes/NuttX-12.5.1.md @@ -1,5 +1,5 @@ NuttX-12.5.1 ------------- +============ What's New In This Release diff --git a/Documentation/ReleaseNotes/NuttX-12.6.0 b/Documentation/ReleaseNotes/NuttX-12.6.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.6.0 rename to Documentation/ReleaseNotes/NuttX-12.6.0.md index 6ee9915d4f9..ae70f5d2c0a 100644 --- a/Documentation/ReleaseNotes/NuttX-12.6.0 +++ b/Documentation/ReleaseNotes/NuttX-12.6.0.md @@ -1,5 +1,5 @@ NuttX-12.6.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.7.0 b/Documentation/ReleaseNotes/NuttX-12.7.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.7.0 rename to Documentation/ReleaseNotes/NuttX-12.7.0.md index 985343dd268..70c02f35880 100644 --- a/Documentation/ReleaseNotes/NuttX-12.7.0 +++ b/Documentation/ReleaseNotes/NuttX-12.7.0.md @@ -1,5 +1,5 @@ NuttX-12.7.0 ------------- +============ What's New In This Release Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.8.0 b/Documentation/ReleaseNotes/NuttX-12.8.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.8.0 rename to Documentation/ReleaseNotes/NuttX-12.8.0.md index 2e8df3b095f..30f2df4e771 100644 --- a/Documentation/ReleaseNotes/NuttX-12.8.0 +++ b/Documentation/ReleaseNotes/NuttX-12.8.0.md @@ -1,5 +1,5 @@ NuttX-12.8.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-12.9.0 b/Documentation/ReleaseNotes/NuttX-12.9.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-12.9.0 rename to Documentation/ReleaseNotes/NuttX-12.9.0.md index 5d3a5c22e30..8b9c0c684bd 100644 --- a/Documentation/ReleaseNotes/NuttX-12.9.0 +++ b/Documentation/ReleaseNotes/NuttX-12.9.0.md @@ -1,5 +1,5 @@ NuttX-12.9.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-13.0.0 b/Documentation/ReleaseNotes/NuttX-13.0.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-13.0.0 rename to Documentation/ReleaseNotes/NuttX-13.0.0.md index e4dd19106f0..a5fe11b8c7c 100644 --- a/Documentation/ReleaseNotes/NuttX-13.0.0 +++ b/Documentation/ReleaseNotes/NuttX-13.0.0.md @@ -1,5 +1,5 @@ NuttX-13.0.0 ------------- +============ What's New In This Release Major Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-13.0.1 b/Documentation/ReleaseNotes/NuttX-13.0.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-13.0.1 rename to Documentation/ReleaseNotes/NuttX-13.0.1.md index 8220ff22410..1b05918ef1f 100644 --- a/Documentation/ReleaseNotes/NuttX-13.0.1 +++ b/Documentation/ReleaseNotes/NuttX-13.0.1.md @@ -1,5 +1,5 @@ NuttX-13.0.1 ------------- +============ What's New In This Release Changes to Core OS diff --git a/Documentation/ReleaseNotes/NuttX-4.14 b/Documentation/ReleaseNotes/NuttX-4.14.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-4.14 rename to Documentation/ReleaseNotes/NuttX-4.14.md index edf95eebf59..a906e478ac1 100644 --- a/Documentation/ReleaseNotes/NuttX-4.14 +++ b/Documentation/ReleaseNotes/NuttX-4.14.md @@ -1,5 +1,5 @@ NuttX-4.14 ----------- +========== This is the 46th release of NuttX. The release extends the support for the STMicro STM32 microcontroller. Minimal support for the diff --git a/Documentation/ReleaseNotes/NuttX-5.0 b/Documentation/ReleaseNotes/NuttX-5.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.0 rename to Documentation/ReleaseNotes/NuttX-5.0.md index 5bdd9cc3527..d78b78950c1 100644 --- a/Documentation/ReleaseNotes/NuttX-5.0 +++ b/Documentation/ReleaseNotes/NuttX-5.0.md @@ -1,5 +1,5 @@ NuttX-5.0 ---------- +========= This is 47th release of NuttX and the successor to nuttx-4.14. This major revision number has been incremented to indicate that an diff --git a/Documentation/ReleaseNotes/NuttX-5.1 b/Documentation/ReleaseNotes/NuttX-5.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.1 rename to Documentation/ReleaseNotes/NuttX-5.1.md index b83df8f225a..17058924b84 100644 --- a/Documentation/ReleaseNotes/NuttX-5.1 +++ b/Documentation/ReleaseNotes/NuttX-5.1.md @@ -1,5 +1,5 @@ NuttX-5.1 ---------- +========= This is the 48th release of NuttX. This release adds support for two new MCU architectures in various states of development: diff --git a/Documentation/ReleaseNotes/NuttX-5.10 b/Documentation/ReleaseNotes/NuttX-5.10.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.10 rename to Documentation/ReleaseNotes/NuttX-5.10.md index 68d4633e212..688a2d27ba5 100644 --- a/Documentation/ReleaseNotes/NuttX-5.10 +++ b/Documentation/ReleaseNotes/NuttX-5.10.md @@ -1,5 +1,5 @@ NuttX-5.10 ----------- +========== This is the 57th release of NuttX. This release includes a combination of some new features as well as several bugfixes. New features diff --git a/Documentation/ReleaseNotes/NuttX-5.11 b/Documentation/ReleaseNotes/NuttX-5.11.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.11 rename to Documentation/ReleaseNotes/NuttX-5.11.md index b4bb47a827a..fd3c3d843d8 100644 --- a/Documentation/ReleaseNotes/NuttX-5.11 +++ b/Documentation/ReleaseNotes/NuttX-5.11.md @@ -1,5 +1,5 @@ NuttX-5.11 ----------- +========== This is the 58th release of NuttX. This is a bugfix release. diff --git a/Documentation/ReleaseNotes/NuttX-5.12 b/Documentation/ReleaseNotes/NuttX-5.12.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.12 rename to Documentation/ReleaseNotes/NuttX-5.12.md index 27f2493d537..e3d5a2398e6 100644 --- a/Documentation/ReleaseNotes/NuttX-5.12 +++ b/Documentation/ReleaseNotes/NuttX-5.12.md @@ -1,5 +1,5 @@ NuttX-5.12 ----------- +========== This is the 59th release of NuttX. This is a critical bugfix release. diff --git a/Documentation/ReleaseNotes/NuttX-5.13 b/Documentation/ReleaseNotes/NuttX-5.13.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.13 rename to Documentation/ReleaseNotes/NuttX-5.13.md index 8c6f060b19b..51f9c200b4d 100644 --- a/Documentation/ReleaseNotes/NuttX-5.13 +++ b/Documentation/ReleaseNotes/NuttX-5.13.md @@ -1,5 +1,5 @@ NuttX-5.13 ----------- +========== This is the 60th release of NuttX. Headlines for this release include: diff --git a/Documentation/ReleaseNotes/NuttX-5.14 b/Documentation/ReleaseNotes/NuttX-5.14.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.14 rename to Documentation/ReleaseNotes/NuttX-5.14.md index 3c9a0bb16b3..3ef3c77cc1f 100644 --- a/Documentation/ReleaseNotes/NuttX-5.14 +++ b/Documentation/ReleaseNotes/NuttX-5.14.md @@ -1,5 +1,5 @@ NuttX-5.14 ----------- +========== The 61st release of NuttX, NuttX-5.14, was made on November 27, 2010. This release includes multiple, important bugfixes as well diff --git a/Documentation/ReleaseNotes/NuttX-5.15 b/Documentation/ReleaseNotes/NuttX-5.15.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.15 rename to Documentation/ReleaseNotes/NuttX-5.15.md index 796181435cd..7dfbd2cf450 100644 --- a/Documentation/ReleaseNotes/NuttX-5.15 +++ b/Documentation/ReleaseNotes/NuttX-5.15.md @@ -1,5 +1,5 @@ NuttX-5.15 ----------- +========== The 62nd release of NuttX, NuttX-5.15, was made on December 12, 2010. This release includes several bugfixes as well as feature diff --git a/Documentation/ReleaseNotes/NuttX-5.16 b/Documentation/ReleaseNotes/NuttX-5.16.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.16 rename to Documentation/ReleaseNotes/NuttX-5.16.md index 6740dce2a8b..b3442411db3 100644 --- a/Documentation/ReleaseNotes/NuttX-5.16 +++ b/Documentation/ReleaseNotes/NuttX-5.16.md @@ -1,5 +1,5 @@ NuttX-5.16 ----------- +========== The 63rd release of NuttX, Version 5.16, was made on January 10, 2010 and is available for download from the SourceForge website. diff --git a/Documentation/ReleaseNotes/NuttX-5.17 b/Documentation/ReleaseNotes/NuttX-5.17.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.17 rename to Documentation/ReleaseNotes/NuttX-5.17.md index 1b49afa1fe0..a82d6ed946f 100644 --- a/Documentation/ReleaseNotes/NuttX-5.17 +++ b/Documentation/ReleaseNotes/NuttX-5.17.md @@ -1,5 +1,5 @@ NuttX-5.17 ----------- +========== The 64th release of NuttX, Version 5.17, was made on January 19, 2011 and is available for download from the SourceForge website. diff --git a/Documentation/ReleaseNotes/NuttX-5.18 b/Documentation/ReleaseNotes/NuttX-5.18.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.18 rename to Documentation/ReleaseNotes/NuttX-5.18.md index b1d84bee18e..3d516fa1a44 100644 --- a/Documentation/ReleaseNotes/NuttX-5.18 +++ b/Documentation/ReleaseNotes/NuttX-5.18.md @@ -1,5 +1,5 @@ NuttX-5.18 ----------- +========== The 65th release of NuttX, Version 5.18, was made on February 27, 2011 and is available for download from the SourceForge website. diff --git a/Documentation/ReleaseNotes/NuttX-5.19 b/Documentation/ReleaseNotes/NuttX-5.19.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.19 rename to Documentation/ReleaseNotes/NuttX-5.19.md index 87d34ca3939..8e6f42cc635 100644 --- a/Documentation/ReleaseNotes/NuttX-5.19 +++ b/Documentation/ReleaseNotes/NuttX-5.19.md @@ -1,5 +1,5 @@ NuttX-5.19 ----------- +========== The 66th release of NuttX, Version 5.19, was made on March 12, 2011 and is available for download from the SourceForge website. This diff --git a/Documentation/ReleaseNotes/NuttX-5.2 b/Documentation/ReleaseNotes/NuttX-5.2.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.2 rename to Documentation/ReleaseNotes/NuttX-5.2.md index 9b12bd210fb..021fd23e4c4 100644 --- a/Documentation/ReleaseNotes/NuttX-5.2 +++ b/Documentation/ReleaseNotes/NuttX-5.2.md @@ -1,5 +1,5 @@ NuttX-5.2 ---------- +========= This is the 49th release of NuttX. This release completes the verification of the basic port for the NXP LPC3131 MCU on the diff --git a/Documentation/ReleaseNotes/NuttX-5.3 b/Documentation/ReleaseNotes/NuttX-5.3.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.3 rename to Documentation/ReleaseNotes/NuttX-5.3.md index e51aa7962bc..b55530db35f 100644 --- a/Documentation/ReleaseNotes/NuttX-5.3 +++ b/Documentation/ReleaseNotes/NuttX-5.3.md @@ -1,5 +1,5 @@ NuttX-5.3 ---------- +========= This is the 50th release of NuttX. This release support for one new architecture: diff --git a/Documentation/ReleaseNotes/NuttX-5.4 b/Documentation/ReleaseNotes/NuttX-5.4.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.4 rename to Documentation/ReleaseNotes/NuttX-5.4.md index 883616615b3..c4e8b4f2b47 100644 --- a/Documentation/ReleaseNotes/NuttX-5.4 +++ b/Documentation/ReleaseNotes/NuttX-5.4.md @@ -1,5 +1,5 @@ NuttX-5.4 ---------- +========= This is the 51st release of NuttX. This release includes one new, important extension to th NX graphics system (See diff --git a/Documentation/ReleaseNotes/NuttX-5.5 b/Documentation/ReleaseNotes/NuttX-5.5.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.5 rename to Documentation/ReleaseNotes/NuttX-5.5.md index 18adeff56ec..0f20f63b3d8 100644 --- a/Documentation/ReleaseNotes/NuttX-5.5 +++ b/Documentation/ReleaseNotes/NuttX-5.5.md @@ -1,5 +1,5 @@ NuttX-5.5 ---------- +========= This is the 52nd release of NuttX. This release includes one new port, some new drivers and some important bugfixes: diff --git a/Documentation/ReleaseNotes/NuttX-5.6 b/Documentation/ReleaseNotes/NuttX-5.6.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.6 rename to Documentation/ReleaseNotes/NuttX-5.6.md index b543c87ae14..d79e2018eff 100644 --- a/Documentation/ReleaseNotes/NuttX-5.6 +++ b/Documentation/ReleaseNotes/NuttX-5.6.md @@ -1,5 +1,5 @@ NuttX-5.6 ---------- +========= This is the 53rd release of NuttX. This release includes one several new drivers for existing NuttX ports: diff --git a/Documentation/ReleaseNotes/NuttX-5.7 b/Documentation/ReleaseNotes/NuttX-5.7.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-5.7 rename to Documentation/ReleaseNotes/NuttX-5.7.md index bdf70f93295..d6979eec8a0 100644 --- a/Documentation/ReleaseNotes/NuttX-5.7 +++ b/Documentation/ReleaseNotes/NuttX-5.7.md @@ -1,5 +1,5 @@ NuttX-5.7 ---------- +========= This is the 54th release of NuttX. This release adds basic support for one new ARM Cortex-M3 architecture: diff --git a/Documentation/ReleaseNotes/NuttX-5.8 b/Documentation/ReleaseNotes/NuttX-5.8.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.8 rename to Documentation/ReleaseNotes/NuttX-5.8.md index a48ea5a30d2..9e3412b2867 100644 --- a/Documentation/ReleaseNotes/NuttX-5.8 +++ b/Documentation/ReleaseNotes/NuttX-5.8.md @@ -1,5 +1,5 @@ NuttX-5.8 ---------- +========= This is the 55th release of NuttX. This includes several important bugfixes: diff --git a/Documentation/ReleaseNotes/NuttX-5.9 b/Documentation/ReleaseNotes/NuttX-5.9.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-5.9 rename to Documentation/ReleaseNotes/NuttX-5.9.md index 022769548b3..fd5d334cac9 100644 --- a/Documentation/ReleaseNotes/NuttX-5.9 +++ b/Documentation/ReleaseNotes/NuttX-5.9.md @@ -1,5 +1,5 @@ NuttX-5.9 ---------- +========= This is the 56th release of NuttX. This release is difficult to categorize; NuttX-5.9 was really released because there were too diff --git a/Documentation/ReleaseNotes/NuttX-6.0 b/Documentation/ReleaseNotes/NuttX-6.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.0 rename to Documentation/ReleaseNotes/NuttX-6.0.md index bb1e7406670..559fcffba45 100644 --- a/Documentation/ReleaseNotes/NuttX-6.0 +++ b/Documentation/ReleaseNotes/NuttX-6.0.md @@ -1,5 +1,5 @@ NuttX-6.0 ---------- +========= The 67th release of NuttX, Version 6.0, was made on March 21, 2011 and is available for download from the SourceForge website. The diff --git a/Documentation/ReleaseNotes/NuttX-6.1 b/Documentation/ReleaseNotes/NuttX-6.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.1 rename to Documentation/ReleaseNotes/NuttX-6.1.md index 69ad7fc17b2..3a1baa3c646 100644 --- a/Documentation/ReleaseNotes/NuttX-6.1 +++ b/Documentation/ReleaseNotes/NuttX-6.1.md @@ -1,5 +1,5 @@ NuttX-6.1 ---------- +========= The 68th release of NuttX, Version 6.1, was made on April 10, 2011 and is available for download from the SourceForge website. The diff --git a/Documentation/ReleaseNotes/NuttX-6.10 b/Documentation/ReleaseNotes/NuttX-6.10.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.10 rename to Documentation/ReleaseNotes/NuttX-6.10.md index cbf4705ba85..fadbe9c35c5 100644 --- a/Documentation/ReleaseNotes/NuttX-6.10 +++ b/Documentation/ReleaseNotes/NuttX-6.10.md @@ -1,5 +1,5 @@ NuttX-6.10 ----------- +========== The 77th release of NuttX, Version 6.10, was made on October 6, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.11 b/Documentation/ReleaseNotes/NuttX-6.11.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.11 rename to Documentation/ReleaseNotes/NuttX-6.11.md index 0cff5f3d608..29d0d6e7da3 100644 --- a/Documentation/ReleaseNotes/NuttX-6.11 +++ b/Documentation/ReleaseNotes/NuttX-6.11.md @@ -1,5 +1,5 @@ NuttX-6.11 ----------- +========== The 78th release of NuttX, Version 6.11, was made on November 12, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.12 b/Documentation/ReleaseNotes/NuttX-6.12.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.12 rename to Documentation/ReleaseNotes/NuttX-6.12.md index 9effe1474e6..d35aa7fbf96 100644 --- a/Documentation/ReleaseNotes/NuttX-6.12 +++ b/Documentation/ReleaseNotes/NuttX-6.12.md @@ -1,5 +1,5 @@ NuttX-6.12 ----------- +========== The 79th release of NuttX, Version 6.12, was made on December 6, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.13 b/Documentation/ReleaseNotes/NuttX-6.13.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.13 rename to Documentation/ReleaseNotes/NuttX-6.13.md index 88cdfa11b0a..e85b8a0d629 100644 --- a/Documentation/ReleaseNotes/NuttX-6.13 +++ b/Documentation/ReleaseNotes/NuttX-6.13.md @@ -1,5 +1,5 @@ NuttX-6.13 ----------- +========== The 80th release of NuttX, Version 6.13, was made on December 26, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.14 b/Documentation/ReleaseNotes/NuttX-6.14.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.14 rename to Documentation/ReleaseNotes/NuttX-6.14.md index ef0e66e8ae6..1bc9983520a 100644 --- a/Documentation/ReleaseNotes/NuttX-6.14 +++ b/Documentation/ReleaseNotes/NuttX-6.14.md @@ -1,5 +1,5 @@ NuttX-6.14 ----------- +========== The 81st release of NuttX, Version 6.14, was made on January 15, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.15 b/Documentation/ReleaseNotes/NuttX-6.15.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.15 rename to Documentation/ReleaseNotes/NuttX-6.15.md index 683cbaf4517..4b1b7b0439b 100644 --- a/Documentation/ReleaseNotes/NuttX-6.15 +++ b/Documentation/ReleaseNotes/NuttX-6.15.md @@ -1,5 +1,5 @@ NuttX-6.15 ----------- +========== The 82nd release of NuttX, Version 6.15, was made on February 12, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.16 b/Documentation/ReleaseNotes/NuttX-6.16.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.16 rename to Documentation/ReleaseNotes/NuttX-6.16.md index d53a1120377..6210856a817 100644 --- a/Documentation/ReleaseNotes/NuttX-6.16 +++ b/Documentation/ReleaseNotes/NuttX-6.16.md @@ -1,5 +1,5 @@ NuttX-6.16 ----------- +========== The 83rd release of NuttX, Version 6.16, was made on March 10, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.17 b/Documentation/ReleaseNotes/NuttX-6.17.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.17 rename to Documentation/ReleaseNotes/NuttX-6.17.md index 55c8cd7d685..a2c1813ba07 100644 --- a/Documentation/ReleaseNotes/NuttX-6.17 +++ b/Documentation/ReleaseNotes/NuttX-6.17.md @@ -1,5 +1,5 @@ NuttX-6.17 ----------- +========== The 84th release of NuttX, Version 6.17, was made on April 14, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.18 b/Documentation/ReleaseNotes/NuttX-6.18.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.18 rename to Documentation/ReleaseNotes/NuttX-6.18.md index dcd376aec83..d48a3074a3c 100644 --- a/Documentation/ReleaseNotes/NuttX-6.18 +++ b/Documentation/ReleaseNotes/NuttX-6.18.md @@ -1,5 +1,5 @@ NuttX-6.18 ----------- +========== The 85th release of NuttX, Version 6.18, was made on May 19, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.19 b/Documentation/ReleaseNotes/NuttX-6.19.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.19 rename to Documentation/ReleaseNotes/NuttX-6.19.md index e1611624eaa..5b628b6490f 100644 --- a/Documentation/ReleaseNotes/NuttX-6.19 +++ b/Documentation/ReleaseNotes/NuttX-6.19.md @@ -1,5 +1,5 @@ NuttX-6.19 ----------- +========== The 86th release of NuttX, Version 6.19, was made on June 15, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.2 b/Documentation/ReleaseNotes/NuttX-6.2.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.2 rename to Documentation/ReleaseNotes/NuttX-6.2.md index e88b3bc0e1f..3da608ade4d 100644 --- a/Documentation/ReleaseNotes/NuttX-6.2 +++ b/Documentation/ReleaseNotes/NuttX-6.2.md @@ -1,5 +1,5 @@ NuttX-6.2 ---------- +========= The 69th release of NuttX, Version 6.2, was made on May 6, 2011 and is available for download from the SourceForge website. The 6.2 diff --git a/Documentation/ReleaseNotes/NuttX-6.20 b/Documentation/ReleaseNotes/NuttX-6.20.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.20 rename to Documentation/ReleaseNotes/NuttX-6.20.md index 0081c678385..ccb6cc894ee 100644 --- a/Documentation/ReleaseNotes/NuttX-6.20 +++ b/Documentation/ReleaseNotes/NuttX-6.20.md @@ -1,5 +1,5 @@ NuttX-6.20 ----------- +========== The 87th release of NuttX, Version 6.20, was made on July 12, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.21 b/Documentation/ReleaseNotes/NuttX-6.21.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.21 rename to Documentation/ReleaseNotes/NuttX-6.21.md index 7098d13577d..4d0aefcb22c 100644 --- a/Documentation/ReleaseNotes/NuttX-6.21 +++ b/Documentation/ReleaseNotes/NuttX-6.21.md @@ -1,5 +1,5 @@ NuttX-6.21 ----------- +========== The 88th release of NuttX, Version 6.21, was made on August 25, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.22 b/Documentation/ReleaseNotes/NuttX-6.22.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.22 rename to Documentation/ReleaseNotes/NuttX-6.22.md index 79a4342a458..8a9bdec3ae4 100644 --- a/Documentation/ReleaseNotes/NuttX-6.22 +++ b/Documentation/ReleaseNotes/NuttX-6.22.md @@ -1,5 +1,5 @@ NuttX-6.22 ----------- +========== The 89th release of NuttX, Version 6.22, was made on September 29, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.23 b/Documentation/ReleaseNotes/NuttX-6.23.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.23 rename to Documentation/ReleaseNotes/NuttX-6.23.md index 4c4b55759fb..131a03ae4a6 100644 --- a/Documentation/ReleaseNotes/NuttX-6.23 +++ b/Documentation/ReleaseNotes/NuttX-6.23.md @@ -1,5 +1,5 @@ NuttX-6.23 ----------- +========== The 90th release of NuttX, Version 6.23, was made on November 5, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.24 b/Documentation/ReleaseNotes/NuttX-6.24.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.24 rename to Documentation/ReleaseNotes/NuttX-6.24.md index c52ffe0daca..41954fc8241 100644 --- a/Documentation/ReleaseNotes/NuttX-6.24 +++ b/Documentation/ReleaseNotes/NuttX-6.24.md @@ -1,5 +1,5 @@ NuttX-6.24 ----------- +========== The 91st release of NuttX, Version 6.24, was made on December 20, 2012, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.25 b/Documentation/ReleaseNotes/NuttX-6.25.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.25 rename to Documentation/ReleaseNotes/NuttX-6.25.md index 1cb782cd2e1..6ec835a73aa 100644 --- a/Documentation/ReleaseNotes/NuttX-6.25 +++ b/Documentation/ReleaseNotes/NuttX-6.25.md @@ -1,5 +1,5 @@ NuttX-6.25 ----------- +========== The 92nd release of NuttX, Version 6.25, was made on February 1, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.26 b/Documentation/ReleaseNotes/NuttX-6.26.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.26 rename to Documentation/ReleaseNotes/NuttX-6.26.md index 6937fb256b1..fa566822670 100644 --- a/Documentation/ReleaseNotes/NuttX-6.26 +++ b/Documentation/ReleaseNotes/NuttX-6.26.md @@ -1,5 +1,5 @@ NuttX-6.26 ----------- +========== The 93rd release of NuttX, Version 6.26, was made on March 15, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.27 b/Documentation/ReleaseNotes/NuttX-6.27.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.27 rename to Documentation/ReleaseNotes/NuttX-6.27.md index d061f5bf60b..242d778b0e0 100644 --- a/Documentation/ReleaseNotes/NuttX-6.27 +++ b/Documentation/ReleaseNotes/NuttX-6.27.md @@ -1,5 +1,5 @@ NuttX-6.27 ----------- +========== The 94th release of NuttX, Version 6.27, was made on April 28, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.28 b/Documentation/ReleaseNotes/NuttX-6.28.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.28 rename to Documentation/ReleaseNotes/NuttX-6.28.md index 2ab8225b97d..8e2ea71e460 100644 --- a/Documentation/ReleaseNotes/NuttX-6.28 +++ b/Documentation/ReleaseNotes/NuttX-6.28.md @@ -1,5 +1,5 @@ NuttX-6.28 ----------- +========== The 95th release of NuttX, Version 6.28, was made on June 14, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.29 b/Documentation/ReleaseNotes/NuttX-6.29.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.29 rename to Documentation/ReleaseNotes/NuttX-6.29.md index 0d85da03ea0..48c4961e73e 100644 --- a/Documentation/ReleaseNotes/NuttX-6.29 +++ b/Documentation/ReleaseNotes/NuttX-6.29.md @@ -1,5 +1,5 @@ NuttX-6.29 ----------- +========== The 96th release of NuttX, Version 6.29, was made on July 31, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.3 b/Documentation/ReleaseNotes/NuttX-6.3.md similarity index 98% rename from Documentation/ReleaseNotes/NuttX-6.3 rename to Documentation/ReleaseNotes/NuttX-6.3.md index 171ed0b5f38..718c4988d3f 100644 --- a/Documentation/ReleaseNotes/NuttX-6.3 +++ b/Documentation/ReleaseNotes/NuttX-6.3.md @@ -1,5 +1,5 @@ NuttX-6.3 ---------- +========= The 70th release of NuttX follows only a nines days after the release of version 6.2. It was released on May 15, 2011. This special diff --git a/Documentation/ReleaseNotes/NuttX-6.30 b/Documentation/ReleaseNotes/NuttX-6.30.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.30 rename to Documentation/ReleaseNotes/NuttX-6.30.md index ae0c83854d9..823e214ef60 100644 --- a/Documentation/ReleaseNotes/NuttX-6.30 +++ b/Documentation/ReleaseNotes/NuttX-6.30.md @@ -1,5 +1,5 @@ NuttX-6.30 ----------- +========== The 97th release of NuttX, Version 6.30, was made on September 14, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.31 b/Documentation/ReleaseNotes/NuttX-6.31.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.31 rename to Documentation/ReleaseNotes/NuttX-6.31.md index 26170dfc9f5..180713e278b 100644 --- a/Documentation/ReleaseNotes/NuttX-6.31 +++ b/Documentation/ReleaseNotes/NuttX-6.31.md @@ -1,5 +1,5 @@ NuttX-6.31 ----------- +========== The 98th release of NuttX, Version 6.31, was made on October 28, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.32 b/Documentation/ReleaseNotes/NuttX-6.32.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.32 rename to Documentation/ReleaseNotes/NuttX-6.32.md index 2ac1a0bae0d..174aabdcfa1 100644 --- a/Documentation/ReleaseNotes/NuttX-6.32 +++ b/Documentation/ReleaseNotes/NuttX-6.32.md @@ -1,5 +1,5 @@ NuttX-6.32 ----------- +========== The 99th release of NuttX, Version 6.32, was made on December 7, 2013, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.4 b/Documentation/ReleaseNotes/NuttX-6.4.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.4 rename to Documentation/ReleaseNotes/NuttX-6.4.md index 876ce2ab733..7e192270eb5 100644 --- a/Documentation/ReleaseNotes/NuttX-6.4 +++ b/Documentation/ReleaseNotes/NuttX-6.4.md @@ -1,5 +1,5 @@ NuttX-6.4 ---------- +========= The 71st release of NuttX, Version 6.4, was made on June 5, 2011 and is available for download from the SourceForge website. The diff --git a/Documentation/ReleaseNotes/NuttX-6.5 b/Documentation/ReleaseNotes/NuttX-6.5.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.5 rename to Documentation/ReleaseNotes/NuttX-6.5.md index e8374fac610..8fecc3a91bd 100644 --- a/Documentation/ReleaseNotes/NuttX-6.5 +++ b/Documentation/ReleaseNotes/NuttX-6.5.md @@ -1,5 +1,5 @@ NuttX-6.5 ---------- +========= The 72nd release of NuttX, Version 6.5, was made on June 21, 2011 and is available for download from the SourceForge website. The diff --git a/Documentation/ReleaseNotes/NuttX-6.6 b/Documentation/ReleaseNotes/NuttX-6.6.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.6 rename to Documentation/ReleaseNotes/NuttX-6.6.md index 44c13a73dcd..5543c85b0e4 100644 --- a/Documentation/ReleaseNotes/NuttX-6.6 +++ b/Documentation/ReleaseNotes/NuttX-6.6.md @@ -1,5 +1,5 @@ NuttX-6.6 ---------- +========= The 73rd release of NuttX, Version 6.6, was made on July 11, 2011 and is available for download from the SourceForge website. The diff --git a/Documentation/ReleaseNotes/NuttX-6.7 b/Documentation/ReleaseNotes/NuttX-6.7.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.7 rename to Documentation/ReleaseNotes/NuttX-6.7.md index e7f33acba45..03626c654d1 100644 --- a/Documentation/ReleaseNotes/NuttX-6.7 +++ b/Documentation/ReleaseNotes/NuttX-6.7.md @@ -1,5 +1,5 @@ NuttX-6.7 ---------- +========= The 74th release of NuttX, Version 6.7, was made on August 2, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.8 b/Documentation/ReleaseNotes/NuttX-6.8.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.8 rename to Documentation/ReleaseNotes/NuttX-6.8.md index 6c5537a6bab..95bd9aee3f5 100644 --- a/Documentation/ReleaseNotes/NuttX-6.8 +++ b/Documentation/ReleaseNotes/NuttX-6.8.md @@ -1,5 +1,5 @@ NuttX-6.8 ---------- +========= The 75th release of NuttX, Version 6.8, was made on August 19, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-6.9 b/Documentation/ReleaseNotes/NuttX-6.9.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-6.9 rename to Documentation/ReleaseNotes/NuttX-6.9.md index 2cbff912818..69c56716535 100644 --- a/Documentation/ReleaseNotes/NuttX-6.9 +++ b/Documentation/ReleaseNotes/NuttX-6.9.md @@ -1,5 +1,5 @@ NuttX-6.9 ---------- +========= The 76th release of NuttX, Version 6.9, was made on September 11, 2011 and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.1 b/Documentation/ReleaseNotes/NuttX-7.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.1 rename to Documentation/ReleaseNotes/NuttX-7.1.md index a5ce624fe87..9f799593100 100644 --- a/Documentation/ReleaseNotes/NuttX-7.1 +++ b/Documentation/ReleaseNotes/NuttX-7.1.md @@ -1,5 +1,5 @@ NuttX-7.1 ---------- +========= The 101st release of NuttX, Version 7.1, was made on March 15, 2014, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.10 b/Documentation/ReleaseNotes/NuttX-7.10.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.10 rename to Documentation/ReleaseNotes/NuttX-7.10.md index fe135f5d031..f994f4c58a8 100644 --- a/Documentation/ReleaseNotes/NuttX-7.10 +++ b/Documentation/ReleaseNotes/NuttX-7.10.md @@ -1,5 +1,5 @@ NuttX-7.10 ----------- +========== The 110th release of NuttX, Version 7.10, was made on June 9, 2015, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.11 b/Documentation/ReleaseNotes/NuttX-7.11.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.11 rename to Documentation/ReleaseNotes/NuttX-7.11.md index 8b8abfc87c0..7438e82649d 100644 --- a/Documentation/ReleaseNotes/NuttX-7.11 +++ b/Documentation/ReleaseNotes/NuttX-7.11.md @@ -1,5 +1,5 @@ NuttX-7.11 ------------------------- +======================== The 111th release of NuttX, Version 7.11, was made on August 13 2015, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.12 b/Documentation/ReleaseNotes/NuttX-7.12.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.12 rename to Documentation/ReleaseNotes/NuttX-7.12.md index 8c2ff395e43..855d43db3b9 100644 --- a/Documentation/ReleaseNotes/NuttX-7.12 +++ b/Documentation/ReleaseNotes/NuttX-7.12.md @@ -1,5 +1,5 @@ NuttX-7.12 ----------- +========== The 112th release of NuttX, Version 7.12, was made on October 1, 2015, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.13 b/Documentation/ReleaseNotes/NuttX-7.13.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.13 rename to Documentation/ReleaseNotes/NuttX-7.13.md index 107b28ef49e..aa224122ba8 100644 --- a/Documentation/ReleaseNotes/NuttX-7.13 +++ b/Documentation/ReleaseNotes/NuttX-7.13.md @@ -1,5 +1,5 @@ NuttX-7.13 ----------- +========== The 113th release of NuttX, Version 7.13, was made on December 5, 2015, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.14 b/Documentation/ReleaseNotes/NuttX-7.14.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.14 rename to Documentation/ReleaseNotes/NuttX-7.14.md index 7123f7645e9..77c223fa2ab 100644 --- a/Documentation/ReleaseNotes/NuttX-7.14 +++ b/Documentation/ReleaseNotes/NuttX-7.14.md @@ -1,5 +1,5 @@ NuttX-7.14 ----------- +========== The 114th release of NuttX, Version 7.14, was made on January 28, 2016, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.15 b/Documentation/ReleaseNotes/NuttX-7.15.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.15 rename to Documentation/ReleaseNotes/NuttX-7.15.md index 38ccd8d4496..fc055d0a21b 100644 --- a/Documentation/ReleaseNotes/NuttX-7.15 +++ b/Documentation/ReleaseNotes/NuttX-7.15.md @@ -1,5 +1,5 @@ NuttX-7.15 ----------- +========== The 115th release of NuttX, Version 7.15, was made on March 27, 2016, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.16 b/Documentation/ReleaseNotes/NuttX-7.16.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.16 rename to Documentation/ReleaseNotes/NuttX-7.16.md index bc54b9d1b9a..f66d94a59ce 100644 --- a/Documentation/ReleaseNotes/NuttX-7.16 +++ b/Documentation/ReleaseNotes/NuttX-7.16.md @@ -1,5 +1,5 @@ NuttX-7.16 ----------- +========== The 116th release of NuttX, Version 7.16, was made on June 1, 2016, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.17 b/Documentation/ReleaseNotes/NuttX-7.17.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.17 rename to Documentation/ReleaseNotes/NuttX-7.17.md index dd5eee3f6cd..c50bd1d7163 100644 --- a/Documentation/ReleaseNotes/NuttX-7.17 +++ b/Documentation/ReleaseNotes/NuttX-7.17.md @@ -1,5 +1,5 @@ NuttX-7.17 ----------- +========== The 117th release of NuttX, Version 7.17, was made on July 25, 2016, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.18 b/Documentation/ReleaseNotes/NuttX-7.18.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.18 rename to Documentation/ReleaseNotes/NuttX-7.18.md index eb3dfb2aba6..c6bf6f54578 100644 --- a/Documentation/ReleaseNotes/NuttX-7.18 +++ b/Documentation/ReleaseNotes/NuttX-7.18.md @@ -1,5 +1,5 @@ NuttX-7.18 ----------- +========== The 118th release of NuttX, Version 7.18, was made on October 8, 2016, and is available for download from the Bitbucket.org website. Note @@ -426,13 +426,13 @@ Young. - lib_dumpbuffer() now prints a large on-stack buffer first to avoid problems when the syslog output is prefixed with time. From Pierre-noel Bouteville. -- libc/math: This fixes the following libc/math issues: (1) asin[f l]() +- libc/math: This fixes the following libc/math issues: (1) asin\[f l]() use Newton's method to converge on a solution. But Newton's method converges very slowly (> 500,000 iterations) for values of x close to 1.0; and, in the case of asinl(), sometimes fails to converge (loops forever). The attached patch uses an trig identity for values of x > sqrt(2). The resultant functions converge in no more than 5 -iterations, 6 for asinl(). (2) The NuttX erf[f l]() functions are +iterations, 6 for asinl(). (2) The NuttX erf\[f l]() functions are based on Chebyshev fitting to a good guess. The problem there's a bug in the implementation that causes the functions to blow up with x near -3.0. This patch fixes that problem. It should be noted that diff --git a/Documentation/ReleaseNotes/NuttX-7.19 b/Documentation/ReleaseNotes/NuttX-7.19.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.19 rename to Documentation/ReleaseNotes/NuttX-7.19.md index 78af93d9f5b..1e786e11fad 100644 --- a/Documentation/ReleaseNotes/NuttX-7.19 +++ b/Documentation/ReleaseNotes/NuttX-7.19.md @@ -1,5 +1,5 @@ NuttX-7.19 ----------- +========== The 119th release of NuttX, Version 7.19, was made on December 26, 2016, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.2 b/Documentation/ReleaseNotes/NuttX-7.2.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.2 rename to Documentation/ReleaseNotes/NuttX-7.2.md index 0988ce7594d..0cbef680600 100644 --- a/Documentation/ReleaseNotes/NuttX-7.2 +++ b/Documentation/ReleaseNotes/NuttX-7.2.md @@ -1,5 +1,5 @@ NuttX-7.2 ---------- +========= The 102nd release of NuttX, Version 7.2, was made on April 29, 2014, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.20 b/Documentation/ReleaseNotes/NuttX-7.20.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.20 rename to Documentation/ReleaseNotes/NuttX-7.20.md index 937f56d808c..0bbca7121ca 100644 --- a/Documentation/ReleaseNotes/NuttX-7.20 +++ b/Documentation/ReleaseNotes/NuttX-7.20.md @@ -1,5 +1,5 @@ NuttX-7.20 ----------- +========== The 120th release of NuttX, Version 7.20, was made on March 8, 2017, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.21 b/Documentation/ReleaseNotes/NuttX-7.21.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.21 rename to Documentation/ReleaseNotes/NuttX-7.21.md index 565b263865c..a35291c4a48 100644 --- a/Documentation/ReleaseNotes/NuttX-7.21 +++ b/Documentation/ReleaseNotes/NuttX-7.21.md @@ -1,5 +1,5 @@ NuttX-7.21 ----------- +========== The 121st release of NuttX, Version 7.21, was made on June 6, 2017, and is available for download from the Bitbucket.org website. Note @@ -578,9 +578,11 @@ up_assert: Assertion failed at file:rwbuffer.c line: 643 that can happen with the following configuration: +``` CONFIG_FTL_WRITEBUFFER=y CONFIG_DRVR_WRITEBUFFER=y # CONFIG_FS_WRITABLE is not set +``` These problems are caused by CONFIG variable differences between the buffer layers. TODO: This is not a perfect solution. readahead diff --git a/Documentation/ReleaseNotes/NuttX-7.22 b/Documentation/ReleaseNotes/NuttX-7.22.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.22 rename to Documentation/ReleaseNotes/NuttX-7.22.md index 0fcb52b59a0..5784f61a15f 100644 --- a/Documentation/ReleaseNotes/NuttX-7.22 +++ b/Documentation/ReleaseNotes/NuttX-7.22.md @@ -1,5 +1,5 @@ NuttX-7.22 ----------- +========== The 122nd release of NuttX, Version 7.22, was made on September 9, 2017, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.23 b/Documentation/ReleaseNotes/NuttX-7.23.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.23 rename to Documentation/ReleaseNotes/NuttX-7.23.md index c207bc166f0..c135041c86d 100644 --- a/Documentation/ReleaseNotes/NuttX-7.23 +++ b/Documentation/ReleaseNotes/NuttX-7.23.md @@ -1,5 +1,5 @@ NuttX-7.23 ----------- +========== The 123rd release of NuttX, Version 7.23, was made on December 4, 2017, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.24 b/Documentation/ReleaseNotes/NuttX-7.24.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.24 rename to Documentation/ReleaseNotes/NuttX-7.24.md index 7df1abc9f31..bde94a17754 100644 --- a/Documentation/ReleaseNotes/NuttX-7.24 +++ b/Documentation/ReleaseNotes/NuttX-7.24.md @@ -1,5 +1,5 @@ NuttX-7.24 ----------- +========== The 124th release of NuttX, Version 7.24, was made on March 2, 2018, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.25 b/Documentation/ReleaseNotes/NuttX-7.25.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.25 rename to Documentation/ReleaseNotes/NuttX-7.25.md index c4c94781571..87f8baaeced 100644 --- a/Documentation/ReleaseNotes/NuttX-7.25 +++ b/Documentation/ReleaseNotes/NuttX-7.25.md @@ -1,5 +1,5 @@ NuttX-7.25 ----------- +========== The 125th release of NuttX, Version 7.25, was made on June 3, 2018, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.26 b/Documentation/ReleaseNotes/NuttX-7.26.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.26 rename to Documentation/ReleaseNotes/NuttX-7.26.md index c553ab6623f..9e5055b2f0c 100644 --- a/Documentation/ReleaseNotes/NuttX-7.26 +++ b/Documentation/ReleaseNotes/NuttX-7.26.md @@ -1,5 +1,5 @@ NuttX-7.26 ----------- +========== The 126th release of NuttX, Version 7.26, was made on September 8, 2018, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.27 b/Documentation/ReleaseNotes/NuttX-7.27.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.27 rename to Documentation/ReleaseNotes/NuttX-7.27.md index f3479c32906..7f9374e6e6f 100644 --- a/Documentation/ReleaseNotes/NuttX-7.27 +++ b/Documentation/ReleaseNotes/NuttX-7.27.md @@ -1,5 +1,5 @@ NuttX-7.27 ----------- +========== The 127th release of NuttX, Version 7.27, was made on November 14, 2018, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.28 b/Documentation/ReleaseNotes/NuttX-7.28.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.28 rename to Documentation/ReleaseNotes/NuttX-7.28.md index cd8fe5e45fe..0684be860a6 100644 --- a/Documentation/ReleaseNotes/NuttX-7.28 +++ b/Documentation/ReleaseNotes/NuttX-7.28.md @@ -1,5 +1,5 @@ NuttX-7.28 ----------- +========== The 128th release of NuttX, Version 7.28, was made on January 19, 2019, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.29 b/Documentation/ReleaseNotes/NuttX-7.29.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.29 rename to Documentation/ReleaseNotes/NuttX-7.29.md index 5b6c01baf04..07651d0a71f 100644 --- a/Documentation/ReleaseNotes/NuttX-7.29 +++ b/Documentation/ReleaseNotes/NuttX-7.29.md @@ -1,5 +1,5 @@ NuttX-7.29 ----------- +========== The 129th release of NuttX, Version 7.29, was made on March 25, 2019, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.3 b/Documentation/ReleaseNotes/NuttX-7.3.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.3 rename to Documentation/ReleaseNotes/NuttX-7.3.md index 6aa915340ba..c99baaef8f8 100644 --- a/Documentation/ReleaseNotes/NuttX-7.3 +++ b/Documentation/ReleaseNotes/NuttX-7.3.md @@ -1,5 +1,5 @@ NuttX-7.3 ---------- +========= The 103rd release of NuttX, Version 7.3, was made on June 25, 2014, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.30 b/Documentation/ReleaseNotes/NuttX-7.30.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.30 rename to Documentation/ReleaseNotes/NuttX-7.30.md index ce657910e0b..c86414eea9d 100644 --- a/Documentation/ReleaseNotes/NuttX-7.30 +++ b/Documentation/ReleaseNotes/NuttX-7.30.md @@ -1,5 +1,5 @@ NuttX-7.30 ----------- +========== The 130th release of NuttX, Version 7.30, was made on May 19, 2019, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.31 b/Documentation/ReleaseNotes/NuttX-7.31.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.31 rename to Documentation/ReleaseNotes/NuttX-7.31.md index 9898922dfa0..feccf1eb6a2 100644 --- a/Documentation/ReleaseNotes/NuttX-7.31 +++ b/Documentation/ReleaseNotes/NuttX-7.31.md @@ -1,5 +1,5 @@ NuttX-7.31 ----------- +========== The 131st release of NuttX, Version 7.31, was made on July 21, 2019, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.4 b/Documentation/ReleaseNotes/NuttX-7.4.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.4 rename to Documentation/ReleaseNotes/NuttX-7.4.md index b92bbc8316a..510dbd7e022 100644 --- a/Documentation/ReleaseNotes/NuttX-7.4 +++ b/Documentation/ReleaseNotes/NuttX-7.4.md @@ -1,5 +1,5 @@ NuttX-7.4 ---------- +========= The 104th release of NuttX, Version 7.4, was made on August 15, 2014, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.5 b/Documentation/ReleaseNotes/NuttX-7.5.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.5 rename to Documentation/ReleaseNotes/NuttX-7.5.md index e9186f645f8..2ed9f00db17 100644 --- a/Documentation/ReleaseNotes/NuttX-7.5 +++ b/Documentation/ReleaseNotes/NuttX-7.5.md @@ -1,5 +1,5 @@ NuttX-7.5 ---------- +========= The 105th release of NuttX, Version 7.5, was made on September 28, 2014, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.6 b/Documentation/ReleaseNotes/NuttX-7.6.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.6 rename to Documentation/ReleaseNotes/NuttX-7.6.md index 47bc97db612..f9566c18e9b 100644 --- a/Documentation/ReleaseNotes/NuttX-7.6 +++ b/Documentation/ReleaseNotes/NuttX-7.6.md @@ -1,5 +1,5 @@ NuttX-7.6 ---------- +========= The 106th release of NuttX, Version 7.6, was made on November 26, 2014, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.7 b/Documentation/ReleaseNotes/NuttX-7.7.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.7 rename to Documentation/ReleaseNotes/NuttX-7.7.md index 32296b9e855..3085ba9d6bf 100644 --- a/Documentation/ReleaseNotes/NuttX-7.7 +++ b/Documentation/ReleaseNotes/NuttX-7.7.md @@ -1,5 +1,5 @@ NuttX-7.7 ---------- +========= The 107th release of NuttX, Version 7.7, was made on January 26, 2015, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.8 b/Documentation/ReleaseNotes/NuttX-7.8.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.8 rename to Documentation/ReleaseNotes/NuttX-7.8.md index c34638c7c86..998582c697a 100644 --- a/Documentation/ReleaseNotes/NuttX-7.8 +++ b/Documentation/ReleaseNotes/NuttX-7.8.md @@ -1,5 +1,5 @@ NuttX-7.8 ---------- +========= The 108th release of NuttX, Version 7.8, was made on February 11, 2015, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-7.9 b/Documentation/ReleaseNotes/NuttX-7.9.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-7.9 rename to Documentation/ReleaseNotes/NuttX-7.9.md index cea03d79f95..32886a9b54e 100644 --- a/Documentation/ReleaseNotes/NuttX-7.9 +++ b/Documentation/ReleaseNotes/NuttX-7.9.md @@ -1,5 +1,5 @@ NuttX-7.9 ---------- +========= The 109th release of NuttX, Version 7.9, was made on April 14, 2015, and is available for download from the SourceForge website. Note diff --git a/Documentation/ReleaseNotes/NuttX-8.1 b/Documentation/ReleaseNotes/NuttX-8.1.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-8.1 rename to Documentation/ReleaseNotes/NuttX-8.1.md index 3f43b7d517f..56faa257774 100644 --- a/Documentation/ReleaseNotes/NuttX-8.1 +++ b/Documentation/ReleaseNotes/NuttX-8.1.md @@ -1,5 +1,5 @@ NuttX-8.1 ---------- +========= The 132nd release of NuttX, Version 8.1, was made on September 14, 2019, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-8.2 b/Documentation/ReleaseNotes/NuttX-8.2.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-8.2 rename to Documentation/ReleaseNotes/NuttX-8.2.md index 69def1a06c4..2907aee6246 100644 --- a/Documentation/ReleaseNotes/NuttX-8.2 +++ b/Documentation/ReleaseNotes/NuttX-8.2.md @@ -1,5 +1,5 @@ NuttX-8.2 ---------- +========= The 133rd release of NuttX, Version 8.2, was made on November 16, 2019, and is available for download from the Bitbucket.org website. Note diff --git a/Documentation/ReleaseNotes/NuttX-9.0.0 b/Documentation/ReleaseNotes/NuttX-9.0.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-9.0.0 rename to Documentation/ReleaseNotes/NuttX-9.0.0.md index 97c18c4f80f..8764a3a0afb 100644 --- a/Documentation/ReleaseNotes/NuttX-9.0.0 +++ b/Documentation/ReleaseNotes/NuttX-9.0.0.md @@ -1,5 +1,5 @@ NuttX-9.0.0 ------------ +=========== This is the first release of NuttX as Apache NuttX (Incubating) and represents our first major milestone as a Podling of the Apache Software Foundation's Incubator. This release is the culmination of nearly 6 months of hard work and includes several new architectures and drivers, and numerous improvements and bug fixes to the core RTOS, drivers, and networking subsystems. diff --git a/Documentation/ReleaseNotes/NuttX-9.1.0 b/Documentation/ReleaseNotes/NuttX-9.1.0.md similarity index 99% rename from Documentation/ReleaseNotes/NuttX-9.1.0 rename to Documentation/ReleaseNotes/NuttX-9.1.0.md index f28ab91711f..54cefb0d189 100644 --- a/Documentation/ReleaseNotes/NuttX-9.1.0 +++ b/Documentation/ReleaseNotes/NuttX-9.1.0.md @@ -1,5 +1,5 @@ NuttX-9.1.0 ------------ +=========== * Major Changes to Core OS: * New Features: @@ -529,7 +529,7 @@ include $(TOPDIR)/Make.defs See git commit # 1a95cce1a3c3ed8b04d1d86b7bd744352cca45a2 in the main NuttX repository, and git commit -# ead498a7883a654b1d542da94a5fab3ce163361e in the apps repository. +\# ead498a7883a654b1d542da94a5fab3ce163361e in the apps repository. * Simplify ARCHINCLUDES and ARCHXXINCLUDES diff --git a/Documentation/ReleaseNotes/index.rst b/Documentation/ReleaseNotes/index.rst new file mode 100644 index 00000000000..3443a452198 --- /dev/null +++ b/Documentation/ReleaseNotes/index.rst @@ -0,0 +1,188 @@ +============= +Release Notes +============= + +The release notes for every NuttX release, from 0.1.0 onwards, exactly as +they were written at the time of the release (with perhaps some corrected +typos). + +Over the course of time NuttX has used several different repositories -- +CVS, two SVN repositories and currently git -- so revision information +specific to an older repository may not be meaningful today. To make it +easier to find those older versions in the current git repository, a +lightweight tag has been applied to most releases; the tag name is the +release name (for example, release 6.27 has the tag ``nuttx-6.27``). +Tagging starts at ``nuttx-4.14``: the 46 releases from 0.1.0 to 0.4.13 +predate it and have no tag. + +.. note:: + When cutting a release, add the new notes file here and prepend it to the + list below. Give the file a single top level heading -- the release name, + underlined with ``=`` -- and start every section inside it at ``##`` or + deeper, so that the release appears in this index as one entry rather than + one entry per section. See :doc:`/contributing/releases` for the full + release procedure. + +.. toctree:: + :maxdepth: 1 + :titlesonly: + :caption: Releases + + NuttX-13.0.1 + NuttX-13.0.0 + NuttX-12.13.0 + NuttX-12.12.0 + NuttX-12.11.0 + NuttX-12.10.0 + NuttX-12.9.0 + NuttX-12.8.0 + NuttX-12.7.0 + NuttX-12.6.0 + NuttX-12.5.1 + NuttX-12.5.0 + NuttX-12.4.0 + NuttX-12.3.0 + NuttX-12.2.1 + NuttX-12.2.0 + NuttX-12.1.0 + NuttX-12.0.0 + NuttX-11.0.0 + NuttX-10.3.0 + NuttX-10.2.0 + NuttX-10.1.0 + NuttX-10.0.0 + NuttX-9.1.0 + NuttX-9.0.0 + NuttX-8.2 + NuttX-8.1 + NuttX-7.31 + NuttX-7.30 + NuttX-7.29 + NuttX-7.28 + NuttX-7.27 + NuttX-7.26 + NuttX-7.25 + NuttX-7.24 + NuttX-7.23 + NuttX-7.22 + NuttX-7.21 + NuttX-7.20 + NuttX-7.19 + NuttX-7.18 + NuttX-7.17 + NuttX-7.16 + NuttX-7.15 + NuttX-7.14 + NuttX-7.13 + NuttX-7.12 + NuttX-7.11 + NuttX-7.10 + NuttX-7.9 + NuttX-7.8 + NuttX-7.7 + NuttX-7.6 + NuttX-7.5 + NuttX-7.4 + NuttX-7.3 + NuttX-7.2 + NuttX-7.1 + NuttX-6.32 + NuttX-6.31 + NuttX-6.30 + NuttX-6.29 + NuttX-6.28 + NuttX-6.27 + NuttX-6.26 + NuttX-6.25 + NuttX-6.24 + NuttX-6.23 + NuttX-6.22 + NuttX-6.21 + NuttX-6.20 + NuttX-6.19 + NuttX-6.18 + NuttX-6.17 + NuttX-6.16 + NuttX-6.15 + NuttX-6.14 + NuttX-6.13 + NuttX-6.12 + NuttX-6.11 + NuttX-6.10 + NuttX-6.9 + NuttX-6.8 + NuttX-6.7 + NuttX-6.6 + NuttX-6.5 + NuttX-6.4 + NuttX-6.3 + NuttX-6.2 + NuttX-6.1 + NuttX-6.0 + NuttX-5.19 + NuttX-5.18 + NuttX-5.17 + NuttX-5.16 + NuttX-5.15 + NuttX-5.14 + NuttX-5.13 + NuttX-5.12 + NuttX-5.11 + NuttX-5.10 + NuttX-5.9 + NuttX-5.8 + NuttX-5.7 + NuttX-5.6 + NuttX-5.5 + NuttX-5.4 + NuttX-5.3 + NuttX-5.2 + NuttX-5.1 + NuttX-5.0 + NuttX-4.14 + NuttX-0.4.13 + NuttX-0.4.12 + NuttX-0.4.11 + NuttX-0.4.10 + NuttX-0.4.9 + NuttX-0.4.8 + NuttX-0.4.7 + NuttX-0.4.6 + NuttX-0.4.5 + NuttX-0.4.4 + NuttX-0.4.3 + NuttX-0.4.2 + NuttX-0.4.1 + NuttX-0.4.0 + NuttX-0.3.19 + NuttX-0.3.18 + NuttX-0.3.17 + NuttX-0.3.16 + NuttX-0.3.15 + NuttX-0.3.14 + NuttX-0.3.13 + NuttX-0.3.12 + NuttX-0.3.11 + NuttX-0.3.10 + NuttX-0.3.9 + NuttX-0.3.8 + NuttX-0.3.7 + NuttX-0.3.6 + NuttX-0.3.5 + NuttX-0.3.4 + NuttX-0.3.3 + NuttX-0.3.2 + NuttX-0.3.1 + NuttX-0.3.0 + NuttX-0.2.9 + NuttX-0.2.8 + NuttX-0.2.7 + NuttX-0.2.6 + NuttX-0.2.5 + NuttX-0.2.4 + NuttX-0.2.3 + NuttX-0.2.2 + NuttX-0.2.1 + NuttX-0.1.2 + NuttX-0.1.1 + NuttX-0.1.0 diff --git a/Documentation/_extensions/tags_overview.py b/Documentation/_extensions/tags_overview.py new file mode 100644 index 00000000000..58113fcaaa5 --- /dev/null +++ b/Documentation/_extensions/tags_overview.py @@ -0,0 +1,369 @@ +############################################################################## +# Documentation/_extensions/tags_overview.py +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. The +# ASF licenses this file to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance with the +# License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +############################################################################## + +"""Group the tag overview page by namespace instead of listing it flat. + +``sphinx_tags`` writes one page per tag and one overview page listing every +tag in a single alphabetical toctree. With a few dozen tags that is fine. +NuttX has around 180, three quarters of them in the ``chip:`` namespace, and +the flat list is unusable: the reader scrolls past 100 chip tags to find the +handful of architectures. + +The tags are already namespaced -- ``arch:``, ``chip:``, ``part:``, +``vendor:`` -- so the grouping is in the data and only the presentation throws +it away. This extension runs after ``sphinx_tags`` and +rewrites the overview it generated. + +``chip:`` and ``part:`` are shown together but not mixed. Every family is +listed once, alphabetically, so that looking one up never depends on knowing +something about it first. Parts follow, grouped under the family whose boards +carry them -- that has to be worked out from the pages, since the name of a +part does not say which family it belongs to. A part used by boards of two +families is listed under both, which is simply true. + +Nothing here needs updating when a tag is added. +""" + +import re +from collections import defaultdict +from pathlib import Path + +from sphinx.application import Sphinx +from sphinx.util import logging + +__version__ = "1.0.0" + +logger = logging.getLogger(__name__) + +# Runs after sphinx_tags, which connects at the default priority of 500. +PRIORITY = 800 + +# Heading shown for each namespace, in the order they appear on the page. +# Architecture and vendor come first because they are how somebody arrives +# without knowing a part number yet. +NAMESPACES = [ + ("arch", "Architecture", "The instruction set, as named under ``arch/``."), + ("vendor", "Vendor", "Who makes the chip."), +] + +CHIP_HEADING = "Chip" +CHIP_INTRO = ( + "A chip family is a directory under ``arch//src/``, and these are " + "all of them. The exact part fitted to a board is listed under its family." +) +FAMILY_HEADING = "Families" +FAMILY_INTRO = "Grouped by the architecture they belong to." +PART_HEADING = "Parts" +PART_INTRO = "Grouped under the family whose boards carry them." + +TAG_NAME = re.compile(r"^Tags:\s*(\S.*)$", re.M) +TAG_PAGE = re.compile(r"^\s+\.\./(\S+\.rst)\s*$", re.M) +BOARD_PATH = re.compile(r"^platforms/([^/]+)/(.+?)/boards/[^/]+/index\.rst$") +PLATFORM_PATH = re.compile(r"^platforms/([^/]+)/") + + +def _collect(tags_dir): + """Read what sphinx_tags generated: tag name -> (page file, page paths).""" + tags = {} + for path in sorted(tags_dir.glob("*.rst")): + if path.name == "tagsindex.rst": + continue + text = path.read_text(encoding="utf-8") + match = TAG_NAME.search(text) + if not match: + continue + tags[match.group(1).strip()] = (path.name, TAG_PAGE.findall(text)) + return tags + + +def _architectures(pages): + """The architectures the pages of one tag live under. + + A chip family is a directory under arch//src/, so its architecture + is the directory its pages sit in. A handful of names exist under more + than one architecture -- qemu under arm, arm64 and x86_64 -- and those are + listed under each, because each really is a different chip. + """ + found = set() + for page in pages: + match = PLATFORM_PATH.match(page) + if match: + found.add(match.group(1)) + return found + + +def _chip_families(pages): + """Chip directories the pages of one tag live in. + + A board page is at platforms///boards//index.rst, and + may itself be nested (avr/atmega/atmega2560); the first component + is the family. + """ + families = set() + for page in pages: + match = BOARD_PATH.match(page) + if match: + families.add(match.group(2).split("/")[0]) + return families + + +# Below this many entries a list is better off in one column: splitting three +# names across the width makes the reader's eye travel further than reading +# them straight down, and leaves a ragged second column. +COLUMN_THRESHOLD = 5 + + +def _toctree(names, tags): + """A toctree of the given tags, in columns only when it is worth it.""" + body = [".. toctree::", " :maxdepth: 1", ""] + _entries(names, tags) + if len(names) < COLUMN_THRESHOLD: + return body + [""] + return ( + [".. container:: tag-columns", ""] + + [f" {line}" if line else "" for line in body] + + [""] + ) + + +def _entries(names, tags): + """toctree lines of the form ``tag (count) ``, alphabetically.""" + lines = [] + for name in sorted(names): + filename, pages = tags[name] + lines.append(f" {name} ({len(pages)}) <{filename}>") + return lines + + +def _tree(rows): + """Draw rows of (depth, label, count, target) as a tree. + + A map of the page, at the top of the page. The sections below say the + same thing over a screen and a half of headings; this says it in one, + which is what somebody arriving here wants first. + + Every row links to the section it names, so the map is also the way to + get there. Padding is measured on the label the reader sees, not on the + markup, or the columns come out ragged. + """ + lines, depths = [], [d for d, _, _, _ in rows] + for i, (depth, label, count, target) in enumerate(rows): + prefix = "" + for level in range(depth): + more = any( + depths[j] == level + for j in range(i + 1, len(rows)) + if min(depths[i + 1 : j + 1] or [level]) >= level + ) + prefix += "\u2502 " if more else " " + last = not any( + depths[j] == depth + for j in range(i + 1, len(rows)) + if min(depths[i + 1 : j + 1] or [depth]) >= depth + ) + prefix += "\u2514\u2500\u2500 " if last else "\u251c\u2500\u2500 " + + shown = f":ref:`{label} <{target}>`" if target else label + width = len(prefix) + len(label) + if count is None: + lines.append(prefix + shown) + else: + lines.append(prefix + shown + " " * max(1, 46 - width) + f"{count:>4}") + return lines + + +def _label(kind, name): + """A reference label for a section, so the tree can point at it. + + Explicit labels rather than '#anchor' links: Sphinx derives section ids + from the titles, and two sections whose titles happen to match would then + silently send the reader to the wrong one. + """ + slug = re.sub(r"[^a-z0-9]+", "-", name.lower()).strip("-") + return f"tag-{kind}-{slug}" + + +def _section(title, underline, intro=None, label=None): + out = [f".. _{label}:", ""] if label else [] + out += [title, underline * len(title), ""] + if intro: + out += [intro, ""] + return out + + +PARTS_SHOWN = 6 + + +def _overview_tree(grouped, tags): + """The map drawn at the top of the page.""" + rows = [] + for namespace, title, _ in NAMESPACES: + names = grouped.get(namespace) + if names: + rows.append((0, title, len(names), _label("section", title))) + + families = grouped.get("chip") or [] + parts = grouped.get("part") or [] + if not (families or parts): + return [] + + rows.append((0, CHIP_HEADING, None, _label("section", CHIP_HEADING))) + if families: + by_arch = defaultdict(list) + for name in families: + for arch in _architectures(tags[name][1]) or ["(unknown)"]: + by_arch[arch].append(name) + # The count has to be what the rows below add up to, not the number of + # distinct names: qemu is a family of arm, arm64 and x86_64, and is + # listed under each because each is a different chip. + rows.append( + ( + 1, + FAMILY_HEADING, + sum(len(v) for v in by_arch.values()), + _label("section", FAMILY_HEADING), + ) + ) + # Alphabetical, like the sections below. Ordering the map by size and + # the page by name makes the reader look twice for the same thing. + for arch in sorted(by_arch): + rows.append((2, arch, len(by_arch[arch]), _label("arch", arch))) + + if parts: + # A leaf: the families underneath are reached through the family you + # already found, and repeating 35 of them here would make the map as + # long as the page it maps. + by_family = defaultdict(list) + for name in parts: + for family in _chip_families(tags[name][1]) or ["(unknown)"]: + by_family[family].append(name) + rows.append( + ( + 1, + f"{PART_HEADING}, under {len(by_family)} families", + sum(len(v) for v in by_family.values()), + _label("section", PART_HEADING), + ) + ) + + return ( + ["", ".. parsed-literal::", ""] + [f" {line}" for line in _tree(rows)] + [""] + ) + + +def write_overview(app: Sphinx): + tags_dir = Path(app.srcdir) / app.config.tags_output_dir + index = tags_dir / "tagsindex.rst" + if not index.is_file(): + return + + tags = _collect(tags_dir) + if not tags: + return + + grouped = defaultdict(list) + for name in tags: + namespace = name.split(":", 1)[0] if ":" in name else "" + grouped[namespace].append(name) + + out = [ + ":orphan:", + "", + ".. _tagoverview:", + "", + # Puts the class on the outermost
, which is what + # _static/custom.css hangs the indentation and the guide lines off. + ".. rst-class:: tag-overview", + "", + "Tags", + "####", + "", + "Every board page is tagged with the architecture and the chip it is " + "built around, so that the boards can be reached by what they are " + "rather than only by where they sit in the tree.", + "", + ] + out += _overview_tree(grouped, tags) + + for namespace, title, intro in NAMESPACES: + names = grouped.get(namespace) + if not names: + continue + out += _section(title, "=", intro, _label("section", title)) + out += _toctree(names, tags) + + families = sorted(grouped.get("chip") or []) + parts = grouped.get("part") or [] + if families or parts: + out += _section(CHIP_HEADING, "=", CHIP_INTRO, _label("section", CHIP_HEADING)) + + if families: + # A chip tag names its family, so it needs no working out. Grouping + # them by architecture is what turns a run of 134 names into + # something you can scan: nobody arrives at this page without already + # knowing whether they are holding an Arm or a RISC-V board. + out += _section( + FAMILY_HEADING, "-", FAMILY_INTRO, _label("section", FAMILY_HEADING) + ) + by_arch = defaultdict(list) + for name in families: + for arch in _architectures(tags[name][1]) or ["(unknown)"]: + by_arch[arch].append(name) + for arch in sorted(by_arch): + out += _section(arch, "~", label=_label("arch", arch)) + out += _toctree(by_arch[arch], tags) + + if parts: + out += _section(PART_HEADING, "-", PART_INTRO, _label("section", PART_HEADING)) + by_family = defaultdict(list) + for name in parts: + found = _chip_families(tags[name][1]) + for family in found or ["(unknown family)"]: + by_family[family].append(name) + for family in sorted(by_family): + out += _section(family, "~") + out += _toctree(by_family[family], tags) + + leftover = [n for ns, names in grouped.items() if not ns for n in names] + if leftover: + # A tag with no namespace has no place in the index; it came from + # somewhere that does not follow the board template. + logger.warning( + "tags_overview: %d tags have no namespace: %s", + len(leftover), + ", ".join(sorted(leftover)), + ) + out += _section("Ungrouped", "=") + out += _toctree(leftover, tags) + + index.write_text("\n".join(out) + "\n", encoding="utf-8") + logger.info( + "[tags_overview] grouped %d tags into %d sections", + len(tags), + sum(1 for ns, _, _ in NAMESPACES if grouped.get(ns)) + bool(families or parts), + ) + + +def setup(app: Sphinx): + app.connect("builder-inited", write_overview, priority=PRIORITY) + return { + "version": __version__, + "parallel_read_safe": True, + "parallel_write_safe": True, + } diff --git a/Documentation/_static/custom.css b/Documentation/_static/custom.css index 7d0464e674d..b0795990d28 100644 --- a/Documentation/_static/custom.css +++ b/Documentation/_static/custom.css @@ -91,3 +91,270 @@ div.version-selector { margin-bottom: 1em; } + +/* Tag overview ------------------------------------------------------------ + * + * The tag overview is a tree: architectures hold chip families, and families + * hold the parts fitted to boards. sphinx_rtd_theme lays nested sections + * flush against the same left margin, so the reader gets four levels of + * heading with nothing saying which belongs to which. Indent each level and + * draw the line it hangs from. + * + * The line is grey rather than a theme colour so that it survives being read + * through a dark mode extension, which tends to rewrite anything with a hue. + * !important throughout, for the same reason as the table rules above: on + * Read the Docs the common stylesheets load after this one. + */ + +.tag-overview section { + margin-left: .25em !important; + padding-left: 1.75em !important; + border-left: 2px solid rgba(127, 127, 127, .45) !important; +} + +/* Nothing may pull a heading back out of its own section: that cancels the + * indentation and puts every level back on the same margin, which is the bug + * this whole block exists to fix. + */ + +.tag-overview section > h2, +.tag-overview section > h3, +.tag-overview section > h4 { + margin-left: 0 !important; + padding-left: 0 !important; + margin-top: 1.3em !important; + margin-bottom: .4em !important; +} + +/* The long lists -- arm alone holds 71 chip families -- leave most of the + * width empty in one column and turn the page into scrolling. Only the lists + * worth splitting get the class, which the page generator decides; a short + * list stays in one column, because sending the eye across the width for + * three names costs more than it saves. + * + * The column width is in em so that the columns collapse back to one on a + * narrow screen instead of being cut off. + */ + +.tag-overview .tag-columns .toctree-wrapper ul { + column-width: 16em; + column-gap: 2.5em; +} + +.tag-overview .toctree-wrapper ul { + margin-bottom: 12px !important; +} + +.tag-overview .toctree-wrapper li { + break-inside: avoid; +} + +/* Sidebar header ---------------------------------------------------------- + * + * The logo, the version selector and the search box, in the block at the top + * of the sidebar. + * + * The colours are not chosen, they are the ones in logos/NuttX_Simple.svg -- + * the logo the NuttX Logos page names as the one to use on documentation. + * Taken from the SVG rather than sampled from a PNG, so they are the exact + * values the artwork carries: + * + * #3c34e3 the indigo of the diamond + * #2b2787 the navy it is shadowed in + * #5a96bd the steel blue of the trailing strokes + * #cee3f1 the pale blue of the letterform highlights + * + * This is also why the header stopped clashing with the logo standing in it: + * the theme's default #2980b9 is a cyan the NuttX mark has nothing to do + * with. + */ + +.wy-side-nav-search { + padding: 1.4em .9em 1.1em; + background: linear-gradient(160deg, #3c34e3 0%, #2b2787 72%) !important; +} + +/* Mark above wordmark, sharing one link. The theme's house icon is gone: the + * logo is the link home, and two ways home side by side is one too many. + */ + +.wy-side-nav-search > a.nuttx-brand { + display: flex; + flex-direction: column; + align-items: center; + gap: .45em; + margin: 0 0 1em; + padding: 0; + background: none; +} + +.wy-side-nav-search > a.nuttx-brand img.logo { + width: 58px; + height: 58px; + margin: 0; + padding: 0; + background: none; +} + +.nuttx-brand-name { + font-size: 1.5em; + font-weight: 600; + letter-spacing: .015em; + line-height: 1; + color: #fff; +} + +/* The version selector carried a comment in the template asking for + * something less raw than a bare OS dropdown. Give it the same shape and + * weight as the search field below so the two read as a pair. + */ + +.version-selector { + display: flex; + align-items: center; + justify-content: center; + gap: .5em; + margin-bottom: .75em; +} + +.nuttx-version-label { + font-size: .7em; + font-weight: 600; + letter-spacing: .09em; + text-transform: uppercase; + color: #cee3f1; + opacity: .8; +} + +.version-selector select { + appearance: none; + -webkit-appearance: none; + padding: .32em 1.9em .32em .75em; + border: 1px solid rgba(90, 150, 189, .75); + border-radius: 6px; + background-color: rgba(255, 255, 255, .1); + color: #fff; + font-size: .85em; + line-height: 1.4; + cursor: pointer; + /* The chevron is drawn here rather than fetched, so the sidebar needs no + * extra asset and no network. */ + background-image: + linear-gradient(45deg, transparent 50%, rgba(255, 255, 255, .75) 50%), + linear-gradient(135deg, rgba(255, 255, 255, .75) 50%, transparent 50%); + background-position: right 1em center, right .65em center; + background-size: 5px 5px, 5px 5px; + background-repeat: no-repeat; +} + +.version-selector select:hover, +.version-selector select:focus { + border-color: rgba(255, 255, 255, .55); + background-color: rgba(255, 255, 255, .18); + outline: none; +} + +.version-selector select option { + color: #404040; + background: #fff; +} + +.wy-side-nav-search input[type="text"] { + border: 1px solid rgba(90, 150, 189, .75) !important; + border-radius: 20px !important; + background-color: rgba(255, 255, 255, .1) !important; + color: #fff; + padding: .5em 1em; + box-shadow: none !important; +} + +.wy-side-nav-search input[type="text"]::placeholder { + color: #cee3f1; + opacity: .75; +} + +.wy-side-nav-search input[type="text"]:focus { + border-color: rgba(255, 255, 255, .55) !important; + background-color: rgba(255, 255, 255, .16) !important; + outline: none; +} + +/* Reading text ------------------------------------------------------------ + * + * Three changes, all about how long a reader can stay on a page. + * + * Justified prose, with hyphenation on. Justifying without hyphens is what + * produces the rivers of white space that make justified text worse than + * ragged-right, so the two go together and neither is useful alone. + * + * Prose uses the full width of the content column, the same as the cards, + * the tables and the diagrams. A narrower measure reads better in the + * abstract -- 60 to 80 characters against the column's 107 -- but it gives + * a page two different right margins, and a paragraph that stops short of + * the boxes underneath it looks like a mistake rather than like + * typography. Hyphenation is what keeps the long line honest. + * + * A darker body colour. The theme's #404040 on white is a little washed + * out; #2b3137 raises the contrast from about 10:1 to 13:1, which reads as + * sharper without going to black, and black on white is its own kind of + * tiring. + * + * Links take the indigo from logos/NuttX_Simple.svg, the same colour as the + * sidebar, instead of the theme's unrelated cyan. + */ + +.rst-content p, +.rst-content li, +.rst-content dd { + text-align: justify; + hyphens: auto; + -webkit-hyphens: auto; +} + +/* Anything that is not running prose keeps its own alignment: code has + * meaningful whitespace, and a short line in a table or a card only looks + * stretched when justified. + */ + +.rst-content pre, +.rst-content pre *, +.rst-content .highlight, +.rst-content .highlight *, +.rst-content table p, +.rst-content table li, +.rst-content .sd-card p, +.rst-content .sd-card li, +.rst-content .caption-text, +.rst-content figcaption, +.rst-content figcaption p, +.rst-content .toctree-wrapper li, +.rst-content dl.c dt, +.wy-menu-vertical li { + text-align: left !important; + hyphens: manual; + max-width: none; +} + +.rst-content, +.rst-content p, +.rst-content li, +.rst-content dd, +.rst-content .section, +.wy-plain-list-disc li { + color: #2b3137; +} + +.rst-content p, +.rst-content li, +.rst-content dd { + line-height: 1.72; +} + +.rst-content a, +.rst-content a:visited { + color: #3c34e3; +} + +.rst-content a:hover { + color: #2b2787; +} diff --git a/Documentation/_templates/layout.html b/Documentation/_templates/layout.html index 3812e2b7c2e..29f41e9e5ba 100644 --- a/Documentation/_templates/layout.html +++ b/Documentation/_templates/layout.html @@ -19,26 +19,31 @@ {% extends "!layout.html" %} {% block sidebartitle %} - {% if logo and theme_logo_only %} - - {% else %} - {{ project }} - {% endif %} + {#- Sphinx passes the logo as `logo_url`; it used to be `logo`, and when + that changed this template quietly stopped rendering the mark at all, + leaving only the theme's house icon. Accept both so the logo shows on + either. -#} + {%- set nuttx_logo = logo_url if logo_url else (pathto('_static/' + logo, 1) if logo else none) %} - {% if logo %} - {# Not strictly valid HTML, but it's the only way to display/scale - it properly, without weird scripting or heaps of work - #} - - {% endif %} + + {% if nuttx_logo %} + + {% endif %} + {% if not theme_logo_only %} + {{ project }} + {% endif %} - -
- + {#- The Makefile builds this list as "latest,$(NUTTX_VERSIONS)", so an + unset NUTTX_VERSIONS leaves a trailing comma and an empty entry. + Dropping the blanks here keeps a nameless option pointing at ./../ + out of the menu. -#} + {% for nuttx_version in nuttx_versions.split(',') if nuttx_version.strip() %} + {%- set nuttx_version = nuttx_version.strip() %} {% endfor %} @@ -46,4 +51,3 @@ {% include "searchbox.html" %} {% endblock %} - diff --git a/Documentation/_templates/redirect.html b/Documentation/_templates/redirect.html new file mode 100644 index 00000000000..e226ce795a5 --- /dev/null +++ b/Documentation/_templates/redirect.html @@ -0,0 +1,5 @@ + + + + + diff --git a/Documentation/about/index.rst b/Documentation/about/index.rst new file mode 100644 index 00000000000..3c89eefb590 --- /dev/null +++ b/Documentation/about/index.rst @@ -0,0 +1,16 @@ +===== +About +===== + +The project itself: common questions, the words it uses, its record of +security vulnerabilities and how to report a new one, what changed in each +release, and the logos. + +.. toctree:: + :maxdepth: 1 + + /faq/index.rst + /security.rst + /glossary.rst + /ReleaseNotes/index.rst + /logos/index.rst diff --git a/Documentation/applications/examples/baromonitor/index.rst b/Documentation/applications/examples/baromonitor/index.rst index f73b4140902..9f98109236f 100644 --- a/Documentation/applications/examples/baromonitor/index.rst +++ b/Documentation/applications/examples/baromonitor/index.rst @@ -16,7 +16,7 @@ and temperature information on animated gauges. To use the barometer dashboard, just ensure there is a ``sensor_baro`` topic registered on the target and then run ``baromonitor``. These sensor topics are registered by NuttX barometer sensor drivers (see -:doc:`/components/drivers/special/sensors/sensors_uorb`). +:doc:`/os/drivers/special/sensors/sensors_uorb`). By default, the application attempts to subscribe to ``sensor_baro0``, but if you wish to monitor a different barometer topic you can pass the instance number diff --git a/Documentation/applications/examples/fb/index.rst b/Documentation/applications/examples/fb/index.rst index 6c6bb7bdf31..0fcb6a30fcf 100644 --- a/Documentation/applications/examples/fb/index.rst +++ b/Documentation/applications/examples/fb/index.rst @@ -4,7 +4,7 @@ This application is a simple demonstration which serves to test the :doc:`framebuffer character driver -`. +`. The program interacts with the framebuffer through the interfaces described in the linked page in order to render a very simple image consisting of 6 diff --git a/Documentation/applications/examples/nxflatxip/index.rst b/Documentation/applications/examples/nxflatxip/index.rst index 38e3e1c0732..74de1ee54e1 100644 --- a/Documentation/applications/examples/nxflatxip/index.rst +++ b/Documentation/applications/examples/nxflatxip/index.rst @@ -2,7 +2,7 @@ ``nxflatxip`` NXFLAT Executed In Place from XIPFS ================================================= -Writes an NXFLAT module into a :doc:`XIPFS ` +Writes an NXFLAT module into a :doc:`XIPFS ` volume at run time, the way a download would, and runs two instances of it concurrently. The module's text is executed directly out of flash and shared between the instances; each instance gets its own data. @@ -63,7 +63,7 @@ Building the module The module is built from ``module/xipmod.c`` at build time, exactly the way :doc:`../nxflat/index` builds its test programs, so it needs the same host tools: ``mknxflat``, which NuttX builds itself, and ``ldnxflat``, which has -to come from the buildroot toolchain. See :doc:`/components/nxflat`. +to come from the buildroot toolchain. See :doc:`/os/binfmt/nxflat`. The module has no static data and no string constants, and reports through a callback into the firmware rather than formatting its own output. The comment diff --git a/Documentation/applications/games/cgol/index.rst b/Documentation/applications/games/cgol/index.rst index 517b283f80b..f0f78a1d006 100644 --- a/Documentation/applications/games/cgol/index.rst +++ b/Documentation/applications/games/cgol/index.rst @@ -19,7 +19,7 @@ Requirements ------------ The CGOL implementation for NuttX relies on a frame buffer driver, that is: -:doc:`/components/nxgraphics/framebuffer_char_driver`. If you have +:doc:`/os/graphics/framebuffer_char_driver`. If you have ``VIDEO_FB`` enabled, you should be able to use the app. The visuals for the game are rendered to a display through the provided frame buffer. diff --git a/Documentation/applications/mlearning/index.rst b/Documentation/applications/mlearning/index.rst index 6231c28520b..166feade84c 100644 --- a/Documentation/applications/mlearning/index.rst +++ b/Documentation/applications/mlearning/index.rst @@ -28,7 +28,7 @@ TFLM). CMake currently builds ``tflite-micro`` and ``cmsis-nn`` only. A ready-to-build simulator configuration is ``sim:tflm``. See :doc:`/platforms/sim/sim/boards/sim/index`. The kernel also has an optional AI-engine character driver (``CONFIG_AI_ENGINE``); see -:doc:`/components/drivers/character/aie`. +:doc:`/os/drivers/character/aie`. .. toctree:: :glob: diff --git a/Documentation/applications/netutils/rexecd/index.rst b/Documentation/applications/netutils/rexecd/index.rst index 7f1246cda68..ee1aba7886c 100644 --- a/Documentation/applications/netutils/rexecd/index.rst +++ b/Documentation/applications/netutils/rexecd/index.rst @@ -30,7 +30,7 @@ Options ``-r`` Specify the address family as ``AF_RPMSG``. This serves the daemon over an RPMsg link instead of TCP/IP, allowing a remote processor in an AMP - system to execute commands. See :doc:`/components/drivers/special/rpmsg/concepts` + system to execute commands. See :doc:`/os/drivers/special/rpmsg/concepts` for details on RPMsg. ``-t`` diff --git a/Documentation/applications/system/critmon/index.rst b/Documentation/applications/system/critmon/index.rst index 7f1b4ed72ae..adebc2d9164 100644 --- a/Documentation/applications/system/critmon/index.rst +++ b/Documentation/applications/system/critmon/index.rst @@ -87,6 +87,6 @@ Stop the monitoring daemon: See Also ======== -- :doc:`/implementation/critical_sections` +- :doc:`/os/interrupts/critical_sections` - :doc:`../stackmonitor/index` - :doc:`../gprof/index` diff --git a/Documentation/applications/system/ptpd/index.rst b/Documentation/applications/system/ptpd/index.rst index 88a1710fe86..702e1fefdb4 100644 --- a/Documentation/applications/system/ptpd/index.rst +++ b/Documentation/applications/system/ptpd/index.rst @@ -593,7 +593,7 @@ Monitor debug output: Related Documentation ===================== -- :doc:`/components/drivers/special/ptp` - PTP Clock Driver Framework +- :doc:`/os/drivers/special/ptp` - PTP Clock Driver Framework - :doc:`/applications/netutils/index` - Network Utilities Overview - IEEE 1588-2008 Standard - Precision Time Protocol specification - IEEE 802.1AS Standard - Timing and Synchronization for Time-Sensitive Applications (gPTP) diff --git a/Documentation/applications/system/syslogd/index.rst b/Documentation/applications/system/syslogd/index.rst index 0c409ebcbfb..1e6eaa898a9 100644 --- a/Documentation/applications/system/syslogd/index.rst +++ b/Documentation/applications/system/syslogd/index.rst @@ -2,8 +2,6 @@ ``syslogd`` =========== -.. tags:: experimental - The ``syslogd`` command is used as a "syslog daemon". It sends syslog entries over the network using UDP so that they can be consumed by a central logging server. This is achieved by reading the newline separated long entries from the @@ -32,4 +30,4 @@ not receive or forward logs. dependent. This results in more consistent behaviour, but requires ``CONFIG_LIBC_EXECFUNCS`` to be enabled. -Read more about ``syslog`` on NuttX: :doc:`/components/drivers/special/syslog` +Read more about ``syslog`` on NuttX: :doc:`/os/drivers/special/syslog` diff --git a/Documentation/applications/system/xipfs/index.rst b/Documentation/applications/system/xipfs/index.rst index 487062969d8..a9915f6e2da 100644 --- a/Documentation/applications/system/xipfs/index.rst +++ b/Documentation/applications/system/xipfs/index.rst @@ -2,7 +2,7 @@ ``xipfs`` XIPFS Compaction and Block Map ========================================= -Compacts a :doc:`XIPFS ` volume and reports how +Compacts a :doc:`XIPFS ` volume and reports how its erase blocks are laid out. Because a XIPFS file is a single contiguous extent, an allocation can fail diff --git a/Documentation/applications/testing/cxx-oot-build/index.rst b/Documentation/applications/testing/cxx-oot-build/index.rst index 9216ebbfe16..bf6cc5ae5d6 100644 --- a/Documentation/applications/testing/cxx-oot-build/index.rst +++ b/Documentation/applications/testing/cxx-oot-build/index.rst @@ -72,4 +72,4 @@ If any step fails, the script will exit immediately with an error message. ``cxx-oot-build`` defconfig is preconfigured to build correctly but is **not suitable for running applications**. - For functional OOT builds, please follow the procedure documented in - :doc:`here `. + :doc:`here `. diff --git a/Documentation/applications/testing/unity/index.rst b/Documentation/applications/testing/unity/index.rst index 8e40b86418a..eced110a6a9 100644 --- a/Documentation/applications/testing/unity/index.rst +++ b/Documentation/applications/testing/unity/index.rst @@ -32,7 +32,7 @@ Usage In order to test your application using the Unity framework in NuttX, you can create a test application. Documentation for creating a custom NuttX application -can be found :doc:`here `. +can be found :doc:`here `. Just mark your application to depend on any Unity options you use: diff --git a/Documentation/applications/testing/xipfs/index.rst b/Documentation/applications/testing/xipfs/index.rst index 7b68753c03f..4caeaee272d 100644 --- a/Documentation/applications/testing/xipfs/index.rst +++ b/Documentation/applications/testing/xipfs/index.rst @@ -2,7 +2,7 @@ ``xipfs`` XIPFS File System Test ================================== -Exercises the :doc:`XIPFS ` file system: the +Exercises the :doc:`XIPFS ` file system: the routine VFS paths, the write-once rules, both flavours of mapping, and then the two properties that are easy to get wrong and quiet when they are -- release of execute-in-place pins, and power-loss atomicity of the metadata diff --git a/Documentation/applications/tools/index.rst b/Documentation/applications/tools/index.rst index 6d8dbf164b9..44a83ee05d8 100644 --- a/Documentation/applications/tools/index.rst +++ b/Documentation/applications/tools/index.rst @@ -49,7 +49,7 @@ Processes and Programs in the KERNEL Build In the kernel build, there are no tasks. There are only processes and all code lives in its own, private address space. -See :doc:`/implementation/processes_vs_tasks`. +See :doc:`/os/scheduling/processes_vs_tasks`. One consequence of that is that functions like ``task_create()`` and friends cannot be used in the KERNEL build mode. Instead, all processes must be loaded diff --git a/Documentation/components/drivers/character/leds/index.rst b/Documentation/components/drivers/character/leds/index.rst deleted file mode 100644 index 88887a9052b..00000000000 --- a/Documentation/components/drivers/character/leds/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -==== -LEDS -==== - -.. toctree:: - :caption: Supported Drivers - - userled.rst - ws2812.rst - ktd2052.rst diff --git a/Documentation/components/index.rst b/Documentation/components/index.rst index edd1415ede2..f1c59d23aa4 100644 --- a/Documentation/components/index.rst +++ b/Documentation/components/index.rst @@ -5,30 +5,12 @@ OS Components NuttX is very feature-rich RTOS and is thus composed of various different subsystems. The following sections explain how each of these main RTOS components work and can be used. For detailed documentation on the specific API used in this -case, you can head to the :doc:`reference <../reference/index>`. +case, you can head to the :doc:`reference `. .. toctree:: :maxdepth: 2 - :caption: Contents: - - binfmt.rst - concurrency/index.rst - iterable_sections.rst - drivers/index.rst - nxflat.rst - nxgraphics/index.rst - paging.rst - audio/index.rst - filesystem/index.rst - libs/index.rst - net/index.rst - mm/index.rst - syscall.rst - tools/index.rst - arch/index.rst - boards.rst + cmake.rst - openamp.rst - video.rst - crypto.rst - wireless.rst + iterable_sections.rst + boards.rst + tools/index.rst diff --git a/Documentation/components/tools/mksyscall-cvsparser.rst b/Documentation/components/tools/mksyscall-cvsparser.rst index cd2070db952..796173abd96 100644 --- a/Documentation/components/tools/mksyscall-cvsparser.rst +++ b/Documentation/components/tools/mksyscall-cvsparser.rst @@ -20,5 +20,5 @@ kernel function call (in kernel-mode) on behalf of the proxy function. Information about the stubs and proxies is maintained in a comma separated value (CSV) file in the syscall/ directory. The mksyscall program will accept this CVS file as input and generate all of the required proxy or -stub files as output. See :doc:`/components/syscall` for additional information. +stub files as output. See :doc:`/os/syscall` for additional information. diff --git a/Documentation/conf.py b/Documentation/conf.py index 69cab3e1e9d..63d0c709a85 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -32,16 +32,42 @@ # # import os +import datetime +import os +import pathlib import sys +import time # Add the '_extensions' directory to sys.path, to enable finding Sphinx # extensions within. sys.path.insert(0, "_extensions") +sys.path.insert(0, ".") + +from redirects import redirects # noqa: E402,F401 (used by sphinx_reredirects) + +# sphinx-reredirects writes a small page at every old URL. Its default one +# is a bare meta refresh, which drops the #anchor of a link to a section; this +# template carries the anchor across with one line of script, and keeps the +# meta refresh as the fallback when scripts are off. +redirect_html_template_file = "_templates/redirect.html" # -- Project information ----------------------------------------------------- project = "NuttX" -copyright = "2023, The Apache Software Foundation" + +# The start year is the one the NOTICE file at the repository root carries; +# the end year is the year the documentation is built, so that the footer +# stops going stale the moment a release slips past New Year. SOURCE_DATE_EPOCH +# is honoured so that a build stays reproducible, which is what the ASF release +# process needs -- Sphinx rewrites the trailing year from it as well, and this +# way the two agree instead of fighting. +_COPYRIGHT_SINCE = 2020 +_build_year = datetime.datetime.fromtimestamp( + int(os.environ.get("SOURCE_DATE_EPOCH", time.time())), + datetime.timezone.utc, +).year + +copyright = f"{_COPYRIGHT_SINCE}-{_build_year}, The Apache Software Foundation" author = "NuttX community" version = release = "latest" @@ -60,9 +86,11 @@ extensions = [ "sphinx_copybutton", "warnings_filter", "sphinx_tags", + "tags_overview", "sphinx_design", "sphinx_collapse", "sphinxcontrib.plantuml", + "sphinx_reredirects", ] source_suffix = [".rst", ".md"] @@ -71,6 +99,18 @@ todo_include_todos = True autosectionlabel_prefix_document = True +# The release notes under ReleaseNotes/ are a frozen archive: each file is the +# text exactly as it was written at the time of the release. They reuse the +# same section titles over and over ("Bug Fixes", "New Features", one per +# subsystem), which makes autosectionlabel emit a duplicate-label warning for +# every repetition. Nothing cross-references a section *inside* a release +# note, so simply stop indexing them. The list is derived from the directory +# so that new releases are covered automatically. +suppress_warnings = [ + f"autosectionlabel.ReleaseNotes/{path.stem}" + for path in sorted(pathlib.Path(__file__).parent.glob("ReleaseNotes/NuttX-*.md")) +] + # do not set Python as primary domain for code blocks highlight_language = "none" primary_domain = None @@ -85,6 +125,7 @@ exclude_patterns = [ "_build", "Thumbs.db", ".DS_Store", + # Not a page of its own: it is inlined by introduction/resources.rst. "legacy_README.md", "venv", ".venv", diff --git a/Documentation/contributing/doc_templates/board-tags-example.txt b/Documentation/contributing/doc_templates/board-tags-example.txt new file mode 100644 index 00000000000..41832a906b5 --- /dev/null +++ b/Documentation/contributing/doc_templates/board-tags-example.txt @@ -0,0 +1 @@ +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st diff --git a/Documentation/debugging/tasktraceinternal.rst b/Documentation/debugging/tasktraceinternal.rst index d2eefd6ab93..e1bcd9380bf 100644 --- a/Documentation/debugging/tasktraceinternal.rst +++ b/Documentation/debugging/tasktraceinternal.rst @@ -42,14 +42,14 @@ Noteram device driver (``nuttx/drivers/note/noteram_driver.c``) - Accumurate incoming note records into the buffer. - Read the note records from the buffer by user requests. - The notes are recorded in the binary format of ``struct note_*_s``. -- The detail function is described in :doc:`../components/drivers/character/note`. +- The detail function is described in :doc:`../os/drivers/character/note`. Notectl device driver (``nuttx/drivers/note/notectl_driver.c``) --------------------------------------------------------------- - ``/dev/notectl`` device driver. - Control the filter logic in ``sched_note.c`` by calling note filter APIs. -- The detail function is described in :doc:`../components/drivers/character/note`. +- The detail function is described in :doc:`../os/drivers/character/note`. "``trace``" Built-In Application (``apps/system/trace/trace.c``) ---------------------------------------------------------------- diff --git a/Documentation/developing/index.rst b/Documentation/developing/index.rst new file mode 100644 index 00000000000..8dd75a75b4c --- /dev/null +++ b/Documentation/developing/index.rst @@ -0,0 +1,21 @@ +================ +Developing NuttX +================ + +Working **on** NuttX rather than with it: how to get a change accepted, how +the build system and its tooling fit together, the conventions the code +follows, and how the project tests itself. + +If you are writing an application that runs on NuttX, you probably want +:doc:`/guides/index` or :doc:`/os/index` instead. And if you are porting to +a new SoC or board, start with :doc:`/guides/porting/port`: the step-by-step +guide lives in Guides, and what this section adds is the conventions and +naming rules a port has to follow. + +.. toctree:: + :maxdepth: 2 + + /contributing/index.rst + /components/index.rst + /implementation/index.rst + /testing/index.rst diff --git a/Documentation/guides/building_nuttx_with_app_out_of_src_tree.rst b/Documentation/guides/build/building_nuttx_with_app_out_of_src_tree.rst similarity index 98% rename from Documentation/guides/building_nuttx_with_app_out_of_src_tree.rst rename to Documentation/guides/build/building_nuttx_with_app_out_of_src_tree.rst index a31d5b77f4d..ab4dc97c6e5 100644 --- a/Documentation/guides/building_nuttx_with_app_out_of_src_tree.rst +++ b/Documentation/guides/build/building_nuttx_with_app_out_of_src_tree.rst @@ -51,7 +51,7 @@ then there is an easy way to do that too: Create a symbolic link in the ``apps/`` directory that redirects to your application sub-directory (or copy your code into a sub-directory of ``apps/``). -.. image:: image/custom_app_dir_through_extension.png +.. image:: /guides/image/custom_app_dir_through_extension.png Makefile and Make.defs ^^^^^^^^^^^^^^^^^^^^^^ @@ -129,7 +129,7 @@ appear as a directory under your custom application directory instead of your application directories being inserted as sub-directories of ``apps/``. It may even be implemented as a sub-module of your custom application directory. -.. image:: image/custom_app_dir_through_containment.png +.. image:: /guides/image/custom_app_dir_through_containment.png Kconfig and Makefile ^^^^^^^^^^^^^^^^^^^^ diff --git a/Documentation/guides/building_uclibcpp.rst b/Documentation/guides/build/building_uclibcpp.rst similarity index 100% rename from Documentation/guides/building_uclibcpp.rst rename to Documentation/guides/build/building_uclibcpp.rst diff --git a/Documentation/guides/cpp_cmake.rst b/Documentation/guides/build/cpp_cmake.rst similarity index 100% rename from Documentation/guides/cpp_cmake.rst rename to Documentation/guides/build/cpp_cmake.rst diff --git a/Documentation/guides/custom_app_directories.rst b/Documentation/guides/build/custom_app_directories.rst similarity index 100% rename from Documentation/guides/custom_app_directories.rst rename to Documentation/guides/build/custom_app_directories.rst diff --git a/Documentation/guides/customapps.rst b/Documentation/guides/build/customapps.rst similarity index 100% rename from Documentation/guides/customapps.rst rename to Documentation/guides/build/customapps.rst diff --git a/Documentation/guides/integrate_newlib.rst b/Documentation/guides/build/integrate_newlib.rst similarity index 100% rename from Documentation/guides/integrate_newlib.rst rename to Documentation/guides/build/integrate_newlib.rst diff --git a/Documentation/guides/nix_flake.rst b/Documentation/guides/build/nix_flake.rst similarity index 100% rename from Documentation/guides/nix_flake.rst rename to Documentation/guides/build/nix_flake.rst diff --git a/Documentation/guides/platform_directories.rst b/Documentation/guides/build/platform_directories.rst similarity index 99% rename from Documentation/guides/platform_directories.rst rename to Documentation/guides/build/platform_directories.rst index 194caa76fb2..bcb4dd8648c 100644 --- a/Documentation/guides/platform_directories.rst +++ b/Documentation/guides/build/platform_directories.rst @@ -10,7 +10,7 @@ Let's assume that you are not change the OS itself but want to implement or extend platform-specific code.In this case, there are six, maybe seven, places where you can provide the platform code. -.. image:: image/directories.png +.. image:: /guides/image/directories.png REVISIT: This is a out of date. There has been a recent reorganization diff --git a/Documentation/guides/armv7m_runtimestackcheck.rst b/Documentation/guides/chip-specific/armv7m_runtimestackcheck.rst similarity index 100% rename from Documentation/guides/armv7m_runtimestackcheck.rst rename to Documentation/guides/chip-specific/armv7m_runtimestackcheck.rst diff --git a/Documentation/guides/changing_systemclockconfig.rst b/Documentation/guides/chip-specific/changing_systemclockconfig.rst similarity index 99% rename from Documentation/guides/changing_systemclockconfig.rst rename to Documentation/guides/chip-specific/changing_systemclockconfig.rst index 0b5039ee2ce..2e25808b425 100644 --- a/Documentation/guides/changing_systemclockconfig.rst +++ b/Documentation/guides/chip-specific/changing_systemclockconfig.rst @@ -166,4 +166,4 @@ recalculate their frequency related settings. Here is some Power Management documentation: -- :doc:`/components/drivers/special/power/pm/index` +- :doc:`/os/drivers/special/power/pm/index` diff --git a/Documentation/guides/port_drivers_to_stm32f7.rst b/Documentation/guides/chip-specific/port_drivers_to_stm32f7.rst similarity index 100% rename from Documentation/guides/port_drivers_to_stm32f7.rst rename to Documentation/guides/chip-specific/port_drivers_to_stm32f7.rst diff --git a/Documentation/guides/semihosting.rst b/Documentation/guides/chip-specific/semihosting.rst similarity index 100% rename from Documentation/guides/semihosting.rst rename to Documentation/guides/chip-specific/semihosting.rst diff --git a/Documentation/guides/smaller_vector_tables.rst b/Documentation/guides/chip-specific/smaller_vector_tables.rst similarity index 100% rename from Documentation/guides/smaller_vector_tables.rst rename to Documentation/guides/chip-specific/smaller_vector_tables.rst diff --git a/Documentation/guides/stm32_ports.rst b/Documentation/guides/chip-specific/stm32_ports.rst similarity index 100% rename from Documentation/guides/stm32_ports.rst rename to Documentation/guides/chip-specific/stm32_ports.rst diff --git a/Documentation/guides/stm32ccm.rst b/Documentation/guides/chip-specific/stm32ccm.rst similarity index 100% rename from Documentation/guides/stm32ccm.rst rename to Documentation/guides/chip-specific/stm32ccm.rst diff --git a/Documentation/guides/stm32nullpointer.rst b/Documentation/guides/chip-specific/stm32nullpointer.rst similarity index 100% rename from Documentation/guides/stm32nullpointer.rst rename to Documentation/guides/chip-specific/stm32nullpointer.rst diff --git a/Documentation/guides/fork_vfork_migration.rst b/Documentation/guides/concurrency/fork_vfork_migration.rst similarity index 100% rename from Documentation/guides/fork_vfork_migration.rst rename to Documentation/guides/concurrency/fork_vfork_migration.rst diff --git a/Documentation/guides/kernel_threads_with_custom_stacks.rst b/Documentation/guides/concurrency/kernel_threads_with_custom_stacks.rst similarity index 100% rename from Documentation/guides/kernel_threads_with_custom_stacks.rst rename to Documentation/guides/concurrency/kernel_threads_with_custom_stacks.rst diff --git a/Documentation/guides/nestedinterrupts.rst b/Documentation/guides/concurrency/nestedinterrupts.rst similarity index 100% rename from Documentation/guides/nestedinterrupts.rst rename to Documentation/guides/concurrency/nestedinterrupts.rst diff --git a/Documentation/guides/signal_events_interrupt_handlers.rst b/Documentation/guides/concurrency/signal_events_interrupt_handlers.rst similarity index 98% rename from Documentation/guides/signal_events_interrupt_handlers.rst rename to Documentation/guides/concurrency/signal_events_interrupt_handlers.rst index c363d7daccb..9a4f080e4a7 100644 --- a/Documentation/guides/signal_events_interrupt_handlers.rst +++ b/Documentation/guides/concurrency/signal_events_interrupt_handlers.rst @@ -106,7 +106,7 @@ it to zero: immediately after the ``sem_init()``. The effect of this function call is to disable priority inheritance for that specific semaphore. There should then be no priority inheritance operations on this semaphore that is -used for signaling. See :doc:`/guides/signaling_sem_priority_inheritance` +used for signaling. See :doc:`/guides/concurrency/signaling_sem_priority_inheritance` for further information. Since the semaphore is initialized to zero, each time that a thread joins @@ -197,7 +197,7 @@ NOTE: There is possibility of improper interactions between the semaphore when it is used for signaling and priority inheritance. In this case, you should disable priority inheritance on the signaling semaphore using ``sem_setprotocol(SEM_PRIO_NONE)``. See -:doc:`/guides/signaling_sem_priority_inheritance` +:doc:`/guides/concurrency/signaling_sem_priority_inheritance` for further information. Signals diff --git a/Documentation/guides/signaling_sem_priority_inheritance.rst b/Documentation/guides/concurrency/signaling_sem_priority_inheritance.rst similarity index 100% rename from Documentation/guides/signaling_sem_priority_inheritance.rst rename to Documentation/guides/concurrency/signaling_sem_priority_inheritance.rst diff --git a/Documentation/guides/thread_local_storage.rst b/Documentation/guides/concurrency/thread_local_storage.rst similarity index 100% rename from Documentation/guides/thread_local_storage.rst rename to Documentation/guides/concurrency/thread_local_storage.rst diff --git a/Documentation/guides/usingkernelthreads.rst b/Documentation/guides/concurrency/usingkernelthreads.rst similarity index 100% rename from Documentation/guides/usingkernelthreads.rst rename to Documentation/guides/concurrency/usingkernelthreads.rst diff --git a/Documentation/guides/versioning_and_task_names.rst b/Documentation/guides/concurrency/versioning_and_task_names.rst similarity index 100% rename from Documentation/guides/versioning_and_task_names.rst rename to Documentation/guides/concurrency/versioning_and_task_names.rst diff --git a/Documentation/guides/zerolatencyinterrupts.rst b/Documentation/guides/concurrency/zerolatencyinterrupts.rst similarity index 100% rename from Documentation/guides/zerolatencyinterrupts.rst rename to Documentation/guides/concurrency/zerolatencyinterrupts.rst diff --git a/Documentation/guides/devicetree.rst b/Documentation/guides/drivers/devicetree.rst similarity index 100% rename from Documentation/guides/devicetree.rst rename to Documentation/guides/drivers/devicetree.rst diff --git a/Documentation/guides/drivers.rst b/Documentation/guides/drivers/drivers.rst similarity index 100% rename from Documentation/guides/drivers.rst rename to Documentation/guides/drivers/drivers.rst diff --git a/Documentation/guides/logging_rambuffer.rst b/Documentation/guides/drivers/logging_rambuffer.rst similarity index 100% rename from Documentation/guides/logging_rambuffer.rst rename to Documentation/guides/drivers/logging_rambuffer.rst diff --git a/Documentation/guides/lwl.rst b/Documentation/guides/drivers/lwl.rst similarity index 100% rename from Documentation/guides/lwl.rst rename to Documentation/guides/drivers/lwl.rst diff --git a/Documentation/guides/ofloader.rst b/Documentation/guides/drivers/ofloader.rst similarity index 100% rename from Documentation/guides/ofloader.rst rename to Documentation/guides/drivers/ofloader.rst diff --git a/Documentation/guides/reading_can_msgs.rst b/Documentation/guides/drivers/reading_can_msgs.rst similarity index 100% rename from Documentation/guides/reading_can_msgs.rst rename to Documentation/guides/drivers/reading_can_msgs.rst diff --git a/Documentation/guides/rndis.rst b/Documentation/guides/drivers/rndis.rst similarity index 100% rename from Documentation/guides/rndis.rst rename to Documentation/guides/drivers/rndis.rst diff --git a/Documentation/guides/usbtrace.rst b/Documentation/guides/drivers/usbtrace.rst similarity index 100% rename from Documentation/guides/usbtrace.rst rename to Documentation/guides/drivers/usbtrace.rst diff --git a/Documentation/guides/automounter.rst b/Documentation/guides/filesystem/automounter.rst similarity index 100% rename from Documentation/guides/automounter.rst rename to Documentation/guides/filesystem/automounter.rst diff --git a/Documentation/guides/etcromfs.rst b/Documentation/guides/filesystem/etcromfs.rst similarity index 100% rename from Documentation/guides/etcromfs.rst rename to Documentation/guides/filesystem/etcromfs.rst diff --git a/Documentation/guides/ram_rom_disks.rst b/Documentation/guides/filesystem/ram_rom_disks.rst similarity index 100% rename from Documentation/guides/ram_rom_disks.rst rename to Documentation/guides/filesystem/ram_rom_disks.rst diff --git a/Documentation/guides/index.rst b/Documentation/guides/index.rst index 9b6114409aa..0f52ddac8aa 100644 --- a/Documentation/guides/index.rst +++ b/Documentation/guides/index.rst @@ -6,61 +6,113 @@ Guides ====== .. toctree:: - nfs.rst - nix_flake.rst - usbtrace.rst - simulator.rst - rndis.rst - drivers.rst - cpp_cmake.rst - pysimcoder.rst - customboards.rst - customapps.rst - zerolatencyinterrupts.rst - fortify.rst - nestedinterrupts.rst - ofloader.rst - testingtcpip.rst - automounter.rst - stm32nullpointer.rst - stm32ccm.rst - etcromfs.rst - thread_local_storage.rst - devicetree.rst - changing_systemclockconfig.rst - usingkernelthreads.rst - armv7m_runtimestackcheck.rst - include_files_board_h.rst - specialstuff_in_nuttxheaderfiles.rst - kernel_threads_with_custom_stacks.rst - versioning_and_task_names.rst - logging_rambuffer.rst - ipv6.rst - integrate_newlib.rst - fork_vfork_migration.rst - protected_build.rst - platform_directories.rst - port_drivers_to_stm32f7.rst - semihosting.rst - renode.rst - signal_events_interrupt_handlers.rst - signaling_sem_priority_inheritance.rst - smaller_vector_tables.rst - port.rst - updating_release_system_elf.rst - partially_linked_elf.rst - fully_linked_elf.rst - building_nuttx_with_app_out_of_src_tree.rst - building_uclibcpp.rst - custom_app_directories.rst - multiple_nsh_sessions.rst - nsh_network_link_management.rst - ram_rom_disks.rst - reading_can_msgs.rst - remove_device_drivers_nsh.rst - rust.rst - optee.rst - qemu_tips.rst - lwl.rst - stm32_ports.rst + :maxdepth: 1 + build/building_nuttx_with_app_out_of_src_tree.rst + build/building_uclibcpp.rst + build/cpp_cmake.rst + build/custom_app_directories.rst + build/customapps.rst + build/integrate_newlib.rst + build/nix_flake.rst + build/platform_directories.rst + +.. toctree:: + :maxdepth: 1 + + porting/customboards.rst + porting/include_files_board_h.rst + porting/port.rst + porting/port_bootsequence.rst + porting/port_relatedkernelconfigrations.rst + porting/specialstuff_in_nuttxheaderfiles.rst + +.. toctree:: + :maxdepth: 1 + + drivers/devicetree.rst + drivers/drivers.rst + drivers/logging_rambuffer.rst + drivers/lwl.rst + drivers/ofloader.rst + drivers/reading_can_msgs.rst + drivers/rndis.rst + drivers/usbtrace.rst + +.. toctree:: + :maxdepth: 1 + + concurrency/fork_vfork_migration.rst + concurrency/kernel_threads_with_custom_stacks.rst + concurrency/nestedinterrupts.rst + concurrency/signal_events_interrupt_handlers.rst + concurrency/signaling_sem_priority_inheritance.rst + concurrency/thread_local_storage.rst + concurrency/usingkernelthreads.rst + concurrency/versioning_and_task_names.rst + concurrency/zerolatencyinterrupts.rst + +.. toctree:: + :maxdepth: 1 + + programs/fully_linked_elf.rst + programs/partially_linked_elf.rst + programs/protected_build.rst + programs/updating_release_system_elf.rst + +.. toctree:: + :maxdepth: 1 + + filesystem/automounter.rst + filesystem/etcromfs.rst + filesystem/ram_rom_disks.rst + +.. toctree:: + :maxdepth: 1 + + networking/ipv6.rst + networking/nfs.rst + networking/nsh_network_link_management.rst + networking/testingtcpip.rst + +.. toctree:: + :maxdepth: 1 + + nsh/multiple_nsh_sessions.rst + nsh/remove_device_drivers_nsh.rst + +.. toctree:: + :maxdepth: 1 + + simulation/qemu_tips.rst + simulation/renode.rst + simulation/simulator.rst + +.. toctree:: + :maxdepth: 1 + + security/fortify.rst + security/optee.rst + +.. toctree:: + :maxdepth: 1 + + languages/pysimcoder.rst + languages/rust.rst + +.. toctree:: + :maxdepth: 1 + + chip-specific/armv7m_runtimestackcheck.rst + chip-specific/changing_systemclockconfig.rst + chip-specific/port_drivers_to_stm32f7.rst + chip-specific/semihosting.rst + chip-specific/smaller_vector_tables.rst + chip-specific/stm32_ports.rst + chip-specific/stm32ccm.rst + chip-specific/stm32nullpointer.rst + +.. toctree:: + :maxdepth: 1 + + /debugging/index.rst diff --git a/Documentation/guides/pysimcoder.rst b/Documentation/guides/languages/pysimcoder.rst similarity index 98% rename from Documentation/guides/pysimcoder.rst rename to Documentation/guides/languages/pysimcoder.rst index 648c8bfb62c..864513c58e7 100644 --- a/Documentation/guides/pysimcoder.rst +++ b/Documentation/guides/languages/pysimcoder.rst @@ -133,7 +133,7 @@ libraries like "input", "output", "math" and so on. Several blocks can have spec of inputs/outputs. Double left click on the block opens parameter settings while single right click on the block leads to number of inputs/outputs setup. The pysimCoder interface can be seen in the picture below. -.. figure:: image/interface.png +.. figure:: /guides/image/interface.png :align: center :width: 100% @@ -142,7 +142,7 @@ to number of inputs/outputs setup. The pysimCoder interface can be seen in the p The NuttX template Makefile nuttx.tmf has to be selected in order to generate code for NuttX target. This can be done in the top menu by clicking on Block settings icon which is highlighted in the red circle. -.. figure:: image/menu.png +.. figure:: /guides/image/menu.png :align: center :width: 100% @@ -151,7 +151,7 @@ This can be done in the top menu by clicking on Block settings icon which is hig Block settings option open the following window (showed in the picture below) where you can set template Makefile and also Python skript with parameters for the controllers. -.. figure:: image/template.png +.. figure:: /guides/image/template.png :align: center :width: 100% diff --git a/Documentation/guides/rust.rst b/Documentation/guides/languages/rust.rst similarity index 100% rename from Documentation/guides/rust.rst rename to Documentation/guides/languages/rust.rst diff --git a/Documentation/guides/ipv6.rst b/Documentation/guides/networking/ipv6.rst similarity index 100% rename from Documentation/guides/ipv6.rst rename to Documentation/guides/networking/ipv6.rst diff --git a/Documentation/guides/nfs.rst b/Documentation/guides/networking/nfs.rst similarity index 100% rename from Documentation/guides/nfs.rst rename to Documentation/guides/networking/nfs.rst diff --git a/Documentation/guides/nsh_network_link_management.rst b/Documentation/guides/networking/nsh_network_link_management.rst similarity index 100% rename from Documentation/guides/nsh_network_link_management.rst rename to Documentation/guides/networking/nsh_network_link_management.rst diff --git a/Documentation/guides/testingtcpip.rst b/Documentation/guides/networking/testingtcpip.rst similarity index 100% rename from Documentation/guides/testingtcpip.rst rename to Documentation/guides/networking/testingtcpip.rst diff --git a/Documentation/guides/multiple_nsh_sessions.rst b/Documentation/guides/nsh/multiple_nsh_sessions.rst similarity index 100% rename from Documentation/guides/multiple_nsh_sessions.rst rename to Documentation/guides/nsh/multiple_nsh_sessions.rst diff --git a/Documentation/guides/remove_device_drivers_nsh.rst b/Documentation/guides/nsh/remove_device_drivers_nsh.rst similarity index 99% rename from Documentation/guides/remove_device_drivers_nsh.rst rename to Documentation/guides/nsh/remove_device_drivers_nsh.rst index 96505d55f91..460a76673be 100644 --- a/Documentation/guides/remove_device_drivers_nsh.rst +++ b/Documentation/guides/nsh/remove_device_drivers_nsh.rst @@ -12,7 +12,7 @@ NuttX and Unix-like Operating Systems Compared There are many things that are called device drivers. In this context, the discussion is limited to **character device drivers**. In NuttX, character device drivers are represented by device driver nodes in the top-level :doc:`pseudo -filesystem `. +filesystem `. Standard Unix-like operating systems also support device driver nodes, which superficially resemble NuttX device driver nodes: Both look like files and diff --git a/Documentation/guides/porting-case-studies/bcm2711-rpi4b.rst b/Documentation/guides/porting/case-studies/bcm2711-rpi4b.rst similarity index 100% rename from Documentation/guides/porting-case-studies/bcm2711-rpi4b.rst rename to Documentation/guides/porting/case-studies/bcm2711-rpi4b.rst diff --git a/Documentation/guides/porting-case-studies/port_arm_cm4.rst b/Documentation/guides/porting/case-studies/port_arm_cm4.rst similarity index 99% rename from Documentation/guides/porting-case-studies/port_arm_cm4.rst rename to Documentation/guides/porting/case-studies/port_arm_cm4.rst index 742d15b5ec2..ba8bdd53817 100644 --- a/Documentation/guides/porting-case-studies/port_arm_cm4.rst +++ b/Documentation/guides/porting/case-studies/port_arm_cm4.rst @@ -27,8 +27,8 @@ Step2 : Add the Board There are two ways about adding the Board directory. The one is in-of-tree, another one is out-of-tree. -For details see :doc:`/guides/customboards`. -And if you wanted to add own apps, see :doc:`/guides/customapps`. +For details see :doc:`/guides/porting/customboards`. +And if you wanted to add own apps, see :doc:`/guides/build/customapps`. This time, the way of out-of-tree is selected. The directory structure is following : diff --git a/Documentation/guides/customboards.rst b/Documentation/guides/porting/customboards.rst similarity index 98% rename from Documentation/guides/customboards.rst rename to Documentation/guides/porting/customboards.rst index 76c3b3afb48..854841b53c5 100644 --- a/Documentation/guides/customboards.rst +++ b/Documentation/guides/porting/customboards.rst @@ -2,7 +2,7 @@ Custom Boards How-To ==================== -As explained in :doc:`../quickstart/configuring`, supported boards (also known +As explained in :doc:`/quickstart/configuring`, supported boards (also known as "in-tree" boards) are configured using a standard syntax: .. code-block:: console diff --git a/Documentation/guides/include_files_board_h.rst b/Documentation/guides/porting/include_files_board_h.rst similarity index 100% rename from Documentation/guides/include_files_board_h.rst rename to Documentation/guides/porting/include_files_board_h.rst diff --git a/Documentation/guides/port.rst b/Documentation/guides/porting/port.rst similarity index 75% rename from Documentation/guides/port.rst rename to Documentation/guides/porting/port.rst index 0cae76a18bb..f4ab11858cf 100644 --- a/Documentation/guides/port.rst +++ b/Documentation/guides/porting/port.rst @@ -15,7 +15,7 @@ Porting a new SoC and board to NuttX requires modifications on arch, SoC and board directories. For the details, see :doc:`/quickstart/organization`, -:doc:`/components/arch/index`, +:doc:`/os/arch/index`, :doc:`/components/boards`. To port NuttX properly, we have to understand the boot sequence and @@ -39,32 +39,32 @@ Porting procedure At first, you have to read and execute :doc:`/quickstart/install` and :doc:`/quickstart/compiling_make`. After that, try following procedure. -+------+---------------+--------------------------------------------------------------------+ -| Step | Process | Comment | -+------+---------------+--------------------------------------------------------------------+ -| 1 | Add the SoC | | -+------+---------------+--------------------------------------------------------------------+ -| 2 | Add the Board | If the board was not sold in the market, | -| | | the board directory should be located out-of-tree. | -| | | For details see :doc:`/guides/customboards`. | -| | | And if you wanted to add own apps, see :doc:`/guides/customapps`. | -+------+---------------+--------------------------------------------------------------------+ -| 3 | Configure | The configure needs to understand related kernel configurations. | -| | | see :doc:`/guides/port_relatedkernelconfigrations`. | -+------+---------------+--------------------------------------------------------------------+ -| 4 | Compile | The compile tells you which source files are needed in SoC/Board | -| | | directory to pass the compile. | -+------+---------------+--------------------------------------------------------------------+ -| 5 | Link | The link tells you which symbols are needed in SoC/Board directory | -| | | to pass the link. | -+------+---------------+--------------------------------------------------------------------+ -| 6 | Implement | Do implement the symbols which are needed by the link. | -+------+---------------+--------------------------------------------------------------------+ -| 7 | Verify | Do "apps/testing/ostest". | -| | | I think the pass of ostest is the one of proof for proper porting. | -| | | And check the timer implementation whether the kernel could | -| | | count the time accurately or not. | -+------+---------------+--------------------------------------------------------------------+ ++------+---------------+-------------------------------------------------------------------------+ +| Step | Process | Comment | ++------+---------------+-------------------------------------------------------------------------+ +| 1 | Add the SoC | | ++------+---------------+-------------------------------------------------------------------------+ +| 2 | Add the Board | If the board was not sold in the market, | +| | | the board directory should be located out-of-tree. | +| | | For details see :doc:`/guides/porting/customboards`. | +| | | And if you wanted to add own apps, see :doc:`/guides/build/customapps`. | ++------+---------------+-------------------------------------------------------------------------+ +| 3 | Configure | The configure needs to understand related kernel configurations. | +| | | see :doc:`/guides/porting/port_relatedkernelconfigrations`. | ++------+---------------+-------------------------------------------------------------------------+ +| 4 | Compile | The compile tells you which source files are needed in SoC/Board | +| | | directory to pass the compile. | ++------+---------------+-------------------------------------------------------------------------+ +| 5 | Link | The link tells you which symbols are needed in SoC/Board directory | +| | | to pass the link. | ++------+---------------+-------------------------------------------------------------------------+ +| 6 | Implement | Do implement the symbols which are needed by the link. | ++------+---------------+-------------------------------------------------------------------------+ +| 7 | Verify | Do "apps/testing/ostest". | +| | | I think the pass of ostest is the one of proof for proper porting. | +| | | And check the timer implementation whether the kernel could | +| | | count the time accurately or not. | ++------+---------------+-------------------------------------------------------------------------+ Porting Case Studies =============================== @@ -76,4 +76,4 @@ provide a general idea on how to port. :glob: :maxdepth: 1 - porting-case-studies/* + case-studies/* diff --git a/Documentation/guides/port_bootsequence.rst b/Documentation/guides/porting/port_bootsequence.rst similarity index 97% rename from Documentation/guides/port_bootsequence.rst rename to Documentation/guides/porting/port_bootsequence.rst index b8439306690..677fb0e6659 100644 --- a/Documentation/guides/port_bootsequence.rst +++ b/Documentation/guides/porting/port_bootsequence.rst @@ -10,7 +10,7 @@ kernel and call ``nsh_main()``. ``nsh_main()`` will execute NuttShell(NSH). ``nx_start()`` is NuttX standard function, but the behavior depends on some kernel configurations. For example, the calling ``nsh_main()`` is also configurable. About related kernel configurations, see -:doc:`/guides/port_relatedkernelconfigrations`. +:doc:`/guides/porting/port_relatedkernelconfigrations`. .. uml:: diff --git a/Documentation/guides/port_relatedkernelconfigrations.rst b/Documentation/guides/porting/port_relatedkernelconfigrations.rst similarity index 100% rename from Documentation/guides/port_relatedkernelconfigrations.rst rename to Documentation/guides/porting/port_relatedkernelconfigrations.rst diff --git a/Documentation/guides/specialstuff_in_nuttxheaderfiles.rst b/Documentation/guides/porting/specialstuff_in_nuttxheaderfiles.rst similarity index 100% rename from Documentation/guides/specialstuff_in_nuttxheaderfiles.rst rename to Documentation/guides/porting/specialstuff_in_nuttxheaderfiles.rst diff --git a/Documentation/guides/fully_linked_elf.rst b/Documentation/guides/programs/fully_linked_elf.rst similarity index 99% rename from Documentation/guides/fully_linked_elf.rst rename to Documentation/guides/programs/fully_linked_elf.rst index 432d0344075..e01bdc67353 100644 --- a/Documentation/guides/fully_linked_elf.rst +++ b/Documentation/guides/programs/fully_linked_elf.rst @@ -502,9 +502,9 @@ D-bus, it cannot be used to execute programs. On the other hand, the STM32F3 has a CCM that is accessible to both the D-Bus and the I-Bus, in which case it should be possible to execute programs directly from this TCM. -.. image:: ./image/system_arch_stm32f42xx_and_f43xx.png +.. image:: /guides/image/system_arch_stm32f42xx_and_f43xx.png -.. image:: ./image/system_arch_stm32f303xBC_and_f358xC.png +.. image:: /guides/image/system_arch_stm32f303xBC_and_f358xC.png When ELF programs are loaded into memory, such memory is allocated from the heap via a standard memory allocator. With the STM32F4, the CCM is included diff --git a/Documentation/guides/partially_linked_elf.rst b/Documentation/guides/programs/partially_linked_elf.rst similarity index 99% rename from Documentation/guides/partially_linked_elf.rst rename to Documentation/guides/programs/partially_linked_elf.rst index b2b6ee8f307..a5c82f5b0de 100644 --- a/Documentation/guides/partially_linked_elf.rst +++ b/Documentation/guides/programs/partially_linked_elf.rst @@ -416,9 +416,9 @@ D-bus, it cannot be used to execute programs. On the other hand, the STM32F3 has a CCM that is accessible to both the D-Bus and the I-Bus, in which case it should be possible to execute programs directly from this TCM. -.. image:: ./image/system_arch_stm32f42xx_and_f43xx.png +.. image:: /guides/image/system_arch_stm32f42xx_and_f43xx.png -.. image:: ./image/system_arch_stm32f303xBC_and_f358xC.png +.. image:: /guides/image/system_arch_stm32f303xBC_and_f358xC.png When ELF programs are loaded into memory, such memory is allocated from the heap via a standard memory allocator. With the STM32F4, the CCM is included diff --git a/Documentation/guides/protected_build.rst b/Documentation/guides/programs/protected_build.rst similarity index 100% rename from Documentation/guides/protected_build.rst rename to Documentation/guides/programs/protected_build.rst diff --git a/Documentation/guides/updating_release_system_elf.rst b/Documentation/guides/programs/updating_release_system_elf.rst similarity index 100% rename from Documentation/guides/updating_release_system_elf.rst rename to Documentation/guides/programs/updating_release_system_elf.rst diff --git a/Documentation/guides/fortify.rst b/Documentation/guides/security/fortify.rst similarity index 100% rename from Documentation/guides/fortify.rst rename to Documentation/guides/security/fortify.rst diff --git a/Documentation/guides/optee.rst b/Documentation/guides/security/optee.rst similarity index 100% rename from Documentation/guides/optee.rst rename to Documentation/guides/security/optee.rst diff --git a/Documentation/guides/qemu_tips.rst b/Documentation/guides/simulation/qemu_tips.rst similarity index 100% rename from Documentation/guides/qemu_tips.rst rename to Documentation/guides/simulation/qemu_tips.rst diff --git a/Documentation/guides/renode.rst b/Documentation/guides/simulation/renode.rst similarity index 100% rename from Documentation/guides/renode.rst rename to Documentation/guides/simulation/renode.rst diff --git a/Documentation/guides/simulator.rst b/Documentation/guides/simulation/simulator.rst similarity index 100% rename from Documentation/guides/simulator.rst rename to Documentation/guides/simulation/simulator.rst diff --git a/Documentation/implementation/index.rst b/Documentation/implementation/index.rst index a0d71ddb152..d92b1e9476f 100644 --- a/Documentation/implementation/index.rst +++ b/Documentation/implementation/index.rst @@ -3,43 +3,12 @@ Implementation Details ====================== .. toctree:: - :maxdepth: 2 - :caption: Contents: - - bottomhalf_interrupt.rst - cancellation_points.rst + :maxdepth: 1 + chip_h.rst - chroot.rst - context_switches.rst - crc.rst - critical_sections.rst - device_drivers.rst - device_nodes.rst - drivers_design.rst - file_descriptors.rst - file_permission.rst hardfaults.rst - interrupt_controls.rst - ioctl.rst - kernel_modules_vs_shared_libraries.rst - kernel_threads_vs_pthreads.rst make_build_system.rst - memory_configurations.rst naming_arch_mcu_board_interfaces.rst naming_os_internals.rst nuttx_initialization_sequence.rst - nuttx_tasking.rst - oneshot_timers_and_cpu_load.rst - power_management.rst - preemption_latency.rst - processes_vs_tasks.rst - short_time_delays.rst - signal_handlers.rst simulation.rst - smp.rst - syslog.rst - tasks_vs_threads.rst - tickless_os.rst - tls.rst - user_identity.rst - usb.rst diff --git a/Documentation/implementation/make_build_system.rst b/Documentation/implementation/make_build_system.rst index 4a2eaa0b0a8..9a9acb39807 100644 --- a/Documentation/implementation/make_build_system.rst +++ b/Documentation/implementation/make_build_system.rst @@ -13,7 +13,7 @@ As stated in :doc:`/introduction/inviolables`, multiple platforms should be supp - :ref:`win_mk`: handles windows platform support. - :ref:`unix_mk`: handles unix-like platforms support. -NuttX supports multiple build modes. See :doc:`/guides/protected_build`: +NuttX supports multiple build modes. See :doc:`/guides/programs/protected_build`: - :ref:`flatlibs_mk`: Kernel and user-space built into a single ``blob``. - :ref:`protectedlibs_mk`: Kernel and user-space built as two separate ``blobs``. diff --git a/Documentation/index.rst b/Documentation/index.rst index 259fed022b1..fb9abebc393 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,12 +1,3 @@ -.. note:: - The present documentation is a recent addition to NuttX and was migrated from previous - documentation content. For this reason, it is possible you may find broken links or - formatting errors. You can help contribute fixes or improvements to this documentation - by following these :doc:`instructions `. - -.. tip:: - You can find the old documentation `here `_. - =================== NuttX Documentation =================== @@ -19,30 +10,142 @@ VxWorks) are adopted for functionality not available under these standards, or for functionality that is not appropriate for deeply-embedded environments (such as fork()). -Last Updated: |today| +Where to start +============== + +.. grid:: 1 2 2 3 + :gutter: 3 + + .. grid-item-card:: :octicon:`rocket;1.2em;sd-text-primary` Getting Started + :link: quickstart/index + :link-type: doc + + Install the toolchain, build for a board, get a shell. + Start here if you have never built NuttX. + + .. grid-item-card:: :octicon:`cpu;1.2em;sd-text-primary` Supported Platforms + :link: platforms/index + :link-type: doc + + Every architecture, chip and board NuttX runs on. + Start here if you have hardware in your hand. + + .. grid-item-card:: :octicon:`checklist;1.2em;sd-text-primary` Guides + :link: guides/index + :link-type: doc + + How to do a particular thing: port, write a driver, debug. + Start here when you know what you want to build. + +Understanding the system +======================== + +.. grid:: 1 2 2 3 + :gutter: 3 + + .. grid-item-card:: :octicon:`stack;1.2em;sd-text-primary` OS Design + :link: os/index + :link-type: doc + + How NuttX is built, subsystem by subsystem. + + .. grid-item-card:: :octicon:`book;1.2em;sd-text-primary` API Reference + :link: reference/index + :link-type: doc + + The POSIX and NuttX calls an application may make. + + .. grid-item-card:: :octicon:`apps;1.2em;sd-text-primary` Applications + :link: applications/index + :link-type: doc + + The programs that ship with NuttX, from NSH onwards. + +Working on NuttX +================ + +.. grid:: 1 2 2 2 + :gutter: 3 + + .. grid-item-card:: :octicon:`tools;1.2em;sd-text-primary` Developing NuttX + :link: developing/index + :link-type: doc + + Getting a change accepted, the build system, porting, testing. + + .. grid-item-card:: :octicon:`info;1.2em;sd-text-primary` About + :link: about/index + :link-type: doc + + Questions, vocabulary, security reports, release notes. + +How this documentation is organised +=================================== + +Four ideas decide where anything goes. They are written down here because +knowing them turns "where do I look?" into a question with an answer -- and, +for anyone writing documentation, "where do I put this?" as well. + +**The sections follow what you are doing, not what NuttX contains.** +Arriving, finding your hardware, doing a task, understanding a subsystem, +looking up a call: those are different activities, and each has a section. +Guides comes before OS Design on purpose, because people want something +running before they want to know how the scheduler works. + +**Three different questions, three different sections.** It is the same +subject seen three ways, and mixing them is what makes documentation hard to +search: + +.. list-table:: + :header-rows: 1 + :widths: 22 30 48 + + * - Section + - Answers + - For example + * - :doc:`Guides ` + - *How do I do X?* + - How to mount a ROMFS image at ``/etc`` + * - :doc:`OS Design ` + - *How does X work?* + - How the scheduler picks the next thread + * - :doc:`API Reference ` + - *What may I call?* + - What ``sched_setscheduler()`` takes and returns + +**OS Design follows the source tree.** Each top level directory of NuttX -- +``sched/``, ``fs/``, ``net/``, ``mm/``, ``drivers/`` -- is a section, and +each subsystem is described once, going from what it is, to how it works, to +the interfaces it offers. That is why there is one page about SMP rather +than three, and why a contributor knows which page to add to. + +**What can be derived is derived, and checked.** Board pages, the +architecture and chip each one is filed under, and the tags that let you +search for them all come from the source tree rather than being typed by +hand, and the build fails when the two disagree. A page describing a board +that no longer exists, or a board with no page, does not survive the next +pull request. + +.. note:: + Something wrong on a page, or missing? The documentation lives in the + same repository as the code, and every page has an *Edit on GitHub* link + at the top right. See :doc:`contributing/documentation` for how to build + it locally. .. toctree:: :caption: Table of Contents :maxdepth: 2 + :hidden: Home introduction/index.rst quickstart/index.rst - contributing/index.rst - introduction/inviolables.rst platforms/index.rst - components/index.rst - applications/index.rst - implementation/index.rst - reference/index.rst - faq/index.rst - debugging/index.rst - testing/index.rst guides/index.rst - standards/index.rst - security.rst - glossary.rst - logos/index.rst - _tags/tagsindex.rst + os/index.rst + reference/index.rst + applications/index.rst + developing/index.rst + about/index.rst .. include:: substitutions.rst diff --git a/Documentation/introduction/about.rst b/Documentation/introduction/about.rst index 05b4d5055f9..252e03916f8 100644 --- a/Documentation/introduction/about.rst +++ b/Documentation/introduction/about.rst @@ -51,7 +51,7 @@ Key features of NuttX include: * Fully pre-emptible. * Naturally scalable. * Highly configurable. - * Easily extensible to new processor architectures, SoC architecture, or board architectures. :doc:`/reference/os/index` is available. + * Easily extensible to new processor architectures, SoC architecture, or board architectures. :doc:`/os/index` is available. * FIFO and round-robin scheduling. * Realtime, deterministic, with support for priority inheritance * Tickless Operation @@ -95,10 +95,10 @@ Key features of NuttX include: * Union filesystem - Supports combining and overlaying file systems. * UserFS - User application file system. * ``procfs/`` pseudo-filesystem support. - * :doc:`/components/binfmt` with support for the following formats: + * :doc:`/os/binfmt/index` with support for the following formats: - Separately linked ELF modules. - - Separately linked :doc:`/components/nxflat` modules. NXFLAT is a binary format that can be XIP from a + - Separately linked :doc:`/os/binfmt/nxflat` modules. NXFLAT is a binary format that can be XIP from a file system. - "Built-In" applications. @@ -120,7 +120,7 @@ Key features of NuttX include: * Graphics: framebuffer drivers, graphic- and segment-LCD drivers. VNC server. * Audio subsystem: CODECs, audio input and output drivers. Command line and graphic media player applications. * Cryptographic subsystem. - * :doc:`/components/drivers/special/power/pm/index` sub-system. + * :doc:`/os/drivers/special/power/pm/index` sub-system. * ModBus support provided by built-in `FreeModBus `__ version 1.5.0. * **C/C++ Libraries** @@ -155,7 +155,7 @@ Key features of NuttX include: * ICMPv6 autonomous auto-configuration * NFS Client. Client side support for a Network File System (NFS, version 3, UDP). * A NuttX port of Jeff Poskanzer's `THTTPD `__ - HTTP server integrated with the NuttX :doc:`/components/binfmt` to provide true, embedded CGI. + HTTP server integrated with the NuttX :doc:`/os/binfmt/index` to provide true, embedded CGI. * PHY Link Status Management. * UDP Network Discovery (Contributed by Richard Cochran). * XML RPC Server (Contributed by Richard Cochran). @@ -185,7 +185,7 @@ Key features of NuttX include: * Device-dependent USB class drivers available for USB serial (CDC/ACM and a PL2303 emulation), for USB mass storage, for USB networking (RNDIS and CDC/ECM), DFU, and for a dynamically configurable, composite USB devices. - * Built-in :doc:`/guides/usbtrace` and USB host trace functionality for non-invasive USB debug. + * Built-in :doc:`/guides/drivers/usbtrace` and USB host trace functionality for non-invasive USB debug. * **Graphics Support** @@ -195,7 +195,7 @@ Key features of NuttX include: * VNC Server. * ``mmap``-able, framebuffer character driver. * NX: A graphics library, tiny windowing system and tiny font support that works with either - framebuffer or LCD drivers. Documented in the :doc:`/components/nxgraphics/index` manual. + framebuffer or LCD drivers. Documented in the :doc:`/os/graphics/index` manual. * Font management sub-system. * :doc:`/applications/graphics/nxwidgets/index`: NXWidgets is library of graphic objects, or "widgets," (labels, buttons, text boxes, images, sliders, progress bars, etc.). NXWidgets is written in C++ and diff --git a/Documentation/introduction/index.rst b/Documentation/introduction/index.rst index d16efdf41bb..f6af22ed737 100644 --- a/Documentation/introduction/index.rst +++ b/Documentation/introduction/index.rst @@ -8,8 +8,10 @@ In the following sections you will find basic information introducing main NuttX :maxdepth: 1 about.rst + inviolables.rst development_environments.rst licensing.rst trademarks.rst resources.rst + /standards/index.rst diff --git a/Documentation/reference/os/app_vs_os.rst b/Documentation/os/app_vs_os.rst similarity index 100% rename from Documentation/reference/os/app_vs_os.rst rename to Documentation/os/app_vs_os.rst diff --git a/Documentation/reference/os/arch.rst b/Documentation/os/arch/arch_api.rst similarity index 100% rename from Documentation/reference/os/arch.rst rename to Documentation/os/arch/arch_api.rst diff --git a/Documentation/reference/os/board.rst b/Documentation/os/arch/board_api.rst similarity index 100% rename from Documentation/reference/os/board.rst rename to Documentation/os/arch/board_api.rst diff --git a/Documentation/components/arch/index.rst b/Documentation/os/arch/index.rst similarity index 98% rename from Documentation/components/arch/index.rst rename to Documentation/os/arch/index.rst index c2e5a499481..51ba2922fc1 100644 --- a/Documentation/components/arch/index.rst +++ b/Documentation/os/arch/index.rst @@ -131,7 +131,7 @@ Summary of Files supports the ``CONFIG_BUILD_PROTECTED`` or ``CONFIG_BUILD_KERNEL``\ configurations. - See :doc:`/components/syscall` for details. + See :doc:`/os/syscall` for details. ``src//`` @@ -149,3 +149,9 @@ Supported Architectures ======================= The list of supported architectures can be found in :ref:`Supported Platforms `. + +.. toctree:: + :maxdepth: 1 + + arch_api.rst + board_api.rst diff --git a/Documentation/components/audio/index.rst b/Documentation/os/audio/index.rst similarity index 99% rename from Documentation/components/audio/index.rst rename to Documentation/os/audio/index.rst index 05bd6dab0e3..7be2546cf77 100644 --- a/Documentation/components/audio/index.rst +++ b/Documentation/os/audio/index.rst @@ -354,5 +354,5 @@ Related Subdirectories Related Pages ============= -* :doc:`/components/drivers/special/audio` +* :doc:`/os/drivers/special/audio` * :doc:`/applications/audioutils/index` diff --git a/Documentation/components/binfmt.rst b/Documentation/os/binfmt/index.rst similarity index 99% rename from Documentation/components/binfmt.rst rename to Documentation/os/binfmt/index.rst index ad61cc2f765..9cb48ec320e 100644 --- a/Documentation/components/binfmt.rst +++ b/Documentation/os/binfmt/index.rst @@ -360,3 +360,9 @@ Configuration Variables Additional configuration options may be required for the each enabled binary format. + +.. toctree:: + :maxdepth: 1 + + nxflat.rst + kernel_modules_vs_shared_libraries.rst diff --git a/Documentation/implementation/kernel_modules_vs_shared_libraries.rst b/Documentation/os/binfmt/kernel_modules_vs_shared_libraries.rst similarity index 100% rename from Documentation/implementation/kernel_modules_vs_shared_libraries.rst rename to Documentation/os/binfmt/kernel_modules_vs_shared_libraries.rst diff --git a/Documentation/components/nxflat.rst b/Documentation/os/binfmt/nxflat.rst similarity index 99% rename from Documentation/components/nxflat.rst rename to Documentation/os/binfmt/nxflat.rst index 48a3a97a07f..4e38f751992 100644 --- a/Documentation/components/nxflat.rst +++ b/Documentation/os/binfmt/nxflat.rst @@ -71,8 +71,8 @@ Limitations In fact, true file mapping is only possible with MCUs that provide an MMU1. Without an MMU, file system may support eXecution In Place (XIP) to mimic file mapping. Two file systems support that kind of XIP execution needed - by NXFLAT: :doc:`ROMFS `, whose image is built on the - host and is read-only, and :doc:`XIPFS `, which is + by NXFLAT: :doc:`ROMFS `, whose image is built on the + host and is read-only, and :doc:`XIPFS `, which is writable, so a module can be downloaded onto the board at run time and still be executed out of flash. diff --git a/Documentation/os/build_modes.rst b/Documentation/os/build_modes.rst new file mode 100644 index 00000000000..b9484069639 --- /dev/null +++ b/Documentation/os/build_modes.rst @@ -0,0 +1,208 @@ +.. _build-modes-detail: + +================================= +Flat, Protected and Kernel Builds +================================= + +.. _flat-build: + +Flat, Embedded Build +==================== + +The normal build of NuttX for the typical embedded environment uses +a single blob of code in a flat address space. +For most lower end CPUs (such as the ARM Cortex-M family), +this means executing directly out of the physical address space. + +Even if the CPU has an MMU (such as with the ARM Cortex-A family), +the typical NuttX build still uses a flat address space with the MMU +providing only an identity mapping. + +In this case, there is still benefit from using the MMU because +the MMU provides fine control over caching and memory behavior +over the address space. + + +.. _on-demand-paging: + +On-Demand Paging +================ + +NuttX also supports on-demand paging via ``CONFIG_PAGING``. +On-demand paging is a method of virtual memory management and requires +the the CPU architecture support a MMU. + +In a system that uses on-demand paging, the OS responds to a page fault +by copying data from some storage media into physical memory and setting up +the MMU to provided the necessary virtual address mapping. +The CPU can then continue from the page fault with the necessary memory +in place for the virtual address. + +Execution Image +--------------- + +The execution image is still built as one blob and appears as one blob on the +storage media. But the execution image is paged into arbitrary physical +addresses with non-contiguous virtual addresses. +The physical and virtual address spaces are then "checker boards" +of memory in use. + +Advantages +---------- + +The main advantage of on-demand paging is that you can execute a single +program that is much larger than the physical address space or a collection +of programs that together are much larger than the physical address space. + +Current Implementation +---------------------- + +On-demand paging is currently implemented only for the NXP LPC31xx family. +The LPC31xx has a 192KiB internal SRAM and with on-demand paging the LPC31xx +can execute a huge program residing in SerialFLASH by bringing in new pages +as needed from the SerialFLASH when ``_page`` ``fault_s`` occur. + + +.. _protected-build: + +Protected Build +=============== + +Protected Build Mode +-------------------- + +NuttX also supports a protected build mode for certain CPU architectures +if ``CONFIG_BUILD_PROTECTED`` is selected. + +**In this mode, NuttX is built as two blobs, one privileged and +one unprivileged.** The privileged blob contains the RTOS, and the other, +unprivileged blob holds all of the applications. + +The build supports system calls via a call gate so that the unprivileged, +application code can access the privileged RTOS services. + +Memory Protection +----------------- + +Within each blob, the address space is flat. No MMU is required to support +the protected build since no address mapping is performed. + +In fact, this feature is currently available only for the ARM Cortex-M family. +In this case the Cortex-M's MPU provides the security in the address spaces +of the two blobs. + +This feature could also be implemented with a CPU that supports an MMU, +but there has thus far been no reason to implement such a configuration. + +Dynamic Memory Allocation +------------------------- + +The purpose of protected build then is focused primarily on securing the OS +and CPU resources from potential rogue applications. + +The MPU simply protects the hardware, code regions, and data regions +of the RTOS. But dynamic memory allocations become more complex. +Protection is also required for (certain) memory allocations made by the RTOS. +The RTOS must also be capable of allocating memory that is accessible +by user applications (such as the user thread stacks). + +Dual Heaps +---------- + +In systems with MMUs, the privilege of each page of memory can be controlled +and there are established architectures for memory management of processes +(see below). However, with only an MPU with a limited number of pages +(the Cortex-M has 8 pages only!) we are forced to resolve this problem +by dividing available heap memory into two heaps: +a privileged heap and an unprivileged heap, using different allocations +mechanisms for each (kmalloc and malloc, respectively). + + +.. _addrenv: + +Address Environments +==================== + +If the option ``CONFIG_ARCH_ADDRENV`` is selected, then NuttX will support +address environments in the following way: the base code is still one blob +and identical in every way to the "Flat Embedded Build" discussed above. +But all applications are loaded into RAM from executable files, +separately compiled and separately linked programs, that reside +in a file system. + +Instead of starting the user application at a fixed, in-memory address +(such as ``nsh_main()``), the system will start the program contained +in an executable file, given its path. + +That initial user program can then start additional applications +from executable files in a file system. + +Per Program +----------- + +As each program is started, a new address environment is created +for the new task. This address environment is then unique for each task. +A task does not have the capability to access just anything in the address +environment. A task may only access addresses within its own address space +and within the address space of the base code. + +MMU (Memory Management Unit) +---------------------------- + +The CPU must support an MMU in order to provide address environments. + +This feature was originally implemented to support the ZiLOG Z180 which +is an 8-bit CPU (basically a Z80) that also supports a simple MMU. +Specifically for the P112 platform. Unfortunately, due to complex tool +issues and fading interest, that port was fully implemented but never tested. + +As of this writing, the implementation of address environment support +for the Cortex-A family is complete and verified. +An example configuration is available at +``nuttx/boards/arm/sama5/sama5d4-ek/configs/elf``. + + +.. _kernel-build: + +Kernel Build +============ + +The Kernel Build +---------------- + +And finally, there is the kernel build that is enabled with +``CONFIG_BUILD_KERNEL=y``. +The NuttX kernel build mode is similar to building with address environments: + +* Each application process executes from its own, private address environment. + +But, in addition, there are some features similar to the protected build mode: + +* NuttX is built as a monolithic kernel, similar to the way that NuttX + is built in the Protected Build Mode. +* All of the code that executes within the kernel executes in privileged, + kernel mode. Again, this is analogous to the Protected Build Mode. +* All user applications are executed with their own private + address environments in unprivileged, user-mode. + +MMU Required +------------ + +In order to support this kernel build mode, the **processor must provide +a Memory Management Unit (MMU)**. The MMU is used to provide both the address +environment for the user application as well as to enforce +the user-/kernel-mode privileges. + +This kernel build feature has been fully implemented and verified +on the Cortex-A family of processes. +A functioning example can be found at +``nuttx/boards/arm/sama5/sama5d4-ek/configs/knsh``. + +Process Environment +------------------- + +Such user applications that execute their own private, unprivileged address +environments are usually referred to as processes. + +The ``CONFIG_BUILD_KERNEL=y`` build is the first step toward support +for processes in NuttX. diff --git a/Documentation/os/build_modes.svg b/Documentation/os/build_modes.svg new file mode 100644 index 00000000000..cd2f06ec83c --- /dev/null +++ b/Documentation/os/build_modes.svg @@ -0,0 +1,88 @@ + + + + + + + + + CONFIG_BUILD_FLAT + one address space, no protection + APPLICATION + + write(fd, buf, n) + + a function call + KERNEL + + nx_writev() + + + the driver + Smallest and fastest. A bug in + the application can corrupt the + kernel. + + + + + CONFIG_BUILD_PROTECTED + one address space, MPU enforced + APPLICATION + + write(fd, buf, n) + + + + system call · MPU + KERNEL + + nx_writev() + + + the driver + The application cannot reach + kernel memory. Addresses are + still shared, so there is no fork(). + + + + + CONFIG_BUILD_KERNEL + one address space per process, MMU + PROCESS + + write(fd, buf, n) + + + + system call · MMU + KERNEL + + nx_writev() + + + the driver + Each process has its own virtual + addresses, so fork() and on-demand + paging work. Needs an MMU. + + diff --git a/Documentation/components/concurrency/index.rst b/Documentation/os/concurrency/index.rst similarity index 98% rename from Documentation/components/concurrency/index.rst rename to Documentation/os/concurrency/index.rst index c728b814580..8d5f002bf78 100644 --- a/Documentation/components/concurrency/index.rst +++ b/Documentation/os/concurrency/index.rst @@ -13,5 +13,5 @@ Related Subdirectories .. toctree:: :maxdepth: 2 :caption: Contents: - + seqcount/index.rst diff --git a/Documentation/components/concurrency/seqcount/index.rst b/Documentation/os/concurrency/seqcount/index.rst similarity index 100% rename from Documentation/components/concurrency/seqcount/index.rst rename to Documentation/os/concurrency/seqcount/index.rst diff --git a/Documentation/reference/os/conventions.rst b/Documentation/os/conventions.rst similarity index 100% rename from Documentation/reference/os/conventions.rst rename to Documentation/os/conventions.rst diff --git a/Documentation/components/crypto.rst b/Documentation/os/crypto.rst similarity index 100% rename from Documentation/components/crypto.rst rename to Documentation/os/crypto.rst diff --git a/Documentation/components/drivers/block/index.rst b/Documentation/os/drivers/block/index.rst similarity index 100% rename from Documentation/components/drivers/block/index.rst rename to Documentation/os/drivers/block/index.rst diff --git a/Documentation/components/drivers/block/ramdisk.rst b/Documentation/os/drivers/block/ramdisk.rst similarity index 100% rename from Documentation/components/drivers/block/ramdisk.rst rename to Documentation/os/drivers/block/ramdisk.rst diff --git a/Documentation/components/drivers/character/1wire.rst b/Documentation/os/drivers/character/1wire.rst similarity index 100% rename from Documentation/components/drivers/character/1wire.rst rename to Documentation/os/drivers/character/1wire.rst diff --git a/Documentation/components/drivers/character/aie.rst b/Documentation/os/drivers/character/aie.rst similarity index 100% rename from Documentation/components/drivers/character/aie.rst rename to Documentation/os/drivers/character/aie.rst diff --git a/Documentation/components/drivers/character/analog/adc/adc1242/index.rst b/Documentation/os/drivers/character/analog/adc/adc1242/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/adc1242/index.rst rename to Documentation/os/drivers/character/analog/adc/adc1242/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/ads1115/index.rst b/Documentation/os/drivers/character/analog/adc/ads1115/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/ads1115/index.rst rename to Documentation/os/drivers/character/analog/adc/ads1115/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/ads7828/index.rst b/Documentation/os/drivers/character/analog/adc/ads7828/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/ads7828/index.rst rename to Documentation/os/drivers/character/analog/adc/ads7828/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/hx711/index.rst b/Documentation/os/drivers/character/analog/adc/hx711/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/hx711/index.rst rename to Documentation/os/drivers/character/analog/adc/hx711/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/index.rst b/Documentation/os/drivers/character/analog/adc/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/index.rst rename to Documentation/os/drivers/character/analog/adc/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/ltc1867l/index.rst b/Documentation/os/drivers/character/analog/adc/ltc1867l/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/ltc1867l/index.rst rename to Documentation/os/drivers/character/analog/adc/ltc1867l/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/max1161x/index.rst b/Documentation/os/drivers/character/analog/adc/max1161x/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/max1161x/index.rst rename to Documentation/os/drivers/character/analog/adc/max1161x/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/mcp3008/index.rst b/Documentation/os/drivers/character/analog/adc/mcp3008/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/mcp3008/index.rst rename to Documentation/os/drivers/character/analog/adc/mcp3008/index.rst diff --git a/Documentation/components/drivers/character/analog/adc/pga11x/index.rst b/Documentation/os/drivers/character/analog/adc/pga11x/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/adc/pga11x/index.rst rename to Documentation/os/drivers/character/analog/adc/pga11x/index.rst diff --git a/Documentation/components/drivers/character/analog/dac/dac7554/index.rst b/Documentation/os/drivers/character/analog/dac/dac7554/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/dac/dac7554/index.rst rename to Documentation/os/drivers/character/analog/dac/dac7554/index.rst diff --git a/Documentation/components/drivers/character/analog/dac/dac7571/index.rst b/Documentation/os/drivers/character/analog/dac/dac7571/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/dac/dac7571/index.rst rename to Documentation/os/drivers/character/analog/dac/dac7571/index.rst diff --git a/Documentation/components/drivers/character/analog/dac/index.rst b/Documentation/os/drivers/character/analog/dac/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/dac/index.rst rename to Documentation/os/drivers/character/analog/dac/index.rst diff --git a/Documentation/components/drivers/character/analog/dac/mcp47x6/index.rst b/Documentation/os/drivers/character/analog/dac/mcp47x6/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/dac/mcp47x6/index.rst rename to Documentation/os/drivers/character/analog/dac/mcp47x6/index.rst diff --git a/Documentation/components/drivers/character/analog/dac/mcp48xx/index.rst b/Documentation/os/drivers/character/analog/dac/mcp48xx/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/dac/mcp48xx/index.rst rename to Documentation/os/drivers/character/analog/dac/mcp48xx/index.rst diff --git a/Documentation/components/drivers/character/analog/dac/stm32h7/index.rst b/Documentation/os/drivers/character/analog/dac/stm32h7/index.rst similarity index 99% rename from Documentation/components/drivers/character/analog/dac/stm32h7/index.rst rename to Documentation/os/drivers/character/analog/dac/stm32h7/index.rst index ffdf2c26c66..cc795b9213a 100644 --- a/Documentation/components/drivers/character/analog/dac/stm32h7/index.rst +++ b/Documentation/os/drivers/character/analog/dac/stm32h7/index.rst @@ -2,7 +2,7 @@ STM32H7 DAC Driver ==================== -.. tags:: chip:stm32h7, arch:arm, vendor:st, peripheral:dac +.. tags:: chip:stm32h7, arch:arm, vendor:st The STM32H7 DAC is a 12-bit, voltage-output, dual-channel digital-to-analog converter embedded in the STM32H7 MCU. The driver supports two operating modes: @@ -300,7 +300,7 @@ These commands are defined in ``include/nuttx/analog/ioctl.h``. The following commands are available when DMA is enabled (``CONFIG_STM32_DAC1CH1_DMA`` or ``CONFIG_STM32_DAC1CH2_DMA``). For the standard DAC ioctl commands see -:doc:`/components/drivers/character/analog/dac/index`. +:doc:`/os/drivers/character/analog/dac/index`. .. c:macro:: ANIOC_DAC_DMABUFF_INIT diff --git a/Documentation/components/drivers/character/analog/index.rst b/Documentation/os/drivers/character/analog/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/index.rst rename to Documentation/os/drivers/character/analog/index.rst diff --git a/Documentation/components/drivers/character/analog/pot/index.rst b/Documentation/os/drivers/character/analog/pot/index.rst similarity index 100% rename from Documentation/components/drivers/character/analog/pot/index.rst rename to Documentation/os/drivers/character/analog/pot/index.rst diff --git a/Documentation/components/drivers/character/bch.rst b/Documentation/os/drivers/character/bch.rst similarity index 100% rename from Documentation/components/drivers/character/bch.rst rename to Documentation/os/drivers/character/bch.rst diff --git a/Documentation/components/drivers/character/can.rst b/Documentation/os/drivers/character/can.rst similarity index 99% rename from Documentation/components/drivers/character/can.rst rename to Documentation/os/drivers/character/can.rst index 76ddfda7ed3..30e097c07b7 100644 --- a/Documentation/components/drivers/character/can.rst +++ b/Documentation/os/drivers/character/can.rst @@ -106,6 +106,6 @@ The upper half driver supports the **strict TX priority ordering**: **Usage Note**: The default behavior of the upper half driver is to return multiple messages on ``read``. See the `guide on this subject -`_. +`_. **Examples**: ``drivers/can/mcp2515.c``. diff --git a/Documentation/components/drivers/character/contactless.rst b/Documentation/os/drivers/character/contactless.rst similarity index 100% rename from Documentation/components/drivers/character/contactless.rst rename to Documentation/os/drivers/character/contactless.rst diff --git a/Documentation/components/drivers/character/crypto/index.rst b/Documentation/os/drivers/character/crypto/index.rst similarity index 100% rename from Documentation/components/drivers/character/crypto/index.rst rename to Documentation/os/drivers/character/crypto/index.rst diff --git a/Documentation/components/drivers/character/crypto/se05x.rst b/Documentation/os/drivers/character/crypto/se05x.rst similarity index 100% rename from Documentation/components/drivers/character/crypto/se05x.rst rename to Documentation/os/drivers/character/crypto/se05x.rst diff --git a/Documentation/components/drivers/character/eeprom.rst b/Documentation/os/drivers/character/eeprom.rst similarity index 100% rename from Documentation/components/drivers/character/eeprom.rst rename to Documentation/os/drivers/character/eeprom.rst diff --git a/Documentation/components/drivers/character/efuse.rst b/Documentation/os/drivers/character/efuse.rst similarity index 100% rename from Documentation/components/drivers/character/efuse.rst rename to Documentation/os/drivers/character/efuse.rst diff --git a/Documentation/components/drivers/character/gpio.rst b/Documentation/os/drivers/character/gpio.rst similarity index 99% rename from Documentation/components/drivers/character/gpio.rst rename to Documentation/os/drivers/character/gpio.rst index 53f3ee6e5aa..455ee82beb7 100644 --- a/Documentation/components/drivers/character/gpio.rst +++ b/Documentation/os/drivers/character/gpio.rst @@ -242,5 +242,5 @@ IO Expander device drivers are chips that provides more GPIO pins, usually connected to the MCU with SPI or I2C bus. It is possible to register individual GPIO pins of the expander as a separate pins if needed. This option is enabled by ``CONFIG_GPIO_LOWER_HALF`` option. Please refer -to `ioexpander documentation `_ +to `ioexpander documentation `_ for more description. diff --git a/Documentation/components/drivers/character/i2s.rst b/Documentation/os/drivers/character/i2s.rst similarity index 100% rename from Documentation/components/drivers/character/i2s.rst rename to Documentation/os/drivers/character/i2s.rst diff --git a/Documentation/components/drivers/character/index.rst b/Documentation/os/drivers/character/index.rst similarity index 100% rename from Documentation/components/drivers/character/index.rst rename to Documentation/os/drivers/character/index.rst diff --git a/Documentation/components/drivers/character/input/images/keypad-example.png b/Documentation/os/drivers/character/input/images/keypad-example.png similarity index 100% rename from Documentation/components/drivers/character/input/images/keypad-example.png rename to Documentation/os/drivers/character/input/images/keypad-example.png diff --git a/Documentation/components/drivers/character/input/images/mpr121.png b/Documentation/os/drivers/character/input/images/mpr121.png similarity index 100% rename from Documentation/components/drivers/character/input/images/mpr121.png rename to Documentation/os/drivers/character/input/images/mpr121.png diff --git a/Documentation/components/drivers/character/input/index.rst b/Documentation/os/drivers/character/input/index.rst similarity index 100% rename from Documentation/components/drivers/character/input/index.rst rename to Documentation/os/drivers/character/input/index.rst diff --git a/Documentation/components/drivers/character/input/keypad-keyboard.rst b/Documentation/os/drivers/character/input/keypad-keyboard.rst similarity index 100% rename from Documentation/components/drivers/character/input/keypad-keyboard.rst rename to Documentation/os/drivers/character/input/keypad-keyboard.rst diff --git a/Documentation/components/drivers/character/input/keypad.rst b/Documentation/os/drivers/character/input/keypad.rst similarity index 100% rename from Documentation/components/drivers/character/input/keypad.rst rename to Documentation/os/drivers/character/input/keypad.rst diff --git a/Documentation/components/drivers/character/input/mpr121.rst b/Documentation/os/drivers/character/input/mpr121.rst similarity index 100% rename from Documentation/components/drivers/character/input/mpr121.rst rename to Documentation/os/drivers/character/input/mpr121.rst diff --git a/Documentation/components/drivers/character/input/sbutton.rst b/Documentation/os/drivers/character/input/sbutton.rst similarity index 100% rename from Documentation/components/drivers/character/input/sbutton.rst rename to Documentation/os/drivers/character/input/sbutton.rst diff --git a/Documentation/components/drivers/character/input/st7123.rst b/Documentation/os/drivers/character/input/st7123.rst similarity index 100% rename from Documentation/components/drivers/character/input/st7123.rst rename to Documentation/os/drivers/character/input/st7123.rst diff --git a/Documentation/components/drivers/character/ipcc.rst b/Documentation/os/drivers/character/ipcc.rst similarity index 100% rename from Documentation/components/drivers/character/ipcc.rst rename to Documentation/os/drivers/character/ipcc.rst diff --git a/Documentation/reference/os/led.rst b/Documentation/os/drivers/character/leds/index.rst similarity index 98% rename from Documentation/reference/os/led.rst rename to Documentation/os/drivers/character/leds/index.rst index eaa4502c179..cb3f723bd6e 100644 --- a/Documentation/reference/os/led.rst +++ b/Documentation/os/drivers/character/leds/index.rst @@ -120,3 +120,10 @@ The ``include/nuttx/board.h`` includes the following declarations: definitions provided in ``/include/board.h``. Note that only ``LED_INIRQ``, ``LED_SIGNAL``, ``LED_ASSERTION``, and ``LED_PANIC`` indications are terminated. + +.. toctree:: + :caption: Supported Drivers + + userled.rst + ws2812.rst + ktd2052.rst diff --git a/Documentation/components/drivers/character/leds/ktd2052.rst b/Documentation/os/drivers/character/leds/ktd2052.rst similarity index 100% rename from Documentation/components/drivers/character/leds/ktd2052.rst rename to Documentation/os/drivers/character/leds/ktd2052.rst diff --git a/Documentation/components/drivers/character/leds/userled.rst b/Documentation/os/drivers/character/leds/userled.rst similarity index 100% rename from Documentation/components/drivers/character/leds/userled.rst rename to Documentation/os/drivers/character/leds/userled.rst diff --git a/Documentation/components/drivers/character/leds/ws2812.rst b/Documentation/os/drivers/character/leds/ws2812.rst similarity index 100% rename from Documentation/components/drivers/character/leds/ws2812.rst rename to Documentation/os/drivers/character/leds/ws2812.rst diff --git a/Documentation/components/drivers/character/loop.rst b/Documentation/os/drivers/character/loop.rst similarity index 100% rename from Documentation/components/drivers/character/loop.rst rename to Documentation/os/drivers/character/loop.rst diff --git a/Documentation/components/drivers/character/math.rst b/Documentation/os/drivers/character/math.rst similarity index 100% rename from Documentation/components/drivers/character/math.rst rename to Documentation/os/drivers/character/math.rst diff --git a/Documentation/components/drivers/character/modem.rst b/Documentation/os/drivers/character/modem.rst similarity index 100% rename from Documentation/components/drivers/character/modem.rst rename to Documentation/os/drivers/character/modem.rst diff --git a/Documentation/components/drivers/character/motor/foc.rst b/Documentation/os/drivers/character/motor/foc.rst similarity index 100% rename from Documentation/components/drivers/character/motor/foc.rst rename to Documentation/os/drivers/character/motor/foc.rst diff --git a/Documentation/components/drivers/character/motor/index.rst b/Documentation/os/drivers/character/motor/index.rst similarity index 100% rename from Documentation/components/drivers/character/motor/index.rst rename to Documentation/os/drivers/character/motor/index.rst diff --git a/Documentation/components/drivers/character/note.rst b/Documentation/os/drivers/character/note.rst similarity index 100% rename from Documentation/components/drivers/character/note.rst rename to Documentation/os/drivers/character/note.rst diff --git a/Documentation/components/drivers/character/nullzero.rst b/Documentation/os/drivers/character/nullzero.rst similarity index 100% rename from Documentation/components/drivers/character/nullzero.rst rename to Documentation/os/drivers/character/nullzero.rst diff --git a/Documentation/components/drivers/character/quadrature.rst b/Documentation/os/drivers/character/quadrature.rst similarity index 100% rename from Documentation/components/drivers/character/quadrature.rst rename to Documentation/os/drivers/character/quadrature.rst diff --git a/Documentation/components/drivers/character/rc.rst b/Documentation/os/drivers/character/rc.rst similarity index 100% rename from Documentation/components/drivers/character/rc.rst rename to Documentation/os/drivers/character/rc.rst diff --git a/Documentation/components/drivers/character/rf.rst b/Documentation/os/drivers/character/rf.rst similarity index 100% rename from Documentation/components/drivers/character/rf.rst rename to Documentation/os/drivers/character/rf.rst diff --git a/Documentation/components/drivers/character/serial.rst b/Documentation/os/drivers/character/serial.rst similarity index 100% rename from Documentation/components/drivers/character/serial.rst rename to Documentation/os/drivers/character/serial.rst diff --git a/Documentation/components/drivers/character/timers/capture.rst b/Documentation/os/drivers/character/timers/capture.rst similarity index 100% rename from Documentation/components/drivers/character/timers/capture.rst rename to Documentation/os/drivers/character/timers/capture.rst diff --git a/Documentation/components/drivers/character/timers/dshot.rst b/Documentation/os/drivers/character/timers/dshot.rst similarity index 100% rename from Documentation/components/drivers/character/timers/dshot.rst rename to Documentation/os/drivers/character/timers/dshot.rst diff --git a/Documentation/components/drivers/character/timers/index.rst b/Documentation/os/drivers/character/timers/index.rst similarity index 100% rename from Documentation/components/drivers/character/timers/index.rst rename to Documentation/os/drivers/character/timers/index.rst diff --git a/Documentation/components/drivers/character/timers/oneshot.rst b/Documentation/os/drivers/character/timers/oneshot.rst similarity index 100% rename from Documentation/components/drivers/character/timers/oneshot.rst rename to Documentation/os/drivers/character/timers/oneshot.rst diff --git a/Documentation/components/drivers/character/timers/pulsecount.rst b/Documentation/os/drivers/character/timers/pulsecount.rst similarity index 100% rename from Documentation/components/drivers/character/timers/pulsecount.rst rename to Documentation/os/drivers/character/timers/pulsecount.rst diff --git a/Documentation/components/drivers/character/timers/pwm.rst b/Documentation/os/drivers/character/timers/pwm.rst similarity index 100% rename from Documentation/components/drivers/character/timers/pwm.rst rename to Documentation/os/drivers/character/timers/pwm.rst diff --git a/Documentation/components/drivers/character/timers/rtc.rst b/Documentation/os/drivers/character/timers/rtc.rst similarity index 100% rename from Documentation/components/drivers/character/timers/rtc.rst rename to Documentation/os/drivers/character/timers/rtc.rst diff --git a/Documentation/components/drivers/character/timers/timer.rst b/Documentation/os/drivers/character/timers/timer.rst similarity index 100% rename from Documentation/components/drivers/character/timers/timer.rst rename to Documentation/os/drivers/character/timers/timer.rst diff --git a/Documentation/components/drivers/character/timers/timer.svg b/Documentation/os/drivers/character/timers/timer.svg similarity index 100% rename from Documentation/components/drivers/character/timers/timer.svg rename to Documentation/os/drivers/character/timers/timer.svg diff --git a/Documentation/components/drivers/character/timers/watchdog.rst b/Documentation/os/drivers/character/timers/watchdog.rst similarity index 100% rename from Documentation/components/drivers/character/timers/watchdog.rst rename to Documentation/os/drivers/character/timers/watchdog.rst diff --git a/Documentation/components/drivers/character/touchscreen.rst b/Documentation/os/drivers/character/touchscreen.rst similarity index 100% rename from Documentation/components/drivers/character/touchscreen.rst rename to Documentation/os/drivers/character/touchscreen.rst diff --git a/Documentation/components/drivers/character/wireless/index.rst b/Documentation/os/drivers/character/wireless/index.rst similarity index 100% rename from Documentation/components/drivers/character/wireless/index.rst rename to Documentation/os/drivers/character/wireless/index.rst diff --git a/Documentation/components/drivers/character/wireless/lpwan/SX1262.jpg b/Documentation/os/drivers/character/wireless/lpwan/SX1262.jpg similarity index 100% rename from Documentation/components/drivers/character/wireless/lpwan/SX1262.jpg rename to Documentation/os/drivers/character/wireless/lpwan/SX1262.jpg diff --git a/Documentation/components/drivers/character/wireless/lpwan/command_run0.jpg b/Documentation/os/drivers/character/wireless/lpwan/command_run0.jpg similarity index 100% rename from Documentation/components/drivers/character/wireless/lpwan/command_run0.jpg rename to Documentation/os/drivers/character/wireless/lpwan/command_run0.jpg diff --git a/Documentation/components/drivers/character/wireless/lpwan/index.rst b/Documentation/os/drivers/character/wireless/lpwan/index.rst similarity index 100% rename from Documentation/components/drivers/character/wireless/lpwan/index.rst rename to Documentation/os/drivers/character/wireless/lpwan/index.rst diff --git a/Documentation/components/drivers/character/wireless/lpwan/lora_gw.rst b/Documentation/os/drivers/character/wireless/lpwan/lora_gw.rst similarity index 100% rename from Documentation/components/drivers/character/wireless/lpwan/lora_gw.rst rename to Documentation/os/drivers/character/wireless/lpwan/lora_gw.rst diff --git a/Documentation/components/drivers/character/wireless/lpwan/sx126x.rst b/Documentation/os/drivers/character/wireless/lpwan/sx126x.rst similarity index 100% rename from Documentation/components/drivers/character/wireless/lpwan/sx126x.rst rename to Documentation/os/drivers/character/wireless/lpwan/sx126x.rst diff --git a/Documentation/components/drivers/character/wireless/lpwan/sx127x.rst b/Documentation/os/drivers/character/wireless/lpwan/sx127x.rst similarity index 100% rename from Documentation/components/drivers/character/wireless/lpwan/sx127x.rst rename to Documentation/os/drivers/character/wireless/lpwan/sx127x.rst diff --git a/Documentation/components/drivers/character/wireless/wireless_ioctl_white.drawio.png b/Documentation/os/drivers/character/wireless/wireless_ioctl_white.drawio.png similarity index 100% rename from Documentation/components/drivers/character/wireless/wireless_ioctl_white.drawio.png rename to Documentation/os/drivers/character/wireless/wireless_ioctl_white.drawio.png diff --git a/Documentation/implementation/device_drivers.rst b/Documentation/os/drivers/device_drivers.rst similarity index 100% rename from Documentation/implementation/device_drivers.rst rename to Documentation/os/drivers/device_drivers.rst diff --git a/Documentation/implementation/device_nodes.rst b/Documentation/os/drivers/device_nodes.rst similarity index 100% rename from Documentation/implementation/device_nodes.rst rename to Documentation/os/drivers/device_nodes.rst diff --git a/Documentation/implementation/drivers_design.rst b/Documentation/os/drivers/drivers_design.rst similarity index 100% rename from Documentation/implementation/drivers_design.rst rename to Documentation/os/drivers/drivers_design.rst diff --git a/Documentation/components/drivers/index.rst b/Documentation/os/drivers/index.rst similarity index 68% rename from Documentation/components/drivers/index.rst rename to Documentation/os/drivers/index.rst index dd2e70daebe..86296859b5b 100644 --- a/Documentation/components/drivers/index.rst +++ b/Documentation/os/drivers/index.rst @@ -5,14 +5,6 @@ Device Drivers NuttX supports a variety of device drivers, which can be broadly divided in three classes: -.. toctree:: - :maxdepth: 1 - - character/index.rst - block/index.rst - special/index.rst - thermal/index.rst - .. note:: Device driver support depends on the *in-memory*, *pseudo* file system that is enabled by default. @@ -32,86 +24,85 @@ Drivers in NuttX generally work in two distinct layers: usually implemented at the architecture or board level. Details about drivers implementation can be found in -:doc:`../../implementation/drivers_design` and :doc:`../../implementation/device_drivers`. +:doc:`/os/drivers/drivers_design` and :doc:`/os/drivers/device_drivers`. Subdirectories of ``nuttx/drivers`` =================================== -* ``1wire/`` :doc:`character/1wire` +* ``1wire/`` :doc:`/os/drivers/character/1wire` 1wire device drivers. -* ``aie/`` :doc:`character/aie` +* ``aie/`` :doc:`/os/drivers/character/aie` Upper-half character driver for hardware AI / NPU engines. See ``include/nuttx/aie/ai_engine.h``. -* ``analog/`` :doc:`character/analog/index` +* ``analog/`` :doc:`/os/drivers/character/analog/index` This directory holds implementations of analog device drivers. This includes drivers for Analog to Digital Conversion (ADC) as well as drivers for Digital to Analog Conversion (DAC). -* ``audio/`` :doc:`special/audio` +* ``audio/`` :doc:`/os/drivers/special/audio` Audio device drivers. -* ``bch/`` :doc:`character/bch` +* ``bch/`` :doc:`/os/drivers/character/bch` Contains logic that may be used to convert a block driver into a character driver. This is the complementary conversion as that performed by loop.c. -* ``can/`` :doc:`character/can` +* ``can/`` :doc:`/os/drivers/character/can` This is the CAN drivers and logic support. -* ``clk/``:doc:`special/clk` +* ``clk/``:doc:`/os/drivers/special/clk` Clock management (CLK) device drivers. -* ``contactless/`` :doc:`character/contactless` +* ``contactless/`` :doc:`/os/drivers/character/contactless` Contactless devices are related to wireless devices. They are not communication devices with other similar peers, but couplers/interfaces to contactless cards and tags. -* ``crypto/`` :doc:`character/crypto/index` +* ``crypto/`` :doc:`/os/drivers/character/crypto/index` Contains crypto drivers and support logic, including the ``/dev/urandom`` device. -* ``devicetree/`` :doc:`special/devicetree` +* ``devicetree/`` :doc:`/os/drivers/special/devicetree` Device Tree support. -* ``dma/`` :doc:`special/dma` +* ``dma/`` :doc:`/os/drivers/special/dma` DMA drivers support. -* ``eeprom/`` :doc:`character/eeprom` +* ``eeprom/`` :doc:`/os/drivers/character/eeprom` EEPROM support as character drivers. Support as Memory Technology Device (MTD) is located in the ``mtd/`` directory. -* ``efuse/`` :doc:`character/efuse` +* ``efuse/`` :doc:`/os/drivers/character/efuse` EFUSE drivers support. -* ``i2c/`` :doc:`special/i2c` +* ``i2c/`` :doc:`/os/drivers/special/i2c` I2C drivers and support logic. -* ``i2s/`` :doc:`character/i2s` +* ``i2s/`` :doc:`/os/drivers/character/i2s` I2S drivers and support logic. - -* ``i3c/`` :doc:`special/i3c` +* ``i3c/`` :doc:`/os/drivers/special/i3c` I3C drivers and support logic. -* ``input/`` :doc:`character/input/index` +* ``input/`` :doc:`/os/drivers/character/input/index` This directory holds implementations of human input device (HID) drivers. This includes such things as mouse, touchscreen, joystick, @@ -120,15 +111,15 @@ Subdirectories of ``nuttx/drivers`` Note that USB HID devices are treated differently. These can be found under ``usbdev/`` or ``usbhost/``. -* ``ioexpander/`` :doc:`special/ioexpander` +* ``ioexpander/`` :doc:`/os/drivers/special/ioexpander` IO Expander drivers. -* ``ipcc/`` :doc:`character/ipcc` +* ``ipcc/`` :doc:`/os/drivers/character/ipcc` IPCC (Inter Processor Communication Controller) driver. -* ``lcd/`` :doc:`special/lcd` +* ``lcd/`` :doc:`/os/drivers/special/lcd` Drivers for parallel and serial LCD and OLED type devices. @@ -136,35 +127,35 @@ Subdirectories of ``nuttx/drivers`` Various LED-related drivers including discrete as well as PWM- driven LEDs. -* ``loop/`` :doc:`character/loop` +* ``loop/`` :doc:`/os/drivers/character/loop` Supports the standard loop device that can be used to export a file (or character device) as a block device. See ``losetup()`` and ``loteardown()`` in ``include/nuttx/fs/fs.h``. -* ``math/`` :doc:`character/math` +* ``math/`` :doc:`/os/drivers/character/math` MATH Acceleration drivers. -* ``misc/`` :doc:`character/nullzero` :doc:`special/rwbuffer` :doc:`block/ramdisk` +* ``misc/`` :doc:`/os/drivers/character/nullzero` :doc:`/os/drivers/special/rwbuffer` :doc:`/os/drivers/block/ramdisk` Various drivers that don't fit elsewhere. -* ``mmcsd/`` :doc:`special/sdio` :doc:`special/mmcsd` +* ``mmcsd/`` :doc:`/os/drivers/special/sdio` :doc:`/os/drivers/special/mmcsd` Support for MMC/SD block drivers. MMC/SD block drivers based on SPI and SDIO/MCI interfaces are supported. -* ``modem/`` :doc:`character/modem` +* ``modem/`` :doc:`/os/drivers/character/modem` Modem Support. -* ``motor/`` :doc:`character/motor/index` +* ``motor/`` :doc:`/os/drivers/character/motor/index` Motor control drivers. -* ``mtd/`` :doc:`special/mtd/index` +* ``mtd/`` :doc:`/os/drivers/special/mtd/index` Memory Technology Device (MTD) drivers. Some simple drivers for memory technologies like FLASH, EEPROM, NVRAM, etc. @@ -174,52 +165,52 @@ Subdirectories of ``nuttx/drivers`` logic is unrelated; I just used the name MTD because I am not aware of any other common way to refer to this class of devices). -* ``net/`` :doc:`special/net/index` +* ``net/`` :doc:`/os/drivers/special/net/index` Network interface drivers. -* ``notes/`` :doc:`character/note` +* ``notes/`` :doc:`/os/drivers/character/note` Note Driver Support. -* ``pinctrl/`` :doc:`special/pinctrl` +* ``pinctrl/`` :doc:`/os/drivers/special/pinctrl` Configure and manage pin. -* ``pipes/`` :doc:`special/pipes` +* ``pipes/`` :doc:`/os/drivers/special/pipes` FIFO and named pipe drivers. Standard interfaces are declared in ``include/unistd.h`` -* ``power/`` :doc:`special/power/index` +* ``power/`` :doc:`/os/drivers/special/power/index` Various drivers related to power management. -* ``rc/`` :doc:`character/rc` +* ``rc/`` :doc:`/os/drivers/character/rc` Remote Control Device Support. -* ``regmap/`` :doc:`special/regmap` +* ``regmap/`` :doc:`/os/drivers/special/regmap` Regmap Subsystems Support. -* ``reset/`` :doc:`special/reset` +* ``reset/`` :doc:`/os/drivers/special/reset` Reset Driver Support. -* ``rf/`` :doc:`character/rf` +* ``rf/`` :doc:`/os/drivers/character/rf` RF Device Support. -* ``rptun/`` :doc:`special/rptun/index` +* ``rptun/`` :doc:`/os/drivers/special/rptun/index` Remote Proc Tunnel Driver Support. -* ``segger/`` :doc:`special/segger` +* ``segger/`` :doc:`/os/drivers/special/segger` Segger RTT drivers. -* ``sensors/`` :doc:`special/sensors` +* ``sensors/`` :doc:`/os/drivers/special/sensors` Drivers for various sensors. A sensor driver differs little from other types of drivers other than they are use to provide measurements @@ -230,53 +221,53 @@ Subdirectories of ``nuttx/drivers`` measure and convert voltage levels. DACs, however, are retained in the ``analog/`` sub-directory. -* ``serial/``:doc:`character/serial` +* ``serial/``:doc:`/os/drivers/character/serial` Front-end character drivers for chip-specific UARTs. This provide some TTY-like functionality and are commonly used (but not required for) the NuttX system console. -* ``spi/`` :doc:`special/spi` +* ``spi/`` :doc:`/os/drivers/special/spi` SPI drivers and support logic. -* ``syslog/`` :doc:`special/syslog` +* ``syslog/`` :doc:`/os/drivers/special/syslog` System logging devices. -* ``timers/`` :doc:`character/timers/index` +* ``timers/`` :doc:`/os/drivers/character/timers/index` Includes support for various timer devices. -* ``usbdev/`` :doc:`special/usbdev` +* ``usbdev/`` :doc:`/os/drivers/special/usbdev` USB device drivers. -* ``usbhost/`` :doc:`special/usbhost` +* ``usbhost/`` :doc:`/os/drivers/special/usbhost` USB host drivers. -* ``usbmisc/`` :doc:`special/usbmisc` +* ``usbmisc/`` :doc:`/os/drivers/special/usbmisc` USB Miscellaneous drivers. -* ``usbmonitor/`` :doc:`special/usbmonitor` +* ``usbmonitor/`` :doc:`/os/drivers/special/usbmonitor` USB Monitor support. -* ``usrsock/`` :doc:`special/usrsock` +* ``usrsock/`` :doc:`/os/drivers/special/usrsock` Usrsock Driver Support. -* ``video/`` :doc:`special/video` +* ``video/`` :doc:`/os/drivers/special/video` Video-related drivers. -* ``virtio/`` :doc:`special/virtio/index` +* ``virtio/`` :doc:`/os/drivers/special/virtio/index` Virtio Device Support. -* ``wireless/`` :doc:`special/wireless` +* ``wireless/`` :doc:`/os/drivers/special/wireless` Drivers for various wireless devices. @@ -303,3 +294,20 @@ system is fully operational. It is important to note that during this early initialization phase, system resources are not yet available for use. This includes memory allocation, file systems, and any other system resources. + +.. toctree:: + :maxdepth: 1 + + character/index.rst + block/index.rst + special/index.rst + thermal/index.rst + +.. toctree:: + :maxdepth: 1 + + drivers_design.rst + device_drivers.rst + device_nodes.rst + ioctl.rst + usb.rst diff --git a/Documentation/implementation/ioctl.rst b/Documentation/os/drivers/ioctl.rst similarity index 100% rename from Documentation/implementation/ioctl.rst rename to Documentation/os/drivers/ioctl.rst diff --git a/Documentation/components/drivers/special/audio.rst b/Documentation/os/drivers/special/audio.rst similarity index 100% rename from Documentation/components/drivers/special/audio.rst rename to Documentation/os/drivers/special/audio.rst diff --git a/Documentation/components/drivers/special/clk.rst b/Documentation/os/drivers/special/clk.rst similarity index 100% rename from Documentation/components/drivers/special/clk.rst rename to Documentation/os/drivers/special/clk.rst diff --git a/Documentation/components/drivers/special/devfreq.rst b/Documentation/os/drivers/special/devfreq.rst similarity index 100% rename from Documentation/components/drivers/special/devfreq.rst rename to Documentation/os/drivers/special/devfreq.rst diff --git a/Documentation/components/drivers/special/devicetree.rst b/Documentation/os/drivers/special/devicetree.rst similarity index 100% rename from Documentation/components/drivers/special/devicetree.rst rename to Documentation/os/drivers/special/devicetree.rst diff --git a/Documentation/components/drivers/special/devmem.rst b/Documentation/os/drivers/special/devmem.rst similarity index 100% rename from Documentation/components/drivers/special/devmem.rst rename to Documentation/os/drivers/special/devmem.rst diff --git a/Documentation/components/drivers/special/dma.rst b/Documentation/os/drivers/special/dma.rst similarity index 100% rename from Documentation/components/drivers/special/dma.rst rename to Documentation/os/drivers/special/dma.rst diff --git a/Documentation/components/drivers/special/framebuffer.rst b/Documentation/os/drivers/special/framebuffer.rst similarity index 100% rename from Documentation/components/drivers/special/framebuffer.rst rename to Documentation/os/drivers/special/framebuffer.rst diff --git a/Documentation/components/drivers/special/i2c.rst b/Documentation/os/drivers/special/i2c.rst similarity index 100% rename from Documentation/components/drivers/special/i2c.rst rename to Documentation/os/drivers/special/i2c.rst diff --git a/Documentation/components/drivers/special/i3c.rst b/Documentation/os/drivers/special/i3c.rst similarity index 100% rename from Documentation/components/drivers/special/i3c.rst rename to Documentation/os/drivers/special/i3c.rst diff --git a/Documentation/components/drivers/special/image/syslog-overview.png b/Documentation/os/drivers/special/image/syslog-overview.png similarity index 100% rename from Documentation/components/drivers/special/image/syslog-overview.png rename to Documentation/os/drivers/special/image/syslog-overview.png diff --git a/Documentation/components/drivers/special/index.rst b/Documentation/os/drivers/special/index.rst similarity index 98% rename from Documentation/components/drivers/special/index.rst rename to Documentation/os/drivers/special/index.rst index f3296845c8a..08313b2b3ad 100644 --- a/Documentation/components/drivers/special/index.rst +++ b/Documentation/os/drivers/special/index.rst @@ -43,6 +43,7 @@ following section. segger.rst spi.rst syslog.rst + syslog_design.rst sdio.rst usbdev.rst uvc.rst diff --git a/Documentation/components/drivers/special/ioexpander.rst b/Documentation/os/drivers/special/ioexpander.rst similarity index 100% rename from Documentation/components/drivers/special/ioexpander.rst rename to Documentation/os/drivers/special/ioexpander.rst diff --git a/Documentation/components/drivers/special/lcd.rst b/Documentation/os/drivers/special/lcd.rst similarity index 100% rename from Documentation/components/drivers/special/lcd.rst rename to Documentation/os/drivers/special/lcd.rst diff --git a/Documentation/components/drivers/special/mmcsd.rst b/Documentation/os/drivers/special/mmcsd.rst similarity index 100% rename from Documentation/components/drivers/special/mmcsd.rst rename to Documentation/os/drivers/special/mmcsd.rst diff --git a/Documentation/components/drivers/special/mtd/devices/at24xx.rst b/Documentation/os/drivers/special/mtd/devices/at24xx.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/at24xx.rst rename to Documentation/os/drivers/special/mtd/devices/at24xx.rst diff --git a/Documentation/components/drivers/special/mtd/devices/at25.rst b/Documentation/os/drivers/special/mtd/devices/at25.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/at25.rst rename to Documentation/os/drivers/special/mtd/devices/at25.rst diff --git a/Documentation/components/drivers/special/mtd/devices/at25ee.rst b/Documentation/os/drivers/special/mtd/devices/at25ee.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/at25ee.rst rename to Documentation/os/drivers/special/mtd/devices/at25ee.rst diff --git a/Documentation/components/drivers/special/mtd/devices/at45db.rst b/Documentation/os/drivers/special/mtd/devices/at45db.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/at45db.rst rename to Documentation/os/drivers/special/mtd/devices/at45db.rst diff --git a/Documentation/components/drivers/special/mtd/devices/gd25.rst b/Documentation/os/drivers/special/mtd/devices/gd25.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/gd25.rst rename to Documentation/os/drivers/special/mtd/devices/gd25.rst diff --git a/Documentation/components/drivers/special/mtd/devices/gd55.rst b/Documentation/os/drivers/special/mtd/devices/gd55.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/gd55.rst rename to Documentation/os/drivers/special/mtd/devices/gd55.rst diff --git a/Documentation/components/drivers/special/mtd/devices/gd5f.rst b/Documentation/os/drivers/special/mtd/devices/gd5f.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/gd5f.rst rename to Documentation/os/drivers/special/mtd/devices/gd5f.rst diff --git a/Documentation/components/drivers/special/mtd/devices/is25xp.rst b/Documentation/os/drivers/special/mtd/devices/is25xp.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/is25xp.rst rename to Documentation/os/drivers/special/mtd/devices/is25xp.rst diff --git a/Documentation/components/drivers/special/mtd/devices/m25px.rst b/Documentation/os/drivers/special/mtd/devices/m25px.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/m25px.rst rename to Documentation/os/drivers/special/mtd/devices/m25px.rst diff --git a/Documentation/components/drivers/special/mtd/devices/mx25l.rst b/Documentation/os/drivers/special/mtd/devices/mx25l.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/mx25l.rst rename to Documentation/os/drivers/special/mtd/devices/mx25l.rst diff --git a/Documentation/components/drivers/special/mtd/devices/mx25r.rst b/Documentation/os/drivers/special/mtd/devices/mx25r.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/mx25r.rst rename to Documentation/os/drivers/special/mtd/devices/mx25r.rst diff --git a/Documentation/components/drivers/special/mtd/devices/mx35.rst b/Documentation/os/drivers/special/mtd/devices/mx35.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/mx35.rst rename to Documentation/os/drivers/special/mtd/devices/mx35.rst diff --git a/Documentation/components/drivers/special/mtd/devices/n25q.rst b/Documentation/os/drivers/special/mtd/devices/n25q.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/n25q.rst rename to Documentation/os/drivers/special/mtd/devices/n25q.rst diff --git a/Documentation/components/drivers/special/mtd/devices/s25fl1.rst b/Documentation/os/drivers/special/mtd/devices/s25fl1.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/s25fl1.rst rename to Documentation/os/drivers/special/mtd/devices/s25fl1.rst diff --git a/Documentation/components/drivers/special/mtd/devices/sst25.rst b/Documentation/os/drivers/special/mtd/devices/sst25.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/sst25.rst rename to Documentation/os/drivers/special/mtd/devices/sst25.rst diff --git a/Documentation/components/drivers/special/mtd/devices/sst26.rst b/Documentation/os/drivers/special/mtd/devices/sst26.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/sst26.rst rename to Documentation/os/drivers/special/mtd/devices/sst26.rst diff --git a/Documentation/components/drivers/special/mtd/devices/sst39vf.rst b/Documentation/os/drivers/special/mtd/devices/sst39vf.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/sst39vf.rst rename to Documentation/os/drivers/special/mtd/devices/sst39vf.rst diff --git a/Documentation/components/drivers/special/mtd/devices/w25n.rst b/Documentation/os/drivers/special/mtd/devices/w25n.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/w25n.rst rename to Documentation/os/drivers/special/mtd/devices/w25n.rst diff --git a/Documentation/components/drivers/special/mtd/devices/w25q.rst b/Documentation/os/drivers/special/mtd/devices/w25q.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/devices/w25q.rst rename to Documentation/os/drivers/special/mtd/devices/w25q.rst diff --git a/Documentation/components/drivers/special/mtd/index.rst b/Documentation/os/drivers/special/mtd/index.rst similarity index 100% rename from Documentation/components/drivers/special/mtd/index.rst rename to Documentation/os/drivers/special/mtd/index.rst diff --git a/Documentation/components/drivers/special/mtd/mtd_open_flow.png b/Documentation/os/drivers/special/mtd/mtd_open_flow.png similarity index 100% rename from Documentation/components/drivers/special/mtd/mtd_open_flow.png rename to Documentation/os/drivers/special/mtd/mtd_open_flow.png diff --git a/Documentation/components/drivers/special/net/ethernet.rst b/Documentation/os/drivers/special/net/ethernet.rst similarity index 100% rename from Documentation/components/drivers/special/net/ethernet.rst rename to Documentation/os/drivers/special/net/ethernet.rst diff --git a/Documentation/components/drivers/special/net/index.rst b/Documentation/os/drivers/special/net/index.rst similarity index 100% rename from Documentation/components/drivers/special/net/index.rst rename to Documentation/os/drivers/special/net/index.rst diff --git a/Documentation/components/drivers/special/net/vlan.rst b/Documentation/os/drivers/special/net/vlan.rst similarity index 100% rename from Documentation/components/drivers/special/net/vlan.rst rename to Documentation/os/drivers/special/net/vlan.rst diff --git a/Documentation/components/drivers/special/pci/index.rst b/Documentation/os/drivers/special/pci/index.rst similarity index 100% rename from Documentation/components/drivers/special/pci/index.rst rename to Documentation/os/drivers/special/pci/index.rst diff --git a/Documentation/components/drivers/special/pinctrl.rst b/Documentation/os/drivers/special/pinctrl.rst similarity index 100% rename from Documentation/components/drivers/special/pinctrl.rst rename to Documentation/os/drivers/special/pinctrl.rst diff --git a/Documentation/components/drivers/special/pipes.rst b/Documentation/os/drivers/special/pipes.rst similarity index 100% rename from Documentation/components/drivers/special/pipes.rst rename to Documentation/os/drivers/special/pipes.rst diff --git a/Documentation/components/drivers/special/power/battery/fakegauge.rst b/Documentation/os/drivers/special/power/battery/fakegauge.rst similarity index 100% rename from Documentation/components/drivers/special/power/battery/fakegauge.rst rename to Documentation/os/drivers/special/power/battery/fakegauge.rst diff --git a/Documentation/components/drivers/special/power/index.rst b/Documentation/os/drivers/special/power/index.rst similarity index 75% rename from Documentation/components/drivers/special/power/index.rst rename to Documentation/os/drivers/special/power/index.rst index 7478dfa7302..c5eb7904972 100644 --- a/Documentation/components/drivers/special/power/index.rst +++ b/Documentation/os/drivers/special/power/index.rst @@ -8,3 +8,8 @@ Power-related Drivers pm/index.rst regulator.rst battery/fakegauge.rst + +.. toctree:: + :maxdepth: 1 + + power_management.rst diff --git a/Documentation/components/drivers/special/power/pm/index.rst b/Documentation/os/drivers/special/power/pm/index.rst similarity index 100% rename from Documentation/components/drivers/special/power/pm/index.rst rename to Documentation/os/drivers/special/power/pm/index.rst diff --git a/Documentation/components/drivers/special/power/pm/pm.png b/Documentation/os/drivers/special/power/pm/pm.png similarity index 100% rename from Documentation/components/drivers/special/power/pm/pm.png rename to Documentation/os/drivers/special/power/pm/pm.png diff --git a/Documentation/implementation/power_management.rst b/Documentation/os/drivers/special/power/power_management.rst similarity index 100% rename from Documentation/implementation/power_management.rst rename to Documentation/os/drivers/special/power/power_management.rst diff --git a/Documentation/components/drivers/special/power/regulator.rst b/Documentation/os/drivers/special/power/regulator.rst similarity index 100% rename from Documentation/components/drivers/special/power/regulator.rst rename to Documentation/os/drivers/special/power/regulator.rst diff --git a/Documentation/components/drivers/special/ptp.rst b/Documentation/os/drivers/special/ptp.rst similarity index 100% rename from Documentation/components/drivers/special/ptp.rst rename to Documentation/os/drivers/special/ptp.rst diff --git a/Documentation/components/drivers/special/regmap.rst b/Documentation/os/drivers/special/regmap.rst similarity index 100% rename from Documentation/components/drivers/special/regmap.rst rename to Documentation/os/drivers/special/regmap.rst diff --git a/Documentation/components/drivers/special/reset.rst b/Documentation/os/drivers/special/reset.rst similarity index 100% rename from Documentation/components/drivers/special/reset.rst rename to Documentation/os/drivers/special/reset.rst diff --git a/Documentation/components/drivers/special/rpmsg/concepts.rst b/Documentation/os/drivers/special/rpmsg/concepts.rst similarity index 100% rename from Documentation/components/drivers/special/rpmsg/concepts.rst rename to Documentation/os/drivers/special/rpmsg/concepts.rst diff --git a/Documentation/components/drivers/special/rpmsg/index.rst b/Documentation/os/drivers/special/rpmsg/index.rst similarity index 100% rename from Documentation/components/drivers/special/rpmsg/index.rst rename to Documentation/os/drivers/special/rpmsg/index.rst diff --git a/Documentation/components/drivers/special/rpmsg/rpmsg_dump.rst b/Documentation/os/drivers/special/rpmsg/rpmsg_dump.rst similarity index 100% rename from Documentation/components/drivers/special/rpmsg/rpmsg_dump.rst rename to Documentation/os/drivers/special/rpmsg/rpmsg_dump.rst diff --git a/Documentation/components/drivers/special/rpmsg/rpmsg_ping.rst b/Documentation/os/drivers/special/rpmsg/rpmsg_ping.rst similarity index 100% rename from Documentation/components/drivers/special/rpmsg/rpmsg_ping.rst rename to Documentation/os/drivers/special/rpmsg/rpmsg_ping.rst diff --git a/Documentation/components/drivers/special/rpmsg/rpmsg_port.rst b/Documentation/os/drivers/special/rpmsg/rpmsg_port.rst similarity index 100% rename from Documentation/components/drivers/special/rpmsg/rpmsg_port.rst rename to Documentation/os/drivers/special/rpmsg/rpmsg_port.rst diff --git a/Documentation/components/drivers/special/rpmsg/rpmsg_port_uart.rst b/Documentation/os/drivers/special/rpmsg/rpmsg_port_uart.rst similarity index 100% rename from Documentation/components/drivers/special/rpmsg/rpmsg_port_uart.rst rename to Documentation/os/drivers/special/rpmsg/rpmsg_port_uart.rst diff --git a/Documentation/components/drivers/special/rptun/api_reference.rst b/Documentation/os/drivers/special/rptun/api_reference.rst similarity index 100% rename from Documentation/components/drivers/special/rptun/api_reference.rst rename to Documentation/os/drivers/special/rptun/api_reference.rst diff --git a/Documentation/components/drivers/special/rptun/architecture.rst b/Documentation/os/drivers/special/rptun/architecture.rst similarity index 100% rename from Documentation/components/drivers/special/rptun/architecture.rst rename to Documentation/os/drivers/special/rptun/architecture.rst diff --git a/Documentation/components/drivers/special/rptun/driver_porting.rst b/Documentation/os/drivers/special/rptun/driver_porting.rst similarity index 100% rename from Documentation/components/drivers/special/rptun/driver_porting.rst rename to Documentation/os/drivers/special/rptun/driver_porting.rst diff --git a/Documentation/components/drivers/special/rptun/index.rst b/Documentation/os/drivers/special/rptun/index.rst similarity index 100% rename from Documentation/components/drivers/special/rptun/index.rst rename to Documentation/os/drivers/special/rptun/index.rst diff --git a/Documentation/components/drivers/special/rptun/resource_table.rst b/Documentation/os/drivers/special/rptun/resource_table.rst similarity index 100% rename from Documentation/components/drivers/special/rptun/resource_table.rst rename to Documentation/os/drivers/special/rptun/resource_table.rst diff --git a/Documentation/components/drivers/special/rwbuffer.rst b/Documentation/os/drivers/special/rwbuffer.rst similarity index 100% rename from Documentation/components/drivers/special/rwbuffer.rst rename to Documentation/os/drivers/special/rwbuffer.rst diff --git a/Documentation/components/drivers/special/sdio.rst b/Documentation/os/drivers/special/sdio.rst similarity index 100% rename from Documentation/components/drivers/special/sdio.rst rename to Documentation/os/drivers/special/sdio.rst diff --git a/Documentation/components/drivers/special/segger.rst b/Documentation/os/drivers/special/segger.rst similarity index 100% rename from Documentation/components/drivers/special/segger.rst rename to Documentation/os/drivers/special/segger.rst diff --git a/Documentation/components/drivers/special/sensors.rst b/Documentation/os/drivers/special/sensors.rst similarity index 100% rename from Documentation/components/drivers/special/sensors.rst rename to Documentation/os/drivers/special/sensors.rst diff --git a/Documentation/components/drivers/special/sensors/adt7320.rst b/Documentation/os/drivers/special/sensors/adt7320.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/adt7320.rst rename to Documentation/os/drivers/special/sensors/adt7320.rst diff --git a/Documentation/components/drivers/special/sensors/adxl345.rst b/Documentation/os/drivers/special/sensors/adxl345.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/adxl345.rst rename to Documentation/os/drivers/special/sensors/adxl345.rst diff --git a/Documentation/components/drivers/special/sensors/adxl362.rst b/Documentation/os/drivers/special/sensors/adxl362.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/adxl362.rst rename to Documentation/os/drivers/special/sensors/adxl362.rst diff --git a/Documentation/components/drivers/special/sensors/adxl367.rst b/Documentation/os/drivers/special/sensors/adxl367.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/adxl367.rst rename to Documentation/os/drivers/special/sensors/adxl367.rst diff --git a/Documentation/components/drivers/special/sensors/adxl372.rst b/Documentation/os/drivers/special/sensors/adxl372.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/adxl372.rst rename to Documentation/os/drivers/special/sensors/adxl372.rst diff --git a/Documentation/components/drivers/special/sensors/aht10.rst b/Documentation/os/drivers/special/sensors/aht10.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/aht10.rst rename to Documentation/os/drivers/special/sensors/aht10.rst diff --git a/Documentation/components/drivers/special/sensors/ak09912.rst b/Documentation/os/drivers/special/sensors/ak09912.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/ak09912.rst rename to Documentation/os/drivers/special/sensors/ak09912.rst diff --git a/Documentation/components/drivers/special/sensors/gnss_lowerhalf.rst b/Documentation/os/drivers/special/sensors/gnss_lowerhalf.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/gnss_lowerhalf.rst rename to Documentation/os/drivers/special/sensors/gnss_lowerhalf.rst index 3485bf39e66..20aaa1b5535 100644 --- a/Documentation/components/drivers/special/sensors/gnss_lowerhalf.rst +++ b/Documentation/os/drivers/special/sensors/gnss_lowerhalf.rst @@ -6,10 +6,10 @@ The GNSS lower half driver is used to create uORB drivers for GNSS/GPS devices. The upper-half driver abstracts away the parsing and advertising of NMEA data from the device. The way this lower-half is instantiated is similar to lower half drivers in the :doc:`uORB framework -`. +`. For an example on how to use this lower-half, see -`` +`` Application Programming Interface ================================= diff --git a/Documentation/components/drivers/special/sensors/l86xxx.rst b/Documentation/os/drivers/special/sensors/l86xxx.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/l86xxx.rst rename to Documentation/os/drivers/special/sensors/l86xxx.rst index 02849685a11..2ab071811c7 100644 --- a/Documentation/components/drivers/special/sensors/l86xxx.rst +++ b/Documentation/os/drivers/special/sensors/l86xxx.rst @@ -2,10 +2,8 @@ L86-XXX ======= -.. tags:: experimental - This driver provides support for the L86-XXX family of GNSS modules by -Quectel via the :doc:`uorb ` interface. +Quectel via the :doc:`uorb ` interface. Functionality for this driver was tested using the Quectel L86-M33. .. warning:: diff --git a/Documentation/components/drivers/special/sensors/lis2mdl.rst b/Documentation/os/drivers/special/sensors/lis2mdl.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/lis2mdl.rst rename to Documentation/os/drivers/special/sensors/lis2mdl.rst index 48a85c85110..465cb08d4b2 100644 --- a/Documentation/components/drivers/special/sensors/lis2mdl.rst +++ b/Documentation/os/drivers/special/sensors/lis2mdl.rst @@ -9,7 +9,7 @@ Microelectronics. It has I2C and SPI interfaces, although this driver currently only supports I2C. The driver uses the :doc:`uorb -` interface. It supports the +` interface. It supports the self-test capability Application Programming Interface diff --git a/Documentation/components/drivers/special/sensors/lsm330.rst b/Documentation/os/drivers/special/sensors/lsm330.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/lsm330.rst rename to Documentation/os/drivers/special/sensors/lsm330.rst diff --git a/Documentation/components/drivers/special/sensors/lsm6ds3trc.rst b/Documentation/os/drivers/special/sensors/lsm6ds3trc.rst similarity index 99% rename from Documentation/components/drivers/special/sensors/lsm6ds3trc.rst rename to Documentation/os/drivers/special/sensors/lsm6ds3trc.rst index ad0f0dba90a..832303cda25 100644 --- a/Documentation/components/drivers/special/sensors/lsm6ds3trc.rst +++ b/Documentation/os/drivers/special/sensors/lsm6ds3trc.rst @@ -8,7 +8,7 @@ LSM6DSL/LSM6DSO32 family. It has both I2C and SPI interfaces, although this driver only supports I2C. This driver uses the :doc:`uorb -` interface. +` interface. .. warning:: The LSM6DS3TR-C is a feature-packed sensor, and this driver does not diff --git a/Documentation/components/drivers/special/sensors/lsm6dso32.rst b/Documentation/os/drivers/special/sensors/lsm6dso32.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/lsm6dso32.rst rename to Documentation/os/drivers/special/sensors/lsm6dso32.rst index b2274f24bbd..e7aa5769e53 100644 --- a/Documentation/components/drivers/special/sensors/lsm6dso32.rst +++ b/Documentation/os/drivers/special/sensors/lsm6dso32.rst @@ -7,7 +7,7 @@ accelerometer by STMicroelectronics. It has both I2C and SPI interfaces, although this driver only supports I2C. This driver uses the :doc:`uorb -` interface. It supports the +` interface. It supports the self-test capability for both the accelerometer and gyroscope. .. warning:: diff --git a/Documentation/components/drivers/special/sensors/mcp9600.rst b/Documentation/os/drivers/special/sensors/mcp9600.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/mcp9600.rst rename to Documentation/os/drivers/special/sensors/mcp9600.rst index cabf9491891..7092fd710d5 100644 --- a/Documentation/components/drivers/special/sensors/mcp9600.rst +++ b/Documentation/os/drivers/special/sensors/mcp9600.rst @@ -18,7 +18,7 @@ The header file for the MCP9600 driver interface can be included using: #include The MCP9600 registration function allows the driver to be registered as a -:doc:`UORB ` sensor. +:doc:`UORB ` sensor. The MCP9600 measures three types of temperature: * Hot junction temperature diff --git a/Documentation/components/drivers/special/sensors/mpl115a.rst b/Documentation/os/drivers/special/sensors/mpl115a.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/mpl115a.rst rename to Documentation/os/drivers/special/sensors/mpl115a.rst diff --git a/Documentation/components/drivers/special/sensors/mpu6050.rst b/Documentation/os/drivers/special/sensors/mpu6050.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/mpu6050.rst rename to Documentation/os/drivers/special/sensors/mpu6050.rst index 4aa5ad8e037..f6056dc9d15 100644 --- a/Documentation/components/drivers/special/sensors/mpu6050.rst +++ b/Documentation/os/drivers/special/sensors/mpu6050.rst @@ -11,7 +11,7 @@ a 3-axis gyroscope and a 3-axis accelerometer on the same silicon die, communica over an I2C serial bus. The driver uses the :doc:`uorb -` interface. +` interface. Application Programming Interface ================================= diff --git a/Documentation/components/drivers/special/sensors/nau7802.rst b/Documentation/os/drivers/special/sensors/nau7802.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/nau7802.rst rename to Documentation/os/drivers/special/sensors/nau7802.rst index 610553c33c5..2ae26d6d42f 100644 --- a/Documentation/components/drivers/special/sensors/nau7802.rst +++ b/Documentation/os/drivers/special/sensors/nau7802.rst @@ -7,7 +7,7 @@ Contributed by Daniel Byshkin. The Adafruit NAU7802 is a high-resolution 24-bit ADC with an integrated load cell amplifier. It is designed for use with load cells and other sensors that require high precision and low noise measurements. The NAU7802 features a built-in programmable gain amplifier (PGA) that allows for easy calibration and adjustment of the sensor's output. The driver uses the :doc:`uorb -` interface. +` interface. Application Programming Interface ================================= diff --git a/Documentation/components/drivers/special/sensors/qmi8658.rst b/Documentation/os/drivers/special/sensors/qmi8658.rst similarity index 98% rename from Documentation/components/drivers/special/sensors/qmi8658.rst rename to Documentation/os/drivers/special/sensors/qmi8658.rst index c971e554e15..31df0640be4 100644 --- a/Documentation/components/drivers/special/sensors/qmi8658.rst +++ b/Documentation/os/drivers/special/sensors/qmi8658.rst @@ -9,7 +9,7 @@ accelerometer and 3-axis gyroscope. It supports both I2C and SPI interfaces, although this driver currently supports I2C communication only. This driver uses the :doc:`uorb -` interface. It supports the +` interface. It supports the self-test capability for both the accelerometer and gyroscope. The driver supports comprehensive features including multiple full-scale ranges, diff --git a/Documentation/components/drivers/special/sensors/sensor_driver_model.png b/Documentation/os/drivers/special/sensors/sensor_driver_model.png similarity index 100% rename from Documentation/components/drivers/special/sensors/sensor_driver_model.png rename to Documentation/os/drivers/special/sensors/sensor_driver_model.png diff --git a/Documentation/components/drivers/special/sensors/sensor_monitor.rst b/Documentation/os/drivers/special/sensors/sensor_monitor.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/sensor_monitor.rst rename to Documentation/os/drivers/special/sensors/sensor_monitor.rst diff --git a/Documentation/components/drivers/special/sensors/sensors_cluster.rst b/Documentation/os/drivers/special/sensors/sensors_cluster.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/sensors_cluster.rst rename to Documentation/os/drivers/special/sensors/sensors_cluster.rst diff --git a/Documentation/components/drivers/special/sensors/sensors_legacy.rst b/Documentation/os/drivers/special/sensors/sensors_legacy.rst similarity index 100% rename from Documentation/components/drivers/special/sensors/sensors_legacy.rst rename to Documentation/os/drivers/special/sensors/sensors_legacy.rst diff --git a/Documentation/components/drivers/special/sensors/sensors_uorb.rst b/Documentation/os/drivers/special/sensors/sensors_uorb.rst similarity index 99% rename from Documentation/components/drivers/special/sensors/sensors_uorb.rst rename to Documentation/os/drivers/special/sensors/sensors_uorb.rst index e2dc8a40639..b8f6e8d0ce6 100644 --- a/Documentation/components/drivers/special/sensors/sensors_uorb.rst +++ b/Documentation/os/drivers/special/sensors/sensors_uorb.rst @@ -20,7 +20,7 @@ within the driver, and device nodes are registered separately through the API .. note:: When writing a uORB driver for GNSS/GPS devices, please use the :doc:`GNSS - lower-half driver `. This + lower-half driver `. This driver abstracts parsing and advertising of NMEA information. Naming diff --git a/Documentation/components/drivers/special/sensors/sht4x.rst b/Documentation/os/drivers/special/sensors/sht4x.rst similarity index 97% rename from Documentation/components/drivers/special/sensors/sht4x.rst rename to Documentation/os/drivers/special/sensors/sht4x.rst index a2d99ad7937..54d30eb3597 100644 --- a/Documentation/components/drivers/special/sensors/sht4x.rst +++ b/Documentation/os/drivers/special/sensors/sht4x.rst @@ -9,7 +9,7 @@ which operates over I2C. They include a small heating element. The driver provided allows interfacing with the sensor over I2C. It has been tested against the SHT41. This driver uses the :doc:`uorb -` interface. +` interface. Application Programming Interface ================================= diff --git a/Documentation/components/drivers/special/sensors/tc74.rst b/Documentation/os/drivers/special/sensors/tc74.rst similarity index 94% rename from Documentation/components/drivers/special/sensors/tc74.rst rename to Documentation/os/drivers/special/sensors/tc74.rst index 3888a80d82b..9bffa3ee8da 100644 --- a/Documentation/components/drivers/special/sensors/tc74.rst +++ b/Documentation/os/drivers/special/sensors/tc74.rst @@ -8,7 +8,7 @@ I2C addresses range from 0x48 through 0x4f (suffixes A0 through A7), allowing up to eight parts on the same bus. This driver uses the :doc:`uorb -` interface, so the reading +` interface, so the reading appears as a topic the common sensor tools can read. Application Programming Interface diff --git a/Documentation/components/drivers/special/sensors/tmp112.rst b/Documentation/os/drivers/special/sensors/tmp112.rst similarity index 96% rename from Documentation/components/drivers/special/sensors/tmp112.rst rename to Documentation/os/drivers/special/sensors/tmp112.rst index a1315867848..3deb930a83a 100644 --- a/Documentation/components/drivers/special/sensors/tmp112.rst +++ b/Documentation/os/drivers/special/sensors/tmp112.rst @@ -8,7 +8,7 @@ pins select one of four bus addresses, 0x48 through 0x4b, so four parts can share a bus. Two drivers exist for this part. This one uses the :doc:`uorb -` interface, so the reading +` interface, so the reading appears as a topic the common sensor tools can read. The older driver presents a character device instead. Only one of the two is built: ``CONFIG_SENSORS_TMP112_UORB`` selects this one, and the board must then call diff --git a/Documentation/components/drivers/special/spi.rst b/Documentation/os/drivers/special/spi.rst similarity index 100% rename from Documentation/components/drivers/special/spi.rst rename to Documentation/os/drivers/special/spi.rst diff --git a/Documentation/components/drivers/special/syslog.rst b/Documentation/os/drivers/special/syslog.rst similarity index 99% rename from Documentation/components/drivers/special/syslog.rst rename to Documentation/os/drivers/special/syslog.rst index f7b058c19f4..0532c9f2351 100644 --- a/Documentation/components/drivers/special/syslog.rst +++ b/Documentation/os/drivers/special/syslog.rst @@ -5,7 +5,7 @@ SYSLOG Overview ======== -.. image:: image/syslog-overview.png +.. image:: /os/drivers/special/image/syslog-overview.png SYSLOG Interfaces ================= diff --git a/Documentation/implementation/syslog.rst b/Documentation/os/drivers/special/syslog_design.rst similarity index 99% rename from Documentation/implementation/syslog.rst rename to Documentation/os/drivers/special/syslog_design.rst index ae4b681d9c5..51ab3351253 100644 --- a/Documentation/implementation/syslog.rst +++ b/Documentation/os/drivers/special/syslog_design.rst @@ -37,7 +37,6 @@ to a lesser extent, its companion ``vsyslog()``: int syslog(int priority, FAR const IPTR char *format, ...); int vsyslog(int priority, FAR const IPTR char *src, va_list ap); - The additional ``setlogmask()`` interface can use use to filter SYSLOG output: @@ -75,10 +74,8 @@ SYSLOG output: int setlogmask(int mask); - These are all standard interfaces as defined at https://www.OpenGroup.org. - Debug Interfaces ================ @@ -124,7 +121,6 @@ are summarized below: It also differs from the other macros in that it is global and cannot be enabled or disabled per subsystem. - SYSLOG Channels =============== @@ -236,7 +232,6 @@ calls ``syslog_intialize()``: # define syslog_initialize(phase) #endif - Different types of SYSLOG devices have different OS initialization requirements. Some are available immediately at reset, some are available after some basic OS initialization, and some only after OS is fully @@ -325,7 +320,6 @@ level SYSLOG output. In this case: be inserted into the correct position in the SYSLOG output when the next normal SYLOG output is generated. - SYSLOG Channel Options ====================== @@ -383,7 +377,6 @@ Interrupt level SYSLOG output will be lost unless: References: ``drivers/syslog/syslog_consolechannel.c`` and ``drivers/syslog/syslog_device.c``. - SYSLOG Character Device ----------------------- @@ -469,7 +462,6 @@ the SYSLOG file channel: int syslog_file_channel(FAR const char *devpath); #endif - References: ``drivers/syslog/syslog_filechannel.c``, ``drivers/syslog/syslog_device.c``, and ``include/nuttx/syslog/syslog.h``. @@ -548,7 +540,6 @@ Other miscellaneous settings: * ``CONFIG_RAMLOG_NPOLLWAITERS`` - The maximum number of threads that may be waiting on the poll method. - SYSLOG (Input) Character Device =============================== @@ -575,7 +566,6 @@ that character device: void syslog_register(void); - .. note:: Careful... there is overloaded naming here! A character device can serve as the SYSLOG output channel as described above. @@ -591,7 +581,6 @@ That is a data path like:: Very confusing and begs for some re-naming. - Using SYSLOG for Debug ====================== diff --git a/Documentation/components/drivers/special/sysview.png b/Documentation/os/drivers/special/sysview.png similarity index 100% rename from Documentation/components/drivers/special/sysview.png rename to Documentation/os/drivers/special/sysview.png diff --git a/Documentation/components/drivers/special/usbdev.rst b/Documentation/os/drivers/special/usbdev.rst similarity index 100% rename from Documentation/components/drivers/special/usbdev.rst rename to Documentation/os/drivers/special/usbdev.rst diff --git a/Documentation/components/drivers/special/usbhost.rst b/Documentation/os/drivers/special/usbhost.rst similarity index 100% rename from Documentation/components/drivers/special/usbhost.rst rename to Documentation/os/drivers/special/usbhost.rst diff --git a/Documentation/components/drivers/special/usbmisc.rst b/Documentation/os/drivers/special/usbmisc.rst similarity index 100% rename from Documentation/components/drivers/special/usbmisc.rst rename to Documentation/os/drivers/special/usbmisc.rst diff --git a/Documentation/components/drivers/special/usbmonitor.rst b/Documentation/os/drivers/special/usbmonitor.rst similarity index 100% rename from Documentation/components/drivers/special/usbmonitor.rst rename to Documentation/os/drivers/special/usbmonitor.rst diff --git a/Documentation/components/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng b/Documentation/os/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng similarity index 100% rename from Documentation/components/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng rename to Documentation/os/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng diff --git a/Documentation/components/drivers/special/usbmonitor_wireshark_linux_example_adb.png b/Documentation/os/drivers/special/usbmonitor_wireshark_linux_example_adb.png similarity index 100% rename from Documentation/components/drivers/special/usbmonitor_wireshark_linux_example_adb.png rename to Documentation/os/drivers/special/usbmonitor_wireshark_linux_example_adb.png diff --git a/Documentation/components/drivers/special/usrsock.rst b/Documentation/os/drivers/special/usrsock.rst similarity index 100% rename from Documentation/components/drivers/special/usrsock.rst rename to Documentation/os/drivers/special/usrsock.rst diff --git a/Documentation/components/drivers/special/uvc.rst b/Documentation/os/drivers/special/uvc.rst similarity index 100% rename from Documentation/components/drivers/special/uvc.rst rename to Documentation/os/drivers/special/uvc.rst diff --git a/Documentation/components/drivers/special/vhost/framework.rst b/Documentation/os/drivers/special/vhost/framework.rst similarity index 100% rename from Documentation/components/drivers/special/vhost/framework.rst rename to Documentation/os/drivers/special/vhost/framework.rst diff --git a/Documentation/components/drivers/special/vhost/index.rst b/Documentation/os/drivers/special/vhost/index.rst similarity index 100% rename from Documentation/components/drivers/special/vhost/index.rst rename to Documentation/os/drivers/special/vhost/index.rst diff --git a/Documentation/components/drivers/special/video.rst b/Documentation/os/drivers/special/video.rst similarity index 100% rename from Documentation/components/drivers/special/video.rst rename to Documentation/os/drivers/special/video.rst diff --git a/Documentation/components/drivers/special/virtio/framework.rst b/Documentation/os/drivers/special/virtio/framework.rst similarity index 100% rename from Documentation/components/drivers/special/virtio/framework.rst rename to Documentation/os/drivers/special/virtio/framework.rst diff --git a/Documentation/components/drivers/special/virtio/index.rst b/Documentation/os/drivers/special/virtio/index.rst similarity index 100% rename from Documentation/components/drivers/special/virtio/index.rst rename to Documentation/os/drivers/special/virtio/index.rst diff --git a/Documentation/components/drivers/special/wireless.rst b/Documentation/os/drivers/special/wireless.rst similarity index 100% rename from Documentation/components/drivers/special/wireless.rst rename to Documentation/os/drivers/special/wireless.rst diff --git a/Documentation/components/drivers/special/wireless/rn2xx3.rst b/Documentation/os/drivers/special/wireless/rn2xx3.rst similarity index 100% rename from Documentation/components/drivers/special/wireless/rn2xx3.rst rename to Documentation/os/drivers/special/wireless/rn2xx3.rst diff --git a/Documentation/components/drivers/thermal/index.rst b/Documentation/os/drivers/thermal/index.rst similarity index 100% rename from Documentation/components/drivers/thermal/index.rst rename to Documentation/os/drivers/thermal/index.rst diff --git a/Documentation/implementation/usb.rst b/Documentation/os/drivers/usb.rst similarity index 100% rename from Documentation/implementation/usb.rst rename to Documentation/os/drivers/usb.rst diff --git a/Documentation/components/filesystem/aio.rst b/Documentation/os/filesystem/aio.rst similarity index 100% rename from Documentation/components/filesystem/aio.rst rename to Documentation/os/filesystem/aio.rst diff --git a/Documentation/components/filesystem/binfs.rst b/Documentation/os/filesystem/binfs.rst similarity index 100% rename from Documentation/components/filesystem/binfs.rst rename to Documentation/os/filesystem/binfs.rst diff --git a/Documentation/implementation/chroot.rst b/Documentation/os/filesystem/chroot.rst similarity index 100% rename from Documentation/implementation/chroot.rst rename to Documentation/os/filesystem/chroot.rst diff --git a/Documentation/components/filesystem/cromfs.rst b/Documentation/os/filesystem/cromfs.rst similarity index 100% rename from Documentation/components/filesystem/cromfs.rst rename to Documentation/os/filesystem/cromfs.rst diff --git a/Documentation/components/filesystem/fat.rst b/Documentation/os/filesystem/fat.rst similarity index 100% rename from Documentation/components/filesystem/fat.rst rename to Documentation/os/filesystem/fat.rst diff --git a/Documentation/implementation/file_descriptors.rst b/Documentation/os/filesystem/file_descriptors.rst similarity index 100% rename from Documentation/implementation/file_descriptors.rst rename to Documentation/os/filesystem/file_descriptors.rst diff --git a/Documentation/implementation/file_permission.rst b/Documentation/os/filesystem/file_permission.rst similarity index 97% rename from Documentation/implementation/file_permission.rst rename to Documentation/os/filesystem/file_permission.rst index 6b6f50c5118..d066a387527 100644 --- a/Documentation/implementation/file_permission.rst +++ b/Documentation/os/filesystem/file_permission.rst @@ -133,5 +133,5 @@ References * ``include/nuttx/fs/fs.h`` — ``struct mountpt_operations`` * ``fs/tmpfs/fs_tmpfs.c`` — ``tmpfs_permission`` * :ref:`user-identity` — credential model -* :doc:`/components/filesystem/littlefs` — littlefs in-volume DAC -* :doc:`/components/filesystem/tmpfs` — tmpfs overview +* :doc:`/os/filesystem/littlefs` — littlefs in-volume DAC +* :doc:`/os/filesystem/tmpfs` — tmpfs overview diff --git a/Documentation/components/filesystem/hostfs.rst b/Documentation/os/filesystem/hostfs.rst similarity index 100% rename from Documentation/components/filesystem/hostfs.rst rename to Documentation/os/filesystem/hostfs.rst diff --git a/Documentation/components/filesystem/how_nxffs_works.rst b/Documentation/os/filesystem/how_nxffs_works.rst similarity index 100% rename from Documentation/components/filesystem/how_nxffs_works.rst rename to Documentation/os/filesystem/how_nxffs_works.rst diff --git a/Documentation/components/filesystem/index.rst b/Documentation/os/filesystem/index.rst similarity index 99% rename from Documentation/components/filesystem/index.rst rename to Documentation/os/filesystem/index.rst index bb3fe88d99f..6d26a45ad98 100644 --- a/Documentation/components/filesystem/index.rst +++ b/Documentation/os/filesystem/index.rst @@ -239,7 +239,6 @@ belonging to a unified interface: :retval OK (0): Success. :retval < 0: Error. - .. c:function:: int poll(FAR struct file *filep, FAR struct pollfd *fds, bool setup) Underlying implementation of ``poll()``. The ``poll()`` function provides @@ -422,7 +421,6 @@ belonging to a unified interface: :retval OK (0): Success. :retval < 0: Error. - * **Path operations** .. c:function:: int unlink(FAR struct inode *mountpt, FAR const char *relpath) @@ -541,7 +539,6 @@ belonging to a unified interface: :retval -ENOTTY: The file system does not recognize the command. :retval < 0: Error. - The file systems can have their own implementations for these functions under-the-hood, but the user does not have to worry about the underlying file system during file I/O, as the file system has to expose its implementations @@ -557,17 +554,32 @@ in a unified interface. to be listed in ``include/sys`` and in ``fs_gettype`` function (in ``fs/mount/fs_gettype.c``) for identification of the filesystem. - File systems ============ NuttX provides support for a variety of file systems out of the box. +FS Categories +------------- + +File systems can be divided into these categories on the basis of the drivers +they require: + +1. They require a block device driver. They include vfat, romfs, smartfs, and + littlefs. +2. They require MTD drivers. They include romfs, spiffs, littlefs, xipfs. +3. They require neither block nor MTD drivers. They include nxffs, tmpfs, nfs + binfs, procfs, userfs, hostfs, cromfs, unionfs, rpmsgfs, and zipfs. + +The requirements are specified by declaring the filesystem in the proper +array in ``fs/mount/fs_mount.c``. + .. toctree:: :maxdepth: 1 aio.rst binfs.rst + chroot.rst cromfs.rst fat.rst hostfs.rst @@ -596,17 +608,8 @@ NuttX provides support for a variety of file systems out of the box. special_files_dev_num.rst v9fs.rst -FS Categories -------------- +.. toctree:: + :maxdepth: 1 -File systems can be divided into these categories on the basis of the drivers -they require: - -1. They require a block device driver. They include vfat, romfs, smartfs, and - littlefs. -2. They require MTD drivers. They include romfs, spiffs, littlefs, xipfs. -3. They require neither block nor MTD drivers. They include nxffs, tmpfs, nfs - binfs, procfs, userfs, hostfs, cromfs, unionfs, rpmsgfs, and zipfs. - -The requirements are specified by declaring the filesystem in the proper -array in ``fs/mount/fs_mount.c``. + file_descriptors.rst + file_permission.rst diff --git a/Documentation/components/filesystem/inotify.rst b/Documentation/os/filesystem/inotify.rst similarity index 100% rename from Documentation/components/filesystem/inotify.rst rename to Documentation/os/filesystem/inotify.rst diff --git a/Documentation/components/filesystem/littlefs.rst b/Documentation/os/filesystem/littlefs.rst similarity index 100% rename from Documentation/components/filesystem/littlefs.rst rename to Documentation/os/filesystem/littlefs.rst diff --git a/Documentation/components/filesystem/mmap.rst b/Documentation/os/filesystem/mmap.rst similarity index 100% rename from Documentation/components/filesystem/mmap.rst rename to Documentation/os/filesystem/mmap.rst diff --git a/Documentation/components/filesystem/mnemofs.rst b/Documentation/os/filesystem/mnemofs.rst similarity index 100% rename from Documentation/components/filesystem/mnemofs.rst rename to Documentation/os/filesystem/mnemofs.rst diff --git a/Documentation/components/filesystem/nfs.rst b/Documentation/os/filesystem/nfs.rst similarity index 100% rename from Documentation/components/filesystem/nfs.rst rename to Documentation/os/filesystem/nfs.rst diff --git a/Documentation/components/filesystem/nuttxfs.rst b/Documentation/os/filesystem/nuttxfs.rst similarity index 100% rename from Documentation/components/filesystem/nuttxfs.rst rename to Documentation/os/filesystem/nuttxfs.rst diff --git a/Documentation/components/filesystem/nuttxfs/nuttxfs_page_0.png b/Documentation/os/filesystem/nuttxfs/nuttxfs_page_0.png similarity index 100% rename from Documentation/components/filesystem/nuttxfs/nuttxfs_page_0.png rename to Documentation/os/filesystem/nuttxfs/nuttxfs_page_0.png diff --git a/Documentation/components/filesystem/nuttxfs/nuttxfs_page_1.png b/Documentation/os/filesystem/nuttxfs/nuttxfs_page_1.png similarity index 100% rename from Documentation/components/filesystem/nuttxfs/nuttxfs_page_1.png rename to Documentation/os/filesystem/nuttxfs/nuttxfs_page_1.png diff --git a/Documentation/components/filesystem/nuttxfs/nuttxfs_page_2.png b/Documentation/os/filesystem/nuttxfs/nuttxfs_page_2.png similarity index 100% rename from Documentation/components/filesystem/nuttxfs/nuttxfs_page_2.png rename to Documentation/os/filesystem/nuttxfs/nuttxfs_page_2.png diff --git a/Documentation/components/filesystem/nuttxfs/nuttxfs_page_3.png b/Documentation/os/filesystem/nuttxfs/nuttxfs_page_3.png similarity index 100% rename from Documentation/components/filesystem/nuttxfs/nuttxfs_page_3.png rename to Documentation/os/filesystem/nuttxfs/nuttxfs_page_3.png diff --git a/Documentation/components/filesystem/nxffs.rst b/Documentation/os/filesystem/nxffs.rst similarity index 100% rename from Documentation/components/filesystem/nxffs.rst rename to Documentation/os/filesystem/nxffs.rst diff --git a/Documentation/components/filesystem/nxffs/nxffs_page_0.png b/Documentation/os/filesystem/nxffs/nxffs_page_0.png similarity index 100% rename from Documentation/components/filesystem/nxffs/nxffs_page_0.png rename to Documentation/os/filesystem/nxffs/nxffs_page_0.png diff --git a/Documentation/components/filesystem/nxffs/nxffs_page_1.png b/Documentation/os/filesystem/nxffs/nxffs_page_1.png similarity index 100% rename from Documentation/components/filesystem/nxffs/nxffs_page_1.png rename to Documentation/os/filesystem/nxffs/nxffs_page_1.png diff --git a/Documentation/components/filesystem/nxffs/nxffs_page_2.png b/Documentation/os/filesystem/nxffs/nxffs_page_2.png similarity index 100% rename from Documentation/components/filesystem/nxffs/nxffs_page_2.png rename to Documentation/os/filesystem/nxffs/nxffs_page_2.png diff --git a/Documentation/components/filesystem/nxflat.rst b/Documentation/os/filesystem/nxflat.rst similarity index 98% rename from Documentation/components/filesystem/nxflat.rst rename to Documentation/os/filesystem/nxflat.rst index 094b9310793..91920cf582a 100644 --- a/Documentation/components/filesystem/nxflat.rst +++ b/Documentation/os/filesystem/nxflat.rst @@ -9,7 +9,7 @@ NuttX FLAT Binary Format (NXFLAT) Overview ======== -NuttX supports a configurable :doc:`binary loader <../binfmt>` . +NuttX supports a configurable :doc:`binary loader ` . This binary loader supports loading and executing binary objects from the file system. The NuttX binary loader is capable of supporting multiple binary formats. @@ -174,7 +174,7 @@ See this `thread `_ for additional information References ---------- -* :doc:`NXFLAT <../nxflat>` +* :doc:`NXFLAT ` * `XFLATFLAT `_ * `FLAT `_ * `ROMFS `_ \ No newline at end of file diff --git a/Documentation/components/filesystem/nxflat/nxflat-addressing.png b/Documentation/os/filesystem/nxflat/nxflat-addressing.png similarity index 100% rename from Documentation/components/filesystem/nxflat/nxflat-addressing.png rename to Documentation/os/filesystem/nxflat/nxflat-addressing.png diff --git a/Documentation/components/filesystem/partition.rst b/Documentation/os/filesystem/partition.rst similarity index 100% rename from Documentation/components/filesystem/partition.rst rename to Documentation/os/filesystem/partition.rst diff --git a/Documentation/components/filesystem/procfs.rst b/Documentation/os/filesystem/procfs.rst similarity index 100% rename from Documentation/components/filesystem/procfs.rst rename to Documentation/os/filesystem/procfs.rst diff --git a/Documentation/components/filesystem/profiler.rst b/Documentation/os/filesystem/profiler.rst similarity index 100% rename from Documentation/components/filesystem/profiler.rst rename to Documentation/os/filesystem/profiler.rst diff --git a/Documentation/components/filesystem/pseudofs.rst b/Documentation/os/filesystem/pseudofs.rst similarity index 100% rename from Documentation/components/filesystem/pseudofs.rst rename to Documentation/os/filesystem/pseudofs.rst diff --git a/Documentation/components/filesystem/romfs.rst b/Documentation/os/filesystem/romfs.rst similarity index 100% rename from Documentation/components/filesystem/romfs.rst rename to Documentation/os/filesystem/romfs.rst diff --git a/Documentation/components/filesystem/rpmsgfs.rst b/Documentation/os/filesystem/rpmsgfs.rst similarity index 100% rename from Documentation/components/filesystem/rpmsgfs.rst rename to Documentation/os/filesystem/rpmsgfs.rst diff --git a/Documentation/components/filesystem/shmfs.rst b/Documentation/os/filesystem/shmfs.rst similarity index 100% rename from Documentation/components/filesystem/shmfs.rst rename to Documentation/os/filesystem/shmfs.rst diff --git a/Documentation/components/filesystem/smartfs.rst b/Documentation/os/filesystem/smartfs.rst similarity index 100% rename from Documentation/components/filesystem/smartfs.rst rename to Documentation/os/filesystem/smartfs.rst diff --git a/Documentation/components/filesystem/special_files_dev_num.rst b/Documentation/os/filesystem/special_files_dev_num.rst similarity index 100% rename from Documentation/components/filesystem/special_files_dev_num.rst rename to Documentation/os/filesystem/special_files_dev_num.rst diff --git a/Documentation/components/filesystem/spiffs.rst b/Documentation/os/filesystem/spiffs.rst similarity index 100% rename from Documentation/components/filesystem/spiffs.rst rename to Documentation/os/filesystem/spiffs.rst diff --git a/Documentation/components/filesystem/tmpfs.rst b/Documentation/os/filesystem/tmpfs.rst similarity index 100% rename from Documentation/components/filesystem/tmpfs.rst rename to Documentation/os/filesystem/tmpfs.rst diff --git a/Documentation/components/filesystem/unionfs.rst b/Documentation/os/filesystem/unionfs.rst similarity index 100% rename from Documentation/components/filesystem/unionfs.rst rename to Documentation/os/filesystem/unionfs.rst diff --git a/Documentation/components/filesystem/userfs.rst b/Documentation/os/filesystem/userfs.rst similarity index 100% rename from Documentation/components/filesystem/userfs.rst rename to Documentation/os/filesystem/userfs.rst diff --git a/Documentation/components/filesystem/v9fs.rst b/Documentation/os/filesystem/v9fs.rst similarity index 100% rename from Documentation/components/filesystem/v9fs.rst rename to Documentation/os/filesystem/v9fs.rst diff --git a/Documentation/components/filesystem/xipfs.rst b/Documentation/os/filesystem/xipfs.rst similarity index 100% rename from Documentation/components/filesystem/xipfs.rst rename to Documentation/os/filesystem/xipfs.rst diff --git a/Documentation/components/filesystem/zipfs.rst b/Documentation/os/filesystem/zipfs.rst similarity index 100% rename from Documentation/components/filesystem/zipfs.rst rename to Documentation/os/filesystem/zipfs.rst diff --git a/Documentation/components/nxgraphics/GraphicsInterfaces.png b/Documentation/os/graphics/GraphicsInterfaces.png similarity index 100% rename from Documentation/components/nxgraphics/GraphicsInterfaces.png rename to Documentation/os/graphics/GraphicsInterfaces.png diff --git a/Documentation/components/nxgraphics/NXOrganization.png b/Documentation/os/graphics/NXOrganization.png similarity index 100% rename from Documentation/components/nxgraphics/NXOrganization.png rename to Documentation/os/graphics/NXOrganization.png diff --git a/Documentation/components/nxgraphics/NuttXScreenShot.jpg b/Documentation/os/graphics/NuttXScreenShot.jpg similarity index 100% rename from Documentation/components/nxgraphics/NuttXScreenShot.jpg rename to Documentation/os/graphics/NuttXScreenShot.jpg diff --git a/Documentation/components/nxgraphics/appendix.rst b/Documentation/os/graphics/appendix.rst similarity index 100% rename from Documentation/components/nxgraphics/appendix.rst rename to Documentation/os/graphics/appendix.rst diff --git a/Documentation/components/nxgraphics/framebuffer_char_driver.rst b/Documentation/os/graphics/framebuffer_char_driver.rst similarity index 99% rename from Documentation/components/nxgraphics/framebuffer_char_driver.rst rename to Documentation/os/graphics/framebuffer_char_driver.rst index 840c6314f24..5fb77fdba8c 100644 --- a/Documentation/components/nxgraphics/framebuffer_char_driver.rst +++ b/Documentation/os/graphics/framebuffer_char_driver.rst @@ -11,7 +11,7 @@ NX Graphics =========== NuttX has supported higher level graphics for some time with -the OS's :doc:`/components/nxgraphics/index` and application +the OS's :doc:`/os/graphics/index` and application oriented :doc:`NxWidgets ` and the tiny window manager :doc:`NxWM `. These are higher level in the sense that the primary diff --git a/Documentation/components/nxgraphics/index.rst b/Documentation/os/graphics/index.rst similarity index 100% rename from Documentation/components/nxgraphics/index.rst rename to Documentation/os/graphics/index.rst diff --git a/Documentation/components/nxgraphics/nx.rst b/Documentation/os/graphics/nx.rst similarity index 100% rename from Documentation/components/nxgraphics/nx.rst rename to Documentation/os/graphics/nx.rst diff --git a/Documentation/components/nxgraphics/nxcursor.rst b/Documentation/os/graphics/nxcursor.rst similarity index 100% rename from Documentation/components/nxgraphics/nxcursor.rst rename to Documentation/os/graphics/nxcursor.rst diff --git a/Documentation/components/nxgraphics/nxfonts.rst b/Documentation/os/graphics/nxfonts.rst similarity index 100% rename from Documentation/components/nxgraphics/nxfonts.rst rename to Documentation/os/graphics/nxfonts.rst diff --git a/Documentation/components/nxgraphics/nxgl.rst b/Documentation/os/graphics/nxgl.rst similarity index 100% rename from Documentation/components/nxgraphics/nxgl.rst rename to Documentation/os/graphics/nxgl.rst diff --git a/Documentation/components/nxgraphics/nxtk.rst b/Documentation/os/graphics/nxtk.rst similarity index 100% rename from Documentation/components/nxgraphics/nxtk.rst rename to Documentation/os/graphics/nxtk.rst diff --git a/Documentation/components/nxgraphics/nxwm_threading.rst b/Documentation/os/graphics/nxwm_threading.rst similarity index 100% rename from Documentation/components/nxgraphics/nxwm_threading.rst rename to Documentation/os/graphics/nxwm_threading.rst diff --git a/Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_0.png b/Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_0.png similarity index 100% rename from Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_0.png rename to Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_0.png diff --git a/Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_1.png b/Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_1.png similarity index 100% rename from Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_1.png rename to Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_1.png diff --git a/Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_2.png b/Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_2.png similarity index 100% rename from Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_2.png rename to Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_2.png diff --git a/Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_3.png b/Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_3.png similarity index 100% rename from Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_3.png rename to Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_3.png diff --git a/Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_4.png b/Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_4.png similarity index 100% rename from Documentation/components/nxgraphics/nxwm_threading_model/nxwm_theading_model_page_4.png rename to Documentation/os/graphics/nxwm_threading_model/nxwm_theading_model_page_4.png diff --git a/Documentation/components/nxgraphics/sample.rst b/Documentation/os/graphics/sample.rst similarity index 100% rename from Documentation/components/nxgraphics/sample.rst rename to Documentation/os/graphics/sample.rst diff --git a/Documentation/os/index.rst b/Documentation/os/index.rst new file mode 100644 index 00000000000..2a8a39cde21 --- /dev/null +++ b/Documentation/os/index.rst @@ -0,0 +1,136 @@ +========= +OS Design +========= + +How NuttX is put together, subsystem by subsystem. The sections follow the source +tree: what lives under ``sched/`` is described in :doc:`scheduling/index`, +what lives under ``fs/`` in :doc:`filesystem/index`, under ``drivers/`` in +:doc:`drivers/index`, and so on. Each subsystem is described once, going +from what it is, to how it works, to the interfaces it offers. + +For the POSIX interface an application sees, go to +:doc:`/reference/user/index` instead. That is a different question -- what +you may call -- and it has its own section. + +.. figure:: system_map.svg + :align: center + :width: 100% + :alt: The layers of NuttX, from applications down through the C library + and the system call boundary to the kernel subsystems, the device + drivers, and the architecture, chip and board code. + + Where each section of this documentation sits in the system, and which + directory of the source tree it describes. + +Build modes +=========== + +Before reading any subsystem page it is worth knowing which **build mode** +you are in, because it decides whether there is a boundary between your +application and the kernel at all. The Kconfig choice that selects it is +called *Memory organization*, under *Build Configuration*. + +.. figure:: build_modes.svg + :align: center + :width: 100% + :alt: The same call to write() under the three build modes: a function + call in a flat build, a system call across an MPU boundary in a + protected build, and a system call into a separate address space in + a kernel build. + + The same ``write()`` under ``CONFIG_BUILD_FLAT``, + ``CONFIG_BUILD_PROTECTED`` and ``CONFIG_BUILD_KERNEL``. + +A flat build is one program: calling ``write()`` is a function call, and an +application bug can corrupt the kernel. A protected build is two blobs, one +privileged and one unprivileged, with an MPU between them, so the same call +becomes a system call; no address mapping is performed, so the two blobs +still share one set of addresses. A kernel build gives each process its own +address environment through an MMU. That is what ``fork()`` needs -- the +child gets its own copy of the parent's memory *at the same virtual +addresses* -- and what ``CONFIG_PAGING`` requires as well. + +Much of what the pages below say depends on this choice, which is why it is +worth settling first. That is the short version; the page below is the long +one, and takes each mode in turn, with on-demand paging and address +environments described alongside them. + +.. toctree:: + :maxdepth: 1 + + build_modes.rst + +The kernel +========== + +.. toctree:: + :maxdepth: 1 + + scheduling/index.rst + ipc/index.rst + concurrency/index.rst + time/index.rst + interrupts/index.rst + memory/index.rst + +Device drivers +============== + +By far the largest part of the OS: ``drivers/`` holds 59 subdirectories, of +which storage is five. Everything a board talks to goes through here. + +.. toctree:: + :maxdepth: 1 + + drivers/index.rst + +File systems and networking +=========================== + +.. toctree:: + :maxdepth: 1 + + filesystem/index.rst + networking/index.rst + +Running programs +================ + +.. toctree:: + :maxdepth: 1 + + binfmt/index.rst + syscall.rst + libs/index.rst + +Media and security +================== + +.. toctree:: + :maxdepth: 1 + + graphics/index.rst + audio/index.rst + video.rst + crypto.rst + wireless.rst + +Portability +=========== + +.. toctree:: + :maxdepth: 1 + + arch/index.rst + openamp.rst + +Reference +========= + +.. toctree:: + :maxdepth: 1 + + nuttx.rst + app_vs_os.rst + conventions.rst + notifier.rst diff --git a/Documentation/implementation/bottomhalf_interrupt.rst b/Documentation/os/interrupts/bottomhalf_interrupt.rst similarity index 100% rename from Documentation/implementation/bottomhalf_interrupt.rst rename to Documentation/os/interrupts/bottomhalf_interrupt.rst diff --git a/Documentation/implementation/critical_sections.rst b/Documentation/os/interrupts/critical_sections.rst similarity index 98% rename from Documentation/implementation/critical_sections.rst rename to Documentation/os/interrupts/critical_sections.rst index 17b0b067d42..0e43a228e6d 100644 --- a/Documentation/implementation/critical_sections.rst +++ b/Documentation/os/interrupts/critical_sections.rst @@ -23,7 +23,7 @@ When we discuss critical sections here we really refer to one of two mechanisms: The use of either mechanism will always harm real-time performance. The effects of critical sections on real-time performance is discussed in -:doc:`/implementation/preemption_latency`. +:doc:`/os/scheduling/preemption_latency`. The end result is that a certain amount of **jitter** is added to the real-time response. Critical sections cannot be avoided within the OS and, as a consequence, a certain @@ -32,7 +32,7 @@ the maximum time that critical sections are in place in order to manage that jit that the variability in response time is within an acceptable range. NOTE: This discussion applies to Normal interrupt processing. Most of this discussion -does not apply to :doc:`/guides/zerolatencyinterrupts`. Those interrupts are not masked +does not apply to :doc:`/guides/concurrency/zerolatencyinterrupts`. Those interrupts are not masked in the same fashion and none of the issues address in this page apply to those interrupts. @@ -459,7 +459,7 @@ NOTES: for ``Tresp1`` should instead be the following? (This assumes that hardware arbitration is such that the interrupt of interest will be deferred by no more than one interrupt). Concurrent, nested interrupts might be better supported with prioritized. - See more: :doc:`/guides/nestedinterrupts`. + See more: :doc:`/guides/concurrency/nestedinterrupts`. * ``Tresp1 = Tcrit + Tintrmax + Tintr + C1`` @@ -486,7 +486,7 @@ You have these options: sections should correctly be used only to protect resources that are shared between tasking level logic and interrupt level logic. -#. Switch to :doc:`/guides/zerolatencyinterrupts`. Those interrupts are not subject +#. Switch to :doc:`/guides/concurrency/zerolatencyinterrupts`. Those interrupts are not subject to most of the issues discussed in this page. **NOTE** diff --git a/Documentation/os/interrupts/index.rst b/Documentation/os/interrupts/index.rst new file mode 100644 index 00000000000..7b9b3961ef1 --- /dev/null +++ b/Documentation/os/interrupts/index.rst @@ -0,0 +1,45 @@ +========== +Interrupts +========== + +How NuttX takes an interrupt, what an interrupt handler may and may not do, +and how code protects itself from one. The code lives in ``sched/irq/``, +with the vector table and the entry sequence in +``arch//src/``. + +On most architectures an interrupt handler runs with interrupts disabled -- +nesting is the exception rather than the rule, and +:doc:`/guides/concurrency/nestedinterrupts` covers it -- and on every +architecture the handler cannot block. That is the whole reason the rest of +this section exists: anything that has to wait, allocate or take a lock has +to be handed off, which is what :doc:`bottom halves ` +and the work queues are for. + +.. figure:: interrupt_flow.svg + :align: center + :width: 100% + :alt: An interrupt is vectored by the architecture entry code, dispatched + to the driver handler which does only what cannot wait, and the + rest is handed to a work queue thread; on return the scheduler may + switch to a different thread. + + From the peripheral asserting the line to the return, and where the work + that cannot be done in a handler goes instead. + +The last step is the one that surprises people: returning from an interrupt +does not necessarily return to the thread that was interrupted. A handler +often makes a higher-priority thread ready -- that is usually the whole +point -- and NuttX switches to it before the interrupted thread runs again. + +For protecting a section of code, note that disabling interrupts and +locking pre-emption are not the same choice and do not cost the same. See +:doc:`critical_sections` for the difference, and +:doc:`/os/scheduling/preemption_latency` for what each one does to response +time. + +.. toctree:: + :maxdepth: 1 + + interrupt_controls.rst + critical_sections.rst + bottomhalf_interrupt.rst diff --git a/Documentation/implementation/interrupt_controls.rst b/Documentation/os/interrupts/interrupt_controls.rst similarity index 100% rename from Documentation/implementation/interrupt_controls.rst rename to Documentation/os/interrupts/interrupt_controls.rst diff --git a/Documentation/os/interrupts/interrupt_flow.svg b/Documentation/os/interrupts/interrupt_flow.svg new file mode 100644 index 00000000000..e22a845c95a --- /dev/null +++ b/Documentation/os/interrupts/interrupt_flow.svg @@ -0,0 +1,69 @@ + + + + + + + + HARDWARE AND ARCHITECTURE ENTRY · arch/<arch>/src/ + + IRQ asserted + by a peripheral + + vector, save context + interrupts disabled (most archs) + + irq_dispatch() + find the handler + + + + + INTERRUPT HANDLER · cannot block, cannot wait, malloc may fail + + the driver's ISR + clear the cause, read the register + + work_queue() + hand off everything that can wait + + This is the rule the whole + section follows. + + + + BOTTOM HALF · a worker thread, later + + the work queue thread + may block, may take a lock + + The device is served here, + where waiting is allowed. + + + RETURN FROM INTERRUPT + + restore context + — but not necessarily the same thread: a handler may have + made a higher-priority thread ready, and NuttX switches to it. + diff --git a/Documentation/reference/os/events.rst b/Documentation/os/ipc/events.rst similarity index 100% rename from Documentation/reference/os/events.rst rename to Documentation/os/ipc/events.rst diff --git a/Documentation/os/ipc/index.rst b/Documentation/os/ipc/index.rst new file mode 100644 index 00000000000..ffa0fce4954 --- /dev/null +++ b/Documentation/os/ipc/index.rst @@ -0,0 +1,59 @@ +========================== +Inter-Thread Communication +========================== + +How threads wait for each other and pass data. The mechanisms live under +``sched/``: ``sched/mqueue/`` for message queues, ``sched/semaphore/`` for +semaphores and mutexes, ``sched/signal/`` for signals and ``sched/event/`` +for events. + +Each of them is in three pieces, and knowing which is which saves a search. +``sched/`` holds the internal machinery, named ``nxsem_``, ``nxmq_`` and so +on. ``libs/libc/semaphore/`` and ``libs/libc/signal/`` hold the POSIX +surface that calls into it -- ``sem_wait()``, ``sigemptyset()``. And +``fs/mqueue/``, ``fs/semaphore/`` and ``fs/event/`` hold only the *named* +variants, the ``open``, ``close`` and ``unlink`` of each: giving one of +these a name makes it a file system object, which is why that part lives +with the file system. + +Which one to reach for: + +.. list-table:: + :header-rows: 1 + :widths: 24 76 + + * - Mechanism + - Use it when + * - Semaphore + - Counting something: a resource with N instances, or one thread + telling another that work is ready. + * - Mutex + - Protecting data. Unlike a semaphore it has an owner: only the thread + that locked it may unlock it, and never from an interrupt handler. + * - Message queue + - Passing data, not just a signal. The queue decouples the sender from + the receiver, up to the point where it fills: a sender that finds it + full waits for room. + * - Signal + - Interrupting a thread that is doing something else, or reacting to an + asynchronous event. + * - Event + - Waiting on a combination of conditions rather than a single one. + An interrupt handler may deliver one, which a mutex cannot accept. + The only one of the five you have to ask for: ``CONFIG_SCHED_EVENTS`` + is off by default, where message queues and signals are on and are + removed by ``CONFIG_DISABLE_MQUEUE`` and + ``CONFIG_DISABLE_ALL_SIGNALS``. + +Priority inheritance is not one of the things that separates the two. +``CONFIG_PRIORITY_INHERITANCE`` covers semaphores as well as mutexes, and +when it is set both start out with inheritance enabled; a semaphore used for +signalling rather than locking is the case where you turn it back off, with +``sem_setprotocol(sem, SEM_PRIO_NONE)``. + +.. toctree:: + :maxdepth: 1 + + mutex.rst + events.rst + signal_handlers.rst diff --git a/Documentation/reference/os/mutex.rst b/Documentation/os/ipc/mutex.rst similarity index 100% rename from Documentation/reference/os/mutex.rst rename to Documentation/os/ipc/mutex.rst diff --git a/Documentation/implementation/signal_handlers.rst b/Documentation/os/ipc/signal_handlers.rst similarity index 100% rename from Documentation/implementation/signal_handlers.rst rename to Documentation/os/ipc/signal_handlers.rst diff --git a/Documentation/implementation/crc.rst b/Documentation/os/libs/crc.rst similarity index 100% rename from Documentation/implementation/crc.rst rename to Documentation/os/libs/crc.rst diff --git a/Documentation/components/libs/index.rst b/Documentation/os/libs/index.rst similarity index 96% rename from Documentation/components/libs/index.rst rename to Documentation/os/libs/index.rst index 47cb071cf9b..f65937a0ea5 100644 --- a/Documentation/components/libs/index.rst +++ b/Documentation/os/libs/index.rst @@ -37,7 +37,13 @@ directory from becoming cluttered with individual libraries. :caption: Contents: libc/index.rst + libbuiltin.rst libdsp.rst libm.rst libxx.rst libnx/index.rst + +.. toctree:: + :maxdepth: 1 + + crc.rst diff --git a/Documentation/os/libs/libbuiltin.rst b/Documentation/os/libs/libbuiltin.rst new file mode 100644 index 00000000000..256e2dfdc51 --- /dev/null +++ b/Documentation/os/libs/libbuiltin.rst @@ -0,0 +1,54 @@ +========================= +Toolchain support library +========================= + +``libs/libbuiltin/`` holds the pieces that come from the toolchain rather +than from NuttX: the compiler's own runtime, and the instrumentation +libraries behind coverage and profiling. It has two provider directories, +``libgcc/`` and ``compiler-rt/``, and three independent choices in Kconfig. + +Builtin runtime +=============== + +The helper routines a compiler emits calls to for work the target has no +instruction for. + +``CONFIG_BUILTIN_TOOLCHAIN`` + Link the toolchain's own builtin library to the OS. This is the default. + +``CONFIG_BUILTIN_COMPILER_RT`` + Compile LLVM's ``libclang_rt.builtins`` into the OS instead. Note that it + depends on ``CONFIG_ARCH_TOOLCHAIN_GNU``: it is for using LLVM's runtime + from a GNU toolchain, not for Clang builds. + +Code coverage +============= + +Off by default -- ``CONFIG_COVERAGE_NONE`` -- with three ways to turn it on: + +``CONFIG_COVERAGE_TOOLCHAIN`` + Link the toolchain's gcov library. Needs a GCC toolchain and + ``CONFIG_HAVE_CXXINITIALIZE``. + +``CONFIG_COVERAGE_COMPILER_RT`` + LLVM's ``libclang_rt.profile``, for a Clang toolchain, which brings the + ``-fprofile-*`` options with it. + +``CONFIG_COVERAGE_MINI`` + A cut-down library for either toolchain. + +``CONFIG_COVERAGE_ALL`` instruments every module, which the Kconfig warns +costs "a large performance penalty"; without it you add the compiler flags +to the one module you care about. Data is written under +``CONFIG_COVERAGE_DEFAULT_PREFIX``, ``/data`` by default, and +``CONFIG_COVERAGE_GCOV_DUMP_REBOOT`` dumps it on reboot. From a shell it is +``gcov dump -d ``. + +Profiling +========= + +``CONFIG_PROFILE_MINI`` enables gprof call graphs; it needs +``CONFIG_FRAME_POINTER`` and the ``-pg`` flag on whatever you want to +profile. ``CONFIG_PROFILE_ALL`` applies it to every module, with the same +penalty as its coverage counterpart. The default is +``CONFIG_PROFILE_NONE``. diff --git a/Documentation/components/libs/libc/index.rst b/Documentation/os/libs/libc/index.rst similarity index 100% rename from Documentation/components/libs/libc/index.rst rename to Documentation/os/libs/libc/index.rst diff --git a/Documentation/components/libs/libc/search.rst b/Documentation/os/libs/libc/search.rst similarity index 100% rename from Documentation/components/libs/libc/search.rst rename to Documentation/os/libs/libc/search.rst diff --git a/Documentation/components/libs/libc/stdbit.rst b/Documentation/os/libs/libc/stdbit.rst similarity index 100% rename from Documentation/components/libs/libc/stdbit.rst rename to Documentation/os/libs/libc/stdbit.rst diff --git a/Documentation/components/libs/libc/stream.rst b/Documentation/os/libs/libc/stream.rst similarity index 100% rename from Documentation/components/libs/libc/stream.rst rename to Documentation/os/libs/libc/stream.rst diff --git a/Documentation/components/libs/libc/zoneinfo.rst b/Documentation/os/libs/libc/zoneinfo.rst similarity index 100% rename from Documentation/components/libs/libc/zoneinfo.rst rename to Documentation/os/libs/libc/zoneinfo.rst diff --git a/Documentation/components/libs/libdsp.rst b/Documentation/os/libs/libdsp.rst similarity index 100% rename from Documentation/components/libs/libdsp.rst rename to Documentation/os/libs/libdsp.rst diff --git a/Documentation/components/libs/libm.rst b/Documentation/os/libs/libm.rst similarity index 100% rename from Documentation/components/libs/libm.rst rename to Documentation/os/libs/libm.rst diff --git a/Documentation/components/libs/libnx/index.rst b/Documentation/os/libs/libnx/index.rst similarity index 100% rename from Documentation/components/libs/libnx/index.rst rename to Documentation/os/libs/libnx/index.rst diff --git a/Documentation/components/libs/libnx/nxfonts.rst b/Documentation/os/libs/libnx/nxfonts.rst similarity index 100% rename from Documentation/components/libs/libnx/nxfonts.rst rename to Documentation/os/libs/libnx/nxfonts.rst diff --git a/Documentation/components/libs/libxx.rst b/Documentation/os/libs/libxx.rst similarity index 100% rename from Documentation/components/libs/libxx.rst rename to Documentation/os/libs/libxx.rst diff --git a/Documentation/reference/os/addrenv.rst b/Documentation/os/memory/addrenv.rst similarity index 100% rename from Documentation/reference/os/addrenv.rst rename to Documentation/os/memory/addrenv.rst diff --git a/Documentation/components/mm/index.rst b/Documentation/os/memory/index.rst similarity index 98% rename from Documentation/components/mm/index.rst rename to Documentation/os/memory/index.rst index e2a9988bbdb..2f78ef63bd0 100644 --- a/Documentation/components/mm/index.rst +++ b/Documentation/os/memory/index.rst @@ -4,11 +4,6 @@ Memory Management This page discusses the NuttX memory management logic. -.. toctree:: - :maxdepth: 1 - - shm.rst - Standard Memory Management Functions ------------------------------------ @@ -218,7 +213,7 @@ Sub-Directories: - ``mm/shm`` - The shared memory logic The shared memory management logic has its own page that can be -found at :doc:`shm`. +found at :doc:`/os/memory/shm`. I/O Buffers ----------- @@ -238,3 +233,16 @@ available for usage by drivers. The I/O buffers have these properties: interface allows different protocol modules to use their own unique I/O buffer sources and allocation strategies without interfering with each other. + +.. toctree:: + :maxdepth: 1 + + shm.rst + +.. toctree:: + :maxdepth: 1 + + memory_configurations.rst + addrenv.rst + iob.rst + paging.rst diff --git a/Documentation/reference/os/iob.rst b/Documentation/os/memory/iob.rst similarity index 100% rename from Documentation/reference/os/iob.rst rename to Documentation/os/memory/iob.rst diff --git a/Documentation/implementation/memory_configurations.rst b/Documentation/os/memory/memory_configurations.rst similarity index 82% rename from Documentation/implementation/memory_configurations.rst rename to Documentation/os/memory/memory_configurations.rst index f8f5b8b9b97..93ec3677755 100644 --- a/Documentation/implementation/memory_configurations.rst +++ b/Documentation/os/memory/memory_configurations.rst @@ -4,210 +4,6 @@ Memory Configurations ===================== -.. _flat-build: - -Flat, Embedded Build -==================== - -The normal build of NuttX for the typical embedded environment uses -a single blob of code in a flat address space. -For most lower end CPUs (such as the ARM Cortex-M family), -this means executing directly out of the physical address space. - -Even if the CPU has an MMU (such as with the ARM Cortex-A family), -the typical NuttX build still uses a flat address space with the MMU -providing only an identity mapping. - -In this case, there is still benefit from using the MMU because -the MMU provides fine control over caching and memory behavior -over the address space. - - -.. _on-demand-paging: - -On-Demand Paging -================ - -NuttX also supports on-demand paging via ``CONFIG_PAGING``. -On-demand paging is a method of virtual memory management and requires -the the CPU architecture support a MMU. - -In a system that uses on-demand paging, the OS responds to a page fault -by copying data from some storage media into physical memory and setting up -the MMU to provided the necessary virtual address mapping. -The CPU can then continue from the page fault with the necessary memory -in place for the virtual address. - -Execution Image ---------------- - -The execution image is still built as one blob and appears as one blob on the -storage media. But the execution image is paged into arbitrary physical -addresses with non-contiguous virtual addresses. -The physical and virtual address spaces are then "checker boards" -of memory in use. - -Advantages ----------- - -The main advantage of on-demand paging is that you can execute a single -program that is much larger than the physical address space or a collection -of programs that together are much larger than the physical address space. - -Current Implementation ----------------------- - -On-demand paging is currently implemented only for the NXP LPC31xx family. -The LPC31xx has a 192KiB internal SRAM and with on-demand paging the LPC31xx -can execute a huge program residing in SerialFLASH by bringing in new pages -as needed from the SerialFLASH when ``_page`` ``fault_s`` occur. - - -.. _protected-build: - -Protected Build -=============== - -Protected Build Mode --------------------- - -NuttX also supports a protected build mode for certain CPU architectures -if ``CONFIG_BUILD_PROTECTED`` is selected. - -**In this mode, NuttX is built as two blobs, one privileged and -one unprivileged.** The privileged blob contains the RTOS, and the other, -unprivileged blob holds all of the applications. - -The build supports system calls via a call gate so that the unprivileged, -application code can access the privileged RTOS services. - -Memory Protection ------------------ - -Within each blob, the address space is flat. No MMU is required to support -the protected build since no address mapping is performed. - -In fact, this feature is currently available only for the ARM Cortex-M family. -In this case the Cortex-M's MPU provides the security in the address spaces -of the two blobs. - -This feature could also be implemented with a CPU that supports an MMU, -but there has thus far been no reason to implement such a configuration. - -Dynamic Memory Allocation -------------------------- - -The purpose of protected build then is focused primarily on securing the OS -and CPU resources from potential rogue applications. - -The MPU simply protects the hardware, code regions, and data regions -of the RTOS. But dynamic memory allocations become more complex. -Protection is also required for (certain) memory allocations made by the RTOS. -The RTOS must also be capable of allocating memory that is accessible -by user applications (such as the user thread stacks). - -Dual Heaps ----------- - -In systems with MMUs, the privilege of each page of memory can be controlled -and there are established architectures for memory management of processes -(see below). However, with only an MPU with a limited number of pages -(the Cortex-M has 8 pages only!) we are forced to resolve this problem -by dividing available heap memory into two heaps: -a privileged heap and an unprivileged heap, using different allocations -mechanisms for each (kmalloc and malloc, respectively). - - -.. _addrenv: - -Address Environments -==================== - -If the option ``CONFIG_ARCH_ADDRENV`` is selected, then NuttX will support -address environments in the following way: the base code is still one blob -and identical in every way to the "Flat Embedded Build" discussed above. -But all applications are loaded into RAM from executable files, -separately compiled and separately linked programs, that reside -in a file system. - -Instead of starting the user application at a fixed, in-memory address -(such as ``nsh_main()``), the system will start the program contained -in an executable file, given its path. - -That initial user program can then start additional applications -from executable files in a file system. - -Per Program ------------ - -As each program is started, a new address environment is created -for the new task. This address environment is then unique for each task. -A task does not have the capability to access just anything in the address -environment. A task may only access addresses within its own address space -and within the address space of the base code. - -MMU (Memory Management Unit) ----------------------------- - -The CPU must support an MMU in order to provide address environments. - -This feature was originally implemented to support the ZiLOG Z180 which -is an 8-bit CPU (basically a Z80) that also supports a simple MMU. -Specifically for the P112 platform. Unfortunately, due to complex tool -issues and fading interest, that port was fully implemented but never tested. - -As of this writing, the implementation of address environment support -for the Cortex-A family is complete and verified. -An example configuration is available at -``nuttx/boards/arm/sama5/sama5d4-ek/configs/elf``. - - -.. _kernel-build: - -Kernel Build -============ - -The Kernel Build ----------------- - -And finally, there is the kernel build that is enabled with -``CONFIG_BUILD_KERNEL=y``. -The NuttX kernel build mode is similar to building with address environments: - -* Each application process executes from its own, private address environment. - -But, in addition, there are some features similar to the protected build mode: - -* NuttX is built as a monolithic kernel, similar to the way that NuttX - is built in the Protected Build Mode. -* All of the code that executes within the kernel executes in privileged, - kernel mode. Again, this is analogous to the Protected Build Mode. -* All user applications are executed with their own private - address environments in unprivileged, user-mode. - -MMU Required ------------- - -In order to support this kernel build mode, the **processor must provide -a Memory Management Unit (MMU)**. The MMU is used to provide both the address -environment for the user application as well as to enforce -the user-/kernel-mode privileges. - -This kernel build feature has been fully implemented and verified -on the Cortex-A family of processes. -A functioning example can be found at -``nuttx/boards/arm/sama5/sama5d4-ek/configs/knsh``. - -Process Environment -------------------- - -Such user applications that execute their own private, unprivileged address -environments are usually referred to as processes. - -The ``CONFIG_BUILD_KERNEL=y`` build is the first step toward support -for processes in NuttX. - - The Roadmap Toward Processes ============================ diff --git a/Documentation/components/paging.rst b/Documentation/os/memory/paging.rst similarity index 100% rename from Documentation/components/paging.rst rename to Documentation/os/memory/paging.rst diff --git a/Documentation/components/mm/shm.rst b/Documentation/os/memory/shm.rst similarity index 100% rename from Documentation/components/mm/shm.rst rename to Documentation/os/memory/shm.rst diff --git a/Documentation/components/net/delay_act_and_tcp_perf.rst b/Documentation/os/networking/delay_act_and_tcp_perf.rst similarity index 100% rename from Documentation/components/net/delay_act_and_tcp_perf.rst rename to Documentation/os/networking/delay_act_and_tcp_perf.rst diff --git a/Documentation/components/net/index.rst b/Documentation/os/networking/index.rst similarity index 98% rename from Documentation/components/net/index.rst rename to Documentation/os/networking/index.rst index f1cd6010832..2285cd2335f 100644 --- a/Documentation/components/net/index.rst +++ b/Documentation/os/networking/index.rst @@ -2,25 +2,6 @@ Network Support =============== -.. toctree:: - :maxdepth: 1 - - sixlowpan.rst - socketcan.rst - pkt.rst - ipfilter.rst - nat.rst - netdev.rst - netdriver.rst - mdio.rst - netguardsize.rst - netlink.rst - slip.rst - wqueuedeadlocks.rst - tcp_network_perf.rst - delay_act_and_tcp_perf.rst - tcp_state_machine.rst - ``net`` Directory Structure :: nuttx/ @@ -74,3 +55,27 @@ Network Support +----------------------------------------------------------------+ +--------------------------+ | Networking Hardware | | Hardware TCP/IP Stack | +----------------------------------------------------------------+ +--------------------------+ + +.. toctree:: + :maxdepth: 1 + + sixlowpan.rst + socketcan.rst + pkt.rst + ipfilter.rst + nat.rst + netdev.rst + netdriver.rst + mdio.rst + netguardsize.rst + netlink.rst + slip.rst + wqueuedeadlocks.rst + tcp_network_perf.rst + delay_act_and_tcp_perf.rst + tcp_state_machine.rst + +.. toctree:: + :maxdepth: 1 + + newreno.rst diff --git a/Documentation/components/net/ipfilter.rst b/Documentation/os/networking/ipfilter.rst similarity index 100% rename from Documentation/components/net/ipfilter.rst rename to Documentation/os/networking/ipfilter.rst diff --git a/Documentation/components/net/mdio.rst b/Documentation/os/networking/mdio.rst similarity index 100% rename from Documentation/components/net/mdio.rst rename to Documentation/os/networking/mdio.rst diff --git a/Documentation/components/net/nat.rst b/Documentation/os/networking/nat.rst similarity index 100% rename from Documentation/components/net/nat.rst rename to Documentation/os/networking/nat.rst diff --git a/Documentation/components/net/netdev.rst b/Documentation/os/networking/netdev.rst similarity index 100% rename from Documentation/components/net/netdev.rst rename to Documentation/os/networking/netdev.rst diff --git a/Documentation/components/net/netdriver.rst b/Documentation/os/networking/netdriver.rst similarity index 100% rename from Documentation/components/net/netdriver.rst rename to Documentation/os/networking/netdriver.rst diff --git a/Documentation/components/net/netguardsize.rst b/Documentation/os/networking/netguardsize.rst similarity index 100% rename from Documentation/components/net/netguardsize.rst rename to Documentation/os/networking/netguardsize.rst diff --git a/Documentation/components/net/netlink.rst b/Documentation/os/networking/netlink.rst similarity index 100% rename from Documentation/components/net/netlink.rst rename to Documentation/os/networking/netlink.rst diff --git a/Documentation/reference/os/newreno.rst b/Documentation/os/networking/newreno.rst similarity index 100% rename from Documentation/reference/os/newreno.rst rename to Documentation/os/networking/newreno.rst diff --git a/Documentation/components/net/pkt.rst b/Documentation/os/networking/pkt.rst similarity index 100% rename from Documentation/components/net/pkt.rst rename to Documentation/os/networking/pkt.rst diff --git a/Documentation/components/net/sixlowpan.rst b/Documentation/os/networking/sixlowpan.rst similarity index 100% rename from Documentation/components/net/sixlowpan.rst rename to Documentation/os/networking/sixlowpan.rst diff --git a/Documentation/components/net/slip.rst b/Documentation/os/networking/slip.rst similarity index 100% rename from Documentation/components/net/slip.rst rename to Documentation/os/networking/slip.rst diff --git a/Documentation/components/net/socketcan.rst b/Documentation/os/networking/socketcan.rst similarity index 100% rename from Documentation/components/net/socketcan.rst rename to Documentation/os/networking/socketcan.rst diff --git a/Documentation/components/net/tcp_network_perf.rst b/Documentation/os/networking/tcp_network_perf.rst similarity index 100% rename from Documentation/components/net/tcp_network_perf.rst rename to Documentation/os/networking/tcp_network_perf.rst diff --git a/Documentation/components/net/tcp_state_machine.rst b/Documentation/os/networking/tcp_state_machine.rst similarity index 100% rename from Documentation/components/net/tcp_state_machine.rst rename to Documentation/os/networking/tcp_state_machine.rst diff --git a/Documentation/components/net/wqueuedeadlocks.rst b/Documentation/os/networking/wqueuedeadlocks.rst similarity index 100% rename from Documentation/components/net/wqueuedeadlocks.rst rename to Documentation/os/networking/wqueuedeadlocks.rst diff --git a/Documentation/reference/os/notifier.rst b/Documentation/os/notifier.rst similarity index 100% rename from Documentation/reference/os/notifier.rst rename to Documentation/os/notifier.rst diff --git a/Documentation/reference/os/nuttx.rst b/Documentation/os/nuttx.rst similarity index 100% rename from Documentation/reference/os/nuttx.rst rename to Documentation/os/nuttx.rst diff --git a/Documentation/components/openamp.rst b/Documentation/os/openamp.rst similarity index 100% rename from Documentation/components/openamp.rst rename to Documentation/os/openamp.rst diff --git a/Documentation/implementation/cancellation_points.rst b/Documentation/os/scheduling/cancellation_points.rst similarity index 100% rename from Documentation/implementation/cancellation_points.rst rename to Documentation/os/scheduling/cancellation_points.rst diff --git a/Documentation/implementation/context_switches.rst b/Documentation/os/scheduling/context_switches.rst similarity index 100% rename from Documentation/implementation/context_switches.rst rename to Documentation/os/scheduling/context_switches.rst diff --git a/Documentation/implementation/disabling_interrupts.png b/Documentation/os/scheduling/disabling_interrupts.png similarity index 100% rename from Documentation/implementation/disabling_interrupts.png rename to Documentation/os/scheduling/disabling_interrupts.png diff --git a/Documentation/implementation/disabling_preemption.png b/Documentation/os/scheduling/disabling_preemption.png similarity index 100% rename from Documentation/implementation/disabling_preemption.png rename to Documentation/os/scheduling/disabling_preemption.png diff --git a/Documentation/os/scheduling/index.rst b/Documentation/os/scheduling/index.rst new file mode 100644 index 00000000000..97bef15e4a3 --- /dev/null +++ b/Documentation/os/scheduling/index.rst @@ -0,0 +1,239 @@ +========== +Scheduling +========== + +NuttX decides which thread runs, and when. This page describes that +decision: the states a thread moves through, the policies that order threads +of equal priority, and the interface an application uses to choose between +them. + +The code lives under ``sched/``. + +Priority comes first +==================== + +NuttX is a **strict priority** scheduler. The thread that runs is always +the ready-to-run thread with the highest priority. A lower-priority thread +runs only while no higher-priority thread is ready; the moment a +higher-priority one becomes ready, it takes the CPU. NuttX is fully +pre-emptible, so that happens immediately, including from inside an +interrupt handler. + +Priority alone does not say what happens when two ready threads share the +same priority. That is what the scheduling policies decide, and it is the +only thing they decide. + +Thread states +============= + +Every thread is in exactly one state, held in its task control block. The +states are defined by ``enum tstate_e`` in ``include/nuttx/sched.h``, and the +comment beside each one sorts it into a group: ``INVALID`` for a TCB that has +not been initialised, ``READY_TO_RUN``, and ``BLOCKED``. + +.. figure:: task_states.svg + :align: center + :width: 100% + :alt: A task is created inactive, becomes ready to run, is scheduled onto a + CPU, blocks waiting for a resource, and finally exits. + + The states of ``enum tstate_e``, and what moves a thread between them. + +``INACTIVE`` carries the ``BLOCKED`` comment as well, though it is not +waiting on anything: it is a task that has been created and not yet +activated. + +Two ready-to-run states are left off the diagram to keep it readable, and +they are not alike. ``ASSIGNED`` is ``READYTORUN`` with a CPU already +picked, and it is the conditional one -- it exists only under +``CONFIG_SMP``. ``PENDING`` is always compiled, and it is narrower than its +name suggests: a thread goes there only if it became ready while another +thread held ``sched_lock()`` **and** would have pre-empted it. +``nxsched_add_readytorun()`` tests both halves -- +``nxsched_islocked_tcb(rtcb)`` and a new priority higher than the running +thread's -- so a thread that becomes ready at equal or lower priority under +the lock joins the ordinary ready-to-run list instead. + +A thread in any *ready-to-run* state is runnable; only one per CPU is +``RUNNING``. A thread in any *blocked* state is waiting for something +specific, and the state says what: a semaphore, a signal, an event, a +message arriving, or room to put one. ``STOPPED`` waits for ``SIGCONT`` +under ``CONFIG_SIG_SIGSTOP_ACTION``, and one more state is off the diagram +too: ``WAIT_PAGEFILL``, under ``CONFIG_LEGACY_PAGING``. Sleeping is not a +state of its own -- ``TSTATE_SLEEPING`` is defined as another name for +``TSTATE_WAIT_SIG``. This is why a stack dump tells you not just that a +thread is stuck but what it is stuck on. + +Scheduling policies +=================== + +The policy applies **between threads of equal priority**. It never lets a +lower-priority thread run ahead of a higher-priority one. + +.. figure:: policies.svg + :align: center + :width: 100% + :alt: Under SCHED_FIFO a thread keeps the CPU until it blocks; under + SCHED_RR threads of equal priority take turns; under + SCHED_SPORADIC a thread runs at a high priority while it has + budget and drops to a low one when the budget is spent. + + The same two threads under each policy, and what the sporadic parameters + mean. + +``SCHED_FIFO`` -- run to completion +----------------------------------- + +A thread runs until it blocks, exits, or is pre-empted by something of +higher priority. Two threads of the same priority do not share the CPU: the +first one to start keeps it until it gives it up. + +This is the most predictable policy and the cheapest one, and it is what a +new task gets -- but only while round robin is switched off. +``nxthread_setup_scheduler()`` picks the policy for every new TCB with a +compile-time test, not a runtime one: ``TCB_FLAG_SCHED_RR`` and a timeslice +of ``CONFIG_RR_INTERVAL`` when that value is positive, +``TCB_FLAG_SCHED_FIFO`` otherwise. So ``CONFIG_RR_INTERVAL`` is not a +per-thread opt-in; setting it changes the default policy of the whole +system. + +``SCHED_RR`` -- take turns +-------------------------- + +Same as ``SCHED_FIFO``, except that a thread which has been running for +``CONFIG_RR_INTERVAL`` milliseconds is moved to the back of the queue of +threads at its own priority, and the next one runs. + +``CONFIG_RR_INTERVAL`` counts milliseconds and defaults to 0, which disables +the policy entirely -- and *entirely* is literal: at 0 the ``SCHED_RR`` case +is not compiled into ``nxsched_set_scheduler()`` at all, so asking for the +policy at run time fails rather than being ignored. Set it to a positive +value and, as above, every task starts out round-robin. Use it when several +threads of the same priority have to make progress together, and none of +them blocks often enough to give the others a chance on its own. + +``SCHED_SPORADIC`` -- a budget per period +----------------------------------------- + +Enabled by ``CONFIG_SCHED_SPORADIC``. This one is worth understanding +before reaching for it, because it behaves unlike the other two. + +A sporadic thread has **two** priorities and a **budget**: + +.. list-table:: + :header-rows: 1 + :widths: 34 66 + + * - ``struct sched_param`` field + - Meaning + * - ``sched_priority`` + - The high priority. The thread runs at this priority while it still + has budget left. + * - ``sched_ss_low_priority`` + - The low priority. The thread drops to this once the budget is spent. + * - ``sched_ss_init_budget`` + - How much CPU time the thread may spend at the high priority. A + ``struct timespec``. + * - ``sched_ss_repl_period`` + - The length of one cycle, budget included. Also a ``struct + timespec``. + * - ``sched_ss_max_repl`` + - How many replenishments may be pending at once + (``CONFIG_SCHED_SPORADIC_MAXREPL``). + +While the thread has budget it competes at ``sched_priority``. When the +budget runs out it is demoted to ``sched_ss_low_priority``, so it keeps +running only if nothing else wants the CPU. Then the cycle repeats. + +The period *contains* the budget rather than following it, which is the part +worth reading twice. ``sched_sporadic.c`` asserts +``repl_period >= budget`` and spends the difference at the low priority:: + + remainder = sporadic->repl_period - sporadic->budget; + +Give a thread a 10 ms budget and a 100 ms period and it runs high for up to +10 ms, low for the other 90, and is promoted again 100 ms after the cycle +began -- not 100 ms after the budget ran out. ``sched_ss_max_repl`` bounds a +second mechanism rather than this one: when the thread is pre-empted part-way +through its budget, each fragment is replenished one period after it was +consumed, and the field caps how many such replenishments may be outstanding +at once. + +What this buys you is a **bounded** amount of high-priority CPU time for a +thread whose workload you do not fully trust: an event handler that is +usually short but occasionally is not. It gets to respond quickly, and it +cannot starve the rest of the system if it misbehaves. A thread that would +otherwise have to be given a low priority -- and therefore a poor response +time -- can be given a high one safely. + +Choosing a policy +================= + +.. list-table:: + :header-rows: 1 + :widths: 22 78 + + * - Policy + - Use it when + * - ``SCHED_FIFO`` + - The normal case. Threads are ordered by priority and each runs until + it blocks. + * - ``SCHED_RR`` + - Several threads sit at the same priority and all have to progress, + for example a set of equivalent workers. + * - ``SCHED_SPORADIC`` + - A thread needs a fast response but its running time is not bounded, + and starving lower-priority work is not acceptable. + +``SCHED_OTHER`` and ``SCHED_NORMAL`` exist for portability and are both 0; +``SCHED_NORMAL`` is defined as an alias of ``SCHED_OTHER``, which the header +describes as mapping to ``SCHED_FIFO`` or ``SCHED_RR``. In the code that +mapping goes to ``SCHED_RR`` and only while ``CONFIG_RR_INTERVAL`` is +positive: ``nxsched_set_scheduler()`` compiles ``case SCHED_OTHER`` next to +``case SCHED_RR`` under that same test. + +``include/sched.h`` also defines ``SCHED_BATCH`` and ``SCHED_IDLE``. Neither +name appears anywhere else in the tree, and ``nxsched_set_scheduler()`` does +not accept either, so asking for one fails. They are numbers reserved in a +header, not policies you can select. + +Application interface +===================== + +The POSIX interface to all of the above -- ``sched_setscheduler()``, +``sched_setparam()``, ``sched_yield()``, ``sched_rr_get_interval()`` and the +rest -- is documented in :doc:`/reference/user/02_task_scheduling`. + +Two interfaces are specific to NuttX and worth naming here: + +``sched_lock()`` / ``sched_unlock()`` + Hold off the scheduler without disabling interrupts. Interrupts still + run; what is suspended is the switch to another thread. A thread that + becomes ready while pre-emption is locked goes to ``PENDING``, provided it + would have pre-empted the thread holding the lock. This is + cheaper and far less disruptive than disabling interrupts, and it is + almost always the right tool when the goal is "do not switch away from + me" rather than "do not interrupt me". See + :doc:`preemption_latency` for what each choice costs. + +``sched_setaffinity()`` / ``sched_getaffinity()`` + Restrict a thread to a set of CPUs under ``CONFIG_SMP``. See + :doc:`smp`. + +In this section +=============== + +.. toctree:: + :maxdepth: 1 + + nuttx_tasking.rst + tasks_vs_threads.rst + kernel_threads_vs_pthreads.rst + processes_vs_tasks.rst + context_switches.rst + preemption_latency.rst + cancellation_points.rst + smp.rst + wqueue.rst + tls.rst + user_identity.rst diff --git a/Documentation/implementation/kernel_threads_vs_pthreads.rst b/Documentation/os/scheduling/kernel_threads_vs_pthreads.rst similarity index 100% rename from Documentation/implementation/kernel_threads_vs_pthreads.rst rename to Documentation/os/scheduling/kernel_threads_vs_pthreads.rst diff --git a/Documentation/implementation/normal_interrupt.png b/Documentation/os/scheduling/normal_interrupt.png similarity index 100% rename from Documentation/implementation/normal_interrupt.png rename to Documentation/os/scheduling/normal_interrupt.png diff --git a/Documentation/implementation/nuttx_tasking.rst b/Documentation/os/scheduling/nuttx_tasking.rst similarity index 99% rename from Documentation/implementation/nuttx_tasking.rst rename to Documentation/os/scheduling/nuttx_tasking.rst index 90a87b9e1e1..7bd9c8c18a5 100644 --- a/Documentation/implementation/nuttx_tasking.rst +++ b/Documentation/os/scheduling/nuttx_tasking.rst @@ -18,7 +18,6 @@ as a library of user managed functions with a diagram. You can however, pick any subsystem of an RTOS and represent that in some fashion. - Kernel Threads ============== @@ -28,7 +27,6 @@ for instance :ref:`kernel-threads-vs-pthreads`, :ref:`tasks-vs-threads`, .. todo:: Provide more content here :-) - The Scheduler ============= @@ -144,7 +142,6 @@ Here are the blocked task lists: Reference: ``nuttx/sched/sched/sched.h``. - State Transition Diagram ======================== @@ -153,7 +150,6 @@ transition diagram. .. todo:: Provide State Transition Diagram. - Scheduling Policies =================== @@ -175,7 +171,6 @@ at the same priority. ``SCHED_FIFO`` are the same, AND 2. ``SCHED_FIFO`` tasks are never pre-empted in this way. - Task IDs ======== @@ -185,7 +180,6 @@ Given a TCB, the RTOS can find the task ID. So they are functionally equivalent. Only the task ID, however, is exposed at the RTOS/application interfaces. - NuttX Tasks =========== @@ -220,7 +214,6 @@ NuttX will use the MMU to control the instruction and data caches and to support protected memory regions. This may change in future, but this is how things are right now. - NuttX Tasks and Task Resources ------------------------------ @@ -257,12 +250,11 @@ In NuttX, a task is created using the interface ``task_create()``. NuttX Task Exit Sequence ------------------------ -.. figure:: task_exit_sequence.png +.. figure:: /os/scheduling/task_exit_sequence.png :alt: Task Exit Sequence diagram. Task Exit Sequence diagram. - The Pseudo File System and Device Drivers ========================================= @@ -308,7 +300,6 @@ By convention, these device nodes are created in the ``/dev`` directory. Now that we have digressed a little to introduce the NuttX file system and device nodes, we can return to our discussion of task resources. - ``/dev/console`` and Standard Streams ------------------------------------- @@ -319,7 +310,6 @@ When the very first thread is created (called the IDLE thread), the special device node ``/dev/console`` is opened. ``/dev/console`` provides the ``stdin``, ``stdout``, and ``stderr`` for the initial task. - Inheritance of the Task Environment and I/O Redirection ======================================================= @@ -343,7 +333,6 @@ For example in the THTTPD server to redirect socket I/O to standard I/O for CGI tasks. In the Telnet server so that new tasks inherit the Telnet session. - Tasks vs. Pthreads ================== @@ -369,7 +358,6 @@ of the parent task. See :ref:`tasks-vs-threads` for more details. - Process IDs / Task IDs / Pthread IDs ==================================== diff --git a/Documentation/os/scheduling/policies.svg b/Documentation/os/scheduling/policies.svg new file mode 100644 index 00000000000..864075d1266 --- /dev/null +++ b/Documentation/os/scheduling/policies.svg @@ -0,0 +1,82 @@ + + + + + SCHED_FIFO + a thread keeps the CPU until it blocks + + thread A + + thread B + + thread A + + A blocks + + B blocks + + + SCHED_RR + equal priority, equal turns + + + + + + + + + A + B + A + B + A + B + + + + CONFIG_RR_INTERVAL + + + SCHED_SPORADIC + high priority while there is budget, low priority after it runs out + + + + sched_priority + sched_ss_low_priority + + + + + + + + + + + sched_ss_init_budget + + + + + sched_ss_repl_period — budget comes back, priority is restored + diff --git a/Documentation/implementation/preemption_latency.rst b/Documentation/os/scheduling/preemption_latency.rst similarity index 100% rename from Documentation/implementation/preemption_latency.rst rename to Documentation/os/scheduling/preemption_latency.rst diff --git a/Documentation/implementation/processes_vs_tasks.rst b/Documentation/os/scheduling/processes_vs_tasks.rst similarity index 100% rename from Documentation/implementation/processes_vs_tasks.rst rename to Documentation/os/scheduling/processes_vs_tasks.rst diff --git a/Documentation/implementation/smp.rst b/Documentation/os/scheduling/smp.rst similarity index 99% rename from Documentation/implementation/smp.rst rename to Documentation/os/scheduling/smp.rst index 5b2548849a7..ad174e0f2c5 100644 --- a/Documentation/implementation/smp.rst +++ b/Documentation/os/scheduling/smp.rst @@ -28,13 +28,11 @@ According to Wikipedia: -- Source: https://en.wikipedia.org/wiki/Symmetric_multiprocessing. - Development Status ================== SMP support is complete and stable in NuttX on several multi-core platforms. - Enabling SMP ============ @@ -57,7 +55,6 @@ when describing the implementation of SMP on NuttX. This design has been maintained and now reflects the current "as-built" state of SMP in NuttX. - Design Requirements =================== @@ -73,7 +70,6 @@ The basic design requirements are pretty simple: 7. Need to understand how some non-standard NuttX operations things like disabling pre-emption work. - Data Structures =============== @@ -307,7 +303,6 @@ is a better general solution. Counter-arguments are: 3. The stack-based TLS is in user-accessible memory and could be used by applications in protected and kernel builds. - System Startup ============== @@ -326,7 +321,6 @@ Perhaps the MCU interface would be something like: The OS initialization logic would call this function repeatedly until each CPU is started. - Scheduler Interactions ====================== @@ -375,7 +369,6 @@ Restart the CPU with the task at the head of the ``g_assignedtasks[]`` list. The same issue exists for dispatching signals to threads actively running on another CPU. - Interrupt Handling ================== @@ -415,7 +408,6 @@ Which would have to become an array like: volatile uint32_t *g_current_regs[CONFIG_SMP_NCPUS]; - System Calls ============ @@ -426,7 +418,6 @@ the logic that generated the System Call or, alternatively, the design must have some way of obtaining the index of the CPU that generated the System Call. - Critical Sections ================= @@ -437,7 +428,6 @@ sections. But within the OS, for example, in the low level implementation of ``sem_wait()`` and ``sem_post()``, more primitive, non-standard methods must be used to implement critical sections. - .. _spinlocks: Spinlocks @@ -570,7 +560,6 @@ this could still be wasteful of memory. This would work in systems that have both data cache and either an MPU (such as Cortex-m7) or an MMU (such as Cortex-Ax). - Disabling Pre-emption ===================== @@ -640,7 +629,6 @@ is common to many RTOS. But since feature is non-standard and perhaps not realizable in the SMP model, another option would be to simply eliminate it. - Disabling Interrupts ==================== @@ -736,7 +724,6 @@ more complex. See the logic in the file ``sched/irq/irq_csection.c`` if you are really interested in the details. - Pre-Emption Controls and Critical Sections ========================================== @@ -772,7 +759,6 @@ Such pending tasks will only be allowed to run when: It can be determined which CPU(s) have the critical section by examining ``g_cpu_irqset``. - Signal Handlers =============== @@ -807,7 +793,6 @@ This same sequence would have to be followed for other functions that might need to modify the behavior of a running task such as ``task_delete()`` or ``task_restart()``. - Thread Affinity =============== diff --git a/Documentation/implementation/task_exit_sequence.png b/Documentation/os/scheduling/task_exit_sequence.png similarity index 100% rename from Documentation/implementation/task_exit_sequence.png rename to Documentation/os/scheduling/task_exit_sequence.png diff --git a/Documentation/os/scheduling/task_states.svg b/Documentation/os/scheduling/task_states.svg new file mode 100644 index 00000000000..7dc23e36e97 --- /dev/null +++ b/Documentation/os/scheduling/task_states.svg @@ -0,0 +1,78 @@ + + + + + + + task_create() + + + INACTIVE + created, not started + + task_activate() + + + READY TO RUN + + + READYTORUN + waiting for a CPU + + RUNNING + holding a CPU + + + highest priority + + pre-empted + + + BLOCKED + + + + + + + + WAIT_SEM + a semaphore + WAIT_SIG + a signal, or sleeping + WAIT_EVENT + an event + WAIT_MQNOTEMPTY · NOTFULL + a message, or room for one + STOPPED + waiting for SIGCONT + + + waits + + what it waited for happened + + + exited + + exit() + diff --git a/Documentation/implementation/tasks_vs_threads.rst b/Documentation/os/scheduling/tasks_vs_threads.rst similarity index 100% rename from Documentation/implementation/tasks_vs_threads.rst rename to Documentation/os/scheduling/tasks_vs_threads.rst diff --git a/Documentation/implementation/tls.rst b/Documentation/os/scheduling/tls.rst similarity index 100% rename from Documentation/implementation/tls.rst rename to Documentation/os/scheduling/tls.rst diff --git a/Documentation/implementation/user_identity.rst b/Documentation/os/scheduling/user_identity.rst similarity index 100% rename from Documentation/implementation/user_identity.rst rename to Documentation/os/scheduling/user_identity.rst diff --git a/Documentation/reference/os/wqueue.rst b/Documentation/os/scheduling/wqueue.rst similarity index 100% rename from Documentation/reference/os/wqueue.rst rename to Documentation/os/scheduling/wqueue.rst diff --git a/Documentation/components/syscall.rst b/Documentation/os/syscall.rst similarity index 99% rename from Documentation/components/syscall.rst rename to Documentation/os/syscall.rst index 909f3cfe3c8..ad5652a99d8 100644 --- a/Documentation/components/syscall.rst +++ b/Documentation/os/syscall.rst @@ -172,7 +172,7 @@ one optional parameter and, if present, it is of type ``mode_t``. NOTE: This CSV file is used not only to support the generate of trap information, but also for the generation of symbol tables. See ``Documentation/components/tools/`` -and ``Documentation/components/libs/`` for further information. +and ``Documentation/os/libs/`` for further information. Auto-Generated Files -------------------- diff --git a/Documentation/os/system_map.svg b/Documentation/os/system_map.svg new file mode 100644 index 00000000000..bd6cbbcac44 --- /dev/null +++ b/Documentation/os/system_map.svg @@ -0,0 +1,91 @@ + + + + + + APPLICATIONS + + nsh + + your program + + examples + apps/ — a separate repository + + + + C LIBRARY + + libc · libm · libc++ + libs/ + + + + system call boundary — present only in PROTECTED and KERNEL builds + syscall/ + + + + KERNEL + + scheduler + tasks, threads, IPC + + VFS + files, mountpoints + + network stack + sockets, TCP/IP + + memory + heaps, allocators + + binfmt + + file systems + + graphics · audio + + crypto · wireless + sched/ fs/ net/ mm/ binfmt/ graphics/ audio/ crypto/ wireless/ + + + + DEVICE DRIVERS + + character + + block · MTD + + network + + USB · sensors + drivers/ + + + + ARCHITECTURE, CHIP, BOARD + + arch/<arch>/src/<chip> + + boards/<arch>/<chip>/<board> + where register access belongs + diff --git a/Documentation/os/time/index.rst b/Documentation/os/time/index.rst new file mode 100644 index 00000000000..2324dbe24ce --- /dev/null +++ b/Documentation/os/time/index.rst @@ -0,0 +1,50 @@ +================ +Time and Timers +================ + +The system clock, the timers built on it, and what happens when a delay is +shorter than a clock tick. The code lives in ``sched/clock/``, +``sched/timer/``, ``sched/wdog/`` and ``sched/hrtimer/``. + +Three things shape everything on this page. + +The first is whether the system runs on a periodic tick or +:doc:`tickless `. By default a periodic timer interrupt drives +system time; tickless replaces it with an interval timer programmed for the +next OS event, so the system can stay asleep in between. It is not a free +choice: ``CONFIG_SCHED_TICKLESS`` depends on ``CONFIG_ARCH_HAVE_TICKLESS``, +and a tickless port has additional interfaces to implement, declared in +``include/nuttx/arch.h``. + +The second is ``CONFIG_USEC_PER_TICK``, the length of one tick -- and it +matters in *both* configurations, which is the part that catches people out. +Without tickless it is the interval at which the hardware interrupts the OS, +10 ms by default. With tickless there are no such interrupts and it controls +no timer rate at all, but it still sets the resolution of the time that +``clock_systime_ticks()`` reports, and of the delays you can ask for from +watchdog timers and delayed work. Its default simply drops to 100 µs. + +That makes the tick a trade-off rather than a dial to turn down. The count is +held in an ``unsigned int`` -- 32 bits on most targets, 16 on some -- so a +smaller tick buys resolution at the cost of the longest delay that can be +represented: the 100 µs default reaches about 120 hours. It should also never +be set below the resolution of the underlying timer. + +The third is that neither of those bounds you when you need timing finer than +a tick, and this section holds two different answers. :doc:`Short delays +` covers the counter-intuitive things that happen when a +requested delay is near or below one tick -- a discussion that applies under +tickless too, only in different terminology. The high-resolution timer in +``sched/hrtimer/`` (``CONFIG_HRTIMER``) is the other answer, offering +nanosecond-level precision; it is described under +:doc:`System Time and Clock `. Its callbacks run in interrupt +context, which is the price. + +.. toctree:: + :maxdepth: 1 + + time_clock.rst + tickless_os.rst + short_time_delays.rst + oneshot_timers_and_cpu_load.rst + sleep.rst diff --git a/Documentation/implementation/oneshot_timers_and_cpu_load.rst b/Documentation/os/time/oneshot_timers_and_cpu_load.rst similarity index 100% rename from Documentation/implementation/oneshot_timers_and_cpu_load.rst rename to Documentation/os/time/oneshot_timers_and_cpu_load.rst diff --git a/Documentation/implementation/short_delay.png b/Documentation/os/time/short_delay.png similarity index 100% rename from Documentation/implementation/short_delay.png rename to Documentation/os/time/short_delay.png diff --git a/Documentation/implementation/short_time_delays.rst b/Documentation/os/time/short_time_delays.rst similarity index 100% rename from Documentation/implementation/short_time_delays.rst rename to Documentation/os/time/short_time_delays.rst diff --git a/Documentation/reference/os/sleep.rst b/Documentation/os/time/sleep.rst similarity index 100% rename from Documentation/reference/os/sleep.rst rename to Documentation/os/time/sleep.rst diff --git a/Documentation/implementation/tickless_os.rst b/Documentation/os/time/tickless_os.rst similarity index 100% rename from Documentation/implementation/tickless_os.rst rename to Documentation/os/time/tickless_os.rst diff --git a/Documentation/reference/os/time_clock.rst b/Documentation/os/time/time_clock.rst similarity index 100% rename from Documentation/reference/os/time_clock.rst rename to Documentation/os/time/time_clock.rst diff --git a/Documentation/components/video.rst b/Documentation/os/video.rst similarity index 100% rename from Documentation/components/video.rst rename to Documentation/os/video.rst diff --git a/Documentation/components/wireless.rst b/Documentation/os/wireless.rst similarity index 100% rename from Documentation/components/wireless.rst rename to Documentation/os/wireless.rst diff --git a/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst b/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst index e10057f205c..54cbf617dab 100644 --- a/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst +++ b/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst @@ -2,5 +2,7 @@ pcduino-a10 =========== +.. tags:: arch:arm, chip:a1x, vendor:allwinner + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst b/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst index ecaaffceb03..fee504f55dd 100644 --- a/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst +++ b/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst @@ -2,6 +2,8 @@ beaglebone-black ================ +.. tags:: arch:arm, chip:am335x, vendor:ti + This directory contains the port of NuttX to the Beaglebone Black board See http://beagleboard.org for information about Beaglebone Black. This board is based around the TI AM335x Sitara Cortex-A8 CPU. diff --git a/Documentation/platforms/arm/am335x/boards/beaglebone/index.rst b/Documentation/platforms/arm/am335x/boards/beaglebone/index.rst index efe414b980c..7b0f72449b8 100644 --- a/Documentation/platforms/arm/am335x/boards/beaglebone/index.rst +++ b/Documentation/platforms/arm/am335x/boards/beaglebone/index.rst @@ -2,7 +2,7 @@ BeagleBone ========== -.. tags:: arch:arm, chip:am335x +.. tags:: arch:arm, chip:am335x, vendor:ti .. figure:: beaglebone.jpg :figwidth: 100% diff --git a/Documentation/platforms/arm/am67/boards/t3-gem-o1/index.rst b/Documentation/platforms/arm/am67/boards/t3-gem-o1/index.rst index c46e0a5457c..ac1d4691290 100644 --- a/Documentation/platforms/arm/am67/boards/t3-gem-o1/index.rst +++ b/Documentation/platforms/arm/am67/boards/t3-gem-o1/index.rst @@ -2,7 +2,7 @@ T3 Gemstone O1 ============== -.. tags:: chip:am67, arch:arm, experimental +.. tags:: arch:arm, chip:am67, vendor:ti .. list-table:: :align: center diff --git a/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst b/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst index f8bbf704cbe..953e56164bc 100644 --- a/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst +++ b/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst @@ -2,6 +2,8 @@ at32f437-mini ============= +.. tags:: arch:arm, chip:at32, vendor:artery + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst b/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst index 9c175ab0b25..b1be75654a6 100644 --- a/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst +++ b/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst @@ -2,6 +2,8 @@ c5471evm ======== +.. tags:: arch:arm, chip:c5471, vendor:ti + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst b/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst index 12d7ab610bc..85b12bea3f4 100644 --- a/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst +++ b/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst @@ -2,7 +2,7 @@ Sony Spresense ============== -.. tags:: chip:cxd56xx, chip:cxd5602 +.. tags:: arch:arm, chip:cxd56xx, part:cxd5602, vendor:sony The `Spresense `_ is a compact development board based on Sony's power-efficient multicore microcontroller diff --git a/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst b/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst index c3acef98ad1..9a61f36a28f 100644 --- a/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst +++ b/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst @@ -2,6 +2,8 @@ ntosd-dm320 =========== +.. tags:: arch:arm, chip:dm320, vendor:ti + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst b/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst index 67eee38b145..a8f4293030e 100644 --- a/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst +++ b/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst @@ -2,6 +2,8 @@ efm32-g8xx-stk ============== +.. tags:: arch:arm, chip:efm32, vendor:silabs + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst b/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst index 3f50c3abc39..878d42ccc70 100644 --- a/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst +++ b/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst @@ -2,6 +2,8 @@ efm32gg-stk3700 =============== +.. tags:: arch:arm, chip:efm32, vendor:silabs + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst b/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst index 1fc86d6e194..7dd0bfe8e3a 100644 --- a/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst +++ b/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst @@ -2,6 +2,8 @@ olimex-efm32g880f128-stk ======================== +.. tags:: arch:arm, chip:efm32, vendor:silabs + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst b/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst index aa0e315ce9d..38ffceda2c0 100644 --- a/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst +++ b/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst @@ -2,6 +2,8 @@ quickfeather ============ +.. tags:: arch:arm, chip:eoss3, vendor:quicklogic + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst b/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst index cb692dcb6f0..4cdd4dc1f1b 100644 --- a/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst +++ b/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst @@ -2,6 +2,8 @@ fvp-armv8r-aarch32 ================== +.. tags:: arch:arm, chip:fvp-v8r-aarch32, vendor:arm + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-aiotbox/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-aiotbox/index.rst index 6a67c8d2cee..6848ffe3c22 100644 --- a/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-aiotbox/index.rst +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-aiotbox/index.rst @@ -2,6 +2,8 @@ gd32f450zk-aiotbox ================== +.. tags:: arch:arm, chip:gd32f4, vendor:gigadevice + The GD32F450Z-AIOTBOX board is a Xiaomi AIoT development platform U1 control board that uses the GD32F450ZK chip as the core. diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst index b82e40ad56d..da9a7a61114 100644 --- a/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst @@ -2,3 +2,5 @@ gd32f450zk-eval =============== +.. tags:: arch:arm, chip:gd32f4, vendor:gigadevice + diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst index d5e3070ad36..1978586f579 100644 --- a/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst @@ -2,3 +2,5 @@ gd32f470ik-eval =============== +.. tags:: arch:arm, chip:gd32f4, vendor:gigadevice + diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-aiotbox/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-aiotbox/index.rst index 334d193ff9c..b022ed9a25c 100644 --- a/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-aiotbox/index.rst +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-aiotbox/index.rst @@ -2,6 +2,8 @@ gd32f470zk-aiotbox ================== +.. tags:: arch:arm, chip:gd32f4, vendor:gigadevice + The GD32F470Z-AIOTBOX board is a Xiaomi AIoT development platform U1 control board that uses the GD32F470ZK chip as the core. diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst index ededb89ac36..3021829cda2 100644 --- a/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst @@ -2,6 +2,8 @@ gd32f470zk-eval =============== +.. tags:: arch:arm, chip:gd32f4, vendor:gigadevice + The GD32F470Z-EVAL board is a hardware platform that enables prototyping on GD32F470ZK Cortex-M4F Stretch Performance MCU. diff --git a/Documentation/platforms/arm/ht32f491x3/boards/esk32/index.rst b/Documentation/platforms/arm/ht32f491x3/boards/esk32/index.rst index e48509635c0..0b44efb30b7 100644 --- a/Documentation/platforms/arm/ht32f491x3/boards/esk32/index.rst +++ b/Documentation/platforms/arm/ht32f491x3/boards/esk32/index.rst @@ -2,7 +2,7 @@ ESK32 (HT32F49163) ================== -.. tags:: arch:arm, chip:ht32f491x3, chip:ht32f49163, vendor:holtek +.. tags:: arch:arm, chip:ht32f491x3, part:ht32f49163, vendor:holtek The ESK32 is a development board based on the Holtek HT32F49163 MCU. The current NuttX port targets the HT32F49163 device used on the diff --git a/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst b/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst index 75afab3d3f8..ae8c3c2ae81 100644 --- a/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst +++ b/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst @@ -2,5 +2,7 @@ sabre-6quad =========== +.. tags:: arch:arm, chip:imx6, vendor:nxp + This directory holds a port of NuttX to the NXP/Freescale Sabre board featuring the iMX 6Quad CPU. diff --git a/Documentation/platforms/arm/imx9/boards/imx93-qsb/index.rst b/Documentation/platforms/arm/imx9/boards/imx93-qsb/index.rst index 8df126b2b29..4b343e820db 100644 --- a/Documentation/platforms/arm/imx9/boards/imx93-qsb/index.rst +++ b/Documentation/platforms/arm/imx9/boards/imx93-qsb/index.rst @@ -2,7 +2,7 @@ IMX93QSB-M33 ============ -.. tags:: arch:arm, arch:armv8m, arch:cm33, chip:imx93, vendor:nxp +.. tags:: arch:arm, chip:imx9, part:imx93, vendor:nxp The IMX93-QSB board is a platform made by NXP, designed to show the most commonly used features of the `i.MX 93 applications processor `_. diff --git a/Documentation/platforms/arm/imx9/boards/imx95-evk/index.rst b/Documentation/platforms/arm/imx9/boards/imx95-evk/index.rst index 1d636638637..9125a83d3ec 100644 --- a/Documentation/platforms/arm/imx9/boards/imx95-evk/index.rst +++ b/Documentation/platforms/arm/imx9/boards/imx95-evk/index.rst @@ -2,6 +2,8 @@ IMX95LPD5EVK-19 =============== +.. tags:: arch:arm, chip:imx9, vendor:nxp + The IMX95LPD5EVK-19 board is a platform designed to show the most commonly used features of the `i.MX 95 automotive applications processor diff --git a/Documentation/platforms/arm/imx9/boards/mr-navq95b/index.rst b/Documentation/platforms/arm/imx9/boards/mr-navq95b/index.rst index e4469a9d6cf..6c3fa0700d0 100644 --- a/Documentation/platforms/arm/imx9/boards/mr-navq95b/index.rst +++ b/Documentation/platforms/arm/imx9/boards/mr-navq95b/index.rst @@ -2,7 +2,7 @@ MR-NAVQ95 ========= -.. tags:: chip:imx9, chip:imx95, vendor:nxp +.. tags:: arch:arm, chip:imx9, part:imx95, vendor:nxp The `MR-NAVQ95 `_ is an open-source development board designed for mobile robotics applications. diff --git a/Documentation/platforms/arm/imxrt/boards/arcx-socket-grid/index.rst b/Documentation/platforms/arm/imxrt/boards/arcx-socket-grid/index.rst index 6ed2c4d03a7..1278ddfbc5c 100644 --- a/Documentation/platforms/arm/imxrt/boards/arcx-socket-grid/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/arcx-socket-grid/index.rst @@ -2,6 +2,8 @@ ARCX Socket Grid ================ +.. tags:: arch:arm, chip:imxrt, vendor:nxp + The ARCX Socket Grid is an industrial board from ARCX. This boards uses the i.MX RT1052 crossover MCU with ARM Cortex M7 core. .. figure:: arc_socket_grid.jpg diff --git a/Documentation/platforms/arm/imxrt/boards/fmu-v6xrt/index.rst b/Documentation/platforms/arm/imxrt/boards/fmu-v6xrt/index.rst index f4af42f85a4..d7740f5be9b 100644 --- a/Documentation/platforms/arm/imxrt/boards/fmu-v6xrt/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/fmu-v6xrt/index.rst @@ -2,7 +2,7 @@ Holybro Pixhawk 6X-RT ===================== -.. tags:: chip:imxrt, chip:imxrt1176, vendor:holybro +.. tags:: arch:arm, chip:imxrt, part:imxrt1176, vendor:nxp .. figure:: pixhawk6x-rt.png :scale: 50 % diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst index 8bc1b955373..79bc82adeb1 100644 --- a/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst @@ -2,6 +2,8 @@ i.MX RT1020 EVK =============== +.. tags:: arch:arm, chip:imxrt, vendor:nxp + `i.MX RT1020 EVK `_ is an evaluation kit by NXP company. This kit uses the i.MX RT1020 crossover MCU in LQFP144 package with ARM Cortex M7 core. diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst index ad90ec80e52..12671b49aab 100644 --- a/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst @@ -2,6 +2,8 @@ i.MX RT1050 EVK =============== +.. tags:: arch:arm, chip:imxrt, vendor:nxp + `i.MX RT1050 EVK `_ is an evaluation kit by NXP company. This kit uses the i.MX RT1050 crossover MCU with ARM Cortex M7 core. diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst index 9668eb40b4d..36ac793a480 100644 --- a/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst @@ -2,6 +2,8 @@ i.MX RT1060 EVK =============== +.. tags:: arch:arm, chip:imxrt, vendor:nxp + `i.MX RT1060 EVK `_ is an evaluation kit by NXP company. This kit uses the i.MX RT1060 crossover MCU with ARM Cortex M7 core. diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst index 5a95b2c2231..7094525c393 100644 --- a/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst @@ -2,6 +2,8 @@ i.MX RT1064 EVK =============== +.. tags:: arch:arm, chip:imxrt, vendor:nxp + `i.MX RT1064 EVK `_ is an evaluation kit by NXP company. This kit uses the i.MX RT1064 crossover MCU with ARM Cortex M7 core. diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1170-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1170-evk/index.rst index db2916765d5..5ce272d6a5f 100644 --- a/Documentation/platforms/arm/imxrt/boards/imxrt1170-evk/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/imxrt1170-evk/index.rst @@ -2,6 +2,8 @@ i.MX RT1170 EVK =============== +.. tags:: arch:arm, chip:imxrt, vendor:nxp + `i.MX RT1170 EVK `_ is an evaluation kit by NXP company. This kit uses the i.MX RT1170 crossover MCU with ARM Cortex M7 core. diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1180-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1180-evk/index.rst index cc252883009..e275bc0ab04 100644 --- a/Documentation/platforms/arm/imxrt/boards/imxrt1180-evk/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/imxrt1180-evk/index.rst @@ -2,7 +2,7 @@ i.MX RT1180 EVK ================ -.. tags:: arch:arm, arch:armv7m, arch:armv8m, arch:cm7, arch:cm33, chip:imxrt, chip:imxrt1180, vendor:nxp, ethernet, usb +.. tags:: arch:arm, arch:armv7m, arch:armv8m, arch:cm7, arch:cm33, chip:imxrt, part:imxrt1180, vendor:nxp The `i.MX RT1180 EVK `_ diff --git a/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst b/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst index 14df038216f..156434ecc97 100644 --- a/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst +++ b/Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst @@ -2,6 +2,8 @@ Teensy-4.x ========== +.. tags:: arch:arm, chip:imxrt, vendor:nxp + The `Teensy 4.0 `_ and `Teensy 4.1 `_ are development boards from PJRC. Both boards use i.MX RT1060 MCU, feature several I/Os pins and on-board LED. diff --git a/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst b/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst index c0098c9f7db..49504308d59 100644 --- a/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst @@ -2,6 +2,8 @@ freedom-k28f ============ +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst b/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst index db8b634a3cb..d5dabd8fe68 100644 --- a/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst @@ -2,6 +2,8 @@ freedom-k64f ============ +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst b/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst index 88a651e1a02..008f000ed9e 100644 --- a/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst @@ -2,6 +2,8 @@ freedom-k66f ============ +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst b/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst index db43609dca3..169e069af82 100644 --- a/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst @@ -2,6 +2,8 @@ kwikstik-k40 ============ +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst b/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst index 13ff96550b3..a2c4d8890c9 100644 --- a/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst @@ -2,6 +2,8 @@ teensy-3.x ========== +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst b/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst index 2b39acc09aa..2a0f424606a 100644 --- a/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst @@ -2,6 +2,8 @@ twr-k60n512 =========== +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst b/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst index 5c788d60e46..300f14b1ab2 100644 --- a/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst +++ b/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst @@ -2,6 +2,8 @@ twr-k64f120m ============ +.. tags:: arch:arm, chip:kinetis, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst b/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst index 1beadcd4a5d..4eb25043662 100644 --- a/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst +++ b/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst @@ -2,5 +2,7 @@ freedom-kl25z ============= +.. tags:: arch:arm, chip:kl, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst b/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst index bd113dfadac..d77ad38a1dc 100644 --- a/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst +++ b/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst @@ -2,5 +2,7 @@ freedom-kl26z ============= +.. tags:: arch:arm, chip:kl, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst index feb20e78284..0f7f048aec7 100644 --- a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst +++ b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst @@ -2,6 +2,8 @@ teensy-lc ========= +.. tags:: arch:arm, chip:kl, vendor:nxp + This is the NuttX port for the PJRC Teensy LC board. The Teensy LC is a DIP-style breakout board for the MKL25Z64 and includes a USB-based bootloader. diff --git a/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst b/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst index 84b50c9d979..387fd4281d2 100644 --- a/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst +++ b/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst @@ -2,6 +2,8 @@ lc823450-xgevk ============== +.. tags:: arch:arm, chip:lc823450, vendor:onsemi + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/boards/lincoln60/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/lincoln60/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/lincoln60/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lincoln60/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/lincoln60/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/lincoln60/index.rst similarity index 57% rename from Documentation/platforms/arm/lpc17xx/boards/lincoln60/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lincoln60/index.rst index 14fe1e5eb79..a2440df2aaf 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/lincoln60/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/lincoln60/index.rst @@ -2,6 +2,8 @@ lincoln60 ========= +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc40xx/boards/lpc4088-devkit/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/lpc4088-devkit/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc40xx/boards/lpc4088-devkit/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lpc4088-devkit/README.txt diff --git a/Documentation/platforms/arm/lpc40xx/boards/lpc4088-quickstart/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/lpc4088-quickstart/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc40xx/boards/lpc4088-quickstart/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lpc4088-quickstart/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/lpcxpresso-lpc1768/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lpcxpresso-lpc1768/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/lpcxpresso-lpc1768/index.rst similarity index 65% rename from Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lpcxpresso-lpc1768/index.rst index e427ed88f2a..9afe39075bd 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/lpcxpresso-lpc1768/index.rst @@ -2,6 +2,8 @@ lpcxpresso-lpc1768 ================== +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/lx_cpu/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc40xx/boards/lx_cpu/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lx_cpu/README.txt diff --git a/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/lx_cpu/index.rst similarity index 83% rename from Documentation/platforms/arm/lpc40xx/boards/lx_cpu/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/lx_cpu/index.rst index 92bacd1c227..fc07ee15be4 100644 --- a/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/lx_cpu/index.rst @@ -2,6 +2,8 @@ lx_cpu ====== +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + This port uses the PiKRON ``LX_CPU`` board. See the http://www.pikron.com/pages/products/cpu_boards/lx_cpu.html for further information. This board features the NXP LPC4088 (compatible with diff --git a/Documentation/platforms/arm/lpc17xx/boards/mbed/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/mbed/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/mbed/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/mbed/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/mbed/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/mbed/index.rst similarity index 81% rename from Documentation/platforms/arm/lpc17xx/boards/mbed/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/mbed/index.rst index d4545c23364..54f96770662 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/mbed/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/mbed/index.rst @@ -2,6 +2,8 @@ mbed ==== +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + The configurations in this directory support the mbed board (http://mbed.org) that features the NXP LPC1768 microcontroller. This OS is also built with the arm-nuttx-elf toolchain*. STATUS: Contributed. diff --git a/Documentation/platforms/arm/lpc17xx/boards/mcb1700/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/mcb1700/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/mcb1700/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/mcb1700/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/mcb1700/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/mcb1700/index.rst similarity index 55% rename from Documentation/platforms/arm/lpc17xx/boards/mcb1700/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/mcb1700/index.rst index 172f39d2994..d3ad8ff5571 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/mcb1700/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/mcb1700/index.rst @@ -2,6 +2,8 @@ mcb1700 ======= +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/index.rst similarity index 64% rename from Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/index.rst index 3bb6bcbd803..9eb7abeedac 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/index.rst @@ -2,6 +2,8 @@ olimex-lpc1766stk ================= +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/boards/open1788/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/open1788/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/open1788/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/open1788/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/open1788/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/open1788/index.rst similarity index 56% rename from Documentation/platforms/arm/lpc17xx/boards/open1788/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/open1788/index.rst index 6b8a34bccc0..fdda27abe48 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/open1788/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/open1788/index.rst @@ -2,6 +2,8 @@ open1788 ======== +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/pnev5180b/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/pnev5180b/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/pnev5180b/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/pnev5180b/index.rst similarity index 57% rename from Documentation/platforms/arm/lpc17xx/boards/pnev5180b/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/pnev5180b/index.rst index 73297524218..769a3ec8c6c 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/pnev5180b/index.rst @@ -2,6 +2,8 @@ pnev5180b ========= +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/u-blox-c027/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/u-blox-c027/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/u-blox-c027/index.rst similarity index 59% rename from Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/u-blox-c027/index.rst index 68e90225c6e..5714ae36377 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/u-blox-c027/index.rst @@ -2,6 +2,8 @@ u-blox-c027 =========== +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/README.txt b/Documentation/platforms/arm/lpc17xx_40xx/boards/zkit-arm-1769/README.txt similarity index 100% rename from Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/README.txt rename to Documentation/platforms/arm/lpc17xx_40xx/boards/zkit-arm-1769/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/boards/zkit-arm-1769/index.rst similarity index 61% rename from Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/boards/zkit-arm-1769/index.rst index ec9b2c9dd0e..975370887f6 100644 --- a/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/boards/zkit-arm-1769/index.rst @@ -2,6 +2,8 @@ zkit-arm-1769 ============= +.. tags:: arch:arm, chip:lpc17xx_40xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc17xx/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/index.rst similarity index 99% rename from Documentation/platforms/arm/lpc17xx/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/index.rst index b23de7452e0..f31eaaf13ba 100644 --- a/Documentation/platforms/arm/lpc17xx/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/index.rst @@ -171,6 +171,11 @@ website. Supported Boards ================ +.. toctree:: + :hidden: + + lpc40xx.rst + .. toctree:: :glob: :maxdepth: 1 diff --git a/Documentation/platforms/arm/lpc40xx/index.rst b/Documentation/platforms/arm/lpc17xx_40xx/lpc40xx.rst similarity index 90% rename from Documentation/platforms/arm/lpc40xx/index.rst rename to Documentation/platforms/arm/lpc17xx_40xx/lpc40xx.rst index e04cf2f7252..28977a072b6 100644 --- a/Documentation/platforms/arm/lpc40xx/index.rst +++ b/Documentation/platforms/arm/lpc17xx_40xx/lpc40xx.rst @@ -15,9 +15,3 @@ board may be configured to use either the LPC4088 or the LPC1788. Supported Boards ================ - -.. toctree:: - :glob: - :maxdepth: 1 - - boards/*/* diff --git a/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst b/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst index 7d7e1579766..cb8d6b3f4bf 100644 --- a/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst +++ b/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst @@ -2,6 +2,8 @@ mcu123-lpc214x ============== +.. tags:: arch:arm, chip:lpc214x, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst b/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst index 2ceaf4b03a6..54e470099c6 100644 --- a/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst +++ b/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst @@ -2,6 +2,8 @@ zp214xpa ======== +.. tags:: arch:arm, chip:lpc214x, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst index f73017812b8..bedbac1d7f1 100644 --- a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst +++ b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst @@ -2,6 +2,8 @@ olimex-lpc2378 ============== +.. tags:: arch:arm, chip:lpc2378, vendor:nxp + The Olimex LPC2378 board has only a small amount of board-specific porting information recorded in the original notes. diff --git a/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst b/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst index 3cf2eed93e2..9579ebfcdcc 100644 --- a/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst +++ b/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst @@ -2,6 +2,8 @@ EA3131 ====== +.. tags:: arch:arm, chip:lpc31xx, vendor:nxp + This documentation discusses the port of NuttX to the Embedded Artists EA3131 board. Development Environment @@ -629,7 +631,7 @@ pgnsh ----- This is the same configuration as nsh, but with On-Demand paging enabled. See -https://nuttx.apache.org/docs/latest/components/paging.html. This configuration +https://nuttx.apache.org/docs/latest/os/memory/paging.html. This configuration is an experiment for the purposes of test and debug. At present, this does not produce functioning, usable system diff --git a/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst b/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst index a5ec8f65867..5c704fa595b 100644 --- a/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst +++ b/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst @@ -2,6 +2,8 @@ EA3152 ====== +.. tags:: arch:arm, chip:lpc31xx, vendor:nxp + This documentation discusses the port of NuttX to the Embedded Artists EA3152 board. diff --git a/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst b/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst index 44346a59ace..fcc77e2e321 100644 --- a/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst +++ b/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst @@ -2,6 +2,8 @@ Olimex LPC-H3131 ================ +.. tags:: arch:arm, chip:lpc31xx, vendor:nxp + This documentation discusses the port of NuttX to the Olimex LPC-H3131 board. .. note:: diff --git a/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst b/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst index fed62aa831d..720165b313b 100644 --- a/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst +++ b/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst @@ -2,6 +2,8 @@ lpc4370-link2 ============= +.. tags:: arch:arm, chip:lpc43xx, vendor:nxp + NuttX port to the NXP LPC4370-Link2 development board featuring the NXP LPC4370FET100 MCU. Based on the LPC4300 Xplorer port and provided by Lok Tep. diff --git a/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst b/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst index 2b15a8b3bfd..de380416d30 100644 --- a/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst +++ b/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst @@ -2,6 +2,8 @@ lpcxpresso-lpc54628 =================== +.. tags:: arch:arm, chip:lpc54xx, vendor:nxp + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst b/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst index 61d39a0c0a0..0cf4d1a1c9c 100644 --- a/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst +++ b/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst @@ -2,6 +2,8 @@ max32660-evsys ============== +.. tags:: arch:arm, chip:max326xx, vendor:maxim + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/moxart/boards/moxa/index.rst b/Documentation/platforms/arm/moxart/boards/moxa/index.rst index 7fb52614acc..b833692a75f 100644 --- a/Documentation/platforms/arm/moxart/boards/moxa/index.rst +++ b/Documentation/platforms/arm/moxart/boards/moxa/index.rst @@ -2,6 +2,8 @@ moxa ==== +.. tags:: arch:arm, chip:moxart, vendor:moxa + Configurations ============== diff --git a/Documentation/platforms/arm/mps/boards/mps2-an500/index.rst b/Documentation/platforms/arm/mps/boards/mps2-an500/index.rst index 81caaf47145..a711132e127 100644 --- a/Documentation/platforms/arm/mps/boards/mps2-an500/index.rst +++ b/Documentation/platforms/arm/mps/boards/mps2-an500/index.rst @@ -2,6 +2,8 @@ MPS2 AN500 Board ================ +.. tags:: arch:arm, chip:mps, vendor:arm + This board configuration will use QEMU to emulate generic ARM v7-M series hardware platform and provides support for these devices: diff --git a/Documentation/platforms/arm/mps/boards/mps2-an512/index.rst b/Documentation/platforms/arm/mps/boards/mps2-an521/index.rst similarity index 96% rename from Documentation/platforms/arm/mps/boards/mps2-an512/index.rst rename to Documentation/platforms/arm/mps/boards/mps2-an521/index.rst index 37bb9bcfc0b..0336af2756f 100644 --- a/Documentation/platforms/arm/mps/boards/mps2-an512/index.rst +++ b/Documentation/platforms/arm/mps/boards/mps2-an521/index.rst @@ -2,6 +2,8 @@ MPS2 AN521 Board ================ +.. tags:: arch:arm, chip:mps, vendor:arm + This board configuration will use QEMU to emulate generic ARM v8-M series hardware platform and provides support for these devices: diff --git a/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst b/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst index c94822557d8..6de171b9db8 100644 --- a/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst +++ b/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst @@ -2,6 +2,8 @@ MPS3 AN547 Board ================ +.. tags:: arch:arm, chip:mps, vendor:arm + The MPS3 AN547 board configuration uses QEMU to emulate a generic ARM v8-M series hardware platform and provides support for the following devices: diff --git a/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst b/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst index 2450f36fb99..cae32e7175a 100644 --- a/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst +++ b/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst @@ -2,6 +2,8 @@ verdin-mx8mp ============= +.. tags:: arch:arm, chip:mx8mp, vendor:nxp + This directory provides board support for the Toradex Verdin i.MX8MP. This port runs on the internal Cortex-M7 auxiliary core, not on the main Cortex-A53 complex. diff --git a/Documentation/platforms/arm/n32h7/boards/n32h762iil7/index.rst b/Documentation/platforms/arm/n32h7/boards/n32h762iil7/index.rst index f4dd3ca30bc..688b3eda271 100644 --- a/Documentation/platforms/arm/n32h7/boards/n32h762iil7/index.rst +++ b/Documentation/platforms/arm/n32h7/boards/n32h762iil7/index.rst @@ -2,7 +2,7 @@ N32H762IIL7 Development Board ============================= -.. tags:: chip:n32h762, arch:armv7e-m, vendor:nations +.. tags:: arch:arm, arch:armv7e-m, chip:n32h7, part:n32h762, vendor:nations .. figure:: n32h762iil7.png :scale: 30 % diff --git a/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble-rev2/index.rst b/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble-rev2/index.rst index 2d8317b9b1c..ca11442b116 100644 --- a/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble-rev2/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble-rev2/index.rst @@ -2,7 +2,7 @@ Arduino Nano 33 BLE Sense Rev2 ============================== -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `Arduino Nano 33 BLE Sense Rev2 `_ is a development board for the nRF52832 SoC from Arduino. diff --git a/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble/index.rst b/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble/index.rst index 5feab11f5c0..21159a21d2c 100644 --- a/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/arduino-nano-33ble/index.rst @@ -2,7 +2,7 @@ Arduino Nano 33 BLE Sense ========================= -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `Arduino Nano 33 BLE Sense `_ is a development board for the nRF52832 SoC from Arduino. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52-feather/intex.rst b/Documentation/platforms/arm/nrf52/boards/nrf52-feather/index.rst similarity index 96% rename from Documentation/platforms/arm/nrf52/boards/nrf52-feather/intex.rst rename to Documentation/platforms/arm/nrf52/boards/nrf52-feather/index.rst index 9f9d101b0b7..03fd479ecc0 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf52-feather/intex.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf52-feather/index.rst @@ -2,7 +2,7 @@ Adafruit NRF52 Feather ====================== -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `Adafruit NRF52 Feather `_ is a development board for the nRF52832 SoC from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52832-dk/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf52832-dk/index.rst index 124f8ff4e30..070dd8943f9 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf52832-dk/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf52832-dk/index.rst @@ -2,7 +2,7 @@ nRF52832-DK =========== -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `NRF52832-DK (PCA10040) `_ is a development board for the nRF52832 SoC from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/index.rst index e5cb7bed495..ff291dd45a8 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf52832-mdk/index.rst @@ -2,7 +2,7 @@ MakerDiary nRF52832-MDK ======================= -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `nRF52832-MDK `_ is a development board for the nRF52832 SoC from Nordic. It features 24 I/Os an on-board RGB led and a chip antenna. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52832-sparkfun/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf52832-sparkfun/index.rst index fc7762de2cd..da0ac00278a 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf52832-sparkfun/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf52832-sparkfun/index.rst @@ -2,7 +2,7 @@ Sparkfun nRF52832 Breakout ========================== -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `Sparkfun nRF52832 Breakout `_ is basic board providing access to all I/O pins, a 32kHz crystal and LED. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52840-dk/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf52840-dk/index.rst index 43e93e1ab6a..176d49be7d9 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf52840-dk/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf52840-dk/index.rst @@ -4,7 +4,7 @@ nRF52840-DK =========== -.. tags:: chip:nrf52, chip:nrf52840 +.. tags:: arch:arm, chip:nrf52, part:nrf52840, vendor:nordic The `NRF52840-DK (PCA10056) `_ is a development board for the nRF52840 SoC from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf52840-dongle/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf52840-dongle/index.rst index 77f653b95be..468f7704923 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf52840-dongle/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf52840-dongle/index.rst @@ -2,7 +2,7 @@ nRF52840-dongle =============== -.. tags:: chip:nrf52, chip:nrf52840 +.. tags:: arch:arm, chip:nrf52, part:nrf52840, vendor:nordic The `nRF52840-dongle (PCA10059) `_ is a a small, low-cost USB dongle based on nRF52840 from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/nrf9160-dk-nrf52/index.rst b/Documentation/platforms/arm/nrf52/boards/nrf9160-dk-nrf52/index.rst index dd2d8d5573f..c65da83a30f 100644 --- a/Documentation/platforms/arm/nrf52/boards/nrf9160-dk-nrf52/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/nrf9160-dk-nrf52/index.rst @@ -2,7 +2,7 @@ Nordic nRF9160 DK (nRF52840) ============================ -.. tags:: chip:nrf52, chip:nrf91, chip:nrf52840, chip:nrf9160 +.. tags:: arch:arm, chip:nrf52, chip:nrf91, part:nrf52840, part:nrf9160, vendor:nordic The `nRF9160-DK (PCA10090) `_ is a development board based on the nRF9160 and nRF52840 from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/thingy52/index.rst b/Documentation/platforms/arm/nrf52/boards/thingy52/index.rst index 9c538c9659a..fea73cfe74d 100644 --- a/Documentation/platforms/arm/nrf52/boards/thingy52/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/thingy52/index.rst @@ -2,7 +2,7 @@ Nordic Thingy:52 ================= -.. tags:: chip:nrf52, chip:nrf52832 +.. tags:: arch:arm, chip:nrf52, part:nrf52832, vendor:nordic The `Thingy:52 (PCA20020) `_ is a prototyping platform build around the nRF52832 from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/thingy91-nrf52/index.rst b/Documentation/platforms/arm/nrf52/boards/thingy91-nrf52/index.rst index 5856a5024e4..799a36995b0 100644 --- a/Documentation/platforms/arm/nrf52/boards/thingy91-nrf52/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/thingy91-nrf52/index.rst @@ -2,7 +2,7 @@ Nordic Thingy:91 (nRF52840) =========================== -.. tags:: chip:nrf52, chip:nrf52840 +.. tags:: arch:arm, chip:nrf52, part:nrf52840, vendor:nordic The `Thingy:91 (PCA0035) `_ is a development board based on the nRF9160 and nRF52840 from Nordic. diff --git a/Documentation/platforms/arm/nrf52/boards/xiao-nrf52840/index.rst b/Documentation/platforms/arm/nrf52/boards/xiao-nrf52840/index.rst index 17ef935968d..14e2406bf57 100644 --- a/Documentation/platforms/arm/nrf52/boards/xiao-nrf52840/index.rst +++ b/Documentation/platforms/arm/nrf52/boards/xiao-nrf52840/index.rst @@ -2,7 +2,7 @@ Seeed Studio XIAO nRF52840 ========================== -.. tags:: chip:nrf52, chip:nrf52840 +.. tags:: arch:arm, chip:nrf52, part:nrf52840, vendor:nordic The `Seeed Studio XIAO nRF52840 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Nordic nRF52840 ecosystem as they share the same MCU. diff --git a/Documentation/platforms/arm/nrf53/boards/nrf5340-audio-dk/index.rst b/Documentation/platforms/arm/nrf53/boards/nrf5340-audio-dk/index.rst index fde198db267..f96425e15d6 100644 --- a/Documentation/platforms/arm/nrf53/boards/nrf5340-audio-dk/index.rst +++ b/Documentation/platforms/arm/nrf53/boards/nrf5340-audio-dk/index.rst @@ -2,7 +2,7 @@ Nordic nRF5340-Audio-DK ======================= -.. tags:: chip:nrf53, chip:nrf5340 +.. tags:: arch:arm, chip:nrf53, part:nrf5340, vendor:nordic The `nRF5340-Audio-DK `_ is a development kit dedicated for Bluetooth LE Audio application based on the nRF5340 from Nordic. diff --git a/Documentation/platforms/arm/nrf53/boards/nrf5340-dk/index.rst b/Documentation/platforms/arm/nrf53/boards/nrf5340-dk/index.rst index 74a93163bd4..393610b3ad3 100644 --- a/Documentation/platforms/arm/nrf53/boards/nrf5340-dk/index.rst +++ b/Documentation/platforms/arm/nrf53/boards/nrf5340-dk/index.rst @@ -2,7 +2,7 @@ Nordic nRF5340 DK ================= -.. tags:: chip:nrf53, chip:nrf5340 +.. tags:: arch:arm, chip:nrf53, part:nrf5340, vendor:nordic The `nRF5340-DK (PCA10092) `_ is a development board based on the nRF5340 from Nordic. diff --git a/Documentation/platforms/arm/nrf53/boards/thingy53/index.rst b/Documentation/platforms/arm/nrf53/boards/thingy53/index.rst index 8f903b1a50a..534f828653f 100644 --- a/Documentation/platforms/arm/nrf53/boards/thingy53/index.rst +++ b/Documentation/platforms/arm/nrf53/boards/thingy53/index.rst @@ -2,7 +2,7 @@ Nordic Thingy:53 ================ -.. tags:: chip:nrf53, chip:nrf5340 +.. tags:: arch:arm, chip:nrf53, part:nrf5340, vendor:nordic The `Thingy:53 (PCA20053) `_ is a prototyping platform build around the nRF5340 from Nordic. diff --git a/Documentation/platforms/arm/nrf91/boards/nrf9160-dk/index.rst b/Documentation/platforms/arm/nrf91/boards/nrf9160-dk/index.rst index ccae7a72ccf..58bf14202eb 100644 --- a/Documentation/platforms/arm/nrf91/boards/nrf9160-dk/index.rst +++ b/Documentation/platforms/arm/nrf91/boards/nrf9160-dk/index.rst @@ -2,7 +2,7 @@ Nordic nRF9160 DK (nRF9160) =========================== -.. tags:: chip:nrf91, chip:nrf9160 +.. tags:: arch:arm, chip:nrf91, part:nrf9160, vendor:nordic The `nRF9160-DK (PCA10090) `_ is a development board based on the nRF9160 and nRF52840 from Nordic. diff --git a/Documentation/platforms/arm/nrf91/boards/thingy91/index.rst b/Documentation/platforms/arm/nrf91/boards/thingy91/index.rst index 2af89956ef3..bbb01bf4f38 100644 --- a/Documentation/platforms/arm/nrf91/boards/thingy91/index.rst +++ b/Documentation/platforms/arm/nrf91/boards/thingy91/index.rst @@ -2,7 +2,7 @@ Nordic Thingy:91 ================= -.. tags:: chip:nrf91, chip:nrf52, chip:nrf9160, chip:nrf52840 +.. tags:: arch:arm, chip:nrf52, chip:nrf91, part:nrf52840, part:nrf9160, vendor:nordic The `Thingy:91 (PCA0035) `_ is a development board based on the nRF9160 and nRF52840 from Nordic. diff --git a/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst b/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst index 9af617a40ad..7a69d20f807 100644 --- a/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst +++ b/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst @@ -2,6 +2,8 @@ nutiny-nuc120 ============= +.. tags:: arch:arm, chip:nuc1xx, vendor:nuvoton + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst b/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst index e05d481e13d..87b07789f44 100644 --- a/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst +++ b/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst @@ -2,3 +2,5 @@ phy62222 ======== +.. tags:: arch:arm, chip:phy62xx, vendor:phyplus + diff --git a/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst b/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst index 073b55a8c73..b07dc17dfd4 100644 --- a/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst +++ b/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst @@ -2,6 +2,8 @@ qemu-armv7a =========== +.. tags:: arch:arm, chip:qemu + This board configuration will use QEMU to emulate generic ARM v7-A series hardware platform and provides support for these devices: diff --git a/Documentation/platforms/arm/qemu/boards/qemu-armv7r/index.rst b/Documentation/platforms/arm/qemu/boards/qemu-armv7r/index.rst index 39800ee33fc..11440403d93 100644 --- a/Documentation/platforms/arm/qemu/boards/qemu-armv7r/index.rst +++ b/Documentation/platforms/arm/qemu/boards/qemu-armv7r/index.rst @@ -2,6 +2,8 @@ qemu-armv7r =========== +.. tags:: arch:arm, chip:qemu + This board configuration will use QEMU to emulate generic ARM v7-R series hardware platform and provides support for these devices: diff --git a/Documentation/platforms/arm/ra4m1/boards/arduino-r4-minima/arduino-r4-minima.png b/Documentation/platforms/arm/ra4/boards/arduino-r4-minima/arduino-r4-minima.png similarity index 100% rename from Documentation/platforms/arm/ra4m1/boards/arduino-r4-minima/arduino-r4-minima.png rename to Documentation/platforms/arm/ra4/boards/arduino-r4-minima/arduino-r4-minima.png diff --git a/Documentation/platforms/arm/ra4m1/boards/arduino-r4-minima/index.rst b/Documentation/platforms/arm/ra4/boards/arduino-r4-minima/index.rst similarity index 99% rename from Documentation/platforms/arm/ra4m1/boards/arduino-r4-minima/index.rst rename to Documentation/platforms/arm/ra4/boards/arduino-r4-minima/index.rst index 3acbb58d9c9..b5fc9f62f6c 100644 --- a/Documentation/platforms/arm/ra4m1/boards/arduino-r4-minima/index.rst +++ b/Documentation/platforms/arm/ra4/boards/arduino-r4-minima/index.rst @@ -2,6 +2,8 @@ Arduino R4 Minima ================= +.. tags:: arch:arm, chip:ra4, vendor:renesas + This board features the R7FA4M1ABxCFM MCU with 256 KiB of FLASH and 32 KiB of SRAM running at 64 MHz (internal clock - HOCO). diff --git a/Documentation/platforms/arm/ra4m1/boards/xiao-ra4m1/index.rst b/Documentation/platforms/arm/ra4/boards/xiao-ra4m1/index.rst similarity index 98% rename from Documentation/platforms/arm/ra4m1/boards/xiao-ra4m1/index.rst rename to Documentation/platforms/arm/ra4/boards/xiao-ra4m1/index.rst index 038008053ab..004eaf9ca79 100644 --- a/Documentation/platforms/arm/ra4m1/boards/xiao-ra4m1/index.rst +++ b/Documentation/platforms/arm/ra4/boards/xiao-ra4m1/index.rst @@ -2,6 +2,8 @@ Seeed Studio XIAO RA4M1 ======================= +.. tags:: arch:arm, chip:ra4, vendor:renesas + The `Seeed Studio XIAO RA4M1 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Renesas RA4M1 ecosystem, sharing the same MCU as Arduino R4 Minima (R7FA4M1AB3CFM). diff --git a/Documentation/platforms/arm/ra4m1/boards/xiao-ra4m1/xiao-ra4m1.jpg b/Documentation/platforms/arm/ra4/boards/xiao-ra4m1/xiao-ra4m1.jpg similarity index 100% rename from Documentation/platforms/arm/ra4m1/boards/xiao-ra4m1/xiao-ra4m1.jpg rename to Documentation/platforms/arm/ra4/boards/xiao-ra4m1/xiao-ra4m1.jpg diff --git a/Documentation/platforms/arm/ra4m1/index.rst b/Documentation/platforms/arm/ra4/index.rst similarity index 100% rename from Documentation/platforms/arm/ra4m1/index.rst rename to Documentation/platforms/arm/ra4/index.rst diff --git a/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst b/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst index e45965ef915..06418ba5435 100644 --- a/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst @@ -2,7 +2,7 @@ Adafruit Feather RP2040 ======================= -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The Feather RP2040 is a general purpose RP2040 board supplied by Adafruit. diff --git a/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst b/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst index df74c0509b9..48ab1d7cc24 100644 --- a/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst @@ -2,7 +2,7 @@ Adafruit KB2040 Kee Boar ======================== -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The KB2040 Kee Boar is a general purpose RP2040 board supplied by Adafruit. diff --git a/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst b/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst index 5feb8f834fc..24ff8b26c6c 100644 --- a/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst @@ -2,7 +2,7 @@ Adafruit QT Py RP2040 ======================= -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The QT Py RP2040 is a tiny general purpose RP2040 board supplied by Adafruit. diff --git a/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst b/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst index e74233763e6..1e3f93fda5a 100644 --- a/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst @@ -2,7 +2,7 @@ Pimoroni Tiny2040 ================= -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The Tiny2040 is a general purpose RP2040 board supplied by Pimoroni. diff --git a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst index 36e80d3ef3f..b69fa64490d 100644 --- a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst @@ -2,7 +2,7 @@ Raspberry Pi Pico W =============================== -.. tags:: chip:rp2040, wifi +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The `Raspberry Pi Pico `_ is a general purpose board supplied by Raspberry Pi. The W variant adds built in WiFi and Bluetooth communications. diff --git a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst index 5f8ac2f0fc4..1b24c5a0566 100644 --- a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst @@ -2,7 +2,7 @@ Raspberry Pi Pico =============================== -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The `Raspberry Pi Pico `_ is a general purpose board supplied by Raspberry Pi. diff --git a/Documentation/platforms/arm/rp2040/boards/seeed-xiao-rp2040/index.rst b/Documentation/platforms/arm/rp2040/boards/seeed-xiao-rp2040/index.rst index 7aa09920afe..534e415cdfe 100644 --- a/Documentation/platforms/arm/rp2040/boards/seeed-xiao-rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/seeed-xiao-rp2040/index.rst @@ -2,7 +2,7 @@ Seeed Studio XIAO RP2040 ======================== -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The `Seeed Studio Xiao RP2040 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Raspberry Pi RP2040 ecosystem as they share the same RP2040 chip. diff --git a/Documentation/platforms/arm/rp2040/boards/w5500-evb-pico/index.rst b/Documentation/platforms/arm/rp2040/boards/w5500-evb-pico/index.rst index bd67d7c7126..d32700d0cfc 100644 --- a/Documentation/platforms/arm/rp2040/boards/w5500-evb-pico/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/w5500-evb-pico/index.rst @@ -2,7 +2,7 @@ W5500-EVB-Pico =============================== -.. tags:: chip:rp2040, ethernet +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The `W5500-EVB-Pico `_ is a microcontroller evaluation board based on the Raspberry Pi RP2040 and fully diff --git a/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst index b85132465d5..6054ca38795 100644 --- a/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst @@ -2,7 +2,7 @@ Waveshare RP2040 LCD 1.28 =============================== -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The `Waveshare RP2040 LCD 1.28 `_ is a low-cost, high-performance MCU board designed by Waveshare based on RP2040 diff --git a/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-zero/index.rst b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-zero/index.rst index 8fc5e5531f0..9152ea9d58c 100644 --- a/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-zero/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-zero/index.rst @@ -2,7 +2,7 @@ Waveshare RP2040 Zero =============================== -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi The `Waveshare RP2040 Zero `_ is a general purpose board supplied by Waveshare. diff --git a/Documentation/platforms/arm/rp2040/index.rst b/Documentation/platforms/arm/rp2040/index.rst index 25dc7df4af1..64f10eb08d1 100644 --- a/Documentation/platforms/arm/rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/index.rst @@ -2,7 +2,7 @@ Raspberry Pi rp2040 =================== -.. tags:: chip:rp2040 +.. tags:: arch:arm, chip:rp2040, vendor:raspberry-pi .. figure:: rp2040.png :align: center diff --git a/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-2-plus/index.rst b/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-2-plus/index.rst index 8269cc7788c..e24530a933b 100644 --- a/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-2-plus/index.rst +++ b/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-2-plus/index.rst @@ -2,7 +2,7 @@ Pimoroni Pico Plus 2 =============================== -.. tags:: chip:rp2350 +.. tags:: arch:arm, chip:rp23xx, part:rp2350, vendor:raspberry-pi The `Pimoroni Pico Plus 2 `_ is an RP2350B based board in the Raspberry Pi Pico form factor, with a @@ -182,4 +182,4 @@ xipfs-nxflat Same as ``xipfs``, plus the NXFLAT execute-in-place demo. Building this configuration requires ``ldnxflat``, which is not part of a standard -toolchain installation; see :doc:`/components/nxflat`. +toolchain installation; see :doc:`/os/binfmt/nxflat`. diff --git a/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-plus-2-w/index.rst b/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-plus-2-w/index.rst index 28eb3e74a99..44ec7aa184c 100644 --- a/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-plus-2-w/index.rst +++ b/Documentation/platforms/arm/rp23xx/boards/pimoroni-pico-plus-2-w/index.rst @@ -2,7 +2,7 @@ Pimoroni Pico Plus 2 W ====================== -.. tags:: chip:rp2350, chip:rp2350b, wifi +.. tags:: arch:arm, chip:rp23xx, part:rp2350, part:rp2350b, vendor:raspberry-pi The `Pimoroni Pico Plus 2 W `_ is a Raspberry Pi Pico form-factor board built around the RP2350B -- the 80-pin diff --git a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst index d0d7ede845c..aa2acae6f7e 100644 --- a/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst +++ b/Documentation/platforms/arm/rp23xx/boards/raspberrypi-pico-2/index.rst @@ -2,7 +2,7 @@ Raspberry Pi Pico 2 =============================== -.. tags:: chip:rp2350 +.. tags:: arch:arm, chip:rp23xx, part:rp2350, vendor:raspberry-pi The `Raspberry Pi Pico 2 `_ is a general purpose board supplied by Raspberry Pi. diff --git a/Documentation/platforms/arm/rp23xx/boards/xiao-rp2350/index.rst b/Documentation/platforms/arm/rp23xx/boards/xiao-rp2350/index.rst index ed8bd6b5b04..3d50e9c18f7 100644 --- a/Documentation/platforms/arm/rp23xx/boards/xiao-rp2350/index.rst +++ b/Documentation/platforms/arm/rp23xx/boards/xiao-rp2350/index.rst @@ -2,7 +2,7 @@ Seeed Studio XIAO RP2350 ========================== -.. tags:: chip:rp2350 +.. tags:: arch:arm, chip:rp23xx, part:rp2350, vendor:raspberry-pi The `Seeed Studio XIAO RP2350 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Raspberry Pi RP2350 ecosystem, sharing the same MCU as Raspberry Pi Pico 2. diff --git a/Documentation/platforms/arm/rp23xx/index.rst b/Documentation/platforms/arm/rp23xx/index.rst index cf1142c46bc..0e8c9df7754 100644 --- a/Documentation/platforms/arm/rp23xx/index.rst +++ b/Documentation/platforms/arm/rp23xx/index.rst @@ -2,7 +2,7 @@ Raspberry Pi rp2350 =================== -.. tags:: chip:rp2350 +.. tags:: arch:arm, chip:rp23xx, part:rp2350, vendor:raspberry-pi The rp2350 is a dual core chip produced by Raspberry Pi that is based on ARM Cortex-M33 or the Hazard3 RISC-V. diff --git a/Documentation/platforms/arm/rtl8720f/boards/rtl8720f_evb/index.rst b/Documentation/platforms/arm/rtl8720f/boards/rtl8720f_evb/index.rst index 703f73f9a8b..2ed01b32130 100644 --- a/Documentation/platforms/arm/rtl8720f/boards/rtl8720f_evb/index.rst +++ b/Documentation/platforms/arm/rtl8720f/boards/rtl8720f_evb/index.rst @@ -2,7 +2,7 @@ RTL8720F EVB ============ -.. tags:: chip:rtl8720f, arch:arm, vendor:realtek +.. tags:: arch:arm, chip:rtl8720f, vendor:realtek .. todo:: diff --git a/Documentation/platforms/arm/rtl8721dx/boards/pke8721daf/index.rst b/Documentation/platforms/arm/rtl8721dx/boards/pke8721daf/index.rst index 0565b1d1725..928d1b1b8a7 100644 --- a/Documentation/platforms/arm/rtl8721dx/boards/pke8721daf/index.rst +++ b/Documentation/platforms/arm/rtl8721dx/boards/pke8721daf/index.rst @@ -2,7 +2,7 @@ PKE8721DAF ========== -.. tags:: chip:rtl8721dx, arch:arm, vendor:realtek +.. tags:: arch:arm, chip:rtl8721dx, vendor:realtek .. figure:: PKE8721DAF.png :scale: 50 % diff --git a/Documentation/platforms/arm/rtl8721f/boards/rtl8721f_evb/index.rst b/Documentation/platforms/arm/rtl8721f/boards/rtl8721f_evb/index.rst index cfbc28429b2..be3213db2ec 100644 --- a/Documentation/platforms/arm/rtl8721f/boards/rtl8721f_evb/index.rst +++ b/Documentation/platforms/arm/rtl8721f/boards/rtl8721f_evb/index.rst @@ -2,7 +2,7 @@ RTL8721F EVB ============ -.. tags:: chip:rtl8721f, arch:arm, vendor:realtek +.. tags:: arch:arm, chip:rtl8721f, vendor:realtek .. figure:: rtl8721f_evb.png :scale: 50 % diff --git a/Documentation/platforms/arm/s32k1xx/boards/rddrone-bms772/index.rst b/Documentation/platforms/arm/s32k1xx/boards/rddrone-bms772/index.rst index 371db65f059..f1bbde0e29e 100644 --- a/Documentation/platforms/arm/s32k1xx/boards/rddrone-bms772/index.rst +++ b/Documentation/platforms/arm/s32k1xx/boards/rddrone-bms772/index.rst @@ -2,6 +2,8 @@ NXP RDDRONE-BMS772 ================== +.. tags:: arch:arm, chip:s32k1xx, vendor:nxp + `NXP RDDRONE-BMS772 `_ is a Battery Management System (BMS) reference design for mobile robotics, such as drones and rovers. Design files are available on the NXP website and may be used to develop your own BMS. RDDRONE-BMS772 is configurable and supports batteries of 3 to 6 cells, which it can monitor individually. The board features the `NXP S32K144 `_ MCU, which can monitor the `NXP MC33772B `_ Battery Cell Controller (BCC) and may communicates with the Vehicle Management Unit (VMU). When faults are detected the battery output can be disconnected to prevent further damage. Status information may be communicated over I2C/SMBus, CAN or NFC. NuttX contains basic board support RDDRONE-BMS772, which allows the S32K144 MCU to be initialized. A NuttX-compatible smart battery application for RDDRONE-BMS772 is also available. It contains additional drivers and example software to use most features of the battery management system. This application is currently published in a `separate repository `_, but (parts) may eventually be upstreamed to Apache NuttX. diff --git a/Documentation/platforms/arm/s32k1xx/boards/s32k118evb/index.rst b/Documentation/platforms/arm/s32k1xx/boards/s32k118evb/index.rst index cb35267674b..325dd05583e 100644 --- a/Documentation/platforms/arm/s32k1xx/boards/s32k118evb/index.rst +++ b/Documentation/platforms/arm/s32k1xx/boards/s32k118evb/index.rst @@ -2,6 +2,8 @@ NXP S32K118EVB ============== +.. tags:: arch:arm, chip:s32k1xx, vendor:nxp + NXP S32K118EVB-Q064 is an evaluation board for the `NXP S32K118 MCU `_ based on an Arm Cortex-M0+ core. Features diff --git a/Documentation/platforms/arm/s32k1xx/boards/s32k144evb/index.rst b/Documentation/platforms/arm/s32k1xx/boards/s32k144evb/index.rst index 2070172f4b1..09e69ad5a8f 100644 --- a/Documentation/platforms/arm/s32k1xx/boards/s32k144evb/index.rst +++ b/Documentation/platforms/arm/s32k1xx/boards/s32k144evb/index.rst @@ -2,6 +2,8 @@ NXP S32K144EVB ============== +.. tags:: arch:arm, chip:s32k1xx, vendor:nxp + `NXP S32K144EVB-Q100 `_ is an evaluation board for the `NXP S32K144 MCU `_ based on an Arm Cortex-M4F core. Features diff --git a/Documentation/platforms/arm/s32k1xx/boards/s32k146evb/index.rst b/Documentation/platforms/arm/s32k1xx/boards/s32k146evb/index.rst index 14433465fb6..1924ea053d7 100644 --- a/Documentation/platforms/arm/s32k1xx/boards/s32k146evb/index.rst +++ b/Documentation/platforms/arm/s32k1xx/boards/s32k146evb/index.rst @@ -2,6 +2,8 @@ NXP S32K146EVB ============== +.. tags:: arch:arm, chip:s32k1xx, vendor:nxp + `NXP S32K146EVB-Q144 `_ is an evaluation board for the `NXP S32K146 MCU `_ based on an Arm Cortex-M4F core. Features diff --git a/Documentation/platforms/arm/s32k1xx/boards/s32k148evb/index.rst b/Documentation/platforms/arm/s32k1xx/boards/s32k148evb/index.rst index 2e4dd182883..5dac099d42b 100644 --- a/Documentation/platforms/arm/s32k1xx/boards/s32k148evb/index.rst +++ b/Documentation/platforms/arm/s32k1xx/boards/s32k148evb/index.rst @@ -2,6 +2,8 @@ NXP S32K148EVB ============== +.. tags:: arch:arm, chip:s32k1xx, vendor:nxp + `NXP S32K148EVB-Q176 `_ is an evaluation board for the `NXP S32K148 MCU `_ based on an Arm Cortex-M4F core. Features diff --git a/Documentation/platforms/arm/s32k1xx/boards/ucans32k146/index.rst b/Documentation/platforms/arm/s32k1xx/boards/ucans32k146/index.rst index 8910249d3db..518a447384d 100644 --- a/Documentation/platforms/arm/s32k1xx/boards/ucans32k146/index.rst +++ b/Documentation/platforms/arm/s32k1xx/boards/ucans32k146/index.rst @@ -2,6 +2,8 @@ NXP UCANS32K146 =============== +.. tags:: arch:arm, chip:s32k1xx, vendor:nxp + `NXP UCANS32K146 `_ is a CAN Node reference design and development platform for mobile robotics applications, such as drones and rovers. It features the `NXP S32K146 MCU `_ based on an Arm Cortex-M4F core. There exist a few different revisions/variants of this board. All variants with the S32K146 microcontroller are supported. Features diff --git a/Documentation/platforms/arm/s32k3xx/boards/mr-canhubk3/index.rst b/Documentation/platforms/arm/s32k3xx/boards/mr-canhubk3/index.rst index 1c33d039570..fb808f80970 100644 --- a/Documentation/platforms/arm/s32k3xx/boards/mr-canhubk3/index.rst +++ b/Documentation/platforms/arm/s32k3xx/boards/mr-canhubk3/index.rst @@ -2,6 +2,8 @@ NXP MR-CANHUBK3 =============== +.. tags:: arch:arm, chip:s32k3xx, vendor:nxp + s a CAN Node reference design and development platform for mobile robotics applications, such as drones and rovers NXP MR-CANHUBK3 is a reference design and development platform for redundant networking and functional safety applications in Mobile Robotics, such as drones and rovers. It features the `NXP S32K344 MCU `_ based on a Arm Cortex-M7 core (Lock-Step). diff --git a/Documentation/platforms/arm/s32k3xx/boards/s32k344evb/index.rst b/Documentation/platforms/arm/s32k3xx/boards/s32k344evb/index.rst index 049a6e6a7d9..5745c1ffd5d 100644 --- a/Documentation/platforms/arm/s32k3xx/boards/s32k344evb/index.rst +++ b/Documentation/platforms/arm/s32k3xx/boards/s32k344evb/index.rst @@ -2,6 +2,8 @@ NXP S32K344EVB ============== +.. tags:: arch:arm, chip:s32k3xx, vendor:nxp + `NXP S32K3X4EVB-Q257 `_ is an evaluation board for the `NXP S32K344 MCU `_ based on a Arm Cortex-M7 core (Lock-Step). Features diff --git a/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst b/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst index f0780145452..6e03f1d2600 100644 --- a/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst +++ b/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst @@ -2,6 +2,8 @@ Arduino Due =========== +.. tags:: arch:arm, chip:sam34, vendor:microchip + This documentation discusses issues unique to NuttX configurations for the Arduino DUE board featuring the Atmel ATSAM3X8E MCU running at 84 MHz. diff --git a/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst b/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst index 9ea14be69b2..d02dfebe621 100644 --- a/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst +++ b/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst @@ -2,6 +2,8 @@ Flip&Click SAM3X ================ +.. tags:: arch:arm, chip:sam34, vendor:microchip + This documentation discusses issues unique to NuttX configurations for the Mikroe Flip&Click SAM3X board. This board is an Arduino-Due work-alike with four Mikroe Click bus interfaces. Like the Arduino-Due, this board features the Atmel diff --git a/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst b/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst index d8b4af05e9a..6374adf986d 100644 --- a/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst @@ -2,6 +2,8 @@ SAM3U-EK ======== +.. tags:: arch:arm, chip:sam34, vendor:microchip + This documentation discusses issues unique to NuttX configurations for the Atmel SAM3U-EK development board featuring the ATAM3U. This board features the ATSAM3U4E MCU running at 96MHz. diff --git a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst index c3e9ff73621..046d6e90db3 100644 --- a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst @@ -2,6 +2,8 @@ sam4cmp-db ========== +.. tags:: arch:arm, chip:sam34, vendor:microchip + README for the NuttX port to the SAM4CMP-DB board. The `SAM4CMP-DB `_ board is used diff --git a/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst b/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst index 41491dcc21f..e75ff860452 100644 --- a/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst @@ -2,6 +2,8 @@ SAM4E-EK ======== +.. tags:: arch:arm, chip:sam34, vendor:microchip + This README discusses issues unique to NuttX configurations for the Atmel SAM4E-EK development. This board features the SAM4E16 MCU running at 96 or 120MHz. diff --git a/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst b/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst index 05616a79b05..d61a813af93 100644 --- a/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst @@ -2,6 +2,8 @@ SAM4L Xplained ============== +.. tags:: arch:arm, chip:sam34, vendor:microchip + This documentation discusses issues unique to NuttX configurations for the Atmel SAM4L Xplained Pro development board. This board features the ATSAM4LC4C MCU. diff --git a/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst b/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst index 3f441871e3d..aec6c3b0794 100644 --- a/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst @@ -2,6 +2,8 @@ SAM4S Xplained Pro ================== +.. tags:: arch:arm, chip:sam34, vendor:microchip + This documentation discusses issues unique to NuttX configurations for the Atmel SAM4S Xplained development board. This board features the ATSAM4S32C MCU with 1MB FLASH and 128KB. diff --git a/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst b/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst index e7aa4bb0807..4572fcc6719 100644 --- a/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst @@ -2,6 +2,8 @@ SAM4S Xplained ============== +.. tags:: arch:arm, chip:sam34, vendor:microchip + This README discusses issues unique to NuttX configurations for the Atmel SAM4S Xplained development board. This board features the ATSAM4S16C MCU with 1MB FLASH and 128KB. diff --git a/Documentation/platforms/arm/sama5/boards/giant-board/index.rst b/Documentation/platforms/arm/sama5/boards/giant-board/index.rst index f0087dff257..df149202674 100644 --- a/Documentation/platforms/arm/sama5/boards/giant-board/index.rst +++ b/Documentation/platforms/arm/sama5/boards/giant-board/index.rst @@ -2,6 +2,8 @@ Groboards Giant Board ===================== +.. tags:: arch:arm, chip:sama5, vendor:microchip + This page file describes the port of NuttX to the Groboards Giant Board development board. This board features the Atmel SAMA5D27 microprocessor as a SIP with 128KB on-chip DDR2 RAM (part number `ATSAMA5D27C-D1G`). diff --git a/Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst b/Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst index c3cbdb69779..5df97f2e33c 100644 --- a/Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst +++ b/Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst @@ -2,6 +2,8 @@ Starcat Jupiter Nano ==================== +.. tags:: arch:arm, chip:sama5, vendor:microchip + This page file describes the port of NuttX to the Starcat Jupiter Nano development board. This board features the Atmel SAMA5D27 microprocessor as a SIP with 128KB on-chip LPDDR2 RAM (part number `ATSAMA5D27C-LD1G`). diff --git a/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst index 73e3b9260a4..29e64d3889c 100644 --- a/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst +++ b/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst @@ -2,6 +2,8 @@ sama5d2-xult ============ +.. tags:: arch:arm, chip:sama5, vendor:microchip + This is the port of NuttX to the Atmel SAMA5D3x-EK development boards (where x=1,3,4, or 5). These boards feature the Atmel SAMA5D3 microprocessors. Four different SAMA5D3x-EK kits are available diff --git a/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst index 72f4cd4a939..910828c3293 100644 --- a/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst +++ b/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst @@ -2,6 +2,8 @@ sama5d3-xplained ================ +.. tags:: arch:arm, chip:sama5, vendor:microchip + This is the port of NuttX to the Atmel SAMA5D3x-Xplained development board. This board features the Atmel SAMA5D36. See http://www.atmel.com/devices/sama5d36.aspx. diff --git a/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst index 89f52f3cba1..6354e7387e4 100644 --- a/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst +++ b/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst @@ -2,6 +2,8 @@ sama5d3x-ek =========== +.. tags:: arch:arm, chip:sama5, vendor:microchip + For details look at ``Documentation/platforms/arm/sama5/boards/sama5d3x-ek/README.txt`` .. this breaks latexpdf build diff --git a/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst index bb6f0f9d4e9..2f8822cdadc 100644 --- a/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst +++ b/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst @@ -2,6 +2,8 @@ sama5d4-ek ========== +.. tags:: arch:arm, chip:sama5, vendor:microchip + For details look at ``Documentation/platforms/arm/sama5/boards/sama5d4-ek/README.txt`` .. this breaks latexpdf build diff --git a/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst b/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst index 645634cbb38..0650126b5be 100644 --- a/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst +++ b/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst @@ -2,6 +2,8 @@ arduino-m0 ========== +.. tags:: arch:arm, chip:samd2l2, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst b/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst index 2504822bf46..88eefbbd285 100644 --- a/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst +++ b/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst @@ -1,3 +1,5 @@ =============== circuit-express =============== + +.. tags:: arch:arm, chip:samd2l2, vendor:microchip diff --git a/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst b/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst index f6034cb9a5a..35539f1f3da 100644 --- a/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst +++ b/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst @@ -2,6 +2,8 @@ samd20-xplained =============== +.. tags:: arch:arm, chip:samd2l2, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst b/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst index 59bcea5c8a8..1545c327c06 100644 --- a/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst +++ b/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst @@ -2,6 +2,8 @@ samd21-xplained =============== +.. tags:: arch:arm, chip:samd2l2, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst b/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst index c2d1fe753b9..73abedf490d 100644 --- a/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst +++ b/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst @@ -2,6 +2,8 @@ saml21-xplained =============== +.. tags:: arch:arm, chip:samd2l2, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samd2l2/boards/xiao-seeeduino/index.rst b/Documentation/platforms/arm/samd2l2/boards/xiao-seeeduino/index.rst index 709404ddd12..647cf0ccf36 100644 --- a/Documentation/platforms/arm/samd2l2/boards/xiao-seeeduino/index.rst +++ b/Documentation/platforms/arm/samd2l2/boards/xiao-seeeduino/index.rst @@ -2,6 +2,8 @@ Seeed Studio XIAO SAMD21 ======================== +.. tags:: arch:arm, chip:samd2l2, vendor:microchip + The `Seeed Studio Xiao SAM21 `_ is the first of the XIAO family, and is a general purpose, low-power and tiny board. It can be referred to as the "Seeed Studio Xiao SAMD21" or the "Xiao Seeeduino". diff --git a/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst b/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst index a7fab871c2a..24daa2b3ad4 100644 --- a/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst +++ b/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst @@ -2,6 +2,8 @@ metro-m4 ======== +.. tags:: arch:arm, chip:samd5e5, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst b/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst index 7d6f775f569..b4eb8599c72 100644 --- a/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst +++ b/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst @@ -2,6 +2,8 @@ same54-xplained-pro =================== +.. tags:: arch:arm, chip:samd5e5, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samv7/boards/pic32czca70-curiosity/index.rst b/Documentation/platforms/arm/samv7/boards/pic32czca70-curiosity/index.rst index b354f98f0a0..67273b42676 100644 --- a/Documentation/platforms/arm/samv7/boards/pic32czca70-curiosity/index.rst +++ b/Documentation/platforms/arm/samv7/boards/pic32czca70-curiosity/index.rst @@ -2,6 +2,8 @@ PIC32CZ CA70 Curiosity Evaluation Kit ===================================== +.. tags:: arch:arm, chip:samv7, vendor:microchip + The `PIC32CZ CA70 Curiosity `_ is an evaluation kit for PIC32CZ CA70 series. diff --git a/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst b/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst index db6a87e7cdb..572383c5b78 100644 --- a/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst +++ b/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst @@ -2,5 +2,7 @@ same70-qmtech ============= +.. tags:: arch:arm, chip:samv7, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst b/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst index b7c714bfa0f..67dac8a58ca 100644 --- a/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst +++ b/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst @@ -2,6 +2,8 @@ same70-xplained =============== +.. tags:: arch:arm, chip:samv7, vendor:microchip + For details look at ``Documentation/platforms/arm/samv7/boards/same70-xplained/README.txt`` .. this breaks latexpdf build diff --git a/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst b/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst index 2c863f9f4e4..76679bd64e5 100644 --- a/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst +++ b/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst @@ -2,6 +2,8 @@ SAMV71 Xplained Ultra ===================== +.. tags:: arch:arm, chip:samv7, vendor:microchip + This entry discusses the port of NuttX to the Atmel SAM V71 Xplained Ultra Evaluation Kit (SAMV71-XULT). This board features the ATSAMV71Q21 Cortex-M7 microcontroller. diff --git a/Documentation/platforms/arm/stm32c0/boards/nucleo-c071rb/index.rst b/Documentation/platforms/arm/stm32c0/boards/nucleo-c071rb/index.rst index 6f7a65f2b86..4bc6a1c0c5a 100644 --- a/Documentation/platforms/arm/stm32c0/boards/nucleo-c071rb/index.rst +++ b/Documentation/platforms/arm/stm32c0/boards/nucleo-c071rb/index.rst @@ -2,7 +2,7 @@ ST Nucleo C071RB ================ -.. tags:: chip:stm32, chip:stm32c0, chip:stm32c071 +.. tags:: arch:arm, chip:stm32c0, part:stm32c071, vendor:st The Nucleo C071RB is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32c0/boards/nucleo-c092rc/index.rst b/Documentation/platforms/arm/stm32c0/boards/nucleo-c092rc/index.rst index 45aa8e787c5..9d4475ff8d8 100644 --- a/Documentation/platforms/arm/stm32c0/boards/nucleo-c092rc/index.rst +++ b/Documentation/platforms/arm/stm32c0/boards/nucleo-c092rc/index.rst @@ -2,7 +2,7 @@ ST Nucleo C092RC ================ -.. tags:: chip:stm32, chip:stm32c0, chip:stm32c092 +.. tags:: arch:arm, chip:stm32c0, part:stm32c092, vendor:st The Nucleo C092RC is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32c5/boards/nucleo-c562re/index.rst b/Documentation/platforms/arm/stm32c5/boards/nucleo-c562re/index.rst index 9ddf47a9c7d..2cac3e577a9 100644 --- a/Documentation/platforms/arm/stm32c5/boards/nucleo-c562re/index.rst +++ b/Documentation/platforms/arm/stm32c5/boards/nucleo-c562re/index.rst @@ -2,7 +2,7 @@ ST NUCLEO-C562RE ================= -.. tags:: chip:stm32, chip:stm32c5, chip:stm32c562 +.. tags:: arch:arm, chip:stm32c5, part:stm32c562, vendor:st The `NUCLEO-C562RE `_ is an STM32 Nucleo-64 board featuring an STM32C562RE microcontroller with diff --git a/Documentation/platforms/arm/stm32f0/boards/nucleo-f072rb/index.rst b/Documentation/platforms/arm/stm32f0/boards/nucleo-f072rb/index.rst index ab46fac83f1..b1d17f68674 100644 --- a/Documentation/platforms/arm/stm32f0/boards/nucleo-f072rb/index.rst +++ b/Documentation/platforms/arm/stm32f0/boards/nucleo-f072rb/index.rst @@ -2,7 +2,7 @@ ST Nucleo F072RB ================ -.. tags:: chip:stm32, chip:stm32f0, chip:stm32f072 +.. tags:: arch:arm, chip:stm32f0, part:stm32f072, vendor:st That board features the STM32F072RBT6 MCU with 128KiB of FLASH and 16KiB of SRAM. diff --git a/Documentation/platforms/arm/stm32f0/boards/nucleo-f091rc/index.rst b/Documentation/platforms/arm/stm32f0/boards/nucleo-f091rc/index.rst index a308569c098..71d77f0ba16 100644 --- a/Documentation/platforms/arm/stm32f0/boards/nucleo-f091rc/index.rst +++ b/Documentation/platforms/arm/stm32f0/boards/nucleo-f091rc/index.rst @@ -4,7 +4,7 @@ ST Nucleo F091RC ================= -.. tags:: chip:stm32, chip:stm32f0, chip:stm32f091 +.. tags:: arch:arm, chip:stm32f0, part:stm32f091, vendor:st That board features the STM32F091RCT6 MCU with 256KiB of FLASH and 32KiB of SRAM. diff --git a/Documentation/platforms/arm/stm32f0/boards/stm32f051-discovery/index.rst b/Documentation/platforms/arm/stm32f0/boards/stm32f051-discovery/index.rst index 3c6b5963ee9..7b776ed92a9 100644 --- a/Documentation/platforms/arm/stm32f0/boards/stm32f051-discovery/index.rst +++ b/Documentation/platforms/arm/stm32f0/boards/stm32f051-discovery/index.rst @@ -2,7 +2,7 @@ ST STM32F051-DISCOVERY ====================== -.. tags:: chip:stm32, chip:stm32f0, chip:stm32f051 +.. tags:: arch:arm, chip:stm32f0, part:stm32f051, vendor:st STATUS ====== diff --git a/Documentation/platforms/arm/stm32f0/boards/stm32f072-discovery/index.rst b/Documentation/platforms/arm/stm32f0/boards/stm32f072-discovery/index.rst index 84b7282d80d..125b05759cf 100644 --- a/Documentation/platforms/arm/stm32f0/boards/stm32f072-discovery/index.rst +++ b/Documentation/platforms/arm/stm32f0/boards/stm32f072-discovery/index.rst @@ -2,7 +2,7 @@ ST STM32F072-DISCOVERY ====================== -.. tags:: chip:stm32, chip:stm32f0, chip:stm32f072 +.. tags:: arch:arm, chip:stm32f0, part:stm32f072, vendor:st STATUS ====== diff --git a/Documentation/platforms/arm/stm32f1/boards/cloudctrl/index.rst b/Documentation/platforms/arm/stm32f1/boards/cloudctrl/index.rst index a9268daf7d0..64600e4451b 100644 --- a/Documentation/platforms/arm/stm32f1/boards/cloudctrl/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/cloudctrl/index.rst @@ -2,7 +2,7 @@ CloudController =============== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f107 +.. tags:: arch:arm, chip:stm32f1, part:stm32f107, vendor:st This page discusses issues unique to NuttX configurations for the CloudController development board featuring the STMicro STM32F107VCT MCU. diff --git a/Documentation/platforms/arm/stm32f1/boards/et-stm32-stamp/index.rst b/Documentation/platforms/arm/stm32f1/boards/et-stm32-stamp/index.rst index 28cd904e27b..c503bcd8927 100644 --- a/Documentation/platforms/arm/stm32f1/boards/et-stm32-stamp/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/et-stm32-stamp/index.rst @@ -2,7 +2,7 @@ ET-STM32 Stamp ============== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues/thoughts unique to NuttX configuration(s) for the ET-STM32 Stamp board from Futurlec (https://www.futurlec.com/ET-STM32_Stamp.shtml). diff --git a/Documentation/platforms/arm/stm32f1/boards/fire-stm32v2/index.rst b/Documentation/platforms/arm/stm32f1/boards/fire-stm32v2/index.rst index 9c15d336c5d..2e84d513cd0 100644 --- a/Documentation/platforms/arm/stm32f1/boards/fire-stm32v2/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/fire-stm32v2/index.rst @@ -2,7 +2,7 @@ fire-stm2v2 =========== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues unique to NuttX configurations for the M3 Wildfire development board (STM32F103VET6). See http://firestm32.taobao.com diff --git a/Documentation/platforms/arm/stm32f1/boards/hymini-stm32/index.rst b/Documentation/platforms/arm/stm32f1/boards/hymini-stm32v/index.rst similarity index 99% rename from Documentation/platforms/arm/stm32f1/boards/hymini-stm32/index.rst rename to Documentation/platforms/arm/stm32f1/boards/hymini-stm32v/index.rst index 4b399f98b4c..c10ed3adc94 100644 --- a/Documentation/platforms/arm/stm32f1/boards/hymini-stm32/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/hymini-stm32v/index.rst @@ -2,7 +2,7 @@ HY-MiniSTM32V ============= -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues unique to NuttX configurations for the HY-MiniSTM32V development board. diff --git a/Documentation/platforms/arm/stm32f1/boards/maple/index.rst b/Documentation/platforms/arm/stm32f1/boards/maple/index.rst index 57973923e08..f7a586762e2 100644 --- a/Documentation/platforms/arm/stm32f1/boards/maple/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/maple/index.rst @@ -2,7 +2,7 @@ maple ===== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues unique to NuttX configurations for the maple board from LeafLabs (http://leaflabs.com). diff --git a/Documentation/platforms/arm/stm32f1/boards/nucleo-f103rb/index.rst b/Documentation/platforms/arm/stm32f1/boards/nucleo-f103rb/index.rst index a49643953d0..ead2a0f2234 100644 --- a/Documentation/platforms/arm/stm32f1/boards/nucleo-f103rb/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/nucleo-f103rb/index.rst @@ -2,7 +2,7 @@ ST Nucleo F103RB ================ -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st The Nucleo F103RB is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32f1/boards/olimexino-stm32/index.rst b/Documentation/platforms/arm/stm32f1/boards/olimexino-stm32/index.rst index 3c5e9280b38..9e142f85a61 100644 --- a/Documentation/platforms/arm/stm32f1/boards/olimexino-stm32/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/olimexino-stm32/index.rst @@ -2,4 +2,4 @@ olimexino-stm32 =============== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st diff --git a/Documentation/platforms/arm/stm32f1/boards/shenzhou/index.rst b/Documentation/platforms/arm/stm32f1/boards/shenzhou/index.rst index 14f2d03a4cd..364375907cb 100644 --- a/Documentation/platforms/arm/stm32f1/boards/shenzhou/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/shenzhou/index.rst @@ -2,7 +2,7 @@ Shenzhou IV =========== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f107 +.. tags:: arch:arm, chip:stm32f1, part:stm32f107, vendor:st This page discusses issues unique to NuttX configurations for the Shenzhou IV development board from www.armjishu.com featuring the STMicro STM32F107VCT diff --git a/Documentation/platforms/arm/stm32f1/boards/stm3210e-eval/index.rst b/Documentation/platforms/arm/stm32f1/boards/stm3210e-eval/index.rst index 3e499fbfe9b..6a49adef9c3 100644 --- a/Documentation/platforms/arm/stm32f1/boards/stm3210e-eval/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/stm3210e-eval/index.rst @@ -2,7 +2,7 @@ ST STM3210E-EVAL ================ -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM3210E-EVAL development board. diff --git a/Documentation/platforms/arm/stm32f1/boards/stm32_tiny/index.rst b/Documentation/platforms/arm/stm32f1/boards/stm32_tiny/index.rst index d42f547766b..f362245eec5 100644 --- a/Documentation/platforms/arm/stm32f1/boards/stm32_tiny/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/stm32_tiny/index.rst @@ -2,7 +2,7 @@ STM32 Tiny ========== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues unique to NuttX configurations for the STM32 Tiny development board. diff --git a/Documentation/platforms/arm/stm32f1/boards/stm32butterfly2/index.rst b/Documentation/platforms/arm/stm32f1/boards/stm32butterfly2/index.rst index 722848c46e5..9ee936e32d1 100644 --- a/Documentation/platforms/arm/stm32f1/boards/stm32butterfly2/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/stm32butterfly2/index.rst @@ -2,4 +2,4 @@ STM32BUTTERFLY2 =============== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f107 +.. tags:: arch:arm, chip:stm32f1, part:stm32f107, vendor:st diff --git a/Documentation/platforms/arm/stm32f1/boards/stm32f103-minimum/index.rst b/Documentation/platforms/arm/stm32f1/boards/stm32f103-minimum/index.rst index e818cabd221..6530604471d 100644 --- a/Documentation/platforms/arm/stm32f1/boards/stm32f103-minimum/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/stm32f103-minimum/index.rst @@ -2,7 +2,7 @@ stm32f103-minimum ================= -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, vendor:st This page discusses issues unique to NuttX configurations for the STM32F103C8T6 Minimum System Development Board for ARM Microcontroller. diff --git a/Documentation/platforms/arm/stm32f1/boards/stm32vldiscovery/index.rst b/Documentation/platforms/arm/stm32f1/boards/stm32vldiscovery/index.rst index 81c6d7b8289..938e9b3a8e7 100644 --- a/Documentation/platforms/arm/stm32f1/boards/stm32vldiscovery/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/stm32vldiscovery/index.rst @@ -2,7 +2,7 @@ ST STM32VLDiscovery =================== -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f100 +.. tags:: arch:arm, chip:stm32f1, part:stm32f100, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32VLDiscovery (Value Line Discovery) board. diff --git a/Documentation/platforms/arm/stm32f1/boards/viewtool-stm32f107/index.rst b/Documentation/platforms/arm/stm32f1/boards/viewtool-stm32f107/index.rst index ab956a36db5..12f9d7e5c79 100644 --- a/Documentation/platforms/arm/stm32f1/boards/viewtool-stm32f107/index.rst +++ b/Documentation/platforms/arm/stm32f1/boards/viewtool-stm32f107/index.rst @@ -2,7 +2,7 @@ ViewTool STM32F103/F107 ======================= -.. tags:: chip:stm32, chip:stm32f1, chip:stm32f103, chip:stm32f107 +.. tags:: arch:arm, chip:stm32f1, part:stm32f103, part:stm32f107, vendor:st This page discusses issues unique to NuttX configurations for the ViewTool STM32F103/F107 V1.2 board. This board may be fitted with either diff --git a/Documentation/platforms/arm/stm32f2/boards/emw3162/index.rst b/Documentation/platforms/arm/stm32f2/boards/emw3162/index.rst index 617a5f13d3c..5209634bbfa 100644 --- a/Documentation/platforms/arm/stm32f2/boards/emw3162/index.rst +++ b/Documentation/platforms/arm/stm32f2/boards/emw3162/index.rst @@ -2,7 +2,7 @@ emw3162 ======= -.. tags:: chip:stm32, chip:stm32f2, chip:stm32f205 +.. tags:: arch:arm, chip:stm32f2, part:stm32f205, vendor:st EMW3162 board (https://www.waveshare.com/EMW3162.htm) features the STM32F205RG MCU and Broadcom BCM43362KUBG Wi-Fi chip. diff --git a/Documentation/platforms/arm/stm32f2/boards/nucleo-f207zg/index.rst b/Documentation/platforms/arm/stm32f2/boards/nucleo-f207zg/index.rst index 088dc0f6612..d80c83cfb0b 100644 --- a/Documentation/platforms/arm/stm32f2/boards/nucleo-f207zg/index.rst +++ b/Documentation/platforms/arm/stm32f2/boards/nucleo-f207zg/index.rst @@ -2,6 +2,6 @@ ST Nucleo F207ZG ================ -.. tags:: chip:stm32, chip:stm32f2, chip:stm32f207 +.. tags:: arch:arm, chip:stm32f2, part:stm32f207, vendor:st The Nucleo F207ZG is a member of the Nucleo-144 board family. diff --git a/Documentation/platforms/arm/stm32f2/boards/olimex-stm32-p207/index.rst b/Documentation/platforms/arm/stm32f2/boards/olimex-stm32-p207/index.rst index 17b29117a8d..00747dc3c9c 100644 --- a/Documentation/platforms/arm/stm32f2/boards/olimex-stm32-p207/index.rst +++ b/Documentation/platforms/arm/stm32f2/boards/olimex-stm32-p207/index.rst @@ -2,7 +2,7 @@ Olimex STM32-P207 ================= -.. tags:: chip:stm32, chip:stm32f2, chip:stm32f207 +.. tags:: arch:arm, chip:stm32f2, part:stm32f207, vendor:st The NuttX configuration for the Olimex STM32-P207 is assembled mainly from the configurations stm32f4discovery and stm3240g-eval. diff --git a/Documentation/platforms/arm/stm32f2/boards/photon/index.rst b/Documentation/platforms/arm/stm32f2/boards/photon/index.rst index e8742154dac..3c8aae447b6 100644 --- a/Documentation/platforms/arm/stm32f2/boards/photon/index.rst +++ b/Documentation/platforms/arm/stm32f2/boards/photon/index.rst @@ -2,7 +2,7 @@ Particle.io Photon ================== -.. tags:: chip:stm32, chip:stm32f2, chip:stm32f205 +.. tags:: arch:arm, chip:stm32f2, part:stm32f205, vendor:st This page discusses issues unique to NuttX configurations for the Particle.io Photon board featuring the STM32F205RG MCU. diff --git a/Documentation/platforms/arm/stm32f2/boards/stm3220g-eval/index.rst b/Documentation/platforms/arm/stm32f2/boards/stm3220g-eval/index.rst index 521269dc321..c4b3989c514 100644 --- a/Documentation/platforms/arm/stm32f2/boards/stm3220g-eval/index.rst +++ b/Documentation/platforms/arm/stm32f2/boards/stm3220g-eval/index.rst @@ -2,7 +2,7 @@ ST STM3220G-EVAL ================ -.. tags:: chip:stm32, chip:stm32f2, chip:stm32f207, ethernet +.. tags:: arch:arm, chip:stm32f2, part:stm32f207, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM3220G-EVAL development board. diff --git a/Documentation/platforms/arm/stm32f3/boards/nucleo-f302r8/index.rst b/Documentation/platforms/arm/stm32f3/boards/nucleo-f302r8/index.rst index 5c9c4eec8b7..35a8501de06 100644 --- a/Documentation/platforms/arm/stm32f3/boards/nucleo-f302r8/index.rst +++ b/Documentation/platforms/arm/stm32f3/boards/nucleo-f302r8/index.rst @@ -2,7 +2,7 @@ ST Nucleo F302R8 ================ -.. tags:: chip:stm32, chip:stm32f3, chip:stm32f302 +.. tags:: arch:arm, chip:stm32f3, part:stm32f302, vendor:st The Nucleo F302R8 is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32f3/boards/nucleo-f303re/index.rst b/Documentation/platforms/arm/stm32f3/boards/nucleo-f303re/index.rst index 417febe9533..5123e1f4c03 100644 --- a/Documentation/platforms/arm/stm32f3/boards/nucleo-f303re/index.rst +++ b/Documentation/platforms/arm/stm32f3/boards/nucleo-f303re/index.rst @@ -2,6 +2,6 @@ ST Nucleo F303RE ================ -.. tags:: chip:stm32, chip:stm32f3, chip:stm32f303 +.. tags:: arch:arm, chip:stm32f3, part:stm32f303, vendor:st The Nucleo F303RE is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32f3/boards/nucleo-f303ze/index.rst b/Documentation/platforms/arm/stm32f3/boards/nucleo-f303ze/index.rst index f5073d9a000..109d0d9109c 100644 --- a/Documentation/platforms/arm/stm32f3/boards/nucleo-f303ze/index.rst +++ b/Documentation/platforms/arm/stm32f3/boards/nucleo-f303ze/index.rst @@ -2,6 +2,6 @@ ST Nucleo F303ZE ================ -.. tags:: chip:stm32, chip:stm32f3, chip:stm32f303 +.. tags:: arch:arm, chip:stm32f3, part:stm32f303, vendor:st The Nucleo F303ZE is a member of the Nucleo-144 board family. diff --git a/Documentation/platforms/arm/stm32f3/boards/nucleo-f334r8/index.rst b/Documentation/platforms/arm/stm32f3/boards/nucleo-f334r8/index.rst index 48e8009b35c..952cf9ed704 100644 --- a/Documentation/platforms/arm/stm32f3/boards/nucleo-f334r8/index.rst +++ b/Documentation/platforms/arm/stm32f3/boards/nucleo-f334r8/index.rst @@ -2,7 +2,7 @@ ST Nucleo F334R8 ================ -.. tags:: chip:stm32, chip:stm32f3, chip:stm32f334 +.. tags:: arch:arm, chip:stm32f3, part:stm32f334, vendor:st The Nucleo F334R8 is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32f3/boards/stm32f334-disco/index.rst b/Documentation/platforms/arm/stm32f3/boards/stm32f334-disco/index.rst index bc7a930a216..69b508f6a6c 100644 --- a/Documentation/platforms/arm/stm32f3/boards/stm32f334-disco/index.rst +++ b/Documentation/platforms/arm/stm32f3/boards/stm32f334-disco/index.rst @@ -2,7 +2,7 @@ 32F3348DISCOVERY ================ -.. tags:: chip:stm32, chip:stm32f3, chip:stm32f334 +.. tags:: arch:arm, chip:stm32f3, part:stm32f334, vendor:st This README discusses issues unique to NuttX configurations for the STMicro 32F3348DISCOVERY development board featuring the STM32F334C8 diff --git a/Documentation/platforms/arm/stm32f3/boards/stm32f3discovery/index.rst b/Documentation/platforms/arm/stm32f3/boards/stm32f3discovery/index.rst index f8358980502..c1be0ea2d56 100644 --- a/Documentation/platforms/arm/stm32f3/boards/stm32f3discovery/index.rst +++ b/Documentation/platforms/arm/stm32f3/boards/stm32f3discovery/index.rst @@ -2,7 +2,7 @@ STM32F3Discovery ================ -.. tags:: chip:stm32, chip:stm32f3, chip:stm32f303 +.. tags:: arch:arm, chip:stm32f3, part:stm32f303, vendor:st This README discusses issues unique to NuttX configurations for the STMicro STM32F3Discovery development board. diff --git a/Documentation/platforms/arm/stm32f4/boards/axoloti/index.rst b/Documentation/platforms/arm/stm32f4/boards/axoloti/index.rst index 93e751aa540..c38a0fbed34 100644 --- a/Documentation/platforms/arm/stm32f4/boards/axoloti/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/axoloti/index.rst @@ -2,7 +2,7 @@ Axoloti ======= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f427 +.. tags:: arch:arm, chip:stm32f4, part:stm32f427, vendor:st This page discusses issues unique to NuttX configurations for the Axoloti open source synthesizer board featuring the STM32F427IGH6 diff --git a/Documentation/platforms/arm/stm32f4/boards/clicker2-stm32/index.rst b/Documentation/platforms/arm/stm32f4/boards/clicker2-stm32/index.rst index b2584194578..84397bd039d 100644 --- a/Documentation/platforms/arm/stm32f4/boards/clicker2-stm32/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/clicker2-stm32/index.rst @@ -2,7 +2,7 @@ Mikroe Clicker2 STM32 ===================== -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407 +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st This is the page file for the port of NuttX to the Mikroe Clicker2 STM32 board based on the STMicro STM32F407VGT6 MCU. diff --git a/Documentation/platforms/arm/stm32f4/boards/mikroe-stm32f4/index.rst b/Documentation/platforms/arm/stm32f4/boards/mikroe-stm32f4/index.rst index 99ef06928f5..04a7a2d117a 100644 --- a/Documentation/platforms/arm/stm32f4/boards/mikroe-stm32f4/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/mikroe-stm32f4/index.rst @@ -2,7 +2,7 @@ mikroe-stm32f4 ============== -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407 +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st This page discusses issues unique to NuttX configurations for the MikroElektronika Mikromedia for STM32F4 development board. This is diff --git a/Documentation/platforms/arm/stm32f4/boards/nucleo-f401re/index.rst b/Documentation/platforms/arm/stm32f4/boards/nucleo-f401re/index.rst index 15adaf23e9c..d5ee252af59 100644 --- a/Documentation/platforms/arm/stm32f4/boards/nucleo-f401re/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/nucleo-f401re/index.rst @@ -2,7 +2,7 @@ ST Nucleo F401RE ================ -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f401 +.. tags:: arch:arm, chip:stm32f4, part:stm32f401, vendor:st This page discusses issues unique to NuttX configurations for the ST NucleoF401RE boards from ST Micro. See diff --git a/Documentation/platforms/arm/stm32f4/boards/nucleo-f410rb/index.rst b/Documentation/platforms/arm/stm32f4/boards/nucleo-f410rb/index.rst index 8181a010015..335ddeb3e7a 100644 --- a/Documentation/platforms/arm/stm32f4/boards/nucleo-f410rb/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/nucleo-f410rb/index.rst @@ -2,7 +2,7 @@ ST Nucleo F410RB ================ -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f401 +.. tags:: arch:arm, chip:stm32f4, part:stm32f401, vendor:st This page discusses issues unique to NuttX configurations for the ST Nucleo F410RB board from ST Micro. See diff --git a/Documentation/platforms/arm/stm32f4/boards/nucleo-f411re/index.rst b/Documentation/platforms/arm/stm32f4/boards/nucleo-f411re/index.rst index 14e1a002196..1a77dda629b 100644 --- a/Documentation/platforms/arm/stm32f4/boards/nucleo-f411re/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/nucleo-f411re/index.rst @@ -2,7 +2,7 @@ ST Nucleo F411RE ================ -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f411 +.. tags:: arch:arm, chip:stm32f4, part:stm32f411, vendor:st This page discusses issues unique to NuttX configurations for the ST NucleoF411RE board from ST Micro. See diff --git a/Documentation/platforms/arm/stm32f4/boards/nucleo-f412zg/index.rst b/Documentation/platforms/arm/stm32f4/boards/nucleo-f412zg/index.rst index c539bdbe1a1..36a05567a3a 100644 --- a/Documentation/platforms/arm/stm32f4/boards/nucleo-f412zg/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/nucleo-f412zg/index.rst @@ -2,7 +2,7 @@ ST Nucleo F412ZG ================ -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f412 +.. tags:: arch:arm, chip:stm32f4, part:stm32f412, vendor:st This page discusses issues unique to NuttX configurations for the ST Nucleo F412ZG board from ST Micro. See diff --git a/Documentation/platforms/arm/stm32f4/boards/nucleo-f429zi/index.rst b/Documentation/platforms/arm/stm32f4/boards/nucleo-f429zi/index.rst index 6cd589ae3eb..6b6d1b84008 100644 --- a/Documentation/platforms/arm/stm32f4/boards/nucleo-f429zi/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/nucleo-f429zi/index.rst @@ -2,7 +2,7 @@ ST Nucleo F429ZI ================ -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f429 +.. tags:: arch:arm, chip:stm32f4, part:stm32f429, vendor:st The Nucleo F429ZI is a member of the Nucleo-144 board family. diff --git a/Documentation/platforms/arm/stm32f4/boards/nucleo-f446re/index.rst b/Documentation/platforms/arm/stm32f4/boards/nucleo-f446re/index.rst index ae56f58dc1d..f379f63a4e7 100644 --- a/Documentation/platforms/arm/stm32f4/boards/nucleo-f446re/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/nucleo-f446re/index.rst @@ -2,7 +2,7 @@ ST Nucleo F446RE ================ -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f446 +.. tags:: arch:arm, chip:stm32f4, part:stm32f446, vendor:st This page discusses issues unique to NuttX configurations for the ST NucleoF446RE boards from ST Micro. See diff --git a/Documentation/platforms/arm/stm32f4/boards/odrive36/index.rst b/Documentation/platforms/arm/stm32f4/boards/odrive36/index.rst index 4a3f9196681..f5005e717ac 100644 --- a/Documentation/platforms/arm/stm32f4/boards/odrive36/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/odrive36/index.rst @@ -2,7 +2,7 @@ ODrive V3.6 =========== -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f405 +.. tags:: arch:arm, chip:stm32f4, part:stm32f405, vendor:st ODrive V3.6 is an open-source dual-motor FOC controller based on the STMicro STM32F405RG and TI DRV8301 gate drivers. diff --git a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-e407/index.rst b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-e407/index.rst index 2eb2a0e8633..2c1d140a536 100644 --- a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-e407/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-e407/index.rst @@ -2,7 +2,7 @@ Olimex STM32-E407 ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407 +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st The Olimex STM32-E407 configuration is based on the configuration olimex-stm32-h407 and stm32f4discovery. diff --git a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h405/index.rst b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h405/index.rst index 189fc9e9149..f5071a2ac1b 100644 --- a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h405/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h405/index.rst @@ -2,7 +2,7 @@ Olimex STM32-P207 ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f405 +.. tags:: arch:arm, chip:stm32f4, part:stm32f405, vendor:st The NuttX configuration for the Olimex STM32-H405 is based on the configuration Olimex STM32-P207. diff --git a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h407/index.rst b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h407/index.rst index 62b9bd4cb39..f83f637be79 100644 --- a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h407/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-h407/index.rst @@ -2,7 +2,7 @@ Olimex STM32-H407 ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407 +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st The Olimex STM32-H407 configuration is based on stm32Fdiscovery and Olimex STM32-H405. diff --git a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-p407/index.rst b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-p407/index.rst index 99515dc88c4..1729bc7275b 100644 --- a/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-p407/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/olimex-stm32-p407/index.rst @@ -2,7 +2,7 @@ Olimex STM32-P207 ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407 +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st The NuttX configuration for the Olimex STM32-P407 is derives more or less directly from the Olimex STM32-P207 board support. The P207 and P407 seem diff --git a/Documentation/platforms/arm/stm32f4/boards/omnibusf4/index.rst b/Documentation/platforms/arm/stm32f4/boards/omnibusf4/index.rst index e81cd71ba97..451deb0513d 100644 --- a/Documentation/platforms/arm/stm32f4/boards/omnibusf4/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/omnibusf4/index.rst @@ -2,7 +2,7 @@ OMNIBUSF4 ========= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f405 +.. tags:: arch:arm, chip:stm32f4, part:stm32f405, vendor:st "OmnibusF4" is not a product name per se, but rather a design spec that many product vendors within the drone flight management unit diff --git a/Documentation/platforms/arm/stm32f4/boards/stm3240g-eval/index.rst b/Documentation/platforms/arm/stm32f4/boards/stm3240g-eval/index.rst index b9d9c192a5c..045472e40b1 100644 --- a/Documentation/platforms/arm/stm32f4/boards/stm3240g-eval/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/stm3240g-eval/index.rst @@ -2,7 +2,7 @@ ST STM3240G-EVAL ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407, ethernet +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM3240G-EVAL development board. diff --git a/Documentation/platforms/arm/stm32f4/boards/stm32f401rc-rs485/index.rst b/Documentation/platforms/arm/stm32f4/boards/stm32f401rc-rs485/index.rst index 22d5ce462f0..c692b3974ce 100644 --- a/Documentation/platforms/arm/stm32f4/boards/stm32f401rc-rs485/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/stm32f401rc-rs485/index.rst @@ -2,7 +2,7 @@ stm32f401rc-rs485 ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f401 +.. tags:: arch:arm, chip:stm32f4, part:stm32f401, vendor:st This page discusses issues unique to NuttX configurations for the NuttX STM32F4-RS485 development board. @@ -999,7 +999,7 @@ Connect the HX711 to the STM32F4 board using the following pins: 11 10 -For more details, refer to the official `HX711 NuttX documentation `_. +For more details, refer to the official `HX711 NuttX documentation `_. MAX31855 -------- diff --git a/Documentation/platforms/arm/stm32f4/boards/stm32f411-minimum/index.rst b/Documentation/platforms/arm/stm32f4/boards/stm32f411-minimum/index.rst index fd9cffa8124..231d4e17532 100644 --- a/Documentation/platforms/arm/stm32f4/boards/stm32f411-minimum/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/stm32f411-minimum/index.rst @@ -2,7 +2,7 @@ stm32f411-minimum ================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f411 +.. tags:: arch:arm, chip:stm32f4, part:stm32f411, vendor:st This page discusses issues unique to NuttX configurations for the WeAct Studio MiniF4 minimum system development board. diff --git a/Documentation/platforms/arm/stm32f4/boards/stm32f411e-disco/index.rst b/Documentation/platforms/arm/stm32f4/boards/stm32f411e-disco/index.rst index 3685d606cf7..47d3afe45f3 100644 --- a/Documentation/platforms/arm/stm32f4/boards/stm32f411e-disco/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/stm32f411e-disco/index.rst @@ -2,7 +2,7 @@ ST STM32F411E-Discovery ======================= -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f411 +.. tags:: arch:arm, chip:stm32f4, part:stm32f411, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32F411E-Discovery board. See diff --git a/Documentation/platforms/arm/stm32f4/boards/stm32f429i-disco/index.rst b/Documentation/platforms/arm/stm32f4/boards/stm32f429i-disco/index.rst index 298ce9cee63..a3cbcd1802c 100644 --- a/Documentation/platforms/arm/stm32f4/boards/stm32f429i-disco/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/stm32f429i-disco/index.rst @@ -2,7 +2,7 @@ ST STM32F429I-DISCO =================== -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f429 +.. tags:: arch:arm, chip:stm32f4, part:stm32f429, vendor:st .. figure:: stm32f429i-disco.png :align: center diff --git a/Documentation/platforms/arm/stm32f4/boards/stm32f4discovery/index.rst b/Documentation/platforms/arm/stm32f4/boards/stm32f4discovery/index.rst index 452ab1ff585..305e2d50412 100644 --- a/Documentation/platforms/arm/stm32f4/boards/stm32f4discovery/index.rst +++ b/Documentation/platforms/arm/stm32f4/boards/stm32f4discovery/index.rst @@ -2,7 +2,7 @@ ST STM32F4-Discovery ==================== -.. tags:: chip:stm32, chip:stm32f4, chip:stm32f407 +.. tags:: arch:arm, chip:stm32f4, part:stm32f407, vendor:st The STM32F4Discover board (also known as STM32F407G-DISC1) is a low cost development board released by STMicroelectronics. @@ -2440,7 +2440,7 @@ Connect the HX711 to the STM32F4 board using the following pins: -4 -4 -For more details, refer to the official `HX711 NuttX documentation `_. +For more details, refer to the official `HX711 NuttX documentation `_. nxscope_cdcacm -------------- diff --git a/Documentation/platforms/arm/stm32f4/index.rst b/Documentation/platforms/arm/stm32f4/index.rst index 11b28dde626..5952ec97b40 100644 --- a/Documentation/platforms/arm/stm32f4/index.rst +++ b/Documentation/platforms/arm/stm32f4/index.rst @@ -242,7 +242,7 @@ Clock device With CONFIG_PTP_CLOCK the driver registers the counter as a PTP hardware clock, ``/dev/ptp0`` for the first Ethernet interface (the number of the device is the number of the interface). It follows the generic framework -described in :doc:`/components/drivers/special/ptp` and offers reading and +described in :doc:`/os/drivers/special/ptp` and offers reading and setting the time, the resolution, frequency adjustment (``ADJ_FREQUENCY``, up to +/- 50 %) and phase steps (``ADJ_OFFSET`` and ``ADJ_SETOFFSET``). It does not offer the cross timestamp of the system and the device clock. diff --git a/Documentation/platforms/arm/stm32f7/boards/nucleo-f722ze/index.rst b/Documentation/platforms/arm/stm32f7/boards/nucleo-f722ze/index.rst index 0243fbc5dec..f3157a0a0c6 100644 --- a/Documentation/platforms/arm/stm32f7/boards/nucleo-f722ze/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/nucleo-f722ze/index.rst @@ -2,7 +2,7 @@ ST Nucleo F722ZE ================ -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f722 +.. tags:: arch:arm, chip:stm32f7, part:stm32f722, vendor:st This page discusses issues unique to NuttX configurations for the STMicro Nucleo-144 board. See ST document STM32 Nucleo-144 boards (UM1974): diff --git a/Documentation/platforms/arm/stm32f7/boards/nucleo-f746zg/index.rst b/Documentation/platforms/arm/stm32f7/boards/nucleo-f746zg/index.rst index eedd91fa4d9..ea90bbbedfc 100644 --- a/Documentation/platforms/arm/stm32f7/boards/nucleo-f746zg/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/nucleo-f746zg/index.rst @@ -4,7 +4,7 @@ ST Nucleo F746ZG ================ -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f746 +.. tags:: arch:arm, chip:stm32f7, part:stm32f746, vendor:st .. figure:: nucleo-f746zg.jpg :align: center diff --git a/Documentation/platforms/arm/stm32f7/boards/nucleo-f767zi/index.rst b/Documentation/platforms/arm/stm32f7/boards/nucleo-f767zi/index.rst index addc01caee4..dceda9b1660 100644 --- a/Documentation/platforms/arm/stm32f7/boards/nucleo-f767zi/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/nucleo-f767zi/index.rst @@ -2,7 +2,7 @@ ST Nucleo F767ZI ================ -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f767 +.. tags:: arch:arm, chip:stm32f7, part:stm32f767, vendor:st This page discusses issues unique to NuttX configurations for the STMicro Nucleo-144 board. See ST document STM32 Nucleo-144 boards (UM1974): diff --git a/Documentation/platforms/arm/stm32f7/boards/steval-eth001v1/index.rst b/Documentation/platforms/arm/stm32f7/boards/steval-eth001v1/index.rst index 77cf08bc8bd..50e0ce60a9e 100644 --- a/Documentation/platforms/arm/stm32f7/boards/steval-eth001v1/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/steval-eth001v1/index.rst @@ -2,7 +2,7 @@ ST STEVAL-ETH001V1 ================== -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f767 +.. tags:: arch:arm, chip:stm32f7, part:stm32f767, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STEVAL-ETH001V1 servo drive evaluation board. diff --git a/Documentation/platforms/arm/stm32f7/boards/stm32f746-ws/index.rst b/Documentation/platforms/arm/stm32f7/boards/stm32f746-ws/index.rst index aba85ba8998..a029e635034 100644 --- a/Documentation/platforms/arm/stm32f7/boards/stm32f746-ws/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/stm32f746-ws/index.rst @@ -2,4 +2,4 @@ STM32F746-WS ============ -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f746 +.. tags:: arch:arm, chip:stm32f7, part:stm32f746, vendor:st diff --git a/Documentation/platforms/arm/stm32f7/boards/stm32f746g-disco/index.rst b/Documentation/platforms/arm/stm32f7/boards/stm32f746g-disco/index.rst index 9d36afba368..2e051d847bd 100644 --- a/Documentation/platforms/arm/stm32f7/boards/stm32f746g-disco/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/stm32f746g-disco/index.rst @@ -2,7 +2,7 @@ ST STM32F746G-DISCO =================== -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f746 +.. tags:: arch:arm, chip:stm32f7, part:stm32f746, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32F746G-DISCO development board featuring the STM32F746NGH6 diff --git a/Documentation/platforms/arm/stm32f7/boards/stm32f769i-disco/index.rst b/Documentation/platforms/arm/stm32f7/boards/stm32f769i-disco/index.rst index dbe20d4247b..3b925e30453 100644 --- a/Documentation/platforms/arm/stm32f7/boards/stm32f769i-disco/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/stm32f769i-disco/index.rst @@ -2,7 +2,7 @@ ST STM32F769I-DISCO =================== -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f769 +.. tags:: arch:arm, chip:stm32f7, part:stm32f769, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32F769I-DISCO development board featuring the STM32F769NIH6 diff --git a/Documentation/platforms/arm/stm32f7/boards/stm32f777zit6-meadow/index.rst b/Documentation/platforms/arm/stm32f7/boards/stm32f777zit6-meadow/index.rst index c1e2c49e2c8..2c9b62247d8 100644 --- a/Documentation/platforms/arm/stm32f7/boards/stm32f777zit6-meadow/index.rst +++ b/Documentation/platforms/arm/stm32f7/boards/stm32f777zit6-meadow/index.rst @@ -2,4 +2,4 @@ STM32f777ZIT6-MEADOW ==================== -.. tags:: chip:stm32, chip:stm32f7, chip:stm32f777 +.. tags:: arch:arm, chip:stm32f7, part:stm32f777, vendor:st diff --git a/Documentation/platforms/arm/stm32g0/boards/nucleo-g070rb/index.rst b/Documentation/platforms/arm/stm32g0/boards/nucleo-g070rb/index.rst index 10247d8426b..2e2c7a45147 100644 --- a/Documentation/platforms/arm/stm32g0/boards/nucleo-g070rb/index.rst +++ b/Documentation/platforms/arm/stm32g0/boards/nucleo-g070rb/index.rst @@ -2,6 +2,6 @@ ST Nucleo G070RB ================ -.. tags:: chip:stm32, chip:stm32g0, chip:stm32g070 +.. tags:: arch:arm, chip:stm32g0, part:stm32g070, vendor:st The Nucleo G070RB is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32g0/boards/nucleo-g071rb/index.rst b/Documentation/platforms/arm/stm32g0/boards/nucleo-g071rb/index.rst index 2bc8b1cddb7..99a9b8bc273 100644 --- a/Documentation/platforms/arm/stm32g0/boards/nucleo-g071rb/index.rst +++ b/Documentation/platforms/arm/stm32g0/boards/nucleo-g071rb/index.rst @@ -2,6 +2,6 @@ ST Nucleo G071RB ================ -.. tags:: chip:stm32, chip:stm32g0, chip:stm32g071 +.. tags:: arch:arm, chip:stm32g0, part:stm32g071, vendor:st The Nucleo G071RB is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32g0/boards/nucleo-g0b1re/index.rst b/Documentation/platforms/arm/stm32g0/boards/nucleo-g0b1re/index.rst index e6a744017ce..c32972bb7df 100644 --- a/Documentation/platforms/arm/stm32g0/boards/nucleo-g0b1re/index.rst +++ b/Documentation/platforms/arm/stm32g0/boards/nucleo-g0b1re/index.rst @@ -1,6 +1,9 @@ ================ ST Nucleo G0B1RE ================ + +.. tags:: arch:arm, chip:stm32g0, vendor:st + .. figure:: nucleo-g0b1re.png :align: center diff --git a/Documentation/platforms/arm/stm32g0/boards/stm32g071b-disco/index.rst b/Documentation/platforms/arm/stm32g0/boards/stm32g071b-disco/index.rst index 89d55a031c8..6febf15fa3f 100644 --- a/Documentation/platforms/arm/stm32g0/boards/stm32g071b-disco/index.rst +++ b/Documentation/platforms/arm/stm32g0/boards/stm32g071b-disco/index.rst @@ -2,7 +2,7 @@ ST STM32G071B-DISCO =================== -.. tags:: chip:stm32, chip:stm32g0, chip:stm32g071 +.. tags:: arch:arm, chip:stm32g0, part:stm32g071, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32G071B-DISCO development board. The STM32G071B-DISCO board diff --git a/Documentation/platforms/arm/stm32g4/boards/b-g431b-esc1/index.rst b/Documentation/platforms/arm/stm32g4/boards/b-g431b-esc1/index.rst index a0b9f5aa9cf..cab6be34210 100644 --- a/Documentation/platforms/arm/stm32g4/boards/b-g431b-esc1/index.rst +++ b/Documentation/platforms/arm/stm32g4/boards/b-g431b-esc1/index.rst @@ -2,7 +2,7 @@ ST B-G431B-ESC ============== -.. tags:: chip:stm32, chip:stm32g4, chip:stm32g431 +.. tags:: arch:arm, chip:stm32g4, part:stm32g431, vendor:st The B-G431B-ESC board is based on the STM32G431CB microcontroller, the L6387 driver and STL180N6F7 power MOSFETs. diff --git a/Documentation/platforms/arm/stm32g4/boards/b-g474e-dpow1/index.rst b/Documentation/platforms/arm/stm32g4/boards/b-g474e-dpow1/index.rst index 2de18b67ef1..0da6f45dd48 100644 --- a/Documentation/platforms/arm/stm32g4/boards/b-g474e-dpow1/index.rst +++ b/Documentation/platforms/arm/stm32g4/boards/b-g474e-dpow1/index.rst @@ -2,7 +2,7 @@ ST B-G474E-DPOW1 ================ -.. tags:: chip:stm32, chip:stm32g4, chip:stm32g474 +.. tags:: arch:arm, chip:stm32g4, part:stm32g474, vendor:st This page is for a port of NuttX to the ST Micro B-G474E-DPOW1 Discovery kit with STM32G474RE MCU. For more information about this board, diff --git a/Documentation/platforms/arm/stm32g4/boards/nucleo-g431kb/index.rst b/Documentation/platforms/arm/stm32g4/boards/nucleo-g431kb/index.rst index ec9c55e9633..097f87d15c5 100644 --- a/Documentation/platforms/arm/stm32g4/boards/nucleo-g431kb/index.rst +++ b/Documentation/platforms/arm/stm32g4/boards/nucleo-g431kb/index.rst @@ -2,6 +2,6 @@ ST Nucleo G431KB ================ -.. tags:: chip:stm32, chip:stm32g4, chip:stm32g431 +.. tags:: arch:arm, chip:stm32g4, part:stm32g431, vendor:st The Nucleo G431KB is a member of the Nucleo-32 board family. diff --git a/Documentation/platforms/arm/stm32g4/boards/nucleo-g431rb/index.rst b/Documentation/platforms/arm/stm32g4/boards/nucleo-g431rb/index.rst index 0276ff9a1aa..9adc5e20081 100644 --- a/Documentation/platforms/arm/stm32g4/boards/nucleo-g431rb/index.rst +++ b/Documentation/platforms/arm/stm32g4/boards/nucleo-g431rb/index.rst @@ -2,7 +2,7 @@ ST Nucleo G431RB ================ -.. tags:: chip:stm32, chip:stm32g4, chip:stm32g431 +.. tags:: arch:arm, chip:stm32g4, part:stm32g431, vendor:st The Nucleo G431RB is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32g4/boards/nucleo-g474re/index.rst b/Documentation/platforms/arm/stm32g4/boards/nucleo-g474re/index.rst index 0df135b0383..de96e226ec0 100644 --- a/Documentation/platforms/arm/stm32g4/boards/nucleo-g474re/index.rst +++ b/Documentation/platforms/arm/stm32g4/boards/nucleo-g474re/index.rst @@ -2,7 +2,7 @@ ST Nucleo G474RE ================ -.. tags:: chip:stm32, chip:stm32g4, chip:stm32g474 +.. tags:: arch:arm, chip:stm32g4, part:stm32g474, vendor:st This is the page for a port of NuttX to the ST Micro Nucleo G474RE board with STM32G474RE MCU. For more information about this board, see: diff --git a/Documentation/platforms/arm/stm32h5/boards/nucleo-h503rb/index.rst b/Documentation/platforms/arm/stm32h5/boards/nucleo-h503rb/index.rst index 4a7b42ce64e..c74bfcdc1ea 100644 --- a/Documentation/platforms/arm/stm32h5/boards/nucleo-h503rb/index.rst +++ b/Documentation/platforms/arm/stm32h5/boards/nucleo-h503rb/index.rst @@ -2,7 +2,7 @@ ST Nucleo-H503RB ================ -.. tags:: chip:stm32, chip:stm32h5, chip:stm32h503 +.. tags:: arch:arm, chip:stm32h5, part:stm32h503, vendor:st Board Information ================= diff --git a/Documentation/platforms/arm/stm32h5/boards/nucleo-h533re/index.rst b/Documentation/platforms/arm/stm32h5/boards/nucleo-h533re/index.rst index 2464e2a18ad..a8901e942d8 100644 --- a/Documentation/platforms/arm/stm32h5/boards/nucleo-h533re/index.rst +++ b/Documentation/platforms/arm/stm32h5/boards/nucleo-h533re/index.rst @@ -2,7 +2,7 @@ ST Nucleo-H533RE ================ -.. tags:: chip:stm32, chip:stm32h5, chip:stm32h533 +.. tags:: arch:arm, chip:stm32h5, part:stm32h533, vendor:st Board Information ================= diff --git a/Documentation/platforms/arm/stm32h5/boards/nucleo-h563zi/index.rst b/Documentation/platforms/arm/stm32h5/boards/nucleo-h563zi/index.rst index 65793a10f68..ef92f0598c1 100644 --- a/Documentation/platforms/arm/stm32h5/boards/nucleo-h563zi/index.rst +++ b/Documentation/platforms/arm/stm32h5/boards/nucleo-h563zi/index.rst @@ -2,7 +2,7 @@ ST Nucleo-H563ZI ================ -.. tags:: chip:stm32, chip:stm32h5, chip:stm32h563 +.. tags:: arch:arm, chip:stm32h5, part:stm32h563, vendor:st .. figure:: nucleo-h563zi.png :align: center diff --git a/Documentation/platforms/arm/stm32h5/index.rst b/Documentation/platforms/arm/stm32h5/index.rst index c60d0d8969b..5f1bd78c45a 100644 --- a/Documentation/platforms/arm/stm32h5/index.rst +++ b/Documentation/platforms/arm/stm32h5/index.rst @@ -195,7 +195,7 @@ eFuse Character Device ``CONFIG_STM32H5_EFUSE`` (which selects ``CONFIG_STM32H5_OTP_WORD``) registers the OTP area as a NuttX efuse character device, by default ``/dev/efuse``, built on the word API above. See -:doc:`/components/drivers/character/efuse` for the ``EFUSEIOC_READ_FIELD``/ +:doc:`/os/drivers/character/efuse` for the ``EFUSEIOC_READ_FIELD``/ ``EFUSEIOC_WRITE_FIELD`` ioctl interface. Field bit offsets index into the flat bit space of the OTP area at 16 bits per word, the same as the word API's ``word`` index. Writing a field requires ``CONFIG_STM32H5_OTP_WRITE``; diff --git a/Documentation/platforms/arm/stm32h7/boards/devebox-stm32h743/index.rst b/Documentation/platforms/arm/stm32h7/boards/devebox-stm32h743/index.rst index 82538040940..1f4d3040840 100644 --- a/Documentation/platforms/arm/stm32h7/boards/devebox-stm32h743/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/devebox-stm32h743/index.rst @@ -2,7 +2,7 @@ devebox-stm32h743 ================== -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h743 +.. tags:: arch:arm, chip:stm32h7, part:stm32h743, vendor:st NuttX port for the DevEbox STM32H743 board. diff --git a/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst b/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst index 01e0e026c17..7cc87437d8a 100644 --- a/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst @@ -2,7 +2,7 @@ linum-stm32h753bi ================= -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h753 +.. tags:: arch:arm, chip:stm32h7, part:stm32h753, vendor:st This page discusses issues unique to NuttX configurations for the LINUM-STM32H753BI board. diff --git a/Documentation/platforms/arm/stm32h7/boards/nucleo-h723zg/index.rst b/Documentation/platforms/arm/stm32h7/boards/nucleo-h723zg/index.rst index 8c4ac5fbb2d..89b5faf1ffd 100644 --- a/Documentation/platforms/arm/stm32h7/boards/nucleo-h723zg/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/nucleo-h723zg/index.rst @@ -2,7 +2,7 @@ ST Nucleo H723ZG ================ -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h723 +.. tags:: arch:arm, chip:stm32h7, part:stm32h723, vendor:st This page discusses issues unique to NuttX configurations for the STMicro Nucleo-H723ZG development board featuring the STM32H723ZG diff --git a/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi/index.rst b/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi/index.rst index f37c5b4dbf4..6f66640e242 100644 --- a/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi/index.rst @@ -2,7 +2,7 @@ ST Nucleo H743ZI ================ -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h743 +.. tags:: arch:arm, chip:stm32h7, part:stm32h743, vendor:st This page discusses issues unique to NuttX configurations for the STMicro NUCLEO-H743ZI development board featuring the STM32H743ZI diff --git a/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi2/index.rst b/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi2/index.rst index f390092265e..aca986bfc4c 100644 --- a/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi2/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/nucleo-h743zi2/index.rst @@ -2,7 +2,7 @@ ST Nucleo H743ZI2 ================= -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h743 +.. tags:: arch:arm, chip:stm32h7, part:stm32h743, vendor:st This page discusses issues unique to NuttX configurations for the STMicro NUCLEO-H743ZI2 development board featuring the STM32H743ZI diff --git a/Documentation/platforms/arm/stm32h7/boards/nucleo-h745zi/index.rst b/Documentation/platforms/arm/stm32h7/boards/nucleo-h745zi/index.rst index 6ee38e98e13..b69529ec02d 100644 --- a/Documentation/platforms/arm/stm32h7/boards/nucleo-h745zi/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/nucleo-h745zi/index.rst @@ -2,7 +2,7 @@ ST Nucleo H745ZI ================ -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h745 +.. tags:: arch:arm, chip:stm32h7, part:stm32h745, vendor:st Dual core support ----------------- diff --git a/Documentation/platforms/arm/stm32h7/boards/nucleo-h753zi/index.rst b/Documentation/platforms/arm/stm32h7/boards/nucleo-h753zi/index.rst index 7d058605721..fca0cb1278b 100644 --- a/Documentation/platforms/arm/stm32h7/boards/nucleo-h753zi/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/nucleo-h753zi/index.rst @@ -2,7 +2,7 @@ ST Nucleo H753ZI ================= -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h753 +.. tags:: arch:arm, chip:stm32h7, part:stm32h753, vendor:st .. figure:: nucleo-h753zi.jpg :align: center diff --git a/Documentation/platforms/arm/stm32h7/boards/nucleo-h7s3l8/index.rst b/Documentation/platforms/arm/stm32h7/boards/nucleo-h7s3l8/index.rst index 217fb24af1e..044fe7ee72e 100644 --- a/Documentation/platforms/arm/stm32h7/boards/nucleo-h7s3l8/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/nucleo-h7s3l8/index.rst @@ -2,7 +2,7 @@ ST Nucleo H7S3L8 ================= -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h7s3 +.. tags:: arch:arm, chip:stm32h7, part:stm32h7s3, vendor:st This page describes the NuttX port for the STMicro NUCLEO-H7S3L8 development board. The board is based on the 600 MHz STM32H7S3L8 diff --git a/Documentation/platforms/arm/stm32h7/boards/openh743i/index.rst b/Documentation/platforms/arm/stm32h7/boards/openh743i/index.rst index a6a33c1d159..e8995aee6c1 100644 --- a/Documentation/platforms/arm/stm32h7/boards/openh743i/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/openh743i/index.rst @@ -2,7 +2,7 @@ Waveshare OpenH743I =================== -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h743 +.. tags:: arch:arm, chip:stm32h7, part:stm32h743, vendor:st The OpenH743I-C is an STM32 development board with STM32H743IIT6. It comes with a rich expansion interface to support access to various diff --git a/Documentation/platforms/arm/stm32h7/boards/portenta-h7/index.rst b/Documentation/platforms/arm/stm32h7/boards/portenta-h7/index.rst index 0de6327c96d..48e3e2f7029 100644 --- a/Documentation/platforms/arm/stm32h7/boards/portenta-h7/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/portenta-h7/index.rst @@ -2,6 +2,8 @@ Arduino Portenta H7 =================== +.. tags:: arch:arm, chip:stm32h7, vendor:st + This page discusses issues unique to NuttX configurations for the Arduino Portenta H7 board. This port applies to all versions of Portenta H7: diff --git a/Documentation/platforms/arm/stm32h7/boards/stm32h745i-disco/index.rst b/Documentation/platforms/arm/stm32h7/boards/stm32h745i-disco/index.rst index f145f0ef446..d2244797838 100644 --- a/Documentation/platforms/arm/stm32h7/boards/stm32h745i-disco/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/stm32h745i-disco/index.rst @@ -2,7 +2,7 @@ ST STM32H745I-DISCO =================== -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h745 +.. tags:: arch:arm, chip:stm32h7, part:stm32h745, vendor:st Dual core support ================= diff --git a/Documentation/platforms/arm/stm32h7/boards/stm32h747i-disco/index.rst b/Documentation/platforms/arm/stm32h7/boards/stm32h747i-disco/index.rst index b74218cd2fa..a5a9c635e73 100644 --- a/Documentation/platforms/arm/stm32h7/boards/stm32h747i-disco/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/stm32h747i-disco/index.rst @@ -2,7 +2,7 @@ ST STM32H747I-DISCO =================== -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h747 +.. tags:: arch:arm, chip:stm32h7, part:stm32h747, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32H747I-DISCO development board featuring the STM32H747I diff --git a/Documentation/platforms/arm/stm32h7/boards/weact-stm32h743/index.rst b/Documentation/platforms/arm/stm32h7/boards/weact-stm32h743/index.rst index 2d1c3e37c52..123d0f322e8 100644 --- a/Documentation/platforms/arm/stm32h7/boards/weact-stm32h743/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/weact-stm32h743/index.rst @@ -2,7 +2,7 @@ weact-stm32h743 =============== -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h743 +.. tags:: arch:arm, chip:stm32h7, part:stm32h743, vendor:st This page discusses issues unique to NuttX configurations for the WeAct STM32H743 board. diff --git a/Documentation/platforms/arm/stm32h7/boards/weact-stm32h750/index.rst b/Documentation/platforms/arm/stm32h7/boards/weact-stm32h750/index.rst index 0c9f73d662b..9096918d6fc 100644 --- a/Documentation/platforms/arm/stm32h7/boards/weact-stm32h750/index.rst +++ b/Documentation/platforms/arm/stm32h7/boards/weact-stm32h750/index.rst @@ -2,7 +2,7 @@ weact-stm32h750 =============== -.. tags:: chip:stm32, chip:stm32h7, chip:stm32h750 +.. tags:: arch:arm, chip:stm32h7, part:stm32h750, vendor:st This page discusses issues unique to NuttX configurations for the WeAct STM32H750 board. diff --git a/Documentation/platforms/arm/stm32h7/index.rst b/Documentation/platforms/arm/stm32h7/index.rst index 7bf075612fe..99278408b29 100644 --- a/Documentation/platforms/arm/stm32h7/index.rst +++ b/Documentation/platforms/arm/stm32h7/index.rst @@ -193,7 +193,7 @@ Clock device With ``CONFIG_PTP_CLOCK`` the driver registers the counter as a PTP hardware clock, ``/dev/ptp0`` for the first Ethernet interface (the number of the device is the number of the interface). It follows the generic framework -described in :doc:`/components/drivers/special/ptp` and offers reading and +described in :doc:`/os/drivers/special/ptp` and offers reading and setting the time, the resolution (the increment of the counter, 10 ns with ``HCLK`` at 200 MHz), frequency adjustment (``ADJ_FREQUENCY``, up to +/- 50 %) and phase steps (``ADJ_OFFSET`` and ``ADJ_SETOFFSET``). It does not offer the diff --git a/Documentation/platforms/arm/stm32l0/boards/b-l072z-lrwan1/index.rst b/Documentation/platforms/arm/stm32l0/boards/b-l072z-lrwan1/index.rst index bb0b99d2170..eda0e1e6d2b 100644 --- a/Documentation/platforms/arm/stm32l0/boards/b-l072z-lrwan1/index.rst +++ b/Documentation/platforms/arm/stm32l0/boards/b-l072z-lrwan1/index.rst @@ -4,7 +4,7 @@ ST B-L072Z-LRWAN1 ================= -.. tags:: chip:stm32, chip:stm32l0, chip:stm32l072 +.. tags:: arch:arm, chip:stm32l0, part:stm32l072, vendor:st .. figure:: b-l072z-lrwan1.jpg :align: center diff --git a/Documentation/platforms/arm/stm32l0/boards/nucleo-l073rz/index.rst b/Documentation/platforms/arm/stm32l0/boards/nucleo-l073rz/index.rst index 201ead1d850..674c59c27a8 100644 --- a/Documentation/platforms/arm/stm32l0/boards/nucleo-l073rz/index.rst +++ b/Documentation/platforms/arm/stm32l0/boards/nucleo-l073rz/index.rst @@ -4,7 +4,7 @@ ST Nucleo L073RZ ================ -.. tags:: chip:stm32, chip:stm32l0, chip:stm32l073 +.. tags:: arch:arm, chip:stm32l0, part:stm32l073, vendor:st The Nucleo L073RZ is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32l0/boards/stm32l0538-disco/index.rst b/Documentation/platforms/arm/stm32l0/boards/stm32l0538-disco/index.rst index 76b2190e65d..3f271236692 100644 --- a/Documentation/platforms/arm/stm32l0/boards/stm32l0538-disco/index.rst +++ b/Documentation/platforms/arm/stm32l0/boards/stm32l0538-disco/index.rst @@ -2,7 +2,7 @@ ST STM32L0538-DISO ================== -.. tags:: chip:stm32, chip:stm32l0, chip:stm32l053 +.. tags:: arch:arm, chip:stm32l0, part:stm32l053, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32L0538-DISO development board. The STM32L0538-DISO board diff --git a/Documentation/platforms/arm/stm32l1/boards/nucleo-l152re/index.rst b/Documentation/platforms/arm/stm32l1/boards/nucleo-l152re/index.rst index 20d25306904..d07c2659d08 100644 --- a/Documentation/platforms/arm/stm32l1/boards/nucleo-l152re/index.rst +++ b/Documentation/platforms/arm/stm32l1/boards/nucleo-l152re/index.rst @@ -2,6 +2,6 @@ ST Nucleo L152RE ================ -.. tags:: chip:stm32, chip:stm32l1, chip:stm32l152 +.. tags:: arch:arm, chip:stm32l1, part:stm32l152, vendor:st The Nucleo L152RE is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32l1/boards/stm32ldiscovery/index.rst b/Documentation/platforms/arm/stm32l1/boards/stm32ldiscovery/index.rst index dc3516ff398..4e6c7fe465a 100644 --- a/Documentation/platforms/arm/stm32l1/boards/stm32ldiscovery/index.rst +++ b/Documentation/platforms/arm/stm32l1/boards/stm32ldiscovery/index.rst @@ -2,7 +2,7 @@ ST STM32L Discovery ===================== -.. tags:: chip:stm32, chip:stm32l1, chip:stm32l152 +.. tags:: arch:arm, chip:stm32l1, part:stm32l152, vendor:st This page discusses issues unique to NuttX configurations for the STMicro STM32L-Discovery development board. The STM32L-Discovery board diff --git a/Documentation/platforms/arm/stm32l4/boards/b-l475e-iot01a/index.rst b/Documentation/platforms/arm/stm32l4/boards/b-l475e-iot01a/index.rst index e11ef4f6773..768898cc5d6 100644 --- a/Documentation/platforms/arm/stm32l4/boards/b-l475e-iot01a/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/b-l475e-iot01a/index.rst @@ -2,7 +2,7 @@ ST B-L475E-IOT01A ================= -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l475 +.. tags:: arch:arm, chip:stm32l4, part:stm32l475, vendor:st This page discusses the port of NuttX to the STMicro B-L475E-IOT01A Discovery kit powered by STM32L475VG Cortex-M4. This board targets IoT diff --git a/Documentation/platforms/arm/stm32l4/boards/nucleo-l432kc/index.rst b/Documentation/platforms/arm/stm32l4/boards/nucleo-l432kc/index.rst index f74c716ea1c..4f958103d64 100644 --- a/Documentation/platforms/arm/stm32l4/boards/nucleo-l432kc/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/nucleo-l432kc/index.rst @@ -2,7 +2,7 @@ ST Nucleo L432KC ================ -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l432 +.. tags:: arch:arm, chip:stm32l4, part:stm32l432, vendor:st This page discusses issues unique to NuttX configurations for the ST Nucleo-l432kc board from ST Micro. See diff --git a/Documentation/platforms/arm/stm32l4/boards/nucleo-l452re/index.rst b/Documentation/platforms/arm/stm32l4/boards/nucleo-l452re/index.rst index 17340c81023..519200ada7b 100644 --- a/Documentation/platforms/arm/stm32l4/boards/nucleo-l452re/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/nucleo-l452re/index.rst @@ -2,7 +2,7 @@ ST Nucleo L452RE ================ -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l452 +.. tags:: arch:arm, chip:stm32l4, part:stm32l452, vendor:st This page file discusses the port of NuttX to the STMicro Nucleo-L452RE board. That board features the STM32L452RET6 MCU with 512KiB of FLASH diff --git a/Documentation/platforms/arm/stm32l4/boards/nucleo-l476rg/index.rst b/Documentation/platforms/arm/stm32l4/boards/nucleo-l476rg/index.rst index a9b749343a8..06f2c9a1e10 100644 --- a/Documentation/platforms/arm/stm32l4/boards/nucleo-l476rg/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/nucleo-l476rg/index.rst @@ -2,7 +2,7 @@ ST Nucleo L476RG ================ -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l476 +.. tags:: arch:arm, chip:stm32l4, part:stm32l476, vendor:st This page discusses issues unique to NuttX configurations for the ST NucleoL476RG board from ST Micro. See diff --git a/Documentation/platforms/arm/stm32l4/boards/nucleo-l496zg/index.rst b/Documentation/platforms/arm/stm32l4/boards/nucleo-l496zg/index.rst index 89df8dc28f4..809d6bfd530 100644 --- a/Documentation/platforms/arm/stm32l4/boards/nucleo-l496zg/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/nucleo-l496zg/index.rst @@ -2,7 +2,7 @@ ST Nucleo L496ZG ================ -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l496 +.. tags:: arch:arm, chip:stm32l4, part:stm32l496, vendor:st This page discusses issues unique to NuttX configurations for the STMicro Nucleo-144 board for STM32L4 chips. diff --git a/Documentation/platforms/arm/stm32l4/boards/steval-stlcs01v1/index.rst b/Documentation/platforms/arm/stm32l4/boards/steval-stlcs01v1/index.rst index 799b8aeeb15..f7dd2ddb81c 100644 --- a/Documentation/platforms/arm/stm32l4/boards/steval-stlcs01v1/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/steval-stlcs01v1/index.rst @@ -2,7 +2,7 @@ ST STEVAL-STLCS01V1 =================== -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l476 +.. tags:: arch:arm, chip:stm32l4, part:stm32l476, vendor:st This page discusses issues unique to NuttX configurations for the ST STEVAL-STLCS01V1 board (SensorTile module) from ST Micro based on diff --git a/Documentation/platforms/arm/stm32l4/boards/stm32l476-mdk/index.rst b/Documentation/platforms/arm/stm32l4/boards/stm32l476-mdk/index.rst index ad037b28c8c..c61a9c1f44d 100644 --- a/Documentation/platforms/arm/stm32l4/boards/stm32l476-mdk/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/stm32l476-mdk/index.rst @@ -2,7 +2,7 @@ STM32L476-mdk ============= -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l476 +.. tags:: arch:arm, chip:stm32l4, part:stm32l476, vendor:st This page discusses issues unique to NuttX configurations for STM32L476ME part in the Motorola MDK. This is referred to as the MuC in Motorola diff --git a/Documentation/platforms/arm/stm32l4/boards/stm32l476vg-disco/index.rst b/Documentation/platforms/arm/stm32l4/boards/stm32l476vg-disco/index.rst index c1d763f67d7..630940d8de9 100644 --- a/Documentation/platforms/arm/stm32l4/boards/stm32l476vg-disco/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/stm32l476vg-disco/index.rst @@ -2,7 +2,7 @@ ST STM32L476VG-DISCO ==================== -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l476 +.. tags:: arch:arm, chip:stm32l4, part:stm32l476, vendor:st XXX all this needs review and update diff --git a/Documentation/platforms/arm/stm32l4/boards/stm32l4r9ai-disco/index.rst b/Documentation/platforms/arm/stm32l4/boards/stm32l4r9ai-disco/index.rst index b87198bfdd5..2ae7cb510ef 100644 --- a/Documentation/platforms/arm/stm32l4/boards/stm32l4r9ai-disco/index.rst +++ b/Documentation/platforms/arm/stm32l4/boards/stm32l4r9ai-disco/index.rst @@ -2,7 +2,7 @@ ST STM32L4R9AI-DISCO ==================== -.. tags:: chip:stm32, chip:stm32l4, chip:stm32l4r9 +.. tags:: arch:arm, chip:stm32l4, part:stm32l4r9, vendor:st This page discusses issues unique to NuttX configurations for the ST STM32L4R9AI Discovery board from ST Micro. See diff --git a/Documentation/platforms/arm/stm32l5/boards/nucleo-l552ze/index.rst b/Documentation/platforms/arm/stm32l5/boards/nucleo-l552ze/index.rst index 66386780317..22c1af140c2 100644 --- a/Documentation/platforms/arm/stm32l5/boards/nucleo-l552ze/index.rst +++ b/Documentation/platforms/arm/stm32l5/boards/nucleo-l552ze/index.rst @@ -2,7 +2,7 @@ ST Nucleo L552ZE-Q ================== -.. tags:: chip:stm32, chip:stm32l5, chip:stm32l552 +.. tags:: arch:arm, chip:stm32l5, part:stm32l552, vendor:st This page discusses the port of NuttX to the STMicro Nucleo-L552ZE board. That board features the STM32L552ZET6Q MCU with 512KiB of FLASH diff --git a/Documentation/platforms/arm/stm32l5/boards/stm32l562e-dk/index.rst b/Documentation/platforms/arm/stm32l5/boards/stm32l562e-dk/index.rst index ddba39b1801..4964f0747bd 100644 --- a/Documentation/platforms/arm/stm32l5/boards/stm32l562e-dk/index.rst +++ b/Documentation/platforms/arm/stm32l5/boards/stm32l562e-dk/index.rst @@ -2,7 +2,7 @@ ST STM32L562E-DK ================ -.. tags:: chip:stm32, chip:stm32l5, chip:stm32l562 +.. tags:: arch:arm, chip:stm32l5, part:stm32l562, vendor:st This page discusses the port of NuttX to the STMicro STM32L562E-DK board. That board features the STM32L562QEI6QU MCU with 512KiB of FLASH diff --git a/Documentation/platforms/arm/stm32n6/boards/nucleo-n657x0-q/index.rst b/Documentation/platforms/arm/stm32n6/boards/nucleo-n657x0-q/index.rst index a3344954af2..c67186783a4 100644 --- a/Documentation/platforms/arm/stm32n6/boards/nucleo-n657x0-q/index.rst +++ b/Documentation/platforms/arm/stm32n6/boards/nucleo-n657x0-q/index.rst @@ -2,7 +2,7 @@ ST Nucleo-N657X0-Q ================== -.. tags:: chip:stm32, chip:stm32n6, chip:stm32n657 +.. tags:: arch:arm, chip:stm32n6, part:stm32n657, vendor:st .. figure:: nucleo-n657x0-q.jpg :width: 50 % diff --git a/Documentation/platforms/arm/stm32u0/boards/nucleo-u083rc/index.rst b/Documentation/platforms/arm/stm32u0/boards/nucleo-u083rc/index.rst index f686bc162f9..acaff4e47f0 100644 --- a/Documentation/platforms/arm/stm32u0/boards/nucleo-u083rc/index.rst +++ b/Documentation/platforms/arm/stm32u0/boards/nucleo-u083rc/index.rst @@ -2,7 +2,7 @@ ST Nucleo U083RC ================ -.. tags:: chip:stm32, chip:stm32u0, chip:stm32u083 +.. tags:: arch:arm, chip:stm32u0, part:stm32u083, vendor:st The Nucleo U083RC is a member of the Nucleo-64 board family. diff --git a/Documentation/platforms/arm/stm32u0/boards/stm32u083c-dk/index.rst b/Documentation/platforms/arm/stm32u0/boards/stm32u083c-dk/index.rst index 29e9e46b1df..8ffc03be7d2 100644 --- a/Documentation/platforms/arm/stm32u0/boards/stm32u083c-dk/index.rst +++ b/Documentation/platforms/arm/stm32u0/boards/stm32u083c-dk/index.rst @@ -2,7 +2,7 @@ ST STM32U083C-DK ================ -.. tags:: chip:stm32, chip:stm32u0, chip:stm32u083 +.. tags:: arch:arm, chip:stm32u0, part:stm32u083, vendor:st The STM32U083C-DK is a Discovery kit based on the STM32U083MC MCU. diff --git a/Documentation/platforms/arm/stm32u3/boards/nucleo-u3c5zi-q/index.rst b/Documentation/platforms/arm/stm32u3/boards/nucleo-u3c5zi-q/index.rst index 573d2d2f6e9..3f6c72a3c34 100644 --- a/Documentation/platforms/arm/stm32u3/boards/nucleo-u3c5zi-q/index.rst +++ b/Documentation/platforms/arm/stm32u3/boards/nucleo-u3c5zi-q/index.rst @@ -2,7 +2,7 @@ ST NUCLEO-U3C5ZI-Q ====================== -.. tags:: chip:stm32, chip:stm32u3, chip:stm32u3c5 +.. tags:: arch:arm, chip:stm32u3, part:stm32u3c5, vendor:st The `NUCLEO-U3C5ZI-Q `_ is an STM32 Nucleo-144 board featuring an STM32U3C5ZI microcontroller with diff --git a/Documentation/platforms/arm/stm32u5/boards/b-u585i-iot02a/index.rst b/Documentation/platforms/arm/stm32u5/boards/b-u585i-iot02a/index.rst index 60af81e77fa..65a21168ce1 100644 --- a/Documentation/platforms/arm/stm32u5/boards/b-u585i-iot02a/index.rst +++ b/Documentation/platforms/arm/stm32u5/boards/b-u585i-iot02a/index.rst @@ -2,7 +2,7 @@ ST B-U585I-IOT02A ================= -.. tags:: chip:stm32, chip:stm32u5, chip:stm32u585 +.. tags:: arch:arm, chip:stm32u5, part:stm32u585, vendor:st This page discusses the port of NuttX to the STMicroelectronics B-U585I-IOT02A board. That board features the STM32U585AII6QU MCU with 2MiB diff --git a/Documentation/platforms/arm/stm32u5/boards/nucleo-u5a5zj-q/index.rst b/Documentation/platforms/arm/stm32u5/boards/nucleo-u5a5zj-q/index.rst index 158318d3d45..48e4664feeb 100644 --- a/Documentation/platforms/arm/stm32u5/boards/nucleo-u5a5zj-q/index.rst +++ b/Documentation/platforms/arm/stm32u5/boards/nucleo-u5a5zj-q/index.rst @@ -2,7 +2,7 @@ ST Nucleo U5A5ZJ-Q ================== -.. tags:: chip:stm32, chip:stm32u5, chip:stm32u5a5 +.. tags:: arch:arm, chip:stm32u5, part:stm32u5a5, vendor:st This page file discusses the port of NuttX to the STMicroelectronics NUCLEO-U5A5ZJ-Q board. That board features the STM32U5A5ZJT6Q MCU with 4MiB diff --git a/Documentation/platforms/arm/stm32wb/boards/flipperzero/index.rst b/Documentation/platforms/arm/stm32wb/boards/flipperzero/index.rst index aa6fbf8838f..47e1d49c647 100644 --- a/Documentation/platforms/arm/stm32wb/boards/flipperzero/index.rst +++ b/Documentation/platforms/arm/stm32wb/boards/flipperzero/index.rst @@ -2,7 +2,7 @@ Flipper Zero ============ -.. tags:: chip:stm32, chip:stm32wb, chip:stm32wb55 +.. tags:: arch:arm, chip:stm32wb, part:stm32wb55, vendor:st This page file discusses the port of NuttX to the Flipper Zero multi-tool device. See https://flipperzero.one/ for device details. diff --git a/Documentation/platforms/arm/stm32wb/boards/nucleo-wb55rg/index.rst b/Documentation/platforms/arm/stm32wb/boards/nucleo-wb55rg/index.rst index a7631a17423..b8ece84a486 100644 --- a/Documentation/platforms/arm/stm32wb/boards/nucleo-wb55rg/index.rst +++ b/Documentation/platforms/arm/stm32wb/boards/nucleo-wb55rg/index.rst @@ -2,7 +2,7 @@ ST Nucleo WB55RG ================ -.. tags:: chip:stm32, chip:stm32wb, chip:stm32wb55 +.. tags:: arch:arm, chip:stm32wb, part:stm32wb55, vendor:st This page file discusses the port of NuttX to the STMicroelectronics NUCLEO-WB55RG board. That board features the multi-protocol wireless and diff --git a/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst b/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst index 62ffec02a25..d74c9546b73 100644 --- a/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst +++ b/Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst @@ -2,7 +2,7 @@ ST Nucleo WL55JC ================ -.. tags:: chip:stm32, chip:stm32wl, chip:stm32wl55 +.. tags:: arch:arm, chip:stm32wl5, part:stm32wl55, vendor:st The `Nucleo-WL55JC `_ is a development board for the STM32WL55 SoC from ST. It features 64 I/O, diff --git a/Documentation/platforms/arm/tiva/boards/lm3s6965-ek/index.rst b/Documentation/platforms/arm/tiva/boards/lm3s6965-ek/index.rst index 3166c2059b1..17cd4298c69 100644 --- a/Documentation/platforms/arm/tiva/boards/lm3s6965-ek/index.rst +++ b/Documentation/platforms/arm/tiva/boards/lm3s6965-ek/index.rst @@ -2,6 +2,8 @@ lm3s6965-ek =========== +.. tags:: arch:arm, chip:tiva, vendor:ti + The `Stellaris LM3S6965 Evaluation Kit `_ is an ARM Cortex-M3 based development board featuring the LM3S6965 microcontroller with an diff --git a/Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/index.rst b/Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/index.rst index adc51b26704..36ada8a43a6 100644 --- a/Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/index.rst +++ b/Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/index.rst @@ -2,7 +2,7 @@ TM4C123G Tiva C LaunchPad ========================= -.. tags:: chip:tm4c123, arch:arm, vendor:tiva +.. tags:: arch:arm, chip:tiva, part:tm4c123, vendor:ti .. figure:: tm4c123g.jpg :scale: 30 % @@ -213,7 +213,7 @@ Using OpenOCD and GDB with an FT2232 JTAG emulator Building OpenOCD under Cygwin: - Refer to Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/README.txt + Refer to Documentation/platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/README.txt Installing OpenOCD in Linux: diff --git a/Documentation/platforms/arm/xmc4/boards/xmc4500-relax/index.rst b/Documentation/platforms/arm/xmc4/boards/xmc4500-relax/index.rst index 0bfb0a5abee..07cffecef39 100644 --- a/Documentation/platforms/arm/xmc4/boards/xmc4500-relax/index.rst +++ b/Documentation/platforms/arm/xmc4/boards/xmc4500-relax/index.rst @@ -2,6 +2,8 @@ XMC4500 Relax ============= +.. tags:: arch:arm, chip:xmc4, vendor:infineon + There are to variants of this board: There is a Lite version that has fewer features, for example, no 32.768KHz crystal. diff --git a/Documentation/platforms/arm/xmc4/boards/xmc4700-relax/index.rst b/Documentation/platforms/arm/xmc4/boards/xmc4700-relax/index.rst index 6cfa753abe8..34d77f17eed 100644 --- a/Documentation/platforms/arm/xmc4/boards/xmc4700-relax/index.rst +++ b/Documentation/platforms/arm/xmc4/boards/xmc4700-relax/index.rst @@ -2,6 +2,8 @@ XMC4700 Relax ============== +.. tags:: arch:arm, chip:xmc4, vendor:infineon + The directory provides board support for the Infineon XMC4700 Relax Kit. Status diff --git a/Documentation/platforms/arm64/a527/boards/avaota-a1/index.rst b/Documentation/platforms/arm64/a527/boards/avaota-a1/index.rst index 76f80c689eb..93104240279 100644 --- a/Documentation/platforms/arm64/a527/boards/avaota-a1/index.rst +++ b/Documentation/platforms/arm64/a527/boards/avaota-a1/index.rst @@ -2,7 +2,7 @@ PINE64 Yuzuki Avaota-A1 ======================= -.. tags:: chip:a527 +.. tags:: arch:arm64, chip:a527, vendor:allwinner `Avaota-A1 `_ is an ARM64 Single-Board Computer based on the Allwinner A527 SoC. diff --git a/Documentation/platforms/arm64/a64/boards/pinephone/index.rst b/Documentation/platforms/arm64/a64/boards/pinephone/index.rst index 758bb47dd2c..622b3992b0e 100644 --- a/Documentation/platforms/arm64/a64/boards/pinephone/index.rst +++ b/Documentation/platforms/arm64/a64/boards/pinephone/index.rst @@ -2,7 +2,7 @@ PINE64 PinePhone ================ -.. tags:: chip:a64 +.. tags:: arch:arm64, chip:a64, vendor:allwinner `PinePhone `_ is an ARM64 smartphone created by PINE64. diff --git a/Documentation/platforms/arm64/am62x/boards/beagleplay/index.rst b/Documentation/platforms/arm64/am62x/boards/beagleplay/index.rst index d3347eb7b94..c9e0ccb8548 100644 --- a/Documentation/platforms/arm64/am62x/boards/beagleplay/index.rst +++ b/Documentation/platforms/arm64/am62x/boards/beagleplay/index.rst @@ -2,7 +2,7 @@ BeaglePlay ========== -.. tags:: chip:am62x, arch:arm64, vendor:beagleboard +.. tags:: arch:arm64, chip:am62x, vendor:ti `BeaglePlay `_ is an open-hardware single-board computer from BeagleBoard.org based on the diff --git a/Documentation/platforms/arm64/am62x/boards/pocketbeagle2/index.rst b/Documentation/platforms/arm64/am62x/boards/pocketbeagle2/index.rst index 06579633852..0a996dfd32d 100644 --- a/Documentation/platforms/arm64/am62x/boards/pocketbeagle2/index.rst +++ b/Documentation/platforms/arm64/am62x/boards/pocketbeagle2/index.rst @@ -2,7 +2,7 @@ PocketBeagle 2 ============== -.. tags:: chip:am62x, arch:arm64, vendor:beagleboard +.. tags:: arch:arm64, chip:am62x, vendor:ti `PocketBeagle 2 `_ is a compact open-hardware board from BeagleBoard.org based on the TI AM6254 SoC. diff --git a/Documentation/platforms/arm64/bcm2711/boards/raspberrypi-4b/index.rst b/Documentation/platforms/arm64/bcm2711/boards/raspberrypi-4b/index.rst index f2d84ed942c..08e95762fa8 100644 --- a/Documentation/platforms/arm64/bcm2711/boards/raspberrypi-4b/index.rst +++ b/Documentation/platforms/arm64/bcm2711/boards/raspberrypi-4b/index.rst @@ -2,7 +2,7 @@ Raspberry Pi 4B =============== -.. tags:: arch:arm64, chip:bcm2711, vendor:raspberry-pi, experimental +.. tags:: arch:arm64, chip:bcm2711, vendor:broadcom .. warning:: diff --git a/Documentation/platforms/arm64/bcm2711/index.rst b/Documentation/platforms/arm64/bcm2711/index.rst index f6dcdc0b4c9..330961887d7 100644 --- a/Documentation/platforms/arm64/bcm2711/index.rst +++ b/Documentation/platforms/arm64/bcm2711/index.rst @@ -2,7 +2,7 @@ BCM2711 ======= -.. tags:: arch:arm64, chip:bcm2711, vendor:broadcom, experimental +.. tags:: arch:arm64, chip:bcm2711, vendor:broadcom .. warning:: diff --git a/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst b/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst index 66203d938a1..94afb529fc3 100644 --- a/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst +++ b/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst @@ -2,7 +2,7 @@ FVP ARMv8-r =========== -.. tags:: chip:virt, arch:arm64 +.. tags:: arch:arm64, chip:fvp-v8r, part:virt, vendor:arm This board configuration will use FVP_BaseR_AEMv8R to emulate generic ARM64v8-R (Cotex-R82) series hardware platform and provides support for these devices: diff --git a/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst b/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst index 7ec4524a204..c9cf6cc18b4 100644 --- a/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst +++ b/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst @@ -2,7 +2,7 @@ IMX8QM MEK ========== -.. tags:: chip:imx8, arch:arm64, experimental +.. tags:: arch:arm64, chip:imx8, vendor:nxp .. todo:: diff --git a/Documentation/platforms/arm64/imx9/boards/imx93-evk/index.rst b/Documentation/platforms/arm64/imx9/boards/imx93-evk/index.rst index fa050199fba..41532a9db30 100644 --- a/Documentation/platforms/arm64/imx9/boards/imx93-evk/index.rst +++ b/Documentation/platforms/arm64/imx9/boards/imx93-evk/index.rst @@ -2,7 +2,7 @@ i.MX93 Evaluation Kit ===================== -.. tags:: chip:imx93, arch:arm64 +.. tags:: arch:arm64, chip:imx9, part:imx93, vendor:nxp The kit i.MX93 Evaluation Kit has a pre-installed Linux image which contains u-boot and the i.MX93 reference Linux installation. diff --git a/Documentation/platforms/arm64/imx9/boards/imx95-a55-evk/index.rst b/Documentation/platforms/arm64/imx9/boards/imx95-a55-evk/index.rst index cc876f8a53a..15bfb0a44db 100644 --- a/Documentation/platforms/arm64/imx9/boards/imx95-a55-evk/index.rst +++ b/Documentation/platforms/arm64/imx9/boards/imx95-a55-evk/index.rst @@ -2,7 +2,7 @@ i.MX95 Evaluation Kit ===================== -.. tags:: chip:imx95, arch:arm64 +.. tags:: arch:arm64, chip:imx9, part:imx95, vendor:nxp The kit i.MX95 Evaluation Kit has a pre-installed Linux image which contains u-boot and the i.MX95 reference Linux installation. diff --git a/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst b/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst index 658bf48da81..5b488b0a147 100644 --- a/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst +++ b/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst @@ -2,7 +2,7 @@ QEMU ARMv8-A ============ -.. tags:: chip:virt, arch:arm64 +.. tags:: arch:arm64, chip:qemu, part:virt This board configuration will use QEMU to emulate generic ARM64 v8-A series hardware platform and provides support for these devices: diff --git a/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst b/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst index 997a37514c6..f94253cfce0 100644 --- a/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst +++ b/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst @@ -2,4 +2,4 @@ nanopi_m4 ========= -.. tags:: chip:rk3399 +.. tags:: arch:arm64, chip:rk3399, vendor:rockchip diff --git a/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst b/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst index 186bbce6bc5..d5618dc02ba 100644 --- a/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst +++ b/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst @@ -2,4 +2,4 @@ pinephonepro ============ -.. tags:: chip:rk3399 +.. tags:: arch:arm64, chip:rk3399, vendor:rockchip diff --git a/Documentation/platforms/arm64/rk3588/boards/orangepi-5-pro/index.rst b/Documentation/platforms/arm64/rk3588/boards/orangepi-5-pro/index.rst index 321b41a3b89..19ccb7c4ca3 100644 --- a/Documentation/platforms/arm64/rk3588/boards/orangepi-5-pro/index.rst +++ b/Documentation/platforms/arm64/rk3588/boards/orangepi-5-pro/index.rst @@ -2,7 +2,7 @@ Orange Pi 5 Pro ================ -.. tags:: arch:arm64, chip:rk3588, vendor:xunlong, experimental +.. tags:: arch:arm64, chip:rk3588, vendor:rockchip .. warning:: diff --git a/Documentation/platforms/arm64/rk3588/index.rst b/Documentation/platforms/arm64/rk3588/index.rst index 5451d57d0d2..b1c157201de 100644 --- a/Documentation/platforms/arm64/rk3588/index.rst +++ b/Documentation/platforms/arm64/rk3588/index.rst @@ -2,7 +2,7 @@ Rockchip RK3588 =============== -.. tags:: arch:arm64, chip:rk3588, vendor:rockchip, experimental +.. tags:: arch:arm64, chip:rk3588, vendor:rockchip .. warning:: diff --git a/Documentation/platforms/arm64/zynq-mpsoc/boards/zcu111/index.rst b/Documentation/platforms/arm64/zynq-mpsoc/boards/zcu111/index.rst index a4c773cc6f3..6ef33652daf 100644 --- a/Documentation/platforms/arm64/zynq-mpsoc/boards/zcu111/index.rst +++ b/Documentation/platforms/arm64/zynq-mpsoc/boards/zcu111/index.rst @@ -2,7 +2,7 @@ Zynq UltraScale+ RFSoC ZCU111 ============================= -.. tags:: chip:xczu28dr, chip:fpga, chip:zynq, chip:ultrascale +.. tags:: arch:arm64, chip:zynq-mpsoc, part:fpga, part:ultrascale, part:xczu28dr, vendor:amd The `ZCU111 `_ is a development board based on the Zynq UltraScale+ RFSoC(XCZU28DR) from XilinX(AMD). diff --git a/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst b/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst index 6742c4e5604..6c6462ba057 100644 --- a/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst +++ b/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst @@ -2,7 +2,7 @@ AVR32DEV1 ========= -.. tags:: chip:at32uc3, arch:avr +.. tags:: arch:avr, chip:at32uc3, vendor:microchip .. note:: diff --git a/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst b/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst index d28c8619b80..1162352e842 100644 --- a/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst +++ b/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst @@ -2,7 +2,7 @@ Micropendous 3 ============== -.. tags:: arch:avr, chip:at90usb +.. tags:: arch:avr, chip:at90usb, vendor:microchip This is the documentation page for the port of NuttX to the Micropendous 3 board. This board is developed by `opendous diff --git a/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst b/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst index 0e090b4a4e8..eb2dfc319c3 100644 --- a/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst +++ b/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst @@ -2,7 +2,7 @@ Teensy 2.0 ========== -.. tags:: arch:avr, chip:at90usb +.. tags:: arch:avr, chip:at90usb, vendor:microchip This is the documentation for the port of NuttX to the PJRC Teensy++ 2.0 board. This board is developed by http://pjrc.com/teensy/. The Teensy++ 2.0 is based on diff --git a/Documentation/platforms/avr/atmega/atmega128/boards/amber/index.rst b/Documentation/platforms/avr/atmega/atmega128/boards/amber/index.rst index afb0cce12c1..207bea0e8ec 100644 --- a/Documentation/platforms/avr/atmega/atmega128/boards/amber/index.rst +++ b/Documentation/platforms/avr/atmega/atmega128/boards/amber/index.rst @@ -2,7 +2,7 @@ Amber ===== -.. tags:: chip:atmega128, arch:avr +.. tags:: arch:avr, chip:atmega, part:atmega128, vendor:microchip This is the documentation for the `SoC Robotics Amber Web Server `_ that is diff --git a/Documentation/platforms/avr/atmega/atmega1284p/boards/mega1284p-xplained/index.rst b/Documentation/platforms/avr/atmega/atmega1284p/boards/mega1284p-xplained/index.rst index 3950c5656c1..4d4d1fe39fd 100644 --- a/Documentation/platforms/avr/atmega/atmega1284p/boards/mega1284p-xplained/index.rst +++ b/Documentation/platforms/avr/atmega/atmega1284p/boards/mega1284p-xplained/index.rst @@ -2,6 +2,8 @@ Atmega MEGA1284P-XPLAINED ========================= +.. tags:: arch:avr, chip:atmega, part:atmega1284p, vendor:microchip + The `MEGA1284P-XPLAINED `_ is a development board for the Atmega1284P from Microchip/Atmel. diff --git a/Documentation/platforms/avr/atmega/atmega1284p/boards/moteino-mega/index.rst b/Documentation/platforms/avr/atmega/atmega1284p/boards/moteino-mega/index.rst index 3334f9add75..3304134fc27 100644 --- a/Documentation/platforms/avr/atmega/atmega1284p/boards/moteino-mega/index.rst +++ b/Documentation/platforms/avr/atmega/atmega1284p/boards/moteino-mega/index.rst @@ -2,7 +2,7 @@ Moteino-Mega ============ -.. tags:: arch:avr, chip:atmega1284p +.. tags:: arch:avr, chip:atmega, part:atmega1284p, vendor:microchip This port was contributed by jeditekunum. diff --git a/Documentation/platforms/avr/atmega/atmega2560/boards/arduino-mega2560/index.rst b/Documentation/platforms/avr/atmega/atmega2560/boards/arduino-mega2560/index.rst index 919d52a4d15..b4c4f7f1406 100644 --- a/Documentation/platforms/avr/atmega/atmega2560/boards/arduino-mega2560/index.rst +++ b/Documentation/platforms/avr/atmega/atmega2560/boards/arduino-mega2560/index.rst @@ -2,7 +2,7 @@ Arduino Mega2560 ================ -.. tags:: chip:atmega2560, chip:atmega, vendor:arduino, arch:avr +.. tags:: arch:avr, chip:atmega, part:atmega2560, vendor:microchip This is the documentation for the port of NuttX to the `Arduino Mega 2560 Rev3 `_. The board is based on diff --git a/Documentation/platforms/avr/atmega/atmega2560/boards/elegoo-mega2560r3/index.rst b/Documentation/platforms/avr/atmega/atmega2560/boards/elegoo-mega2560r3/index.rst index e05e79764e9..9f3e445c297 100644 --- a/Documentation/platforms/avr/atmega/atmega2560/boards/elegoo-mega2560r3/index.rst +++ b/Documentation/platforms/avr/atmega/atmega2560/boards/elegoo-mega2560r3/index.rst @@ -2,7 +2,7 @@ Elegoo Mega2560 Rev3 ==================== -.. tags:: chip:atmega2560, chip:atmega, arch:avr, vendor:elegoo, experimental +.. tags:: arch:avr, chip:atmega, part:atmega2560, vendor:microchip .. figure:: elegoo-mega2560r3.jpg :scale: 40 % diff --git a/Documentation/platforms/avr/atmega/index.rst b/Documentation/platforms/avr/atmega/index.rst index 9aa7554adf3..8ead43c6280 100644 --- a/Documentation/platforms/avr/atmega/index.rst +++ b/Documentation/platforms/avr/atmega/index.rst @@ -2,7 +2,7 @@ Microchip Atmega ================ -.. tags:: chip:atmega, arch:avr, vendor:microchip +.. tags:: arch:avr, chip:atmega, vendor:microchip ATMega chips share some common NuttX code in their implementations. diff --git a/Documentation/platforms/avr/avrdx/boards/breadxavr/index.rst b/Documentation/platforms/avr/avrdx/boards/breadxavr/index.rst index 1265766b284..5458fd29e3d 100644 --- a/Documentation/platforms/avr/avrdx/boards/breadxavr/index.rst +++ b/Documentation/platforms/avr/avrdx/boards/breadxavr/index.rst @@ -4,6 +4,8 @@ AVR128DA28 on breadboard ======================== +.. tags:: arch:avr, chip:avrdx, vendor:microchip + This is a AVR128DA28 stuck into a breadboard for the purpose of developing this port for NuttX. It can also be used as a reference for making ports for other boards. diff --git a/Documentation/platforms/avr/avrdx/docs/up_udelay.rst b/Documentation/platforms/avr/avrdx/docs/up_udelay.rst index a89f954ff00..5630cd8ee99 100644 --- a/Documentation/platforms/avr/avrdx/docs/up_udelay.rst +++ b/Documentation/platforms/avr/avrdx/docs/up_udelay.rst @@ -3,7 +3,7 @@ AVR DA/DB family ``up_udelay`` implementation ============================================= NuttX provides functions for busy sleep, these are documented -:doc:`here `. These functions +:doc:`here `. These functions use ``BOARD_LOOPSPERMSEC`` configuration value to determine how many loops need to be done to cause requested delay. Creator of a the board code is supposed to calibrate this value to make the delay as precise as possible. diff --git a/Documentation/platforms/avr/common/context-switch-notes.rst b/Documentation/platforms/avr/common/context-switch-notes.rst index fa12c73b7b1..ee8e7c18ef6 100644 --- a/Documentation/platforms/avr/common/context-switch-notes.rst +++ b/Documentation/platforms/avr/common/context-switch-notes.rst @@ -47,7 +47,7 @@ where it gave the CPU up, which is inside ``up_switch_context()``. This function is supposed to be executed with interrupt disabled ("This function is called only from the NuttX scheduling logic. Interrupts will always be disabled when this function is -called." https://nuttx.apache.org/docs/latest/reference/os/arch.html ) Caller +called." https://nuttx.apache.org/docs/latest/os/arch/arch_api.html ) Caller of the context switch method is therefore responsible for re-enabling interrupts. diff --git a/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst b/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst index afcc55e5495..3203db5d80f 100644 --- a/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst +++ b/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst @@ -2,7 +2,7 @@ demo9s12ne64 ============ -.. tags:: vendor:freescale +.. tags:: arch:hc, chip:m9s12, vendor:nxp This README discusses issues unique to NuttX configurations for the Freescale DEMO9S12NE64 development board. diff --git a/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst b/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst index 381976e4ec9..3874b54d6dc 100644 --- a/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst +++ b/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst @@ -2,7 +2,7 @@ ne64badge ========= -.. tags:: vendor:freescale +.. tags:: arch:hc, chip:m9s12, vendor:nxp This README discusses issues unique to NuttX configurations for the Future Electronics Group NE64 /PoE Badge board based on the MC9S12NE64 hcs12 cpu. diff --git a/Documentation/platforms/hc/m9s12/index.rst b/Documentation/platforms/hc/m9s12/index.rst index deaacc8b5d0..7126200b2e2 100644 --- a/Documentation/platforms/hc/m9s12/index.rst +++ b/Documentation/platforms/hc/m9s12/index.rst @@ -2,7 +2,7 @@ Freescale M9S12 =============== -.. tags:: vendor:freescale +.. tags:: arch:hc, chip:m9s12, vendor:nxp Freescale M68HCS12 ------------------ diff --git a/Documentation/platforms/index.rst b/Documentation/platforms/index.rst index 370556a0e5a..8b7fbb3d3dd 100644 --- a/Documentation/platforms/index.rst +++ b/Documentation/platforms/index.rst @@ -13,4 +13,4 @@ series and boards supported in NuttX: :titlesonly: */index - + /_tags/tagsindex.rst diff --git a/Documentation/platforms/mips/jz4780/boards/mips-creator-ci20/ci20.jpg b/Documentation/platforms/mips/jz4780/boards/ci20/ci20.jpg similarity index 100% rename from Documentation/platforms/mips/jz4780/boards/mips-creator-ci20/ci20.jpg rename to Documentation/platforms/mips/jz4780/boards/ci20/ci20.jpg diff --git a/Documentation/platforms/mips/jz4780/boards/mips-creator-ci20/index.rst b/Documentation/platforms/mips/jz4780/boards/ci20/index.rst similarity index 97% rename from Documentation/platforms/mips/jz4780/boards/mips-creator-ci20/index.rst rename to Documentation/platforms/mips/jz4780/boards/ci20/index.rst index 0488c29c258..0e7e218d57e 100644 --- a/Documentation/platforms/mips/jz4780/boards/mips-creator-ci20/index.rst +++ b/Documentation/platforms/mips/jz4780/boards/ci20/index.rst @@ -2,7 +2,7 @@ MIPS Creator CI20 ================= -.. tags:: arch:mips, chip:jz4780 +.. tags:: arch:mips, chip:jz4780, vendor:ingenic .. figure:: ci20.jpg :figwidth: 100% diff --git a/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst b/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst index fda076ba3d2..182b81cd24b 100644 --- a/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst +++ b/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst @@ -2,6 +2,8 @@ mirtoo ====== +.. tags:: arch:mips, chip:pic32mx, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst b/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst index b13da335051..a3e36eccc5b 100644 --- a/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst +++ b/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst @@ -2,6 +2,8 @@ pic32mx-starterkit ================== +.. tags:: arch:mips, chip:pic32mx, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst b/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst index 1b84e482132..1240a1a6d41 100644 --- a/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst +++ b/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst @@ -2,6 +2,8 @@ pic32mx7mmb =========== +.. tags:: arch:mips, chip:pic32mx, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst b/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst index d5e1bb586c4..1adfd341a37 100644 --- a/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst +++ b/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst @@ -2,6 +2,8 @@ sure-pic32mx ============ +.. tags:: arch:mips, chip:pic32mx, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst b/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst index fa05bc912c2..d323170871a 100644 --- a/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst +++ b/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst @@ -2,6 +2,8 @@ ubw32 ===== +.. tags:: arch:mips, chip:pic32mx, vendor:microchip + .. include:: README.txt :literal: diff --git a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst index 6418cb5ca39..6ac283387cc 100644 --- a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst +++ b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst @@ -2,7 +2,7 @@ chipKIT Wi-FIRE =============== -.. tags:: arch:mips, chip:pic32mz +.. tags:: arch:mips, chip:pic32mz, vendor:microchip .. figure:: chipkit-wifire.jpg :figwidth: 40% diff --git a/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst b/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst index bf6b292422f..52dd2ac70e1 100644 --- a/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst +++ b/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst @@ -2,7 +2,7 @@ Flip & Click PIC32MZ ==================== -.. tags:: arch:mips, chip:pic32mz, vendor:mikroelektronika +.. tags:: arch:mips, chip:pic32mz, vendor:microchip .. figure:: flipclick-pic32mz.jpg :scale: 30 % diff --git a/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst b/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst index 04f88587a22..7037efd8e15 100644 --- a/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst +++ b/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst @@ -2,7 +2,7 @@ PIC32MZ Starter Kit =================== -.. tags:: arch:mips, chip:pic32mz +.. tags:: arch:mips, chip:pic32mz, vendor:microchip Documentation for the NuttX port to the Microchip PIC32MZ Embedded Connectivity (EC) Starter Kit. diff --git a/Documentation/platforms/misco/index.rst b/Documentation/platforms/misoc/index.rst similarity index 100% rename from Documentation/platforms/misco/index.rst rename to Documentation/platforms/misoc/index.rst diff --git a/Documentation/platforms/misco/lm32/boards/misoc/index.rst b/Documentation/platforms/misoc/lm32/boards/misoc/index.rst similarity index 98% rename from Documentation/platforms/misco/lm32/boards/misoc/index.rst rename to Documentation/platforms/misoc/lm32/boards/misoc/index.rst index 8b76a30b8b0..fb95905de4a 100644 --- a/Documentation/platforms/misco/lm32/boards/misoc/index.rst +++ b/Documentation/platforms/misoc/lm32/boards/misoc/index.rst @@ -2,6 +2,8 @@ Misoc ===== +.. tags:: arch:misoc, chip:lm32 + This README applies to a port to NuttX running on a Qemu LM32 system. You can find the Qemu setup at https://bitbucket.org/key2/qemu diff --git a/Documentation/platforms/misco/lm32/index.rst b/Documentation/platforms/misoc/lm32/index.rst similarity index 100% rename from Documentation/platforms/misco/lm32/index.rst rename to Documentation/platforms/misoc/lm32/index.rst diff --git a/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst b/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst index 951f0a5430e..b11ec9c1089 100644 --- a/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst +++ b/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst @@ -2,6 +2,8 @@ or1k ==== +.. tags:: arch:or1k, chip:mor1kx + Generic OpenRISC board, suitable for use with Qemu, for example. .. todo:: diff --git a/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst b/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst index 40c085e0fac..f729320e876 100644 --- a/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst +++ b/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst @@ -2,7 +2,7 @@ SKP16C26 ======== -.. tags:: arch:renesas +.. tags:: arch:renesas, chip:m16c, vendor:renesas 1. The buildroot package can be used to build an M16C toolchain. The toolchain buildroot can be downloaded from buildroot in the NuttX GIT. Instructions for diff --git a/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst b/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst index 26e56b30b4e..dc674376ed4 100644 --- a/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst +++ b/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst @@ -2,7 +2,7 @@ RX65N GRROSE ============ -.. tags:: arch:renesas +.. tags:: arch:renesas, chip:rx65n, vendor:renesas This documentation discusses the port of NuttX to “GR-ROSE” board produced by Gadget Renesas. This board features the RX65N (R5F565NEHDFP 100pin QFP). diff --git a/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst b/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst index d3f027967c0..41c3d1e3559 100644 --- a/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst +++ b/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst @@ -2,7 +2,7 @@ RX65N RSK2MB ============ -.. tags:: arch:renesas +.. tags:: arch:renesas, chip:rx65n, vendor:renesas This README file discusses the port of NuttX to the RX65N RSK2MB board. This board features the RX65N (R5F565NEHDFC 176 pin) diff --git a/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst b/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst index cd821ded712..9a846b23096 100644 --- a/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst +++ b/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst @@ -2,7 +2,7 @@ US7032EVB1 ========== -.. tags:: arch:renesas, experimental +.. tags:: arch:renesas, chip:sh1, vendor:renesas .. warning:: diff --git a/Documentation/platforms/risc-v/allwinner-d1/boards/lichee-rv-86-panel/index.rst b/Documentation/platforms/risc-v/allwinner-d1/boards/lichee-rv-86-panel/index.rst index 62c5f5def43..139b437bc00 100644 --- a/Documentation/platforms/risc-v/allwinner-d1/boards/lichee-rv-86-panel/index.rst +++ b/Documentation/platforms/risc-v/allwinner-d1/boards/lichee-rv-86-panel/index.rst @@ -2,6 +2,8 @@ Lichee RV 86 Panel ================== +.. tags:: arch:risc-v, chip:allwinner-d1, vendor:allwinner + The Sipeed Lichee RV 86 Panel is based on the Allwinner D1 SoC. The board contains a single T-Head C906 RV64 core and 512 MiB of external DDR3 memory. This NuttX port runs in supervisor mode under OpenSBI and uses a FLAT address diff --git a/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst b/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst index 8d99ad135bc..966fe1d3990 100644 --- a/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst +++ b/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst @@ -1,3 +1,5 @@ ======== bl602evb ======== + +.. tags:: arch:risc-v, chip:bl602, vendor:bouffalolab diff --git a/Documentation/platforms/risc-v/bl808/boards/ox64/index.rst b/Documentation/platforms/risc-v/bl808/boards/ox64/index.rst index 799a5304432..7112419cf58 100644 --- a/Documentation/platforms/risc-v/bl808/boards/ox64/index.rst +++ b/Documentation/platforms/risc-v/bl808/boards/ox64/index.rst @@ -2,6 +2,8 @@ PINE64 Ox64 =========== +.. tags:: arch:risc-v, chip:bl808, vendor:bouffalolab + `Ox64 `_ is a RISC-V Single-Board Computer based on the Bouffalo Lab BL808 RISC-V SoC with C906 64-bit CPU Core and E907 / E902 32-bit CPU Cores supported by 64 MB of embedded PSRAM memory, diff --git a/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst b/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst index 3528fc47f46..cb586c59141 100644 --- a/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst +++ b/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst @@ -2,7 +2,7 @@ smartl-c906 =========== -.. tags:: arch:riscv, experimental +.. tags:: arch:risc-v, chip:c906, vendor:thead .. todo:: diff --git a/Documentation/platforms/risc-v/eic7700x/boards/eic7700-evb/index.rst b/Documentation/platforms/risc-v/eic7700x/boards/eic7700-evb/index.rst index 0c3735a0988..813b24028c3 100644 --- a/Documentation/platforms/risc-v/eic7700x/boards/eic7700-evb/index.rst +++ b/Documentation/platforms/risc-v/eic7700x/boards/eic7700-evb/index.rst @@ -2,7 +2,7 @@ ESWIN EIC7700 EVB ================= -.. tags:: chip:eic7700x, arch:risc-v, vendor:eswin, experimental +.. tags:: arch:risc-v, chip:eic7700x, vendor:eswin .. figure:: eic7700-evb.jpg :align: center diff --git a/Documentation/platforms/risc-v/eic7700x/boards/starpro64/index.rst b/Documentation/platforms/risc-v/eic7700x/boards/starpro64/index.rst index e2b5e66888a..7bf0fae665d 100644 --- a/Documentation/platforms/risc-v/eic7700x/boards/starpro64/index.rst +++ b/Documentation/platforms/risc-v/eic7700x/boards/starpro64/index.rst @@ -2,7 +2,7 @@ PINE64 StarPro64 ================ -.. tags:: chip:eic7700x, arch:risc-v, vendor:pine64, experimental +.. tags:: arch:risc-v, chip:eic7700x, vendor:eswin `PINE64 StarPro64 `_ is a RISC-V Single-Board Computer based on the ESWIN EIC7700X RISC-V SoC diff --git a/Documentation/platforms/risc-v/eic7700x/index.rst b/Documentation/platforms/risc-v/eic7700x/index.rst index 6fa44ebc45c..86a84f56383 100644 --- a/Documentation/platforms/risc-v/eic7700x/index.rst +++ b/Documentation/platforms/risc-v/eic7700x/index.rst @@ -2,7 +2,7 @@ ESWIN EIC7700X ============== -.. tags:: chip:eic7700x, arch:risc-v, vendor:eswin +.. tags:: arch:risc-v, chip:eic7700x, vendor:eswin `ESWIN EIC7700X `_ is a 64-bit RISC-V SoC with 4 RISC-V Cores: diff --git a/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit-rust-1/index.rst b/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit-rust-1/index.rst index e4b10abe6b8..558bbc645bb 100644 --- a/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit-rust-1/index.rst +++ b/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit-rust-1/index.rst @@ -2,7 +2,7 @@ ESP32C3 DevKit RUST-1 (Legacy) ============================== -.. tags:: arch:riscv, vendor:espressif +.. tags:: arch:risc-v, chip:esp32c3-legacy, vendor:espressif .. figure:: esp32c3-devkit-rust-1.png :figwidth: 30% diff --git a/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit/index.rst b/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit/index.rst index 3bccfa8c382..50505de13d2 100644 --- a/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit/index.rst +++ b/Documentation/platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit/index.rst @@ -2,6 +2,8 @@ ESP32-C3 DevKit (Legacy) ======================== +.. tags:: arch:risc-v, chip:esp32c3-legacy, vendor:espressif + The ESP32-C3 DevKit is an entry-level development board equipped with either an ESP32-C3-WROOM-02 or an ESP32-C3-MINI-1. ESP32-C3-WROOM-02 and ESP32-C3-MINI-1 are SoMs based on the RISC-V ESP32-C3 CPU. diff --git a/Documentation/platforms/risc-v/esp32c3/boards/esp32-c3-zero/index.rst b/Documentation/platforms/risc-v/esp32c3/boards/esp32-c3-zero/index.rst index a551fe04840..b6303ba0a5d 100644 --- a/Documentation/platforms/risc-v/esp32c3/boards/esp32-c3-zero/index.rst +++ b/Documentation/platforms/risc-v/esp32c3/boards/esp32-c3-zero/index.rst @@ -2,7 +2,7 @@ Waveshare ESP32-C3-Zero =============================== -.. tags:: chip:ESP32-C3 +.. tags:: arch:risc-v, chip:esp32c3, vendor:espressif The `Waveshare ESP32-C3-Zero `_ is a compact development board supplied by Waveshare. diff --git a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst index 761e69dc315..12f21b5dae4 100644 --- a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst +++ b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst @@ -2,6 +2,8 @@ ESP32-C3 DevKit ================ +.. tags:: arch:risc-v, chip:esp32c3, vendor:espressif + The ESP32-C3 DevKit is an entry-level development board equipped with either an ESP32-C3-WROOM-02 or an ESP32-C3-MINI-1. ESP32-C3-WROOM-02 and ESP32-C3-MINI-1 are SoMs based on the RISC-V ESP32-C3 CPU. diff --git a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-supermini/index.rst b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-supermini/index.rst index 6b23fee2371..72fcec23732 100644 --- a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-supermini/index.rst +++ b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-supermini/index.rst @@ -2,7 +2,7 @@ ESP32-C3 SuperMini ================== -.. tags:: chip:ESP32-C3 +.. tags:: arch:risc-v, chip:esp32c3, vendor:espressif The ESP32-C3 SuperMini is a compact third-party board based on the Espressif ESP32-C3 RISC-V SoC. diff --git a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-xiao/index.rst b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-xiao/index.rst index 472c4798815..73ea1a8f4da 100644 --- a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-xiao/index.rst +++ b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-xiao/index.rst @@ -2,6 +2,8 @@ Seeed Studio XIAO ESP32C3 ========================= +.. tags:: arch:risc-v, chip:esp32c3, vendor:espressif + The `Seeed Studio XIAO ESP32C3 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Espressif ESP32C3 ecosystem, sharing the same MCU as ESP32-C3-DevKitC. @@ -253,7 +255,7 @@ smartfs ------- This configuration is identical to the ``nimble`` configuration, except that -there is a 1MB :doc:`SMARTFS ` file system using +there is a 1MB :doc:`SMARTFS ` file system using the chip's on-board flash located at `/data` for storing files. .. note:: @@ -272,5 +274,5 @@ the chip's on-board flash located at `/data` for storing files. .. note:: You can choose to mount other types of file systems to the flash partition, - too! :doc:`NXFFS `, :doc:`littlefs - `, etc. + too! :doc:`NXFFS `, :doc:`littlefs + `, etc. diff --git a/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitc/index.rst b/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitc/index.rst index 3eb958c06b9..a291370056d 100644 --- a/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitc/index.rst +++ b/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitc/index.rst @@ -2,6 +2,8 @@ ESP32-C6-DevKitC-1 ================== +.. tags:: arch:risc-v, chip:esp32c6, vendor:espressif + ESP32-C6-DevKitC-1 is an entry-level development board based on ESP32-C6-WROOM-1(U), a general-purpose module with a 8 MB SPI flash. This board integrates complete Wi-Fi, Bluetooth LE, Zigbee, and Thread functions. You can find the board schematic diff --git a/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitm/index.rst b/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitm/index.rst index 43cfccbfa7e..0e19dc65ce0 100644 --- a/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitm/index.rst +++ b/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitm/index.rst @@ -2,6 +2,8 @@ ESP32-C6-DevKitM-1 ================== +.. tags:: arch:risc-v, chip:esp32c6, vendor:espressif + ESP32-C6-DevKitM-1 is an entry-level development board based on ESP32-C6-MINI-1(U), a general-purpose module with a 4 MB SPI flash. This board integrates complete Wi-Fi, Bluetooth LE, Zigbee, and Thread functions. You can find the board schematic diff --git a/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-xiao/index.rst b/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-xiao/index.rst index 81430a2221b..e4bc794b34e 100644 --- a/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-xiao/index.rst +++ b/Documentation/platforms/risc-v/esp32c6/boards/esp32c6-xiao/index.rst @@ -2,6 +2,8 @@ Seeed Studio XIAO ESP32C6 ========================= +.. tags:: arch:risc-v, chip:esp32c6, vendor:espressif + The `Seeed Studio XIAO ESP32C6 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Espressif ESP32C6 ecosystem, sharing the same MCU as ESP32-C6-DevKitC. diff --git a/Documentation/platforms/risc-v/esp32c6/index.rst b/Documentation/platforms/risc-v/esp32c6/index.rst index 84f139f1e0f..675de258ae8 100644 --- a/Documentation/platforms/risc-v/esp32c6/index.rst +++ b/Documentation/platforms/risc-v/esp32c6/index.rst @@ -934,7 +934,7 @@ adds every source and header file into project and builds it. To sum up, here is an example. ``ulp_example/ulp (../ulp_example/ulp)`` folder selected as example to create a subfolder for ULP but folder that includes ULP source code can be anywhere. For more information about -custom apps, please follow NuttX `Custom Apps How-to `__ guide, +custom apps, please follow NuttX `Custom Apps How-to `__ guide, this example will demonstrate how to add ULP code into a custom application: - Tree view: diff --git a/Documentation/platforms/risc-v/esp32h2/boards/esp32h2-devkit/index.rst b/Documentation/platforms/risc-v/esp32h2/boards/esp32h2-devkit/index.rst index ce548f96968..d9b481b09a0 100644 --- a/Documentation/platforms/risc-v/esp32h2/boards/esp32h2-devkit/index.rst +++ b/Documentation/platforms/risc-v/esp32h2/boards/esp32h2-devkit/index.rst @@ -2,6 +2,8 @@ ESP32-H2-DevKitM-1 ================== +.. tags:: arch:risc-v, chip:esp32h2, vendor:espressif + ESP32-H2-DevKitM-1 is an entry-level development board based on Bluetooth® Low Energy and IEEE 802.15.4 combo module ESP32-H2-MINI-1 or ESP32-H2-MINI-1U. You can find the board schematic `here `_. diff --git a/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-function-ev-board/index.rst b/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-function-ev-board/index.rst index 72115c075b9..7eab1a1af66 100644 --- a/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-function-ev-board/index.rst +++ b/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-function-ev-board/index.rst @@ -4,7 +4,7 @@ ESP32-P4-Function-EV-Board ========================== -.. tags:: chip:esp32p4, arch:risc-v, vendor:espressif +.. tags:: arch:risc-v, chip:esp32p4, vendor:espressif .. figure:: esp32-p4-function-ev-board-isometric_v1.5.2.png :align: center diff --git a/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-tab5/index.rst b/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-tab5/index.rst index 60710556b7d..62e448c76dc 100644 --- a/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-tab5/index.rst +++ b/Documentation/platforms/risc-v/esp32p4/boards/esp32p4-tab5/index.rst @@ -4,7 +4,7 @@ M5Stack Tab5 ============== -.. tags:: chip:esp32p4, arch:risc-v, vendor:espressif +.. tags:: arch:risc-v, chip:esp32p4, vendor:espressif .. figure:: esp32p4-tab5-m5stack-1.png :align: center diff --git a/Documentation/platforms/risc-v/esp32p4/index.rst b/Documentation/platforms/risc-v/esp32p4/index.rst index b9da0ddbe4a..9ac1c6aad78 100644 --- a/Documentation/platforms/risc-v/esp32p4/index.rst +++ b/Documentation/platforms/risc-v/esp32p4/index.rst @@ -2,7 +2,7 @@ Espressif ESP32-P4 ================== -.. tags:: chip:esp32p4, arch:risc-v, vendor:espressif +.. tags:: arch:risc-v, chip:esp32p4, vendor:espressif The ESP32-P4 is a high-performance, highly integrated SoC featuring RISC-V processors, rich multimedia capabilities, and abundant peripherals. It targets @@ -562,7 +562,7 @@ adds every source and header file into project and builds it. To sum up, here is an example. ``ulp_example/ulp (../ulp_example/ulp)`` folder selected as example to create a subfolder for ULP but folder that includes ULP source code can be anywhere. For more information about -custom apps, please follow NuttX `Custom Apps How-to `__ guide, +custom apps, please follow NuttX `Custom Apps How-to `__ guide, this example will demonstrate how to add ULP code into a custom application: - Tree view: diff --git a/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst b/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst index bbaec110746..8f2a1f550cf 100644 --- a/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst +++ b/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst @@ -2,7 +2,7 @@ HiFive1 Rev B ============= -.. tags:: arch:riscv, vendor:sifive, experimental +.. tags:: arch:risc-v, chip:fe310, vendor:sifive .. todo:: diff --git a/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553-hmq/index.rst b/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553-hmq/index.rst index b2e9a3ad5cd..1cc98c41309 100644 --- a/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553-hmq/index.rst +++ b/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553-hmq/index.rst @@ -2,6 +2,8 @@ GD32VW553-HMQ ============= +.. tags:: arch:risc-v, chip:gd32vw55x, vendor:gigadevice + The GD32VW553-HMQ is the generic evaluation board for the GD32VW553HMQ6 (Nuclei N307, Wi-Fi 6 + BLE 5.3). It carries an on-board USB/Serial port provides the USB serial console. diff --git a/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553k-start/index.rst b/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553k-start/index.rst index b10833d2c7d..16d134d8c10 100644 --- a/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553k-start/index.rst +++ b/Documentation/platforms/risc-v/gd32vw55x/boards/gd32vw553k-start/index.rst @@ -2,6 +2,8 @@ GD32VW553K-START ================ +.. tags:: arch:risc-v, chip:gd32vw55x, vendor:gigadevice + The GD32VW553K-START is the GigaDevice evaluation board for the GD32VW553KMQ (Nuclei N307, Wi-Fi 6 + BLE 5.3). It carries an on-board GD-Link debug probe which also provides the USB serial console. diff --git a/Documentation/platforms/risc-v/hpm6000/boards/hpm6360evk/index.rst b/Documentation/platforms/risc-v/hpm6000/boards/hpm6360evk/index.rst index 78cfac80392..3486ab03236 100644 --- a/Documentation/platforms/risc-v/hpm6000/boards/hpm6360evk/index.rst +++ b/Documentation/platforms/risc-v/hpm6000/boards/hpm6360evk/index.rst @@ -2,6 +2,8 @@ hpm6360evk ========== +.. tags:: arch:risc-v, chip:hpm6000, vendor:hpmicro + 1. Download and install toolchain:: $ wget https://github.com/hpmicro/riscv-gnu-toolchain/releases/download/2022.05.15/riscv32-unknown-elf-newlib-multilib_2022.05.15_linux.tar.gz diff --git a/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst b/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst index ba01bf35dfd..cf8b4ce5c3e 100644 --- a/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst +++ b/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst @@ -2,7 +2,7 @@ HPM6750EVK2 =========== -.. tags:: arch:riscv, vendor:hpmicro, experimental +.. tags:: arch:risc-v, chip:hpm6750, vendor:hpmicro .. figure:: hpm6750evk2.png :figwidth: 50% diff --git a/Documentation/platforms/risc-v/jh7110/boards/star64/index.rst b/Documentation/platforms/risc-v/jh7110/boards/star64/index.rst index 8028e8b9d8a..589b744c129 100644 --- a/Documentation/platforms/risc-v/jh7110/boards/star64/index.rst +++ b/Documentation/platforms/risc-v/jh7110/boards/star64/index.rst @@ -2,6 +2,8 @@ PINE64 Star64 ============= +.. tags:: arch:risc-v, chip:jh7110, vendor:starfive + `Star64 `_ is a 64-bit RISC-V based Single Board Computer powered by StarFive JH7110 Quad-Core SiFive U74 64-Bit CPU, Imagination Technology BX-4-32 GPU and supports up to 8GB 1866MHz LPDDR4 memory. diff --git a/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst b/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst index 83bb368ab9b..5d6e45a4a8d 100644 --- a/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst +++ b/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst @@ -2,7 +2,7 @@ Maix Bit ======== -.. tags:: experimental, arch:risc-v, chip:k210, vendor:sipeed +.. tags:: arch:risc-v, chip:k210, vendor:canaan .. figure:: maix-bit.png :figwidth: 50% diff --git a/Documentation/platforms/risc-v/k230/boards/canmv230/index.rst b/Documentation/platforms/risc-v/k230/boards/canmv230/index.rst index 3c27131c3b5..3212f44bf08 100644 --- a/Documentation/platforms/risc-v/k230/boards/canmv230/index.rst +++ b/Documentation/platforms/risc-v/k230/boards/canmv230/index.rst @@ -2,6 +2,8 @@ CanMV K230 ============= +.. tags:: arch:risc-v, chip:k230, vendor:canaan + The `CanMV K230 `_ is a raspberry-pi sized single board computer with 512MB DRAM and a microSD card slot for booting. It comes with serial console, Ethernet, HDMI and USB/OTG ports. Unfortuunately it doesn't support JTAG alike debugging interfaces. The `K230 SDK `_ contains source code, libraries and user guides for booting up an AMP environment with Linux on CPU0 and RT-Thread on CPU1. @@ -9,7 +11,7 @@ The `K230 SDK `_ contains source code, lib K230 boots from CPU0 and loads U-Boot SPL into DRAM first, then U-Boot kicks off OpenSBI wrapped Linux/RTT OS images on respective CPU cores accordingly. The K230 U-Boot kicks off firmwares in machine mode, thus it allows flat, protected or kernel -NuttX `build modes `_. The kernel build mode further works with OpenSBI or a builtin minimal SBI layer. +NuttX `build modes `_. The kernel build mode further works with OpenSBI or a builtin minimal SBI layer. Preparations ============ diff --git a/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst b/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst index 3de222cdbf9..801df4fa6b3 100644 --- a/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst +++ b/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst @@ -2,7 +2,7 @@ Arty A7 ======= -.. tags:: arch:riscv, vendor:sifive, experimental +.. tags:: arch:risc-v, chip:litex .. todo:: diff --git a/Documentation/platforms/risc-v/mpfs/boards/icicle/index.rst b/Documentation/platforms/risc-v/mpfs/boards/icicle/index.rst index b66ea75ae23..14a221fdca0 100644 --- a/Documentation/platforms/risc-v/mpfs/boards/icicle/index.rst +++ b/Documentation/platforms/risc-v/mpfs/boards/icicle/index.rst @@ -2,6 +2,8 @@ PolarFire SoC Icicle Kit ======================== +.. tags:: arch:risc-v, chip:mpfs, vendor:microchip + .. list-table:: :align: center diff --git a/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst b/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst index fa418ef7a48..ee4e4897717 100644 --- a/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst +++ b/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst @@ -2,6 +2,8 @@ rv-virt ======= +.. tags:: arch:risc-v, chip:qemu-rv + RISC-V Toolchain ================ diff --git a/Documentation/platforms/risc-v/rp23xx-rv/boards/raspberrypi-pico-2-rv/index.rst b/Documentation/platforms/risc-v/rp23xx-rv/boards/raspberrypi-pico-2-rv/index.rst index fa3f94ae0d9..c6281ba3003 100644 --- a/Documentation/platforms/risc-v/rp23xx-rv/boards/raspberrypi-pico-2-rv/index.rst +++ b/Documentation/platforms/risc-v/rp23xx-rv/boards/raspberrypi-pico-2-rv/index.rst @@ -2,7 +2,7 @@ Raspberry Pi Pico 2 RISC-V =============================== -.. tags:: chip:rp2350 +.. tags:: arch:risc-v, chip:rp23xx-rv, part:rp2350, vendor:raspberry-pi The `Raspberry Pi Pico 2 `_ is a general purpose board supplied by Raspberry Pi. diff --git a/Documentation/platforms/risc-v/rp23xx-rv/index.rst b/Documentation/platforms/risc-v/rp23xx-rv/index.rst index 22c5188a3f4..e9c6b4e5f23 100644 --- a/Documentation/platforms/risc-v/rp23xx-rv/index.rst +++ b/Documentation/platforms/risc-v/rp23xx-rv/index.rst @@ -2,7 +2,7 @@ Raspberry Pi rp2350 RISC-V ========================== -.. tags:: chip:rp2350 +.. tags:: arch:risc-v, chip:rp23xx-rv, part:rp2350, vendor:raspberry-pi The rp2350 is a dual core chip produced by Raspberry Pi that is based on ARM Cortex-M33 or the Hazard3 RISC-V. diff --git a/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst b/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst index a8ff056eb24..a4344a539dc 100644 --- a/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst +++ b/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst @@ -2,7 +2,7 @@ RV32M1-VEGA =========== -.. tags:: arch:riscv, vendor:vega, experimental +.. tags:: arch:risc-v, chip:rv32m1, vendor:nxp .. figure:: rv32m1-vega.png :figwidth: 40% diff --git a/Documentation/platforms/risc-v/sg2000/boards/milkv_duos/index.rst b/Documentation/platforms/risc-v/sg2000/boards/milkv_duos/index.rst index aa25aba48ba..e1f289c4298 100644 --- a/Documentation/platforms/risc-v/sg2000/boards/milkv_duos/index.rst +++ b/Documentation/platforms/risc-v/sg2000/boards/milkv_duos/index.rst @@ -2,6 +2,8 @@ Milk-V Duo S ============ +.. tags:: arch:risc-v, chip:sg2000, vendor:sophgo + `Milk-V Duo S `_ is a RISC-V Single-Board Computer based on the SOPHGO SG2000 RISC-V SoC with T-Head C906 64-bit Main Processor, 512 MB of SIP DRAM memory and 100 Mbps Ethernet. diff --git a/Documentation/platforms/sim/sim/boards/sim/index.rst b/Documentation/platforms/sim/sim/boards/sim/index.rst index 2e2ad3d63e2..73403cda61f 100644 --- a/Documentation/platforms/sim/sim/boards/sim/index.rst +++ b/Documentation/platforms/sim/sim/boards/sim/index.rst @@ -2,7 +2,7 @@ SIM === -.. tags:: arch:sim +.. tags:: arch:sim, chip:sim This documentation page describes the contents of the build configurations available for the NuttX "sim" target. The sim target is a NuttX port that runs diff --git a/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst b/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst index 94cbbea4cf0..e100b3b2253 100644 --- a/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst +++ b/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst @@ -2,3 +2,5 @@ xx3803 ====== +.. tags:: arch:sparc, chip:bm3803 + diff --git a/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst b/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst index d98eea0ff6d..2e48668d723 100644 --- a/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst +++ b/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst @@ -2,3 +2,5 @@ xx3823 ====== +.. tags:: arch:sparc, chip:bm3823 + diff --git a/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst b/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst index f507dddf04b..dcb130acdcd 100644 --- a/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst +++ b/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst @@ -1,3 +1,5 @@ =========== s698pm-dkit =========== + +.. tags:: arch:sparc, chip:s698pm diff --git a/Documentation/platforms/tricore/tc397/boards/kit_a2g_tc397_tft/index.rst b/Documentation/platforms/tricore/tc397/boards/a2g-tc397-5v-tft/index.rst similarity index 97% rename from Documentation/platforms/tricore/tc397/boards/kit_a2g_tc397_tft/index.rst rename to Documentation/platforms/tricore/tc397/boards/a2g-tc397-5v-tft/index.rst index 2029a9e28ef..49d0ff48f0b 100644 --- a/Documentation/platforms/tricore/tc397/boards/kit_a2g_tc397_tft/index.rst +++ b/Documentation/platforms/tricore/tc397/boards/a2g-tc397-5v-tft/index.rst @@ -2,6 +2,8 @@ A2G_TC397_5V_TFT ================= +.. tags:: arch:tricore, chip:tc397, vendor:infineon + This page file describes the contents of the build configurations available for the NuttX TriCore port. diff --git a/Documentation/platforms/tricore/tc4d9/boards/triboard_tc4x9_com/index.rst b/Documentation/platforms/tricore/tc4da/boards/triboard_tc4x9_com/index.rst similarity index 96% rename from Documentation/platforms/tricore/tc4d9/boards/triboard_tc4x9_com/index.rst rename to Documentation/platforms/tricore/tc4da/boards/triboard_tc4x9_com/index.rst index c3b391fc564..438c9d97eeb 100644 --- a/Documentation/platforms/tricore/tc4d9/boards/triboard_tc4x9_com/index.rst +++ b/Documentation/platforms/tricore/tc4da/boards/triboard_tc4x9_com/index.rst @@ -2,6 +2,8 @@ TRIBOARD_TC4X9_COM ================== +.. tags:: arch:tricore, chip:tc4da, vendor:infineon + This port should work on TRIBOARD_TC4X9_COM with a proper CPU. The mandatory CPU features are: diff --git a/Documentation/platforms/tricore/tc4d9/index.rst b/Documentation/platforms/tricore/tc4da/index.rst similarity index 100% rename from Documentation/platforms/tricore/tc4d9/index.rst rename to Documentation/platforms/tricore/tc4da/index.rst diff --git a/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst b/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst index 31e97e9ea87..46358d3728d 100644 --- a/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst +++ b/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst @@ -2,6 +2,8 @@ qemu-i486 ========= +.. tags:: arch:x86, chip:qemu + Port of NuttX to QEMU in i486 mode. This port will also run on real i486 hardware (Google the Bifferboard). diff --git a/Documentation/platforms/x86_64/intel64/index.rst b/Documentation/platforms/x86_64/intel64/index.rst index 3bdd8da4d6a..b2752d3bdcc 100644 --- a/Documentation/platforms/x86_64/intel64/index.rst +++ b/Documentation/platforms/x86_64/intel64/index.rst @@ -138,9 +138,3 @@ You can find this in most Linux distributions:: Supported Boards ================ - -.. toctree:: - :glob: - :maxdepth: 1 - - boards/*/* diff --git a/Documentation/platforms/x86_64/intel64/boards/qemu-intel64/index.rst b/Documentation/platforms/x86_64/qemu/boards/qemu-intel64/index.rst similarity index 99% rename from Documentation/platforms/x86_64/intel64/boards/qemu-intel64/index.rst rename to Documentation/platforms/x86_64/qemu/boards/qemu-intel64/index.rst index e6b38d88f30..a244980fc5a 100644 --- a/Documentation/platforms/x86_64/intel64/boards/qemu-intel64/index.rst +++ b/Documentation/platforms/x86_64/qemu/boards/qemu-intel64/index.rst @@ -2,6 +2,8 @@ qemu-intel64 ============ +.. tags:: arch:x86_64, chip:qemu + This page file describes the contents of the build configurations available for the NuttX QEMU x86_64 port. diff --git a/Documentation/platforms/x86_64/qemu/index.rst b/Documentation/platforms/x86_64/qemu/index.rst new file mode 100644 index 00000000000..6b90c9c07c1 --- /dev/null +++ b/Documentation/platforms/x86_64/qemu/index.rst @@ -0,0 +1,12 @@ +==== +QEMU +==== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-2432S028/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-2432S028/index.rst index d32ebc4f7a4..92cabc14d56 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-2432S028/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-2432S028/index.rst @@ -2,7 +2,7 @@ ESP32-2432S028 ============== -.. tags:: chip:esp32, chip:esp32wrover32 +.. tags:: arch:xtensa, chip:esp32, part:esp32wrover32, vendor:espressif The ESP32-2432S028 is a development board based on an ESP32-WROVER-32 module. It is designed for a wide range of applications, particularly in the field of the Internet of Things (IoT). diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst index c024e9ac543..9b6c1964da6 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-audio-kit/index.rst @@ -2,7 +2,7 @@ ESP32-AUDIO-KIT =============== -.. tags:: chip:esp32, chip:esp32a1s +.. tags:: arch:xtensa, chip:esp32, part:esp32a1s, vendor:espressif The `Ai-Thinker ESP32 Audio Kit `_ is a development board for the ESP32 SoC from Espressif, based on Ai-Thinker ESP32-A1S audio module. diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-devkitc/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-devkitc/index.rst index ecfea34d30c..b868a7f8e5c 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-devkitc/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-devkitc/index.rst @@ -2,7 +2,7 @@ ESP32 DevKitC ============= -.. tags:: chip:esp32, chip:esp32wroom32 +.. tags:: arch:xtensa, chip:esp32, part:esp32wroom32, vendor:espressif The `ESP32 DevKitC `_ is a development board for the ESP32 SoC from Espressif, based on a ESP-WROOM-32 module. You can find the original V2 version and the newer V4 variant. They are pin compatible. diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst index 76054bd3cad..9567ae67dd6 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst @@ -5,7 +5,7 @@ ESP32-Ethernet-Kit V1.2 ======================= -.. tags:: chip:esp32, chip:esp32wrover32 +.. tags:: arch:xtensa, chip:esp32, part:esp32wrover32, vendor:espressif The ESP32-Ethernet-Kit is an Ethernet-to-Wi-Fi development board that enables Ethernet devices to be interconnected over Wi-Fi. At the same time, to provide more flexible power diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-lyrat/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-lyrat/index.rst index 82a8a6687e8..3abea38a360 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-lyrat/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-lyrat/index.rst @@ -5,7 +5,7 @@ ESP32-LyraT V4.3 ================ -.. tags:: chip:esp32, chip:esp32wrover32 +.. tags:: arch:xtensa, chip:esp32, part:esp32wrover32, vendor:espressif The ESP32-LyraT development board is a hardware platform designed for the dual-core ESP32 audio applications, e.g., Wi-Fi or BT audio speakers, diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-pico-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-pico-kit/index.rst index 97550a15361..ac08c1bf8cb 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-pico-kit/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-pico-kit/index.rst @@ -1,7 +1,7 @@ ESP32-PICO-KIT V4 ================= -.. tags:: chip:esp32, chip:esp32picod4 +.. tags:: arch:xtensa, chip:esp32, part:esp32picod4, vendor:espressif This guide shows how to get started with the ESP32-PICO-KIT V4/V4.1 mini development board. diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-wrover-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-wrover-kit/index.rst index 093b573b771..9df44b97f4b 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-wrover-kit/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-wrover-kit/index.rst @@ -2,7 +2,7 @@ ESP-WROVER-KIT ============== -.. tags:: chip:esp32, chip:esp32wrover32 +.. tags:: arch:xtensa, chip:esp32, part:esp32wrover32, vendor:espressif The `ESP-WROVER-KIT `_ is a development board for the ESP32 SoC from Espressif, based on a ESP32-WROVER-B module. diff --git a/Documentation/platforms/xtensa/esp32/boards/heltec_wifi_lora32/index.rst b/Documentation/platforms/xtensa/esp32/boards/heltec_wifi_lora32/index.rst index 48d156ac731..2721beeebac 100644 --- a/Documentation/platforms/xtensa/esp32/boards/heltec_wifi_lora32/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/heltec_wifi_lora32/index.rst @@ -4,7 +4,7 @@ Heltec WiFi LoRa 32 V2 ====================== -.. tags:: chip:esp32, chip:esp32wrover32 +.. tags:: arch:xtensa, chip:esp32, part:esp32wrover32, vendor:espressif The Heltec WiFi LoRa32 is a development board based on an ESP32 microcontroller. It is designed for LoRa application. diff --git a/Documentation/platforms/xtensa/esp32/index.rst b/Documentation/platforms/xtensa/esp32/index.rst index 7af5670f0f1..e39fefa1fe8 100644 --- a/Documentation/platforms/xtensa/esp32/index.rst +++ b/Documentation/platforms/xtensa/esp32/index.rst @@ -547,7 +547,7 @@ Linker Segments ESP32 has 4 generic timers of 64 bits (2 from Group 0 and 2 from Group 1). They're accessible as character drivers, the configuration along with a guidance on how to run the example and the description of the application level interface -can be found :doc:`here `. +can be found :doc:`here `. Watchdog Timers =============== @@ -556,7 +556,7 @@ ESP32 has 3 WDTs. 2 MWDTS from the Timers Module and 1 RWDT from the RTC Module (Currently not supported yet). They're accessible as character drivers, The configuration along with a guidance on how to run the example and the description of the application level interface can be found -:doc:`here `. +:doc:`here `. SMP === diff --git a/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst b/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst index b5ccabea7f5..6d75fb09d33 100644 --- a/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst +++ b/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst @@ -2,7 +2,7 @@ ESP32-S2-Kaluga-1 Kit v1.3 ========================== -.. tags:: chip:esp32, chip:esp32s2 +.. tags:: arch:xtensa, chip:esp32s2, vendor:espressif The `ESP32-S2-Kaluga-1 kit v1.3 `_ is a development kit by Espressif that is mainly created to: diff --git a/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-saola-1/index.rst b/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-saola-1/index.rst index 8ec09a6153d..cff888084ae 100644 --- a/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-saola-1/index.rst +++ b/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-saola-1/index.rst @@ -2,7 +2,7 @@ ESP32-S2-Saola-1 ================ -.. tags:: chip:esp32, chip:esp32s2 +.. tags:: arch:xtensa, chip:esp32s2, vendor:espressif The `ESP32-S2-Saola-1 `_ is a development board for the ESP32-S2 SoC from Espressif, based on the following modules: diff --git a/Documentation/platforms/xtensa/esp32s2/index.rst b/Documentation/platforms/xtensa/esp32s2/index.rst index 168fe8fcdb6..a59a6f72d59 100644 --- a/Documentation/platforms/xtensa/esp32s2/index.rst +++ b/Documentation/platforms/xtensa/esp32s2/index.rst @@ -529,7 +529,7 @@ Linker Segments ESP32-S2 has 4 generic timers of 64 bits (2 from Group 0 and 2 from Group 1). They're accessible as character drivers, the configuration along with a guidance on how to run the example and the description of the application level -interface can be found in the :doc:`timer documentation `. +interface can be found in the :doc:`timer documentation `. Watchdog Timers =============== @@ -538,7 +538,7 @@ ESP32-S2 has 3 WDTs. 2 MWDTs from the Timers Module and 1 RWDT from the RTC Modu (Currently not supported yet). They're accessible as character drivers, The configuration along with a guidance on how to run the example and the description of the application level interface can be found in the -:doc:`watchdog documentation `. +:doc:`watchdog documentation `. I2S === @@ -1066,7 +1066,7 @@ adds every source and header file into project and builds it. To sum up, here is an example. ``ulp_example/ulp (../ulp_example/ulp)`` folder selected as example to create a subfolder for ULP but folder that includes ULP source code can be anywhere. For more information about -custom apps, please follow NuttX `Custom Apps How-to `__ guide, +custom apps, please follow NuttX `Custom Apps How-to `__ guide, this example will demonstrate how to add ULP code into a custom application: - Tree view: diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-8048S043/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-8048S043/index.rst index e9d23045fb6..88979fee9ad 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-8048S043/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-8048S043/index.rst @@ -2,7 +2,7 @@ ESP32S3-8048S043 ================ -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The `ESP32S3-8048S343 ` is a dual-core MCU, integrated WI-FI and Bluetooth functions, the main frequency can reach 240MHz, 512KB SRAM, 384KB ROM, 8M PSRAM, Flash size is 16MB. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst index dc91b84ef12..4baa9421a1c 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-devkit/index.rst @@ -2,7 +2,7 @@ ESP32S3-DevKit ============== -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The `ESP32S3 DevKit `_ is a development board for the ESP32-S3 SoC from Espressif, based on a ESP32-S3-WROOM-1 module. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-eye/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-eye/index.rst index f2596e89f7b..ea12e0e2d31 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-eye/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-eye/index.rst @@ -2,7 +2,7 @@ ESP32-S3-EYE ============= -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The `ESP32-S3-EYE `_ is a small-sized AI development board from Espressif featuring the ESP32-S3 CPU with a 2-Megapixel camera, an LCD display, a microphone, an 8 MB Octal PSRAM and an 8 MB flash. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-korvo-2/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-korvo-2/index.rst index cd2aa06aca7..edb4de60705 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-korvo-2/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-korvo-2/index.rst @@ -2,7 +2,7 @@ ESP32-S3-Korvo-2 V3.0 ===================== -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The ESP32-S3-Korvo-2 is a multimedia development board based on the ESP32-S3 chip. It is equipped with a two-microphone array which is suitable for voice recognition and near/far-field voice wake-up applications. The board integrates multiple peripherals such as LCD, camera, and microSD card. It also supports JPEG video stream processing. With all of its outstanding features, the board is an ideal choice for the development of low-cost and low-power network-connected audio and video products. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lcd-ev/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lcd-ev/index.rst index 430642b0981..d013930dd0f 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lcd-ev/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lcd-ev/index.rst @@ -2,7 +2,7 @@ ESP32-S3-LCD-EV =============== -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The `ESP32-S3-LCD-EV-Board `_ is a small-sized AI development board from Espressif featuring the ESP32-S3 CPU with a touchscreen LCD display, dual microphone, an 16 MB Octal PSRAM and an 16 MB flash. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lhcbit/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lhcbit/index.rst index 759ded71ced..ca3c0facf50 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lhcbit/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-lhcbit/index.rst @@ -2,7 +2,7 @@ esp32s3-lhcbit ================= -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif This page discusses issues unique to NuttX configurations for the ESP32S3-LHCBit board. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-m5-cardputer/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-m5-cardputer/index.rst index eda4fe85e84..a9f91867204 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-m5-cardputer/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-m5-cardputer/index.rst @@ -4,7 +4,7 @@ M5Stack Cardputer ================= -.. tags:: chip:esp32, chip:esp32s3, arch:xtensa, vendor:espressif +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif .. figure:: esp32-cardputer-image-1.png :align: center diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-touch-lcd7/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-touch-lcd7/index.rst index b0f50683332..07ea323cdd8 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-touch-lcd7/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-touch-lcd7/index.rst @@ -2,7 +2,7 @@ esp32s3-touch-lcd7 ================== -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif This page discusses issues unique to NuttX configurations for the ESP32S3-Touch-LCD-7 board. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-ws-lcd128/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-ws-lcd128/index.rst index dd5318cd2da..bfec2263ed0 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-ws-lcd128/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-ws-lcd128/index.rst @@ -2,7 +2,7 @@ ESP32S3-WS-LCD128 ================= -.. tags:: chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif .. figure:: ESP32-S3-Touch-LCD-1.28.jpg :align: center diff --git a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-xiao/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-xiao/index.rst index 20a2d1a5af8..f5ba123d68d 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-xiao/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/esp32s3-xiao/index.rst @@ -2,7 +2,7 @@ Seeed Studio XIAO ESP32S3 ========================= -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The `Seeed Studio XIAO ESP32S3 `_ is a general purpose board supplied by Seeed Studio and it is compatible with the Espressif ESP32S3 ecosystem, sharing the same MCU as ESP32-S3-DevKitC. diff --git a/Documentation/platforms/xtensa/esp32s3/boards/lckfb-szpi-esp32s3/index.rst b/Documentation/platforms/xtensa/esp32s3/boards/lckfb-szpi-esp32s3/index.rst index cb770388f5a..b6762f8c263 100644 --- a/Documentation/platforms/xtensa/esp32s3/boards/lckfb-szpi-esp32s3/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/boards/lckfb-szpi-esp32s3/index.rst @@ -2,7 +2,7 @@ LCKFB SZPI ESP32-S3 =================== -.. tags:: chip:esp32, chip:esp32s3 +.. tags:: arch:xtensa, chip:esp32s3, vendor:espressif The `LCKFB SZPI ESP32-S3 `_ is a development board for the ESP32-S3 SoC from Jialichuang, based on a ESP32-S3-WROOM-1 module. diff --git a/Documentation/platforms/xtensa/esp32s3/index.rst b/Documentation/platforms/xtensa/esp32s3/index.rst index 95914f0ccb1..f35d6ccb5d5 100644 --- a/Documentation/platforms/xtensa/esp32s3/index.rst +++ b/Documentation/platforms/xtensa/esp32s3/index.rst @@ -1053,7 +1053,7 @@ adds every source and header file into project and builds it. To sum up, here is an example. ``ulp_example/ulp (../ulp_example/ulp)`` folder selected as example to create a subfolder for ULP but folder that includes ULP source code can be anywhere. For more information about -custom apps, please follow NuttX `Custom Apps How-to `__ guide, +custom apps, please follow NuttX `Custom Apps How-to `__ guide, this example will demonstrate how to add ULP code into a custom application: - Tree view: diff --git a/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst b/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst index d31a4473685..38fc8dc1e5d 100644 --- a/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst +++ b/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst @@ -2,6 +2,8 @@ z16f2800100zcog =============== +.. tags:: arch:z16, chip:z16f, vendor:zilog + z16f Microcontroller. This port use the Zilog z16f2800100zcog development kit and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. diff --git a/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst b/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst index 542bc14a782..f731c54c686 100644 --- a/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst +++ b/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst @@ -2,6 +2,8 @@ ez80f0910200kitg ================ +.. tags:: arch:z80, chip:ez80, vendor:zilog + ez80Acclaim! Microcontroller. This port use the Zilog ez80f0910200kitg development kit, eZ80F091 part, and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. diff --git a/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst b/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst index b0e082e9167..f13e9c3f25a 100644 --- a/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst +++ b/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst @@ -2,6 +2,8 @@ ez80f0910200zco =============== +.. tags:: arch:z80, chip:ez80, vendor:zilog + ez80Acclaim! Microcontroller. This port use the Zilog ez80f0910200zco development kit, eZ80F091 part, and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. diff --git a/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst b/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst index 5e9403c7d07..072237aca5b 100644 --- a/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst +++ b/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst @@ -2,6 +2,8 @@ makerlisp ========= +.. tags:: arch:z80, chip:ez80, vendor:zilog + This port use the MakerLisp machine based on an eZ80F091 ez80Acclaim! Microcontroller, and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under Windows. A Windows native diff --git a/Documentation/platforms/z80/ez80/boards/z20x/index.rst b/Documentation/platforms/z80/ez80/boards/z20x/index.rst index 0e88f8fafd6..aa2b94bd9d2 100644 --- a/Documentation/platforms/z80/ez80/boards/z20x/index.rst +++ b/Documentation/platforms/z80/ez80/boards/z20x/index.rst @@ -2,6 +2,8 @@ z20x ==== +.. tags:: arch:z80, chip:ez80, vendor:zilog + Microcontroller. This directory holds the port of NuttX to the z80x board based on an ez80Acclaim! eZ80F091 microcontroller. diff --git a/Documentation/platforms/z80/z180/boards/p112/index.rst b/Documentation/platforms/z80/z180/boards/p112/index.rst index 926c157472a..1846d199f65 100644 --- a/Documentation/platforms/z80/z180/boards/p112/index.rst +++ b/Documentation/platforms/z80/z180/boards/p112/index.rst @@ -2,6 +2,8 @@ p112 ==== +.. tags:: arch:z80, chip:z180, vendor:zilog + The P112 is notable because it was the first of the hobbyist single board computers to reach the production stage. The P112 hobbyist computers were relatively widespread and inspired other hobbyist centered home brew diff --git a/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst b/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst index db02b2bbd13..a0184edc942 100644 --- a/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst +++ b/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst @@ -2,6 +2,8 @@ z8encore000zco ============== +.. tags:: arch:z80, chip:z8, vendor:zilog + z8Encore! Microcontroller. This port use the Zilog z8encore000zco development kit, Z8F6403 part, and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. diff --git a/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst b/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst index 70972cabb6d..e7fd4b553c0 100644 --- a/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst +++ b/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst @@ -2,6 +2,8 @@ z8f64200100kit ============== +.. tags:: arch:z80, chip:z8, vendor:zilog + z8Encore! Microcontroller. This port use the Zilog z8f64200100kit development kit, Z8F6423 part, and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. diff --git a/Documentation/platforms/z80/z80/boards/z80sim/index.rst b/Documentation/platforms/z80/z80/boards/z80sim/index.rst index bb0f4612bd0..05a66ab7957 100644 --- a/Documentation/platforms/z80/z80/boards/z80sim/index.rst +++ b/Documentation/platforms/z80/z80/boards/z80sim/index.rst @@ -2,6 +2,8 @@ z80sim ====== +.. tags:: arch:z80, chip:z80, vendor:zilog + z80 Microcontroller. This port uses a Z80 instruction set simulator called z80sim. This port also uses the SDCC toolchain (http://sdcc.sourceforge.net/") (verified with version 2.6.0). diff --git a/Documentation/quickstart/organization.rst b/Documentation/quickstart/organization.rst index 6d80e7f2e09..c30ca531443 100644 --- a/Documentation/quickstart/organization.rst +++ b/Documentation/quickstart/organization.rst @@ -85,7 +85,7 @@ README.md file for information on how to build it. This sub-directory holds the NuttX supported architectures. -For details see :doc:`/components/arch/index`. +For details see :doc:`/os/arch/index`. ``nuttx/binfmt`` ================ @@ -131,14 +131,14 @@ For details see :doc:`/components/cmake`. This sub-directory holds the NuttX cryptographic sub-system. -For details see :doc:`/components/crypto`. +For details see :doc:`/os/crypto`. ``nuttx/drivers`` ================= This directory holds architecture-independent device drivers. -For details see :doc:`/components/drivers/index`. +For details see :doc:`/os/drivers/index`. ``nuttx/fs`` ============ @@ -152,7 +152,7 @@ described `below <#NxFileSystem>`__. This directory contains files for graphics/video support under NuttX. -For details see :doc:`/components/nxgraphics/index`. +For details see :doc:`/os/graphics/index`. ``nuttx/include`` ================= @@ -166,14 +166,14 @@ file retained in can be included in the *normal* fashion: This directory holds a collection of standard libc-like functions with custom interfaces into NuttX. -For details see :doc:`/components/libs/index`. +For details see :doc:`/os/libs/index`. ``nuttx/mm`` ============ This is the NuttX memory manager. -For details see :doc:`/components/mm/index`. +For details see :doc:`/os/memory/index`. ``nuttx/net`` ============= @@ -181,14 +181,14 @@ For details see :doc:`/components/mm/index`. This directory contains the implementation of the NuttX networking layer including internal socket APIs. -For details see :doc:`/components/net/index`. +For details see :doc:`/os/networking/index`. ``nuttx/openamp`` ================= This directory contains OpenAMP support for NuttX. -For details see :doc:`/components/openamp`. +For details see :doc:`/os/openamp`. ``nuttx/pass1`` =============== @@ -217,7 +217,7 @@ the contents of this directory are built. This directory holds a syscall interface that can be used for communication between user-mode applications and the kernel-mode RTOS. -For details see :doc:`/components/syscall`. +For details see :doc:`/os/syscall`. ``nuttx/tools`` =============== @@ -235,7 +235,7 @@ building <#configandbuild>`__ NuttX. This directory holds support for video sub-system. -For details see :doc:`/components/video`. +For details see :doc:`/os/video`. ``nuttx/wireless`` ================== @@ -243,7 +243,7 @@ For details see :doc:`/components/video`. This directory holds support for hardware-independent wireless support. -For details see :doc:`/components/wireless`. +For details see :doc:`/os/wireless`. ``nuttx/CMakeLists.txt`` ======================== diff --git a/Documentation/redirects.py b/Documentation/redirects.py new file mode 100644 index 00000000000..cc0947c8c25 --- /dev/null +++ b/Documentation/redirects.py @@ -0,0 +1,572 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. The +# ASF licenses this file to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance with the +# License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""Redirect map for pages that were moved or merged. + +Every documentation page that is renamed, moved or merged into another one +MUST get an entry here. The NuttX documentation is linked to from issues, +mailing list archives, blog posts and slide decks going back many years; +without these redirects a reorganisation silently breaks all of them. + +The mapping is consumed by the ``sphinx_reredirects`` extension and is +keyed by the *old* document name (no extension, path relative to the +documentation root). The value is the *new* location, relative to the old +page's directory -- see the sphinx-reredirects documentation. + +Keep the entries grouped by the change that introduced them and keep each +group sorted, so that the file stays reviewable as it grows. +""" + +import pathlib +import posixpath + + +def _moved(pairs): + """Turn (old docname, new docname) pairs into a sphinx-reredirects map. + + sphinx-reredirects expects the target to be written relative to the + directory the *old* page used to live in, which is easy to get wrong by + hand. Spell the moves out as document names and let posixpath work the + relative link out. + """ + out = {} + for old, new in pairs: + assert old not in out, f"duplicate redirect for {old}" + out[old] = posixpath.relpath(new, posixpath.dirname(old)) + ".html" + return out + + +# Aligning Documentation/platforms/ with the source tree. +# +# * the architecture directory was spelled "misco" instead of "misoc"; +# * the chip directory "ra4m1" is "ra4" under arch/ and boards/; +# * LPC17xx and LPC40xx are one directory in the source tree +# (arch/arm/src/lpc17xx_40xx, boards/arm/lpc17xx_40xx) but were two here; +# * four boards were filed under a name the source tree does not use. +_PLATFORM_ALIGNMENT = [ + # misco -> misoc + ("platforms/misco/index", "platforms/misoc/index"), + ("platforms/misco/lm32/index", "platforms/misoc/lm32/index"), + ( + "platforms/misco/lm32/boards/misoc/index", + "platforms/misoc/lm32/boards/misoc/index", + ), + # ra4m1 -> ra4 + ("platforms/arm/ra4m1/index", "platforms/arm/ra4/index"), + ( + "platforms/arm/ra4m1/boards/arduino-r4-minima/index", + "platforms/arm/ra4/boards/arduino-r4-minima/index", + ), + ( + "platforms/arm/ra4m1/boards/xiao-ra4m1/index", + "platforms/arm/ra4/boards/xiao-ra4m1/index", + ), + # lpc17xx -> lpc17xx_40xx + ("platforms/arm/lpc17xx/index", "platforms/arm/lpc17xx_40xx/index"), + ( + "platforms/arm/lpc17xx/boards/lincoln60/index", + "platforms/arm/lpc17xx_40xx/boards/lincoln60/index", + ), + ( + "platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index", + "platforms/arm/lpc17xx_40xx/boards/lpcxpresso-lpc1768/index", + ), + ( + "platforms/arm/lpc17xx/boards/mbed/index", + "platforms/arm/lpc17xx_40xx/boards/mbed/index", + ), + ( + "platforms/arm/lpc17xx/boards/mcb1700/index", + "platforms/arm/lpc17xx_40xx/boards/mcb1700/index", + ), + ( + "platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index", + "platforms/arm/lpc17xx_40xx/boards/olimex-lpc1766stk/index", + ), + ( + "platforms/arm/lpc17xx/boards/open1788/index", + "platforms/arm/lpc17xx_40xx/boards/open1788/index", + ), + ( + "platforms/arm/lpc17xx/boards/pnev5180b/index", + "platforms/arm/lpc17xx_40xx/boards/pnev5180b/index", + ), + ( + "platforms/arm/lpc17xx/boards/u-blox-c027/index", + "platforms/arm/lpc17xx_40xx/boards/u-blox-c027/index", + ), + ( + "platforms/arm/lpc17xx/boards/zkit-arm-1769/index", + "platforms/arm/lpc17xx_40xx/boards/zkit-arm-1769/index", + ), + # lpc40xx -> lpc17xx_40xx + ("platforms/arm/lpc40xx/index", "platforms/arm/lpc17xx_40xx/lpc40xx"), + ( + "platforms/arm/lpc40xx/boards/lx_cpu/index", + "platforms/arm/lpc17xx_40xx/boards/lx_cpu/index", + ), + # added upstream after the fork, filed here by where its code lives + ("implementation/chroot", "os/filesystem/chroot"), + # upstream typo: the page was named intex.rst + ( + "platforms/arm/nrf52/boards/nrf52-feather/intex", + "platforms/arm/nrf52/boards/nrf52-feather/index", + ), + # boards filed under a name the source tree does not use + ( + "platforms/arm/stm32f1/boards/hymini-stm32/index", + "platforms/arm/stm32f1/boards/hymini-stm32v/index", + ), + ( + "platforms/arm/mps/boards/mps2-an512/index", + "platforms/arm/mps/boards/mps2-an521/index", + ), + ( + "platforms/mips/jz4780/boards/mips-creator-ci20/index", + "platforms/mips/jz4780/boards/ci20/index", + ), + ( + "platforms/tricore/tc397/boards/kit_a2g_tc397_tft/index", + "platforms/tricore/tc397/boards/a2g-tc397-5v-tft/index", + ), +] + +# Normalising the tag vocabulary. Tag pages have stable URLs under _tags/, +# so a renamed tag needs a redirect like any other page. Tags that were +# dropped rather than renamed point at the overview. +_TAG_VOCABULARY = [ + # The architecture is the directory: arch/risc-v, boards/risc-v. + ("_tags/arch-riscv", "_tags/arch-risc-v"), + # Lower case, like arch/risc-v/src/esp32c3. + ("_tags/chip-esp32-c3", "_tags/chip-esp32c3"), + # Tiva is a Texas Instruments product line, not a vendor. + ("_tags/vendor-tiva", "_tags/vendor-ti"), + # Peripherals and port maturity stopped being tags altogether; see + # _DROPPED_FACTS below. + ("_tags/ethernet", "_tags/tagsindex"), + ("_tags/wifi", "_tags/tagsindex"), + ("_tags/experimental", "_tags/tagsindex"), + # Dropped: armv8-m and cortex-m33 are cores, not architectures, and the + # pages that carried them already carry arch:arm. + ("_tags/arch-armv8m", "_tags/tagsindex"), + ("_tags/arch-cm33", "_tags/tagsindex"), + # Dropped: these came from the board template, which no longer emits + # live tags of its own. + ("_tags/arch-example", "_tags/tagsindex"), + ("_tags/chip-example", "_tags/tagsindex"), + ("_tags/vendor-example", "_tags/tagsindex"), +] + +# Splitting part numbers out of chip:. chip: is now exactly the set of chip +# family directories; the individual part on a board moved to part:. +_CHIP_TO_PART = [ + ("_tags/chip-cxd5602", "_tags/part-cxd5602"), + ("_tags/chip-esp32a1s", "_tags/part-esp32a1s"), + ("_tags/chip-esp32picod4", "_tags/part-esp32picod4"), + ("_tags/chip-esp32wroom32", "_tags/part-esp32wroom32"), + ("_tags/chip-esp32wrover32", "_tags/part-esp32wrover32"), + ("_tags/chip-fpga", "_tags/part-fpga"), + ("_tags/chip-ht32f49163", "_tags/part-ht32f49163"), + ("_tags/chip-imx93", "_tags/part-imx93"), + ("_tags/chip-imx95", "_tags/part-imx95"), + ("_tags/chip-nrf52832", "_tags/part-nrf52832"), + ("_tags/chip-nrf52840", "_tags/part-nrf52840"), + ("_tags/chip-nrf5340", "_tags/part-nrf5340"), + ("_tags/chip-nrf9160", "_tags/part-nrf9160"), + ("_tags/chip-rp2350", "_tags/part-rp2350"), + ("_tags/chip-rp2350b", "_tags/part-rp2350b"), + ("_tags/chip-stm32c071", "_tags/part-stm32c071"), + ("_tags/chip-stm32c092", "_tags/part-stm32c092"), + ("_tags/chip-stm32c562", "_tags/part-stm32c562"), + ("_tags/chip-stm32f051", "_tags/part-stm32f051"), + ("_tags/chip-stm32f072", "_tags/part-stm32f072"), + ("_tags/chip-stm32f091", "_tags/part-stm32f091"), + ("_tags/chip-stm32f100", "_tags/part-stm32f100"), + ("_tags/chip-stm32f103", "_tags/part-stm32f103"), + ("_tags/chip-stm32f107", "_tags/part-stm32f107"), + ("_tags/chip-stm32f205", "_tags/part-stm32f205"), + ("_tags/chip-stm32f207", "_tags/part-stm32f207"), + ("_tags/chip-stm32f302", "_tags/part-stm32f302"), + ("_tags/chip-stm32f303", "_tags/part-stm32f303"), + ("_tags/chip-stm32f334", "_tags/part-stm32f334"), + ("_tags/chip-stm32f401", "_tags/part-stm32f401"), + ("_tags/chip-stm32f405", "_tags/part-stm32f405"), + ("_tags/chip-stm32f407", "_tags/part-stm32f407"), + ("_tags/chip-stm32f411", "_tags/part-stm32f411"), + ("_tags/chip-stm32f412", "_tags/part-stm32f412"), + ("_tags/chip-stm32f427", "_tags/part-stm32f427"), + ("_tags/chip-stm32f429", "_tags/part-stm32f429"), + ("_tags/chip-stm32f446", "_tags/part-stm32f446"), + ("_tags/chip-stm32f722", "_tags/part-stm32f722"), + ("_tags/chip-stm32f746", "_tags/part-stm32f746"), + ("_tags/chip-stm32f767", "_tags/part-stm32f767"), + ("_tags/chip-stm32f769", "_tags/part-stm32f769"), + ("_tags/chip-stm32f777", "_tags/part-stm32f777"), + ("_tags/chip-stm32g070", "_tags/part-stm32g070"), + ("_tags/chip-stm32g071", "_tags/part-stm32g071"), + ("_tags/chip-stm32g431", "_tags/part-stm32g431"), + ("_tags/chip-stm32g474", "_tags/part-stm32g474"), + ("_tags/chip-stm32h503", "_tags/part-stm32h503"), + ("_tags/chip-stm32h533", "_tags/part-stm32h533"), + ("_tags/chip-stm32h563", "_tags/part-stm32h563"), + ("_tags/chip-stm32h723", "_tags/part-stm32h723"), + ("_tags/chip-stm32h743", "_tags/part-stm32h743"), + ("_tags/chip-stm32h745", "_tags/part-stm32h745"), + ("_tags/chip-stm32h747", "_tags/part-stm32h747"), + ("_tags/chip-stm32h750", "_tags/part-stm32h750"), + ("_tags/chip-stm32h753", "_tags/part-stm32h753"), + ("_tags/chip-stm32h7s3", "_tags/part-stm32h7s3"), + ("_tags/chip-stm32l053", "_tags/part-stm32l053"), + ("_tags/chip-stm32l072", "_tags/part-stm32l072"), + ("_tags/chip-stm32l073", "_tags/part-stm32l073"), + ("_tags/chip-stm32l152", "_tags/part-stm32l152"), + ("_tags/chip-stm32l432", "_tags/part-stm32l432"), + ("_tags/chip-stm32l452", "_tags/part-stm32l452"), + ("_tags/chip-stm32l475", "_tags/part-stm32l475"), + ("_tags/chip-stm32l476", "_tags/part-stm32l476"), + ("_tags/chip-stm32l496", "_tags/part-stm32l496"), + ("_tags/chip-stm32l4r9", "_tags/part-stm32l4r9"), + ("_tags/chip-stm32l552", "_tags/part-stm32l552"), + ("_tags/chip-stm32l562", "_tags/part-stm32l562"), + ("_tags/chip-stm32n657", "_tags/part-stm32n657"), + ("_tags/chip-stm32u083", "_tags/part-stm32u083"), + ("_tags/chip-stm32u3c5", "_tags/part-stm32u3c5"), + ("_tags/chip-stm32u585", "_tags/part-stm32u585"), + ("_tags/chip-stm32u5a5", "_tags/part-stm32u5a5"), + ("_tags/chip-stm32wb55", "_tags/part-stm32wb55"), + ("_tags/chip-stm32wl55", "_tags/part-stm32wl55"), + ("_tags/chip-tm4c123", "_tags/part-tm4c123"), + ("_tags/chip-ultrascale", "_tags/part-ultrascale"), + ("_tags/chip-virt", "_tags/part-virt"), + ("_tags/chip-xczu28dr", "_tags/part-xczu28dr"), +] + +# Dropped when the vocabulary was tightened: chip:stm32, chip:stm32wl and +# chip:zynq were product lines rather than families, and every page carrying +# them already carried its family. "Every STM32 board" is vendor:st now. +_DROPPED_ROLLUPS = [ + ("_tags/chip-stm32", "_tags/vendor-st"), + ("_tags/chip-stm32wl", "_tags/chip-stm32wl5"), + ("_tags/chip-zynq", "_tags/chip-zynq-mpsoc"), +] + +# vendor: now names who makes the chip and is derived from the chip family. +# The board makers it used to hold are already in the board names. +_DROPPED_BOARD_VENDORS = [ + ("_tags/vendor-arduino", "_tags/tagsindex"), + ("_tags/vendor-beagleboard", "_tags/tagsindex"), + ("_tags/vendor-elegoo", "_tags/tagsindex"), + ("_tags/vendor-mikroelektronika", "_tags/tagsindex"), + ("_tags/vendor-pine64", "_tags/tagsindex"), + ("_tags/vendor-raspberry-pi", "_tags/tagsindex"), + ("_tags/vendor-sipeed", "_tags/tagsindex"), + ("_tags/vendor-xunlong", "_tags/tagsindex"), + ("_tags/vendor-vega", "_tags/vendor-nxp"), + # Freescale became part of NXP in 2015. + ("_tags/vendor-freescale", "_tags/vendor-nxp"), +] + +# What a board offers, and how far its port has been taken, are facts about +# the hardware. As tags they covered a twentieth of the boards that actually +# have the peripheral, which reads as a complete answer and is not one; and +# every page tagged status:experimental already said so in its own text. Both +# now live in the Support Status and Peripheral Support sections of the board +# page, where there is room to be exact. +_DROPPED_FACTS = [ + ("_tags/peripheral-dac", "_tags/tagsindex"), + ("_tags/peripheral-ethernet", "_tags/tagsindex"), + ("_tags/peripheral-wifi", "_tags/tagsindex"), + ("_tags/status-experimental", "_tags/tagsindex"), +] + +# Two directories that only the source tree could settle. tricore/tc4d9 was a +# misspelling of arch/tricore/src/tc4da (the page itself is titled TC4DA), and +# avr/atmega128, atmega1284p and atmega2560 are parts of the atmega family +# rather than families of their own -- arch/avr/src/ has one atmega directory. +# The pages stay where they are, because they carry real per part content; +# only the tags were wrong. +_SOURCE_TREE_TRUTH = [ + ("platforms/tricore/tc4d9/index", "platforms/tricore/tc4da/index"), + ( + "platforms/tricore/tc4d9/boards/triboard_tc4x9_com/index", + "platforms/tricore/tc4da/boards/triboard_tc4x9_com/index", + ), + ("_tags/chip-tc4d9", "_tags/chip-tc4da"), + ("_tags/chip-atmega128", "_tags/part-atmega128"), + ("_tags/chip-atmega1284p", "_tags/part-atmega1284p"), + ("_tags/chip-atmega2560", "_tags/part-atmega2560"), +] + +# boards/x86_64/qemu/qemu-intel64/ is where the source tree files this board, +# so that is where its page belongs. platforms/x86_64/intel64/ stays: it is a +# real family under arch/x86_64/src/, it just has no boards of its own. +_X86_64_BOARD = [ + ( + "platforms/x86_64/intel64/boards/qemu-intel64/index", + "platforms/x86_64/qemu/boards/qemu-intel64/index", + ), +] + +# Grouping the OS documentation by subsystem instead of by how deep it goes. +# The scheduler pages were spread over implementation/ and reference/os/; +# they live under os/scheduling/ now. reference/os/smp.rst is merged into +# os/scheduling/smp.rst, which is where its technical description already +# was. +_OS_SCHEDULING = [ + ("implementation/nuttx_tasking", "os/scheduling/nuttx_tasking"), + ("implementation/tasks_vs_threads", "os/scheduling/tasks_vs_threads"), + ("implementation/processes_vs_tasks", "os/scheduling/processes_vs_tasks"), + ( + "implementation/kernel_threads_vs_pthreads", + "os/scheduling/kernel_threads_vs_pthreads", + ), + ("implementation/context_switches", "os/scheduling/context_switches"), + ("implementation/preemption_latency", "os/scheduling/preemption_latency"), + ("implementation/cancellation_points", "os/scheduling/cancellation_points"), + ("implementation/smp", "os/scheduling/smp"), +] + +# Grouping the rest of the OS documentation by subsystem. components/, +# implementation/ and reference/os/ described the same subsystems at three +# different depths; they are one tree now, following the source tree. +_OS_TREES = [ + ("components/drivers", "os/drivers"), + ("components/filesystem", "os/filesystem"), + ("components/net", "os/networking"), + ("components/mm", "os/memory"), + ("components/libs", "os/libs"), + ("components/nxgraphics", "os/graphics"), + ("components/audio", "os/audio"), + ("components/arch", "os/arch"), + ("components/concurrency", "os/concurrency"), +] + +_OS_PAGES = [ + ("components/binfmt", "os/binfmt/index"), + ("components/nxflat", "os/binfmt/nxflat"), + ("components/crypto", "os/crypto"), + ("components/video", "os/video"), + ("components/wireless", "os/wireless"), + ("components/syscall", "os/syscall"), + ("components/paging", "os/memory/paging"), + ("components/openamp", "os/openamp"), + ("implementation/device_drivers", "os/drivers/device_drivers"), + ("implementation/device_nodes", "os/drivers/device_nodes"), + ("implementation/drivers_design", "os/drivers/drivers_design"), + ("implementation/ioctl", "os/drivers/ioctl"), + ("implementation/usb", "os/drivers/usb"), + ("implementation/power_management", "os/drivers/special/power/power_management"), + ("implementation/syslog", "os/drivers/special/syslog_design"), + ("implementation/file_descriptors", "os/filesystem/file_descriptors"), + ("implementation/file_permission", "os/filesystem/file_permission"), + ("implementation/memory_configurations", "os/memory/memory_configurations"), + ("implementation/crc", "os/libs/crc"), + ( + "implementation/kernel_modules_vs_shared_libraries", + "os/binfmt/kernel_modules_vs_shared_libraries", + ), + ("implementation/tls", "os/scheduling/tls"), + ("implementation/user_identity", "os/scheduling/user_identity"), + ("implementation/bottomhalf_interrupt", "os/interrupts/bottomhalf_interrupt"), + ("implementation/interrupt_controls", "os/interrupts/interrupt_controls"), + ("implementation/critical_sections", "os/interrupts/critical_sections"), + ("implementation/tickless_os", "os/time/tickless_os"), + ("implementation/short_time_delays", "os/time/short_time_delays"), + ( + "implementation/oneshot_timers_and_cpu_load", + "os/time/oneshot_timers_and_cpu_load", + ), + ("implementation/signal_handlers", "os/ipc/signal_handlers"), + ("reference/os/addrenv", "os/memory/addrenv"), + ("reference/os/iob", "os/memory/iob"), + ("reference/os/events", "os/ipc/events"), + ("reference/os/mutex", "os/ipc/mutex"), + ("reference/os/sleep", "os/time/sleep"), + ("reference/os/time_clock", "os/time/time_clock"), + ("reference/os/wqueue", "os/scheduling/wqueue"), + ("reference/os/newreno", "os/networking/newreno"), + ("reference/os/led", "os/drivers/character/leds/index"), + ("reference/os/arch", "os/arch/arch_api"), + ("reference/os/board", "os/arch/board_api"), + ("reference/os/notifier", "os/notifier"), + ("reference/os/app_vs_os", "os/app_vs_os"), + ("reference/os/nuttx", "os/nuttx"), + ("reference/os/conventions", "os/conventions"), +] + + +# Pages that live in one of the new directories above but never lived in +# the old one: they came from implementation/ or reference/os/ (and have +# their own line in _OS_PAGES), or they are new. Without this list the +# expansion below would add a redirect for an old URL that never existed. +_NOT_IN_OLD_TREE = { + "components/arch/arch_api", + "components/arch/board_api", + "components/drivers/device_drivers", + "components/drivers/device_nodes", + "components/drivers/drivers_design", + "components/drivers/ioctl", + "components/drivers/special/power/power_management", + "components/drivers/special/syslog_design", + "components/drivers/usb", + "components/filesystem/chroot", + "components/filesystem/file_descriptors", + "components/filesystem/file_permission", + "components/libs/crc", + "components/libs/libbuiltin", + "components/mm/addrenv", + "components/mm/iob", + "components/mm/memory_configurations", + "components/mm/paging", + "components/net/newreno", +} + + +def _moved_trees(pairs): + """Expand whole-directory moves into one redirect per page. + + Built from the pages that are there now, so a page added to a section + later does not need a line here. + """ + here = pathlib.Path(__file__).parent + out = [] + for old_dir, new_dir in pairs: + for page in sorted((here / new_dir).rglob("*.rst")): + name = page.relative_to(here / new_dir).with_suffix("").as_posix() + if f"{old_dir}/{name}" in _NOT_IN_OLD_TREE: + continue + out.append((f"{old_dir}/{name}", f"{new_dir}/{name}")) + return out + + +# guides/ split by subject. 60 files in one directory, in no order anybody +# could use; each one now sits under the thing it is about. +_GUIDES = [ + ( + "guides/armv7m_runtimestackcheck", + "guides/chip-specific/armv7m_runtimestackcheck", + ), + ("guides/automounter", "guides/filesystem/automounter"), + ( + "guides/building_nuttx_with_app_out_of_src_tree", + "guides/build/building_nuttx_with_app_out_of_src_tree", + ), + ("guides/building_uclibcpp", "guides/build/building_uclibcpp"), + ( + "guides/changing_systemclockconfig", + "guides/chip-specific/changing_systemclockconfig", + ), + ("guides/cpp_cmake", "guides/build/cpp_cmake"), + ("guides/custom_app_directories", "guides/build/custom_app_directories"), + ("guides/customapps", "guides/build/customapps"), + ("guides/customboards", "guides/porting/customboards"), + ("guides/devicetree", "guides/drivers/devicetree"), + ("guides/drivers", "guides/drivers/drivers"), + ("guides/etcromfs", "guides/filesystem/etcromfs"), + ("guides/fork_vfork_migration", "guides/concurrency/fork_vfork_migration"), + ("guides/fortify", "guides/security/fortify"), + ("guides/fully_linked_elf", "guides/programs/fully_linked_elf"), + ("guides/include_files_board_h", "guides/porting/include_files_board_h"), + ("guides/integrate_newlib", "guides/build/integrate_newlib"), + ("guides/ipv6", "guides/networking/ipv6"), + ( + "guides/kernel_threads_with_custom_stacks", + "guides/concurrency/kernel_threads_with_custom_stacks", + ), + ("guides/logging_rambuffer", "guides/drivers/logging_rambuffer"), + ("guides/lwl", "guides/drivers/lwl"), + ("guides/multiple_nsh_sessions", "guides/nsh/multiple_nsh_sessions"), + ("guides/nestedinterrupts", "guides/concurrency/nestedinterrupts"), + ("guides/nfs", "guides/networking/nfs"), + ("guides/nix_flake", "guides/build/nix_flake"), + ( + "guides/nsh_network_link_management", + "guides/networking/nsh_network_link_management", + ), + ("guides/ofloader", "guides/drivers/ofloader"), + ("guides/optee", "guides/security/optee"), + ("guides/partially_linked_elf", "guides/programs/partially_linked_elf"), + ("guides/platform_directories", "guides/build/platform_directories"), + ("guides/port", "guides/porting/port"), + ("guides/port_bootsequence", "guides/porting/port_bootsequence"), + ("guides/port_drivers_to_stm32f7", "guides/chip-specific/port_drivers_to_stm32f7"), + ( + "guides/port_relatedkernelconfigrations", + "guides/porting/port_relatedkernelconfigrations", + ), + ("guides/protected_build", "guides/programs/protected_build"), + ("guides/pysimcoder", "guides/languages/pysimcoder"), + ("guides/qemu_tips", "guides/simulation/qemu_tips"), + ("guides/ram_rom_disks", "guides/filesystem/ram_rom_disks"), + ("guides/reading_can_msgs", "guides/drivers/reading_can_msgs"), + ("guides/remove_device_drivers_nsh", "guides/nsh/remove_device_drivers_nsh"), + ("guides/renode", "guides/simulation/renode"), + ("guides/rndis", "guides/drivers/rndis"), + ("guides/rust", "guides/languages/rust"), + ("guides/semihosting", "guides/chip-specific/semihosting"), + ( + "guides/signal_events_interrupt_handlers", + "guides/concurrency/signal_events_interrupt_handlers", + ), + ( + "guides/signaling_sem_priority_inheritance", + "guides/concurrency/signaling_sem_priority_inheritance", + ), + ("guides/simulator", "guides/simulation/simulator"), + ("guides/smaller_vector_tables", "guides/chip-specific/smaller_vector_tables"), + ( + "guides/specialstuff_in_nuttxheaderfiles", + "guides/porting/specialstuff_in_nuttxheaderfiles", + ), + ("guides/stm32_ports", "guides/chip-specific/stm32_ports"), + ("guides/stm32ccm", "guides/chip-specific/stm32ccm"), + ("guides/stm32nullpointer", "guides/chip-specific/stm32nullpointer"), + ("guides/testingtcpip", "guides/networking/testingtcpip"), + ("guides/thread_local_storage", "guides/concurrency/thread_local_storage"), + ( + "guides/updating_release_system_elf", + "guides/programs/updating_release_system_elf", + ), + ("guides/usbtrace", "guides/drivers/usbtrace"), + ("guides/usingkernelthreads", "guides/concurrency/usingkernelthreads"), + ( + "guides/versioning_and_task_names", + "guides/concurrency/versioning_and_task_names", + ), + ("guides/zerolatencyinterrupts", "guides/concurrency/zerolatencyinterrupts"), + ( + "guides/porting-case-studies/bcm2711-rpi4b", + "guides/porting/case-studies/bcm2711-rpi4b", + ), + ( + "guides/porting-case-studies/port_arm_cm4", + "guides/porting/case-studies/port_arm_cm4", + ), +] + +redirects = _moved( + _PLATFORM_ALIGNMENT + + _TAG_VOCABULARY + + _CHIP_TO_PART + + _DROPPED_ROLLUPS + + _DROPPED_BOARD_VENDORS + + _DROPPED_FACTS + + _SOURCE_TREE_TRUTH + + _X86_64_BOARD + + _OS_SCHEDULING + + _OS_PAGES + + _moved_trees(_OS_TREES) + + _GUIDES +) diff --git a/Documentation/reference/os/index.rst b/Documentation/reference/os/index.rst index 094ea5d5813..e9dce4cac70 100644 --- a/Documentation/reference/os/index.rst +++ b/Documentation/reference/os/index.rst @@ -9,21 +9,6 @@ interface with are also identified in ``include/nuttx/arch.h`` or in other header files. .. toctree:: - addrenv.rst - app_vs_os.rst - arch.rst - board.rst - conventions.rst - iob.rst - led.rst - mutex.rst - newreno.rst - notifier.rst - nuttx.rst paging.rst shm.rst smp.rst - sleep.rst - time_clock.rst - wqueue.rst - events.rst diff --git a/Documentation/reference/user/01_task_control.rst b/Documentation/reference/user/01_task_control.rst index 05c064d4ecd..53cb6f880f3 100644 --- a/Documentation/reference/user/01_task_control.rst +++ b/Documentation/reference/user/01_task_control.rst @@ -366,7 +366,7 @@ Functions absent from ``unistd.h`` and code that calls it fails to build. That is deliberate. A build error naming the function is strictly better than a ``fork()`` that silently gives the child the parent's memory. - See :doc:`/guides/fork_vfork_migration` for how to move code that + See :doc:`/guides/concurrency/fork_vfork_migration` for how to move code that relied on the previous behaviour. There is no copy-on-write, because NuttX has no demand paging to build diff --git a/Documentation/reference/user/13_boardctl.rst b/Documentation/reference/user/13_boardctl.rst index a182ddf69e2..f8742bcb05f 100644 --- a/Documentation/reference/user/13_boardctl.rst +++ b/Documentation/reference/user/13_boardctl.rst @@ -72,7 +72,7 @@ Power Management Manage power state transition and query. The supplied argument indicates the specific PM operation to perform, which map to corresponding internal ``pm_`` functions - (see :doc:`/components/drivers/special/power/pm/index`). + (see :doc:`/os/drivers/special/power/pm/index`). With this interface you can interact with PM handling arch/board logic (typically done in IDLE loop) or you can directly manage state transitions diff --git a/Documentation/reference/user/14_logging.rst b/Documentation/reference/user/14_logging.rst index ad73493cc61..b8a2c6bfde0 100644 --- a/Documentation/reference/user/14_logging.rst +++ b/Documentation/reference/user/14_logging.rst @@ -4,7 +4,7 @@ Logging NuttX provides the SYSLOG for application and OS logging, which can be configured in various ways to select how these messages are displayed -(see details :doc:`here `). +(see details :doc:`here `). Applications can emit logging messages using the standard :c:func:`syslog` interface. diff --git a/Documentation/testing/ntfc.rst b/Documentation/testing/ntfc.rst index 47cb6e169bf..3e4d84c8b64 100644 --- a/Documentation/testing/ntfc.rst +++ b/Documentation/testing/ntfc.rst @@ -22,7 +22,7 @@ CI runtime test cases use NTFC. Configurations with an NTFC runner include: - :doc:`arm/imx6 `: ``sabre-6quad/citest`` - :doc:`arm64/qemu `: ``qemu-armv8a/citest`` - :doc:`arm64/qemu `: ``qemu-armv8a/citest_smp`` -- :doc:`x86_64/qemu `: ``qemu-intel64/citest_smp`` +- :doc:`x86_64/qemu `: ``qemu-intel64/citest_smp`` Running a CI Test Target Locally ================================