OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/services/index.rst

33 lines
539 B
ReStructuredText
Raw Normal View History

doc: add os services Add a new 'OS Services' section to contain all dedicated os services from other sections of the doc (reference and guides). Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:40:37 +08:00
.. _os_services:
OS Services
###########
.. toctree::
:maxdepth: 1
doc: move logging to os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:41:46 +08:00
doc: move crypto/random sections into os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 23:23:10 +08:00
crypto/index
doc: move debugging under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:46:11 +08:00
debugging/index.rst
doc: move device mgmt under services Device management is an OS service. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-05 22:33:17 +08:00
device_mgmt/index
doc: move file system into os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 23:17:53 +08:00
file_system/index.rst
doc: move formatted output under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:53:48 +08:00
formatted_output.rst
doc: Add IPC service documentation Adding IPC service documentation for ICMSg backend. Signed-off-by: Emil Obalski <Emil.Obalski@nordicsemi.no>
2022-10-24 18:20:20 +08:00
ipc/index.rst
doc: move logging to os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:41:46 +08:00
logging/index.rst
doc: move debugging under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:46:11 +08:00
tracing/index.rst
doc: move resource management under services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:47:04 +08:00
resource_management/index.rst
doc: get rid of reference section Move last remaining items from reference section to the appropriate new section in the new structure. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-06 06:06:14 +08:00
modbus/index.rst
doc: move notification services under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:51:01 +08:00
notify.rst
doc: move power management under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:55:06 +08:00
pm/index.rst
doc: remove guides and split content Remove the old guides section and move all remaining items into new sections. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-06 05:36:48 +08:00
portability/index.rst
doc: move shell under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:51:52 +08:00
shell/index.rst
doc: move settings under os services Move this documentation to a new location under OS Services section. See #33725 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-04 22:52:33 +08:00
settings/index.rst
doc: move smf section into os services Move SMF frameowrk into OS Services. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-05 04:10:35 +08:00
smf/index.rst
doc: move misc services into OS Service section Move remaining services from guides into OS services. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-05 22:55:10 +08:00
storage/index.rst
task_wdt/index.rst
doc: move sections from guides Move remaining items from guides into the appropriate locations using the new structure. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-06 05:24:02 +08:00
tfm/index
doc: get rid of reference section Move last remaining items from reference section to the appropriate new section in the new structure. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-06 06:06:14 +08:00
usb/index.rst
virtualization/index.rst
rtio: Real-Time Input/Output Stream A DMA friendly Stream API for zephyr. Based on ideas from io_uring and iio, a queue based API for I/O operations. Provides a pair of fixed length ringbuffer backed queues for submitting I/O requests and recieving I/O completions. The requests may be chained together to ensure the next operation does not start until the current one is complete. Requests target an abstract rtio_iodev which is expected to wrap all the hardware particulars of how to perform the operation. For example with a SPI bus device, a description of what a read, and write mean can be decided by the iodev wrapping a particular device hanging off of a SPI controller. The queue pair are submitted to an executor which may be a simple inplace looping executor done in the callers execution context (thread/stack) but other executors are expected. A threadpool executor might for example allow for concurrent request chains to execute in parallel. A DMA executor, in conjunction with DMA aware iodevs would allow for hardware offloading of operations going so far as to schedule with priority using hardware arbitration. Both the iodev and executor are definable by a particular SoC, meaning they can work in conjuction to perform IO operations using a particular DMA controller or methodology if desired. The application decides entirely how large the queues are, where the buffers to read/write come from (some executors may have particular demands!), and which executor to submit requests to. Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2019-06-26 23:17:18 +08:00
rtio/index.rst
doc: get rid of reference section Move last remaining items from reference section to the appropriate new section in the new structure. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-06 06:06:14 +08:00
misc.rst