Merge branch 'master' into feature/btdm_gatt_api

docs/api/gpio.rst

@@ -4,20 +4,17 @@ GPIO
 Overview
 --------
 
-`Instructions`_
+The ESP32 chip features 40 physical GPIO pads. Some GPIO pads cannot be used or do not have the corresponding pin on the chip package(refer to technical reference manual ). Each pad can be used as a general purpose I/O or can be connected to an internal peripheral signal.
+Note that GPIO6-11 are usually used for SPI flash. GPIO34-39 can only be set as input mode.
 
 Application Example
 -------------------
 
-`Instructions`_
+GPIO output and input interrupt example: `examples/21_gpio <https://github.com/espressif/esp-idf/tree/master/examples/21_gpio>`_.
 
 API Reference
 -------------
 
-`Instructions`_
-
-.. _Instructions: template.html
-
 Header Files
 ^^^^^^^^^^^^
 
@@ -110,7 +107,8 @@ Macros
 Type Definitions
 ^^^^^^^^^^^^^^^^
 
-.. doxygentypedef:: gpio_event_callback
+.. doxygentypedef:: gpio_isr_t
+.. doxygentypedef:: gpio_isr_handle_t
 
 Enumerations
 ^^^^^^^^^^^^
@@ -122,6 +120,13 @@ Enumerations
 .. doxygenenum:: gpio_pulldown_t
 .. doxygenenum:: gpio_pull_mode_t
 
+Structures
+^^^^^^^^^^
+
+.. doxygenstruct:: gpio_config_t
+    :members:
+
+
 Functions
 ^^^^^^^^^
 
@@ -136,3 +141,12 @@ Functions
 .. doxygenfunction:: gpio_wakeup_enable
 .. doxygenfunction:: gpio_wakeup_disable
 .. doxygenfunction:: gpio_isr_register
+.. doxygenfunction:: gpio_pullup_en
+.. doxygenfunction:: gpio_pullup_dis
+.. doxygenfunction:: gpio_pulldown_en
+.. doxygenfunction:: gpio_pulldown_dis
+.. doxygenfunction:: gpio_install_isr_service
+.. doxygenfunction:: gpio_uninstall_isr_service
+.. doxygenfunction:: gpio_isr_handler_add
+.. doxygenfunction:: gpio_isr_handler_remove
+

docs/api/i2c.rst

@@ -0,0 +1,82 @@
+I2C
+===========
+
+Overview
+--------
+
+ESP32 has two I2C controllers which can be set as master mode or slave mode.
+
+Application Example
+-------------------
+
+I2C master and slave example: `examples/18_i2c <https://github.com/espressif/esp-idf/tree/master/examples/18_i2c>`_.
+
+API Reference
+-------------
+
+Header Files
+^^^^^^^^^^^^
+
+  * `driver/include/driver/i2c.h <https://github.com/espressif/esp-idf/blob/master/components/driver/include/driver/i2c.h>`_
+
+Macros
+^^^^^^
+
+.. doxygendefine:: I2C_APB_CLK_FREQ
+.. doxygendefine:: I2C_FIFO_LEN
+
+Type Definitions
+^^^^^^^^^^^^^^^^
+
+.. doxygentypedef:: i2c_cmd_handle_t
+
+Enumerations
+^^^^^^^^^^^^
+
+.. doxygenenum:: i2c_mode_t
+.. doxygenenum:: i2c_rw_t
+.. doxygenenum:: i2c_trans_mode_t
+.. doxygenenum:: i2c_opmode_t
+.. doxygenenum:: i2c_port_t
+.. doxygenenum:: i2c_addr_mode_t
+
+Structures
+^^^^^^^^^^
+
+.. doxygenstruct:: i2c_config_t
+    :members:
+
+
+Functions
+^^^^^^^^^
+
+.. doxygenfunction:: i2c_driver_install
+.. doxygenfunction:: i2c_driver_delete
+.. doxygenfunction:: i2c_param_config
+.. doxygenfunction:: i2c_reset_tx_fifo
+.. doxygenfunction:: i2c_reset_rx_fifo
+.. doxygenfunction:: i2c_isr_register
+.. doxygenfunction:: i2c_isr_free
+.. doxygenfunction:: i2c_set_pin
+.. doxygenfunction:: i2c_master_start
+.. doxygenfunction:: i2c_master_write_byte
+.. doxygenfunction:: i2c_master_write
+.. doxygenfunction:: i2c_master_read_byte
+.. doxygenfunction:: i2c_master_read
+.. doxygenfunction:: i2c_master_stop
+.. doxygenfunction:: i2c_master_cmd_begin
+.. doxygenfunction:: i2c_slave_write_buffer
+.. doxygenfunction:: i2c_slave_read
+.. doxygenfunction:: i2c_set_period
+.. doxygenfunction:: i2s_get_period
+.. doxygenfunction:: i2c_set_start_timing
+.. doxygenfunction:: i2c_get_start_timing
+.. doxygenfunction:: i2c_set_stop_timing
+.. doxygenfunction:: i2c_get_stop_timing
+.. doxygenfunction:: i2c_set_data_timing
+.. doxygenfunction:: i2c_get_data_timing
+.. doxygenfunction:: i2c_set_data_mode
+.. doxygenfunction:: i2c_get_data_mode
+.. doxygenfunction:: i2c_cmd_link_create
+.. doxygenfunction:: i2c_cmd_link_delete
+

docs/api/template.rst

@@ -40,10 +40,15 @@ Application Example
 
    *INSTRUCTIONS*
 
-   1. Provide one or more practical examples to demonstrate functionality of this API.
-   2. Break down the code into parts and describe functionality of each part.
-   3. Provide screenshots if applicable.
-
+   1. Prepare one or more practical examples to demonstrate functionality of this API.
+   2. Each example should follow pattern of projects located in ``esp-idf/examples/`` folder.
+   3. Place example in this folder complete with ``README.md`` file.
+   4. Provide overview of demonstrated functionality in ``README.md``.
+   5. With good overview reader should be able to understand what example does without opening the source code.
+   6. Depending on complexity of example, break down description of code into parts and provide overview of functionality of each part.
+   7. Include flow diagram and screenshots of application output if applicable.
+   8. Finally add in this section synopsis of each example together with link to respective folder in ``esp-idf/examples/``.
+  
 API Reference
 -------------
 

docs/api/uart.rst

@@ -94,5 +94,7 @@ Functions
 .. doxygenfunction:: uart_write_bytes_with_break
 .. doxygenfunction:: uart_read_bytes
 .. doxygenfunction:: uart_flush
-
+.. doxygenfunction:: uart_get_buffered_data_len
+.. doxygenfunction:: uart_disable_pattern_det_intr
+.. doxygenfunction:: uart_enable_pattern_det_intr