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

102 lines
1.6 KiB
ReStructuredText
Raw Normal View History

doc: Include the I/O APIs in the documentation. Includes the I/O drivers' interfaces in the ReST documentation. Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-08 05:32:14 +08:00
.. _io_interfaces:
Input / Output Driver APIs
###########################
.. contents::
:depth: 1
:local:
:backlinks: top
doc: add missing API content Some API material (from doxygen comments) wasn't included in the generated documentation because there was no doxygengroup Sphinx directive to display them. This PR add content into appropriate places in existing documentation (e.g., Bluetooth Cryptography APIs into the Bluetooth API doc) and creates two new collections for Display and Miscellaneous APIs. Comments added to the .rst files to mention doxygengroups that are intentionally excluded (because they're organizational groups containing subgroups that are included). Sorted the Bluetooth API list, mostly. Fixed a couple doxygen group titles defined in the include files, and added a few patterns to filter new "expected" errors from the document generation process. Legacy and deprecated APIs remain left out, as intended: http_legacy (net/http_legacy.h) spi_interface_legacy (spi_legacy.h) zoap (net/zoap.h) fixes: Issue #5051 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-12-01 06:44:16 +08:00
.. comment
not documenting
.. doxygengroup:: io_interfaces
doc: Include the I/O APIs in the documentation. Includes the I/O drivers' interfaces in the ReST documentation. Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-08 05:32:14 +08:00
ADC Interface
*************
.. doxygengroup:: adc_interface
:project: Zephyr
doc: add missing API content Some API material (from doxygen comments) wasn't included in the generated documentation because there was no doxygengroup Sphinx directive to display them. This PR add content into appropriate places in existing documentation (e.g., Bluetooth Cryptography APIs into the Bluetooth API doc) and creates two new collections for Display and Miscellaneous APIs. Comments added to the .rst files to mention doxygengroups that are intentionally excluded (because they're organizational groups containing subgroups that are included). Sorted the Bluetooth API list, mostly. Fixed a couple doxygen group titles defined in the include files, and added a few patterns to filter new "expected" errors from the document generation process. Legacy and deprecated APIs remain left out, as intended: http_legacy (net/http_legacy.h) spi_interface_legacy (spi_legacy.h) zoap (net/zoap.h) fixes: Issue #5051 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-12-01 06:44:16 +08:00
DMA Interface
*************
.. doxygengroup:: DMA_interface
:project: Zephyr
doc: Include the I/O APIs in the documentation. Includes the I/O drivers' interfaces in the ReST documentation. Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-08 05:32:14 +08:00
GPIO Interface
**************
.. doxygengroup:: gpio_interface
:project: Zephyr
I2C Interface
*************
.. doxygengroup:: i2c_interface
:project: Zephyr
drivers: Add I2S (Inter-IC Sound) driver API Origin: Original Jira: ZEP-230 Signed-off-by: Piotr Mienkowski <piotr.mienkowski@gmail.com>
2017-07-11 05:27:10 +08:00
I2S Interface
*************
The I2S (Inter-IC Sound) API provides support for the standard I2S interface
as well as common non-standard extensions such as PCM Short/Long Frame Sync
and Left/Right Justified Data Formats.
.. doxygengroup:: i2s_interface
:project: Zephyr
doc: Include the I/O APIs in the documentation. Includes the I/O drivers' interfaces in the ReST documentation. Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-08 05:32:14 +08:00
IPM Interface
*************
.. doxygengroup:: ipm_interface
:project: Zephyr
PWM Interface
*************
.. doxygengroup:: pwm_interface
:project: Zephyr
Pinmux Interface
****************
.. doxygengroup:: pinmux_interface
:project: Zephyr
SPI Interface
*************
.. doxygengroup:: spi_interface
:project: Zephyr
drivers: Rename `random` to `entropy` This should clear up some of the confusion with random number generators and drivers that obtain entropy from the hardware. Also, many hardware number generators have limited bandwidth, so it's natural for their output to be only used for seeding a random number generator. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2017-10-14 07:30:55 +08:00
Entropy Interface
*****************
random: Introduce random device API. Introduce random device API analgous to other device driver classes in Zephyr. Modify the the KSDK random driver to implement the API. We retain the sys_rand32_get() interface for now on the assumption it will eventually relocate to or be otherwise replaced by an entropy management system. The existing TEST_RANDOM_GENERATOR related drivers that do not generate entropy are not modified to expose this driver API since they cannot generate entropy. Change-Id: I60b2d5afddf242e802a1d9014c99579870fb7472 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-11-20 07:46:22 +08:00
drivers: Rename `random` to `entropy` This should clear up some of the confusion with random number generators and drivers that obtain entropy from the hardware. Also, many hardware number generators have limited bandwidth, so it's natural for their output to be only used for seeding a random number generator. Signed-off-by: Leandro Pereira <leandro.pereira@intel.com>
2017-10-14 07:30:55 +08:00
.. doxygengroup:: entropy_interface
random: Introduce random device API. Introduce random device API analgous to other device driver classes in Zephyr. Modify the the KSDK random driver to implement the API. We retain the sys_rand32_get() interface for now on the assumption it will eventually relocate to or be otherwise replaced by an entropy management system. The existing TEST_RANDOM_GENERATOR related drivers that do not generate entropy are not modified to expose this driver API since they cannot generate entropy. Change-Id: I60b2d5afddf242e802a1d9014c99579870fb7472 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-11-20 07:46:22 +08:00
:project: Zephyr
doc: Include the I/O APIs in the documentation. Includes the I/O drivers' interfaces in the ReST documentation. Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-08 05:32:14 +08:00
UART Interface
**************
.. doxygengroup:: uart_interface
:project: Zephyr
doc: Add sensor section in API documentation Change-Id: Ie35bf6a8630db25d25604cd0a1667699ba261577 Signed-off-by: Vlad Dogaru <vlad.dogaru@intel.com>
2016-03-30 19:45:41 +08:00
doc: add missing API content Some API material (from doxygen comments) wasn't included in the generated documentation because there was no doxygengroup Sphinx directive to display them. This PR add content into appropriate places in existing documentation (e.g., Bluetooth Cryptography APIs into the Bluetooth API doc) and creates two new collections for Display and Miscellaneous APIs. Comments added to the .rst files to mention doxygengroups that are intentionally excluded (because they're organizational groups containing subgroups that are included). Sorted the Bluetooth API list, mostly. Fixed a couple doxygen group titles defined in the include files, and added a few patterns to filter new "expected" errors from the document generation process. Legacy and deprecated APIs remain left out, as intended: http_legacy (net/http_legacy.h) spi_interface_legacy (spi_legacy.h) zoap (net/zoap.h) fixes: Issue #5051 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-12-01 06:44:16 +08:00
Flash Interface
***************
.. doxygengroup:: flash_interface
:project: Zephyr
doc: Add sensor section in API documentation Change-Id: Ie35bf6a8630db25d25604cd0a1667699ba261577 Signed-off-by: Vlad Dogaru <vlad.dogaru@intel.com>
2016-03-30 19:45:41 +08:00
Sensor Interface
****************
.. doxygengroup:: sensor_interface
:project: Zephyr
doc: add missing API content Some API material (from doxygen comments) wasn't included in the generated documentation because there was no doxygengroup Sphinx directive to display them. This PR add content into appropriate places in existing documentation (e.g., Bluetooth Cryptography APIs into the Bluetooth API doc) and creates two new collections for Display and Miscellaneous APIs. Comments added to the .rst files to mention doxygengroups that are intentionally excluded (because they're organizational groups containing subgroups that are included). Sorted the Bluetooth API list, mostly. Fixed a couple doxygen group titles defined in the include files, and added a few patterns to filter new "expected" errors from the document generation process. Legacy and deprecated APIs remain left out, as intended: http_legacy (net/http_legacy.h) spi_interface_legacy (spi_legacy.h) zoap (net/zoap.h) fixes: Issue #5051 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-12-01 06:44:16 +08:00
Counter Interface
*****************
.. doxygengroup:: counter_interface
:project: Zephyr