extern "C" {
#endif
-#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 */
-#define GPIO_SEL_3 (BIT(3)) /* Pin 3 selected */
-#define GPIO_SEL_4 (BIT(4)) /* Pin 4 selected */
-#define GPIO_SEL_5 (BIT(5)) /* Pin 5 selected */
-#define GPIO_SEL_6 (BIT(6)) /* Pin 6 selected */
-#define GPIO_SEL_7 (BIT(7)) /* Pin 7 selected */
-#define GPIO_SEL_8 (BIT(8)) /* Pin 8 selected */
-#define GPIO_SEL_9 (BIT(9)) /* Pin 9 selected */
-#define GPIO_SEL_10 (BIT(10)) /* Pin 10 selected */
-#define GPIO_SEL_11 (BIT(11)) /* Pin 11 selected */
-#define GPIO_SEL_12 (BIT(12)) /* Pin 12 selected */
-#define GPIO_SEL_13 (BIT(13)) /* Pin 13 selected */
-#define GPIO_SEL_14 (BIT(14)) /* Pin 14 selected */
-#define GPIO_SEL_15 (BIT(15)) /* Pin 15 selected */
-#define GPIO_SEL_16 (BIT(16)) /* Pin 16 selected */
-#define GPIO_SEL_17 (BIT(17)) /* Pin 17 selected */
-#define GPIO_SEL_18 (BIT(18)) /* Pin 18 selected */
-#define GPIO_SEL_19 (BIT(19)) /* Pin 19 selected */
-
-#define GPIO_SEL_21 (BIT(21)) /* Pin 21 selected */
-#define GPIO_SEL_22 (BIT(22)) /* Pin 22 selected */
-#define GPIO_SEL_23 (BIT(23)) /* Pin 23 selected */
-
-#define GPIO_SEL_25 (BIT(25)) /* Pin 25 selected */
-#define GPIO_SEL_26 (BIT(26)) /* Pin 26 selected */
-#define GPIO_SEL_27 (BIT(27)) /* Pin 27 selected */
-
-#define GPIO_SEL_32 ((uint64_t)(((uint64_t)1)<<32)) /* Pin 32 selected */
-#define GPIO_SEL_33 ((uint64_t)(((uint64_t)1)<<33)) /* Pin 33 selected */
-#define GPIO_SEL_34 ((uint64_t)(((uint64_t)1)<<34)) /* Pin 34 selected */
-#define GPIO_SEL_35 ((uint64_t)(((uint64_t)1)<<35)) /* Pin 35 selected */
-#define GPIO_SEL_36 ((uint64_t)(((uint64_t)1)<<36)) /* Pin 36 selected */
-#define GPIO_SEL_37 ((uint64_t)(((uint64_t)1)<<37)) /* Pin 37 selected */
-#define GPIO_SEL_38 ((uint64_t)(((uint64_t)1)<<38)) /* Pin 38 selected */
-#define GPIO_SEL_39 ((uint64_t)(((uint64_t)1)<<39)) /* Pin 39 selected */
+#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 */
+#define GPIO_SEL_3 (BIT(3)) /*!< Pin 3 selected */
+#define GPIO_SEL_4 (BIT(4)) /*!< Pin 4 selected */
+#define GPIO_SEL_5 (BIT(5)) /*!< Pin 5 selected */
+#define GPIO_SEL_6 (BIT(6)) /*!< Pin 6 selected */
+#define GPIO_SEL_7 (BIT(7)) /*!< Pin 7 selected */
+#define GPIO_SEL_8 (BIT(8)) /*!< Pin 8 selected */
+#define GPIO_SEL_9 (BIT(9)) /*!< Pin 9 selected */
+#define GPIO_SEL_10 (BIT(10)) /*!< Pin 10 selected */
+#define GPIO_SEL_11 (BIT(11)) /*!< Pin 11 selected */
+#define GPIO_SEL_12 (BIT(12)) /*!< Pin 12 selected */
+#define GPIO_SEL_13 (BIT(13)) /*!< Pin 13 selected */
+#define GPIO_SEL_14 (BIT(14)) /*!< Pin 14 selected */
+#define GPIO_SEL_15 (BIT(15)) /*!< Pin 15 selected */
+#define GPIO_SEL_16 (BIT(16)) /*!< Pin 16 selected */
+#define GPIO_SEL_17 (BIT(17)) /*!< Pin 17 selected */
+#define GPIO_SEL_18 (BIT(18)) /*!< Pin 18 selected */
+#define GPIO_SEL_19 (BIT(19)) /*!< Pin 19 selected */
+
+#define GPIO_SEL_21 (BIT(21)) /*!< Pin 21 selected */
+#define GPIO_SEL_22 (BIT(22)) /*!< Pin 22 selected */
+#define GPIO_SEL_23 (BIT(23)) /*!< Pin 23 selected */
+
+#define GPIO_SEL_25 (BIT(25)) /*!< Pin 25 selected */
+#define GPIO_SEL_26 (BIT(26)) /*!< Pin 26 selected */
+#define GPIO_SEL_27 (BIT(27)) /*!< Pin 27 selected */
+
+#define GPIO_SEL_32 ((uint64_t)(((uint64_t)1)<<32)) /*!< Pin 32 selected */
+#define GPIO_SEL_33 ((uint64_t)(((uint64_t)1)<<33)) /*!< Pin 33 selected */
+#define GPIO_SEL_34 ((uint64_t)(((uint64_t)1)<<34)) /*!< Pin 34 selected */
+#define GPIO_SEL_35 ((uint64_t)(((uint64_t)1)<<35)) /*!< Pin 35 selected */
+#define GPIO_SEL_36 ((uint64_t)(((uint64_t)1)<<36)) /*!< Pin 36 selected */
+#define GPIO_SEL_37 ((uint64_t)(((uint64_t)1)<<37)) /*!< Pin 37 selected */
+#define GPIO_SEL_38 ((uint64_t)(((uint64_t)1)<<38)) /*!< Pin 38 selected */
+#define GPIO_SEL_39 ((uint64_t)(((uint64_t)1)<<39)) /*!< Pin 39 selected */
#define GPIO_PIN_REG_0 PERIPHS_IO_MUX_GPIO0_U
#define GPIO_PIN_REG_1 PERIPHS_IO_MUX_U0TXD_U
#define GPIO_IS_VALID_OUTPUT_GPIO(gpio_num) ((GPIO_IS_VALID_GPIO(gpio_num)) && (gpio_num < 34)) //to decide whether it can be a valid GPIO number of output mode
typedef enum {
- GPIO_NUM_0 = 0,
- GPIO_NUM_1 = 1,
- GPIO_NUM_2 = 2,
- GPIO_NUM_3 = 3,
- GPIO_NUM_4 = 4,
- GPIO_NUM_5 = 5,
- GPIO_NUM_6 = 6,
- GPIO_NUM_7 = 7,
- GPIO_NUM_8 = 8,
- GPIO_NUM_9 = 9,
- GPIO_NUM_10 = 10,
- GPIO_NUM_11 = 11,
- GPIO_NUM_12 = 12,
- GPIO_NUM_13 = 13,
- GPIO_NUM_14 = 14,
- GPIO_NUM_15 = 15,
- GPIO_NUM_16 = 16,
- GPIO_NUM_17 = 17,
- GPIO_NUM_18 = 18,
- GPIO_NUM_19 = 19,
-
- GPIO_NUM_21 = 21,
- GPIO_NUM_22 = 22,
- GPIO_NUM_23 = 23,
-
- GPIO_NUM_25 = 25,
- GPIO_NUM_26 = 26,
- GPIO_NUM_27 = 27,
-
- GPIO_NUM_32 = 32,
- GPIO_NUM_33 = 33,
- GPIO_NUM_34 = 34, /*input mode only */
- GPIO_NUM_35 = 35, /*input mode only */
- GPIO_NUM_36 = 36, /*input mode only */
- GPIO_NUM_37 = 37, /*input mode only */
- GPIO_NUM_38 = 38, /*input mode only */
- GPIO_NUM_39 = 39, /*input mode only */
+ GPIO_NUM_0 = 0, /*!< GPIO0, input and output */
+ GPIO_NUM_1 = 1, /*!< GPIO1, input and output */
+ GPIO_NUM_2 = 2, /*!< GPIO2, input and output */
+ GPIO_NUM_3 = 3, /*!< GPIO3, input and output */
+ GPIO_NUM_4 = 4, /*!< GPIO4, input and output */
+ GPIO_NUM_5 = 5, /*!< GPIO5, input and output */
+ GPIO_NUM_6 = 6, /*!< GPIO6, input and output */
+ GPIO_NUM_7 = 7, /*!< GPIO7, input and output */
+ GPIO_NUM_8 = 8, /*!< GPIO8, input and output */
+ GPIO_NUM_9 = 9, /*!< GPIO9, input and output */
+ GPIO_NUM_10 = 10, /*!< GPIO10, input and output */
+ GPIO_NUM_11 = 11, /*!< GPIO11, input and output */
+ GPIO_NUM_12 = 12, /*!< GPIO12, input and output */
+ GPIO_NUM_13 = 13, /*!< GPIO13, input and output */
+ GPIO_NUM_14 = 14, /*!< GPIO14, input and output */
+ GPIO_NUM_15 = 15, /*!< GPIO15, input and output */
+ GPIO_NUM_16 = 16, /*!< GPIO16, input and output */
+ GPIO_NUM_17 = 17, /*!< GPIO17, input and output */
+ GPIO_NUM_18 = 18, /*!< GPIO18, input and output */
+ GPIO_NUM_19 = 19, /*!< GPIO19, input and output */
+
+ GPIO_NUM_21 = 21, /*!< GPIO21, input and output */
+ GPIO_NUM_22 = 22, /*!< GPIO22, input and output */
+ GPIO_NUM_23 = 23, /*!< GPIO23, input and output */
+
+ GPIO_NUM_25 = 25, /*!< GPIO25, input and output */
+ GPIO_NUM_26 = 26, /*!< GPIO26, input and output */
+ GPIO_NUM_27 = 27, /*!< GPIO27, input and output */
+
+ GPIO_NUM_32 = 32, /*!< GPIO32, input and output */
+ GPIO_NUM_33 = 33, /*!< GPIO32, input and output */
+ GPIO_NUM_34 = 34, /*!< GPIO34, input mode only */
+ GPIO_NUM_35 = 35, /*!< GPIO35, input mode only */
+ GPIO_NUM_36 = 36, /*!< GPIO36, input mode only */
+ GPIO_NUM_37 = 37, /*!< GPIO37, input mode only */
+ GPIO_NUM_38 = 38, /*!< GPIO38, input mode only */
+ GPIO_NUM_39 = 39, /*!< GPIO39, input mode only */
} gpio_num_t;
typedef enum {
- GPIO_INTR_DISABLE = 0, /*!< disable GPIO interrupt */
+ GPIO_INTR_DISABLE = 0, /*!< Disable GPIO interrupt */
GPIO_INTR_POSEDGE = 1, /*!< GPIO interrupt type : rising edge */
GPIO_INTR_NEGEDGE = 2, /*!< GPIO interrupt type : falling edge */
GPIO_INTR_ANYEDGE = 3, /*!< GPIO interrupt type : both rising and falling edge */
} gpio_mode_t;
typedef enum {
- GPIO_PULLUP_DISABLE = 0x0, /*!< disable GPIO pull-up resistor */
- GPIO_PULLUP_ENABLE = 0x1, /*!< enable GPIO pull-up resistor */
+ GPIO_PULLUP_DISABLE = 0x0, /*!< Disable GPIO pull-up resistor */
+ GPIO_PULLUP_ENABLE = 0x1, /*!< Enable GPIO pull-up resistor */
} gpio_pullup_t;
typedef enum {
- GPIO_PULLDOWN_DISABLE = 0x0, /*!< disable GPIO pull-down resistor */
- GPIO_PULLDOWN_ENABLE = 0x1, /*!< enable GPIO pull-down resistor */
+ GPIO_PULLDOWN_DISABLE = 0x0, /*!< Disable GPIO pull-down resistor */
+ GPIO_PULLDOWN_ENABLE = 0x1, /*!< Enable GPIO pull-down resistor */
} gpio_pulldown_t;
typedef struct {
gpio_int_type_t intr_type; /*!< GPIO interrupt type */
} gpio_config_t;
-typedef enum {
- GPIO_LOW_LEVEL = 0,
- GPIO_HIGH_LEVEL = 1,
- GPIO_LEVEL_ERR,
-} gpio_level_t;
-
typedef enum {
GPIO_PULLUP_ONLY, /*!< Pad pull up */
GPIO_PULLDOWN_ONLY, /*!< Pad pull down */
typedef void (*gpio_event_callback)(gpio_num_t gpio_intr_num);
-/** \defgroup Driver_APIs Driver APIs
- * @brief Driver APIs
- */
-
-/** @addtogroup Driver_APIs
- * @{
- */
-
-/** \defgroup GPIO_Driver_APIs GPIO Driver APIs
- * @brief GPIO APIs
- */
-
-/** @addtogroup GPIO_Driver_APIs
- * @{
- */
-
/**
- * @brief GPIO common configuration
+ * @brief GPIO common configuration
*
- * Use this Function ,Configure GPIO's Mode,pull-up,PullDown,IntrType
+ * Configure GPIO's Mode,pull-up,PullDown,IntrType
*
- * @param[in] pGPIOConfig
- * pGPIOConfig.pin_bit_mask : Configure GPIO pins bits,set this parameter with bit mask.
- * If you want to configure GPIO34 and GPIO16, pin_bit_mask=GPIO_Pin_16|GPIO_Pin_34;
- * pGPIOConfig.mode : Configure GPIO mode,such as output ,input...
- * pGPIOConfig.pull_up_en : Enable or Disable pull-up
- * pGPIOConfig.pull_down_en : Enable or Disable pull-down
- * pGPIOConfig.intr_type : Configure GPIO interrupt trigger type
- * @return ESP_OK: success ;
- * ESP_ERR_INVALID_ARG: parameter error
- * ESP_FAIL : GPIO error
+ * @param pGPIOConfig Pointer to GPIO configure struct
+ *
+ * @return
+ * - ESP_OK success
+ * - ESP_ERR_INVALID_ARG Parameter error
*
*/
esp_err_t gpio_config(gpio_config_t *pGPIOConfig);
/**
- * @brief GPIO set interrupt trigger type
+ * @brief GPIO set interrupt trigger type
*
- * @param[in] gpio_num : GPIO number.
- * If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
- * @param[in] intr_type: interrupt type, select from gpio_int_type_t
+ * @param gpio_num GPIO number. If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
+ * @param intr_type Interrupt type, select from gpio_int_type_t
*
- * @return ESP_OK : success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*
*/
esp_err_t gpio_set_intr_type(gpio_num_t gpio_num, gpio_int_type_t intr_type);
/**
- * @brief enable GPIO module interrupt signal
+ * @brief Enable GPIO module interrupt signal
*
- * @param[in] gpio_num : GPIO number.
- * If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
+ * @param gpio_num GPIO number. If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
*
- * @return ESP_OK : success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*
*/
esp_err_t gpio_intr_enable(gpio_num_t gpio_num);
/**
- * @brief disable GPIO module interrupt signal
+ * @brief Disable GPIO module interrupt signal
*
- * @param[in] gpio_num : GPIO number.
- * If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
+ * @param gpio_num GPIO number. If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
*
- * @return ESP_OK : success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK success
+ * - ESP_ERR_INVALID_ARG Parameter error
*
*/
esp_err_t gpio_intr_disable(gpio_num_t gpio_num);
/**
- * @brief GPIO set output level
+ * @brief GPIO set output level
*
- * @param[in] gpio_num : GPIO number.
- * If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
- * @param[in] level : Output level. 0: low ; 1: high
+ * @param gpio_num GPIO number. If you want to set output level of GPIO16, gpio_num should be GPIO_NUM_16 (16);
+ * @param level Output level. 0: low ; 1: high
*
- * @return ESP_OK : success
- * ESP_FAIL : GPIO error
+ * @return
+ * - ESP_OK Success
+ * - GPIO_IS_VALID_GPIO GPIO number error
*
*/
esp_err_t gpio_set_level(gpio_num_t gpio_num, uint32_t level);
/**
- * @brief GPIO get input level
+ * @brief GPIO get input level
*
- * @param[in] gpio_num : GPIO number.
- * If you want to get level of pin GPIO16, gpio_num should be GPIO_NUM_16 (16);
+ * @param gpio_num GPIO number. If you want to get level of pin GPIO16, gpio_num should be GPIO_NUM_16 (16);
*
- * @return 0 : the GPIO input level is 0
- * 1 : the GPIO input level is 1
+ * @return
+ * - 0 the GPIO input level is 0
+ * - 1 the GPIO input level is 1
*
*/
int gpio_get_level(gpio_num_t gpio_num);
/**
- * @brief GPIO set direction
+ * @brief GPIO set direction
*
* Configure GPIO direction,such as output_only,input_only,output_and_input
*
- * @param[in] gpio_num : Configure GPIO pins number,it should be GPIO number.
- * If you want to set direction of GPIO16, gpio_num should be GPIO_NUM_16 (16);
- * @param[in] mode : Configure GPIO direction,such as output_only,input_only,...
+ * @param gpio_num Configure GPIO pins number, it should be GPIO number. If you want to set direction of GPIO16, gpio_num should be GPIO_NUM_16 (16);
+ * @param mode GPIO direction
*
- * @return ESP_OK : success
- * ESP_ERR_INVALID_ARG : fail
- * ESP_FAIL : GPIO error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG GPIO error
*
*/
esp_err_t gpio_set_direction(gpio_num_t gpio_num, gpio_mode_t mode);
/**
- * @brief GPIO set pull
+ * @brief GPIO set pull
*
* User this Function,configure GPIO pull mode,such as pull-up,pull-down
*
- * @param[in] gpio_num : Configure GPIO pins number,it should be GPIO number.
- * If you want to set pull up or down mode for GPIO16,gpio_num should be GPIO_NUM_16 (16);
- * @param[in] pull : Configure GPIO pull up/down mode,such as pullup_only,pulldown_only,pullup_and_pulldown,...
+ * @param gpio_num GPIO number. If you want to set pull up or down mode for GPIO16,gpio_num should be GPIO_NUM_16 (16);
+ * @param pull GPIO pull up/down mode.
*
- * @return ESP_OK : success
- * ESP_ERR_INVALID_ARG : fail
- * ESP_FAIL : GPIO error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG : Parameter error
*
*/
esp_err_t gpio_set_pull_mode(gpio_num_t gpio_num, gpio_pull_mode_t pull);
/**
- * @brief enable GPIO wake-up function.
+ * @brief enable GPIO wake-up function.
*
- * @param gpio_num : GPIO number.
+ * @param gpio_num GPIO number.
*
- * @param intr_type : only GPIO_INTR_LOLEVEL\GPIO_INTR_HILEVEL can be used
+ * @param intr_type GPIO wake-up type. Only GPIO_INTR_LOLEVEL\GPIO_INTR_HILEVEL can be used
*
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*/
esp_err_t gpio_wakeup_enable(gpio_num_t gpio_num, gpio_int_type_t intr_type);
/**
- * @brief disable GPIO wake-up function.
+ * @brief Disable GPIO wake-up function.
*
- * @param gpio_num: GPIO number
+ * @param gpio_num GPIO number
*
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*/
esp_err_t gpio_wakeup_disable(gpio_num_t gpio_num);
/**
* @brief register GPIO interrupt handler, the handler is an ISR.
* The handler will be attached to the same CPU core that this function is running on.
+ * @note
* Users should know that which CPU is running and then pick a INUM that is not used by system.
* We can find the information of INUM and interrupt level in soc.h.
- * TODO: to move INUM options to menu_config
- * @param gpio_intr_num : GPIO interrupt number,check the info in soc.h, and please see the core-isa.h for more details
- * @param (*fn)(void* ) : interrupt handler function.
- * Note that the handler function MUST be defined with attribution of "IRAM_ATTR".
- * @param arg : parameter for handler function
- *
- * @return ESP_OK : success ;
- * ESP_FAIL: gpio error
+ *
+ * @param gpio_intr_num GPIO interrupt number,check the info in soc.h, and please see the core-isa.h for more details
+ * @param fn Interrupt handler function.
+ *
+ * @note
+ * Note that the handler function MUST be defined with attribution of "IRAM_ATTR".
+ *
+ * @param arg Parameter for handler function
+ *
+ * @return
+ * - ESP_OK Success ;
+ * - ESP_ERR_INVALID_ARG GPIO error
*/
esp_err_t gpio_isr_register(uint32_t gpio_intr_num, void (*fn)(void*), void * arg);
/**
* *************** ATTENTION ********************/
/**
- *
- * Each GPIO has its own separate configuration register, so we do not use
- * a lock to serialize access to them. This works under the assumption that
- * no situation will occur where two tasks try to configure the same GPIO
- * pin simultaneously. It is up to the application developer to guarantee this.
+ *@attention
+ * Each GPIO has its own separate configuration register, so we do not use
+ * a lock to serialize access to them. This works under the assumption that
+ * no situation will occur where two tasks try to configure the same GPIO
+ * pin simultaneously. It is up to the application developer to guarantee this.
*/
-
-/*----------EXAMPLE TO CONIFGURE GPIO AS OUTPUT ------------ */
-/* gpio_config_t io_conf;
+/**
+ *----------EXAMPLE TO CONIFGURE GPIO AS OUTPUT ------------ *
+ * @code{c}
+ * gpio_config_t io_conf;
* io_conf.intr_type = GPIO_INTR_DISABLE; //disable interrupt
* io_conf.mode = GPIO_MODE_OUTPUT; //set as output mode
* io_conf.pin_bit_mask = GPIO_SEL_18 | GPIO_SEL_19; //bit mask of the pins that you want to set,e.g.GPIO18/19
* io_conf.pull_down_en = 0; //disable pull-down mode
* io_conf.pull_up_en = 0; //disable pull-up mode
* gpio_config(&io_conf); //configure GPIO with the given settings
+ * @endcode
**/
-/*----------EXAMPLE TO CONIFGURE GPIO AS OUTPUT ------------ */
-/* io_conf.intr_type = GPIO_INTR_POSEDGE; //set posedge interrupt
+
+/**
+ *----------EXAMPLE TO CONIFGURE GPIO AS OUTPUT ------------ *
+ * @code{c}
+ * io_conf.intr_type = GPIO_INTR_POSEDGE; //set posedge interrupt
* io_conf.mode = GPIO_MODE_INPUT; //set as input
* io_conf.pin_bit_mask = GPIO_SEL_4 | GPIO_SEL_5; //bit mask of the pins that you want to set, e.g.,GPIO4/5
* io_conf.pull_down_en = 0; //disable pull-down mode
* io_conf.pull_up_en = 1; //enable pull-up mode
* gpio_config(&io_conf); //configure GPIO with the given settings
- *----------EXAMPLE TO SET ISR HANDLER ----------------------*/
-/* gpio_isr_register(18,gpio_intr_test,NULL); //hook the isr handler for GPIO interrupt
- * //the first parameter is INUM, you can pick one form interrupt level 1/2 which is not used by the system.
- * //NOTE1:user should arrange the INUMs that used, better not to use a same INUM for different interrupt.
- * //NOTE2:do not pick the INUM that already occupied by the system.
- * //NOTE3:refer to soc.h to check which INUMs that can be used.
- *-------------EXAMPLE OF HANDLER FUNCTION-------------------*/
-/*#include "esp_attr.h"
- * void IRAM_ATTR gpio_intr_test(void* arg)
- *{
- * //GPIO intr process
- * ets_printf("in gpio_intr\n");
- * uint32_t gpio_num = 0;
- * uint32_t gpio_intr_status = READ_PERI_REG(GPIO_STATUS_REG); //read status to get interrupt status for GPIO0-31
- * uint32_t gpio_intr_status_h = READ_PERI_REG(GPIO_STATUS1_REG);//read status1 to get interrupt status for GPIO32-39
- * SET_PERI_REG_MASK(GPIO_STATUS_W1TC_REG, gpio_intr_status); //Clear intr for gpio0-gpio31
- * SET_PERI_REG_MASK(GPIO_STATUS1_W1TC_REG, gpio_intr_status_h); //Clear intr for gpio32-39
- * do {
- * if(gpio_num < 32) {
- * if(gpio_intr_status & BIT(gpio_num)) { //gpio0-gpio31
- * ets_printf("Intr GPIO%d ,val: %d\n",gpio_num,gpio_get_level(gpio_num));
- * //This is an isr handler, you should post an event to process it in RTOS queue.
- * }
- * } else {
- * if(gpio_intr_status_h & BIT(gpio_num - 32)) {
- * ets_printf("Intr GPIO%d, val : %d\n",gpio_num,gpio_get_level(gpio_num));
- * //This is an isr handler, you should post an event to process it in RTOS queue.
- * }
- * }
- * } while(++gpio_num < GPIO_PIN_COUNT);
- *}
- *----EXAMPLE OF I2C CONFIG AND PICK SIGNAL FOR IO MATRIX---*/
-/* gpio_config_t io_conf;
- * io_conf.intr_type = GPIO_INTR_DISABLE; //disable interrupt
- * io_conf.mode = GPIO_MODE_INPUT_OUTPUT_OD; //set as output mode
- * io_conf.pin_bit_mask = GPIO_SEL_21 | GPIO_SEL_22; //bit mask of the pins that you want to set,e.g.GPIO21/22
- * io_conf.pull_down_en = 0; //disable pull-down mode
- * io_conf.pull_up_en = 1; //enable pull-up mode
- * gpio_config(&io_conf); //configure GPIO with the given settings
- * gpio_matrix_out(21, EXT_I2C_SCL_O_IDX, 0, 0); //set output signal for io_matrix
- * gpio_matrix_out(22, EXT_I2C_SDA_O_IDX, 0, 0); //set output signal for io_matrix
- * gpio_matrix_in( 22, EXT_I2C_SDA_I_IDX, 0); //set input signal for io_matrix
- *
+ * @endcode
*/
-
/**
- * @}
+ *----------EXAMPLE TO SET ISR HANDLER ----------------------
+ * @code{c}
+ * //the first parameter is INUM, you can pick one form interrupt level 1/2 which is not used by the system.
+ * gpio_isr_register(18,gpio_intr_test,NULL); //hook the isr handler for GPIO interrupt
+ * @endcode
+ * @note
+ * 1. user should arrange the INUMs that used, better not to use a same INUM for different interrupt.
+ * 2. do not pick the INUM that already occupied by the system.
+ * 3. refer to soc.h to check which INUMs that can be used.
+ */
+/**
+ *-------------EXAMPLE OF HANDLER FUNCTION-------------------*
+ * @code{c}
+ * #include "esp_attr.h"
+ * void IRAM_ATTR gpio_intr_test(void* arg)
+ * {
+ * //GPIO intr process
+ * ets_printf("in gpio_intr\n");
+ * uint32_t gpio_num = 0;
+ * uint32_t gpio_intr_status = READ_PERI_REG(GPIO_STATUS_REG); //read status to get interrupt status for GPIO0-31
+ * uint32_t gpio_intr_status_h = READ_PERI_REG(GPIO_STATUS1_REG);//read status1 to get interrupt status for GPIO32-39
+ * SET_PERI_REG_MASK(GPIO_STATUS_W1TC_REG, gpio_intr_status); //Clear intr for gpio0-gpio31
+ * SET_PERI_REG_MASK(GPIO_STATUS1_W1TC_REG, gpio_intr_status_h); //Clear intr for gpio32-39
+ * do {
+ * if(gpio_num < 32) {
+ * if(gpio_intr_status & BIT(gpio_num)) { //gpio0-gpio31
+ * ets_printf("Intr GPIO%d ,val: %d\n",gpio_num,gpio_get_level(gpio_num));
+ * //This is an isr handler, you should post an event to process it in RTOS queue.
+ * }
+ * } else {
+ * if(gpio_intr_status_h & BIT(gpio_num - 32)) {
+ * ets_printf("Intr GPIO%d, val : %d\n",gpio_num,gpio_get_level(gpio_num));
+ * //This is an isr handler, you should post an event to process it in RTOS queue.
+ * }
+ * }
+ * } while(++gpio_num < GPIO_PIN_COUNT);
+ * }
+ * @endcode
*/
/**
- * @}
+ *----EXAMPLE OF I2C CONFIG AND PICK SIGNAL FOR IO MATRIX---*
+ * @code{c}
+ * gpio_config_t io_conf;
+ * io_conf.intr_type = GPIO_INTR_DISABLE; //disable interrupt
+ * io_conf.mode = GPIO_MODE_INPUT_OUTPUT_OD; //set as output mode
+ * io_conf.pin_bit_mask = GPIO_SEL_21 | GPIO_SEL_22; //bit mask of the pins that you want to set,e.g.GPIO21/22
+ * io_conf.pull_down_en = 0; //disable pull-down mode
+ * io_conf.pull_up_en = 1; //enable pull-up mode
+ * gpio_config(&io_conf); //configure GPIO with the given settings
+ * gpio_matrix_out(21, EXT_I2C_SCL_O_IDX, 0, 0); //set output signal for io_matrix
+ * gpio_matrix_out(22, EXT_I2C_SDA_O_IDX, 0, 0); //set output signal for io_matrix
+ * gpio_matrix_in( 22, EXT_I2C_SDA_I_IDX, 0); //set input signal for io_matrix
+ * @endcode
+ *
*/
#ifdef __cplusplus
#define LEDC_REF_CLK_HZ (1*1000000)
typedef enum {
- LEDC_HIGH_SPEED_MODE = 0, /*LEDC high speed speed_mode */
+ LEDC_HIGH_SPEED_MODE = 0, /*!< LEDC high speed speed_mode */
//in this version, we only support high speed speed_mode. We will access low speed speed_mode later
- //LEDC_LOW_SPEED_MODE, /*LEDC low speed speed_mode */
- LEDC_SPEED_MODE_MAX,
+ //LEDC_LOW_SPEED_MODE, /*!< LEDC low speed speed_mode */
+ LEDC_SPEED_MODE_MAX, /*!< LEDC speed limit */
} ledc_mode_t;
typedef enum {
- LEDC_INTR_DISABLE = 0, /*Disable LEDC interrupt */
- LEDC_INTR_FADE_END, /*Enable LEDC interrupt */
+ LEDC_INTR_DISABLE = 0, /*!< Disable LEDC interrupt */
+ LEDC_INTR_FADE_END, /*!< Enable LEDC interrupt */
} ledc_intr_type_t;
typedef enum {
- LEDC_DUTY_DIR_DECREASE = 0, /*LEDC duty decrease direction */
- LEDC_DUTY_DIR_INCREASE = 1, /*LEDC duty increase direction */
+ LEDC_DUTY_DIR_DECREASE = 0, /*!< LEDC duty decrease direction */
+ LEDC_DUTY_DIR_INCREASE = 1, /*!< LEDC duty increase direction */
} ledc_duty_direction_t;
typedef enum {
- LEDC_REF_TICK = 0, /*LEDC timer clock divided from reference tick(1Mhz) */
- LEDC_APB_CLK, /*LEDC timer clock divided from APB clock(80Mhz)*/
+ LEDC_REF_TICK = 0, /*!< LEDC timer clock divided from reference tick(1Mhz) */
+ LEDC_APB_CLK, /*!< LEDC timer clock divided from APB clock(80Mhz)*/
} ledc_clk_src_t;
typedef enum {
- LEDC_TIMER_0 = 0, /*LEDC source timer TIMER0 */
- LEDC_TIMER_1, /*LEDC source timer TIMER1 */
- LEDC_TIMER_2, /*LEDC source timer TIMER2 */
- LEDC_TIMER_3, /*LEDC source timer TIMER3 */
+ LEDC_TIMER_0 = 0, /*!< LEDC source timer TIMER0 */
+ LEDC_TIMER_1, /*!< LEDC source timer TIMER1 */
+ LEDC_TIMER_2, /*!< LEDC source timer TIMER2 */
+ LEDC_TIMER_3, /*!< LEDC source timer TIMER3 */
} ledc_timer_t;
typedef enum {
- LEDC_CHANNEL_0 = 0, /*LEDC channel 0 */
- LEDC_CHANNEL_1, /*LEDC channel 1 */
- LEDC_CHANNEL_2, /*LEDC channel 2 */
- LEDC_CHANNEL_3, /*LEDC channel 3 */
- LEDC_CHANNEL_4, /*LEDC channel 4 */
- LEDC_CHANNEL_5, /*LEDC channel 5 */
- LEDC_CHANNEL_6, /*LEDC channel 6 */
- LEDC_CHANNEL_7, /*LEDC channel 7 */
+ LEDC_CHANNEL_0 = 0, /*!< LEDC channel 0 */
+ LEDC_CHANNEL_1, /*!< LEDC channel 1 */
+ LEDC_CHANNEL_2, /*!< LEDC channel 2 */
+ LEDC_CHANNEL_3, /*!< LEDC channel 3 */
+ LEDC_CHANNEL_4, /*!< LEDC channel 4 */
+ LEDC_CHANNEL_5, /*!< LEDC channel 5 */
+ LEDC_CHANNEL_6, /*!< LEDC channel 6 */
+ LEDC_CHANNEL_7, /*!< LEDC channel 7 */
} ledc_channel_t;
typedef enum {
- LEDC_TIMER_10_BIT = 10, /*LEDC PWM depth 10Bit */
- LEDC_TIMER_11_BIT = 11, /*LEDC PWM depth 11Bit */
- LEDC_TIMER_12_BIT = 12, /*LEDC PWM depth 12Bit */
- LEDC_TIMER_13_BIT = 13, /*LEDC PWM depth 13Bit */
- LEDC_TIMER_14_BIT = 14, /*LEDC PWM depth 14Bit */
- LEDC_TIMER_15_BIT = 15, /*LEDC PWM depth 15Bit */
+ LEDC_TIMER_10_BIT = 10, /*!< LEDC PWM depth 10Bit */
+ LEDC_TIMER_11_BIT = 11, /*!< LEDC PWM depth 11Bit */
+ LEDC_TIMER_12_BIT = 12, /*!< LEDC PWM depth 12Bit */
+ LEDC_TIMER_13_BIT = 13, /*!< LEDC PWM depth 13Bit */
+ LEDC_TIMER_14_BIT = 14, /*!< LEDC PWM depth 14Bit */
+ LEDC_TIMER_15_BIT = 15, /*!< LEDC PWM depth 15Bit */
} ledc_timer_bit_t;
typedef struct {
- int gpio_num; /*the LEDC output gpio_num, if you want to use gpio16, gpio_num = 16*/
- ledc_mode_t speed_mode; /*LEDC speed speed_mode, high-speed mode or low-speed mode*/
- ledc_channel_t channel; /*LEDC channel(0 - 7)*/
- ledc_intr_type_t intr_type; /*configure interrupt, Fade interrupt enable or Fade interrupt disable*/
- ledc_timer_t timer_sel; /*Select the timer source of channel (0 - 3)*/
- uint32_t duty; /*LEDC channel duty, the duty range is [0, (2**bit_num) - 1], */
+ int gpio_num; /*!< the LEDC output gpio_num, if you want to use gpio16, gpio_num = 16*/
+ ledc_mode_t speed_mode; /*!< LEDC speed speed_mode, high-speed mode or low-speed mode*/
+ ledc_channel_t channel; /*!< LEDC channel(0 - 7)*/
+ ledc_intr_type_t intr_type; /*!< configure interrupt, Fade interrupt enable or Fade interrupt disable*/
+ ledc_timer_t timer_sel; /*!< Select the timer source of channel (0 - 3)*/
+ uint32_t duty; /*!< LEDC channel duty, the duty range is [0, (2**bit_num) - 1], */
} ledc_channel_config_t;
typedef struct {
- ledc_mode_t speed_mode; /*LEDC speed speed_mode, high-speed mode or low-speed mode*/
- ledc_timer_bit_t bit_num; /*LEDC channel duty depth*/
- ledc_timer_t timer_num; /*The timer source of channel (0 - 3)*/
- uint32_t freq_hz; /*LEDC timer frequency(Hz)*/
+ ledc_mode_t speed_mode; /*!< LEDC speed speed_mode, high-speed mode or low-speed mode*/
+ ledc_timer_bit_t bit_num; /*!< LEDC channel duty depth*/
+ ledc_timer_t timer_num; /*!< The timer source of channel (0 - 3)*/
+ uint32_t freq_hz; /*!< LEDC timer frequency(Hz)*/
} ledc_timer_config_t;
*
* User this Function, configure LEDC channel with the given channel/output gpio_num/interrupt/source timer/frequency(Hz)/LEDC depth
*
- * @param[in] ledc_channel_config_t
- * ledc_channel_config_t.speed_mode : LEDC speed speed_mode
- * ledc_channel_config_t.gpio_num : LEDC output gpio_num, if you want to use gpio16, ledc_channel_config_t.gpio_num = 16
- * ledc_channel_config_t.channel : LEDC channel(0 - 7)
- * ledc_channel_config_t.intr_type : configure interrupt, Fade interrupt enable or Fade interrupt disable
- * ledc_channel_config_t.timer_sel : Select the timer source of channel (0 - 3), high speed channel must bind with high speed timer.
- * ledc_channel_config_t.duty : LEDC channel duty, the duty range is [0, (2**timer_bit_num) - 1],
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @param ledc_conf Pointer of LEDC channel configure struct
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*
*/
esp_err_t ledc_channel_config(ledc_channel_config_t* ledc_conf);
*
* User this Function, configure LEDC timer with the given source timer/frequency(Hz)/bit_num
*
- * @param[in] ledc_timer_config_t
- * ledc_timer_config_t.speed_mode : LEDC speed speed_mode
- * ledc_timer_config_t.timer_num : Select the timer source of channel (0 - 3)
- * ledc_timer_config_t.freq_hz : LEDC channel frequency(Hz),
- * ledc_timer_config_t.bit_num : LEDC channel duty depth
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
- * ESP_FAIL: Can not find a proper pre-divider number base on the given frequency and the current bit_num.
+ * @param timer_conf Pointer of LEDC timer configure struct
+ *
+ *
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
+ * - ESP_FAIL Can not find a proper pre-divider number base on the given frequency and the current bit_num.
*
*/
esp_err_t ledc_timer_config(ledc_timer_config_t* timer_conf);
* Call this function to activate the LEDC updated parameters.
* After ledc_set_duty, ledc_set_fade, we need to call this function to update the settings.
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] channel : LEDC channel(0-7), select from ledc_channel_t
+ * @param channel LEDC channel(0-7), select from ledc_channel_t
*
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*
*/
esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel);
*
* Disable LEDC output, and set idle level
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] channel : LEDC channel(0-7), select from ledc_channel_t
+ * @param channel LEDC channel(0-7), select from ledc_channel_t
*
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*/
esp_err_t ledc_stop(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t idle_level);
*
* Set LEDC frequency(Hz)
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] timer_num : LEDC timer index(0-3), select from ledc_timer_t
+ * @param timer_num LEDC timer index(0-3), select from ledc_timer_t
*
- * @param[in] freq_hz : set the LEDC frequency
+ * @param freq_hz Set the LEDC frequency
*
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
- * ESP_FAIL: Can not find a proper pre-divider number base on the given frequency and the current bit_num.
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
+ * - ESP_FAIL Can not find a proper pre-divider number base on the given frequency and the current bit_num.
*/
esp_err_t ledc_set_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num, uint32_t freq_hz);
/**
* @brief LEDC get channel frequency(Hz)
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] timer_num : LEDC timer index(0-3), select from ledc_timer_t
+ * @param timer_num LEDC timer index(0-3), select from ledc_timer_t
*
- * @return 0 : error
- * others : current LEDC frequency
+ * @return
+ * - 0 error
+ * - Others Current LEDC frequency
*
*/
uint32_t ledc_get_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num);
*
* Set LEDC duty, After the function calls the ledc_update_duty function, the function can take effect.
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] channel : LEDC channel(0-7), select from ledc_channel_t
+ * @param channel LEDC channel(0-7), select from ledc_channel_t
*
- * @param[in] duty : set the LEDC duty, the duty range is [0, (2**bit_num) - 1]
+ * @param duty Set the LEDC duty, the duty range is [0, (2**bit_num) - 1]
*
- * @return ESP_OK: success
- * ESP_ERR_INVALID_ARG: parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*/
esp_err_t ledc_set_duty(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty);
/**
* @brief LEDC get duty
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] channel : LEDC channel(0-7), select from ledc_channel_t
+ * @param channel LEDC channel(0-7), select from ledc_channel_t
*
*
- * @return -1: parameter error
- * other value: current LEDC duty
+ * @return
+ * - (-1) parameter error
+ * - Others Current LEDC duty
*
*/
int ledc_get_duty(ledc_mode_t speed_mode, ledc_channel_t channel);
*
* Set LEDC gradient, After the function calls the ledc_update_duty function, the function can take effect.
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] channel : LEDC channel(0-7), select from ledc_channel_t
+ * @param channel LEDC channel(0-7), select from ledc_channel_t
*
- * @param[in] duty : set the start of the gradient duty, the duty range is [0, (2**bit_num) - 1]
+ * @param duty Set the start of the gradient duty, the duty range is [0, (2**bit_num) - 1]
*
- * @param[in] gradule_direction : set the direction of the gradient
+ * @param gradule_direction Set the direction of the gradient
*
- * @param[in] step_num : set the number of the gradient
+ * @param step_num Set the number of the gradient
*
- * @param[in] duty_cyle_num : set how many LEDC tick each time the gradient lasts
+ * @param duty_cyle_num Set how many LEDC tick each time the gradient lasts
*
- * @param[in] duty_scale : set gradient change amplitude
+ * @param duty_scale Set gradient change amplitude
*
- * @return ESP_OK : success
- * ESP_ERR_INVALID_ARG : parameter error
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Parameter error
*/
esp_err_t ledc_set_fade(ledc_mode_t speed_mode, uint32_t channel, uint32_t duty, ledc_duty_direction_t gradule_direction,
uint32_t step_num, uint32_t duty_cyle_num, uint32_t duty_scale);
/**
* @brief register LEDC interrupt handler, the handler is an ISR.
* The handler will be attached to the same CPU core that this function is running on.
- * Users should know that which CPU is running and then pick a INUM that is not used by system.
- * We can find the information of INUM and interrupt level in soc.h.
- * TODO: to move INUM options to menu_config
- * @param[in] uint32_t ledc_intr_num : LEDC interrupt number, check the info in soc.h, and please see the core-isa.h for more details
- * @param[in] void (* fn)(void* ) : interrupt handler function.
- * Note that the handler function MUST be defined with attribution of "IRAM_ATTR".
- * @param[in] void * arg : parameter for handler function
- *
- * @return ESP_OK : success ;
- * ESP_ERR_INVALID_ARG : function ptr error.
+ * @note
+ * Users should know that which CPU is running and then pick a INUM that is not used by system.
+ * We can find the information of INUM and interrupt level in soc.h.
+ * @param ledc_intr_num LEDC interrupt number, check the info in soc.h, and please see the core-isa.h for more details
+ * @param fn Interrupt handler function.
+ * @note
+ * Note that the handler function MUST be defined with attribution of "IRAM_ATTR".
+ * @param arg Parameter for handler function
+ *
+ * @return
+ * - ESP_OK Success
+ * - ESP_ERR_INVALID_ARG Function pointer error.
*/
esp_err_t ledc_isr_register(uint32_t ledc_intr_num, void (*fn)(void*), void * arg);
/**
* @brief configure LEDC settings
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] timer_sel : timer index(0-3), there are 4 timers in LEDC module
+ * @param timer_sel Timer index(0-3), there are 4 timers in LEDC module
*
- * @param[in] div_num : timer clock divide number, the timer clock is divided from the selected clock source
+ * @param div_num Timer clock divide number, the timer clock is divided from the selected clock source
*
- * @param[in] bit_num : the count number of one period, counter range is 0 ~ ((2 ** bit_num) - 1)
+ * @param bit_num The count number of one period, counter range is 0 ~ ((2 ** bit_num) - 1)
*
- * @param[in] clk_src : select LEDC source clock.
+ * @param clk_src Select LEDC source clock.
*
- * @return -1: parameter error
- * other value: current LEDC duty
+ * @return
+ * - (-1) Parameter error
+ * - Other Current LEDC duty
*
*/
esp_err_t ledc_timer_set(ledc_mode_t speed_mode, ledc_timer_t timer_sel, uint32_t div_num, uint32_t bit_num, ledc_clk_src_t clk_src);
/**
* @brief reset LEDC timer
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] timer_sel : LEDC timer index(0-3), select from ledc_timer_t
+ * @param timer_sel LEDC timer index(0-3), select from ledc_timer_t
*
*
- * @return ESP_ERR_INVALID_ARG: parameter error
- * ESP_OK: success
+ * @return
+ * - ESP_ERR_INVALID_ARG Parameter error
+ * - ESP_OK Success
*
*/
esp_err_t ledc_timer_rst(ledc_mode_t speed_mode, uint32_t timer_sel);
/**
* @brief pause LEDC timer counter
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] timer_sel : LEDC timer index(0-3), select from ledc_timer_t
+ * @param timer_sel LEDC timer index(0-3), select from ledc_timer_t
*
*
- * @return ESP_ERR_INVALID_ARG: parameter error
- * ESP_OK: success
+ * @return
+ * - ESP_ERR_INVALID_ARG Parameter error
+ * - ESP_OK Success
*
*/
esp_err_t ledc_timer_pause(ledc_mode_t speed_mode, uint32_t timer_sel);
/**
* @brief pause LEDC timer resume
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] timer_sel : LEDC timer index(0-3), select from ledc_timer_t
+ * @param timer_sel LEDC timer index(0-3), select from ledc_timer_t
*
*
- * @return ESP_ERR_INVALID_ARG: parameter error
- * ESP_OK: success
+ * @return
+ * - ESP_ERR_INVALID_ARG Parameter error
+ * - ESP_OK Success
*
*/
esp_err_t ledc_timer_resume(ledc_mode_t speed_mode, uint32_t timer_sel);
/**
* @brief bind LEDC channel with the selected timer
*
- * @param[in] speed_mode : select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
+ * @param speed_mode Select the LEDC speed_mode, high-speed mode and low-speed mode, now we only support high-speed mode. We will access low-speed mode in next version
*
- * @param[in] channel : LEDC channel index(0-7), select from ledc_channel_t
+ * @param channel LEDC channel index(0-7), select from ledc_channel_t
*
- * @param[in] timer_idx : LEDC timer index(0-3), select from ledc_timer_t
+ * @param timer_idx LEDC timer index(0-3), select from ledc_timer_t
*
*
- * @return ESP_ERR_INVALID_ARG: parameter error
- * ESP_OK: success
+ * @return
+ * - ESP_ERR_INVALID_ARG Parameter error
+ * - ESP_OK Success
*
*/
esp_err_t ledc_bind_channel_timer(ledc_mode_t speed_mode, uint32_t channel, uint32_t timer_idx);
*
*
* ----------------EXAMPLE OF LEDC SETTING ---------------------
- * //1. enable LEDC
- * periph_module_enable(PERIPH_LEDC_MODULE); //enable LEDC module, or you can not set any register of it.
- *
- * //2. set LEDC timer
- * ledc_timer_config_t timer_conf = {
- * .bit_num = LEDC_TIMER_12_BIT, //set timer counter bit number
- * .freq_hz = 1000, //set frequency of pwm, here, 1000Hz
- * .speed_mode = LEDC_HIGH_SPEED_MODE //timer mode,
- * .timer_num = LEDC_TIMER_0, //timer number
- * };
- * ledc_timer_config(&timer_conf); //setup timer.
- *
- * //3. set LEDC channel
- * ledc_channel_config_t ledc_conf = {
- * .channel = LEDC_CHANNEL_0; //set LEDC channel 0
- * .duty = 1000; //set the duty for initialization.(duty range is 0 ~ ((2**bit_num)-1)
- * .gpio_num = 16; //GPIO number
- * .intr_type = LEDC_INTR_FADE_END; //GPIO INTR TYPE, as an example, we enable fade_end interrupt here.
- * .speed_mode = LEDC_HIGH_SPEED_MODE; //set LEDC mode, from ledc_mode_t
- * .timer_sel = LEDC_TIMER_0; //set LEDC timer source, if different channel use one timer, the frequency and bit_num of these channels should be the same
- * }
- * ledc_channel_config(&ledc_conf); //setup the configuration
+ * @code{c}
+ * //1. enable LEDC
+ * //enable LEDC module, or you can not set any register of it.
+ * periph_module_enable(PERIPH_LEDC_MODULE);
+ * @endcode
+ *
+ * @code{c}
+ * //2. set LEDC timer
+ * ledc_timer_config_t timer_conf = {
+ * .bit_num = LEDC_TIMER_12_BIT, //set timer counter bit number
+ * .freq_hz = 1000, //set frequency of pwm, here, 1000Hz
+ * .speed_mode = LEDC_HIGH_SPEED_MODE, //timer mode,
+ * .timer_num = LEDC_TIMER_0, //timer number
+ * };
+ * ledc_timer_config(&timer_conf); //setup timer.
+ * @endcode
+ *
+ * @code{c}
+ * //3. set LEDC channel
+ * ledc_channel_config_t ledc_conf = {
+ * .channel = LEDC_CHANNEL_0; //set LEDC channel 0
+ * .duty = 1000; //set the duty for initialization.(duty range is 0 ~ ((2**bit_num)-1)
+ * .gpio_num = 16; //GPIO number
+ * .intr_type = LEDC_INTR_FADE_END; //GPIO INTR TYPE, as an example, we enable fade_end interrupt here.
+ * .speed_mode = LEDC_HIGH_SPEED_MODE; //set LEDC mode, from ledc_mode_t
+ * .timer_sel = LEDC_TIMER_0; //set LEDC timer source, if different channel use one timer, the frequency and bit_num of these channels should be the same
+ * }
+ * ledc_channel_config(&ledc_conf); //setup the configuration
*
* ----------------EXAMPLE OF SETTING DUTY --- -----------------
- * uint32_t ledc_channel = LEDC_CHANNEL_0; //LEDC channel(0-73)
- * uint32_t duty = 2000; //duty range is 0 ~ ((2**bit_num)-1)
- * LEDC_set_duty(LEDC_HIGH_SPEED_MODE, ledc_channel, duty); //set speed mode, channel, and duty.
- * ledc_update_duty(LEDC_HIGH_SPEED_MODE, ledc_channel); //after set duty, we need to call ledc_update_duty to update the settings.
- *
+ * @code{c}
+ * uint32_t ledc_channel = LEDC_CHANNEL_0; //LEDC channel(0-73)
+ * uint32_t duty = 2000; //duty range is 0 ~ ((2**bit_num)-1)
+ * LEDC_set_duty(LEDC_HIGH_SPEED_MODE, ledc_channel, duty); //set speed mode, channel, and duty.
+ * ledc_update_duty(LEDC_HIGH_SPEED_MODE, ledc_channel); //after set duty, we need to call ledc_update_duty to update the settings.
+ * @endcode
*
* ----------------EXAMPLE OF LEDC INTERRUPT ------------------
- * //we have fade_end interrupt and counter overflow interrupt. we just give an example of fade_end interrupt here.
- * ledc_isr_register(18, ledc_isr_handler, NULL); //hook the isr handler for LEDC interrupt
- * //the first parameter is INUM, you can pick one form interrupt level 1/2 which is not used by the system.
- * //NOTE1:user should arrange the INUMs that used, better not to use a same INUM for different interrupt source.
- * //NOTE2:do not pick the INUM that already occupied by the system.
- * //NOTE3:refer to soc.h to check which INUMs that can be used.
+ * @code{c}
+ * //we have fade_end interrupt and counter overflow interrupt. we just give an example of fade_end interrupt here.
+ * ledc_isr_register(18, ledc_isr_handler, NULL); //hook the isr handler for LEDC interrupt
+ * @endcode
+ * @note
+ * 1. the first parameter is INUM, you can pick one form interrupt level 1/2 which is not used by the system.
+ * 2. user should arrange the INUMs that used, better not to use a same INUM for different interrupt source.
+ * 3. do not pick the INUM that already occupied by the system.
+ * 4. refer to soc.h to check which INUMs that can be used.
+ *
* ----------------EXAMPLE OF INTERRUPT HANDLER ---------------
+ * @code{c}
* #include "esp_attr.h"
* void IRAM_ATTR ledc_isr_handler(void* arg) //we should add 'IRAM_ATTR' attribution when we declare the isr function
* {
*
* LEDC.int_clr.val = intr_st; //clear LEDC interrupt status.
* }
- *
+ * @endcode
*
*--------------------------END OF EXAMPLE --------------------------
*/
projects / esp-idf / commitdiff