esp8266_driver.h
Go to the documentation of this file.
1 /**
2  * @file esp8266_driver.h
3  * @brief ESP8266 Wi-Fi controller
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _ESP8266_WIFI_DRIVER_H
32 #define _ESP8266_WIFI_DRIVER_H
33 
34 //Dependencies
35 #include "core/nic.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //ESP8266 Wi-Fi driver (STA mode)
43 extern const NicDriver esp8266WifiStaDriver;
44 //ESP8266 Wi-Fi driver (AP mode)
45 extern const NicDriver esp8266WifiApDriver;
46 
47 //ESP8266 Wi-Fi related functions
49 
50 void esp8266WifiTick(NetInterface *interface);
51 
52 void esp8266WifiEnableIrq(NetInterface *interface);
53 void esp8266WifiDisableIrq(NetInterface *interface);
54 void esp8266WifiEventHandler(NetInterface *interface);
55 
57  const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
58 
60 
61 //C++ guard
62 #ifdef __cplusplus
63 }
64 #endif
65 
66 #endif
const NicDriver esp8266WifiStaDriver
ESP8266 Wi-Fi driver (STA mode)
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
const NicDriver esp8266WifiApDriver
ESP8266 Wi-Fi driver (AP mode)
void esp8266WifiTick(NetInterface *interface)
ESP8266 Wi-Fi timer handler.
error_t esp8266WifiInit(NetInterface *interface)
ESP8266_WIFI initialization.
error_t esp8266WifiSendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send a packet.
error_t esp8266WifiUpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
error_t
Error codes.
Definition: error.h:43
void esp8266WifiEventHandler(NetInterface *interface)
ESP8266 Wi-Fi event handler.
#define NetInterface
Definition: net.h:36
#define NetTxAncillary
Definition: net_misc.h:36
Network interface controller abstraction layer.
void esp8266WifiEnableIrq(NetInterface *interface)
Enable interrupts.
void esp8266WifiDisableIrq(NetInterface *interface)
Disable interrupts.
NIC driver.
Definition: nic.h:286