doc: add peripherals reference
Create a reference page for each peripheral and move doxygen API reference to the main documentation page. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
ecff7e6901
commit
4db3d06c2e
23 changed files with 278 additions and 136 deletions
|
@ -1,6 +1,6 @@
|
|||
#
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]file_system.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.
|
||||
#
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]io_interfaces.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]dma.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.
|
||||
#
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]subsystems[/\\]sensor.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]sensor.rst):(?P<lineno>[0-9]+): WARNING: Duplicate declaration.
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
#
|
||||
# UART unnamed struct definition
|
||||
#
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]io_interfaces.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
|
||||
#doc/api/peripherals/uart.rst
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]uart.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
|
||||
^[ \t]*
|
||||
^[ \t]*\^
|
||||
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
|
||||
|
@ -14,7 +14,7 @@
|
|||
^.*uart_device_config.__unnamed__.*
|
||||
^[- \t]*\^
|
||||
#
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]io_interfaces.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
|
||||
^(?P<filename>([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]uart.rst):(?P<lineno>[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
|
||||
^[ \t]*
|
||||
^[ \t]*\^
|
||||
^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]
|
||||
|
|
|
@ -16,8 +16,7 @@ The Zephyr APIs are used the same way on all SoCs and boards.
|
|||
kernel_api.rst
|
||||
bluetooth.rst
|
||||
networking.rst
|
||||
io_interfaces.rst
|
||||
timer_counter_interfaces.rst
|
||||
file_system
|
||||
display_api
|
||||
misc_api
|
||||
peripherals/index.rst
|
||||
|
|
|
@ -1,113 +0,0 @@
|
|||
.. _io_interfaces:
|
||||
|
||||
Input / Output Driver APIs
|
||||
###########################
|
||||
|
||||
.. contents::
|
||||
:depth: 1
|
||||
:local:
|
||||
:backlinks: top
|
||||
|
||||
.. comment
|
||||
not documenting
|
||||
.. doxygengroup:: io_interfaces
|
||||
|
||||
ADC Interface
|
||||
*************
|
||||
|
||||
.. doxygengroup:: adc_interface
|
||||
:project: Zephyr
|
||||
|
||||
CAN Interface
|
||||
*************
|
||||
|
||||
.. doxygengroup:: can_interface
|
||||
:project: Zephyr
|
||||
|
||||
DMA Interface
|
||||
*************
|
||||
|
||||
.. doxygengroup:: DMA_interface
|
||||
:project: Zephyr
|
||||
|
||||
GPIO Interface
|
||||
**************
|
||||
|
||||
.. doxygengroup:: gpio_interface
|
||||
:project: Zephyr
|
||||
|
||||
I2C Interface
|
||||
*************
|
||||
|
||||
.. doxygengroup:: i2c_interface
|
||||
:project: Zephyr
|
||||
|
||||
I2C EEPROM Slave Driver
|
||||
***********************
|
||||
|
||||
.. doxygengroup:: i2c_eeprom_slave_api
|
||||
:project: Zephyr
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
Entropy Interface
|
||||
*****************
|
||||
|
||||
.. doxygengroup:: entropy_interface
|
||||
:project: Zephyr
|
||||
|
||||
UART Interface
|
||||
**************
|
||||
|
||||
.. doxygengroup:: uart_interface
|
||||
:project: Zephyr
|
||||
|
||||
Flash Interface
|
||||
***************
|
||||
|
||||
.. doxygengroup:: flash_interface
|
||||
:project: Zephyr
|
||||
|
||||
Sensor Interface
|
||||
****************
|
||||
|
||||
.. doxygengroup:: sensor_interface
|
||||
:project: Zephyr
|
||||
|
||||
Counter Interface
|
||||
*****************
|
||||
|
||||
.. doxygengroup:: counter_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/adc.rst
Normal file
14
doc/api/peripherals/adc.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _adc_interface:
|
||||
|
||||
ADC
|
||||
###
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: adc_interface
|
||||
:project: Zephyr
|
13
doc/api/peripherals/can.rst
Normal file
13
doc/api/peripherals/can.rst
Normal file
|
@ -0,0 +1,13 @@
|
|||
.. _can_interface:
|
||||
|
||||
CAN
|
||||
###
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: can_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/counter.rst
Normal file
14
doc/api/peripherals/counter.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _counter_interface:
|
||||
|
||||
Counter
|
||||
#######
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: counter_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/dma.rst
Normal file
14
doc/api/peripherals/dma.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _dma_interface:
|
||||
|
||||
DMA
|
||||
###
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: dma_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/entropy.rst
Normal file
14
doc/api/peripherals/entropy.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _entropy_interface:
|
||||
|
||||
Entropy
|
||||
#######
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: entropy_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/flash.rst
Normal file
14
doc/api/peripherals/flash.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _flash_interface:
|
||||
|
||||
Flash
|
||||
#####
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: flash_interface
|
||||
:project: Zephyr
|
21
doc/api/peripherals/gpio.rst
Normal file
21
doc/api/peripherals/gpio.rst
Normal file
|
@ -0,0 +1,21 @@
|
|||
.. _gpio:
|
||||
|
||||
|
||||
GPIO
|
||||
####
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Configuration Options
|
||||
*********************
|
||||
|
||||
Related configuration options:
|
||||
|
||||
* :option:`CONFIG_GPIO`
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: gpio_interface
|
||||
:project: Zephyr
|
21
doc/api/peripherals/i2c.rst
Normal file
21
doc/api/peripherals/i2c.rst
Normal file
|
@ -0,0 +1,21 @@
|
|||
.. _i2c:
|
||||
|
||||
|
||||
I2C
|
||||
####
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
Configuration Options
|
||||
*********************
|
||||
|
||||
Related configuration options:
|
||||
|
||||
* :option:`CONFIG_I2C`
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: i2c_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/i2c_eeprom_slave.rst
Normal file
14
doc/api/peripherals/i2c_eeprom_slave.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _i2c_eeprom_slave_interface:
|
||||
|
||||
I2C EEPROM Slave
|
||||
################
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
API Reference
|
||||
**************
|
||||
|
||||
.. doxygengroup:: i2c_eeprom_slave_api
|
||||
:project: Zephyr
|
||||
|
25
doc/api/peripherals/i2s.rst
Normal file
25
doc/api/peripherals/i2s.rst
Normal file
|
@ -0,0 +1,25 @@
|
|||
.. _i2s:
|
||||
|
||||
|
||||
I2S
|
||||
####
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
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.
|
||||
|
||||
Configuration Options
|
||||
*********************
|
||||
|
||||
Related configuration options:
|
||||
|
||||
* :option:`CONFIG_I2S`
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: i2s_interface
|
||||
:project: Zephyr
|
24
doc/api/peripherals/index.rst
Normal file
24
doc/api/peripherals/index.rst
Normal file
|
@ -0,0 +1,24 @@
|
|||
.. _api_peripherals:
|
||||
|
||||
Peripherals
|
||||
###########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
adc.rst
|
||||
can.rst
|
||||
counter.rst
|
||||
dma.rst
|
||||
entropy.rst
|
||||
flash.rst
|
||||
gpio.rst
|
||||
i2c_eeprom_slave.rst
|
||||
i2c.rst
|
||||
i2s.rst
|
||||
ipm.rst
|
||||
pinmux.rst
|
||||
pwm.rst
|
||||
spi.rst
|
||||
uart.rst
|
||||
watchdog.rst
|
14
doc/api/peripherals/ipm.rst
Normal file
14
doc/api/peripherals/ipm.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _ipm_interface:
|
||||
|
||||
IPM
|
||||
###
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: ipm_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/pinmux.rst
Normal file
14
doc/api/peripherals/pinmux.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _pinmux_interface:
|
||||
|
||||
Pinmux
|
||||
######
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: pinmux_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/pwm.rst
Normal file
14
doc/api/peripherals/pwm.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _pwm_interface:
|
||||
|
||||
PWM
|
||||
###
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: pwm_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/spi.rst
Normal file
14
doc/api/peripherals/spi.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _spi_interface:
|
||||
|
||||
SPI
|
||||
###
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: spi_interface
|
||||
:project: Zephyr
|
13
doc/api/peripherals/uart.rst
Normal file
13
doc/api/peripherals/uart.rst
Normal file
|
@ -0,0 +1,13 @@
|
|||
.. _uart_interface:
|
||||
|
||||
UART
|
||||
####
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: uart_interface
|
||||
:project: Zephyr
|
14
doc/api/peripherals/watchdog.rst
Normal file
14
doc/api/peripherals/watchdog.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
.. _watchdog_interface:
|
||||
|
||||
Watchdog
|
||||
########
|
||||
|
||||
Overview
|
||||
********
|
||||
|
||||
|
||||
API Reference
|
||||
*************
|
||||
|
||||
.. doxygengroup:: watchdog_interface
|
||||
:project: Zephyr
|
|
@ -1,15 +0,0 @@
|
|||
.. _timer_counter_interfaces:
|
||||
|
||||
Timer / Counter Driver APIs
|
||||
###########################
|
||||
|
||||
.. contents::
|
||||
:depth: 1
|
||||
:local:
|
||||
:backlinks: top
|
||||
|
||||
Watchdog Interface
|
||||
******************
|
||||
|
||||
.. doxygengroup:: watchdog_interface
|
||||
:project: Zephyr
|
|
@ -23,7 +23,7 @@ extern "C" {
|
|||
|
||||
/**
|
||||
* @brief DMA Interface
|
||||
* @defgroup DMA_interface DMA Interface
|
||||
* @defgroup dma_interface DMA Interface
|
||||
* @ingroup io_interfaces
|
||||
* @{
|
||||
*/
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue