rmt.c 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344
  1. // Copyright 2015-2020 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. #include <stdlib.h>
  15. #include <string.h>
  16. #include <sys/lock.h>
  17. #include "esp_compiler.h"
  18. #include "esp_intr_alloc.h"
  19. #include "esp_log.h"
  20. #include "driver/gpio.h"
  21. #include "driver/periph_ctrl.h"
  22. #include "driver/rmt.h"
  23. #include "freertos/FreeRTOS.h"
  24. #include "freertos/task.h"
  25. #include "freertos/semphr.h"
  26. #include "freertos/ringbuf.h"
  27. #include "soc/soc_memory_layout.h"
  28. #include "soc/rmt_periph.h"
  29. #include "soc/rtc.h"
  30. #include "hal/rmt_hal.h"
  31. #include "hal/rmt_ll.h"
  32. #include "esp_rom_gpio.h"
  33. #define RMT_CHANNEL_ERROR_STR "RMT CHANNEL ERR"
  34. #define RMT_ADDR_ERROR_STR "RMT ADDRESS ERR"
  35. #define RMT_MEM_CNT_ERROR_STR "RMT MEM BLOCK NUM ERR"
  36. #define RMT_CARRIER_ERROR_STR "RMT CARRIER LEVEL ERR"
  37. #define RMT_MEM_OWNER_ERROR_STR "RMT MEM OWNER_ERR"
  38. #define RMT_BASECLK_ERROR_STR "RMT BASECLK ERR"
  39. #define RMT_WR_MEM_OVF_ERROR_STR "RMT WR MEM OVERFLOW"
  40. #define RMT_GPIO_ERROR_STR "RMT GPIO ERROR"
  41. #define RMT_MODE_ERROR_STR "RMT MODE ERROR"
  42. #define RMT_CLK_DIV_ERROR_STR "RMT CLK DIV ERR"
  43. #define RMT_DRIVER_ERROR_STR "RMT DRIVER ERR"
  44. #define RMT_DRIVER_LENGTH_ERROR_STR "RMT PARAM LEN ERROR"
  45. #define RMT_PSRAM_BUFFER_WARN_STR "Using buffer allocated from psram"
  46. #define RMT_TRANSLATOR_NULL_STR "RMT translator is null"
  47. #define RMT_TRANSLATOR_UNINIT_STR "RMT translator not init"
  48. #define RMT_PARAM_ERR_STR "RMT param error"
  49. static const char *RMT_TAG = "rmt";
  50. #define RMT_CHECK(a, str, ret_val, ...) \
  51. if (unlikely(!(a))) { \
  52. ESP_LOGE(RMT_TAG, "%s(%d): "str, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
  53. return (ret_val); \
  54. }
  55. // Spinlock for protecting concurrent register-level access only
  56. #define RMT_ENTER_CRITICAL() portENTER_CRITICAL_SAFE(&(rmt_contex.rmt_spinlock))
  57. #define RMT_EXIT_CRITICAL() portEXIT_CRITICAL_SAFE(&(rmt_contex.rmt_spinlock))
  58. #define RMT_RX_CHANNEL_ENCODING_START (SOC_RMT_CHANNELS_NUM-SOC_RMT_TX_CHANNELS_NUM)
  59. #define RMT_TX_CHANNEL_ENCODING_END (SOC_RMT_TX_CHANNELS_NUM-1)
  60. #define RMT_IS_RX_CHANNEL(channel) ((channel) >= RMT_RX_CHANNEL_ENCODING_START)
  61. #define RMT_IS_TX_CHANNEL(channel) ((channel) <= RMT_TX_CHANNEL_ENCODING_END)
  62. #define RMT_DECODE_RX_CHANNEL(encode_chan) ((encode_chan - RMT_RX_CHANNEL_ENCODING_START))
  63. #define RMT_ENCODE_RX_CHANNEL(decode_chan) ((decode_chan + RMT_RX_CHANNEL_ENCODING_START))
  64. typedef struct {
  65. rmt_hal_context_t hal;
  66. _lock_t rmt_driver_isr_lock;
  67. portMUX_TYPE rmt_spinlock; // Mutex lock for protecting concurrent register/unregister of RMT channels' ISR
  68. rmt_isr_handle_t rmt_driver_intr_handle;
  69. rmt_tx_end_callback_t rmt_tx_end_callback;// Event called when transmission is ended
  70. uint8_t rmt_driver_channels; // Bitmask of installed drivers' channels
  71. bool rmt_module_enabled;
  72. } rmt_contex_t;
  73. typedef struct {
  74. size_t tx_offset;
  75. size_t tx_len_rem;
  76. size_t tx_sub_len;
  77. bool translator;
  78. bool wait_done; //Mark whether wait tx done.
  79. rmt_channel_t channel;
  80. const rmt_item32_t *tx_data;
  81. xSemaphoreHandle tx_sem;
  82. #if CONFIG_SPIRAM_USE_MALLOC
  83. int intr_alloc_flags;
  84. StaticSemaphore_t tx_sem_buffer;
  85. #endif
  86. rmt_item32_t *tx_buf;
  87. RingbufHandle_t rx_buf;
  88. #if SOC_RMT_SUPPORT_RX_PINGPONG
  89. rmt_item32_t *rx_item_buf;
  90. uint32_t rx_item_buf_size;
  91. uint32_t rx_item_len;
  92. uint32_t rx_item_start_idx;
  93. #endif
  94. sample_to_rmt_t sample_to_rmt;
  95. size_t sample_size_remain;
  96. const uint8_t *sample_cur;
  97. } rmt_obj_t;
  98. static rmt_contex_t rmt_contex = {
  99. .hal.regs = RMT_LL_HW_BASE,
  100. .hal.mem = RMT_LL_MEM_BASE,
  101. .rmt_spinlock = portMUX_INITIALIZER_UNLOCKED,
  102. .rmt_driver_intr_handle = NULL,
  103. .rmt_tx_end_callback = {
  104. .function = NULL,
  105. },
  106. .rmt_driver_channels = 0,
  107. .rmt_module_enabled = false,
  108. };
  109. static rmt_obj_t *p_rmt_obj[RMT_CHANNEL_MAX] = {0};
  110. #if SOC_RMT_SOURCE_CLK_INDEPENDENT
  111. static uint32_t s_rmt_source_clock_hz[RMT_CHANNEL_MAX];
  112. #else
  113. static uint32_t s_rmt_source_clock_hz;
  114. #endif
  115. //Enable RMT module
  116. static void rmt_module_enable(void)
  117. {
  118. RMT_ENTER_CRITICAL();
  119. if (rmt_contex.rmt_module_enabled == false) {
  120. periph_module_reset(rmt_periph_signals.module);
  121. periph_module_enable(rmt_periph_signals.module);
  122. rmt_contex.rmt_module_enabled = true;
  123. }
  124. RMT_EXIT_CRITICAL();
  125. }
  126. //Disable RMT module
  127. static void rmt_module_disable(void)
  128. {
  129. RMT_ENTER_CRITICAL();
  130. if (rmt_contex.rmt_module_enabled == true) {
  131. periph_module_disable(rmt_periph_signals.module);
  132. rmt_contex.rmt_module_enabled = false;
  133. }
  134. RMT_EXIT_CRITICAL();
  135. }
  136. esp_err_t rmt_set_clk_div(rmt_channel_t channel, uint8_t div_cnt)
  137. {
  138. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  139. RMT_ENTER_CRITICAL();
  140. if (RMT_IS_RX_CHANNEL(channel)) {
  141. rmt_ll_rx_set_counter_clock_div(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), div_cnt);
  142. } else {
  143. rmt_ll_tx_set_counter_clock_div(rmt_contex.hal.regs, channel, div_cnt);
  144. }
  145. RMT_EXIT_CRITICAL();
  146. return ESP_OK;
  147. }
  148. esp_err_t rmt_get_clk_div(rmt_channel_t channel, uint8_t *div_cnt)
  149. {
  150. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  151. RMT_CHECK(div_cnt != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  152. RMT_ENTER_CRITICAL();
  153. if (RMT_IS_RX_CHANNEL(channel)) {
  154. *div_cnt = (uint8_t)rmt_ll_rx_get_counter_clock_div(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  155. } else {
  156. *div_cnt = (uint8_t)rmt_ll_tx_get_counter_clock_div(rmt_contex.hal.regs, channel);
  157. }
  158. RMT_EXIT_CRITICAL();
  159. return ESP_OK;
  160. }
  161. esp_err_t rmt_set_rx_idle_thresh(rmt_channel_t channel, uint16_t thresh)
  162. {
  163. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  164. RMT_ENTER_CRITICAL();
  165. rmt_ll_rx_set_idle_thres(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), thresh);
  166. RMT_EXIT_CRITICAL();
  167. return ESP_OK;
  168. }
  169. esp_err_t rmt_get_rx_idle_thresh(rmt_channel_t channel, uint16_t *thresh)
  170. {
  171. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  172. RMT_CHECK(thresh != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  173. RMT_ENTER_CRITICAL();
  174. *thresh = (uint16_t)rmt_ll_rx_get_idle_thres(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  175. RMT_EXIT_CRITICAL();
  176. return ESP_OK;
  177. }
  178. esp_err_t rmt_set_mem_block_num(rmt_channel_t channel, uint8_t rmt_mem_num)
  179. {
  180. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  181. RMT_CHECK(rmt_mem_num <= RMT_CHANNEL_MAX - channel, RMT_MEM_CNT_ERROR_STR, ESP_ERR_INVALID_ARG);
  182. RMT_ENTER_CRITICAL();
  183. if (RMT_IS_RX_CHANNEL(channel)) {
  184. rmt_ll_rx_set_mem_blocks(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), rmt_mem_num);
  185. } else {
  186. rmt_ll_tx_set_mem_blocks(rmt_contex.hal.regs, channel, rmt_mem_num);
  187. }
  188. RMT_EXIT_CRITICAL();
  189. return ESP_OK;
  190. }
  191. esp_err_t rmt_get_mem_block_num(rmt_channel_t channel, uint8_t *rmt_mem_num)
  192. {
  193. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  194. RMT_CHECK(rmt_mem_num != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  195. RMT_ENTER_CRITICAL();
  196. if (RMT_IS_RX_CHANNEL(channel)) {
  197. *rmt_mem_num = (uint8_t)rmt_ll_rx_get_mem_blocks(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  198. } else {
  199. *rmt_mem_num = (uint8_t)rmt_ll_tx_get_mem_blocks(rmt_contex.hal.regs, channel);
  200. }
  201. RMT_EXIT_CRITICAL();
  202. return ESP_OK;
  203. }
  204. esp_err_t rmt_set_tx_carrier(rmt_channel_t channel, bool carrier_en, uint16_t high_level, uint16_t low_level,
  205. rmt_carrier_level_t carrier_level)
  206. {
  207. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  208. RMT_CHECK(carrier_level < RMT_CARRIER_LEVEL_MAX, RMT_CARRIER_ERROR_STR, ESP_ERR_INVALID_ARG);
  209. RMT_ENTER_CRITICAL();
  210. rmt_ll_tx_set_carrier_high_low_ticks(rmt_contex.hal.regs, channel, high_level, low_level);
  211. rmt_ll_tx_set_carrier_level(rmt_contex.hal.regs, channel, carrier_level);
  212. rmt_ll_tx_enable_carrier_modulation(rmt_contex.hal.regs, channel, carrier_en);
  213. RMT_EXIT_CRITICAL();
  214. return ESP_OK;
  215. }
  216. esp_err_t rmt_set_mem_pd(rmt_channel_t channel, bool pd_en)
  217. {
  218. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  219. RMT_ENTER_CRITICAL();
  220. rmt_ll_power_down_mem(rmt_contex.hal.regs, pd_en);
  221. RMT_EXIT_CRITICAL();
  222. return ESP_OK;
  223. }
  224. esp_err_t rmt_get_mem_pd(rmt_channel_t channel, bool *pd_en)
  225. {
  226. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  227. RMT_ENTER_CRITICAL();
  228. *pd_en = rmt_ll_is_mem_power_down(rmt_contex.hal.regs);
  229. RMT_EXIT_CRITICAL();
  230. return ESP_OK;
  231. }
  232. esp_err_t rmt_tx_start(rmt_channel_t channel, bool tx_idx_rst)
  233. {
  234. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  235. RMT_ENTER_CRITICAL();
  236. if (tx_idx_rst) {
  237. rmt_ll_tx_reset_pointer(rmt_contex.hal.regs, channel);
  238. }
  239. rmt_ll_clear_tx_end_interrupt(rmt_contex.hal.regs, channel);
  240. // enable tx end interrupt in non-loop mode
  241. if (!rmt_ll_is_tx_loop_enabled(rmt_contex.hal.regs, channel)) {
  242. rmt_ll_enable_tx_end_interrupt(rmt_contex.hal.regs, channel, true);
  243. } else {
  244. #if SOC_RMT_SUPPORT_TX_LOOP_COUNT
  245. rmt_ll_tx_reset_loop(rmt_contex.hal.regs, channel);
  246. rmt_ll_tx_enable_loop_count(rmt_contex.hal.regs, channel, true);
  247. rmt_ll_clear_tx_loop_interrupt(rmt_contex.hal.regs, channel);
  248. rmt_ll_enable_tx_loop_interrupt(rmt_contex.hal.regs, channel, true);
  249. #endif
  250. }
  251. rmt_ll_tx_start(rmt_contex.hal.regs, channel);
  252. RMT_EXIT_CRITICAL();
  253. return ESP_OK;
  254. }
  255. esp_err_t rmt_tx_stop(rmt_channel_t channel)
  256. {
  257. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  258. RMT_ENTER_CRITICAL();
  259. rmt_ll_tx_stop(rmt_contex.hal.regs, channel);
  260. rmt_ll_tx_reset_pointer(rmt_contex.hal.regs, channel);
  261. RMT_EXIT_CRITICAL();
  262. return ESP_OK;
  263. }
  264. esp_err_t rmt_rx_start(rmt_channel_t channel, bool rx_idx_rst)
  265. {
  266. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  267. RMT_ENTER_CRITICAL();
  268. rmt_ll_rx_enable(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), false);
  269. if (rx_idx_rst) {
  270. rmt_ll_rx_reset_pointer(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  271. }
  272. rmt_ll_clear_rx_end_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  273. rmt_ll_enable_rx_end_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), true);
  274. #if SOC_RMT_SUPPORT_RX_PINGPONG
  275. const uint32_t item_block_len = rmt_ll_rx_get_mem_blocks(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel)) * RMT_MEM_ITEM_NUM;
  276. p_rmt_obj[channel]->rx_item_start_idx = 0;
  277. p_rmt_obj[channel]->rx_item_len = 0;
  278. rmt_set_rx_thr_intr_en(channel, true, item_block_len / 2);
  279. #endif
  280. rmt_ll_rx_enable(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), true);
  281. RMT_EXIT_CRITICAL();
  282. return ESP_OK;
  283. }
  284. esp_err_t rmt_rx_stop(rmt_channel_t channel)
  285. {
  286. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  287. RMT_ENTER_CRITICAL();
  288. rmt_ll_enable_rx_end_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), false);
  289. rmt_ll_rx_enable(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), false);
  290. rmt_ll_rx_reset_pointer(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  291. #if SOC_RMT_SUPPORT_RX_PINGPONG
  292. rmt_ll_enable_rx_thres_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), false);
  293. #endif
  294. RMT_EXIT_CRITICAL();
  295. return ESP_OK;
  296. }
  297. esp_err_t rmt_tx_memory_reset(rmt_channel_t channel)
  298. {
  299. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  300. RMT_ENTER_CRITICAL();
  301. rmt_ll_tx_reset_pointer(rmt_contex.hal.regs, channel);
  302. RMT_EXIT_CRITICAL();
  303. return ESP_OK;
  304. }
  305. esp_err_t rmt_rx_memory_reset(rmt_channel_t channel)
  306. {
  307. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  308. RMT_ENTER_CRITICAL();
  309. rmt_ll_rx_reset_pointer(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  310. RMT_EXIT_CRITICAL();
  311. return ESP_OK;
  312. }
  313. esp_err_t rmt_set_memory_owner(rmt_channel_t channel, rmt_mem_owner_t owner)
  314. {
  315. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  316. RMT_CHECK(owner < RMT_MEM_OWNER_MAX, RMT_MEM_OWNER_ERROR_STR, ESP_ERR_INVALID_ARG);
  317. RMT_ENTER_CRITICAL();
  318. rmt_ll_rx_set_mem_owner(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), owner);
  319. RMT_EXIT_CRITICAL();
  320. return ESP_OK;
  321. }
  322. esp_err_t rmt_get_memory_owner(rmt_channel_t channel, rmt_mem_owner_t *owner)
  323. {
  324. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  325. RMT_CHECK(owner != NULL, RMT_MEM_OWNER_ERROR_STR, ESP_ERR_INVALID_ARG);
  326. RMT_ENTER_CRITICAL();
  327. *owner = (rmt_mem_owner_t)rmt_ll_rx_get_mem_owner(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  328. RMT_EXIT_CRITICAL();
  329. return ESP_OK;
  330. }
  331. esp_err_t rmt_set_tx_loop_mode(rmt_channel_t channel, bool loop_en)
  332. {
  333. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  334. RMT_ENTER_CRITICAL();
  335. rmt_ll_tx_enable_loop(rmt_contex.hal.regs, channel, loop_en);
  336. RMT_EXIT_CRITICAL();
  337. return ESP_OK;
  338. }
  339. esp_err_t rmt_get_tx_loop_mode(rmt_channel_t channel, bool *loop_en)
  340. {
  341. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  342. RMT_ENTER_CRITICAL();
  343. *loop_en = rmt_ll_is_tx_loop_enabled(rmt_contex.hal.regs, channel);
  344. RMT_EXIT_CRITICAL();
  345. return ESP_OK;
  346. }
  347. esp_err_t rmt_set_rx_filter(rmt_channel_t channel, bool rx_filter_en, uint8_t thresh)
  348. {
  349. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  350. RMT_ENTER_CRITICAL();
  351. rmt_ll_rx_enable_filter(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), rx_filter_en);
  352. rmt_ll_rx_set_filter_thres(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), thresh);
  353. RMT_EXIT_CRITICAL();
  354. return ESP_OK;
  355. }
  356. esp_err_t rmt_set_source_clk(rmt_channel_t channel, rmt_source_clk_t base_clk)
  357. {
  358. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  359. RMT_CHECK(base_clk < RMT_BASECLK_MAX, RMT_BASECLK_ERROR_STR, ESP_ERR_INVALID_ARG);
  360. RMT_ENTER_CRITICAL();
  361. rmt_ll_set_counter_clock_src(rmt_contex.hal.regs, channel, base_clk, 0, 0, 0);
  362. RMT_EXIT_CRITICAL();
  363. return ESP_OK;
  364. }
  365. esp_err_t rmt_get_source_clk(rmt_channel_t channel, rmt_source_clk_t *src_clk)
  366. {
  367. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  368. RMT_ENTER_CRITICAL();
  369. *src_clk = (rmt_source_clk_t)rmt_ll_get_counter_clock_src(rmt_contex.hal.regs, channel);
  370. RMT_EXIT_CRITICAL();
  371. return ESP_OK;
  372. }
  373. esp_err_t rmt_set_idle_level(rmt_channel_t channel, bool idle_out_en, rmt_idle_level_t level)
  374. {
  375. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  376. RMT_CHECK(level < RMT_IDLE_LEVEL_MAX, "RMT IDLE LEVEL ERR", ESP_ERR_INVALID_ARG);
  377. RMT_ENTER_CRITICAL();
  378. rmt_ll_tx_enable_idle(rmt_contex.hal.regs, channel, idle_out_en);
  379. rmt_ll_tx_set_idle_level(rmt_contex.hal.regs, channel, level);
  380. RMT_EXIT_CRITICAL();
  381. return ESP_OK;
  382. }
  383. esp_err_t rmt_get_idle_level(rmt_channel_t channel, bool *idle_out_en, rmt_idle_level_t *level)
  384. {
  385. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  386. RMT_ENTER_CRITICAL();
  387. *idle_out_en = rmt_ll_is_tx_idle_enabled(rmt_contex.hal.regs, channel);
  388. *level = rmt_ll_tx_get_idle_level(rmt_contex.hal.regs, channel);
  389. RMT_EXIT_CRITICAL();
  390. return ESP_OK;
  391. }
  392. esp_err_t rmt_get_status(rmt_channel_t channel, uint32_t *status)
  393. {
  394. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  395. RMT_ENTER_CRITICAL();
  396. if (RMT_IS_RX_CHANNEL(channel)) {
  397. *status = rmt_ll_rx_get_channel_status(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  398. } else {
  399. *status = rmt_ll_tx_get_channel_status(rmt_contex.hal.regs, channel);
  400. }
  401. RMT_EXIT_CRITICAL();
  402. return ESP_OK;
  403. }
  404. void rmt_set_intr_enable_mask(uint32_t mask)
  405. {
  406. RMT_ENTER_CRITICAL();
  407. rmt_ll_set_intr_enable_mask(mask);
  408. RMT_EXIT_CRITICAL();
  409. }
  410. void rmt_clr_intr_enable_mask(uint32_t mask)
  411. {
  412. RMT_ENTER_CRITICAL();
  413. rmt_ll_clr_intr_enable_mask(mask);
  414. RMT_EXIT_CRITICAL();
  415. }
  416. esp_err_t rmt_set_rx_intr_en(rmt_channel_t channel, bool en)
  417. {
  418. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  419. RMT_ENTER_CRITICAL();
  420. rmt_ll_enable_rx_end_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), en);
  421. RMT_EXIT_CRITICAL();
  422. return ESP_OK;
  423. }
  424. #if SOC_RMT_SUPPORT_RX_PINGPONG
  425. esp_err_t rmt_set_rx_thr_intr_en(rmt_channel_t channel, bool en, uint16_t evt_thresh)
  426. {
  427. RMT_CHECK(RMT_IS_RX_CHANNEL(channel) && channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  428. if (en) {
  429. uint32_t item_block_len = rmt_ll_rx_get_mem_blocks(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel)) * RMT_MEM_ITEM_NUM;
  430. RMT_CHECK(evt_thresh <= item_block_len, "RMT EVT THRESH ERR", ESP_ERR_INVALID_ARG);
  431. RMT_ENTER_CRITICAL();
  432. rmt_ll_rx_set_limit(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), evt_thresh);
  433. rmt_ll_enable_rx_thres_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), true);
  434. RMT_EXIT_CRITICAL();
  435. } else {
  436. RMT_ENTER_CRITICAL();
  437. rmt_ll_enable_rx_thres_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), false);
  438. RMT_EXIT_CRITICAL();
  439. }
  440. return ESP_OK;
  441. }
  442. #endif
  443. esp_err_t rmt_set_err_intr_en(rmt_channel_t channel, bool en)
  444. {
  445. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  446. RMT_ENTER_CRITICAL();
  447. if (RMT_IS_RX_CHANNEL(channel)) {
  448. rmt_ll_enable_rx_err_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), en);
  449. } else {
  450. rmt_ll_enable_tx_err_interrupt(rmt_contex.hal.regs, channel, en);
  451. }
  452. RMT_EXIT_CRITICAL();
  453. return ESP_OK;
  454. }
  455. esp_err_t rmt_set_tx_intr_en(rmt_channel_t channel, bool en)
  456. {
  457. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  458. RMT_ENTER_CRITICAL();
  459. rmt_ll_enable_tx_end_interrupt(rmt_contex.hal.regs, channel, en);
  460. RMT_EXIT_CRITICAL();
  461. return ESP_OK;
  462. }
  463. esp_err_t rmt_set_tx_thr_intr_en(rmt_channel_t channel, bool en, uint16_t evt_thresh)
  464. {
  465. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  466. if (en) {
  467. uint32_t item_block_len = rmt_ll_tx_get_mem_blocks(rmt_contex.hal.regs, channel) * RMT_MEM_ITEM_NUM;
  468. RMT_CHECK(evt_thresh <= item_block_len, "RMT EVT THRESH ERR", ESP_ERR_INVALID_ARG);
  469. RMT_ENTER_CRITICAL();
  470. rmt_ll_tx_set_limit(rmt_contex.hal.regs, channel, evt_thresh);
  471. rmt_ll_enable_tx_thres_interrupt(rmt_contex.hal.regs, channel, true);
  472. RMT_EXIT_CRITICAL();
  473. } else {
  474. RMT_ENTER_CRITICAL();
  475. rmt_ll_enable_tx_thres_interrupt(rmt_contex.hal.regs, channel, false);
  476. RMT_EXIT_CRITICAL();
  477. }
  478. return ESP_OK;
  479. }
  480. esp_err_t rmt_set_pin(rmt_channel_t channel, rmt_mode_t mode, gpio_num_t gpio_num)
  481. {
  482. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  483. RMT_CHECK(mode < RMT_MODE_MAX, RMT_MODE_ERROR_STR, ESP_ERR_INVALID_ARG);
  484. RMT_CHECK(((GPIO_IS_VALID_GPIO(gpio_num) && (mode == RMT_MODE_RX)) ||
  485. (GPIO_IS_VALID_OUTPUT_GPIO(gpio_num) && (mode == RMT_MODE_TX))),
  486. RMT_GPIO_ERROR_STR, ESP_ERR_INVALID_ARG);
  487. PIN_FUNC_SELECT(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
  488. if (mode == RMT_MODE_TX) {
  489. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  490. gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
  491. esp_rom_gpio_connect_out_signal(gpio_num, rmt_periph_signals.channels[channel].tx_sig, 0, 0);
  492. } else {
  493. RMT_CHECK(RMT_IS_RX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  494. gpio_set_direction(gpio_num, GPIO_MODE_INPUT);
  495. esp_rom_gpio_connect_in_signal(gpio_num, rmt_periph_signals.channels[channel].rx_sig, 0);
  496. }
  497. return ESP_OK;
  498. }
  499. static bool rmt_is_channel_number_valid(rmt_channel_t channel, uint8_t mode)
  500. {
  501. // RX mode
  502. if (mode == RMT_MODE_RX) {
  503. return RMT_IS_RX_CHANNEL(channel) && (channel < RMT_CHANNEL_MAX);
  504. }
  505. // TX mode
  506. return (channel >= 0) && RMT_IS_TX_CHANNEL(channel);
  507. }
  508. static esp_err_t rmt_internal_config(rmt_dev_t *dev, const rmt_config_t *rmt_param)
  509. {
  510. uint8_t mode = rmt_param->rmt_mode;
  511. uint8_t channel = rmt_param->channel;
  512. uint8_t gpio_num = rmt_param->gpio_num;
  513. uint8_t mem_cnt = rmt_param->mem_block_num;
  514. uint8_t clk_div = rmt_param->clk_div;
  515. uint32_t carrier_freq_hz = rmt_param->tx_config.carrier_freq_hz;
  516. bool carrier_en = rmt_param->tx_config.carrier_en;
  517. uint32_t rmt_source_clk_hz;
  518. RMT_CHECK(rmt_is_channel_number_valid(channel, mode), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  519. RMT_CHECK((mem_cnt + channel <= 8 && mem_cnt > 0), RMT_MEM_CNT_ERROR_STR, ESP_ERR_INVALID_ARG);
  520. RMT_CHECK((clk_div > 0), RMT_CLK_DIV_ERROR_STR, ESP_ERR_INVALID_ARG);
  521. if (mode == RMT_MODE_TX) {
  522. RMT_CHECK((!carrier_en || carrier_freq_hz > 0), "RMT carrier frequency can't be zero", ESP_ERR_INVALID_ARG);
  523. }
  524. RMT_ENTER_CRITICAL();
  525. rmt_ll_enable_mem_access(dev, true);
  526. if (rmt_param->flags & RMT_CHANNEL_FLAGS_AWARE_DFS) {
  527. #if SOC_RMT_SUPPORT_XTAL
  528. // clock src: XTAL_CLK
  529. rmt_source_clk_hz = rtc_clk_xtal_freq_get() * 1000000;
  530. rmt_ll_set_counter_clock_src(dev, channel, RMT_BASECLK_XTAL, 0, 0, 0);
  531. #elif SOC_RMT_SUPPORT_REF_TICK
  532. // clock src: REF_CLK
  533. rmt_source_clk_hz = REF_CLK_FREQ;
  534. rmt_ll_set_counter_clock_src(dev, channel, RMT_BASECLK_REF, 0, 0, 0);
  535. #endif
  536. } else {
  537. // clock src: APB_CLK
  538. rmt_source_clk_hz = APB_CLK_FREQ;
  539. rmt_ll_set_counter_clock_src(dev, channel, RMT_BASECLK_APB, 0, 0, 0);
  540. }
  541. RMT_EXIT_CRITICAL();
  542. #if SOC_RMT_SOURCE_CLK_INDEPENDENT
  543. s_rmt_source_clock_hz[channel] = rmt_source_clk_hz;
  544. #else
  545. if (s_rmt_source_clock_hz && rmt_source_clk_hz != s_rmt_source_clock_hz) {
  546. ESP_LOGW(RMT_TAG, "RMT clock source has been configured to %d by other channel, now reconfigure it to %d", s_rmt_source_clock_hz, rmt_source_clk_hz);
  547. }
  548. s_rmt_source_clock_hz = rmt_source_clk_hz;
  549. #endif
  550. ESP_LOGD(RMT_TAG, "rmt_source_clk_hz: %d\n", rmt_source_clk_hz);
  551. if (mode == RMT_MODE_TX) {
  552. uint16_t carrier_duty_percent = rmt_param->tx_config.carrier_duty_percent;
  553. uint8_t carrier_level = rmt_param->tx_config.carrier_level;
  554. uint8_t idle_level = rmt_param->tx_config.idle_level;
  555. RMT_ENTER_CRITICAL();
  556. rmt_ll_tx_set_counter_clock_div(dev, channel, clk_div);
  557. rmt_ll_tx_set_mem_blocks(dev, channel, mem_cnt);
  558. rmt_ll_tx_reset_pointer(dev, channel);
  559. rmt_ll_tx_enable_loop(dev, channel, rmt_param->tx_config.loop_en);
  560. #if SOC_RMT_SUPPORT_TX_LOOP_COUNT
  561. if (rmt_param->tx_config.loop_en) {
  562. rmt_ll_tx_set_loop_count(dev, channel, rmt_param->tx_config.loop_count);
  563. }
  564. #endif
  565. /* always enable tx ping-pong */
  566. rmt_ll_tx_enable_pingpong(dev, channel, true);
  567. /*Set idle level */
  568. rmt_ll_tx_enable_idle(dev, channel, rmt_param->tx_config.idle_output_en);
  569. rmt_ll_tx_set_idle_level(dev, channel, idle_level);
  570. /*Set carrier*/
  571. rmt_ll_tx_enable_carrier_modulation(dev, channel, carrier_en);
  572. if (carrier_en) {
  573. uint32_t duty_div, duty_h, duty_l;
  574. duty_div = rmt_source_clk_hz / carrier_freq_hz;
  575. duty_h = duty_div * carrier_duty_percent / 100;
  576. duty_l = duty_div - duty_h;
  577. rmt_ll_tx_set_carrier_level(dev, channel, carrier_level);
  578. rmt_ll_tx_set_carrier_high_low_ticks(dev, channel, duty_h, duty_l);
  579. } else {
  580. rmt_ll_tx_set_carrier_level(dev, channel, 0);
  581. rmt_ll_tx_set_carrier_high_low_ticks(dev, channel, 0, 0);
  582. }
  583. RMT_EXIT_CRITICAL();
  584. ESP_LOGD(RMT_TAG, "Rmt Tx Channel %u|Gpio %u|Sclk_Hz %u|Div %u|Carrier_Hz %u|Duty %u",
  585. channel, gpio_num, rmt_source_clk_hz, clk_div, carrier_freq_hz, carrier_duty_percent);
  586. } else if (RMT_MODE_RX == mode) {
  587. uint8_t filter_cnt = rmt_param->rx_config.filter_ticks_thresh;
  588. uint16_t threshold = rmt_param->rx_config.idle_threshold;
  589. RMT_ENTER_CRITICAL();
  590. rmt_ll_rx_set_counter_clock_div(dev, RMT_DECODE_RX_CHANNEL(channel), clk_div);
  591. rmt_ll_rx_set_mem_blocks(dev, RMT_DECODE_RX_CHANNEL(channel), mem_cnt);
  592. rmt_ll_rx_reset_pointer(dev, RMT_DECODE_RX_CHANNEL(channel));
  593. rmt_ll_rx_set_mem_owner(dev, RMT_DECODE_RX_CHANNEL(channel), RMT_MEM_OWNER_HW);
  594. /*Set idle threshold*/
  595. rmt_ll_rx_set_idle_thres(dev, RMT_DECODE_RX_CHANNEL(channel), threshold);
  596. /* Set RX filter */
  597. rmt_ll_rx_set_filter_thres(dev, RMT_DECODE_RX_CHANNEL(channel), filter_cnt);
  598. rmt_ll_rx_enable_filter(dev, RMT_DECODE_RX_CHANNEL(channel), rmt_param->rx_config.filter_en);
  599. #if SOC_RMT_SUPPORT_RX_PINGPONG
  600. /* always enable rx ping-pong */
  601. rmt_ll_rx_enable_pingpong(dev, RMT_DECODE_RX_CHANNEL(channel), true);
  602. #endif
  603. #if SOC_RMT_SUPPORT_RX_DEMODULATION
  604. rmt_ll_rx_enable_carrier_demodulation(dev, RMT_DECODE_RX_CHANNEL(channel), rmt_param->rx_config.rm_carrier);
  605. if (rmt_param->rx_config.rm_carrier) {
  606. uint32_t duty_total = rmt_source_clk_hz / rmt_ll_rx_get_counter_clock_div(dev, RMT_DECODE_RX_CHANNEL(channel)) / rmt_param->rx_config.carrier_freq_hz;
  607. uint32_t duty_high = duty_total * rmt_param->rx_config.carrier_duty_percent / 100;
  608. // there could be residual in timing the carrier pulse, so double enlarge the theoretical value
  609. rmt_ll_rx_set_carrier_high_low_ticks(dev, RMT_DECODE_RX_CHANNEL(channel), duty_high * 2, (duty_total - duty_high) * 2);
  610. rmt_ll_rx_set_carrier_level(dev, RMT_DECODE_RX_CHANNEL(channel), rmt_param->rx_config.carrier_level);
  611. }
  612. #endif
  613. RMT_EXIT_CRITICAL();
  614. ESP_LOGD(RMT_TAG, "Rmt Rx Channel %u|Gpio %u|Sclk_Hz %u|Div %u|Thresold %u|Filter %u",
  615. channel, gpio_num, rmt_source_clk_hz, clk_div, threshold, filter_cnt);
  616. }
  617. return ESP_OK;
  618. }
  619. esp_err_t rmt_config(const rmt_config_t *rmt_param)
  620. {
  621. rmt_module_enable();
  622. RMT_CHECK(rmt_set_pin(rmt_param->channel, rmt_param->rmt_mode, rmt_param->gpio_num) == ESP_OK,
  623. "set gpio for RMT driver failed", ESP_ERR_INVALID_ARG);
  624. RMT_CHECK(rmt_internal_config(&RMT, rmt_param) == ESP_OK,
  625. "initialize RMT driver failed", ESP_ERR_INVALID_ARG);
  626. return ESP_OK;
  627. }
  628. static void IRAM_ATTR rmt_fill_memory(rmt_channel_t channel, const rmt_item32_t *item,
  629. uint16_t item_num, uint16_t mem_offset)
  630. {
  631. RMT_ENTER_CRITICAL();
  632. rmt_ll_write_memory(rmt_contex.hal.mem, channel, item, item_num, mem_offset);
  633. RMT_EXIT_CRITICAL();
  634. }
  635. esp_err_t rmt_fill_tx_items(rmt_channel_t channel, const rmt_item32_t *item, uint16_t item_num, uint16_t mem_offset)
  636. {
  637. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, (0));
  638. RMT_CHECK((item != NULL), RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  639. RMT_CHECK((item_num > 0), RMT_DRIVER_LENGTH_ERROR_STR, ESP_ERR_INVALID_ARG);
  640. /*Each block has 64 x 32 bits of data*/
  641. uint8_t mem_cnt = rmt_ll_tx_get_mem_blocks(rmt_contex.hal.regs, channel);
  642. RMT_CHECK((mem_cnt * RMT_MEM_ITEM_NUM >= item_num), RMT_WR_MEM_OVF_ERROR_STR, ESP_ERR_INVALID_ARG);
  643. rmt_fill_memory(channel, item, item_num, mem_offset);
  644. return ESP_OK;
  645. }
  646. esp_err_t rmt_isr_register(void (*fn)(void *), void *arg, int intr_alloc_flags, rmt_isr_handle_t *handle)
  647. {
  648. RMT_CHECK((fn != NULL), RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  649. RMT_CHECK(rmt_contex.rmt_driver_channels == 0, "RMT driver installed, can not install generic ISR handler", ESP_FAIL);
  650. return esp_intr_alloc(rmt_periph_signals.irq, intr_alloc_flags, fn, arg, handle);
  651. }
  652. esp_err_t rmt_isr_deregister(rmt_isr_handle_t handle)
  653. {
  654. return esp_intr_free(handle);
  655. }
  656. static int IRAM_ATTR rmt_rx_get_mem_len_in_isr(rmt_channel_t channel)
  657. {
  658. int block_num = rmt_ll_rx_get_mem_blocks(rmt_contex.hal.regs, channel);
  659. int item_block_len = block_num * RMT_MEM_ITEM_NUM;
  660. volatile rmt_item32_t *data = (rmt_item32_t *)RMTMEM.chan[RMT_ENCODE_RX_CHANNEL(channel)].data32;
  661. int idx;
  662. for (idx = 0; idx < item_block_len; idx++) {
  663. if (data[idx].duration0 == 0) {
  664. return idx;
  665. } else if (data[idx].duration1 == 0) {
  666. return idx + 1;
  667. }
  668. }
  669. return idx;
  670. }
  671. static void IRAM_ATTR rmt_driver_isr_default(void *arg)
  672. {
  673. uint32_t status = 0;
  674. rmt_item32_t volatile *addr = NULL;
  675. uint8_t channel = 0;
  676. rmt_hal_context_t *hal = (rmt_hal_context_t *)arg;
  677. portBASE_TYPE HPTaskAwoken = pdFALSE;
  678. // Tx end interrupt
  679. status = rmt_ll_get_tx_end_interrupt_status(hal->regs);
  680. while (status) {
  681. channel = __builtin_ffs(status) - 1;
  682. status &= ~(1 << channel);
  683. rmt_obj_t *p_rmt = p_rmt_obj[channel];
  684. if (p_rmt) {
  685. xSemaphoreGiveFromISR(p_rmt->tx_sem, &HPTaskAwoken);
  686. rmt_ll_tx_reset_pointer(rmt_contex.hal.regs, channel);
  687. p_rmt->tx_data = NULL;
  688. p_rmt->tx_len_rem = 0;
  689. p_rmt->tx_offset = 0;
  690. p_rmt->tx_sub_len = 0;
  691. p_rmt->sample_cur = NULL;
  692. p_rmt->translator = false;
  693. if (rmt_contex.rmt_tx_end_callback.function != NULL) {
  694. rmt_contex.rmt_tx_end_callback.function(channel, rmt_contex.rmt_tx_end_callback.arg);
  695. }
  696. }
  697. rmt_ll_clear_tx_end_interrupt(hal->regs, channel);
  698. }
  699. // Tx thres interrupt
  700. status = rmt_ll_get_tx_thres_interrupt_status(hal->regs);
  701. while (status) {
  702. channel = __builtin_ffs(status) - 1;
  703. status &= ~(1 << channel);
  704. rmt_obj_t *p_rmt = p_rmt_obj[channel];
  705. if (p_rmt) {
  706. if (p_rmt->translator) {
  707. if (p_rmt->sample_size_remain > 0) {
  708. size_t translated_size = 0;
  709. p_rmt->sample_to_rmt((void *)p_rmt->sample_cur,
  710. p_rmt->tx_buf,
  711. p_rmt->sample_size_remain,
  712. p_rmt->tx_sub_len,
  713. &translated_size,
  714. &p_rmt->tx_len_rem);
  715. p_rmt->sample_size_remain -= translated_size;
  716. p_rmt->sample_cur += translated_size;
  717. p_rmt->tx_data = p_rmt->tx_buf;
  718. } else {
  719. p_rmt->sample_cur = NULL;
  720. p_rmt->translator = false;
  721. }
  722. }
  723. const rmt_item32_t *pdata = p_rmt->tx_data;
  724. int len_rem = p_rmt->tx_len_rem;
  725. if (len_rem >= p_rmt->tx_sub_len) {
  726. rmt_fill_memory(channel, pdata, p_rmt->tx_sub_len, p_rmt->tx_offset);
  727. p_rmt->tx_data += p_rmt->tx_sub_len;
  728. p_rmt->tx_len_rem -= p_rmt->tx_sub_len;
  729. } else if (len_rem == 0) {
  730. rmt_item32_t stop_data = {0};
  731. rmt_ll_write_memory(rmt_contex.hal.mem, channel, &stop_data, 1, p_rmt->tx_offset);
  732. } else {
  733. rmt_fill_memory(channel, pdata, len_rem, p_rmt->tx_offset);
  734. rmt_item32_t stop_data = {0};
  735. rmt_ll_write_memory(rmt_contex.hal.mem, channel, &stop_data, 1, p_rmt->tx_offset + len_rem);
  736. p_rmt->tx_data += len_rem;
  737. p_rmt->tx_len_rem -= len_rem;
  738. }
  739. if (p_rmt->tx_offset == 0) {
  740. p_rmt->tx_offset = p_rmt->tx_sub_len;
  741. } else {
  742. p_rmt->tx_offset = 0;
  743. }
  744. }
  745. rmt_ll_clear_tx_thres_interrupt(hal->regs, channel);
  746. }
  747. // Rx end interrupt
  748. status = rmt_ll_get_rx_end_interrupt_status(hal->regs);
  749. while (status) {
  750. channel = __builtin_ffs(status) - 1;
  751. status &= ~(1 << channel);
  752. rmt_obj_t *p_rmt = p_rmt_obj[RMT_ENCODE_RX_CHANNEL(channel)];
  753. if (p_rmt) {
  754. rmt_ll_rx_enable(rmt_contex.hal.regs, channel, false);
  755. int item_len = rmt_rx_get_mem_len_in_isr(channel);
  756. rmt_ll_rx_set_mem_owner(rmt_contex.hal.regs, channel, RMT_MEM_OWNER_SW);
  757. if (p_rmt->rx_buf) {
  758. addr = RMTMEM.chan[RMT_ENCODE_RX_CHANNEL(channel)].data32;
  759. #if SOC_RMT_SUPPORT_RX_PINGPONG
  760. if (item_len > p_rmt->rx_item_start_idx) {
  761. item_len = item_len - p_rmt->rx_item_start_idx;
  762. }
  763. memcpy((void *)(p_rmt->rx_item_buf + p_rmt->rx_item_len), (void *)(addr + p_rmt->rx_item_start_idx), item_len * 4);
  764. p_rmt->rx_item_len += item_len;
  765. BaseType_t res = xRingbufferSendFromISR(p_rmt->rx_buf, (void *)(p_rmt->rx_item_buf), p_rmt->rx_item_len * 4, &HPTaskAwoken);
  766. #else
  767. BaseType_t res = xRingbufferSendFromISR(p_rmt->rx_buf, (void *)addr, item_len * 4, &HPTaskAwoken);
  768. #endif
  769. if (res == pdFALSE) {
  770. ESP_EARLY_LOGE(RMT_TAG, "RMT RX BUFFER FULL");
  771. }
  772. } else {
  773. ESP_EARLY_LOGE(RMT_TAG, "RMT RX BUFFER ERROR");
  774. }
  775. #if SOC_RMT_SUPPORT_RX_PINGPONG
  776. p_rmt->rx_item_start_idx = 0;
  777. p_rmt->rx_item_len = 0;
  778. memset((void *)p_rmt->rx_item_buf, 0, p_rmt->rx_item_buf_size);
  779. #endif
  780. rmt_ll_rx_reset_pointer(rmt_contex.hal.regs, channel);
  781. rmt_ll_rx_set_mem_owner(rmt_contex.hal.regs, channel, RMT_MEM_OWNER_HW);
  782. rmt_ll_rx_enable(rmt_contex.hal.regs, channel, true);
  783. }
  784. rmt_ll_clear_rx_end_interrupt(hal->regs, channel);
  785. }
  786. #if SOC_RMT_SUPPORT_RX_PINGPONG
  787. // Rx thres interrupt
  788. status = rmt_ll_get_rx_thres_interrupt_status(hal->regs);
  789. while (status) {
  790. channel = __builtin_ffs(status) - 1;
  791. status &= ~(1 << channel);
  792. rmt_obj_t *p_rmt = p_rmt_obj[RMT_ENCODE_RX_CHANNEL(channel)];
  793. int mem_item_size = rmt_ll_rx_get_mem_blocks(rmt_contex.hal.regs, channel) * RMT_MEM_ITEM_NUM;
  794. int rx_thres_lim = rmt_ll_rx_get_limit(rmt_contex.hal.regs, channel);
  795. int item_len = (p_rmt->rx_item_start_idx == 0) ? rx_thres_lim : (mem_item_size - rx_thres_lim);
  796. if ((p_rmt->rx_item_len + item_len) < (p_rmt->rx_item_buf_size / 4)) {
  797. rmt_ll_rx_set_mem_owner(rmt_contex.hal.regs, channel, RMT_MEM_OWNER_SW);
  798. memcpy((void *)(p_rmt->rx_item_buf + p_rmt->rx_item_len), (void *)(RMTMEM.chan[RMT_ENCODE_RX_CHANNEL(channel)].data32 + p_rmt->rx_item_start_idx), item_len * 4);
  799. rmt_ll_rx_set_mem_owner(rmt_contex.hal.regs, channel, RMT_MEM_OWNER_HW);
  800. p_rmt->rx_item_len += item_len;
  801. p_rmt->rx_item_start_idx += item_len;
  802. if (p_rmt->rx_item_start_idx >= mem_item_size) {
  803. p_rmt->rx_item_start_idx = 0;
  804. }
  805. } else {
  806. ESP_EARLY_LOGE(RMT_TAG, "---RX buffer too small: %d", sizeof(p_rmt->rx_item_buf));
  807. }
  808. rmt_ll_clear_rx_thres_interrupt(hal->regs, channel);
  809. }
  810. #endif
  811. #if SOC_RMT_SUPPORT_TX_LOOP_COUNT
  812. // loop count interrupt
  813. status = rmt_ll_get_tx_loop_interrupt_status(hal->regs);
  814. while (status) {
  815. channel = __builtin_ffs(status) - 1;
  816. status &= ~(1 << channel);
  817. rmt_obj_t *p_rmt = p_rmt_obj[channel];
  818. if (p_rmt) {
  819. xSemaphoreGiveFromISR(p_rmt->tx_sem, &HPTaskAwoken);
  820. if (rmt_contex.rmt_tx_end_callback.function != NULL) {
  821. rmt_contex.rmt_tx_end_callback.function(channel, rmt_contex.rmt_tx_end_callback.arg);
  822. }
  823. }
  824. rmt_ll_clear_tx_loop_interrupt(hal->regs, channel);
  825. }
  826. #endif
  827. // RX Err interrupt
  828. status = rmt_ll_get_rx_err_interrupt_status(hal->regs);
  829. while (status) {
  830. channel = __builtin_ffs(status) - 1;
  831. status &= ~(1 << channel);
  832. rmt_obj_t *p_rmt = p_rmt_obj[RMT_ENCODE_RX_CHANNEL(channel)];
  833. if (p_rmt) {
  834. // Reset the receiver's write/read addresses to prevent endless err interrupts.
  835. rmt_ll_rx_reset_pointer(rmt_contex.hal.regs, channel);
  836. ESP_EARLY_LOGD(RMT_TAG, "RMT RX channel %d error", channel);
  837. ESP_EARLY_LOGD(RMT_TAG, "status: 0x%08x", rmt_ll_rx_get_channel_status(rmt_contex.hal.regs, channel));
  838. }
  839. rmt_ll_clear_rx_err_interrupt(hal->regs, channel);
  840. }
  841. // TX Err interrupt
  842. status = rmt_ll_get_tx_err_interrupt_status(hal->regs);
  843. while (status) {
  844. channel = __builtin_ffs(status) - 1;
  845. status &= ~(1 << channel);
  846. rmt_obj_t *p_rmt = p_rmt_obj[channel];
  847. if (p_rmt) {
  848. // Reset the transmitter's write/read addresses to prevent endless err interrupts.
  849. rmt_ll_tx_reset_pointer(rmt_contex.hal.regs, channel);
  850. ESP_EARLY_LOGD(RMT_TAG, "RMT TX channel %d error", channel);
  851. ESP_EARLY_LOGD(RMT_TAG, "status: 0x%08x", rmt_ll_tx_get_channel_status(rmt_contex.hal.regs, channel));
  852. }
  853. rmt_ll_clear_tx_err_interrupt(hal->regs, channel);
  854. }
  855. if (HPTaskAwoken == pdTRUE) {
  856. portYIELD_FROM_ISR();
  857. }
  858. }
  859. esp_err_t rmt_driver_uninstall(rmt_channel_t channel)
  860. {
  861. esp_err_t err = ESP_OK;
  862. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  863. RMT_CHECK((rmt_contex.rmt_driver_channels & BIT(channel)) != 0, "No RMT driver for this channel", ESP_ERR_INVALID_STATE);
  864. if (p_rmt_obj[channel] == NULL) {
  865. return ESP_OK;
  866. }
  867. //Avoid blocking here(when the interrupt is disabled and do not wait tx done).
  868. if (p_rmt_obj[channel]->wait_done) {
  869. xSemaphoreTake(p_rmt_obj[channel]->tx_sem, portMAX_DELAY);
  870. }
  871. RMT_ENTER_CRITICAL();
  872. // check channel's working mode
  873. if (p_rmt_obj[channel]->rx_buf) {
  874. rmt_ll_enable_rx_end_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), 0);
  875. rmt_ll_enable_rx_err_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), 0);
  876. #if SOC_RMT_SUPPORT_RX_PINGPONG
  877. rmt_ll_enable_rx_thres_interrupt(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel), 0);
  878. #endif
  879. } else {
  880. rmt_ll_enable_tx_end_interrupt(rmt_contex.hal.regs, channel, 0);
  881. rmt_ll_enable_tx_err_interrupt(rmt_contex.hal.regs, channel, 0);
  882. rmt_ll_enable_tx_thres_interrupt(rmt_contex.hal.regs, channel, false);
  883. }
  884. RMT_EXIT_CRITICAL();
  885. _lock_acquire_recursive(&(rmt_contex.rmt_driver_isr_lock));
  886. rmt_contex.rmt_driver_channels &= ~BIT(channel);
  887. if (rmt_contex.rmt_driver_channels == 0) {
  888. rmt_module_disable();
  889. // all channels have driver disabled
  890. err = rmt_isr_deregister(rmt_contex.rmt_driver_intr_handle);
  891. rmt_contex.rmt_driver_intr_handle = NULL;
  892. }
  893. _lock_release_recursive(&(rmt_contex.rmt_driver_isr_lock));
  894. if (err != ESP_OK) {
  895. return err;
  896. }
  897. if (p_rmt_obj[channel]->tx_sem) {
  898. vSemaphoreDelete(p_rmt_obj[channel]->tx_sem);
  899. p_rmt_obj[channel]->tx_sem = NULL;
  900. }
  901. if (p_rmt_obj[channel]->rx_buf) {
  902. vRingbufferDelete(p_rmt_obj[channel]->rx_buf);
  903. p_rmt_obj[channel]->rx_buf = NULL;
  904. }
  905. if (p_rmt_obj[channel]->tx_buf) {
  906. free(p_rmt_obj[channel]->tx_buf);
  907. p_rmt_obj[channel]->tx_buf = NULL;
  908. }
  909. if (p_rmt_obj[channel]->sample_to_rmt) {
  910. p_rmt_obj[channel]->sample_to_rmt = NULL;
  911. }
  912. #if SOC_RMT_SUPPORT_RX_PINGPONG
  913. if (p_rmt_obj[channel]->rx_item_buf) {
  914. free(p_rmt_obj[channel]->rx_item_buf);
  915. p_rmt_obj[channel]->rx_item_buf = NULL;
  916. p_rmt_obj[channel]->rx_item_buf_size = 0;
  917. }
  918. #endif
  919. free(p_rmt_obj[channel]);
  920. p_rmt_obj[channel] = NULL;
  921. return ESP_OK;
  922. }
  923. esp_err_t rmt_driver_install(rmt_channel_t channel, size_t rx_buf_size, int intr_alloc_flags)
  924. {
  925. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  926. RMT_CHECK((rmt_contex.rmt_driver_channels & BIT(channel)) == 0,
  927. "RMT driver already installed for channel", ESP_ERR_INVALID_STATE);
  928. esp_err_t err = ESP_OK;
  929. if (p_rmt_obj[channel] != NULL) {
  930. ESP_LOGD(RMT_TAG, "RMT driver already installed");
  931. return ESP_ERR_INVALID_STATE;
  932. }
  933. #if !CONFIG_SPIRAM_USE_MALLOC
  934. p_rmt_obj[channel] = calloc(1, sizeof(rmt_obj_t));
  935. #else
  936. if (!(intr_alloc_flags & ESP_INTR_FLAG_IRAM)) {
  937. p_rmt_obj[channel] = calloc(1, sizeof(rmt_obj_t));
  938. } else {
  939. p_rmt_obj[channel] = heap_caps_calloc(1, sizeof(rmt_obj_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  940. }
  941. #endif
  942. if (p_rmt_obj[channel] == NULL) {
  943. ESP_LOGE(RMT_TAG, "RMT driver malloc error");
  944. return ESP_ERR_NO_MEM;
  945. }
  946. p_rmt_obj[channel]->tx_len_rem = 0;
  947. p_rmt_obj[channel]->tx_data = NULL;
  948. p_rmt_obj[channel]->channel = channel;
  949. p_rmt_obj[channel]->tx_offset = 0;
  950. p_rmt_obj[channel]->tx_sub_len = 0;
  951. p_rmt_obj[channel]->wait_done = false;
  952. p_rmt_obj[channel]->translator = false;
  953. p_rmt_obj[channel]->sample_to_rmt = NULL;
  954. if (p_rmt_obj[channel]->tx_sem == NULL) {
  955. #if !CONFIG_SPIRAM_USE_MALLOC
  956. p_rmt_obj[channel]->tx_sem = xSemaphoreCreateBinary();
  957. #else
  958. p_rmt_obj[channel]->intr_alloc_flags = intr_alloc_flags;
  959. if (!(intr_alloc_flags & ESP_INTR_FLAG_IRAM)) {
  960. p_rmt_obj[channel]->tx_sem = xSemaphoreCreateBinary();
  961. } else {
  962. p_rmt_obj[channel]->tx_sem = xSemaphoreCreateBinaryStatic(&p_rmt_obj[channel]->tx_sem_buffer);
  963. }
  964. #endif
  965. xSemaphoreGive(p_rmt_obj[channel]->tx_sem);
  966. }
  967. if (p_rmt_obj[channel]->rx_buf == NULL && rx_buf_size > 0) {
  968. p_rmt_obj[channel]->rx_buf = xRingbufferCreate(rx_buf_size, RINGBUF_TYPE_NOSPLIT);
  969. }
  970. #if SOC_RMT_SUPPORT_RX_PINGPONG
  971. if (p_rmt_obj[channel]->rx_item_buf == NULL && rx_buf_size > 0) {
  972. #if !CONFIG_SPIRAM_USE_MALLOC
  973. p_rmt_obj[channel]->rx_item_buf = calloc(1, rx_buf_size);
  974. #else
  975. if (!(p_rmt_obj[channel]->intr_alloc_flags & ESP_INTR_FLAG_IRAM)) {
  976. p_rmt_obj[channel]->rx_item_buf = calloc(1, rx_buf_size);
  977. } else {
  978. p_rmt_obj[channel]->rx_item_buf = heap_caps_calloc(1, rx_buf_size, MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  979. }
  980. #endif
  981. if (p_rmt_obj[channel]->rx_item_buf == NULL) {
  982. ESP_LOGE(RMT_TAG, "RMT malloc fail");
  983. return ESP_FAIL;
  984. }
  985. p_rmt_obj[channel]->rx_item_buf_size = rx_buf_size;
  986. }
  987. #endif
  988. _lock_acquire_recursive(&(rmt_contex.rmt_driver_isr_lock));
  989. if (rmt_contex.rmt_driver_channels == 0) {
  990. // first RMT channel using driver
  991. err = rmt_isr_register(rmt_driver_isr_default, &rmt_contex.hal, intr_alloc_flags, &(rmt_contex.rmt_driver_intr_handle));
  992. }
  993. if (err == ESP_OK) {
  994. rmt_contex.rmt_driver_channels |= BIT(channel);
  995. }
  996. _lock_release_recursive(&(rmt_contex.rmt_driver_isr_lock));
  997. rmt_module_enable();
  998. if (RMT_IS_RX_CHANNEL(channel)) {
  999. rmt_hal_rx_channel_reset(&rmt_contex.hal, RMT_DECODE_RX_CHANNEL(channel));
  1000. } else {
  1001. rmt_hal_tx_channel_reset(&rmt_contex.hal, channel);
  1002. }
  1003. return err;
  1004. }
  1005. esp_err_t rmt_write_items(rmt_channel_t channel, const rmt_item32_t *rmt_item, int item_num, bool wait_tx_done)
  1006. {
  1007. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1008. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  1009. RMT_CHECK(rmt_item != NULL, RMT_ADDR_ERROR_STR, ESP_FAIL);
  1010. RMT_CHECK(item_num > 0, RMT_DRIVER_LENGTH_ERROR_STR, ESP_ERR_INVALID_ARG);
  1011. #if CONFIG_SPIRAM_USE_MALLOC
  1012. if (p_rmt_obj[channel]->intr_alloc_flags & ESP_INTR_FLAG_IRAM) {
  1013. if (!esp_ptr_internal(rmt_item)) {
  1014. ESP_LOGE(RMT_TAG, RMT_PSRAM_BUFFER_WARN_STR);
  1015. return ESP_ERR_INVALID_ARG;
  1016. }
  1017. }
  1018. #endif
  1019. rmt_obj_t *p_rmt = p_rmt_obj[channel];
  1020. int block_num = rmt_ll_tx_get_mem_blocks(rmt_contex.hal.regs, channel);
  1021. int item_block_len = block_num * RMT_MEM_ITEM_NUM;
  1022. int item_sub_len = block_num * RMT_MEM_ITEM_NUM / 2;
  1023. int len_rem = item_num;
  1024. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  1025. // fill the memory block first
  1026. if (item_num >= item_block_len) {
  1027. rmt_fill_memory(channel, rmt_item, item_block_len, 0);
  1028. len_rem -= item_block_len;
  1029. rmt_set_tx_loop_mode(channel, false);
  1030. rmt_set_tx_thr_intr_en(channel, 1, item_sub_len);
  1031. p_rmt->tx_data = rmt_item + item_block_len;
  1032. p_rmt->tx_len_rem = len_rem;
  1033. p_rmt->tx_offset = 0;
  1034. p_rmt->tx_sub_len = item_sub_len;
  1035. } else {
  1036. rmt_fill_memory(channel, rmt_item, len_rem, 0);
  1037. rmt_item32_t stop_data = {0};
  1038. rmt_ll_write_memory(rmt_contex.hal.mem, channel, &stop_data, 1, len_rem);
  1039. p_rmt->tx_len_rem = 0;
  1040. }
  1041. rmt_tx_start(channel, true);
  1042. p_rmt->wait_done = wait_tx_done;
  1043. if (wait_tx_done) {
  1044. // wait loop done
  1045. if (rmt_ll_is_tx_loop_enabled(rmt_contex.hal.regs, channel)) {
  1046. #if SOC_RMT_SUPPORT_TX_LOOP_COUNT
  1047. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  1048. xSemaphoreGive(p_rmt->tx_sem);
  1049. #endif
  1050. } else {
  1051. // wait tx end
  1052. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  1053. xSemaphoreGive(p_rmt->tx_sem);
  1054. }
  1055. }
  1056. return ESP_OK;
  1057. }
  1058. esp_err_t rmt_wait_tx_done(rmt_channel_t channel, TickType_t wait_time)
  1059. {
  1060. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1061. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  1062. if (xSemaphoreTake(p_rmt_obj[channel]->tx_sem, wait_time) == pdTRUE) {
  1063. p_rmt_obj[channel]->wait_done = false;
  1064. xSemaphoreGive(p_rmt_obj[channel]->tx_sem);
  1065. return ESP_OK;
  1066. } else {
  1067. if (wait_time != 0) {
  1068. // Don't emit error message if just polling.
  1069. ESP_LOGE(RMT_TAG, "Timeout on wait_tx_done");
  1070. }
  1071. return ESP_ERR_TIMEOUT;
  1072. }
  1073. }
  1074. esp_err_t rmt_get_ringbuf_handle(rmt_channel_t channel, RingbufHandle_t *buf_handle)
  1075. {
  1076. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1077. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  1078. RMT_CHECK(buf_handle != NULL, RMT_ADDR_ERROR_STR, ESP_ERR_INVALID_ARG);
  1079. *buf_handle = p_rmt_obj[channel]->rx_buf;
  1080. return ESP_OK;
  1081. }
  1082. rmt_tx_end_callback_t rmt_register_tx_end_callback(rmt_tx_end_fn_t function, void *arg)
  1083. {
  1084. rmt_tx_end_callback_t previous = rmt_contex.rmt_tx_end_callback;
  1085. rmt_contex.rmt_tx_end_callback.function = function;
  1086. rmt_contex.rmt_tx_end_callback.arg = arg;
  1087. return previous;
  1088. }
  1089. esp_err_t rmt_translator_init(rmt_channel_t channel, sample_to_rmt_t fn)
  1090. {
  1091. RMT_CHECK(fn != NULL, RMT_TRANSLATOR_NULL_STR, ESP_ERR_INVALID_ARG);
  1092. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1093. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  1094. const uint32_t block_size = rmt_ll_tx_get_mem_blocks(rmt_contex.hal.regs, channel) *
  1095. RMT_MEM_ITEM_NUM * sizeof(rmt_item32_t);
  1096. if (p_rmt_obj[channel]->tx_buf == NULL) {
  1097. #if !CONFIG_SPIRAM_USE_MALLOC
  1098. p_rmt_obj[channel]->tx_buf = (rmt_item32_t *)malloc(block_size);
  1099. #else
  1100. if (p_rmt_obj[channel]->intr_alloc_flags & ESP_INTR_FLAG_IRAM) {
  1101. p_rmt_obj[channel]->tx_buf = (rmt_item32_t *)malloc(block_size);
  1102. } else {
  1103. p_rmt_obj[channel]->tx_buf = (rmt_item32_t *)heap_caps_calloc(1, block_size, MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  1104. }
  1105. #endif
  1106. if (p_rmt_obj[channel]->tx_buf == NULL) {
  1107. ESP_LOGE(RMT_TAG, "RMT translator buffer create fail");
  1108. return ESP_FAIL;
  1109. }
  1110. }
  1111. p_rmt_obj[channel]->sample_to_rmt = fn;
  1112. p_rmt_obj[channel]->sample_size_remain = 0;
  1113. p_rmt_obj[channel]->sample_cur = NULL;
  1114. ESP_LOGD(RMT_TAG, "RMT translator init done");
  1115. return ESP_OK;
  1116. }
  1117. esp_err_t rmt_write_sample(rmt_channel_t channel, const uint8_t *src, size_t src_size, bool wait_tx_done)
  1118. {
  1119. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1120. RMT_CHECK(p_rmt_obj[channel] != NULL, RMT_DRIVER_ERROR_STR, ESP_FAIL);
  1121. RMT_CHECK(p_rmt_obj[channel]->sample_to_rmt != NULL, RMT_TRANSLATOR_UNINIT_STR, ESP_FAIL);
  1122. #if CONFIG_SPIRAM_USE_MALLOC
  1123. if (p_rmt_obj[channel]->intr_alloc_flags & ESP_INTR_FLAG_IRAM) {
  1124. if (!esp_ptr_internal(src)) {
  1125. ESP_LOGE(RMT_TAG, RMT_PSRAM_BUFFER_WARN_STR);
  1126. return ESP_ERR_INVALID_ARG;
  1127. }
  1128. }
  1129. #endif
  1130. size_t item_num = 0;
  1131. size_t translated_size = 0;
  1132. rmt_obj_t *p_rmt = p_rmt_obj[channel];
  1133. const uint32_t item_block_len = rmt_ll_tx_get_mem_blocks(rmt_contex.hal.regs, channel) * RMT_MEM_ITEM_NUM;
  1134. const uint32_t item_sub_len = item_block_len / 2;
  1135. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  1136. p_rmt->sample_to_rmt((void *)src, p_rmt->tx_buf, src_size, item_block_len, &translated_size, &item_num);
  1137. p_rmt->sample_size_remain = src_size - translated_size;
  1138. p_rmt->sample_cur = src + translated_size;
  1139. rmt_fill_memory(channel, p_rmt->tx_buf, item_num, 0);
  1140. if (item_num == item_block_len) {
  1141. rmt_set_tx_thr_intr_en(channel, 1, item_sub_len);
  1142. p_rmt->tx_data = p_rmt->tx_buf;
  1143. p_rmt->tx_offset = 0;
  1144. p_rmt->tx_sub_len = item_sub_len;
  1145. p_rmt->translator = true;
  1146. } else {
  1147. rmt_item32_t stop_data = {0};
  1148. rmt_ll_write_memory(rmt_contex.hal.mem, channel, &stop_data, 1, item_num);
  1149. p_rmt->tx_len_rem = 0;
  1150. p_rmt->sample_cur = NULL;
  1151. p_rmt->translator = false;
  1152. }
  1153. rmt_tx_start(channel, true);
  1154. p_rmt->wait_done = wait_tx_done;
  1155. if (wait_tx_done) {
  1156. xSemaphoreTake(p_rmt->tx_sem, portMAX_DELAY);
  1157. xSemaphoreGive(p_rmt->tx_sem);
  1158. }
  1159. return ESP_OK;
  1160. }
  1161. esp_err_t rmt_get_channel_status(rmt_channel_status_result_t *channel_status)
  1162. {
  1163. RMT_CHECK(channel_status != NULL, RMT_PARAM_ERR_STR, ESP_ERR_INVALID_ARG);
  1164. for (int i = 0; i < RMT_CHANNEL_MAX; i++) {
  1165. channel_status->status[i] = RMT_CHANNEL_UNINIT;
  1166. if (p_rmt_obj[i] != NULL) {
  1167. if (p_rmt_obj[i]->tx_sem != NULL) {
  1168. if (xSemaphoreTake(p_rmt_obj[i]->tx_sem, (TickType_t)0) == pdTRUE) {
  1169. channel_status->status[i] = RMT_CHANNEL_IDLE;
  1170. xSemaphoreGive(p_rmt_obj[i]->tx_sem);
  1171. } else {
  1172. channel_status->status[i] = RMT_CHANNEL_BUSY;
  1173. }
  1174. }
  1175. }
  1176. }
  1177. return ESP_OK;
  1178. }
  1179. esp_err_t rmt_get_counter_clock(rmt_channel_t channel, uint32_t *clock_hz)
  1180. {
  1181. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1182. RMT_CHECK(clock_hz, "parameter clock_hz can't be null", ESP_ERR_INVALID_ARG);
  1183. RMT_ENTER_CRITICAL();
  1184. uint32_t rmt_source_clk_hz = 0;
  1185. #if SOC_RMT_SOURCE_CLK_INDEPENDENT
  1186. rmt_source_clk_hz = s_rmt_source_clock_hz[channel];
  1187. #else
  1188. rmt_source_clk_hz = s_rmt_source_clock_hz;
  1189. #endif
  1190. if (RMT_IS_RX_CHANNEL(channel)) {
  1191. *clock_hz = rmt_source_clk_hz / rmt_ll_rx_get_counter_clock_div(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  1192. } else {
  1193. *clock_hz = rmt_source_clk_hz / rmt_ll_tx_get_counter_clock_div(rmt_contex.hal.regs, channel);
  1194. }
  1195. RMT_EXIT_CRITICAL();
  1196. return ESP_OK;
  1197. }
  1198. #if SOC_RMT_SUPPORT_TX_GROUP
  1199. esp_err_t rmt_add_channel_to_group(rmt_channel_t channel)
  1200. {
  1201. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1202. RMT_ENTER_CRITICAL();
  1203. rmt_ll_tx_enable_sync(rmt_contex.hal.regs, true);
  1204. rmt_ll_tx_add_channel_to_group(rmt_contex.hal.regs, channel);
  1205. rmt_ll_tx_reset_counter_clock_div(rmt_contex.hal.regs, channel);
  1206. RMT_EXIT_CRITICAL();
  1207. return ESP_OK;
  1208. }
  1209. esp_err_t rmt_remove_channel_from_group(rmt_channel_t channel)
  1210. {
  1211. RMT_CHECK(RMT_IS_TX_CHANNEL(channel), RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1212. RMT_ENTER_CRITICAL();
  1213. if (rmt_ll_tx_remove_channel_from_group(rmt_contex.hal.regs, channel) == 0) {
  1214. rmt_ll_tx_enable_sync(rmt_contex.hal.regs, false);
  1215. }
  1216. RMT_EXIT_CRITICAL();
  1217. return ESP_OK;
  1218. }
  1219. esp_err_t rmt_memory_rw_rst(rmt_channel_t channel)
  1220. {
  1221. RMT_CHECK(channel < RMT_CHANNEL_MAX, RMT_CHANNEL_ERROR_STR, ESP_ERR_INVALID_ARG);
  1222. RMT_ENTER_CRITICAL();
  1223. if (RMT_IS_RX_CHANNEL(channel)) {
  1224. rmt_ll_rx_reset_pointer(rmt_contex.hal.regs, RMT_DECODE_RX_CHANNEL(channel));
  1225. } else {
  1226. rmt_ll_tx_reset_pointer(rmt_contex.hal.regs, channel);
  1227. }
  1228. RMT_EXIT_CRITICAL();
  1229. return ESP_OK;
  1230. }
  1231. #endif