OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity
49,398 Commits 18 Branches 185 Tags 409 MiB
Commit Graph

51 Commits

Author SHA1 Message Date
Brennan Ashton 14d311ca0a docs: Add copy button for code blocks 2023-05-20 12:58:32 +08:00
Brennan Ashton 4d3ce8f706 docs: Fix sphinx warnings listed in issue #9306 
Fixes these errors:
```
 /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/lcd.rst:52: WARNING: duplicate label ttgotdisplayesp32, other instance in /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/framebuffer.rst
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:370: CRITICAL: Unexpected section title.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:394: CRITICAL: Unexpected section title.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1494: ERROR: Inconsistent literal block quoting.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1569: WARNING: Literal block expected; none found.
 /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst:207: WARNING: download file not readable: /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/tone.wav
 checking consistency... /home/bashton/nuttx-wrk/nuttx/Documentation/reference/os/newreno.rst: WARNING: document isn't included in any toctree
 /home/bashton/nuttx-wrk/nuttx/Documentation/guides/zerolatencyinterrupts.rst:117: WARNING: unknown document: <nestedinterrupts.rst>
```
 2023-05-20 12:40:52 +08:00
Nathan Hartman e299af410a Documentation: Import Nested Interrupts page from CWIKI 
* Documentation/guides/nestedinterrupts.rst:
  New. Imported from [1] and converted from CWIKI to reStructuredText.

* Documentation/guides/index.rst:
  Link to the new page.

* Documentation/guides/zerolatencyinterrupts.rst:
  Replace link to the CWIKI Nested Interrupts page with link to the
  above.

[1] https://cwiki.apache.org/confluence/display/NUTTX/Nested+Interrupts
 2023-05-19 23:20:43 +08:00
Nathan Hartman 33bf661413 Documentation: Improve "High Performance, Zero Latency Interrupts" 
* Documentation/guides/zerolatencyinterrupts.rst:
  Add paragraph that defines jitter. Fix a few minor typos. Fix
  incorrect reStructuredText formatting for bulletpoints (they were
  being rendered like 2nd level bulletpoints).

* Documentation/guides/index.rst:
  Add zerolatencyinterrupts.rst to the TOC, which I forgot to do in PR
  # 9302.
 2023-05-19 10:22:50 +08:00
Nathan Hartman 242127556c Documentation: Add "High Performance, Zero Latency Interrupts" 
* Documentation/guides/zerolatencyinterrupts.rst: New. This document is
  converted from CWIKI (see [1]) to reStructuredText and brought into
  the Documentation tree in the repo.

[1] https://cwiki.apache.org/confluence/display/NUTTX/High+Performance%2C+Zero+Latency+Interrupts
 2023-05-17 02:23:19 +08:00
Tiago Medicci Serrano 5a1efdecfd documentation: add references to RTP Tools' defconfigs 
Added examples of using the RTP Tools (`rtpdump`, in particular)
to receive RTP packets and 1) print the data and/or 2) playback
audio content through I2S.
 2023-05-03 07:57:11 +02:00
Lucas Saavedra Vaz c961edbe6c Documentation: Fix compilation warnings 2023-03-25 12:23:35 +02:00
Alan Carvalho de Assis dd0f389e72 doc: Add guide how to use QEMU and GDB to debug NuttX 
This guide is based on steps from this issue:
https://github.com/apache/nuttx/issues/8616
 2023-02-26 01:14:41 +08:00
yinshengkai 55ce5d0511 note: remove SCHED_INSTRUMENTATION_HIRES 
Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
 2023-02-23 22:30:07 +08:00
chao an ee1e1108a7 drivers/note: fix build break by note rename change 
Regression by:

| commit ee24396d77
| Author: Xiang Xiao <xiaoxiang@xiaomi.com>
| Date:   Tue Feb 14 01:11:48 2023 +0800
|
|     drivers/note: Change DRIVER_NOTExxx to DRIVERS_NOTExxx
|
|     follow other driver config style
|
|     Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>

Signed-off-by: chao an <anchao@xiaomi.com>
 2023-02-20 16:19:57 +08:00
