doc: add peripheral_types.h as API reference for peripheral docs

Closes DOC-136
Closes IDF-1673
This commit is contained in:
Marius Vikhammer
2020-04-28 10:52:14 +08:00
parent 84b51781c8
commit 7d3d56ff9a
15 changed files with 36 additions and 15 deletions

View File

@@ -26,6 +26,8 @@ typedef enum {
GPIO_PORT_MAX, GPIO_PORT_MAX,
} gpio_port_t; } gpio_port_t;
/** @cond */ //Doxy command to hide preprocessor definitions from docs */
#define GPIO_SEL_0 (BIT(0)) /*!< Pin 0 selected */ #define GPIO_SEL_0 (BIT(0)) /*!< Pin 0 selected */
#define GPIO_SEL_1 (BIT(1)) /*!< Pin 1 selected */ #define GPIO_SEL_1 (BIT(1)) /*!< Pin 1 selected */
#define GPIO_SEL_2 (BIT(2)) /*!< Pin 2 selected */ #define GPIO_SEL_2 (BIT(2)) /*!< Pin 2 selected */
@@ -130,6 +132,8 @@ typedef enum {
#define GPIO_PIN_REG_46 IO_MUX_GPIO46_REG #define GPIO_PIN_REG_46 IO_MUX_GPIO46_REG
#endif #endif
/** @endcond */
typedef enum { typedef enum {
GPIO_NUM_NC = -1, /*!< Use to signal not connected to S/W */ GPIO_NUM_NC = -1, /*!< Use to signal not connected to S/W */
GPIO_NUM_0 = 0, /*!< GPIO0, input and output */ GPIO_NUM_0 = 0, /*!< GPIO0, input and output */

View File

@@ -29,6 +29,8 @@ typedef enum {
#endif #endif
} spi_host_device_t; } spi_host_device_t;
/** @cond */ //Doxy command to hide preprocessor definitions from docs */
//alias for different chips //alias for different chips
#ifdef CONFIG_IDF_TARGET_ESP32 #ifdef CONFIG_IDF_TARGET_ESP32
#define SPI_HOST SPI1_HOST #define SPI_HOST SPI1_HOST
@@ -40,3 +42,5 @@ typedef enum {
#define HSPI_HOST SPI3_HOST #define HSPI_HOST SPI3_HOST
#define VSPI_HOST SPI4_HOST #define VSPI_HOST SPI4_HOST
#endif #endif
/** @endcond */

View File

@@ -226,6 +226,8 @@ ADC driver
.. include:: /_build/inc/adc.inc .. include:: /_build/inc/adc.inc
.. include:: /_build/inc/adc_types.inc
.. _adc-api-reference-adc-calibration: .. _adc-api-reference-adc-calibration:
ADC Calibration ADC Calibration

View File

@@ -39,3 +39,4 @@ e.g.
2. ``DAC_GPIO26_CHANNEL`` is the channel number of GPIO 26 (channel 2). 2. ``DAC_GPIO26_CHANNEL`` is the channel number of GPIO 26 (channel 2).
.. include:: /_build/inc/dac_channel.inc .. include:: /_build/inc/dac_channel.inc
.. include:: /_build/inc/dac_types.inc

View File

@@ -20,9 +20,10 @@ API Reference - Normal GPIO
--------------------------- ---------------------------
.. include:: /_build/inc/gpio.inc .. include:: /_build/inc/gpio.inc
.. include:: /_build/inc/gpio_types.inc
API Reference - RTC GPIO API Reference - RTC GPIO
------------------------ ------------------------
.. include:: /_build/inc/rtc_io.inc .. include:: /_build/inc/rtc_io.inc
.. include:: /_build/inc/rtc_io_types.inc

View File

@@ -250,3 +250,4 @@ API Reference
------------- -------------
.. include:: /_build/inc/i2c.inc .. include:: /_build/inc/i2c.inc
.. include:: /_build/inc/i2c_types.inc

View File

@@ -209,4 +209,5 @@ API Reference
------------- -------------
.. include:: /_build/inc/i2s.inc .. include:: /_build/inc/i2s.inc
.. include:: /_build/inc/i2s_types.inc

View File

@@ -174,4 +174,5 @@ API Reference
------------- -------------
.. include:: /_build/inc/ledc.inc .. include:: /_build/inc/ledc.inc
.. include:: /_build/inc/ledc_types.inc

View File

@@ -93,4 +93,5 @@ API Reference
------------- -------------
.. include:: /_build/inc/pcnt.inc .. include:: /_build/inc/pcnt.inc
.. include:: /_build/inc/pcnt_types.inc

View File

@@ -265,4 +265,5 @@ API Reference
------------- -------------
.. include:: /_build/inc/rmt.inc .. include:: /_build/inc/rmt.inc
.. include:: /_build/inc/rmt_types.inc

View File

@@ -30,3 +30,4 @@ API Reference
------------- -------------
.. include:: /_build/inc/sigmadelta.inc .. include:: /_build/inc/sigmadelta.inc
.. include:: /_build/inc/sigmadelta_types.inc

View File

@@ -107,3 +107,4 @@ API Reference
------------- -------------
.. include:: /_build/inc/timer.inc .. include:: /_build/inc/timer.inc
.. include:: /_build/inc/timer_types.inc

View File

@@ -380,6 +380,7 @@ API Reference
------------- -------------
.. include:: /_build/inc/uart.inc .. include:: /_build/inc/uart.inc
.. include:: /_build/inc/uart_types.inc
GPIO Lookup Macros GPIO Lookup Macros

View File

@@ -105,3 +105,4 @@ API 参考
------------- -------------
.. include:: /_build/inc/timer.inc .. include:: /_build/inc/timer.inc
.. include:: /_build/inc/timer_types.inc