Commit Graph

135 Commits

Author SHA1 Message Date
Alan Carvalho de Assis
468e9fcde5 Documentation: Fix typos
I used codespell to find typos in the documentation.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2023-10-29 10:35:51 +08:00
raiden00pl
8f7be6ce27 Documentation: move nxwidgets to applications as it is apps-side lib 2023-10-27 13:21:40 -03:00
raiden00pl
579a35dc68 Documentation: fix ugly formating around some inline literals 2023-10-27 13:21:40 -03:00
raiden00pl
770df6d820 Documentation: remove readme references 2023-10-27 13:21:40 -03:00
raiden00pl
d72c6802c1 Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
raiden00pl
870139e45f Documentation: move socketcan.rst to net/ 2023-10-27 13:21:40 -03:00
raiden00pl
8090fb9d5c Documentation: add dummy pages for missing top directories
crypto, openamp, video and wireless
2023-10-27 13:21:40 -03:00
raiden00pl
9c4f042c57 Documentation: add missing directories in net 2023-10-27 13:21:40 -03:00
raiden00pl
408441bf15 Documentation: initialize cmake doc 2023-10-27 13:21:40 -03:00
raiden00pl
82e260740a Documentation: cosmetics for unionfs.rst 2023-10-27 13:21:40 -03:00
raiden00pl
56529d2944 Documentation: migrate the rest boards
- migrated /README are removed from /boards

- there are a lot of READMEs that should be further converted to rst.
  At the moment they are moved to Documentation/platforms and included in rst files
2023-10-26 18:13:34 -03:00
raiden00pl
443e900188 Documentation: migrate the rest of drivers readmes 2023-10-26 20:02:03 +08:00
raiden00pl
d98ae9d3e4 Documentation: cosmetics changes
- various style fixes
- limit the line length to about 80 characters to improve readability in terminal-based IDEs
2023-10-26 20:01:21 +08:00
raiden00pl
9bef53bbdd Documentation: migrate /drivers 2023-10-26 00:08:54 +08:00
raiden00pl
8e40cfd1b6 Documentation: migrate /arch 2023-10-26 00:08:54 +08:00
raiden00pl
8a330ca0bc Documentation: migrate /tools 2023-10-26 00:08:54 +08:00
raiden00pl
64b924d18c Documentation: migrate /syscall 2023-10-26 00:08:54 +08:00
raiden00pl
00d14665d1 Documentation: migrate /mm 2023-10-26 00:08:54 +08:00
raiden00pl
ebcf8f0d16 Documentation: migrate /net 2023-10-26 00:08:54 +08:00
raiden00pl
61cdd105ef Documentation: migrate /libs 2023-10-26 00:08:54 +08:00
raiden00pl
6448135f65 Documentation: migrate /fs 2023-10-26 00:08:54 +08:00
raiden00pl
1822b1c37f Documentation: migrate /audio 2023-10-26 00:08:54 +08:00
anjiahao
ae9d9054af zipfs:Add Documentation for zipfs
Signed-off-by: anjiahao <anjiahao@xiaomi.com>
2023-09-27 01:06:04 +08:00
Andre Heinemans
329e050c30 Added NXP SE05x support (secure element) 2023-09-09 15:54:08 +08:00
Xiang Xiao
90f8315432 arch: Remove up_netinitialize
since this api change to xxx_netinitialize

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2023-08-20 14:33:17 +03:00
yinshengkai
84799d15ac note: remove NOTERAM_GETTASKNAME
Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
2023-08-11 13:27:17 +08:00
wangjianyu3
036d7bfe1e Partition: Add doc for TXTABLE
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2023-08-02 19:51:53 -07:00
yinshengkai
ce98f186c0 syslog: add syslog channel filtering function
support to control the opening or closing of the specified channel through the syslogmask command at runtime