Jackson R 491c3b564f Repeated Command "sudo port install" 
The merged code had Repeated Command.
 2023-02-16 14:09:50 +08:00
Jackson R 37db965cff This simulator was tested on ARM MacBook. 
Updating Simulator for macOS

macOS requires genromfs and X11 Libraries to run Simulators.
* Added instructions to install genromfs
* Added instructions to install X11
Adding Xorg Server

The linker was unable to identify the location of X11 libraries.

removed -L/opt/X11/lib from ln 145

Updating Changes to streamline with other Hosts
 2023-02-16 09:27:54 +08:00
Alan Carvalho de Assis 8564b49469 doc: Add USB RNDIS tutorial to documentation. 2023-01-29 10:09:13 +08:00
yinshengkai dd32eccfc3 drivers/note: Move taskname related functions to note_driver.c 
so all note drivers can retrieve the task name even after the task exit

Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
 2022-12-26 15:03:57 +08:00
Alan Carvalho de Assis 3d016db226 Doc: Fix ping to external IP on simulator 2022-12-23 00:32:10 +08:00
TimJTi 83c76eaa93 Documentation file typo's corrected 
Correct "Nuttx" to "NuttX"
 2022-10-13 18:26:17 +08:00
TimJTi 538365e362 Documentation for Custom Boards and Apps 2022-10-12 14:56:31 -03:00
Brennan Ashton c9636f0b3e docs: Update dependencies and fix lint errors 2022-10-10 09:29:53 +08:00
Nathan Hartman 2032eeae6c Documentation: Fix various typos. 
Documentation/components/drivers/character/serial.rst
Documentation/faq/index.rst
Documentation/guides/pysimcoder.rst
Documentation/platforms/arm/imxrt/boards/teensy-4.x/index.rst
Documentation/platforms/arm/imxrt/index.rst
Documentation/platforms/arm/stm32wl5/boards/nucleo-wl55jc/index.rst
Documentation/platforms/arm/stm32wl5/index.rst
Documentation/platforms/risc-v/bl602/index.rst
Documentation/platforms/sim/sim/index.rst
Documentation/platforms/xtensa/esp32/index.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>
 2022-06-24 00:01:38 +08:00
Xiang Xiao b30e0a26ef Move "-nostartfiles -nodefaultlibs" from Make.defs to Toolchian.defs 
and replace "-nostartfiles -nodefaultlibs" with "-nostdlib"

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-05-18 08:26:02 -04:00
Michal Lenc d5b34f9ce0 Documentation/guides/pysimcoder.rst: update pysimCoder dependencies 
CONFIG_LIBM option may be required by some toolchains that do not include
standard math library. Morover CONFIG_PTHREAD_STACK_MIN was listed twice
in the list.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
 2022-04-08 01:05:43 +08:00
Long Dao 8bf0750090 Update cpp_cmake.rst 2022-04-05 02:04:05 +08:00
Long Dao e25df6706d Update cpp_cmake.rst 
update CMAKE_C_FLAGS when compile C file
 2022-04-05 02:04:05 +08:00
Xiang Xiao ee931c137f boards: Remove -fno-builtin 
it's more efficent to generate the machine code directly if possible

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-03-10 19:46:01 +02:00
Xiang Xiao f1ed349dd9 sched/clock: Remove CLOCK_MONOTONIC option from Kconfig 
here is the reason:
1.clock_systime_timespec(core function) always exist regardless the setting
2.CLOCK_MONOTONIC is a foundamental clock type required by many places

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-02-23 01:21:26 +08:00
Xiang Xiao 1d1bdd85a3 Remove the double blank line from source files 
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-02-20 20:10:14 +01:00
Xiang Xiao b0fa232918 boards: Remove -D__NuttX__ from the individual Make.defs 
since it is defined globally in tools/Config.mk now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-02-15 15:26:38 +01:00
Xiang Xiao 04297c3ca3 board: Remove -fno-omit-frame-pointer from Make.defs 
except sim arch, since this flag is set inside Toolschain.defs now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-01-20 16:00:48 +01:00
Alexander Lunev ea6141e01b Documentation: added "Testing / capturing TCP network traffic" section, including packet loss emulation 2022-01-20 14:15:33 +08:00
Xiang Xiao 8bcdefafc9 board: Remove -fno-strength-reduce 
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2022-01-19 00:14:03 +01:00
ligd 10ccba6671 init: move USERMAIN_XX out of INIT_ENTRYPOINT 
Signed-off-by: ligd <liguiding1@xiaomi.com>
 2021-12-24 08:23:30 -06:00
