2016-09-23 09:21:37 +08:00
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
# ifndef _DRIVER_LEDC_H_
# define _DRIVER_LEDC_H_
# include "esp_err.h"
# include "soc/soc.h"
# include "driver/gpio.h"
2016-09-28 23:20:34 +08:00
# include "driver/periph_ctrl.h"
2016-12-07 21:30:21 +08:00
# include "esp_intr_alloc.h"
2016-09-23 09:21:37 +08:00
# ifdef __cplusplus
extern " C " {
# endif
# define LEDC_APB_CLK_HZ (APB_CLK_FREQ)
# define LEDC_REF_CLK_HZ (1*1000000)
2017-05-12 10:43:37 +08:00
# define LEDC_ERR_DUTY (0xFFFFFFFF)
2018-04-12 15:38:39 +08:00
# define LEDC_ERR_VAL (-1)
2016-09-23 09:21:37 +08:00
typedef enum {
2016-11-01 11:48:32 +08:00
LEDC_HIGH_SPEED_MODE = 0 , /*!< LEDC high speed speed_mode */
2017-10-23 05:32:47 +02:00
LEDC_LOW_SPEED_MODE , /*!< LEDC low speed speed_mode */
2016-11-01 11:48:32 +08:00
LEDC_SPEED_MODE_MAX , /*!< LEDC speed limit */
2016-09-23 09:21:37 +08:00
} ledc_mode_t ;
2016-09-28 12:04:15 +08:00
2016-09-23 09:21:37 +08:00
typedef enum {
2016-11-01 11:48:32 +08:00
LEDC_INTR_DISABLE = 0 , /*!< Disable LEDC interrupt */
LEDC_INTR_FADE_END , /*!< Enable LEDC interrupt */
2016-09-23 09:21:37 +08:00
} ledc_intr_type_t ;
2016-09-28 12:04:15 +08:00
2016-09-23 09:21:37 +08:00
typedef enum {
2016-11-01 11:48:32 +08:00
LEDC_DUTY_DIR_DECREASE = 0 , /*!< LEDC duty decrease direction */
LEDC_DUTY_DIR_INCREASE = 1 , /*!< LEDC duty increase direction */
2018-04-12 15:38:39 +08:00
LEDC_DUTY_DIR_MAX ,
2016-09-23 09:21:37 +08:00
} ledc_duty_direction_t ;
2016-09-28 12:04:15 +08:00
2016-09-23 09:21:37 +08:00
typedef enum {
2017-10-23 05:32:47 +02:00
LEDC_REF_TICK = 0 , /*!< LEDC timer clock divided from reference tick (1Mhz) */
LEDC_APB_CLK , /*!< LEDC timer clock divided from APB clock (80Mhz) */
2016-09-26 09:56:03 +08:00
} ledc_clk_src_t ;
2016-09-28 12:04:15 +08:00
2016-09-23 09:21:37 +08:00
typedef enum {
2017-10-23 05:32:47 +02:00
LEDC_TIMER_0 = 0 , /*!< LEDC timer 0 */
LEDC_TIMER_1 , /*!< LEDC timer 1 */
LEDC_TIMER_2 , /*!< LEDC timer 2 */
LEDC_TIMER_3 , /*!< LEDC timer 3 */
2018-04-12 15:38:39 +08:00
LEDC_TIMER_MAX ,
2016-09-26 09:56:03 +08:00
} ledc_timer_t ;
2016-09-28 12:04:15 +08:00
2016-09-23 09:21:37 +08:00
typedef enum {
2016-11-01 11:48:32 +08:00
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 */
2016-12-25 23:11:24 +08:00
LEDC_CHANNEL_MAX ,
2016-09-23 09:21:37 +08:00
} ledc_channel_t ;
2016-09-28 12:04:15 +08:00
2016-09-23 09:21:37 +08:00
typedef enum {
2018-04-12 15:38:39 +08:00
LEDC_TIMER_1_BIT = 1 , /*!< LEDC PWM duty resolution of 1 bits */
LEDC_TIMER_2_BIT , /*!< LEDC PWM duty resolution of 2 bits */
LEDC_TIMER_3_BIT , /*!< LEDC PWM duty resolution of 3 bits */
LEDC_TIMER_4_BIT , /*!< LEDC PWM duty resolution of 4 bits */
LEDC_TIMER_5_BIT , /*!< LEDC PWM duty resolution of 5 bits */
LEDC_TIMER_6_BIT , /*!< LEDC PWM duty resolution of 6 bits */
LEDC_TIMER_7_BIT , /*!< LEDC PWM duty resolution of 7 bits */
LEDC_TIMER_8_BIT , /*!< LEDC PWM duty resolution of 8 bits */
LEDC_TIMER_9_BIT , /*!< LEDC PWM duty resolution of 9 bits */
LEDC_TIMER_10_BIT , /*!< LEDC PWM duty resolution of 10 bits */
LEDC_TIMER_11_BIT , /*!< LEDC PWM duty resolution of 11 bits */
LEDC_TIMER_12_BIT , /*!< LEDC PWM duty resolution of 12 bits */
LEDC_TIMER_13_BIT , /*!< LEDC PWM duty resolution of 13 bits */
LEDC_TIMER_14_BIT , /*!< LEDC PWM duty resolution of 14 bits */
LEDC_TIMER_15_BIT , /*!< LEDC PWM duty resolution of 15 bits */
LEDC_TIMER_16_BIT , /*!< LEDC PWM duty resolution of 16 bits */
LEDC_TIMER_17_BIT , /*!< LEDC PWM duty resolution of 17 bits */
LEDC_TIMER_18_BIT , /*!< LEDC PWM duty resolution of 18 bits */
LEDC_TIMER_19_BIT , /*!< LEDC PWM duty resolution of 19 bits */
LEDC_TIMER_20_BIT , /*!< LEDC PWM duty resolution of 20 bits */
LEDC_TIMER_BIT_MAX ,
2016-09-26 09:56:03 +08:00
} ledc_timer_bit_t ;
2016-09-23 09:21:37 +08:00
2016-12-25 23:11:24 +08:00
typedef enum {
LEDC_FADE_NO_WAIT = 0 , /*!< LEDC fade function will return immediately */
2017-10-23 05:32:47 +02:00
LEDC_FADE_WAIT_DONE , /*!< LEDC fade function will block until fading to the target duty */
2016-12-25 23:11:24 +08:00
LEDC_FADE_MAX ,
} ledc_fade_mode_t ;
2017-10-23 05:32:47 +02:00
2016-11-16 01:35:09 +08:00
/**
* @ brief Configuration parameters of LEDC channel for ledc_channel_config function
*/
2016-09-28 23:20:34 +08:00
typedef struct {
2017-10-23 05:32:47 +02:00
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) */
2018-04-12 15:38:39 +08:00
uint32_t duty ; /*!< LEDC channel duty, the range of duty setting is [0, (2**duty_resolution)] */
int hpoint ; /*!< LEDC channel hpoint value, the max value is 0xfffff */
2016-09-28 23:20:34 +08:00
} ledc_channel_config_t ;
2016-11-16 01:35:09 +08:00
/**
* @ brief Configuration parameters of LEDC Timer timer for ledc_timer_config function
*/
2016-09-28 23:20:34 +08:00
typedef struct {
2017-12-04 20:22:24 +01:00
ledc_mode_t speed_mode ; /*!< LEDC speed speed_mode, high-speed mode or low-speed mode */
union {
ledc_timer_bit_t duty_resolution ; /*!< LEDC channel duty resolution */
ledc_timer_bit_t bit_num __attribute__ ( ( deprecated ) ) ; /*!< Deprecated in ESP-IDF 3.0. This is an alias to 'duty_resolution' for backward compatibility with ESP-IDF 2.1 */
} ;
ledc_timer_t timer_num ; /*!< The timer source of channel (0 - 3) */
uint32_t freq_hz ; /*!< LEDC timer frequency (Hz) */
2016-09-28 23:20:34 +08:00
} ledc_timer_config_t ;
2016-12-07 21:30:21 +08:00
typedef intr_handle_t ledc_isr_handle_t ;
2016-09-28 23:20:34 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief LEDC channel configuration
2017-10-23 05:32:47 +02:00
* Configure LEDC channel with the given channel / output gpio_num / interrupt / source timer / frequency ( Hz ) / LEDC duty resolution
2016-09-28 23:20:34 +08:00
*
2016-12-25 23:11:24 +08:00
* @ param ledc_conf Pointer of LEDC channel configure struct
2016-09-28 23:20:34 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2016-09-28 23:20:34 +08:00
*/
2017-04-13 18:33:33 +01:00
esp_err_t ledc_channel_config ( const ledc_channel_config_t * ledc_conf ) ;
2016-09-23 09:21:37 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief LEDC timer configuration
2017-10-23 05:32:47 +02:00
* Configure LEDC timer with the given source timer / frequency ( Hz ) / duty_resolution
2016-09-28 23:20:34 +08:00
*
2016-11-01 11:48:32 +08:00
* @ param timer_conf Pointer of LEDC timer configure struct
*
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2017-10-23 05:32:47 +02:00
* - ESP_FAIL Can not find a proper pre - divider number base on the given frequency and the current duty_resolution .
2016-09-23 09:21:37 +08:00
*/
2017-04-13 18:33:33 +01:00
esp_err_t ledc_timer_config ( const ledc_timer_config_t * timer_conf ) ;
2016-09-23 09:21:37 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief LEDC update channel parameters
2018-04-12 15:38:39 +08:00
* @ note Call this function to activate the LEDC updated parameters .
* After ledc_set_duty , we need to call this function to update the settings .
* @ note ledc_set_duty , ledc_set_duty_with_hpoint and ledc_update_duty are not thread - safe , do not call these functions to
* control one LEDC channel in different tasks at the same time .
* A thread - safe version of API is ledc_set_duty_and_update
2016-12-25 23:11:24 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode ,
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
2016-09-23 09:21:37 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2016-09-23 09:21:37 +08:00
*
*/
2016-09-28 23:20:34 +08:00
esp_err_t ledc_update_duty ( ledc_mode_t speed_mode , ledc_channel_t channel ) ;
2016-09-23 09:21:37 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief LEDC stop .
* Disable LEDC output , and set idle level
2016-09-23 09:21:37 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
2016-11-16 01:31:02 +08:00
* @ param idle_level Set output idle level after LEDC stops .
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2016-09-23 09:21:37 +08:00
*/
esp_err_t ledc_stop ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t idle_level ) ;
/**
2017-10-23 05:32:47 +02:00
* @ brief LEDC set channel frequency ( Hz )
2016-09-23 09:21:37 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param timer_num LEDC timer index ( 0 - 3 ) , select from ledc_timer_t
2016-11-01 11:48:32 +08:00
* @ param freq_hz Set the LEDC frequency
2016-09-23 09:21:37 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2017-10-23 05:32:47 +02:00
* - ESP_FAIL Can not find a proper pre - divider number base on the given frequency and the current duty_resolution .
2016-09-23 09:21:37 +08:00
*/
2016-09-26 09:56:03 +08:00
esp_err_t ledc_set_freq ( ledc_mode_t speed_mode , ledc_timer_t timer_num , uint32_t freq_hz ) ;
2016-09-23 09:21:37 +08:00
/**
2017-10-23 05:32:47 +02:00
* @ brief LEDC get channel frequency ( Hz )
2016-09-23 09:21:37 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param timer_num LEDC timer index ( 0 - 3 ) , select from ledc_timer_t
2016-09-23 09:21:37 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - 0 error
* - Others Current LEDC frequency
2016-09-23 09:21:37 +08:00
*/
2016-09-26 09:56:03 +08:00
uint32_t ledc_get_freq ( ledc_mode_t speed_mode , ledc_timer_t timer_num ) ;
2016-09-23 09:21:37 +08:00
/**
2018-04-12 15:38:39 +08:00
* @ brief LEDC set duty and hpoint value
2016-12-25 23:11:24 +08:00
* Only after calling ledc_update_duty will the duty update .
2018-04-12 15:38:39 +08:00
* @ note ledc_set_duty , ledc_set_duty_with_hpoint and ledc_update_duty are not thread - safe , do not call these functions to
* control one LEDC channel in different tasks at the same time .
* A thread - safe version of API is ledc_set_duty_and_update
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
* @ param duty Set the LEDC duty , the range of duty setting is [ 0 , ( 2 * * duty_resolution ) ]
* @ param hpoint Set the LEDC hpoint value ( max : 0xfffff )
*
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
*/
esp_err_t ledc_set_duty_with_hpoint ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t duty , uint32_t hpoint ) ;
/**
* @ brief LEDC get hpoint value , the counter value when the output is set high level .
2016-09-23 09:21:37 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
2018-04-12 15:38:39 +08:00
* @ return
* - LEDC_ERR_VAL if parameter error
* - Others Current hpoint value of LEDC channel
*/
int ledc_get_hpoint ( ledc_mode_t speed_mode , ledc_channel_t channel ) ;
/**
* @ brief LEDC set duty
* This function do not change the hpoint value of this channel . if needed , please call ledc_set_duty_with_hpoint .
* only after calling ledc_update_duty will the duty update .
* @ note ledc_set_duty , ledc_set_duty_with_hpoint and ledc_update_duty are not thread - safe , do not call these functions to
* control one LEDC channel in different tasks at the same time .
* A thread - safe version of API is ledc_set_duty_and_update .
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
* @ param duty Set the LEDC duty , the range of duty setting is [ 0 , ( 2 * * duty_resolution ) ]
2016-09-23 09:21:37 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2016-09-23 09:21:37 +08:00
*/
esp_err_t ledc_set_duty ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t duty ) ;
/**
2016-12-25 23:11:24 +08:00
* @ brief LEDC get duty
2016-09-23 09:21:37 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
2016-09-23 09:21:37 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
2017-05-12 10:43:37 +08:00
* - LEDC_ERR_DUTY if parameter error
2016-11-01 11:48:32 +08:00
* - Others Current LEDC duty
2016-09-23 09:21:37 +08:00
*/
2017-05-12 10:43:37 +08:00
uint32_t ledc_get_duty ( ledc_mode_t speed_mode , ledc_channel_t channel ) ;
2016-09-23 09:21:37 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief LEDC set gradient
* Set LEDC gradient , After the function calls the ledc_update_duty function , the function can take effect .
2018-04-12 15:38:39 +08:00
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
* @ param duty Set the start of the gradient duty , the range of duty setting is [ 0 , ( 2 * * duty_resolution ) ]
* @ param fade_direction Set the direction of the gradient
* @ param step_num Set the number of the gradient
* @ param duty_cyle_num Set how many LEDC tick each time the gradient lasts
* @ param duty_scale Set gradient change amplitude
2016-09-23 09:21:37 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
2016-09-23 09:21:37 +08:00
*/
2018-04-12 15:38:39 +08:00
esp_err_t ledc_set_fade ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t duty , ledc_duty_direction_t fade_direction ,
2016-09-23 09:21:37 +08:00
uint32_t step_num , uint32_t duty_cyle_num , uint32_t duty_scale ) ;
/**
2016-12-25 23:11:24 +08:00
* @ 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 .
2016-11-25 17:33:51 +08:00
*
2016-12-25 23:11:24 +08:00
* @ param fn Interrupt handler function .
* @ param arg User - supplied argument passed to the handler function .
* @ param intr_alloc_flags Flags used to allocate the interrupt . One or multiple ( ORred )
* ESP_INTR_FLAG_ * values . See esp_intr_alloc . h for more info .
* @ param arg Parameter for handler function
* @ param handle Pointer to return handle . If non - NULL , a handle for the interrupt will
* be returned here .
2016-11-01 11:48:32 +08:00
*
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Function pointer error .
2016-09-23 09:21:37 +08:00
*/
2016-12-07 21:30:21 +08:00
esp_err_t ledc_isr_register ( void ( * fn ) ( void * ) , void * arg , int intr_alloc_flags , ledc_isr_handle_t * handle ) ;
2016-09-23 09:21:37 +08:00
2016-09-26 09:56:03 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief Configure LEDC settings
2016-09-26 09:56:03 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param timer_sel Timer index ( 0 - 3 ) , there are 4 timers in LEDC module
* @ param clock_divider Timer clock divide value , the timer clock is divided from the selected clock source
2018-04-12 15:38:39 +08:00
* @ param duty_resolution Resolution of duty setting in number of bits . The range of duty values is [ 0 , ( 2 * * duty_resolution ) ]
2016-12-25 23:11:24 +08:00
* @ param clk_src Select LEDC source clock .
2016-09-26 09:56:03 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ( - 1 ) Parameter error
* - Other Current LEDC duty
2016-09-26 09:56:03 +08:00
*/
2017-10-23 05:32:47 +02:00
esp_err_t ledc_timer_set ( ledc_mode_t speed_mode , ledc_timer_t timer_sel , uint32_t clock_divider , uint32_t duty_resolution , ledc_clk_src_t clk_src ) ;
2016-09-26 09:56:03 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief Reset LEDC timer
2016-09-26 09:56:03 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param timer_sel LEDC timer index ( 0 - 3 ) , select from ledc_timer_t
2016-09-26 09:56:03 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
2016-09-26 09:56:03 +08:00
*/
esp_err_t ledc_timer_rst ( ledc_mode_t speed_mode , uint32_t timer_sel ) ;
2016-09-23 09:21:37 +08:00
2016-09-26 09:56:03 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief Pause LEDC timer counter
2016-09-26 09:56:03 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param timer_sel LEDC timer index ( 0 - 3 ) , select from ledc_timer_t
2016-09-26 09:56:03 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
2016-09-26 09:56:03 +08:00
*
*/
esp_err_t ledc_timer_pause ( ledc_mode_t speed_mode , uint32_t timer_sel ) ;
2016-09-23 09:21:37 +08:00
2016-09-26 09:56:03 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief Resume LEDC timer
2016-09-26 09:56:03 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param timer_sel LEDC timer index ( 0 - 3 ) , select from ledc_timer_t
2016-09-26 09:56:03 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
2016-09-26 09:56:03 +08:00
*/
esp_err_t ledc_timer_resume ( ledc_mode_t speed_mode , uint32_t timer_sel ) ;
2016-09-23 09:21:37 +08:00
2016-09-26 09:56:03 +08:00
/**
2016-12-25 23:11:24 +08:00
* @ brief Bind LEDC channel with the selected timer
2016-09-26 09:56:03 +08:00
*
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel index ( 0 - 7 ) , select from ledc_channel_t
* @ param timer_idx LEDC timer index ( 0 - 3 ) , select from ledc_timer_t
2016-09-26 09:56:03 +08:00
*
2016-12-25 23:11:24 +08:00
* @ 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 ) ;
/**
2018-04-12 15:38:39 +08:00
* @ brief Set LEDC fade function .
* @ note Call ledc_fade_func_install ( ) once before calling this function .
2016-12-25 23:11:24 +08:00
* Call ledc_fade_start ( ) after this to start fading .
2018-04-12 15:38:39 +08:00
* @ note ledc_set_fade_with_step , ledc_set_fade_with_time and ledc_fade_start are not thread - safe , do not call these functions to
* control one LEDC channel in different tasks at the same time .
* A thread - safe version of API is ledc_set_fade_step_and_start
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
2016-12-25 23:11:24 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode ,
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel index ( 0 - 7 ) , select from ledc_channel_t
* @ param target_duty Target duty of fading [ 0 , ( 2 * * duty_resolution ) - 1 ]
2016-12-25 23:11:24 +08:00
* @ param scale Controls the increase or decrease step scale .
* @ param cycle_num increase or decrease the duty every cycle_num cycles
2016-09-26 09:56:03 +08:00
*
2016-11-01 11:48:32 +08:00
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
2016-12-25 23:11:24 +08:00
* - ESP_ERR_INVALID_STATE Fade function not installed .
2017-02-08 19:52:18 +08:00
* - ESP_FAIL Fade function init error
2016-09-26 09:56:03 +08:00
*/
2018-04-12 15:38:39 +08:00
esp_err_t ledc_set_fade_with_step ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t target_duty , uint32_t scale , uint32_t cycle_num ) ;
2016-12-25 23:11:24 +08:00
/**
2018-04-12 15:38:39 +08:00
* @ brief Set LEDC fade function , with a limited time .
* @ note Call ledc_fade_func_install ( ) once before calling this function .
2016-12-25 23:11:24 +08:00
* Call ledc_fade_start ( ) after this to start fading .
2018-04-12 15:38:39 +08:00
* @ note ledc_set_fade_with_step , ledc_set_fade_with_time and ledc_fade_start are not thread - safe , do not call these functions to
* control one LEDC channel in different tasks at the same time .
* A thread - safe version of API is ledc_set_fade_step_and_start
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
2016-12-25 23:11:24 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode ,
2017-10-23 05:32:47 +02:00
* @ param channel LEDC channel index ( 0 - 7 ) , select from ledc_channel_t
* @ param target_duty Target duty of fading . ( 0 - ( 2 * * duty_resolution - 1 ) ) )
2016-12-25 23:11:24 +08:00
* @ param max_fade_time_ms The maximum time of the fading ( ms ) .
*
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
* - ESP_ERR_INVALID_STATE Fade function not installed .
2017-02-08 19:52:18 +08:00
* - ESP_FAIL Fade function init error
2016-09-23 09:21:37 +08:00
*/
2017-05-12 10:43:37 +08:00
esp_err_t ledc_set_fade_with_time ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t target_duty , int max_fade_time_ms ) ;
2016-09-23 09:21:37 +08:00
2016-12-25 23:11:24 +08:00
/**
2018-04-12 15:38:39 +08:00
* @ brief Install LEDC fade function . This function will occupy interrupt of LEDC module .
2016-12-25 23:11:24 +08:00
* @ param intr_alloc_flags Flags used to allocate the interrupt . One or multiple ( ORred )
* ESP_INTR_FLAG_ * values . See esp_intr_alloc . h for more info .
*
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_STATE Fade function already installed .
*/
esp_err_t ledc_fade_func_install ( int intr_alloc_flags ) ;
2016-09-23 09:21:37 +08:00
2016-12-25 23:11:24 +08:00
/**
* @ brief Uninstall LEDC fade function .
*
*/
void ledc_fade_func_uninstall ( ) ;
2016-09-23 09:21:37 +08:00
2016-12-25 23:11:24 +08:00
/**
* @ brief Start LEDC fading .
2018-04-12 15:38:39 +08:00
* @ note Call ledc_fade_func_install ( ) once before calling this function .
* Call this API right after ledc_set_fade_with_time or ledc_set_fade_with_step before to start fading .
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
2017-02-08 19:52:18 +08:00
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
2016-12-25 23:11:24 +08:00
* @ param channel LEDC channel number
2018-04-12 15:38:39 +08:00
* @ param fade_mode Whether to block until fading done .
2016-12-25 23:11:24 +08:00
*
* @ return
* - ESP_OK Success
* - ESP_ERR_INVALID_STATE Fade function not installed .
* - ESP_ERR_INVALID_ARG Parameter error .
*/
2018-04-12 15:38:39 +08:00
esp_err_t ledc_fade_start ( ledc_mode_t speed_mode , ledc_channel_t channel , ledc_fade_mode_t fade_mode ) ;
/**
* @ brief A thread - safe API to set duty for LEDC channel and update the settings immediately
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
*
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode
* @ param channel LEDC channel ( 0 - 7 ) , select from ledc_channel_t
* @ param duty Set the LEDC duty , the range of duty setting is [ 0 , ( 2 * * duty_resolution ) ]
* @ param hpoint Set the LEDC hpoint value ( max : 0xfffff )
*
*/
esp_err_t ledc_set_duty_and_update ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t duty , uint32_t hpoint ) ;
2016-09-23 09:21:37 +08:00
2018-04-12 15:38:39 +08:00
/**
* @ brief A thread - safe API to set and start LEDC fade function , with a limited time .
* @ note Call ledc_fade_func_install ( ) once , before calling this function .
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode ,
* @ param channel LEDC channel index ( 0 - 7 ) , select from ledc_channel_t
* @ param target_duty Target duty of fading . ( 0 - ( 2 * * duty_resolution - 1 ) ) )
* @ param max_fade_time_ms The maximum time of the fading ( ms ) .
* @ param fade_mode choose blocking or non - blocking mode
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
* - ESP_ERR_INVALID_STATE Fade function not installed .
* - ESP_FAIL Fade function init error
*/
esp_err_t ledc_set_fade_time_and_start ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t target_duty , uint32_t max_fade_time_ms , ledc_fade_mode_t fade_mode ) ;
/**
* @ brief A thread - safe API to set and start LEDC fade function .
* @ note Call ledc_fade_func_install ( ) once before calling this function .
* @ note If a fade operation is running in progress on that channel , the driver would not allow it to be stopped .
* Other duty operations will have to wait until the fade operation has finished .
* @ param speed_mode Select the LEDC speed_mode , high - speed mode and low - speed mode ,
* @ param channel LEDC channel index ( 0 - 7 ) , select from ledc_channel_t
* @ param target_duty Target duty of fading [ 0 , ( 2 * * duty_resolution ) - 1 ]
* @ param scale Controls the increase or decrease step scale .
* @ param cycle_num increase or decrease the duty every cycle_num cycles
* @ param fade_mode choose blocking or non - blocking mode
* @ return
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_OK Success
* - ESP_ERR_INVALID_STATE Fade function not installed .
* - ESP_FAIL Fade function init error
*/
esp_err_t ledc_set_fade_step_and_start ( ledc_mode_t speed_mode , ledc_channel_t channel , uint32_t target_duty , uint32_t scale , uint32_t cycle_num , ledc_fade_mode_t fade_mode ) ;
2016-09-23 09:21:37 +08:00
# ifdef __cplusplus
}
# endif
# endif /* _DRIVER_LEDC_H_ */