1 // SPDX-License-Identifier: GPL-2.0-only
3 * Espressif Systems Wireless LAN device driver
5 * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
9 #include <linux/init.h>
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/gpio.h>
13 #include <linux/igmp.h>
17 #include "esp_bt_api.h"
20 #include "esp_kernel_port.h"
22 #include "esp_cfg80211.h"
23 #include "esp_stats.h"
25 #define HOST_GPIO_PIN_INVALID -1
26 static int resetpin = HOST_GPIO_PIN_INVALID;
27 extern u8 ap_bssid[MAC_ADDR_LEN];
28 extern volatile u8 host_sleep;
30 module_param(resetpin, int, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
31 MODULE_PARM_DESC(resetpin, "Host's GPIO pin number which is connected to ESP32's EN to reset ESP32 device");
33 static void deinit_adapter(void);
36 struct multicast_list mcast_list = {0};
37 struct esp_adapter adapter;
38 /*struct esp_device esp_dev;*/
40 struct esp_adapter *esp_get_adapter(void)
45 void esp_process_new_packet_intr(struct esp_adapter *adapter)
48 queue_work(adapter->if_rx_workqueue, &adapter->if_rx_work);
51 static int process_tx_packet(struct sk_buff *skb)
53 struct esp_wifi_device *priv = NULL;
54 struct esp_skb_cb *cb = NULL;
55 struct esp_payload_header *payload_header = NULL;
56 struct sk_buff *new_skb = NULL;
58 u8 pad_len = 0, realloc_skb = 0;
66 cb = (struct esp_skb_cb *) skb->cb;
71 esp_info("No priv\n");
75 if (netif_queue_stopped((const struct net_device *) priv->ndev)) {
76 esp_info("Netif queue stopped\n");
77 return NETDEV_TX_BUSY;
81 return NETDEV_TX_BUSY;
86 /* Create space for payload header */
87 pad_len = sizeof(struct esp_payload_header);
89 total_len = len + pad_len;
91 /* Align buffer length */
92 pad_len += SKB_DATA_ADDR_ALIGNMENT - (total_len % SKB_DATA_ADDR_ALIGNMENT);
94 if (skb_headroom(skb) < pad_len) {
95 /* Headroom is not sufficient */
99 if (realloc_skb || !IS_ALIGNED((unsigned long) skb->data, SKB_DATA_ADDR_ALIGNMENT)) {
101 if (skb_linearize(skb)) {
102 priv->stats.tx_errors++;
104 esp_err("Failed to linearize SKB");
108 new_skb = esp_alloc_skb(skb->len + pad_len);
111 esp_err("Failed to allocate SKB");
112 priv->stats.tx_errors++;
120 /* Populate new SKB */
121 skb_copy_from_linear_data(skb, pos, skb->len);
122 skb_put(new_skb, skb->len + pad_len);
124 /* Replace old SKB */
125 dev_kfree_skb_any(skb);
128 /* Realloc is not needed, Make space for interface header */
129 skb_push(skb, pad_len);
132 /* Set payload header */
133 payload_header = (struct esp_payload_header *) skb->data;
134 memset(payload_header, 0, pad_len);
136 payload_header->if_type = priv->if_type;
137 payload_header->if_num = priv->if_num;
138 payload_header->len = cpu_to_le16(len);
139 payload_header->offset = cpu_to_le16(pad_len);
140 payload_header->packet_type = PACKET_TYPE_DATA;
142 if (adapter.capabilities & ESP_CHECKSUM_ENABLED)
143 payload_header->checksum = cpu_to_le16(compute_checksum(skb->data, (len + pad_len)));
145 if (!priv->stop_data) {
146 ret = esp_send_packet(priv->adapter, skb);
149 /* esp_err("Failed to send SKB");*/
150 priv->stats.tx_errors++;
152 priv->stats.tx_packets++;
153 priv->stats.tx_bytes += skb->len;
156 dev_kfree_skb_any(skb);
157 priv->stats.tx_dropped++;
163 void esp_port_open(struct esp_wifi_device *priv)
169 void esp_port_close(struct esp_wifi_device *priv)
178 void print_capabilities(u32 cap)
180 esp_info("Capabilities: 0x%x. Features supported are:\n", cap);
181 if (cap & ESP_WLAN_SDIO_SUPPORT)
182 esp_info("\t * WLAN on SDIO\n");
183 else if (cap & ESP_WLAN_SPI_SUPPORT)
184 esp_info("\t * WLAN on SPI\n");
186 if ((cap & ESP_BT_UART_SUPPORT) ||
187 (cap & ESP_BT_SDIO_SUPPORT) ||
188 (cap & ESP_BT_SPI_SUPPORT)) {
189 esp_info("\t * BT/BLE\n");
190 if (cap & ESP_BT_UART_SUPPORT)
191 esp_info("\t - HCI over UART\n");
192 if (cap & ESP_BT_SDIO_SUPPORT)
193 esp_info("\t - HCI over SDIO\n");
194 if (cap & ESP_BT_SPI_SUPPORT)
195 esp_info("\t - HCI over SPI\n");
197 if ((cap & ESP_BLE_ONLY_SUPPORT) && (cap & ESP_BR_EDR_ONLY_SUPPORT))
198 esp_info("\t - BT/BLE dual mode\n");
199 else if (cap & ESP_BLE_ONLY_SUPPORT)
200 esp_info("\t - BLE only\n");
201 else if (cap & ESP_BR_EDR_ONLY_SUPPORT)
202 esp_info("\t - BR EDR only\n");
206 void process_capabilities(struct esp_adapter *adapter)
208 esp_info("ESP peripheral capabilities: 0x%x\n", adapter->capabilities);
211 esp_deinit_bt(adapter);
213 if ((adapter->capabilities & ESP_BT_SPI_SUPPORT) ||
214 (adapter->capabilities & ESP_BT_SDIO_SUPPORT)) {
216 esp_info("ESP Bluetooth init\n");
217 esp_init_bt(adapter);
221 static int check_esp_version(struct fw_version *ver)
223 esp_info("esp32: ESP Firmware version: %u.%u.%u\n",
224 ver->major1, ver->major2, ver->minor);
226 esp_err("Incompatible ESP firmware release detected, Please use correct ESP-Hosted branch/compatible release\n");
232 static void print_reset_reason(uint32_t reason)
236 case 1: esp_info("POWERON_RESET\n"); break; /**<1, Vbat power on reset*/
237 case 3: esp_info("SW_RESET\n"); break; /**<3, Software reset digital core*/
238 case 4: esp_info("OWDT_RESET\n"); break; /**<4, Legacy watch dog reset digital core*/
239 case 5: esp_info("DEEPSLEEP_RESET\n"); break; /**<5, Deep Sleep reset digital core*/
240 case 6: esp_info("SDIO_RESET\n"); break; /**<6, Reset by SLC module, reset digital core*/
241 case 7: esp_info("TG0WDT_SYS_RESET\n"); break; /**<7, Timer Group0 Watch dog reset digital core*/
242 case 8: esp_info("TG1WDT_SYS_RESET\n"); break; /**<8, Timer Group1 Watch dog reset digital core*/
243 case 9: esp_info("RTCWDT_SYS_RESET\n"); break; /**<9, RTC Watch dog Reset digital core*/
244 case 10: esp_info("INTRUSION_RESET\n"); break; /**<10, Instrusion tested to reset CPU*/
245 case 11: esp_info("TGWDT_CPU_RESET\n"); break; /**<11, Time Group reset CPU*/
246 case 12: esp_info("SW_CPU_RESET\n"); break; /**<12, Software reset CPU*/
247 case 13: esp_info("RTCWDT_CPU_RESET\n"); break; /**<13, RTC Watch dog Reset CPU*/
248 case 14: esp_info("EXT_CPU_RESET\n"); break; /**<14, for APP CPU, reseted by PRO CPU*/
249 case 15: esp_info("RTCWDT_BROWN_OUT_RESET\n"); break;/**<15, Reset when the vdd voltage is not stable*/
250 case 16: esp_info("RTCWDT_RTC_RESET\n"); break; /**<16, RTC Watch dog reset digital core and rtc module*/
251 default: esp_info("Unknown[%u]\n", reason); break;
255 int process_fw_data(struct fw_data *fw_p)
258 esp_err("Incomplete/incorrect bootup event received\n");
262 esp_info("ESP chipset's last reset cause:\n");
263 print_reset_reason(le32_to_cpu(fw_p->last_reset_reason));
264 return check_esp_version(&fw_p->version);
267 static int esp_open(struct net_device *ndev)
272 static int esp_stop(struct net_device *ndev)
274 struct esp_wifi_device *priv = netdev_priv(ndev);
276 ESP_MARK_SCAN_DONE(priv, true);
280 static struct net_device_stats *esp_get_stats(struct net_device *ndev)
282 struct esp_wifi_device *priv = netdev_priv(ndev);
290 static int esp_set_mac_address(struct net_device *ndev, void *data)
292 struct esp_wifi_device *priv = netdev_priv(ndev);
293 struct sockaddr *sa = (struct sockaddr *)data;
296 if (!priv || !priv->adapter)
299 esp_info("%u "MACSTR"\n", __LINE__, MAC2STR(sa->sa_data));
301 ret = cmd_set_mac(priv, sa->sa_data);
304 eth_hw_addr_set(ndev, priv->mac_address/*mac_addr->sa_data*/);
309 static void esp_set_rx_mode(struct net_device *ndev)
311 struct esp_wifi_device *priv = netdev_priv(ndev);
312 struct netdev_hw_addr *mac_addr;
315 struct in_device *in_dev = in_dev_get(ndev);
316 struct ip_mc_list *ip_list = in_dev->mc_list;
318 netdev_for_each_mc_addr(mac_addr, ndev) {
319 if (count < MAX_MULTICAST_ADDR_COUNT) {
320 /*esp_info("%d: "MACSTR"\n", count+1, MAC2STR(mac_addr->addr));*/
321 memcpy(&mcast_list.mcast_addr[count++], mac_addr->addr, ETH_ALEN);
325 mcast_list.priv = priv;
326 mcast_list.addr_count = count;
328 if (priv->port_open) {
329 /*esp_info("Set Multicast list\n");*/
330 if (adapter.mac_filter_wq)
331 queue_work(adapter.mac_filter_wq, &adapter.mac_flter_work);
334 cmd_set_mcast_mac_list(priv, &mcast_list);
336 esp_dbg(" IP MC Address: 0x%x\n", ip_list->multiaddr);
337 ip_list = ip_list->next;
343 static int esp_hard_start_xmit(struct sk_buff *skb, struct net_device *ndev)
345 struct esp_wifi_device *priv = NULL;
346 struct esp_skb_cb *cb = NULL;
351 priv = netdev_priv(ndev);
357 if (!priv->port_open) {
358 priv->stats.tx_dropped++;
359 /*esp_err("Port not yet open\n");*/
364 if (!skb->len || (skb->len > ETH_FRAME_LEN)) {
365 esp_err("Bad len %d\n", skb->len);
366 priv->stats.tx_dropped++;
371 cb = (struct esp_skb_cb *) skb->cb;
374 return process_tx_packet(skb);
377 static const struct net_device_ops esp_netdev_ops = {
378 .ndo_open = esp_open,
379 .ndo_stop = esp_stop,
380 .ndo_start_xmit = esp_hard_start_xmit,
381 .ndo_set_mac_address = esp_set_mac_address,
382 .ndo_validate_addr = eth_validate_addr,
383 .ndo_get_stats = esp_get_stats,
384 .ndo_set_rx_mode = esp_set_rx_mode,
388 void esp_init_priv(struct net_device *ndev)
390 ndev->netdev_ops = &esp_netdev_ops;
391 ndev->needed_headroom = roundup(sizeof(struct esp_payload_header) +
392 INTERFACE_HEADER_PADDING, 4);
395 static int add_network_iface(void)
398 struct esp_adapter *adapter = esp_get_adapter();
399 struct wireless_dev *wdev = NULL;
402 esp_info("adapter not yet init\n");
406 ret = esp_cfg80211_register(adapter);
408 esp_err("Failed to register with cfg80211 (err code 0x%x)\n", ret);
413 wdev = esp_cfg80211_add_iface(adapter->wiphy, "espsta%d", 1, NL80211_IFTYPE_STATION, NULL);
416 /* Return success if network added successfully */
423 int esp_add_card(struct esp_adapter *adapter)
425 RET_ON_FAIL(esp_commands_setup(adapter));
427 RET_ON_FAIL(add_network_iface());
432 void esp_remove_network_interfaces(struct esp_adapter *adapter)
434 uint8_t iface_idx = 0;
435 struct net_device *ndev = NULL;
436 struct esp_wifi_device *priv = NULL;
438 for (iface_idx = 0; iface_idx < ESP_MAX_INTERFACE; iface_idx++) {
440 priv = adapter->priv[iface_idx];
445 if (!test_bit(ESP_NETWORK_UP, &priv->priv_flags))
448 /* stop and unregister network */
453 if (netif_carrier_ok(ndev))
454 netif_carrier_off(ndev);
456 netif_device_detach(ndev);
458 if (ndev->reg_state == NETREG_REGISTERED) {
459 unregister_inetaddr_notifier(&(adapter->priv[0]->nb));
460 unregister_netdev(ndev);
465 clear_bit(ESP_NETWORK_UP, &priv->priv_flags);
468 if (adapter->wiphy) {
470 wiphy_unregister(adapter->wiphy);
471 wiphy_free(adapter->wiphy);
472 adapter->wiphy = NULL;
476 int esp_remove_card(struct esp_adapter *adapter)
478 uint8_t iface_idx = 0;
484 esp_deinit_bt(adapter);
486 esp_commands_teardown(adapter);
488 esp_remove_network_interfaces(adapter);
490 for (iface_idx = 0; iface_idx < ESP_MAX_INTERFACE; iface_idx++) {
491 esp_port_close(adapter->priv[iface_idx]);
492 adapter->priv[iface_idx] = NULL;
498 struct esp_wifi_device *get_priv_from_payload_header(
499 struct esp_payload_header *header)
501 struct esp_wifi_device *priv = NULL;
507 for (i = 0; i < ESP_MAX_INTERFACE; i++) {
508 priv = adapter.priv[i];
513 if (priv->if_type == header->if_type &&
514 priv->if_num == header->if_num) {
521 static void process_esp_bootup_event(struct esp_adapter *adapter,
522 struct esp_internal_bootup_event *evt)
524 if (!adapter || !evt) {
525 esp_err("Invalid arguments\n");
529 if (evt->header.status) {
530 esp_err("Incorrect ESP bootup event\n");
534 esp_info("\nReceived ESP bootup event\n");
535 process_event_esp_bootup(adapter, evt->data, evt->len);
538 static int process_internal_event(struct esp_adapter *adapter,
541 struct event_header *header = NULL;
543 if (!skb || !adapter) {
544 esp_err("esp32: Incorrect event data!\n");
548 header = (struct event_header *) (skb->data);
550 switch (header->event_code) {
552 case ESP_INTERNAL_BOOTUP_EVENT:
553 process_esp_bootup_event(adapter,
554 (struct esp_internal_bootup_event *)(skb->data));
558 esp_info("%u unhandled internal event[%u]\n",
559 __LINE__, header->event_code);
566 static void process_rx_packet(struct esp_adapter *adapter, struct sk_buff *skb)
568 struct esp_wifi_device *priv = NULL;
569 struct esp_payload_header *payload_header = NULL;
570 u16 len = 0, offset = 0;
571 u16 rx_checksum = 0, checksum = 0;
572 struct hci_dev *hdev = adapter->hcidev;
574 struct sk_buff *eap_skb = NULL;
575 struct ethhdr *eth = NULL;
580 /* get the paload header */
581 payload_header = (struct esp_payload_header *) skb->data;
583 len = le16_to_cpu(payload_header->len);
584 offset = le16_to_cpu(payload_header->offset);
586 if (payload_header->reserved2 == 0xFF) {
587 print_hex_dump(KERN_INFO, "Wake up packet: ", DUMP_PREFIX_ADDRESS, 16, 1, skb->data, len+offset, 1);
590 if (adapter->capabilities & ESP_CHECKSUM_ENABLED) {
591 rx_checksum = le16_to_cpu(payload_header->checksum);
592 payload_header->checksum = 0;
594 checksum = compute_checksum(skb->data, (len + offset));
596 if (checksum != rx_checksum) {
597 dev_kfree_skb_any(skb);
602 /* chop off the header from skb */
603 skb_pull(skb, offset);
605 if (payload_header->if_type == ESP_STA_IF || payload_header->if_type == ESP_AP_IF) {
607 /* retrieve priv based on payload header contents */
608 priv = get_priv_from_payload_header(payload_header);
611 esp_err("Empty priv\n");
612 dev_kfree_skb_any(skb);
616 if (payload_header->packet_type == PACKET_TYPE_EAPOL) {
617 esp_info("Rx PACKET_TYPE_EAPOL!!!!\n");
620 eap_skb = alloc_skb(skb->len + ETH_HLEN, GFP_KERNEL);
622 esp_info("%u memory alloc failed\n", __LINE__);
625 eap_skb->dev = priv->ndev;
627 if (!IS_ALIGNED((unsigned long) eap_skb->data, SKB_DATA_ADDR_ALIGNMENT)) {
628 esp_info("%u eap skb unaligned\n", __LINE__);
631 eth = (struct ethhdr *) skb_put(eap_skb, ETH_HLEN);
632 ether_addr_copy(eth->h_dest, /*skb->data*/priv->ndev->dev_addr);
633 ether_addr_copy(eth->h_source, /*skb->data+6*/ ap_bssid);
634 eth->h_proto = cpu_to_be16(ETH_P_PAE);
636 skb_put_data(eap_skb, skb->data, skb->len);
637 eap_skb->protocol = eth_type_trans(eap_skb, eap_skb->dev);
641 } else if (payload_header->packet_type == PACKET_TYPE_DATA) {
643 skb->dev = priv->ndev;
644 skb->protocol = eth_type_trans(skb, priv->ndev);
645 skb->ip_summed = CHECKSUM_NONE;
647 priv->stats.rx_bytes += skb->len;
648 /* Forward skb to kernel */
650 priv->stats.rx_packets++;
651 } else if (payload_header->packet_type == PACKET_TYPE_COMMAND_RESPONSE) {
652 process_cmd_resp(priv->adapter, skb);
653 } else if (payload_header->packet_type == PACKET_TYPE_EVENT) {
654 process_cmd_event(priv, skb);
655 dev_kfree_skb_any(skb);
658 } else if (payload_header->if_type == ESP_HCI_IF) {
662 hci_skb_pkt_type(skb) = *type;
665 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(3, 13, 0))
666 if (hci_recv_frame(hdev, skb)) {
668 if (hci_recv_frame(skb)) {
672 esp_hci_update_rx_counter(hdev, *type, skb->len);
675 } else if (payload_header->if_type == ESP_INTERNAL_IF) {
677 /* Queue event skb for processing in events workqueue */
678 skb_queue_tail(&adapter->events_skb_q, skb);
680 if (adapter->events_wq)
681 queue_work(adapter->events_wq, &adapter->events_work);
683 dev_kfree_skb_any(skb);
685 } else if (payload_header->if_type == ESP_TEST_IF) {
687 update_test_raw_tp_rx_stats(len);
689 dev_kfree_skb_any(skb);
691 dev_kfree_skb_any(skb);
695 int esp_is_tx_queue_paused(struct esp_wifi_device *priv)
697 if (!priv || !priv->ndev)
701 !netif_queue_stopped((const struct net_device *)priv->ndev)))
706 void esp_tx_pause(struct esp_wifi_device *priv)
708 if (!priv || !priv->ndev)
711 if (!netif_queue_stopped((const struct net_device *)priv->ndev)) {
712 netif_stop_queue(priv->ndev);
716 void esp_tx_resume(struct esp_wifi_device *priv)
718 if (!priv || !priv->ndev)
721 if (netif_queue_stopped((const struct net_device *)priv->ndev)) {
722 netif_wake_queue(priv->ndev);
726 struct sk_buff *esp_alloc_skb(u32 len)
728 struct sk_buff *skb = NULL;
732 skb = netdev_alloc_skb(NULL, len + INTERFACE_HEADER_PADDING);
735 /* Align SKB data pointer */
736 offset = ((unsigned long)skb->data) & (SKB_DATA_ADDR_ALIGNMENT - 1);
739 skb_reserve(skb, INTERFACE_HEADER_PADDING - offset);
746 static int esp_get_packets(struct esp_adapter *adapter)
748 struct sk_buff *skb = NULL;
750 if (!adapter || !adapter->if_ops || !adapter->if_ops->read)
753 skb = adapter->if_ops->read(adapter);
758 process_rx_packet(adapter, skb);
763 int esp_send_packet(struct esp_adapter *adapter, struct sk_buff *skb)
765 if (!adapter || !adapter->if_ops || !adapter->if_ops->write) {
766 esp_err("%u adapter: %p\n", __LINE__, adapter);
770 return adapter->if_ops->write(adapter, skb);
773 static void esp_if_rx_work(struct work_struct *work)
775 /* read inbound packet and forward it to network/serial interface */
776 esp_get_packets(&adapter);
779 static void update_mac_filter(struct work_struct *work)
781 cmd_set_mcast_mac_list(mcast_list.priv, &mcast_list);
784 static void esp_events_work(struct work_struct *work)
786 struct sk_buff *skb = NULL;
788 skb = skb_dequeue(&adapter.events_skb_q);
792 process_internal_event(&adapter, skb);
793 dev_kfree_skb_any(skb);
796 static struct esp_adapter *init_adapter(void)
798 memset(&adapter, 0, sizeof(adapter));
800 /* Prepare interface RX work */
801 adapter.if_rx_workqueue = alloc_workqueue("ESP_IF_RX_WORK_QUEUE", 0, 0);
803 if (!adapter.if_rx_workqueue) {
808 INIT_WORK(&adapter.if_rx_work, esp_if_rx_work);
810 skb_queue_head_init(&adapter.events_skb_q);
812 adapter.events_wq = alloc_workqueue("ESP_EVENTS_WORKQUEUE", WQ_HIGHPRI, 0);
814 if (!adapter.events_wq) {
819 INIT_WORK(&adapter.events_work, esp_events_work);
821 adapter.mac_filter_wq = alloc_workqueue("MAC_FILTER", 0, 0);
822 if (!adapter.mac_filter_wq) {
827 INIT_WORK(&adapter.mac_flter_work, update_mac_filter);
832 static void deinit_adapter(void)
834 skb_queue_purge(&adapter.events_skb_q);
836 if (adapter.events_wq)
837 destroy_workqueue(adapter.events_wq);
839 if (adapter.if_rx_workqueue)
840 destroy_workqueue(adapter.if_rx_workqueue);
842 if (adapter.mac_filter_wq)
843 destroy_workqueue(adapter.mac_filter_wq);
846 static void esp_reset(void)
848 if (resetpin != HOST_GPIO_PIN_INVALID) {
849 /* Check valid GPIO or not */
850 if (!gpio_is_valid(resetpin)) {
851 esp_warn("host resetpin (%d) configured is invalid GPIO\n", resetpin);
852 resetpin = HOST_GPIO_PIN_INVALID;
854 gpio_request(resetpin, "sysfs");
856 /* HOST's resetpin set to OUTPUT, HIGH */
857 gpio_direction_output(resetpin, true);
859 /* HOST's resetpin set to LOW */
860 gpio_set_value(resetpin, 0);
863 /* HOST's resetpin set to INPUT */
864 gpio_direction_input(resetpin);
866 esp_dbg("Triggering ESP reset.\n");
872 static int __init esp_init(void)
875 struct esp_adapter *adapter = NULL;
877 /* Reset ESP, Clean start ESP */
881 adapter = init_adapter();
886 /* Init transport layer */
887 ret = esp_init_interface_layer(adapter);
896 static void __exit esp_exit(void)
898 uint8_t iface_idx = 0;
900 test_raw_tp_cleanup();
902 for (iface_idx = 0; iface_idx < ESP_MAX_INTERFACE; iface_idx++) {
903 cmd_deinit_interface(adapter.priv[iface_idx]);
905 clear_bit(ESP_DRIVER_ACTIVE, &adapter.state_flags);
907 esp_deinit_interface_layer();
910 if (resetpin != HOST_GPIO_PIN_INVALID) {
914 MODULE_LICENSE("GPL");
918 MODULE_DESCRIPTION("Wifi driver for ESP-Hosted solution");
919 MODULE_VERSION("0.1");
920 module_init(esp_init);
921 module_exit(esp_exit);