blob: 416e02e12db857b8c20601633f1043e77ea5b2a9 [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
Tobias Eydam48437ce2021-04-18 21:38:36 +020033#include "esp_idf_version.h"
34
Damien Tournoude982c1d2023-01-12 21:04:07 -080035#if MICROPY_PY_NETWORK_LAN
Tobias Eydam48437ce2021-04-18 21:38:36 +020036
37#include "esp_eth.h"
38#include "esp_eth_mac.h"
Glenn Moloney288a0362024-07-08 17:33:53 +100039#include "esp_mac.h"
Tobias Eydam48437ce2021-04-18 21:38:36 +020040#include "esp_event.h"
41#include "esp_log.h"
42#include "esp_netif.h"
Damien Tournoude982c1d2023-01-12 21:04:07 -080043#if CONFIG_ETH_USE_SPI_ETHERNET
44#include "driver/spi_master.h"
45#endif
Eric Poulsen29dd6a72017-09-27 14:59:49 -070046
47#include "modnetwork.h"
robert-hhbbbd4842023-10-20 21:34:46 +020048#include "extmod/modnetwork.h"
Eric Poulsen29dd6a72017-09-27 14:59:49 -070049
50typedef struct _lan_if_obj_t {
Damien Georgee4650122023-05-09 09:52:54 +100051 base_if_obj_t base;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070052 bool initialized;
Damien Tournoude982c1d2023-01-12 21:04:07 -080053 int8_t mdc_pin;
54 int8_t mdio_pin;
robert-hhcdfc6c12024-03-03 12:54:33 +010055 int8_t phy_reset_pin;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070056 int8_t phy_power_pin;
Damien Tournoude982c1d2023-01-12 21:04:07 -080057 int8_t phy_cs_pin;
58 int8_t phy_int_pin;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070059 uint8_t phy_addr;
60 uint8_t phy_type;
Tobias Eydam48437ce2021-04-18 21:38:36 +020061 esp_eth_phy_t *phy;
Tobias Eydam48437ce2021-04-18 21:38:36 +020062 esp_eth_handle_t eth_handle;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070063} lan_if_obj_t;
64
65const mp_obj_type_t lan_if_type;
Angus Grattondecf8e62024-02-27 15:32:29 +110066static lan_if_obj_t lan_obj = {{{&lan_if_type}, ESP_IF_ETH, NULL}, false, false};
67static uint8_t eth_status = 0;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070068
Tobias Eydam48437ce2021-04-18 21:38:36 +020069static void eth_event_handler(void *arg, esp_event_base_t event_base,
70 int32_t event_id, void *event_data) {
71 switch (event_id) {
72 case ETHERNET_EVENT_CONNECTED:
73 eth_status = ETH_CONNECTED;
74 ESP_LOGI("ethernet", "Ethernet Link Up");
75 break;
76 case ETHERNET_EVENT_DISCONNECTED:
77 eth_status = ETH_DISCONNECTED;
78 ESP_LOGI("ethernet", "Ethernet Link Down");
79 break;
80 case ETHERNET_EVENT_START:
81 eth_status = ETH_STARTED;
82 ESP_LOGI("ethernet", "Ethernet Started");
83 break;
84 case ETHERNET_EVENT_STOP:
85 eth_status = ETH_STOPPED;
86 ESP_LOGI("ethernet", "Ethernet Stopped");
87 break;
88 case IP_EVENT_ETH_GOT_IP:
89 eth_status = ETH_GOT_IP;
90 ESP_LOGI("ethernet", "Ethernet Got IP");
91 break;
92 default:
93 break;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070094 }
95}
96
Glenn Moloney288a0362024-07-08 17:33:53 +100097static void set_mac_address(lan_if_obj_t *self, uint8_t *mac, size_t len) {
98 if (len != 6) {
99 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
100 }
101 if (((mac[0] & 0x01) != 0) ||
102 (esp_eth_ioctl(self->eth_handle, ETH_CMD_S_MAC_ADDR, mac) != ESP_OK) ||
103 (esp_netif_set_mac(self->base.netif, mac) != ESP_OK)) {
104 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("failed setting MAC address"));
105 }
106}
107
Angus Grattondecf8e62024-02-27 15:32:29 +1100108static 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 +1100109 lan_if_obj_t *self = &lan_obj;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700110
111 if (self->initialized) {
112 return MP_OBJ_FROM_PTR(&lan_obj);
113 }
114
robert-hhcdfc6c12024-03-03 12:54:33 +0100115 enum { ARG_id, ARG_mdc, ARG_mdio, ARG_reset, ARG_power, ARG_phy_addr, ARG_phy_type,
Damien George67097d82023-01-18 13:47:10 +1100116 ARG_spi, ARG_cs, ARG_int, ARG_ref_clk_mode, ARG_ref_clk };
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700117 static const mp_arg_t allowed_args[] = {
118 { MP_QSTR_id, MP_ARG_OBJ, {.u_obj = mp_const_none} },
Damien Tournoude982c1d2023-01-12 21:04:07 -0800119 { MP_QSTR_mdc, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
120 { MP_QSTR_mdio, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
robert-hhcdfc6c12024-03-03 12:54:33 +0100121 { MP_QSTR_reset, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Petr Kracík5801a002019-02-17 14:02:02 +0100122 { MP_QSTR_power, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700123 { MP_QSTR_phy_addr, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
124 { MP_QSTR_phy_type, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
Damien George67097d82023-01-18 13:47:10 +1100125 { MP_QSTR_spi, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
126 { MP_QSTR_cs, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
127 { MP_QSTR_int, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
robert-hh4b520032022-12-24 16:52:55 +0100128 { MP_QSTR_ref_clk_mode, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = -1} },
129 { MP_QSTR_ref_clk, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700130 };
131
132 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
133 mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
134
135 if (args[ARG_id].u_obj != mp_const_none) {
136 if (mp_obj_get_int(args[ARG_id].u_obj) != 0) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100137 mp_raise_ValueError(MP_ERROR_TEXT("invalid LAN interface identifier"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700138 }
139 }
140
Damien Tournoude982c1d2023-01-12 21:04:07 -0800141 #define GET_PIN(XXX) args[XXX].u_obj == mp_const_none ? -1 : machine_pin_get_id(args[XXX].u_obj);
142
143 self->mdc_pin = GET_PIN(ARG_mdc);
144 self->mdio_pin = GET_PIN(ARG_mdio);
robert-hhcdfc6c12024-03-03 12:54:33 +0100145 self->phy_reset_pin = GET_PIN(ARG_reset);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800146 self->phy_power_pin = GET_PIN(ARG_power);
147 self->phy_cs_pin = GET_PIN(ARG_cs);
148 self->phy_int_pin = GET_PIN(ARG_int);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700149
150 if (args[ARG_phy_addr].u_int < 0x00 || args[ARG_phy_addr].u_int > 0x1f) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100151 mp_raise_ValueError(MP_ERROR_TEXT("invalid phy address"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700152 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200153 self->phy_addr = args[ARG_phy_addr].u_int;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700154
robert-hhefb4bd32022-12-24 09:37:02 +0100155 if (args[ARG_phy_type].u_int != PHY_LAN8710 &&
156 args[ARG_phy_type].u_int != PHY_LAN8720 &&
Tobias Eydam48437ce2021-04-18 21:38:36 +0200157 args[ARG_phy_type].u_int != PHY_IP101 &&
158 args[ARG_phy_type].u_int != PHY_RTL8201 &&
Tobias Eydam48437ce2021-04-18 21:38:36 +0200159 args[ARG_phy_type].u_int != PHY_KSZ8041 &&
ma-lalonde30db33d2022-05-30 01:16:51 -0400160 args[ARG_phy_type].u_int != PHY_KSZ8081 &&
Damien Tournoude982c1d2023-01-12 21:04:07 -0800161 #if CONFIG_ETH_USE_SPI_ETHERNET
162 #if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
163 args[ARG_phy_type].u_int != PHY_KSZ8851SNL &&
164 #endif
165 #if CONFIG_ETH_SPI_ETHERNET_DM9051
166 args[ARG_phy_type].u_int != PHY_DM9051 &&
167 #endif
168 #if CONFIG_ETH_SPI_ETHERNET_W5500
169 args[ARG_phy_type].u_int != PHY_W5500 &&
170 #endif
171 #endif
Tobias Eydam48437ce2021-04-18 21:38:36 +0200172 args[ARG_phy_type].u_int != PHY_DP83848) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100173 mp_raise_ValueError(MP_ERROR_TEXT("invalid phy type"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700174 }
175
Tobias Eydam48437ce2021-04-18 21:38:36 +0200176 eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG();
Damien Georgee4650122023-05-09 09:52:54 +1000177 #if CONFIG_IDF_TARGET_ESP32
178 eth_esp32_emac_config_t esp32_config = ETH_ESP32_EMAC_DEFAULT_CONFIG();
179 #endif
180
Damien Tournoude982c1d2023-01-12 21:04:07 -0800181 esp_eth_mac_t *mac = NULL;
182
Damien Georgee4650122023-05-09 09:52:54 +1000183 #if CONFIG_IDF_TARGET_ESP32
184 // Dynamic ref_clk configuration.
robert-hh4b520032022-12-24 16:52:55 +0100185 if (args[ARG_ref_clk_mode].u_int != -1) {
186 // Map the GPIO_MODE constants to EMAC_CLK constants.
Damien Georgee4650122023-05-09 09:52:54 +1000187 esp32_config.clock_config.rmii.clock_mode =
robert-hh4b520032022-12-24 16:52:55 +0100188 args[ARG_ref_clk_mode].u_int == GPIO_MODE_INPUT ? EMAC_CLK_EXT_IN : EMAC_CLK_OUT;
189 }
190 if (args[ARG_ref_clk].u_obj != mp_const_none) {
Damien Georgee4650122023-05-09 09:52:54 +1000191 esp32_config.clock_config.rmii.clock_gpio = machine_pin_get_id(args[ARG_ref_clk].u_obj);
robert-hh4b520032022-12-24 16:52:55 +0100192 }
193 #endif
Petr Kracík7d8c71c2019-02-17 11:46:23 +0100194
Tobias Eydam48437ce2021-04-18 21:38:36 +0200195 eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG();
196 phy_config.phy_addr = self->phy_addr;
robert-hhcdfc6c12024-03-03 12:54:33 +0100197 phy_config.reset_gpio_num = self->phy_reset_pin;
Tobias Eydam48437ce2021-04-18 21:38:36 +0200198 self->phy = NULL;
robert-hhcdfc6c12024-03-03 12:54:33 +0100199 // Switch on the power before PHY is reset
200 if (self->phy_power_pin >= 0) {
201 mp_hal_pin_output(self->phy_power_pin);
202 mp_hal_pin_write(self->phy_power_pin, 1);
203 // let the power settle
204 mp_hal_delay_ms(100);
205 }
Damien Tournoude982c1d2023-01-12 21:04:07 -0800206 #if CONFIG_ETH_USE_SPI_ETHERNET
robert-hhc4e63ac2023-10-17 21:48:18 +0200207 spi_device_interface_config_t devcfg = {
208 .mode = 0,
209 .clock_speed_hz = MICROPY_PY_NETWORK_LAN_SPI_CLOCK_SPEED_MZ * 1000 * 1000,
210 .queue_size = 20,
211 .spics_io_num = self->phy_cs_pin,
212 .command_bits = 0, // Can both be set to 0, as the respective
213 .address_bits = 0, // driver fills in proper default values.
214 };
Damien Tournoude982c1d2023-01-12 21:04:07 -0800215 #endif
216
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700217 switch (args[ARG_phy_type].u_int) {
Damien Tournoude982c1d2023-01-12 21:04:07 -0800218 #if CONFIG_IDF_TARGET_ESP32
robert-hhefb4bd32022-12-24 09:37:02 +0100219 case PHY_LAN8710:
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700220 case PHY_LAN8720:
Damien Georgee4650122023-05-09 09:52:54 +1000221 self->phy = esp_eth_phy_new_lan87xx(&phy_config);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700222 break;
Kenneth Ryerson76fefad2020-04-20 09:51:11 -0500223 case PHY_IP101:
Tobias Eydam48437ce2021-04-18 21:38:36 +0200224 self->phy = esp_eth_phy_new_ip101(&phy_config);
Kenneth Ryerson76fefad2020-04-20 09:51:11 -0500225 break;
Tobias Eydam48437ce2021-04-18 21:38:36 +0200226 case PHY_RTL8201:
227 self->phy = esp_eth_phy_new_rtl8201(&phy_config);
228 break;
229 case PHY_DP83848:
230 self->phy = esp_eth_phy_new_dp83848(&phy_config);
231 break;
232 case PHY_KSZ8041:
ma-lalonde30db33d2022-05-30 01:16:51 -0400233 case PHY_KSZ8081:
Damien Georgee4650122023-05-09 09:52:54 +1000234 self->phy = esp_eth_phy_new_ksz80xx(&phy_config);
ma-lalonde30db33d2022-05-30 01:16:51 -0400235 break;
236 #endif
Damien Tournoude982c1d2023-01-12 21:04:07 -0800237 #if CONFIG_ETH_USE_SPI_ETHERNET
238 #if CONFIG_ETH_SPI_ETHERNET_KSZ8851SNL
239 case PHY_KSZ8851SNL: {
robert-hhc4e63ac2023-10-17 21:48:18 +0200240 spi_host_device_t host = machine_hw_spi_get_host(args[ARG_spi].u_obj);
241 eth_ksz8851snl_config_t chip_config = ETH_KSZ8851SNL_DEFAULT_CONFIG(host, &devcfg);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800242 chip_config.int_gpio_num = self->phy_int_pin;
243 mac = esp_eth_mac_new_ksz8851snl(&chip_config, &mac_config);
244 self->phy = esp_eth_phy_new_ksz8851snl(&phy_config);
245 break;
246 }
247 #endif
248 #if CONFIG_ETH_SPI_ETHERNET_DM9051
249 case PHY_DM9051: {
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_dm9051_config_t chip_config = ETH_DM9051_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_dm9051(&chip_config, &mac_config);
254 self->phy = esp_eth_phy_new_dm9051(&phy_config);
255 break;
256 }
257 #endif
258 #if CONFIG_ETH_SPI_ETHERNET_W5500
259 case PHY_W5500: {
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_w5500_config_t chip_config = ETH_W5500_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_w5500(&chip_config, &mac_config);
264 self->phy = esp_eth_phy_new_w5500(&phy_config);
265 break;
266 }
267 #endif
268 #endif
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700269 }
270
Damien Tournoude982c1d2023-01-12 21:04:07 -0800271 #if CONFIG_IDF_TARGET_ESP32
272 if (!IS_SPI_PHY(args[ARG_phy_type].u_int)) {
273 if (self->mdc_pin == -1 || self->mdio_pin == -1) {
274 mp_raise_ValueError(MP_ERROR_TEXT("mdc and mdio must be specified"));
275 }
Damien Georgee4650122023-05-09 09:52:54 +1000276 esp32_config.smi_mdc_gpio_num = self->mdc_pin;
277 esp32_config.smi_mdio_gpio_num = self->mdio_pin;
278 mac = esp_eth_mac_new_esp32(&esp32_config, &mac_config);
Damien Tournoude982c1d2023-01-12 21:04:07 -0800279 }
280 #endif
281
Tobias Eydam48437ce2021-04-18 21:38:36 +0200282 if (esp_netif_init() != ESP_OK) {
283 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_netif_init failed"));
Petr Kracík7d8c71c2019-02-17 11:46:23 +0100284 }
285
Tobias Eydam48437ce2021-04-18 21:38:36 +0200286 esp_netif_config_t cfg = ESP_NETIF_DEFAULT_ETH();
Damien Georgee4650122023-05-09 09:52:54 +1000287 self->base.netif = esp_netif_new(&cfg);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200288
289 if (esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, &eth_event_handler, NULL) != ESP_OK) {
290 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_event_handler_register failed"));
291 }
292
293 if (esp_event_handler_register(IP_EVENT, ESP_EVENT_ANY_ID, &eth_event_handler, NULL) != ESP_OK) {
294 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_event_handler_register failed"));
295 }
296
297 esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, self->phy);
298
299 esp_err_t esp_err = esp_eth_driver_install(&config, &self->eth_handle);
300 if (esp_err == ESP_OK) {
Glenn Moloneydbced752023-07-01 13:54:44 +1000301 self->base.active = false;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700302 self->initialized = true;
303 } else {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200304 if (esp_err == ESP_ERR_INVALID_ARG) {
305 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed with invalid argument"));
306 } else if (esp_err == ESP_ERR_NO_MEM) {
307 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed with no memory for driver"));
308 } else {
309 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed"));
310 }
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700311 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200312
Damien Georgee4650122023-05-09 09:52:54 +1000313 if (esp_netif_attach(self->base.netif, esp_eth_new_netif_glue(self->eth_handle)) != ESP_OK) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200314 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_netif_attach failed"));
315 }
316
Glenn Moloney288a0362024-07-08 17:33:53 +1000317 // If MAC address is unset, set it to the address reserved for the ESP32 ETH interface
318 uint8_t mac_addr[6];
319 esp_eth_ioctl(self->eth_handle, ETH_CMD_G_MAC_ADDR, mac_addr);
320 if ((mac_addr[0] | mac_addr[1] | mac_addr[2] | mac_addr[3] | mac_addr[4] | mac_addr[5]) == 0) {
321 esp_read_mac(mac_addr, ESP_MAC_ETH); // Get ESP32 MAC address for ETH iface
322 set_mac_address(self, mac_addr, sizeof(mac_addr));
323 }
324
Tobias Eydam48437ce2021-04-18 21:38:36 +0200325 eth_status = ETH_INITIALIZED;
326
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700327 return MP_OBJ_FROM_PTR(&lan_obj);
328}
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100329MP_DEFINE_CONST_FUN_OBJ_KW(esp_network_get_lan_obj, 0, get_lan);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700330
Angus Grattondecf8e62024-02-27 15:32:29 +1100331static mp_obj_t lan_active(size_t n_args, const mp_obj_t *args) {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700332 lan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
333
334 if (n_args > 1) {
Glenn Moloney868d3112024-06-30 22:01:32 +1000335 bool make_active = mp_obj_is_true(args[1]);
336 if (make_active && !self->base.active) {
robert-hhbbbd4842023-10-20 21:34:46 +0200337 esp_netif_set_hostname(self->base.netif, mod_network_hostname_data);
Glenn Moloneydbced752023-07-01 13:54:44 +1000338 self->base.active = (esp_eth_start(self->eth_handle) == ESP_OK);
339 if (!self->base.active) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100340 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("ethernet enable failed"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700341 }
Glenn Moloney868d3112024-06-30 22:01:32 +1000342 } else if (!make_active && self->base.active) {
Glenn Moloneydbced752023-07-01 13:54:44 +1000343 self->base.active = !(esp_eth_stop(self->eth_handle) == ESP_OK);
344 if (self->base.active) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100345 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("ethernet disable failed"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700346 }
347 }
348 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200349
Glenn Moloneydbced752023-07-01 13:54:44 +1000350 return mp_obj_new_bool(self->base.active);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700351}
Angus Grattondecf8e62024-02-27 15:32:29 +1100352static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(lan_active_obj, 1, 2, lan_active);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700353
Angus Grattondecf8e62024-02-27 15:32:29 +1100354static mp_obj_t lan_status(mp_obj_t self_in) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200355 return MP_OBJ_NEW_SMALL_INT(eth_status);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700356}
Angus Grattondecf8e62024-02-27 15:32:29 +1100357static MP_DEFINE_CONST_FUN_OBJ_1(lan_status_obj, lan_status);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700358
Angus Grattondecf8e62024-02-27 15:32:29 +1100359static mp_obj_t lan_isconnected(mp_obj_t self_in) {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700360 lan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
robert-hh9c244132023-10-19 15:05:59 +0200361 return mp_obj_new_bool(self->base.active && (eth_status == ETH_GOT_IP));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700362}
Angus Grattondecf8e62024-02-27 15:32:29 +1100363static MP_DEFINE_CONST_FUN_OBJ_1(lan_isconnected_obj, lan_isconnected);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700364
Angus Grattondecf8e62024-02-27 15:32:29 +1100365static 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 +0200366 if (n_args != 1 && kwargs->used != 0) {
367 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
368 }
369 lan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200370
371 if (kwargs->used != 0) {
372
373 for (size_t i = 0; i < kwargs->alloc; i++) {
374 if (mp_map_slot_is_filled(kwargs, i)) {
Damien George5adb1fa2021-12-10 23:28:46 +1100375 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
376 case MP_QSTR_mac: {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200377 mp_buffer_info_t bufinfo;
378 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
Glenn Moloney288a0362024-07-08 17:33:53 +1000379 set_mac_address(self, bufinfo.buf, bufinfo.len);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200380 break;
381 }
382 default:
383 break;
384 }
385 }
386 }
387 return mp_const_none;
388 }
389
390 if (n_args != 2) {
391 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
392 }
393
394 mp_obj_t val = mp_const_none;
395
Damien George5adb1fa2021-12-10 23:28:46 +1100396 switch (mp_obj_str_get_qstr(args[1])) {
397 case MP_QSTR_mac: {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200398 uint8_t mac[6];
399 esp_eth_ioctl(self->eth_handle, ETH_CMD_G_MAC_ADDR, mac);
400 return mp_obj_new_bytes(mac, sizeof(mac));
401 }
Daniël van de Giessenba8aad32023-07-04 15:36:37 +0200402 case MP_QSTR_ifname: {
403 val = esp_ifname(self->base.netif);
404 break;
405 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200406 default:
407 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
408 }
409
410 return val;
411}
Angus Grattondecf8e62024-02-27 15:32:29 +1100412static MP_DEFINE_CONST_FUN_OBJ_KW(lan_config_obj, 1, lan_config);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200413
Angus Grattondecf8e62024-02-27 15:32:29 +1100414static const mp_rom_map_elem_t lan_if_locals_dict_table[] = {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700415 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&lan_active_obj) },
416 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&lan_isconnected_obj) },
417 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&lan_status_obj) },
Tobias Eydam48437ce2021-04-18 21:38:36 +0200418 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&lan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100419 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
Felix Dörre1f23ab12024-03-27 21:53:34 +0000420 { MP_ROM_QSTR(MP_QSTR_ipconfig), MP_ROM_PTR(&esp_nic_ipconfig_obj) },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700421};
422
Angus Grattondecf8e62024-02-27 15:32:29 +1100423static MP_DEFINE_CONST_DICT(lan_if_locals_dict, lan_if_locals_dict_table);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700424
Jim Mussared662b9762021-07-14 14:38:38 +1000425MP_DEFINE_CONST_OBJ_TYPE(
426 lan_if_type,
427 MP_QSTR_LAN,
428 MP_TYPE_FLAG_NONE,
Jim Mussared9dce8272022-06-24 16:27:46 +1000429 locals_dict, &lan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000430 );
Jim Mussared96008ff2019-09-13 23:04:13 +1000431
Tobias Eydam48437ce2021-04-18 21:38:36 +0200432#endif