blob: 471e31d627d147866ed84ba51e1fe876eca434c1 [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
35// LAN only for ESP32 (not ESP32S2) and only for ESP-IDF v4.1 and higher
36#if (ESP_IDF_VERSION_MAJOR == 4) && (ESP_IDF_VERSION_MINOR >= 1) && (CONFIG_IDF_TARGET_ESP32)
37
38#include "esp_eth.h"
39#include "esp_eth_mac.h"
40#include "esp_event.h"
41#include "esp_log.h"
42#include "esp_netif.h"
Eric Poulsen29dd6a72017-09-27 14:59:49 -070043
44#include "modnetwork.h"
45
46typedef struct _lan_if_obj_t {
47 mp_obj_base_t base;
48 int if_id; // MUST BE FIRST to match wlan_if_obj_t
49 bool initialized;
50 bool active;
51 uint8_t mdc_pin;
52 uint8_t mdio_pin;
53 int8_t phy_power_pin;
54 uint8_t phy_addr;
55 uint8_t phy_type;
Tobias Eydam48437ce2021-04-18 21:38:36 +020056 esp_eth_phy_t *phy;
57 esp_netif_t *eth_netif;
58 esp_eth_handle_t eth_handle;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070059} lan_if_obj_t;
60
61const mp_obj_type_t lan_if_type;
62STATIC lan_if_obj_t lan_obj = {{&lan_if_type}, ESP_IF_ETH, false, false};
Tobias Eydam48437ce2021-04-18 21:38:36 +020063STATIC uint8_t eth_status = 0;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070064
Tobias Eydam48437ce2021-04-18 21:38:36 +020065static void eth_event_handler(void *arg, esp_event_base_t event_base,
66 int32_t event_id, void *event_data) {
67 switch (event_id) {
68 case ETHERNET_EVENT_CONNECTED:
69 eth_status = ETH_CONNECTED;
70 ESP_LOGI("ethernet", "Ethernet Link Up");
71 break;
72 case ETHERNET_EVENT_DISCONNECTED:
73 eth_status = ETH_DISCONNECTED;
74 ESP_LOGI("ethernet", "Ethernet Link Down");
75 break;
76 case ETHERNET_EVENT_START:
77 eth_status = ETH_STARTED;
78 ESP_LOGI("ethernet", "Ethernet Started");
79 break;
80 case ETHERNET_EVENT_STOP:
81 eth_status = ETH_STOPPED;
82 ESP_LOGI("ethernet", "Ethernet Stopped");
83 break;
84 case IP_EVENT_ETH_GOT_IP:
85 eth_status = ETH_GOT_IP;
86 ESP_LOGI("ethernet", "Ethernet Got IP");
87 break;
88 default:
89 break;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070090 }
91}
92
Eric Poulsen29dd6a72017-09-27 14:59:49 -070093STATIC 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 +110094 lan_if_obj_t *self = &lan_obj;
Eric Poulsen29dd6a72017-09-27 14:59:49 -070095
96 if (self->initialized) {
97 return MP_OBJ_FROM_PTR(&lan_obj);
98 }
99
robert-hh4b520032022-12-24 16:52:55 +0100100 enum { ARG_id, ARG_mdc, ARG_mdio, ARG_power, ARG_phy_addr, ARG_phy_type,
101 ARG_ref_clk_mode, ARG_ref_clk };
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700102 static const mp_arg_t allowed_args[] = {
103 { MP_QSTR_id, MP_ARG_OBJ, {.u_obj = mp_const_none} },
104 { MP_QSTR_mdc, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_OBJ },
105 { MP_QSTR_mdio, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_OBJ },
Petr KracĂ­k5801a002019-02-17 14:02:02 +0100106 { MP_QSTR_power, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700107 { MP_QSTR_phy_addr, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
108 { MP_QSTR_phy_type, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
robert-hh4b520032022-12-24 16:52:55 +0100109 // Dynamic ref_clk configuration available at v4.4
110 #if ESP_IDF_VERSION_MINOR >= 4
111 { MP_QSTR_ref_clk_mode, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = -1} },
112 { MP_QSTR_ref_clk, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
113 #endif
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700114 };
115
116 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
117 mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
118
119 if (args[ARG_id].u_obj != mp_const_none) {
120 if (mp_obj_get_int(args[ARG_id].u_obj) != 0) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100121 mp_raise_ValueError(MP_ERROR_TEXT("invalid LAN interface identifier"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700122 }
123 }
124
125 self->mdc_pin = machine_pin_get_id(args[ARG_mdc].u_obj);
126 self->mdio_pin = machine_pin_get_id(args[ARG_mdio].u_obj);
127 self->phy_power_pin = args[ARG_power].u_obj == mp_const_none ? -1 : machine_pin_get_id(args[ARG_power].u_obj);
128
129 if (args[ARG_phy_addr].u_int < 0x00 || args[ARG_phy_addr].u_int > 0x1f) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100130 mp_raise_ValueError(MP_ERROR_TEXT("invalid phy address"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700131 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200132 self->phy_addr = args[ARG_phy_addr].u_int;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700133
robert-hhefb4bd32022-12-24 09:37:02 +0100134 if (args[ARG_phy_type].u_int != PHY_LAN8710 &&
135 args[ARG_phy_type].u_int != PHY_LAN8720 &&
Tobias Eydam48437ce2021-04-18 21:38:36 +0200136 args[ARG_phy_type].u_int != PHY_IP101 &&
137 args[ARG_phy_type].u_int != PHY_RTL8201 &&
138 #if ESP_IDF_VERSION_MINOR >= 3 // KSZ8041 is new in ESP-IDF v4.3
139 args[ARG_phy_type].u_int != PHY_KSZ8041 &&
140 #endif
141 args[ARG_phy_type].u_int != PHY_DP83848) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100142 mp_raise_ValueError(MP_ERROR_TEXT("invalid phy type"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700143 }
144
Tobias Eydam48437ce2021-04-18 21:38:36 +0200145 eth_mac_config_t mac_config = ETH_MAC_DEFAULT_CONFIG();
146 mac_config.smi_mdc_gpio_num = self->mdc_pin;
147 mac_config.smi_mdio_gpio_num = self->mdio_pin;
robert-hh4b520032022-12-24 16:52:55 +0100148 // Dynamic ref_clk configuration available at v4.4
149 #if ESP_IDF_VERSION_MINOR >= 4
150 if (args[ARG_ref_clk_mode].u_int != -1) {
151 // Map the GPIO_MODE constants to EMAC_CLK constants.
152 mac_config.clock_config.rmii.clock_mode =
153 args[ARG_ref_clk_mode].u_int == GPIO_MODE_INPUT ? EMAC_CLK_EXT_IN : EMAC_CLK_OUT;
154 }
155 if (args[ARG_ref_clk].u_obj != mp_const_none) {
156 mac_config.clock_config.rmii.clock_gpio = machine_pin_get_id(args[ARG_ref_clk].u_obj);
157 }
158 #endif
Tobias Eydam48437ce2021-04-18 21:38:36 +0200159 esp_eth_mac_t *mac = esp_eth_mac_new_esp32(&mac_config);
Petr KracĂ­k7d8c71c2019-02-17 11:46:23 +0100160
Tobias Eydam48437ce2021-04-18 21:38:36 +0200161 eth_phy_config_t phy_config = ETH_PHY_DEFAULT_CONFIG();
162 phy_config.phy_addr = self->phy_addr;
163 phy_config.reset_gpio_num = self->phy_power_pin;
164 self->phy = NULL;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700165
166 switch (args[ARG_phy_type].u_int) {
robert-hhefb4bd32022-12-24 09:37:02 +0100167 case PHY_LAN8710:
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700168 case PHY_LAN8720:
Tobias Eydam48437ce2021-04-18 21:38:36 +0200169 self->phy = esp_eth_phy_new_lan8720(&phy_config);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700170 break;
Kenneth Ryerson76fefad2020-04-20 09:51:11 -0500171 case PHY_IP101:
Tobias Eydam48437ce2021-04-18 21:38:36 +0200172 self->phy = esp_eth_phy_new_ip101(&phy_config);
Kenneth Ryerson76fefad2020-04-20 09:51:11 -0500173 break;
Tobias Eydam48437ce2021-04-18 21:38:36 +0200174 case PHY_RTL8201:
175 self->phy = esp_eth_phy_new_rtl8201(&phy_config);
176 break;
177 case PHY_DP83848:
178 self->phy = esp_eth_phy_new_dp83848(&phy_config);
179 break;
180 case PHY_KSZ8041:
181 #if ESP_IDF_VERSION_MINOR >= 3 // KSZ8041 is new in ESP-IDF v4.3
182 self->phy = esp_eth_phy_new_ksz8041(&phy_config);
183 break;
184 #endif
185 default:
186 mp_raise_ValueError(MP_ERROR_TEXT("unknown phy"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700187 }
188
Tobias Eydam48437ce2021-04-18 21:38:36 +0200189 if (esp_netif_init() != ESP_OK) {
190 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_netif_init failed"));
Petr KracĂ­k7d8c71c2019-02-17 11:46:23 +0100191 }
192
Tobias Eydam48437ce2021-04-18 21:38:36 +0200193 esp_netif_config_t cfg = ESP_NETIF_DEFAULT_ETH();
194 self->eth_netif = esp_netif_new(&cfg);
195
196 if (esp_eth_set_default_handlers(self->eth_netif) != ESP_OK) {
197 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_set_default_handlers failed (invalid parameter)"));
198 }
199
200 if (esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, &eth_event_handler, NULL) != ESP_OK) {
201 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_event_handler_register failed"));
202 }
203
204 if (esp_event_handler_register(IP_EVENT, ESP_EVENT_ANY_ID, &eth_event_handler, NULL) != ESP_OK) {
205 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_event_handler_register failed"));
206 }
207
208 esp_eth_config_t config = ETH_DEFAULT_CONFIG(mac, self->phy);
209
210 esp_err_t esp_err = esp_eth_driver_install(&config, &self->eth_handle);
211 if (esp_err == ESP_OK) {
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700212 self->active = false;
213 self->initialized = true;
214 } else {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200215 if (esp_err == ESP_ERR_INVALID_ARG) {
216 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed with invalid argument"));
217 } else if (esp_err == ESP_ERR_NO_MEM) {
218 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed with no memory for driver"));
219 } else {
220 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_eth_driver_install failed"));
221 }
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700222 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200223
224 if (esp_netif_attach(self->eth_netif, esp_eth_new_netif_glue(self->eth_handle)) != ESP_OK) {
225 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("esp_netif_attach failed"));
226 }
227
228 eth_status = ETH_INITIALIZED;
229
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700230 return MP_OBJ_FROM_PTR(&lan_obj);
231}
232MP_DEFINE_CONST_FUN_OBJ_KW(get_lan_obj, 0, get_lan);
233
234STATIC mp_obj_t lan_active(size_t n_args, const mp_obj_t *args) {
235 lan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
236
237 if (n_args > 1) {
238 if (mp_obj_is_true(args[1])) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200239 self->active = (esp_eth_start(self->eth_handle) == ESP_OK);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700240 if (!self->active) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100241 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("ethernet enable failed"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700242 }
243 } else {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200244 self->active = !(esp_eth_stop(self->eth_handle) == ESP_OK);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700245 if (self->active) {
Jim Mussareddef76fe2020-03-02 22:35:22 +1100246 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("ethernet disable failed"));
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700247 }
248 }
249 }
Tobias Eydam48437ce2021-04-18 21:38:36 +0200250
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700251 return mp_obj_new_bool(self->active);
252}
253STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(lan_active_obj, 1, 2, lan_active);
254
255STATIC mp_obj_t lan_status(mp_obj_t self_in) {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200256 return MP_OBJ_NEW_SMALL_INT(eth_status);
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700257}
258STATIC MP_DEFINE_CONST_FUN_OBJ_1(lan_status_obj, lan_status);
259
260STATIC mp_obj_t lan_isconnected(mp_obj_t self_in) {
261 lan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200262 return self->active ? mp_obj_new_bool(self->phy->get_link(self->phy) == ETH_LINK_UP) : mp_const_false;
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700263}
264STATIC MP_DEFINE_CONST_FUN_OBJ_1(lan_isconnected_obj, lan_isconnected);
265
Tobias Eydam48437ce2021-04-18 21:38:36 +0200266STATIC mp_obj_t lan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
267 if (n_args != 1 && kwargs->used != 0) {
268 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
269 }
270 lan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
Tobias Eydam48437ce2021-04-18 21:38:36 +0200271
272 if (kwargs->used != 0) {
273
274 for (size_t i = 0; i < kwargs->alloc; i++) {
275 if (mp_map_slot_is_filled(kwargs, i)) {
Damien George5adb1fa2021-12-10 23:28:46 +1100276 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
277 case MP_QSTR_mac: {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200278 mp_buffer_info_t bufinfo;
279 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
280 if (bufinfo.len != 6) {
281 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
282 }
283 esp_eth_ioctl(self->eth_handle, ETH_CMD_S_MAC_ADDR, bufinfo.buf);
284 break;
285 }
286 default:
287 break;
288 }
289 }
290 }
291 return mp_const_none;
292 }
293
294 if (n_args != 2) {
295 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
296 }
297
298 mp_obj_t val = mp_const_none;
299
Damien George5adb1fa2021-12-10 23:28:46 +1100300 switch (mp_obj_str_get_qstr(args[1])) {
301 case MP_QSTR_mac: {
Tobias Eydam48437ce2021-04-18 21:38:36 +0200302 uint8_t mac[6];
303 esp_eth_ioctl(self->eth_handle, ETH_CMD_G_MAC_ADDR, mac);
304 return mp_obj_new_bytes(mac, sizeof(mac));
305 }
306 default:
307 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
308 }
309
310 return val;
311}
312STATIC MP_DEFINE_CONST_FUN_OBJ_KW(lan_config_obj, 1, lan_config);
313
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700314STATIC const mp_rom_map_elem_t lan_if_locals_dict_table[] = {
315 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&lan_active_obj) },
316 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&lan_isconnected_obj) },
317 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&lan_status_obj) },
Tobias Eydam48437ce2021-04-18 21:38:36 +0200318 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&lan_config_obj) },
Eric Poulsen29dd6a72017-09-27 14:59:49 -0700319 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_ifconfig_obj) },
320};
321
322STATIC MP_DEFINE_CONST_DICT(lan_if_locals_dict, lan_if_locals_dict_table);
323
Jim Mussared662b9762021-07-14 14:38:38 +1000324MP_DEFINE_CONST_OBJ_TYPE(
325 lan_if_type,
326 MP_QSTR_LAN,
327 MP_TYPE_FLAG_NONE,
Jim Mussared9dce8272022-06-24 16:27:46 +1000328 locals_dict, &lan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000329 );
Jim Mussared96008ff2019-09-13 23:04:13 +1000330
Tobias Eydam48437ce2021-04-18 21:38:36 +0200331#endif