Commit graph

345 commits

Author SHA1 Message Date
Chris Friedt 1f5960e531 doc: posix: add links and make minor corrections
Add a link to _POSIX_CLOCK_MONOTONIC, correct the
_POSIX_RAW_SOCKETS kconfig option.

Define _POSIX_CHOWN_RESTRICTED and _POSIX_NO_TRUNC so that they
conform to the spec.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-05-07 21:22:56 -04:00
Chris Friedt 73c8611682 doc: posix: link _POSIX_FSYNC to kconfig option
Link _POSIX_FSYNC to CONFIG_POSIX_FSYNC instead of
CONFIG_POSIX_FS.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-05-07 21:22:56 -04:00
Chris Friedt 99f81ce5c6 doc: posix: conformance: define realtime signals option group
Link the option _POSIX_REALTIME_SIGNALS to the option group
POSIX_REALTIME_SIGNALS since it is well-defined in the spec.

Add the definition to the option_groups page.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-05-07 21:22:56 -04:00
Chris Friedt b2954ab036 doc: posix: overview: link to memory domain documentation
Link to the Memory Domains document in the overview.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-05-07 21:22:56 -04:00
Chris Friedt 785ea74016 doc: posix: overview: correct typo (needed plural threads)
Correct the typo on thread so that it reads as the plural
threads.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-05-07 21:22:56 -04:00
Chris Friedt d1a3ad43a6 doc: posix: impl: add missing ref tags
Previously, the :ref: tag was missing in front of two links to
the System Calls page.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-05-07 21:22:56 -04:00
Benjamin Cabé 5b98c29d72 docs: nvme: Fix formatting issue
Fix an improperly formatted bullet list due to missing empty line.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-05-07 17:56:06 -04:00
Fin Maaß 7d83a8a68a lib: smf: constant number of arguments for SMF_CREATE_STATE()
This sets the number of arguments for SMF_CREATE_STATE() to always
be the same, independent of the selected Kconfig options.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-05-07 17:46:21 +02:00
Fabio Baltieri 4d51bea084 doc: services: pm: document the "device list" command
Document the "device list" command in the context of device power
management.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-05-01 10:31:03 +02:00
Chris Friedt 35429debb6 doc: posix: add visualization diagram for aep, si, pse51-pse53
Add a diagram that was first created for eoss 2024 to help
visualize the relation between the different application
environment profiles of IEEE 1003.13-2003.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt c0dc8d1426 doc: posix: aep: condense aep documentation
The POSIX Application Environment Profiles are additive and
offer incrementally more features over the System Interfaces.

For example, PSE51 includes all of the features of the Minimal
Realtime System Profile plus all of the System Interfaces.
PSE52 includes all of the features of the Realtime Controller
System Profile, plus the features of PSE51, plus the System
Interfaces, and so on.

It makes sense to take advantage of that and to condense the
AEP documenation.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt 37462aec6d doc: posix: option_groups: additional options and option groups
Define additional options and option groups for PSE51 to PSE53.

The options groups added in this commit are:

POSIX_SIGNAL_JUMP
POSIX_FILE_SYSTEM
POSIX_PIPE
POSIX_FILE_LOCKING

The options added in this commit are:

_POSIX_MEMLOCK
_POSIX_MEMLOCK_RANGE
_POSIX_MONOTONIC_CLOCK
_POSIX_SHARED_MEMORY_OBJECTS
_POSIX_THREAD_CPUTIME

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt 57ff7c9f7e doc: posix: conformance: reorder _POSIX_THREAD_CPUTIME
_POSIX_THREAD_CPUTIME was listed out of alphabetical order.

Move it to the correct location.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt ee2c2f6488 doc: posix: overview: add missing :ref: in subprofiles section
Previously, some links were not resolving properly since they
lacked the :ref: prefix, so it was added.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt 28a69a8e80 doc: posix: mark asyncronous io as being supported
Mark the _POSIX_ASYNCHRONOUS_IO headers as supported, and note
the deviation that they return -1 and set errno to ENOTSUP.

