c7738f24fc
driver: Avoid possible accidental mismatch between ledc_clk_src_t & ledc_clk_cfg_t enum See merge request espressif/esp-idf!7021
154 lines
7 KiB
C
154 lines
7 KiB
C
// Copyright 2019 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.
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "soc/ledc_caps.h"
|
|
|
|
typedef enum {
|
|
#ifdef SOC_LEDC_SUPPORT_HS_MODE
|
|
LEDC_HIGH_SPEED_MODE = 0, /*!< LEDC high speed speed_mode */
|
|
#endif
|
|
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_MAX,
|
|
} 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_MAX,
|
|
} ledc_duty_direction_t;
|
|
|
|
typedef enum {
|
|
LEDC_SLOW_CLK_RTC8M = 0, /*!< LEDC low speed timer clock source is 8MHz RTC clock*/
|
|
LEDC_SLOW_CLK_APB, /*!< LEDC low speed timer clock source is 80MHz APB clock*/
|
|
#ifdef SOC_LEDC_SUPPORT_XTAL_CLOCK
|
|
LEDC_SLOW_CLK_XTAL, /*!< LEDC low speed timer clock source XTAL clock*/
|
|
#endif
|
|
} ledc_slow_clk_sel_t;
|
|
|
|
typedef enum {
|
|
LEDC_AUTO_CLK = 0, /*!< The driver will automatically select the source clock(REF_TICK or APB) based on the giving resolution and duty parameter when init the timer*/
|
|
LEDC_USE_REF_TICK, /*!< LEDC timer select REF_TICK clock as source clock*/
|
|
LEDC_USE_APB_CLK, /*!< LEDC timer select APB clock as source clock*/
|
|
LEDC_USE_RTC8M_CLK, /*!< LEDC timer select RTC8M_CLK as source clock. Only for low speed channels and this parameter must be the same for all low speed channels*/
|
|
#ifdef SOC_LEDC_SUPPORT_XTAL_CLOCK
|
|
LEDC_USE_XTAL_CLK, /*!< LEDC timer select XTAL clock as source clock*/
|
|
#endif
|
|
} ledc_clk_cfg_t;
|
|
|
|
/* Note: Setting numeric values to match ledc_clk_cfg_t values are a hack to avoid collision with
|
|
LEDC_AUTO_CLK in the driver, as these enums have very similar names and user may pass
|
|
one of these by mistake. */
|
|
typedef enum {
|
|
LEDC_REF_TICK = LEDC_USE_REF_TICK, /*!< LEDC timer clock divided from reference tick (1Mhz) */
|
|
LEDC_APB_CLK = LEDC_USE_APB_CLK, /*!< LEDC timer clock divided from APB clock (80Mhz) */
|
|
} ledc_clk_src_t;
|
|
|
|
|
|
typedef enum {
|
|
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 */
|
|
LEDC_TIMER_MAX,
|
|
} 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_MAX,
|
|
} ledc_channel_t;
|
|
|
|
typedef enum {
|
|
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,
|
|
} ledc_timer_bit_t;
|
|
|
|
typedef enum {
|
|
LEDC_FADE_NO_WAIT = 0, /*!< LEDC fade function will return immediately */
|
|
LEDC_FADE_WAIT_DONE, /*!< LEDC fade function will block until fading to the target duty */
|
|
LEDC_FADE_MAX,
|
|
} ledc_fade_mode_t;
|
|
|
|
/**
|
|
* @brief Configuration parameters of LEDC channel for ledc_channel_config function
|
|
*/
|
|
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 range of duty setting is [0, (2**duty_resolution)] */
|
|
int hpoint; /*!< LEDC channel hpoint value, the max value is 0xfffff */
|
|
} ledc_channel_config_t;
|
|
|
|
/**
|
|
* @brief Configuration parameters of LEDC Timer timer for ledc_timer_config function
|
|
*/
|
|
typedef struct {
|
|
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) */
|
|
ledc_clk_cfg_t clk_cfg; /*!< Configure LEDC source clock.
|
|
For low speed channels and high speed channels, you can specify the source clock using LEDC_USE_REF_TICK, LEDC_USE_APB_CLK or LEDC_AUTO_CLK.
|
|
For low speed channels, you can also specify the source clock using LEDC_USE_RTC8M_CLK, in this case, all low speed channel's source clock must be RTC8M_CLK*/
|
|
} ledc_timer_config_t;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|