Michal Lenc c456b15916 Documentation: add guide for pysimCoder integration with NuttX 
This commit adds documentation for compiling NuttX for pysimCoder and
then running pysimCoder designed applications on NuttX. PysimCoder is
a Rapid Control Application Development Tool that can transfer block
diagrams into C code and can be used in real time control applications.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
 2021-08-11 18:04:09 +02:00
Nathan Hartman ce20211357 Fix various typos in comments and documentation 
Fix typos in these files:
    * Documentation/components/drivers/character/foc.rst
    * Documentation/guides/cpp_cmake.rst
    * Kconfig
    * arch/arm/src/imxrt/imxrt_lpspi.c
    * arch/arm/src/kinetis/kinetis_spi.c
    * arch/arm/src/kl/kl_spi.c
    * arch/arm/src/lpc31xx/lpc31_spi.c
    * arch/arm/src/nrf52/nrf52_radio.h
    * arch/arm/src/s32k1xx/s32k1xx_lpspi.c
    * arch/arm/src/stm32/Kconfig
    * arch/arm/src/stm32/stm32_adc.c
    * arch/arm/src/stm32/stm32_foc.c
    * arch/arm/src/stm32/stm32_foc.h
    * arch/arm/src/stm32/stm32_pwm.c
    * arch/arm/src/stm32/stm32_spi.c
    * arch/arm/src/stm32f0l0g0/stm32_spi.c
    * arch/arm/src/stm32f7/Kconfig
    * arch/arm/src/stm32f7/stm32_spi.c
    * arch/arm/src/stm32h7/Kconfig
    * arch/arm/src/stm32h7/stm32_allocateheap.c
    * arch/arm/src/stm32h7/stm32_fmc.c
    * arch/arm/src/stm32h7/stm32_fmc.h
    * arch/arm/src/stm32h7/stm32_pwm.c
    * arch/arm/src/stm32h7/stm32_qspi.c
    * arch/arm/src/stm32h7/stm32_spi.c
    * arch/arm/src/stm32l4/stm32l4_pwm.c
    * arch/arm/src/stm32l4/stm32l4_spi.c
    * arch/arm/src/stm32l5/Kconfig
    * arch/arm/src/stm32l5/stm32l5_spi.c
    * arch/renesas/src/rx65n/rx65n_dtc.c
    * arch/renesas/src/rx65n/rx65n_usbdev.c
    * arch/risc-v/src/rv32m1/rv32m1_serial.c
    * boards/arm/stm32/b-g431b-esc1/src/stm32_foc.c
    * boards/arm/stm32/nucleo-f103rb/src/stm32_foc_ihm07m1.c
    * boards/arm/stm32/nucleo-f302r8/src/stm32_foc_ihm07m1.c
    * boards/arm/stm32h7/nucleo-h743zi2/README.txt
    * boards/risc-v/rv32m1/rv32m1-vega/README.txt
    * boards/sim/sim/sim/scripts/Make.defs
    * drivers/1wire/1wire.c
    * drivers/1wire/1wire_internal.h
    * drivers/lcd/Kconfig
    * drivers/syslog/ramlog.c
    * fs/fat/Kconfig
    * libs/libc/debug/Kconfig
    * libs/libc/machine/Kconfig
    * libs/libc/stdio/lib_libvsprintf.c
    * libs/libc/stdlib/lib_div.c
    * libs/libc/stdlib/lib_ldiv.c
    * libs/libc/stdlib/lib_lldiv.c
    * libs/libdsp/lib_observer.c
 2021-07-04 11:23:26 -05:00