At some later date, it might be possible to implement the
standard functions with other Zephyr API calls.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 11:02:11 +02:00
Flavio Ceolin c059405da5 docs: pm: Fix typo
s/seatures/features/g

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-27 11:06:06 +03:00
Flavio Ceolin a9cf4a16ad docs: pm: Change API section name
Add APIs suffix to distinguish this section from others
power management sections.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin 1aaf597e4f docs: pm: Add introduction section in system pm
Create a introduction section just like the others chapters.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin bbd9d3dc5d docs: pm: Add examples to power domains
Add specific power dmains samples in power domains section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin b4d3f47466 docs: pm: Add examples to device runtime pm
Add specific device runtime power management samples to device runtime
pm section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin eff0e4f6b1 docs: pm: Add examples to device pm
Add specific device power management samples to device pm section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin 63d7e459bb docs: pm: Organize device pm sections
Instead of chapters, make device runtime power management and
system-managed device power management sections.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin d07f3c3da3 doc: pm: Remove power domain section in device
There is a whole section dedicated to power domains. The brief
information in device power management was not adding anything.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Fabio Baltieri a466fb05d0 doc: services: pm: mention the pm shell option
Add a paragraph about the CONFIG_PM_DEVICE_SHELL option and how to use
it.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-04-25 18:00:05 -04:00
Karthikeyan Krishnasamy 5233a4fa92 doc: posix: mark ftruncate as supported
Add POSIX FD_MGMT option and mark ftruncate as supported
in POSIX Option group Documentation

Signed-off-by: Karthikeyan Krishnasamy <karthikeyan@linumiz.com>
2024-04-22 04:33:16 -07:00
Karthikeyan Krishnasamy 1ddefc6ba0 doc: posix: mark fynsc as supported
Mark fsync as supported in POSIX options Documentation

Signed-off-by: Karthikeyan Krishnasamy <karthikeyan@linumiz.com>
2024-04-22 04:33:16 -07:00
Gaetan Perrot 4f9338a66b doc: posix: mark isastream as supported
`isastream ()` is now implemented, mark it so.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-04-13 20:23:34 -04:00
Declan Snyder 12f48fe896 doc: services: pm: Reword System PM Doc
The following changes:
- Generally reword all the paragraphs to hopefully by clearer and
  easier to read by using more straighforward and direct wording,
  and avoiding run on sentences and ambiguous/wrong grammar, etc.
- Move Examples to the bottom of the page.
- Fix a typo in the code expression where there was an extra
  parentheses.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2024-04-12 21:56:35 -04:00
Dmitrii Golovanov 3614d4cb88 gdbstub: doc: Update documentation with example
Update the Zephyr `gdbstub` documentation with its 'how to use'
example to align with former sample application replaced by the test.

Fixes: zephyrproject-rtos#70966

Signed-off-by: Dmitrii Golovanov <dmitrii.golovanov@intel.com>
2024-04-11 09:07:50 +02:00
Lluis Campos 85b86daa01 doc: device_mgmt: Fix typo in link text
Previously it read "there is a sample sample that..."

Signed-off-by: Lluis Campos <lluis.campos@northern.tech>
2024-04-10 11:28:51 -04:00
Flavio Ceolin cd685bdce8 doc: pm: Update system pm diagram
Update system pm diagram to reflect recent changes in the subysystem.
Use graphviz to create this new diagram.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-05 16:50:21 +03:00
Flavio Ceolin 68c0c55419 doc: pm: Clarify a device pm note
Clarify conditions that prevent the cpu to enter low power
state.

Fixes #69647

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-05 12:19:46 +02:00
Flavio Ceolin 6c68d62e48 doc: pm: Update device power management documentation
Update information about device power management.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-03 20:41:26 -04:00
Flavio Ceolin 0a44403c46 doc: pm: Change section in device pm
s/System Power Management/System Managed Device Power Management/g

System Power Management is confusing and does not tell
anything about device. Change it for something more explicit.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-03 20:41:26 -04:00
Gaetan Perrot 97f8745eec doc: posix: mark set and get inheritsched as supported
`pthread_attr_getinheritsched()` and
`pthread_attr_setinheritsched()` are now implemented,
mark it so.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-04-01 11:04:35 +01:00
Jukka Rissanen 9dad97ae95 doc: net: Remove the mention of NET_SOCKETS_POSIX_NAMES
The option is deprecated so remove it from documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-03-27 13:40:13 -05:00
Chris Friedt 0bcf71e28a doc: posix: add POSIX_NETWORKING Option Group and mark supported
Mark the POSIX_NETWORKING Option Group as supported. The
POSIX_NETWORKING Option Group is required for PSE53 Conformance.

