blob: bf6b565e8cd199e12e60ba3b15500c56d30f6936 [file] [log] [blame]
Eric Poulsen29dd6a72017-09-27 14:59:49 -07001/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2017 "Eric Poulsen" <eric@zyxod.com>
Tobias Eydam48437ce2021-04-18 21:38:36 +02007 * Copyright (c) 2021 "Tobias Eydam" <tobiaseydam@hotmail.com>
Eric Poulsen29dd6a72017-09-27 14:59:49 -07008 *
9 * Based on the ESP IDF example code which is Public Domain / CC0
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 */
29
30#include "py/runtime.h"
31#include "py/mphal.h"
32
Damien Tournoude982c1d2023-01-12 21:04:07 -080033#if MICROPY_PY_NETWORK_LAN
Tobias Eydam48437ce2021-04-18 21:38:36 +020034
35#include "esp_eth.h"
36#include "esp_eth_mac.h"
Glenn Moloney288a0362024-07-08 17:33:53 +100037#include "esp_mac.h"
Tobias Eydam48437ce2021-04-18 21:38:36 +020038#include "esp_event.h"
39#include "esp_log.h"
40#include "esp_netif.h"
Damien Tournoude982c1d2023-01-12 21:04:07 -080041#if CONFIG_ETH_USE_SPI_ETHERNET
42#include "driver/spi_master.h"
43#endif
Eric Poulsen29dd6a72017-09-27 14:59:49 -070044
45#include "modnetwork.h"
robert-hhbbbd4842023-10-20 21:34:46 +020046#include "extmod/modnetwork.h"
Eric Poulsen29dd6a72017-09-27 14:59:49 -070047
Angus Gratton10f6c062025-02-05 10:42:55 +110048#if PHY_LAN867X_ENABLED
49#include "esp_eth_phy_lan867x.h"
50#endif
51
Eric Poulsen29dd6a72017-09-27 14:59:49 -070052typedef struct _lan_if_obj_t {
Damien Georgee4650122023-05-09 09:52:54 +100053 base_if_obj_t base;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070054 bool initialized;
Damien Tournoude982c1d2023-01-12 21:04:07 -080055 int8_t mdc_pin;
56 int8_t mdio_pin;
robert-hhcdfc6c12024-03-03 12:54:33 +010057 int8_t phy_reset_pin;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070058 int8_t phy_power_pin;
Damien Tournoude982c1d2023-01-12 21:04:07 -080059 int8_t phy_cs_pin;
60 int8_t phy_int_pin;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070061 uint8_t phy_addr;
62 uint8_t phy_type;
Tobias Eydam48437ce2021-04-18 21:38:36 +020063 esp_eth_phy_t *phy;
Tobias Eydam48437ce2021-04-18 21:38:36 +020064 esp_eth_handle_t eth_handle;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070065} lan_if_obj_t;
66
67const mp_obj_type_t lan_if_type;
Angus Grattondecf8e62024-02-27 15:32:29 +110068static lan_if_obj_t lan_obj = {{{&lan_if_type}, ESP_IF_ETH, NULL}, false, false};
69static uint8_t eth_status = 0;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070070
Tobias Eydam48437ce2021-04-18 21:38:36 +020071static void eth_event_handler(void *arg, esp_event_base_t event_base,
72 int32_t event_id, void *event_data) {
73 switch (event_id) {
74 case ETHERNET_EVENT_CONNECTED:
75 eth_status = ETH_CONNECTED;
76 ESP_LOGI("ethernet", "Ethernet Link Up");
77 break;
78 case ETHERNET_EVENT_DISCONNECTED:
79 eth_status = ETH_DISCONNECTED;
80 ESP_LOGI("ethernet", "Ethernet Link Down");
81 break;
82 case ETHERNET_EVENT_START:
83 eth_status = ETH_STARTED;
84 ESP_LOGI("ethernet", "Ethernet Started");
85 break;
86 case ETHERNET_EVENT_STOP:
87 eth_status = ETH_STOPPED;
88 ESP_LOGI("ethernet", "Ethernet Stopped");
89 break;
90 case IP_EVENT_ETH_GOT_IP:
91 eth_status = ETH_GOT_IP;
92 ESP_LOGI("ethernet", "Ethernet Got IP");
93 break;
94 default:
95 break;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070096 }
97}
98
Glenn Moloney288a0362024-07-08 17:33:53 +100099static void set_mac_address(lan_if_obj_t *self, uint8_t *mac, size_t len) {
100 if (len != 6) {
101 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
102 }
103 if (((mac[0] & 0x01) != 0) ||
104 (esp_eth_ioctl(self->eth_handle, ETH_CMD_S_MAC_ADDR, mac) != ESP_OK) ||
105 (esp_netif_set_mac(self->base.netif, mac) != ESP_OK)) {
106 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("failed setting MAC address"));
107 }
108}
109
Angus Grattondecf8e62024-02-27 15:32:29 +1100110static mp_obj_t get_lan(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
Damien George69661f32020-02-27 15:36:53 +1100111 lan_if_obj_t *self = &lan_obj;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700112
113 if (self->initialized) {
114 return MP_OBJ_FROM_PTR(&lan_obj);
115 }
116
robert-hhcdfc6c12024-03-03 12:54:33 +0100117 enum { ARG_id, ARG_mdc, ARG_mdio, ARG_reset, ARG_power, ARG_phy_addr, ARG_phy_type,
Damien George67097d82023-01-18 13:47:10 +1100118 ARG_spi, ARG_cs, ARG_int, ARG_ref_clk_mode, ARG_ref_clk };
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700119 static const mp_arg_t allowed_args[] = {
120 { MP_QSTR_id, MP_ARG_OBJ, {.u_obj = mp_const_none} },
Damien Tournoude982c1d2023-01-12 21:04:07 -0800121 { MP_QSTR_mdc, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
122 { MP_QSTR_mdio, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
robert-hhcdfc6c12024-03-03 12:54:33 +0100123 { MP_QSTR_reset, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Petr Kracík5801a002019-02-17 14:02:02 +0100124 { MP_QSTR_power, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700125 { MP_QSTR_phy_addr, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
126 { MP_QSTR_phy_type, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
Damien George67097d82023-01-18 13:47:10 +1100127 { MP_QSTR_spi, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
128 { MP_QSTR_cs, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
129 { MP_QSTR_int, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
robert-hh4b520032022-12-24 16:52:55 +0100130 { MP_QSTR_ref_clk_mode, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = -1} },
131 { MP_QSTR_ref_clk, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700132 };
133
134 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
135 mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
136
137 if (args[ARG_id].u_obj != mp_const_none) {
138 if (mp_obj_get_int(args[ARG_id].u_obj) != 0) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100139 mp_raise_ValueError(MP_ERROR_TEXT("invalid LAN interface identifier"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700140 }
141 }
142
Damien Tournoude982c1d2023-01-12 21:04:07 -0800143 #define GET_PIN(XXX) args[XXX].u_obj == mp_const_none ? -1 : machine_pin_get_id(args[XXX].u_obj);
144
145 self->mdc_pin = GET_PIN(ARG_mdc);
146 self->mdio_pin = GET_PIN(ARG_mdio);
robert-hhcdfc6c12024-03-03 12:54:33 +0100147 self->phy_reset_pin = GET_PIN(ARG_reset);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800148 self->phy_power_pin = GET_PIN(ARG_power);
149 self->phy_cs_pin = GET_PIN(ARG_cs);
150 self->phy_int_pin = GET_PIN(ARG_int);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700151
152 if (args[ARG_phy_addr].u_int < 0x00 || args[ARG_phy_addr].u_int > 0x1f) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100153 mp_raise_ValueError(MP_ERROR_TEXT("invalid phy address"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700154 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200155 self->phy_addr = args[ARG_phy_addr].u_int;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700156
robert-hhefb4bd32022-12-24 09:37:02 +0100157 if (args[ARG_phy_type].u_int != PHY_LAN8710 &&
158 args[ARG_phy_type].u_int != PHY_LAN8720 &&
Tobias Eydam48437ce2021-04-18 21:38:36 +0200159 args[ARG_phy_type].u_int != PHY_IP101 &&
160 args[ARG_phy_type].u_int != PHY_RTL8201 &&
Tobias Eydam48437ce2021-04-18 21:38:36 +0200161 args[ARG_phy_type].u_int != PHY_KSZ8041 &&
ma-lalonde30db33d2022-05-30 01:16:51 -0400162 args[ARG_phy_type].u_int != PHY_KSZ8081 &&
Angus Gratton10f6c062025-02-05 10:42:55 +1100163 #if PHY_LAN867X_ENABLED
164 args[ARG_phy_type].u_int != PHY_LAN8670 &&
165 #endif
Damien Tournoude982c1d2023-01-12 21:04:07 -0800166 #if CONFIG_ETH_USE_SPI_ETHERNET
167 #if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
168 args[ARG_phy_type].u_int != PHY_KSZ8851SNL &&
169 #endif
170 #if CONFIG_ETH_SPI_ETHERNET_DM9051
171 args[ARG_phy_type].u_int != PHY_DM9051 &&
172 #endif
173 #if CONFIG_ETH_SPI_ETHERNET_W5500
174 args[ARG_phy_type].u_int != PHY_W5500 &&
175 #endif
176 #endif
Tobias Eydam48437ce2021-04-18 21:38:36 +0200177 args[ARG_phy_type].u_int != PHY_DP83848) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100178 mp_raise_ValueError(MP_ERROR_TEXT("invalid phy type"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700179 }
180
Tobias Eydam48437ce2021-04-18 21:38:36 +0200181 eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG();
Damien Georgee4650122023-05-09 09:52:54 +1000182 #if CONFIG_IDF_TARGET_ESP32
183 eth_esp32_emac_config_t esp32_config = ETH_ESP32_EMAC_DEFAULT_CONFIG();
184 #endif
185
Damien Tournoude982c1d2023-01-12 21:04:07 -0800186 esp_eth_mac_t *mac = NULL;
187
Damien Georgee4650122023-05-09 09:52:54 +1000188 #if CONFIG_IDF_TARGET_ESP32
189 // Dynamic ref_clk configuration.
robert-hh4b520032022-12-24 16:52:55 +0100190 if (args[ARG_ref_clk_mode].u_int != -1) {
191 // Map the GPIO_MODE constants to EMAC_CLK constants.
Damien Georgee4650122023-05-09 09:52:54 +1000192 esp32_config.clock_config.rmii.clock_mode =
robert-hh4b520032022-12-24 16:52:55 +0100193 args[ARG_ref_clk_mode].u_int == GPIO_MODE_INPUT ? EMAC_CLK_EXT_IN : EMAC_CLK_OUT;
194 }
195 if (args[ARG_ref_clk].u_obj != mp_const_none) {
Damien Georgee4650122023-05-09 09:52:54 +1000196 esp32_config.clock_config.rmii.clock_gpio = machine_pin_get_id(args[ARG_ref_clk].u_obj);
robert-hh4b520032022-12-24 16:52:55 +0100197 }
198 #endif
Petr Kracík7d8c71c2019-02-17 11:46:23 +0100199
Tobias Eydam48437ce2021-04-18 21:38:36 +0200200 eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG();
201 phy_config.phy_addr = self->phy_addr;
robert-hhcdfc6c12024-03-03 12:54:33 +0100202 phy_config.reset_gpio_num = self->phy_reset_pin;
Tobias Eydam48437ce2021-04-18 21:38:36 +0200203 self->phy = NULL;
robert-hhcdfc6c12024-03-03 12:54:33 +0100204 // Switch on the power before PHY is reset
205 if (self->phy_power_pin >= 0) {
206 mp_hal_pin_output(self->phy_power_pin);
207 mp_hal_pin_write(self->phy_power_pin, 1);
208 // let the power settle
209 mp_hal_delay_ms(100);
210 }
Damien Tournoude982c1d2023-01-12 21:04:07 -0800211 #if CONFIG_ETH_USE_SPI_ETHERNET
robert-hhc4e63ac2023-10-17 21:48:18 +0200212 spi_device_interface_config_t devcfg = {
213 .mode = 0,
214 .clock_speed_hz = MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ * 1000 * 1000,
215 .queue_size = 20,
216 .spics_io_num = self->phy_cs_pin,
217 .command_bits = 0, // Can both be set to 0, as the respective
218 .address_bits = 0, // driver fills in proper default values.
219 };
Damien Tournoude982c1d2023-01-12 21:04:07 -0800220 #endif
221
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700222 switch (args[ARG_phy_type].u_int) {
Damien Tournoude982c1d2023-01-12 21:04:07 -0800223 #if CONFIG_IDF_TARGET_ESP32
robert-hhefb4bd32022-12-24 09:37:02 +0100224 case PHY_LAN8710:
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700225 case PHY_LAN8720:
Damien Georgee4650122023-05-09 09:52:54 +1000226 self->phy = esp_eth_phy_new_lan87xx(&phy_config);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700227 break;
Kenneth Ryerson76fefad2020-04-20 09:51:11 -0500228 case PHY_IP101:
Tobias Eydam48437ce2021-04-18 21:38:36 +0200229 self->phy = esp_eth_phy_new_ip101(&phy_config);
Kenneth Ryerson76fefad2020-04-20 09:51:11 -0500230 break;
Tobias Eydam48437ce2021-04-18 21:38:36 +0200231 case PHY_RTL8201:
232 self->phy = esp_eth_phy_new_rtl8201(&phy_config);
233 break;
234 case PHY_DP83848:
235 self->phy = esp_eth_phy_new_dp83848(&phy_config);
236 break;
237 case PHY_KSZ8041:
ma-lalonde30db33d2022-05-30 01:16:51 -0400238 case PHY_KSZ8081:
Damien Georgee4650122023-05-09 09:52:54 +1000239 self->phy = esp_eth_phy_new_ksz80xx(&phy_config);
ma-lalonde30db33d2022-05-30 01:16:51 -0400240 break;
Angus Gratton10f6c062025-02-05 10:42:55 +1100241 #if PHY_LAN867X_ENABLED
242 case PHY_LAN8670:
243 self->phy = esp_eth_phy_new_lan867x(&phy_config);
244 break;
ma-lalonde30db33d2022-05-30 01:16:51 -0400245 #endif
Angus Gratton10f6c062025-02-05 10:42:55 +1100246 #endif // CONFIG_IDF_TARGET_ESP32
Damien Tournoude982c1d2023-01-12 21:04:07 -0800247 #if CONFIG_ETH_USE_SPI_ETHERNET
248 #if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
249 case PHY_KSZ8851SNL: {
robert-hhc4e63ac2023-10-17 21:48:18 +0200250 spi_host_device_t host = machine_hw_spi_get_host(args[ARG_spi].u_obj);
251 eth_ksz8851snl_config_t chip_config = ETH_KSZ8851SNL_DEFAULT_CONFIG(host, &devcfg);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800252 chip_config.int_gpio_num = self->phy_int_pin;
253 mac = esp_eth_mac_new_ksz8851snl(&chip_config, &mac_config);
254 self->phy = esp_eth_phy_new_ksz8851snl(&phy_config);
255 break;
256 }
257 #endif
258 #if CONFIG_ETH_SPI_ETHERNET_DM9051
259 case PHY_DM9051: {
robert-hhc4e63ac2023-10-17 21:48:18 +0200260 spi_host_device_t host = machine_hw_spi_get_host(args[ARG_spi].u_obj);
261 eth_dm9051_config_t chip_config = ETH_DM9051_DEFAULT_CONFIG(host, &devcfg);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800262 chip_config.int_gpio_num = self->phy_int_pin;
263 mac = esp_eth_mac_new_dm9051(&chip_config, &mac_config);
264 self->phy = esp_eth_phy_new_dm9051(&phy_config);
265 break;
266 }
267 #endif
268 #if CONFIG_ETH_SPI_ETHERNET_W5500
269 case PHY_W5500: {
robert-hhc4e63ac2023-10-17 21:48:18 +0200270 spi_host_device_t host = machine_hw_spi_get_host(args[ARG_spi].u_obj);
271 eth_w5500_config_t chip_config = ETH_W5500_DEFAULT_CONFIG(host, &devcfg);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800272 chip_config.int_gpio_num = self->phy_int_pin;
273 mac = esp_eth_mac_new_w5500(&chip_config, &mac_config);
274 self->phy = esp_eth_phy_new_w5500(&phy_config);
275 break;
276 }
277 #endif
278 #endif
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700279 }
280
Damien Tournoude982c1d2023-01-12 21:04:07 -0800281 #if CONFIG_IDF_TARGET_ESP32
282 if (!IS_SPI_PHY(args[ARG_phy_type].u_int)) {
283 if (self->mdc_pin == -1 || self->mdio_pin == -1) {
284 mp_raise_ValueError(MP_ERROR_TEXT("mdc and mdio must be specified"));
285 }
Damien Georgee4650122023-05-09 09:52:54 +1000286 esp32_config.smi_mdc_gpio_num = self->mdc_pin;
287 esp32_config.smi_mdio_gpio_num = self->mdio_pin;
288 mac = esp_eth_mac_new_esp32(&esp32_config, &mac_config);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800289 }
290 #endif
291
Tobias Eydam48437ce2021-04-18 21:38:36 +0200292 if (esp_netif_init() != ESP_OK) {
293 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_netif_init failed"));
Petr Kracík7d8c71c2019-02-17 11:46:23 +0100294 }
295
Tobias Eydam48437ce2021-04-18 21:38:36 +0200296 esp_netif_config_t cfg = ESP_NETIF_DEFAULT_ETH();
Damien Georgee4650122023-05-09 09:52:54 +1000297 self->base.netif = esp_netif_new(&cfg);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200298
299 if (esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, &eth_event_handler, NULL) != ESP_OK) {
300 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_event_handler_register failed"));
301 }
302
303 if (esp_event_handler_register(IP_EVENT, ESP_EVENT_ANY_ID, &eth_event_handler, NULL) != ESP_OK) {
304 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_event_handler_register failed"));
305 }
306
307 esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, self->phy);
308
309 esp_err_t esp_err = esp_eth_driver_install(&config, &self->eth_handle);
310 if (esp_err == ESP_OK) {
Glenn Moloneydbced752023-07-01 13:54:44 +1000311 self->base.active = false;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700312 self->initialized = true;
313 } else {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200314 if (esp_err == ESP_ERR_INVALID_ARG) {
315 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed with invalid argument"));
316 } else if (esp_err == ESP_ERR_NO_MEM) {
317 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed with no memory for driver"));
318 } else {
319 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed"));
320 }
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700321 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200322
Damien Georgee4650122023-05-09 09:52:54 +1000323 if (esp_netif_attach(self->base.netif, esp_eth_new_netif_glue(self->eth_handle)) != ESP_OK) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200324 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_netif_attach failed"));
325 }
326
Glenn Moloney288a0362024-07-08 17:33:53 +1000327 // If MAC address is unset, set it to the address reserved for the ESP32 ETH interface
328 uint8_t mac_addr[6];
329 esp_eth_ioctl(self->eth_handle, ETH_CMD_G_MAC_ADDR, mac_addr);
330 if ((mac_addr[0] | mac_addr[1] | mac_addr[2] | mac_addr[3] | mac_addr[4] | mac_addr[5]) == 0) {
331 esp_read_mac(mac_addr, ESP_MAC_ETH); // Get ESP32 MAC address for ETH iface
332 set_mac_address(self, mac_addr, sizeof(mac_addr));
333 }
334
Tobias Eydam48437ce2021-04-18 21:38:36 +0200335 eth_status = ETH_INITIALIZED;
336
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700337 return MP_OBJ_FROM_PTR(&lan_obj);
338}
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100339MP_DEFINE_CONST_FUN_OBJ_KW(esp_network_get_lan_obj, 0, get_lan);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700340
Angus Grattondecf8e62024-02-27 15:32:29 +1100341static mp_obj_t lan_active(size_t n_args, const mp_obj_t *args) {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700342 lan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
343
344 if (n_args > 1) {
Glenn Moloney868d3112024-06-30 22:01:32 +1000345 bool make_active = mp_obj_is_true(args[1]);
346 if (make_active && !self->base.active) {
robert-hhbbbd4842023-10-20 21:34:46 +0200347 esp_netif_set_hostname(self->base.netif, mod_network_hostname_data);
Glenn Moloneydbced752023-07-01 13:54:44 +1000348 self->base.active = (esp_eth_start(self->eth_handle) == ESP_OK);
349 if (!self->base.active) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100350 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("ethernet enable failed"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700351 }
Glenn Moloney868d3112024-06-30 22:01:32 +1000352 } else if (!make_active && self->base.active) {
Glenn Moloneydbced752023-07-01 13:54:44 +1000353 self->base.active = !(esp_eth_stop(self->eth_handle) == ESP_OK);
354 if (self->base.active) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100355 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("ethernet disable failed"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700356 }
357 }
358 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200359
Glenn Moloneydbced752023-07-01 13:54:44 +1000360 return mp_obj_new_bool(self->base.active);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700361}
Angus Grattondecf8e62024-02-27 15:32:29 +1100362static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(lan_active_obj, 1, 2, lan_active);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700363
Angus Grattondecf8e62024-02-27 15:32:29 +1100364static mp_obj_t lan_status(mp_obj_t self_in) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200365 return MP_OBJ_NEW_SMALL_INT(eth_status);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700366}
Angus Grattondecf8e62024-02-27 15:32:29 +1100367static MP_DEFINE_CONST_FUN_OBJ_1(lan_status_obj, lan_status);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700368
Angus Grattondecf8e62024-02-27 15:32:29 +1100369static mp_obj_t lan_isconnected(mp_obj_t self_in) {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700370 lan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
robert-hh9c244132023-10-19 15:05:59 +0200371 return mp_obj_new_bool(self->base.active && (eth_status == ETH_GOT_IP));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700372}
Angus Grattondecf8e62024-02-27 15:32:29 +1100373static MP_DEFINE_CONST_FUN_OBJ_1(lan_isconnected_obj, lan_isconnected);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700374
Angus Grattondecf8e62024-02-27 15:32:29 +1100375static mp_obj_t lan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200376 if (n_args != 1 && kwargs->used != 0) {
377 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
378 }
379 lan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200380
381 if (kwargs->used != 0) {
382
383 for (size_t i = 0; i < kwargs->alloc; i++) {
384 if (mp_map_slot_is_filled(kwargs, i)) {
Damien George5adb1fa2021-12-10 23:28:46 +1100385 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
386 case MP_QSTR_mac: {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200387 mp_buffer_info_t bufinfo;
388 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
Glenn Moloney288a0362024-07-08 17:33:53 +1000389 set_mac_address(self, bufinfo.buf, bufinfo.len);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200390 break;
391 }
392 default:
393 break;
394 }
395 }
396 }
397 return mp_const_none;
398 }
399
400 if (n_args != 2) {
401 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
402 }
403
404 mp_obj_t val = mp_const_none;
405
Damien George5adb1fa2021-12-10 23:28:46 +1100406 switch (mp_obj_str_get_qstr(args[1])) {
407 case MP_QSTR_mac: {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200408 uint8_t mac[6];
409 esp_eth_ioctl(self->eth_handle, ETH_CMD_G_MAC_ADDR, mac);
410 return mp_obj_new_bytes(mac, sizeof(mac));
411 }
Daniël van de Giessenba8aad32023-07-04 15:36:37 +0200412 case MP_QSTR_ifname: {
413 val = esp_ifname(self->base.netif);
414 break;
415 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200416 default:
417 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
418 }
419
420 return val;
421}
Angus Grattondecf8e62024-02-27 15:32:29 +1100422static MP_DEFINE_CONST_FUN_OBJ_KW(lan_config_obj, 1, lan_config);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200423
Angus Grattondecf8e62024-02-27 15:32:29 +1100424static const mp_rom_map_elem_t lan_if_locals_dict_table[] = {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700425 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&lan_active_obj) },
426 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&lan_isconnected_obj) },
427 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&lan_status_obj) },
Tobias Eydam48437ce2021-04-18 21:38:36 +0200428 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&lan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100429 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
Felix Dörre1f23ab12024-03-27 21:53:34 +0000430 { MP_ROM_QSTR(MP_QSTR_ipconfig), MP_ROM_PTR(&esp_nic_ipconfig_obj) },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700431};
432
Angus Grattondecf8e62024-02-27 15:32:29 +1100433static MP_DEFINE_CONST_DICT(lan_if_locals_dict, lan_if_locals_dict_table);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700434
Jim Mussared662b9762021-07-14 14:38:38 +1000435MP_DEFINE_CONST_OBJ_TYPE(
436 lan_if_type,
437 MP_QSTR_LAN,
438 MP_TYPE_FLAG_NONE,
Jim Mussared9dce8272022-06-24 16:27:46 +1000439 locals_dict, &lan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000440 );
Jim Mussared96008ff2019-09-13 23:04:13 +1000441
Tobias Eydam48437ce2021-04-18 21:38:36 +0200442#endif