knx
ETS configurable knx-stack
esp32_idf_platform.cpp
Go to the documentation of this file.
1 #ifndef ARDUINO
2 #ifdef ESP_PLATFORM
3 // esp32_idf_platform.cpp
4 #include <esp_system.h>
5 #include <esp_mac.h>
6 #include "esp32_idf_platform.h"
7 #include "esp_log.h"
8 #include "knx/bits.h"
9 #include "nvs.h"
10 #include <esp_timer.h>
11 
12 static const char* KTAG = "KNX_LIB";
13 
15  : _uart_num(uart_num)
16 {
17  // Set the memory type to use our NVS-based EEPROM emulation
19 }
20 
22 {
23  if (_sock != -1)
24  {
26  }
27  if (_uart_installed)
28  {
29  closeUart();
30  }
31  if (_eeprom_buffer)
32  {
33  free(_eeprom_buffer);
34  }
35  if (_nvs_handle)
36  {
37  nvs_close(_nvs_handle);
38  }
39 }
40 
41 void Esp32IdfPlatform::knxUartPins(int8_t rxPin, int8_t txPin)
42 {
43  _rxPin = rxPin;
44  _txPin = txPin;
45 }
46 
47 void Esp32IdfPlatform::knxUartBaudRate(uint32_t baudRate)
48 {
49  _baudRate = baudRate;
50  ESP_LOGI(KTAG, "UART baud rate set to %lu", _baudRate);
51 }
52 
53 void Esp32IdfPlatform::setNetif(esp_netif_t* netif)
54 {
55  _netif = netif;
56 }
57 
59 {
60  ESP_LOGE(KTAG, "FATAL ERROR. System halted.");
61  // Loop forever to halt the system
62  while (1)
63  {
64  vTaskDelay(pdMS_TO_TICKS(1000));
65  }
66 }
67 
68 // ESP specific uart handling with pins
70 {
71  if (_uart_installed)
72  return;
73  uart_config_t uart_config;
74  memset(&uart_config, 0, sizeof(uart_config));
75  uart_config.baud_rate = _baudRate; // Use configurable baud rate
76  uart_config.data_bits = UART_DATA_8_BITS;
77  uart_config.parity = UART_PARITY_EVEN;
78  uart_config.stop_bits = UART_STOP_BITS_1;
79  uart_config.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
80  uart_config.source_clk = UART_SCLK_DEFAULT;
81 
82  ESP_ERROR_CHECK(uart_driver_install(_uart_num, 256 * 2, 0, 0, NULL, 0));
83  ESP_ERROR_CHECK(uart_param_config(_uart_num, &uart_config));
84  ESP_ERROR_CHECK(uart_set_pin(_uart_num, _txPin, _rxPin, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE));
85  _uart_installed = true;
86  ESP_LOGI(KTAG, "UART initialized with baud rate %lu", _baudRate);
87 }
88 
90 {
91  if (!_uart_installed)
92  return;
93  uart_driver_delete(_uart_num);
94  _uart_installed = false;
95 }
96 
98 {
99  if (!_uart_installed)
100  return 0;
101  size_t length = 0;
102  ESP_ERROR_CHECK(uart_get_buffered_data_len(_uart_num, &length));
103  return length;
104 }
105 
106 size_t Esp32IdfPlatform::writeUart(const uint8_t data)
107 {
108  if (!_uart_installed)
109  return 0;
110  return uart_write_bytes(_uart_num, &data, 1);
111 }
112 
113 size_t Esp32IdfPlatform::writeUart(const uint8_t* buffer, size_t size)
114 {
115  if (!_uart_installed)
116  return 0;
117  return uart_write_bytes(_uart_num, buffer, size);
118 }
119 
121 {
122  if (!_uart_installed)
123  return -1;
124  uint8_t data;
125  if (uart_read_bytes(_uart_num, &data, 1, pdMS_TO_TICKS(20)) > 0)
126  {
127  return data;
128  }
129  return -1;
130 }
131 
132 size_t Esp32IdfPlatform::readBytesUart(uint8_t* buffer, size_t length)
133 {
134  if (!_uart_installed)
135  return 0;
136  return uart_read_bytes(_uart_num, buffer, length, pdMS_TO_TICKS(100));
137 }
138 
140 {
141  if (!_uart_installed)
142  return;
143  ESP_ERROR_CHECK(uart_flush(_uart_num));
144 }
145 
147 {
148  if (!_netif)
149  return 0;
150  esp_netif_ip_info_t ip_info;
151  esp_netif_get_ip_info(_netif, &ip_info);
152  return ip_info.ip.addr;
153 }
154 
156 {
157  if (!_netif)
158  return 0;
159  esp_netif_ip_info_t ip_info;
160  esp_netif_get_ip_info(_netif, &ip_info);
161  return ip_info.netmask.addr;
162 }
163 
165 {
166  if (!_netif)
167  return 0;
168  esp_netif_ip_info_t ip_info;
169  esp_netif_get_ip_info(_netif, &ip_info);
170  return ip_info.gw.addr;
171 }
172 
173 void Esp32IdfPlatform::macAddress(uint8_t* addr)
174 {
175  if (!_netif)
176  return;
177  esp_netif_get_mac(_netif, addr);
178 }
179 
181 {
182  uint8_t mac[6];
183  esp_efuse_mac_get_default(mac);
184  uint64_t chipid = 0;
185  for (int i = 0; i < 6; i++)
186  {
187  chipid |= ((uint64_t)mac[i] << (i * 8));
188  }
189  uint32_t upperId = (chipid >> 32) & 0xFFFFFFFF;
190  uint32_t lowerId = (chipid & 0xFFFFFFFF);
191  return (upperId ^ lowerId);
192 }
193 
195 {
196  ESP_LOGI(KTAG, "Restarting system...");
197  esp_restart();
198 }
199 
200 void Esp32IdfPlatform::setupMultiCast(uint32_t addr, uint16_t port)
201 {
202  _multicast_addr = addr;
203  _multicast_port = port;
204 
205  _sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP);
206  if (_sock < 0)
207  {
208  ESP_LOGE(KTAG, "Failed to create socket. Errno: %d", errno);
209  return;
210  }
211 
212  struct sockaddr_in saddr;
213  memset(&saddr, 0, sizeof(saddr));
214  saddr.sin_family = AF_INET;
215  saddr.sin_port = htons(port);
216  saddr.sin_addr.s_addr = htonl(INADDR_ANY);
217  if (bind(_sock, (struct sockaddr*)&saddr, sizeof(struct sockaddr_in)) < 0)
218  {
219  ESP_LOGE(KTAG, "Failed to bind socket. Errno: %d", errno);
220  close(_sock);
221  _sock = -1;
222  return;
223  }
224 
225  struct ip_mreq imreq;
226  memset(&imreq, 0, sizeof(imreq));
227  imreq.imr_interface.s_addr = IPADDR_ANY;
228  imreq.imr_multiaddr.s_addr = addr;
229  if (setsockopt(_sock, IPPROTO_IP, IP_ADD_MEMBERSHIP, &imreq, sizeof(struct ip_mreq)) < 0)
230  {
231  ESP_LOGE(KTAG, "Failed to join multicast group. Errno: %d", errno);
232  close(_sock);
233  _sock = -1;
234  return;
235  }
236 
237  ESP_LOGI(KTAG, "Successfully joined multicast group on port %d", port);
238 }
239 
241 {
242  if (_sock != -1)
243  {
244  close(_sock);
245  _sock = -1;
246  }
247 }
248 
249 bool Esp32IdfPlatform::sendBytesMultiCast(uint8_t* buffer, uint16_t len)
250 {
251  if (_sock < 0)
252  return false;
253 
254  struct sockaddr_in dest_addr = {};
255  dest_addr.sin_family = AF_INET;
256  dest_addr.sin_port = htons(_multicast_port);
257  dest_addr.sin_addr.s_addr = _multicast_addr;
258 
259  int sent_len = sendto(_sock, buffer, len, 0, (struct sockaddr*)&dest_addr, sizeof(dest_addr));
260  if (sent_len < 0)
261  {
262  ESP_LOGE(KTAG, "sendBytesMultiCast failed. Errno: %d", errno);
263  return false;
264  }
265  return sent_len == len;
266 }
267 
268 int Esp32IdfPlatform::readBytesMultiCast(uint8_t* buffer, uint16_t maxLen, uint32_t& src_addr, uint16_t& src_port)
269 {
270  if (_sock < 0)
271  return 0;
272 
273  socklen_t socklen = sizeof(_remote_addr);
274  int len = recvfrom(_sock, buffer, maxLen, 0, (struct sockaddr*)&_remote_addr, &socklen);
275 
276  if (len <= 0)
277  {
278  return 0; // No data or error
279  }
280 
281  src_addr = _remote_addr.sin_addr.s_addr;
282  src_port = ntohs(_remote_addr.sin_port);
283 
284  return len;
285 }
286 
287 bool Esp32IdfPlatform::sendBytesUniCast(uint32_t addr, uint16_t port, uint8_t* buffer, uint16_t len)
288 {
289  if (_sock < 0)
290  return false;
291 
292  struct sockaddr_in dest_addr;
293  dest_addr.sin_family = AF_INET;
294 
295  if (addr == 0)
296  { // If address is 0, use the address from the last received packet
297  dest_addr.sin_addr.s_addr = _remote_addr.sin_addr.s_addr;
298  }
299  else
300  {
301  dest_addr.sin_addr.s_addr = addr;
302  }
303 
304  if (port == 0)
305  { // If port is 0, use the port from the last received packet
306  dest_addr.sin_port = _remote_addr.sin_port;
307  }
308  else
309  {
310  dest_addr.sin_port = htons(port);
311  }
312 
313  if (sendto(_sock, buffer, len, 0, (struct sockaddr*)&dest_addr, sizeof(dest_addr)) < 0)
314  {
315  ESP_LOGE(KTAG, "sendBytesUniCast failed. Errno: %d", errno);
316  return false;
317  }
318 
319  return true;
320 }
321 
322 uint8_t* Esp32IdfPlatform::getEepromBuffer(uint32_t size)
323 {
324  if (_eeprom_buffer && _eeprom_size == size)
325  {
326  return _eeprom_buffer;
327  }
328 
329  if (_eeprom_buffer)
330  {
331  free(_eeprom_buffer);
332  _eeprom_buffer = nullptr;
333  }
334 
335  _eeprom_size = size;
336  _eeprom_buffer = (uint8_t*)malloc(size);
337  if (!_eeprom_buffer)
338  {
339  ESP_LOGE(KTAG, "Failed to allocate EEPROM buffer");
340  fatalError();
341  return nullptr;
342  }
343 
344  esp_err_t err = nvs_flash_init();
345  if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND)
346  {
347  ESP_ERROR_CHECK(nvs_flash_erase());
348  err = nvs_flash_init();
349  }
350  ESP_ERROR_CHECK(err);
351 
352  err = nvs_open(_nvs_namespace, NVS_READWRITE, &_nvs_handle);
353  if (err != ESP_OK)
354  {
355  ESP_LOGE(KTAG, "Error opening NVS handle: %s", esp_err_to_name(err));
356  free(_eeprom_buffer);
357  _eeprom_buffer = nullptr;
358  fatalError();
359  return nullptr;
360  }
361 
362  size_t required_size = size;
363  err = nvs_get_blob(_nvs_handle, _nvs_key, _eeprom_buffer, &required_size);
364  if (err != ESP_OK || required_size != size)
365  {
366  if (err == ESP_ERR_NVS_NOT_FOUND)
367  {
368  ESP_LOGI(KTAG, "No previous EEPROM data found in NVS. Initializing fresh buffer.");
369  }
370  else
371  {
372  ESP_LOGW(KTAG, "NVS get blob failed (%s) or size mismatch. Initializing fresh buffer.", esp_err_to_name(err));
373  }
374  memset(_eeprom_buffer, 0xFF, size);
375  }
376  else
377  {
378  ESP_LOGI(KTAG, "Successfully loaded %d bytes from NVS into EEPROM buffer.", required_size);
379  }
380 
381  return _eeprom_buffer;
382 }
383 
385 {
386  if (!_eeprom_buffer || !_nvs_handle)
387  {
388  ESP_LOGE(KTAG, "EEPROM not initialized, cannot commit.");
389  return;
390  }
391 
392  esp_err_t err = nvs_set_blob(_nvs_handle, _nvs_key, _eeprom_buffer, _eeprom_size);
393  if (err != ESP_OK)
394  {
395  ESP_LOGE(KTAG, "Failed to set NVS blob: %s", esp_err_to_name(err));
396  return;
397  }
398 
399  err = nvs_commit(_nvs_handle);
400  if (err != ESP_OK)
401  {
402  ESP_LOGE(KTAG, "Failed to commit NVS: %s", esp_err_to_name(err));
403  }
404  else
405  {
406  ESP_LOGI(KTAG, "Committed %" PRIu32 " bytes to NVS.", _eeprom_size);
407  }
408 }
409 
410 uint32_t millis()
411 {
412  // esp_timer_get_time() returns microseconds, so we divide by 1000 for milliseconds.
413  // Cast to uint32_t to match the Arduino function signature.
414  return (uint32_t)(esp_timer_get_time() / 1000);
415 }
416 
417 // Internal wrapper function to bridge Arduino-style ISR to ESP-IDF
418 static void IRAM_ATTR isr_wrapper(void* arg)
419 {
420  IsrFuncPtr fn = (IsrFuncPtr)arg;
421  fn(); // call the original ISR
422 }
423 
424 // Implement attachInterrupt arduino like in ESP IDF
425 void attachInterrupt(uint32_t pin, IsrFuncPtr callback, uint32_t mode)
426 {
427  gpio_config_t io_conf = {
428  .pin_bit_mask = (1ULL << pin),
429  .mode = GPIO_MODE_INPUT,
430  .pull_up_en = GPIO_PULLUP_ENABLE,
431  .pull_down_en = GPIO_PULLDOWN_DISABLE,
432  .intr_type = (gpio_int_type_t)mode
433  };
434 
435  ESP_ERROR_CHECK(gpio_config(&io_conf));
436 
437  ESP_ERROR_CHECK(gpio_install_isr_service(0));
438  // Add ISR using the wrapper and pass original function as argument
439  ESP_ERROR_CHECK(gpio_isr_handler_add((gpio_num_t)pin, isr_wrapper, (void*)callback));
440 }
441 
442 #endif // ESP_PLATFORM
443 #endif // !ARDUINO
void(* IsrFuncPtr)()
uint8_t * getEepromBuffer(uint32_t size) override
size_t writeUart(const uint8_t data) override
void macAddress(uint8_t *addr) override
void flushUart() override
uint32_t currentIpAddress() override
bool sendBytesUniCast(uint32_t addr, uint16_t port, uint8_t *buffer, uint16_t len) override
uint32_t uniqueSerialNumber() override
uint32_t currentSubnetMask() override
void knxUartBaudRate(uint32_t baudRate)
int readUart() override
bool sendBytesMultiCast(uint8_t *buffer, uint16_t len) override
void setupMultiCast(uint32_t addr, uint16_t port) override
size_t readBytesUart(uint8_t *buffer, size_t length) override
int readBytesMultiCast(uint8_t *buffer, uint16_t maxLen, uint32_t &src_addr, uint16_t &src_port) override
uint32_t currentDefaultGateway() override
void setNetif(esp_netif_t *netif)
void restart() override
int uartAvailable() override
void commitToEeprom() override
void closeMultiCast() override
void knxUartPins(int8_t rxPin, int8_t txPin)
void setupUart() override
void fatalError() override
void closeUart() override
Esp32IdfPlatform(uart_port_t uart_num=UART_NUM_1)
NvMemoryType _memoryType
Definition: platform.h:130
void attachInterrupt(uint32_t pin, IsrFuncPtr callback, uint32_t mode)
uint32_t millis()
@ Eeprom
Definition: platform.h:26