rmt.c 54 KB

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