Signed-off-by: yinshengkai <yinshengkai@xiaomi.com>
2023-07-13 01:04:07 +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
Brennan Ashton
9a654b658e docs: Generate pdf version of docs for #9095
This implements the changes required to genreate the pdf version
of the documentation. The pdf will be generated as a build artifact
attached to the build. This is the first patch to enable this
a follow on patch to the website repo will publish the pdf to the
NuttX website.
2023-05-16 15:12:10 +08:00
pengyiqiang
0ed82e8380 video/fb: add vsync offset support
Android Documentation: https://source.android.com/docs/core/graphics/implement-vsync#vsync_offset

Signed-off-by: pengyiqiang <pengyiqiang@xiaomi.com>
2023-04-22 01:09:09 +08:00
Fotis Panagiotopoulos
85ceb7920e Typo fixes. 2023-02-17 11:17:11 -03:00
Ville Juven
42d0e356c2 arch/addrenv: Change group_addrenv_t to arch_addrenv_t
This is preparation for moving address environments out of the group
structure into the tcb.

Why move ? Because the group is destroyed very early in the exit phase,
but the MMU mappings are needed until the context switch to the next
process is complete. Otherwise the MMU will lose its mappings and the
system will crash.
2023-01-27 23:17:01 +08:00
Nathan Hartman
03802dad13 NuttX graduated the Incubator; update repository links 2022-11-26 11:58:15 -08:00
zhangyuan21
d8051ba979 nuttx/sched: merge up_block_task and up_unblock_task 2022-11-22 22:59:08 +08:00
Xiang Xiao
64e7833cbc sched/spawn: Support task_spawnattr_[set|get]stackaddr
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2022-10-31 12:46:58 +09:00
Brennan Ashton
c9636f0b3e docs: Update dependencies and fix lint errors 2022-10-10 09:29:53 +08:00
Tiago Medicci Serrano
daa4cf7ad2 documentation: improve frame buffer and lcd drivers documentation 2022-08-17 10:04:52 +03:00
curuvar
0c3db448bb Added Adafruit Feather RP2040, Adafruit KB2040 and Added neopixel driver to support RP2040 2022-06-30 22:13:49 -07: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
Michał Łyszczek
a5bcb2dc46 Documentation: fix multiple errors and warnings
Multiple files were badly formatted, which resulted in many
warnings. This made it harder to check for errors in newly
written documentation.

What's worse, badly formatted text resulted in butchered
output in generated html.

This patch fixes most of the errors, but alas, not all of
the errors can be fixed. Anyway, this should be way easier
to spot errors in newly written docs now.

Signed-off-by: Michał Łyszczek <michal.lyszczek@bofc.pl>
2022-06-08 03:02:32 +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
ligd
75aec04330 serial: add CONFIG_TTY_LAUNCH support
this allow user start new program from tty

Signed-off-by: ligd <liguiding1@xiaomi.com>
2022-01-01 20:38:26 +08:00
Xiang Xiao
6b6c11f0ad mtd: Replace MTDIOC_XIPBASE with BIOC_XIPBASE
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-08-12 08:01:29 -03:00
Xiang Xiao
5025fbef8d Rename LIB_ to LIBC_ for all libc Kconfig
follow other libc component naming convention

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2021-08-05 19:45:24 +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
Fotis Panagiotopoulos
e189d83e11 SYSLOG channel add functions return handle to the channel. 2021-06-03 08:36:15 -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
Fotis Panagiotopoulos
ee7276e7a7 syslog: syslog_device ops are handled internally by the driver. 2021-04-09 08:02:38 -05:00
raiden00pl
e4c27dfdd6 drivers: add generic upper-half driver for Field Oriented Control (FOC) 2021-03-30 21:54:39 -03:00
Byron Ellacott
c9db653c8d symtabs: improve handling of symbol lookups
When CONFIG_SYMTAB_ORDEREDBYNAME is selected most code will use
the ordered search function. When it is not selected no code will
use the ordered search function. This change merges the two
functions and varies its behaviour based on the config setting,
such that all callers can simply call the one search function
and get the best behaviour.