Nathan Hartman 26f09cec6d Documentation: Fix a few typos. 
* Documentation/contributing/documentation.rst
    * Documentation/guides/tasktraceuser.rst
    * Documentation/guides/drivers.rst
    * Documentation/quickstart/running.rst
    * Documentation/quickstart/compiling.rst
    * Documentation/components/drivers/character/watchdog.rst
    * Documentation/components/drivers/character/foc.rst
    * Documentation/components/nxgraphics/nxtk.rst
    * Documentation/applications/nsh/login.rst
    * Documentation/introduction/detailed_support.rst
    * Documentation/introduction/resources.rst
    * Documentation/reference/user/01_task_control.rst
    * Documentation/reference/os/wqueue.rst

      Fix some misspelled words.

      Many of these were caught by codespell.
 2021-04-28 17:00:23 -03:00
Nathan Hartman 4a75b41b4d Documentation: Minor fixes 
Documentation/guides/drivers.rst:

    * Replace wrong "Ethernet" with "SD Card"

Documentation/platforms/arm/imxrt/index.rst:

    * Fix misspelled "Supported"

Documentation/platforms/xtensa/esp32/index.rst:

    * Fix doubled "also"
    * Fix "the" -> "to"

Documentation/reference/os/index.rst:

    * Fix doubled "also"
    * Fix "also" -> "are"
 2021-04-20 21:31:18 -05:00
Flavio Alves bbdec3c4f4 Adding example to build cmake projects in NuttX 
Section adjustments

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Matias N. <v01d@users.noreply.github.com>

Reviewed introduction to the document

Add the motivation for writing the document.

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Adding caption and name for files

Correcting caption

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

test: Separating the file from the document

Revert "test: Separating the file from the document"

This reverts commit beec4788bdb574d9c99f1817b7ffe6e90a18fe46.

Removing captions

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>

Update Documentation/guides/cpp_cmake.rst

Co-authored-by: Gustavo Henrique Nihei <38959758+gustavonihei@users.noreply.github.com>
 2021-03-23 06:41:16 -07:00
Nakamura, Yuuichi 08ad202dfb Update task trace document 2020-11-02 01:12:08 -08:00
Brennan Ashton 23cd1e030e Docs: Fix broken links and references in docs 
Also add to the CI a problem matcher to better report issues

Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
 2020-10-22 10:22:11 -03:00
Nakamura, Yuuichi d8d19911ef Add SCHED_INSTRUMENTATION_HIRES support 2020-10-21 00:33:10 +08:00
Nakamura, Yuuichi e1b9c278f8 Update trace command document 2020-10-21 00:31:51 +08:00
Xiang Xiao eb4121ce38 Change all 'Nuttx' to 'NuttX' 
Unify the naming convention

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2020-10-20 01:45:06 -07:00
Xiang Xiao 598e3eedb4 Documentation: Remove all tail spaces from *.rst and *.html 
by the below command:
find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
 2020-10-18 10:51:22 -07:00
Nakamura, Yuuichi 1472a913a9 Add documentation for note filters and task trace guides 2020-10-16 10:13:15 +08:00
Adam Feuer d788b2e16c fix bugs in quickstart docs 
- change Gnu to GNU
- fix formatting and link fixes
- add menuconfig screenshot
- replaced config file edits with kconfig-tweak
- fix section numbering
- removed leftover todo in quickstart/index.rst
- rewrote debugging section to use menuconfig
 2020-09-06 22:28:32 +01:00
Adam Feuer ce604692db deleted section on copying driver code 
- changed to "use for inspiration only"
 2020-09-04 20:02:30 -03:00
Adam Feuer 7632b4d716 formatting fixes 2020-09-04 20:02:30 -03:00
Adam Feuer dcf32363c2 fixed copy-paste error in sim 2020-09-04 20:02:30 -03:00
Adam Feuer b85fcd7566 PR feedback changes 2020-09-04 20:02:30 -03:00
Adam Feuer 56b89a89f2 add sim and drivers guides, contributing workflow 2020-09-04 20:02:30 -03:00
Matias N 4a38a15332 convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-24 10:29:55 -07:00