From 27fa1dc0dd527083ada37220135f6dbbb0b7166d Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 28 Apr 2020 10:52:14 +0800 Subject: [PATCH] doc: add peripheral_types.h as API reference for peripheral docs Closes DOC-136 Closes IDF-1673 --- components/soc/include/hal/gpio_types.h | 4 ++++ components/soc/include/hal/spi_types.h | 4 ++++ docs/en/api-reference/peripherals/adc.rst | 2 ++ docs/en/api-reference/peripherals/dac.rst | 1 + docs/en/api-reference/peripherals/gpio.rst | 3 +++ docs/en/api-reference/peripherals/i2c.rst | 3 ++- docs/en/api-reference/peripherals/i2s.rst | 3 ++- docs/en/api-reference/peripherals/ledc.rst | 1 + docs/en/api-reference/peripherals/pcnt.rst | 1 + docs/en/api-reference/peripherals/rmt.rst | 1 + docs/en/api-reference/peripherals/sigmadelta.rst | 1 + docs/en/api-reference/peripherals/timer.rst | 1 + docs/en/api-reference/peripherals/uart.rst | 1 + docs/zh_CN/api-reference/peripherals/ledc.rst | 1 + docs/zh_CN/api-reference/peripherals/timer.rst | 1 + 15 files changed, 26 insertions(+), 2 deletions(-) diff --git a/components/soc/include/hal/gpio_types.h b/components/soc/include/hal/gpio_types.h index 164d076f9..498d40962 100644 --- a/components/soc/include/hal/gpio_types.h +++ b/components/soc/include/hal/gpio_types.h @@ -26,6 +26,8 @@ typedef enum { GPIO_PORT_MAX, } gpio_port_t; +/** @cond */ //Doxy command to hide preprocessor definitions from docs */ + #define GPIO_SEL_0 (BIT(0)) /*!< Pin 0 selected */ #define GPIO_SEL_1 (BIT(1)) /*!< Pin 1 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 #endif +/** @endcond */ + typedef enum { GPIO_NUM_NC = -1, /*!< Use to signal not connected to S/W */ GPIO_NUM_0 = 0, /*!< GPIO0, input and output */ diff --git a/components/soc/include/hal/spi_types.h b/components/soc/include/hal/spi_types.h index e8dec6ca0..379f13988 100644 --- a/components/soc/include/hal/spi_types.h +++ b/components/soc/include/hal/spi_types.h @@ -27,6 +27,8 @@ typedef enum { SPI3_HOST=2, ///< SPI3 } spi_host_device_t; +/** @cond */ //Doxy command to hide preprocessor definitions from docs */ + //alias for different chips #ifdef CONFIG_IDF_TARGET_ESP32 #define SPI_HOST SPI1_HOST @@ -38,3 +40,5 @@ typedef enum { #define FSPI_HOST SPI2_HOST #define HSPI_HOST SPI3_HOST #endif + +/** @endcond */ diff --git a/docs/en/api-reference/peripherals/adc.rst b/docs/en/api-reference/peripherals/adc.rst index b07bad67c..6d7d8f33d 100644 --- a/docs/en/api-reference/peripherals/adc.rst +++ b/docs/en/api-reference/peripherals/adc.rst @@ -246,6 +246,8 @@ ADC driver .. include-build-file:: inc/adc.inc +.. include-build-file:: inc/adc_types.inc + .. _adc-api-reference-adc-calibration: ADC Calibration diff --git a/docs/en/api-reference/peripherals/dac.rst b/docs/en/api-reference/peripherals/dac.rst index d8fbd55e1..35191a2ea 100644 --- a/docs/en/api-reference/peripherals/dac.rst +++ b/docs/en/api-reference/peripherals/dac.rst @@ -44,3 +44,4 @@ e.g. 2. ``DAC_{IDF_TARGET_DAC_CH_2}_CHANNEL`` is the channel number of GPIO 26 (channel 2). .. include-build-file:: inc/dac_channel.inc +.. include-build-file:: inc/dac_types.inc diff --git a/docs/en/api-reference/peripherals/gpio.rst b/docs/en/api-reference/peripherals/gpio.rst index 6281c98c9..ab13341ee 100644 --- a/docs/en/api-reference/peripherals/gpio.rst +++ b/docs/en/api-reference/peripherals/gpio.rst @@ -30,9 +30,12 @@ API Reference - Normal GPIO --------------------------- .. include-build-file:: inc/gpio.inc +.. include-build-file:: inc/gpio_types.inc API Reference - RTC GPIO ------------------------ .. include-build-file:: inc/rtc_io.inc +.. include-build-file:: inc/rtc_io_types.inc + diff --git a/docs/en/api-reference/peripherals/i2c.rst b/docs/en/api-reference/peripherals/i2c.rst index 9d72c333b..5795041cd 100644 --- a/docs/en/api-reference/peripherals/i2c.rst +++ b/docs/en/api-reference/peripherals/i2c.rst @@ -104,7 +104,7 @@ The following describes how a command link for a "master write" is set up and wh 1. Create a command link with :cpp:func:`i2c_cmd_link_create`. Then, populate it with the series of data to be sent to the slave: - + a) **Start bit** - :cpp:func:`i2c_master_start` b) **Slave address** - :cpp:func:`i2c_master_write_byte`. The single byte address is provided as an argument of this function call. c) **Data** - One or more bytes as an argument of :cpp:func:`i2c_master_write` @@ -249,3 +249,4 @@ API Reference ------------- .. include-build-file:: inc/i2c.inc +.. include-build-file:: inc/i2c_types.inc diff --git a/docs/en/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst index 1a96eb722..5216f2160 100644 --- a/docs/en/api-reference/peripherals/i2s.rst +++ b/docs/en/api-reference/peripherals/i2s.rst @@ -204,7 +204,7 @@ Configuring I2S to use internal DAC for analog output i2s_driver_install(i2s_num, &i2s_config, 0, NULL); //install and start i2s driver i2s_set_pin(i2s_num, NULL); //for internal DAC, this will enable both of the internal channels - + //You can call i2s_set_dac_mode to set built-in DAC output mode. //i2s_set_dac_mode(I2S_DAC_CHANNEL_BOTH_EN); @@ -217,4 +217,5 @@ API Reference ------------- .. include-build-file:: inc/i2s.inc +.. include-build-file:: inc/i2s_types.inc diff --git a/docs/en/api-reference/peripherals/ledc.rst b/docs/en/api-reference/peripherals/ledc.rst index 71adcb00c..49bfcfae2 100644 --- a/docs/en/api-reference/peripherals/ledc.rst +++ b/docs/en/api-reference/peripherals/ledc.rst @@ -203,4 +203,5 @@ API Reference ------------- .. include-build-file:: inc/ledc.inc +.. include-build-file:: inc/ledc_types.inc diff --git a/docs/en/api-reference/peripherals/pcnt.rst b/docs/en/api-reference/peripherals/pcnt.rst index 55458a48f..a5f0b3c60 100644 --- a/docs/en/api-reference/peripherals/pcnt.rst +++ b/docs/en/api-reference/peripherals/pcnt.rst @@ -98,4 +98,5 @@ API Reference ------------- .. include-build-file:: inc/pcnt.inc +.. include-build-file:: inc/pcnt_types.inc diff --git a/docs/en/api-reference/peripherals/rmt.rst b/docs/en/api-reference/peripherals/rmt.rst index 5a39ae2f1..0e66057b5 100644 --- a/docs/en/api-reference/peripherals/rmt.rst +++ b/docs/en/api-reference/peripherals/rmt.rst @@ -296,4 +296,5 @@ API Reference ------------- .. include-build-file:: inc/rmt.inc +.. include-build-file:: inc/rmt_types.inc diff --git a/docs/en/api-reference/peripherals/sigmadelta.rst b/docs/en/api-reference/peripherals/sigmadelta.rst index 55721b309..0352cc81b 100644 --- a/docs/en/api-reference/peripherals/sigmadelta.rst +++ b/docs/en/api-reference/peripherals/sigmadelta.rst @@ -30,3 +30,4 @@ API Reference ------------- .. include-build-file:: inc/sigmadelta.inc +.. include-build-file:: inc/sigmadelta_types.inc diff --git a/docs/en/api-reference/peripherals/timer.rst b/docs/en/api-reference/peripherals/timer.rst index 9c0c09257..017ecab01 100644 --- a/docs/en/api-reference/peripherals/timer.rst +++ b/docs/en/api-reference/peripherals/timer.rst @@ -108,3 +108,4 @@ API Reference ------------- .. include-build-file:: inc/timer.inc +.. include-build-file:: inc/timer_types.inc diff --git a/docs/en/api-reference/peripherals/uart.rst b/docs/en/api-reference/peripherals/uart.rst index e638d8ede..f6f8aa027 100644 --- a/docs/en/api-reference/peripherals/uart.rst +++ b/docs/en/api-reference/peripherals/uart.rst @@ -401,6 +401,7 @@ API Reference ------------- .. include-build-file:: inc/uart.inc +.. include-build-file:: inc/uart_types.inc GPIO Lookup Macros diff --git a/docs/zh_CN/api-reference/peripherals/ledc.rst b/docs/zh_CN/api-reference/peripherals/ledc.rst index 5822d9d65..13a62dd0b 100644 --- a/docs/zh_CN/api-reference/peripherals/ledc.rst +++ b/docs/zh_CN/api-reference/peripherals/ledc.rst @@ -173,4 +173,5 @@ API 参考 ------------- .. include-build-file:: inc/ledc.inc +.. include-build-file:: inc/ledc_types.inc diff --git a/docs/zh_CN/api-reference/peripherals/timer.rst b/docs/zh_CN/api-reference/peripherals/timer.rst index f432cd8b5..b9ea490b7 100644 --- a/docs/zh_CN/api-reference/peripherals/timer.rst +++ b/docs/zh_CN/api-reference/peripherals/timer.rst @@ -105,3 +105,4 @@ API 参考 ------------- .. include-build-file:: inc/timer.inc +.. include-build-file:: inc/timer_types.inc