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