• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2015-2019 Espressif Systems (Shanghai) PTE LTD
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #include "esp_log.h"
16 #include "esp_err.h"
17 #include "driver/sigmadelta.h"
18 #include "esp_heap_caps.h"
19 #include "hal/sigmadelta_hal.h"
20 #include "hal/gpio_hal.h"
21 #include "esp_rom_gpio.h"
22 
23 static const char *TAG = "sigma-delta";
24 
25 #define SIGMADELTA_CHECK(a,str,ret_val) if(!(a)) {                 \
26         ESP_LOGE(TAG,"%s(%d): %s", __FUNCTION__, __LINE__, str);   \
27         return (ret_val);                                          \
28     }
29 
30 typedef struct {
31     sigmadelta_hal_context_t hal;        /*!< SIGMADELTA hal context*/
32 } sigmadelta_obj_t;
33 
34 static sigmadelta_obj_t *p_sigmadelta_obj[SIGMADELTA_PORT_MAX] = {0};
35 
36 #define SIGMADELTA_OBJ_CHECK(sigmadelta_port) { \
37     SIGMADELTA_CHECK((sigmadelta_port < SIGMADELTA_PORT_MAX), "sigmadelta port error", ESP_ERR_INVALID_ARG); \
38     SIGMADELTA_CHECK((p_sigmadelta_obj[sigmadelta_port]), "sigmadelta driver has not been initialized", ESP_ERR_INVALID_STATE); \
39 }
40 
_sigmadelta_set_duty(sigmadelta_port_t sigmadelta_port,sigmadelta_channel_t channel,int8_t duty)41 static inline esp_err_t _sigmadelta_set_duty(sigmadelta_port_t sigmadelta_port, sigmadelta_channel_t channel, int8_t duty)
42 {
43     SIGMADELTA_OBJ_CHECK(sigmadelta_port);
44 
45     sigmadelta_hal_set_duty(&(p_sigmadelta_obj[sigmadelta_port]->hal), channel, duty);
46     return ESP_OK;
47 }
48 
_sigmadelta_set_prescale(sigmadelta_port_t sigmadelta_port,sigmadelta_channel_t channel,uint8_t prescale)49 static inline esp_err_t _sigmadelta_set_prescale(sigmadelta_port_t sigmadelta_port, sigmadelta_channel_t channel, uint8_t prescale)
50 {
51     SIGMADELTA_OBJ_CHECK(sigmadelta_port);
52 
53     sigmadelta_hal_set_prescale(&(p_sigmadelta_obj[sigmadelta_port]->hal), channel, prescale);
54     return ESP_OK;
55 }
56 
_sigmadelta_set_pin(sigmadelta_port_t sigmadelta_port,sigmadelta_channel_t channel,gpio_num_t gpio_num)57 static inline esp_err_t _sigmadelta_set_pin(sigmadelta_port_t sigmadelta_port, sigmadelta_channel_t channel, gpio_num_t gpio_num)
58 {
59     SIGMADELTA_OBJ_CHECK(sigmadelta_port);
60 
61     gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
62     gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
63     esp_rom_gpio_connect_out_signal(gpio_num, sigma_delta_periph_signals.channels[channel].sd_sig, 0, 0);
64     return ESP_OK;
65 }
66 
_sigmadelta_config(sigmadelta_port_t sigmadelta_port,const sigmadelta_config_t * config)67 static inline esp_err_t _sigmadelta_config(sigmadelta_port_t sigmadelta_port, const sigmadelta_config_t *config)
68 {
69     SIGMADELTA_OBJ_CHECK(sigmadelta_port);
70 
71     _sigmadelta_set_duty(sigmadelta_port, config->channel, config->sigmadelta_duty);
72     _sigmadelta_set_prescale(sigmadelta_port, config->channel, config->sigmadelta_prescale);
73     _sigmadelta_set_pin(sigmadelta_port, config->channel, config->sigmadelta_gpio);
74     return ESP_OK;
75 }
76 
sigmadelta_deinit(sigmadelta_port_t sigmadelta_port)77 esp_err_t sigmadelta_deinit(sigmadelta_port_t sigmadelta_port)
78 {
79     SIGMADELTA_OBJ_CHECK(sigmadelta_port);
80 
81     heap_caps_free(p_sigmadelta_obj[sigmadelta_port]);
82     p_sigmadelta_obj[sigmadelta_port] = NULL;
83     return ESP_OK;
84 }
85 
sigmadelta_init(sigmadelta_port_t sigmadelta_port)86 esp_err_t sigmadelta_init(sigmadelta_port_t sigmadelta_port)
87 {
88     SIGMADELTA_CHECK((sigmadelta_port < SIGMADELTA_PORT_MAX), "sigmadelta_port error", ESP_ERR_INVALID_ARG);
89     SIGMADELTA_CHECK((p_sigmadelta_obj[sigmadelta_port]) == NULL, "sigmadelta driver already initialized", ESP_ERR_INVALID_STATE);
90 
91     p_sigmadelta_obj[sigmadelta_port] = (sigmadelta_obj_t *) heap_caps_calloc(1, sizeof(sigmadelta_obj_t), MALLOC_CAP_DEFAULT);
92 
93     if (p_sigmadelta_obj[sigmadelta_port] == NULL) {
94         ESP_LOGE(TAG, "TAG driver malloc error");
95         return ESP_FAIL;
96     }
97 
98     sigmadelta_hal_init(&(p_sigmadelta_obj[sigmadelta_port]->hal), sigmadelta_port);
99     return ESP_OK;
100 }
101 
102 // TODO: The following functions are wrappers, for compatibility with current API.
103 
sigmadelta_set_duty(sigmadelta_channel_t channel,int8_t duty)104 esp_err_t sigmadelta_set_duty(sigmadelta_channel_t channel, int8_t duty)
105 {
106     SIGMADELTA_CHECK(channel < SIGMADELTA_CHANNEL_MAX, "sigmadelta channel error", ESP_ERR_INVALID_ARG);
107     return _sigmadelta_set_duty(SIGMADELTA_PORT_0, channel, duty);
108 }
109 
sigmadelta_set_prescale(sigmadelta_channel_t channel,uint8_t prescale)110 esp_err_t sigmadelta_set_prescale(sigmadelta_channel_t channel, uint8_t prescale)
111 {
112     SIGMADELTA_CHECK(channel < SIGMADELTA_CHANNEL_MAX, "sigmadelta channel error", ESP_ERR_INVALID_ARG);
113     return _sigmadelta_set_prescale(SIGMADELTA_PORT_0, channel, prescale);
114 }
115 
sigmadelta_set_pin(sigmadelta_channel_t channel,gpio_num_t gpio_num)116 esp_err_t sigmadelta_set_pin(sigmadelta_channel_t channel, gpio_num_t gpio_num)
117 {
118     SIGMADELTA_CHECK(channel < SIGMADELTA_CHANNEL_MAX, "sigmadelta channel error", ESP_ERR_INVALID_ARG);
119     SIGMADELTA_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "sigmadelta gpio num error", ESP_ERR_INVALID_ARG);
120     return _sigmadelta_set_pin(SIGMADELTA_PORT_0, channel, gpio_num);
121 }
122 
sigmadelta_config(const sigmadelta_config_t * config)123 esp_err_t sigmadelta_config(const sigmadelta_config_t *config)
124 {
125     SIGMADELTA_CHECK(config->channel < SIGMADELTA_CHANNEL_MAX, "sigmadelta channel error", ESP_ERR_INVALID_ARG);
126     SIGMADELTA_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(config->sigmadelta_gpio), "sigmadelta gpio num error", ESP_ERR_INVALID_ARG);
127     esp_err_t ret;
128 
129     if ((p_sigmadelta_obj[SIGMADELTA_PORT_0]) == NULL) {
130         ret = sigmadelta_init(SIGMADELTA_PORT_0);
131         if (ret != ESP_OK) {
132             return ret;
133         }
134     }
135     return _sigmadelta_config(SIGMADELTA_PORT_0, config);
136 }
137