rmt.c 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735
  1. // Copyright 2015-2016 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. // http://www.apache.org/licenses/LICENSE-2.0
  7. //
  8. // Unless required by applicable law or agreed to in writing, software
  9. // distributed under the License is distributed on an "AS IS" BASIS,
  10. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. // See the License for the specific language governing permissions and
  12. // limitations under the License.
  13. #include <esp_types.h>
  14. #include <string.h>
  15. #include <stdlib.h>
  16. #include "freertos/FreeRTOS.h"
  17. #include "freertos/semphr.h"
  18. #include "freertos/xtensa_api.h"
  19. #include "freertos/ringbuf.h"
  20. #include "esp_intr.h"
  21. #include "esp_log.h"
  22. #include "esp_err.h"
  23. #include "esp_intr_alloc.h"
  24. #include "soc/gpio_sig_map.h"
  25. #include "soc/rmt_struct.h"
  26. #include "driver/periph_ctrl.h"
  27. #include "driver/rmt.h"
  28. #define RMT_SOUCCE_CLK_APB (APB_CLK_FREQ) /*!< RMT source clock is APB_CLK */
  29. #define RMT_SOURCE_CLK_REF (1 * 1000000) /*!< not used yet */
  30. #define RMT_SOURCE_CLK(select) ((select == RMT_BASECLK_REF) ? (RMT_SOURCE_CLK_REF) : (RMT_SOUCCE_CLK_APB)) /*! RMT source clock frequency */
  31. #define RMT_CHANNEL_ERROR_STR "RMT CHANNEL ERR"
  32. #define RMT_ADDR_ERROR_STR "RMT ADDRESS ERR"
  33. #define RMT_MEM_CNT_ERROR_STR "RMT MEM BLOCK NUM ERR"
  34. #define RMT_CARRIER_ERROR_STR "RMT CARRIER LEVEL ERR"
  35. #define RMT_MEM_OWNER_ERROR_STR "RMT MEM OWNER_ERR"
  36. #define RMT_BASECLK_ERROR_STR "RMT BASECLK ERR"
  37. #define RMT_WR_MEM_OVF_ERROR_STR "RMT WR MEM OVERFLOW"
  38. #define RMT_GPIO_ERROR_STR "RMT GPIO ERROR"
  39. #define RMT_MODE_ERROR_STR "RMT MODE ERROR"
  40. #define RMT_CLK_DIV_ERROR_STR "RMT CLK DIV ERR"
  41. #define RMT_DRIVER_ERROR_STR "RMT DRIVER ERR"
  42. #define RMT_DRIVER_LENGTH_ERROR_STR "RMT PARAM LEN ERROR"
  43. static const char* RMT_TAG = "rmt";
  44. static bool s_rmt_driver_installed = false;
  45. static rmt_isr_handle_t s_rmt_driver_intr_handle;
  46. #define RMT_CHECK(a, str, ret_val) \
  47. if (!(a)) { \
  48. ESP_LOGE(RMT_TAG,"%s(%d): %s", __FUNCTION__, __LINE__, str); \
  49. return (ret_val); \
  50. }
  51. static portMUX_TYPE rmt_spinlock = portMUX_INITIALIZER_UNLOCKED;
  52. typedef struct {
  53. int tx_offset;
  54. int tx_len_rem;
  55. int tx_sub_len;
  56. rmt_channel_t channel;
  57. const rmt_item32_t* tx_data;
  58. xSemaphoreHandle tx_sem;
  59. RingbufHandle_t tx_buf;
  60. RingbufHandle_t rx_buf;
  61. } rmt_obj_t;
  62. rmt_obj_t* p_rmt_obj[RMT_CHANNEL_MAX] = {0};
  63. static void rmt_set_tx_wrap_en(rmt_channel_t channel, bool en)
  64. {
  65. portENTER_CRITICAL(&rmt_spinlock);
  66. RMT.apb_conf.mem_tx_wrap_en = en;
  67. portEXIT_CRITICAL(&rmt_spinlock);
  68. }
  69. static void rmt_set_data_mode(rmt_data_mode_t data_mode)
  70. {
  71. portENTER_CRITICAL(&rmt_spinlock);
  72. RMT.apb_conf.fifo_mask = data_mode;
  73. portEXIT_CRITICAL(&rmt_spinlock);
  74. }
  75. esp_err_t rmt_set_clk_div(rmt_channel_t channel, uint8_t div_cnt)
  76. {
  77. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  78. RMT.conf_ch[channel].conf0.div_cnt = div_cnt;
  79. return ESP_OK;
  80. }
  81. esp_err_t rmt_get_clk_div(rmt_channel_t channel, uint8_t* div_cnt)
  82. {
  83. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  84. RMT_CHECK(div_cnt != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  85. *div_cnt = RMT.conf_ch[channel].conf0.div_cnt;
  86. return ESP_OK;
  87. }
  88. esp_err_t rmt_set_rx_idle_thresh(rmt_channel_t channel, uint16_t thresh)
  89. {
  90. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  91. RMT.conf_ch[channel].conf0.idle_thres = thresh;
  92. return ESP_OK;
  93. }
  94. esp_err_t rmt_get_rx_idle_thresh(rmt_channel_t channel, uint16_t *thresh)
  95. {
  96. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  97. RMT_CHECK(thresh != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  98. *thresh = RMT.conf_ch[channel].conf0.idle_thres;
  99. return ESP_OK;
  100. }
  101. esp_err_t rmt_set_mem_block_num(rmt_channel_t channel, uint8_t rmt_mem_num)
  102. {
  103. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  104. RMT_CHECK(rmt_mem_num < 16, RMT_MEM_CNT_ERROR_STR, ESP_ERR_INVALID_ARG);
  105. RMT.conf_ch[channel].conf0.mem_size = rmt_mem_num;
  106. return ESP_OK;
  107. }
  108. esp_err_t rmt_get_mem_block_num(rmt_channel_t channel, uint8_t* rmt_mem_num)
  109. {
  110. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  111. RMT_CHECK(rmt_mem_num != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  112. *rmt_mem_num = RMT.conf_ch[channel].conf0.mem_size;
  113. return ESP_OK;
  114. }
  115. esp_err_t rmt_set_tx_carrier(rmt_channel_t channel, bool carrier_en, uint16_t high_level, uint16_t low_level,
  116. rmt_carrier_level_t carrier_level)
  117. {
  118. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  119. RMT_CHECK(carrier_level < RMT_CARRIER_LEVEL_MAX, RMT_CARRIER_ERROR_STR, ESP_ERR_INVALID_ARG);
  120. RMT.carrier_duty_ch[channel].high = high_level;
  121. RMT.carrier_duty_ch[channel].low = low_level;
  122. RMT.conf_ch[channel].conf0.carrier_out_lv = carrier_level;
  123. RMT.conf_ch[channel].conf0.carrier_en = carrier_en;
  124. return ESP_OK;
  125. }
  126. esp_err_t rmt_set_mem_pd(rmt_channel_t channel, bool pd_en)
  127. {
  128. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  129. RMT.conf_ch[channel].conf0.mem_pd = pd_en;
  130. return ESP_OK;
  131. }
  132. esp_err_t rmt_get_mem_pd(rmt_channel_t channel, bool* pd_en)
  133. {
  134. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  135. *pd_en = (bool) RMT.conf_ch[channel].conf0.mem_pd;
  136. return ESP_OK;
  137. }
  138. esp_err_t rmt_tx_start(rmt_channel_t channel, bool tx_idx_rst)
  139. {
  140. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  141. portENTER_CRITICAL(&rmt_spinlock);
  142. if(tx_idx_rst) {
  143. RMT.conf_ch[channel].conf1.mem_rd_rst = 1;
  144. }
  145. RMT.conf_ch[channel].conf1.mem_owner = RMT_MEM_OWNER_TX;
  146. RMT.conf_ch[channel].conf1.tx_start = 1;
  147. portEXIT_CRITICAL(&rmt_spinlock);
  148. return ESP_OK;
  149. }
  150. esp_err_t rmt_tx_stop(rmt_channel_t channel)
  151. {
  152. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  153. portENTER_CRITICAL(&rmt_spinlock);
  154. RMT.conf_ch[channel].conf1.tx_start = 0;
  155. portEXIT_CRITICAL(&rmt_spinlock);
  156. return ESP_OK;
  157. }
  158. esp_err_t rmt_rx_start(rmt_channel_t channel, bool rx_idx_rst)
  159. {
  160. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  161. portENTER_CRITICAL(&rmt_spinlock);
  162. if(rx_idx_rst) {
  163. RMT.conf_ch[channel].conf1.mem_wr_rst = 1;
  164. }
  165. RMT.conf_ch[channel].conf1.rx_en = 0;
  166. RMT.conf_ch[channel].conf1.mem_owner = RMT_MEM_OWNER_RX;
  167. RMT.conf_ch[channel].conf1.rx_en = 1;
  168. portEXIT_CRITICAL(&rmt_spinlock);
  169. return ESP_OK;
  170. }
  171. esp_err_t rmt_rx_stop(rmt_channel_t channel)
  172. {
  173. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  174. portENTER_CRITICAL(&rmt_spinlock);
  175. RMT.conf_ch[channel].conf1.rx_en = 0;
  176. portEXIT_CRITICAL(&rmt_spinlock);
  177. return ESP_OK;
  178. }
  179. esp_err_t rmt_memory_rw_rst(rmt_channel_t channel)
  180. {
  181. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  182. portENTER_CRITICAL(&rmt_spinlock);
  183. RMT.conf_ch[channel].conf1.mem_rd_rst = 1;
  184. RMT.conf_ch[channel].conf1.mem_wr_rst = 1;
  185. portEXIT_CRITICAL(&rmt_spinlock);
  186. return ESP_OK;
  187. }
  188. esp_err_t rmt_set_memory_owner(rmt_channel_t channel, rmt_mem_owner_t owner)
  189. {
  190. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  191. RMT_CHECK(owner < RMT_MEM_OWNER_MAX, RMT_MEM_OWNER_ERROR_STR, ESP_ERR_INVALID_ARG);
  192. portENTER_CRITICAL(&rmt_spinlock);
  193. RMT.conf_ch[channel].conf1.mem_owner = owner;
  194. portEXIT_CRITICAL(&rmt_spinlock);
  195. return ESP_OK;
  196. }
  197. esp_err_t rmt_get_memory_owner(rmt_channel_t channel, rmt_mem_owner_t* owner)
  198. {
  199. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  200. RMT_CHECK(owner != NULL, RMT_MEM_OWNER_ERROR_STR, ESP_ERR_INVALID_ARG);
  201. *owner = (rmt_mem_owner_t) RMT.conf_ch[channel].conf1.mem_owner;
  202. return ESP_OK;
  203. }
  204. esp_err_t rmt_set_tx_loop_mode(rmt_channel_t channel, bool loop_en)
  205. {
  206. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  207. portENTER_CRITICAL(&rmt_spinlock);
  208. RMT.conf_ch[channel].conf1.tx_conti_mode = loop_en;
  209. portEXIT_CRITICAL(&rmt_spinlock);
  210. return ESP_OK;
  211. }
  212. esp_err_t rmt_get_tx_loop_mode(rmt_channel_t channel, bool* loop_en)
  213. {
  214. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  215. *loop_en = (bool) RMT.conf_ch[channel].conf1.tx_conti_mode;
  216. return ESP_OK;
  217. }
  218. esp_err_t rmt_set_rx_filter(rmt_channel_t channel, bool rx_filter_en, uint8_t thresh)
  219. {
  220. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  221. portENTER_CRITICAL(&rmt_spinlock);
  222. RMT.conf_ch[channel].conf1.rx_filter_en = rx_filter_en;
  223. RMT.conf_ch[channel].conf1.rx_filter_thres = thresh;
  224. portEXIT_CRITICAL(&rmt_spinlock);
  225. return ESP_OK;
  226. }
  227. esp_err_t rmt_set_source_clk(rmt_channel_t channel, rmt_source_clk_t base_clk)
  228. {
  229. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  230. RMT_CHECK(base_clk < RMT_BASECLK_MAX, RMT_BASECLK_ERROR_STR, ESP_ERR_INVALID_ARG);
  231. portENTER_CRITICAL(&rmt_spinlock);
  232. RMT.conf_ch[channel].conf1.ref_always_on = base_clk;
  233. portEXIT_CRITICAL(&rmt_spinlock);
  234. return ESP_OK;
  235. }
  236. esp_err_t rmt_get_source_clk(rmt_channel_t channel, rmt_source_clk_t* src_clk)
  237. {
  238. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  239. *src_clk = (rmt_source_clk_t) (RMT.conf_ch[channel].conf1.ref_always_on);
  240. return ESP_OK;
  241. }
  242. esp_err_t rmt_set_idle_level(rmt_channel_t channel, bool idle_out_en, rmt_idle_level_t level)
  243. {
  244. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  245. RMT_CHECK(level < RMT_IDLE_LEVEL_MAX, "RMT IDLE LEVEL ERR", ESP_ERR_INVALID_ARG);
  246. portENTER_CRITICAL(&rmt_spinlock);
  247. RMT.conf_ch[channel].conf1.idle_out_en = idle_out_en;
  248. RMT.conf_ch[channel].conf1.idle_out_lv = level;
  249. portEXIT_CRITICAL(&rmt_spinlock);
  250. return ESP_OK;
  251. }
  252. esp_err_t rmt_get_status(rmt_channel_t channel, uint32_t* status)
  253. {
  254. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  255. *status = RMT.status_ch[channel];
  256. return ESP_OK;
  257. }
  258. rmt_data_mode_t rmt_get_data_mode()
  259. {
  260. return (rmt_data_mode_t) (RMT.apb_conf.fifo_mask);
  261. }
  262. void rmt_set_intr_enable_mask(uint32_t mask)
  263. {
  264. portENTER_CRITICAL(&rmt_spinlock);
  265. RMT.int_ena.val |= mask;
  266. portEXIT_CRITICAL(&rmt_spinlock);
  267. }
  268. void rmt_clr_intr_enable_mask(uint32_t mask)
  269. {
  270. portENTER_CRITICAL(&rmt_spinlock);
  271. RMT.int_ena.val &= (~mask);
  272. portEXIT_CRITICAL(&rmt_spinlock);
  273. }
  274. esp_err_t rmt_set_rx_intr_en(rmt_channel_t channel, bool en)
  275. {
  276. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  277. if(en) {
  278. rmt_set_intr_enable_mask(BIT(channel * 3 + 1));
  279. } else {
  280. rmt_clr_intr_enable_mask(BIT(channel * 3 + 1));
  281. }
  282. return ESP_OK;
  283. }
  284. esp_err_t rmt_set_err_intr_en(rmt_channel_t channel, bool en)
  285. {
  286. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  287. if(en) {
  288. rmt_set_intr_enable_mask(BIT(channel * 3 + 2));
  289. } else {
  290. rmt_clr_intr_enable_mask(BIT(channel * 3 + 2));
  291. }
  292. return ESP_OK;
  293. }
  294. esp_err_t rmt_set_tx_intr_en(rmt_channel_t channel, bool en)
  295. {
  296. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  297. if(en) {
  298. rmt_set_intr_enable_mask(BIT(channel * 3));
  299. } else {
  300. rmt_clr_intr_enable_mask(BIT(channel * 3));
  301. }
  302. return ESP_OK;
  303. }
  304. esp_err_t rmt_set_tx_thr_intr_en(rmt_channel_t channel, bool en, uint16_t evt_thresh)
  305. {
  306. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  307. if(en) {
  308. RMT_CHECK(evt_thresh < 256, "RMT EVT THRESH ERR", ESP_ERR_INVALID_ARG);
  309. RMT.tx_lim_ch[channel].limit = evt_thresh;
  310. rmt_set_tx_wrap_en(channel, true);
  311. rmt_set_intr_enable_mask(BIT(channel + 24));
  312. } else {
  313. rmt_clr_intr_enable_mask(BIT(channel + 24));
  314. }
  315. return ESP_OK;
  316. }
  317. esp_err_t rmt_set_pin(rmt_channel_t channel, rmt_mode_t mode, gpio_num_t gpio_num)
  318. {
  319. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  320. RMT_CHECK(mode < RMT_MODE_MAX, RMT_MODE_ERROR_STR, ESP_ERR_INVALID_ARG);
  321. RMT_CHECK(((GPIO_IS_VALID_GPIO(gpio_num) && (mode == RMT_MODE_RX)) || (GPIO_IS_VALID_OUTPUT_GPIO(gpio_num) && (mode == RMT_MODE_TX))),
  322. RMT_GPIO_ERROR_STR, ESP_ERR_INVALID_ARG);
  323. PIN_FUNC_SELECT(GPIO_PIN_MUX_REG[gpio_num], 2);
  324. if(mode == RMT_MODE_TX) {
  325. gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
  326. gpio_matrix_out(gpio_num, RMT_SIG_OUT0_IDX + channel, 0, 0);
  327. } else {
  328. gpio_set_direction(gpio_num, GPIO_MODE_INPUT);
  329. gpio_matrix_in(gpio_num, RMT_SIG_IN0_IDX + channel, 0);
  330. }
  331. return ESP_OK;
  332. }
  333. esp_err_t rmt_config(const rmt_config_t* rmt_param)
  334. {
  335. uint8_t mode = rmt_param->rmt_mode;
  336. uint8_t channel = rmt_param->channel;
  337. uint8_t gpio_num = rmt_param->gpio_num;
  338. uint8_t mem_cnt = rmt_param->mem_block_num;
  339. int clk_div = rmt_param->clk_div;
  340. uint32_t carrier_freq_hz = rmt_param->tx_config.carrier_freq_hz;
  341. bool carrier_en = rmt_param->tx_config.carrier_en;
  342. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  343. RMT_CHECK(GPIO_IS_VALID_GPIO(gpio_num), RMT_GPIO_ERROR_STR, ESP_ERR_INVALID_ARG);
  344. RMT_CHECK((mem_cnt + channel <= 8 && mem_cnt > 0), RMT_MEM_CNT_ERROR_STR, ESP_ERR_INVALID_ARG);
  345. RMT_CHECK((clk_div > 0), RMT_CLK_DIV_ERROR_STR, ESP_ERR_INVALID_ARG);
  346. if (mode == RMT_MODE_TX) {
  347. RMT_CHECK((!carrier_en || carrier_freq_hz > 0), "RMT carrier frequency can't be zero", ESP_ERR_INVALID_ARG);
  348. }
  349. periph_module_enable(PERIPH_RMT_MODULE);
  350. RMT.conf_ch[channel].conf0.div_cnt = clk_div;
  351. /*Visit data use memory not FIFO*/
  352. rmt_set_data_mode(RMT_DATA_MODE_MEM);
  353. /*Reset tx/rx memory index */
  354. portENTER_CRITICAL(&rmt_spinlock);
  355. RMT.conf_ch[channel].conf1.mem_rd_rst = 1;
  356. RMT.conf_ch[channel].conf1.mem_wr_rst = 1;
  357. portEXIT_CRITICAL(&rmt_spinlock);
  358. if(mode == RMT_MODE_TX) {
  359. uint32_t rmt_source_clk_hz = 0;
  360. uint16_t carrier_duty_percent = rmt_param->tx_config.carrier_duty_percent;
  361. uint8_t carrier_level = rmt_param->tx_config.carrier_level;
  362. uint8_t idle_level = rmt_param->tx_config.idle_level;
  363. portENTER_CRITICAL(&rmt_spinlock);
  364. RMT.conf_ch[channel].conf1.tx_conti_mode = rmt_param->tx_config.loop_en;
  365. /*Memory set block number*/
  366. RMT.conf_ch[channel].conf0.mem_size = mem_cnt;
  367. RMT.conf_ch[channel].conf1.mem_owner = RMT_MEM_OWNER_TX;
  368. /*We use APB clock in this version, which is 80Mhz, later we will release system reference clock*/
  369. RMT.conf_ch[channel].conf1.ref_always_on = RMT_BASECLK_APB;
  370. rmt_source_clk_hz = RMT_SOURCE_CLK(RMT_BASECLK_APB);
  371. /*Set idle level */
  372. RMT.conf_ch[channel].conf1.idle_out_en = rmt_param->tx_config.idle_output_en;
  373. RMT.conf_ch[channel].conf1.idle_out_lv = idle_level;
  374. portEXIT_CRITICAL(&rmt_spinlock);
  375. /*Set carrier*/
  376. RMT.conf_ch[channel].conf0.carrier_en = carrier_en;
  377. if (carrier_en) {
  378. uint32_t duty_div, duty_h, duty_l;
  379. duty_div = rmt_source_clk_hz / carrier_freq_hz;
  380. duty_h = duty_div * carrier_duty_percent / 100;
  381. duty_l = duty_div - duty_h;
  382. RMT.conf_ch[channel].conf0.carrier_out_lv = carrier_level;
  383. RMT.carrier_duty_ch[channel].high = duty_h;
  384. RMT.carrier_duty_ch[channel].low = duty_l;
  385. } else {
  386. RMT.conf_ch[channel].conf0.carrier_out_lv = 0;
  387. RMT.carrier_duty_ch[channel].high = 0;
  388. RMT.carrier_duty_ch[channel].low = 0;
  389. }
  390. ESP_LOGD(RMT_TAG, "Rmt Tx Channel %u|Gpio %u|Sclk_Hz %u|Div %u|Carrier_Hz %u|Duty %u",
  391. channel, gpio_num, rmt_source_clk_hz, clk_div, carrier_freq_hz, carrier_duty_percent);
  392. }
  393. else if(RMT_MODE_RX == mode) {
  394. uint8_t filter_cnt = rmt_param->rx_config.filter_ticks_thresh;
  395. uint16_t threshold = rmt_param->rx_config.idle_threshold;
  396. portENTER_CRITICAL(&rmt_spinlock);
  397. /*clock init*/
  398. RMT.conf_ch[channel].conf1.ref_always_on = RMT_BASECLK_APB;
  399. uint32_t rmt_source_clk_hz = RMT_SOURCE_CLK(RMT_BASECLK_APB);
  400. /*memory set block number and owner*/
  401. RMT.conf_ch[channel].conf0.mem_size = mem_cnt;
  402. RMT.conf_ch[channel].conf1.mem_owner = RMT_MEM_OWNER_RX;
  403. /*Set idle threshold*/
  404. RMT.conf_ch[channel].conf0.idle_thres = threshold;
  405. /* Set RX filter */
  406. RMT.conf_ch[channel].conf1.rx_filter_thres = filter_cnt;
  407. RMT.conf_ch[channel].conf1.rx_filter_en = rmt_param->rx_config.filter_en;
  408. portEXIT_CRITICAL(&rmt_spinlock);
  409. ESP_LOGD(RMT_TAG, "Rmt Rx Channel %u|Gpio %u|Sclk_Hz %u|Div %u|Thresold %u|Filter %u",
  410. channel, gpio_num, rmt_source_clk_hz, clk_div, threshold, filter_cnt);
  411. }
  412. rmt_set_pin(channel, mode, gpio_num);
  413. return ESP_OK;
  414. }
  415. static void IRAM_ATTR rmt_fill_memory(rmt_channel_t channel, const rmt_item32_t* item, uint16_t item_num, uint16_t mem_offset)
  416. {
  417. portENTER_CRITICAL(&rmt_spinlock);
  418. RMT.apb_conf.fifo_mask = RMT_DATA_MODE_MEM;
  419. portEXIT_CRITICAL(&rmt_spinlock);
  420. int i;
  421. for(i = 0; i < item_num; i++) {
  422. RMTMEM.chan[channel].data32[i + mem_offset].val = item[i].val;
  423. }
  424. }
  425. esp_err_t rmt_fill_tx_items(rmt_channel_t channel, const rmt_item32_t* item, uint16_t item_num, uint16_t mem_offset)
  426. {
  427. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, (0));
  428. RMT_CHECK((item != NULL), RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  429. RMT_CHECK((item_num > 0), RMT_DRIVER_LENGTH_ERROR_STR, ESP_ERR_INVALID_ARG);
  430. /*Each block has 64 x 32 bits of data*/
  431. uint8_t mem_cnt = RMT.conf_ch[channel].conf0.mem_size;
  432. RMT_CHECK((mem_cnt * RMT_MEM_ITEM_NUM >= item_num), RMT_WR_MEM_OVF_ERROR_STR, ESP_ERR_INVALID_ARG);
  433. rmt_fill_memory(channel, item, item_num, mem_offset);
  434. return ESP_OK;
  435. }
  436. esp_err_t rmt_isr_register(void (*fn)(void*), void * arg, int intr_alloc_flags, rmt_isr_handle_t *handle)
  437. {
  438. esp_err_t ret;
  439. RMT_CHECK((fn != NULL), RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  440. RMT_CHECK(s_rmt_driver_installed == false, "RMT DRIVER INSTALLED, CAN NOT REG ISR HANDLER", ESP_FAIL);
  441. portENTER_CRITICAL(&rmt_spinlock);
  442. ret=esp_intr_alloc(ETS_RMT_INTR_SOURCE, intr_alloc_flags, fn, arg, handle);
  443. portEXIT_CRITICAL(&rmt_spinlock);
  444. return ret;
  445. }
  446. esp_err_t rmt_isr_deregister(rmt_isr_handle_t handle)
  447. {
  448. return esp_intr_free(handle);
  449. }
  450. static int IRAM_ATTR rmt_get_mem_len(rmt_channel_t channel)
  451. {
  452. int block_num = RMT.conf_ch[channel].conf0.mem_size;
  453. int item_block_len = block_num * RMT_MEM_ITEM_NUM;
  454. volatile rmt_item32_t* data = RMTMEM.chan[channel].data32;
  455. int idx;
  456. for(idx = 0; idx < item_block_len; idx++) {
  457. if(data[idx].duration0 == 0) {
  458. return idx;
  459. } else if(data[idx].duration1 == 0) {
  460. return idx + 1;
  461. }
  462. }
  463. return idx;
  464. }
  465. static void IRAM_ATTR rmt_driver_isr_default(void* arg)
  466. {
  467. uint32_t intr_st = RMT.int_st.val;
  468. uint32_t i = 0;
  469. uint8_t channel;
  470. portBASE_TYPE HPTaskAwoken = 0;
  471. for(i = 0; i < 32; i++) {
  472. if(i < 24) {
  473. if(intr_st & (BIT(i))) {
  474. channel = i / 3;
  475. rmt_obj_t* p_rmt = p_rmt_obj[channel];
  476. switch(i % 3) {
  477. //TX END
  478. case 0:
  479. ESP_EARLY_LOGD(RMT_TAG, "RMT INTR : TX END");
  480. xSemaphoreGiveFromISR(p_rmt->tx_sem, &HPTaskAwoken);
  481. if(HPTaskAwoken == pdTRUE) {
  482. portYIELD_FROM_ISR();
  483. }
  484. p_rmt->tx_data = NULL;
  485. p_rmt->tx_len_rem = 0;
  486. p_rmt->tx_offset = 0;
  487. p_rmt->tx_sub_len = 0;
  488. break;
  489. //RX_END
  490. case 1:
  491. ESP_EARLY_LOGD(RMT_TAG, "RMT INTR : RX END");
  492. RMT.conf_ch[channel].conf1.rx_en = 0;
  493. int item_len = rmt_get_mem_len(channel);
  494. //change memory owner to protect data.
  495. RMT.conf_ch[channel].conf1.mem_owner = RMT_MEM_OWNER_TX;
  496. if(p_rmt->rx_buf) {
  497. BaseType_t res = xRingbufferSendFromISR(p_rmt->rx_buf, (void*) RMTMEM.chan[channel].data32, item_len * 4, &HPTaskAwoken);
  498. if(res == pdFALSE) {
  499. ESP_EARLY_LOGE(RMT_TAG, "RMT RX BUFFER FULL");
  500. } else {
  501. }
  502. if(HPTaskAwoken == pdTRUE) {
  503. portYIELD_FROM_ISR();
  504. }
  505. } else {
  506. ESP_EARLY_LOGE(RMT_TAG, "RMT RX BUFFER ERROR\n");
  507. }
  508. RMT.conf_ch[channel].conf1.mem_wr_rst = 1;
  509. RMT.conf_ch[channel].conf1.mem_owner = RMT_MEM_OWNER_RX;
  510. RMT.conf_ch[channel].conf1.rx_en = 1;
  511. break;
  512. //ERR
  513. case 2:
  514. ESP_EARLY_LOGE(RMT_TAG, "RMT[%d] ERR", channel);
  515. ESP_EARLY_LOGE(RMT_TAG, "status: 0x%08x", RMT.status_ch[channel]);
  516. RMT.int_ena.val &= (~(BIT(i)));
  517. break;
  518. default:
  519. break;
  520. }
  521. RMT.int_clr.val = BIT(i);
  522. }
  523. } else {
  524. if(intr_st & (BIT(i))) {
  525. channel = i - 24;
  526. rmt_obj_t* p_rmt = p_rmt_obj[channel];
  527. RMT.int_clr.val = BIT(i);
  528. ESP_EARLY_LOGD(RMT_TAG, "RMT CH[%d]: EVT INTR", channel);
  529. if(p_rmt->tx_data == NULL) {
  530. //skip
  531. } else {
  532. const rmt_item32_t* pdata = p_rmt->tx_data;
  533. int len_rem = p_rmt->tx_len_rem;
  534. if(len_rem >= p_rmt->tx_sub_len) {
  535. rmt_fill_memory(channel, pdata, p_rmt->tx_sub_len, p_rmt->tx_offset);
  536. p_rmt->tx_data += p_rmt->tx_sub_len;
  537. p_rmt->tx_len_rem -= p_rmt->tx_sub_len;
  538. } else if(len_rem == 0) {
  539. RMTMEM.chan[channel].data32[p_rmt->tx_offset].val = 0;
  540. } else {
  541. rmt_fill_memory(channel, pdata, len_rem, p_rmt->tx_offset);
  542. RMTMEM.chan[channel].data32[p_rmt->tx_offset + len_rem].val = 0;
  543. p_rmt->tx_data += len_rem;
  544. p_rmt->tx_len_rem -= len_rem;
  545. }
  546. if(p_rmt->tx_offset == 0) {
  547. p_rmt->tx_offset = p_rmt->tx_sub_len;
  548. } else {
  549. p_rmt->tx_offset = 0;
  550. }
  551. }
  552. }
  553. }
  554. }
  555. }
  556. esp_err_t rmt_driver_uninstall(rmt_channel_t channel)
  557. {
  558. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  559. if(p_rmt_obj[channel] == NULL) {
  560. return ESP_OK;
  561. }
  562. xSemaphoreTake(p_rmt_obj[channel]->tx_sem, portMAX_DELAY);
  563. rmt_set_rx_intr_en(channel, 0);
  564. rmt_set_err_intr_en(channel, 0);
  565. rmt_set_tx_intr_en(channel, 0);
  566. rmt_set_tx_thr_intr_en(channel, 0, 0xffff);
  567. if(p_rmt_obj[channel]->tx_sem) {
  568. vSemaphoreDelete(p_rmt_obj[channel]->tx_sem);
  569. p_rmt_obj[channel]->tx_sem = NULL;
  570. }
  571. if(p_rmt_obj[channel]->rx_buf) {
  572. vRingbufferDelete(p_rmt_obj[channel]->rx_buf);
  573. p_rmt_obj[channel]->rx_buf = NULL;
  574. }
  575. free(p_rmt_obj[channel]);
  576. p_rmt_obj[channel] = NULL;
  577. s_rmt_driver_installed = false;
  578. return rmt_isr_deregister(s_rmt_driver_intr_handle);
  579. }
  580. esp_err_t rmt_driver_install(rmt_channel_t channel, size_t rx_buf_size, int intr_alloc_flags)
  581. {
  582. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  583. if(p_rmt_obj[channel] != NULL) {
  584. ESP_LOGD(RMT_TAG, "RMT driver already installed");
  585. return ESP_ERR_INVALID_STATE;
  586. }
  587. p_rmt_obj[channel] = (rmt_obj_t*) malloc(sizeof(rmt_obj_t));
  588. if(p_rmt_obj[channel] == NULL) {
  589. ESP_LOGE(RMT_TAG, "RMT driver malloc error");
  590. return ESP_ERR_NO_MEM;
  591. }
  592. memset(p_rmt_obj[channel], 0, sizeof(rmt_obj_t));
  593. p_rmt_obj[channel]->tx_len_rem = 0;
  594. p_rmt_obj[channel]->tx_data = NULL;
  595. p_rmt_obj[channel]->channel = channel;
  596. p_rmt_obj[channel]->tx_offset = 0;
  597. p_rmt_obj[channel]->tx_sub_len = 0;
  598. if(p_rmt_obj[channel]->tx_sem == NULL) {
  599. p_rmt_obj[channel]->tx_sem = xSemaphoreCreateBinary();
  600. xSemaphoreGive(p_rmt_obj[channel]->tx_sem);
  601. }
  602. if(p_rmt_obj[channel]->rx_buf == NULL && rx_buf_size > 0) {
  603. p_rmt_obj[channel]->rx_buf = xRingbufferCreate(rx_buf_size, RINGBUF_TYPE_NOSPLIT);
  604. rmt_set_rx_intr_en(channel, 1);
  605. rmt_set_err_intr_en(channel, 1);
  606. }
  607. if(s_rmt_driver_installed == false) {
  608. rmt_isr_register(rmt_driver_isr_default, NULL, intr_alloc_flags, &s_rmt_driver_intr_handle);
  609. s_rmt_driver_installed = true;
  610. }
  611. rmt_set_tx_intr_en(channel, 1);
  612. return ESP_OK;
  613. }
  614. esp_err_t rmt_write_items(rmt_channel_t channel, const rmt_item32_t* rmt_item, int item_num, bool wait_tx_done)
  615. {
  616. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  617. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  618. RMT_CHECK(rmt_item != NULL, RMT_ADDR_ERROR_STR, ESP_FAIL);
  619. RMT_CHECK(item_num > 0, RMT_DRIVER_LENGTH_ERROR_STR, ESP_ERR_INVALID_ARG);
  620. rmt_obj_t* p_rmt = p_rmt_obj[channel];
  621. int block_num = RMT.conf_ch[channel].conf0.mem_size;
  622. int item_block_len = block_num * RMT_MEM_ITEM_NUM;
  623. int item_sub_len = block_num * RMT_MEM_ITEM_NUM / 2;
  624. int len_rem = item_num;
  625. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  626. // fill the memory block first
  627. if(item_num >= item_block_len) {
  628. rmt_fill_memory(channel, rmt_item, item_block_len, 0);
  629. RMT.tx_lim_ch[channel].limit = item_sub_len;
  630. RMT.apb_conf.mem_tx_wrap_en = 1;
  631. len_rem -= item_block_len;
  632. RMT.conf_ch[channel].conf1.tx_conti_mode = 0;
  633. rmt_set_tx_thr_intr_en(channel, 1, item_sub_len);
  634. p_rmt->tx_data = rmt_item + item_block_len;
  635. p_rmt->tx_len_rem = len_rem;
  636. p_rmt->tx_offset = 0;
  637. p_rmt->tx_sub_len = item_sub_len;
  638. } else {
  639. rmt_fill_memory(channel, rmt_item, len_rem, 0);
  640. RMTMEM.chan[channel].data32[len_rem].val = 0;
  641. len_rem = 0;
  642. }
  643. rmt_tx_start(channel, true);
  644. if(wait_tx_done) {
  645. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  646. xSemaphoreGive(p_rmt->tx_sem);
  647. }
  648. return ESP_OK;
  649. }
  650. esp_err_t rmt_wait_tx_done(rmt_channel_t channel)
  651. {
  652. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  653. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  654. xSemaphoreTake(p_rmt_obj[channel]->tx_sem, portMAX_DELAY);
  655. xSemaphoreGive(p_rmt_obj[channel]->tx_sem);
  656. return ESP_OK;
  657. }
  658. esp_err_t rmt_get_ringbuf_handler(rmt_channel_t channel, RingbufHandle_t* buf_handler)
  659. {
  660. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  661. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  662. RMT_CHECK(buf_handler != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  663. *buf_handler = p_rmt_obj[channel]->rx_buf;
  664. return ESP_OK;
  665. }