esp8266_driver.h File Reference

ESP8266 Wi-Fi controller. More...

#include "core/nic.h"

Go to the source code of this file.

Functions
error_t	esp8266WifiInit (NetInterface *interface)
	ESP8266_WIFI initialization. More...
void	esp8266WifiTick (NetInterface *interface)
	ESP8266 Wi-Fi timer handler. More...
void	esp8266WifiEnableIrq (NetInterface *interface)
	Enable interrupts. More...
void	esp8266WifiDisableIrq (NetInterface *interface)
	Disable interrupts. More...
void	esp8266WifiEventHandler (NetInterface *interface)
	ESP8266 Wi-Fi event handler. More...
error_t	esp8266WifiSendPacket (NetInterface *interface, const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
	Send a packet. More...
error_t	esp8266WifiUpdateMacAddrFilter (NetInterface *interface)
	Configure MAC address filtering. More...

Variables
const NicDriver	esp8266WifiStaDriver
	ESP8266 Wi-Fi driver (STA mode) More...
const NicDriver	esp8266WifiApDriver
	ESP8266 Wi-Fi driver (AP mode) More...

Detailed Description

ESP8266 Wi-Fi controller.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneTCP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.0

Definition in file esp8266_driver.h.

Function Documentation

esp8266WifiDisableIrq()

void esp8266WifiDisableIrq

(

NetInterface *

interface

)

Disable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 207 of file esp8266_driver.c.

esp8266WifiEnableIrq()

void esp8266WifiEnableIrq

(

NetInterface *

interface

)

Enable interrupts.

Parameters

[in]

interface

Underlying network interface

Definition at line 197 of file esp8266_driver.c.

esp8266WifiEventHandler()

void esp8266WifiEventHandler

(

NetInterface *

interface

)

ESP8266 Wi-Fi event handler.

Parameters

[in]

interface

Underlying network interface

Definition at line 217 of file esp8266_driver.c.

esp8266WifiInit()

error_t esp8266WifiInit

(

NetInterface *

interface

)

ESP8266_WIFI initialization.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 103 of file esp8266_driver.c.

esp8266WifiSendPacket()

error_t esp8266WifiSendPacket	(	NetInterface *	interface,
		const NetBuffer *	buffer,
		size_t	offset,
		NetTxAncillary *	ancillary
	)

Send a packet.

Parameters

[in]	interface	Underlying network interface
[in]	buffer	Multi-part buffer containing the data to send
[in]	offset	Offset to the first data byte
[in]	ancillary	Additional options passed to the stack along with the packet

Returns

Error code

Definition at line 232 of file esp8266_driver.c.

esp8266WifiTick()

void esp8266WifiTick

(

NetInterface *

interface

)

ESP8266 Wi-Fi timer handler.

This routine is periodically called by the TCP/IP stack to handle periodic operations such as polling the link state

Parameters

[in]

interface

Underlying network interface

Definition at line 187 of file esp8266_driver.c.

esp8266WifiUpdateMacAddrFilter()

error_t esp8266WifiUpdateMacAddrFilter

(

NetInterface *

interface

)

Configure MAC address filtering.

Parameters

[in]

interface

Underlying network interface

Returns

Error code

Definition at line 294 of file esp8266_driver.c.

Variable Documentation

esp8266WifiApDriver

const NicDriver esp8266WifiApDriver

extern

ESP8266 Wi-Fi driver (AP mode)

Definition at line 76 of file esp8266_driver.c.

esp8266WifiStaDriver

const NicDriver esp8266WifiStaDriver

extern

ESP8266 Wi-Fi driver (STA mode)

Definition at line 51 of file esp8266_driver.c.