An additional configuration option allows leading underscores to
be stripped from symbols being relocated in loaded objects. This
allows toolchains which prefix C symbol with underscores to make
loadable ELF objects.
2021-03-16 10:18:17 -07:00
Sara Souza
071cfceed6 Update Documentation/components/drivers/character/watchdog.rst 2020-12-18 04:07:07 -08:00
David Sidrane
8de9cba43b Update Documentation/components/drivers/character/watchdog.rst 2020-12-18 03:35:54 -08:00
saramonteiro
48b5ac3ec0 Apply suggestions from code review
Co-authored-by: David Sidrane <David.Sidrane@Nscdg.com>
2020-12-18 03:35:54 -08:00
Sara Souza
4029c315f0 Apply 1 suggestion(s) to 1 file(s) 2020-12-18 03:35:54 -08:00
Sara Souza
51a6665925 Apply 1 suggestion(s) to 1 file(s) 2020-12-18 03:35:54 -08:00
Sara Souza
e049afc2a1 Documentation: how to use auto monitor feature to keep the chip alive 2020-12-18 03:35:54 -08:00
Matias N
206402c7e0 Documentation: add TODO 2020-11-21 18:09:19 -08:00
Diego Herranz
3956787254 Documentation/components/drivers/character/pwm: fix pwm.c location
- pwm.c was moved in 68bbc8438c but the
documentation wasn't updated.
- Also a minor typo fixed.
2020-11-17 22:11:08 +01:00
Sara Souza
8a1960fdf4 Documentation for Watchdog Timer Driver 2020-11-09 08:06:10 -08: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
Xiang Xiao
eb4121ce38 Change all 'Nuttx' to 'NuttX'
Unify the naming convention

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-20 01:45:06 -07:00
Xiang Xiao
e53779065e Documentation: Fix the broken link in introduction/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
4f1f25b516 Documentation: Remove the wrong comment about 64bit sim
64bit sim is fully supported now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
81465f659d Documentation: Move nsh/ to applications/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
9abe505726 Documentation: Move syslog.rst to components/drivers/special/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
155e98d42c Documentation: Move socketcan.rst to components/drivers/special/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
302d4da341 Documentation: Move note.rst to components/drivers/character/
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -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
Diego Herranz
9c43ca3d82 Documentation/components/nsh/login.rst: fix a couple of repo links manually
They may have been malformed or the path changed at some point
2020-10-18 12:22:54 -04:00
Diego Herranz
77160c7a32 Documentation: replace bitbucket links with github ones
bitbucket.org/nuttx/nuttx/src/ replaced with github.com/apache/incubator-nuttx/blob/
2020-10-18 12:22:54 -04:00
saramonteiro
d1f0c71d2c Update timer.rst 2020-10-15 19:09:26 -03:00
saramonteiro
b0416202f6 Update timer.rst 2020-10-15 19:09:26 -03:00
saramonteiro
8c4553693b Documentation for the Timer Driver 2020-10-15 19:09:26 -03:00
Matias N
166242c171 use "export" to expose TOPDIR to all child make instead of passing it around every time 2020-09-15 21:11:33 -07:00
Xiang Xiao
b0797263ca libc/stdio: Allocate file_struct dynamically
1.Reduce the default size of task_group_s(~512B each task)
2.Scale better between simple and complex application

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
Change-Id: Ia872137504fddcf64d89c48d6f0593d76d582710
2020-09-11 17:58:17 +08:00
Matias N
44cee3f211 documentation: split device drivers sections into individual documents 2020-09-06 10:58:12 -03:00
Matias N
2120eed84f documentation: fix build warning 2020-09-02 13:16:24 -07:00
Matias N
9b08cf945f documentation: address various duplicate declarations 2020-09-02 16:00:08 +08:00
Brennan Ashton
4cb193d530 Docs: Update links to old website and wiki
Signed-off-by: Brennan Ashton <bashton@brennanashton.com>
2020-08-30 19:16:30 -03:00
Matias N
b3a269b957 fix link 2020-08-24 10:29:55 -07:00
Matias N
4a38a15332 convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-24 10:29:55 -07:00
Matias N
2fb9910b01 backport SocketCAN documentation to new docs (PR #1533) 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00