Esp32/Components/driver/include/driver/pwm.h
Go to the documentation of this file.
1 /*
2  * ESPRESSIF MIT License
3  *
4  * Copyright (c) 2016 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
5  *
6  * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
7  * it is free of charge, to any person obtaining a copy of this software and associated
8  * documentation files (the "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
11  * to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all copies or
14  * substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  *
23  */
24 
25 #ifndef __PWM_H__
26 #define __PWM_H__
27 
28 #pragma once
29 
30 #if defined(__cplusplus)
31 extern "C" {
32 #endif
33 
34 /*pwm.h: function and macro definition of PWM API , driver level */
35 /*user_light.h: user interface for light API, user level*/
36 /*user_light_adj: API for color changing and lighting effects, user level*/
37 
38 /*NOTE!! : DO NOT CHANGE THIS FILE*/
39 
40 /*SUPPORT UP TO 8 PWM CHANNEL*/
41 #define PWM_CHANNEL_NUM_MAX 8
42 
43 //struct pwm_param {
44 // uint32_t period;
45 // uint32_t freq;
46 // uint32_t duty[PWM_CHANNEL_NUM_MAX]; //PWM_CHANNEL<=8
47 //};
48 //
50 //void pwm_init(uint32_t period, uint32_t* duty, uint32_t pwm_channel_num, uint32_t (*pin_info_list)[3]);
51 //void pwm_start(void);
52 //
53 //void pwm_set_duty(uint32_t duty, uint8_t channel);
54 //uint32_t pwm_get_duty(uint8_t channel);
55 //void pwm_set_period(uint32_t period);
56 //uint32_t pwm_get_period(void);
57 //
58 //uint32_t get_pwm_version(void);
59 //void set_pwm_debug_en(uint8_t print_en);
60 
61 #if defined(__cplusplus)
62 }
63 #endif
64 
65 #endif