Signed-off-by: Chris Friedt <chrisfriedt@gmail.com>
2024-03-27 07:36:18 -04:00
Kevin ORourke 98aa10d6ea scripts: coredump: coredump_gdbserver in pipeline
Add support to coredump_gdbserver.py for running in a pipeline,
communicating through stdin/stdout instead of a socket.

This allows starting it from inside gdb, with:

    target remote | coredump_gdbserver.py --pipe <elf_file>  <log_file>

Signed-off-by: Kevin ORourke <kevin.orourke@ferroamp.se>
2024-03-26 08:51:49 -04:00
Chris Friedt b5a15c980f doc: posix: remove unneeded notes about XSI_THREADS_EXT
Previously, XSI_THREADS_EXT included a note about
undefined behaviour. However, the required functions
pthread_attr_getstack(), pthread_attr_setstack(),
pthread_getconcurrency(), and pthread_setconcurrency()
are all conformant.

Remove the unneeded note (all of them)

Signed-off-by: Chris Friedt <chrisfriedt@gmail.com>
2024-03-26 06:54:27 -04:00
Christopher Friedt 8de8bcc99c doc: posix: mark pthread_rwlockattr_setpshared as supported
Mark pthread_rwlockattr_setpshared() and
pthread_rwlockattr_getpshared() as supported in the POSIX
Options documentation.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 16:19:57 -04:00
Christopher Friedt 457e44073b doc: posix: mark clock_getres() as supported
Mark clock_getres() as supported in the POSIX_TIMERS Option
Group.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 16:19:27 -04:00
Christopher Friedt 98a121da0c doc: posix: aep: mark POSIX_SINGLE_PROCESS as supported
Mark the POSIX_SINGLE_PROCESS Option Group as supported
in PSE51, PSE52, and PSE53 Application Environment
Profiles.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:57:44 +01:00
Christopher Friedt 601c0bed33 doc: posix: mark confstr() as supported
Mark confstr() as supported in POSIX Option Groups.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:57:44 +01:00
Christopher Friedt cb9384e597 doc: posix: mark _POSIX_CPUTIME as supported
The `_POSIX_CPUTIME` interface requires
`CLOCK_PROCESS_CPUTIME_ID` and `clock_getcpuclockid()` to be
present. Both of those are now available and therefore we can
mark `_POSIX_CPUTIME` as supported for PSE53.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:54:17 +01:00
Christopher Friedt b31b6f9feb doc: posix: correct note of XSI_THREADS_EXT
Previously, XSI_THREADS_EXT included a note about
undefined behaviour. However, the required functions
pthread_attr_getstack(), pthread_attr_setstack(),
pthread_getconcurrency(), and pthread_setconcurrency()
are all conformant.

Remove the unneeded note.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:53:57 +01:00
Jordan Yates ca36feeca8 doc: logging: document LOG_WRN_ONCE
Document the existence of `LOG_WRN_ONCE`.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2024-03-21 10:07:36 +00:00
Glenn Andrews aeea1d10de Lib: SMF: Fix typo in documentation
Fixes a typo found by @bryceschober

Spell-checked the rest of the document and found no issues.

Signed-off-by: Glenn Andrews <glenn.andrews.42@gmail.com>
2024-03-19 11:45:27 -04:00
Gaetan Perrot 990ebd5c94 doc: posix: mark set and get scope APIs for pthread attr as supported
`pthread_attr_setscope()` and `pthread_attr_getscope()`
are now implemented, mark it so.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-18 10:15:53 +01:00
Gaetan Perrot b519041948 doc: posix: sched functions will fail with ENOSYS
Mark `sched_setparam()` , `sched_setscheduler()`
and `sched_rr_get_interval()`
have implemented but will fail with ``ENOSYS``
Were missing on the documentation before.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-16 18:19:21 +09:00
Gaetan Perrot f913af8a4d doc: posix: mark putmsg as supported
Mark `putmsg()` as implemented but will fail with ``ENOSYS``
Was missing on the documentation before.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-16 18:19:21 +09:00