wilc1000_driver.h
Go to the documentation of this file.
1 /**
2  * @file wilc1000_driver.h
3  * @brief WILC1000 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 _WILC1000_DRIVER_H
30 #define _WILC1000_DRIVER_H
31 
32 //Dependencies
33 #include "core/nic.h"
34 
35 //TX buffer size
36 #ifndef WILC1000_TX_BUFFER_SIZE
37  #define WILC1000_TX_BUFFER_SIZE 1600
38 #elif (WILC1000_TX_BUFFER_SIZE != 1600)
39  #error WILC1000_TX_BUFFER_SIZE parameter is not valid
40 #endif
41 
42 //RX buffer size
43 #ifndef WILC1000_RX_BUFFER_SIZE
44  #define WILC1000_RX_BUFFER_SIZE 1600
45 #elif (WILC1000_RX_BUFFER_SIZE != 1600)
46  #error WILC1000_RX_BUFFER_SIZE parameter is not valid
47 #endif
48 
49 //C++ guard
50 #ifdef __cplusplus
51  extern "C" {
52 #endif
53 
54 //WILC1000 driver (STA mode)
55 extern const NicDriver wilc1000StaDriver;
56 //WILC1000 driver (AP mode)
57 extern const NicDriver wilc1000ApDriver;
58 
59 //WILC1000 related functions
61 
62 void wilc1000Tick(NetInterface *interface);
63 
64 void wilc1000EnableIrq(NetInterface *interface);
65 void wilc1000DisableIrq(NetInterface *interface);
67 void wilc1000EventHandler(NetInterface *interface);
68 
70  const NetBuffer *buffer, size_t offset);
71 
73 bool_t wilc1000GetAddrRefCount(NetInterface *interface, const MacAddr *macAddr);
74 
75 void wilc1000AppWifiEvent(uint8_t msgType, void *msg);
76 void wilc1000AppEthEvent(uint8_t msgType, void *msg, void *ctrlBuf);
77 
78 //C++ guard
79 #ifdef __cplusplus
80  }
81 #endif
82 
83 #endif
void wilc1000EnableIrq(NetInterface *interface)
Enable interrupts.
error_t wilc1000UpdateMacAddrFilter(NetInterface *interface)
Configure MAC address filtering.
const NicDriver wilc1000ApDriver
WILC1000 driver (AP mode)
void wilc1000AppEthEvent(uint8_t msgType, void *msg, void *ctrlBuf)
Callback function that handles events in bypass mode.
error_t wilc1000SendPacket(NetInterface *interface, const NetBuffer *buffer, size_t offset)
Send a packet.
const NicDriver wilc1000StaDriver
WILC1000 driver (STA mode)
NIC driver.
Definition: nic.h:161
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:86
bool_t wilc1000GetAddrRefCount(NetInterface *interface, const MacAddr *macAddr)
Get reference count for the specified multicast MAC address.
void wilc1000Tick(NetInterface *interface)
WILC1000 timer handler.
bool_t wilc1000IrqHandler(void)
WILC1000 interrupt service routine.
void wilc1000EventHandler(NetInterface *interface)
WILC1000 event handler.
void wilc1000DisableIrq(NetInterface *interface)
Disable interrupts.
error_t
Error codes.
Definition: error.h:40
__start_packed struct @112 MacAddr
MAC address.
#define NetInterface
Definition: net.h:34
void wilc1000AppWifiEvent(uint8_t msgType, void *msg)
Callback function that handles Wi-Fi events.
uint8_t msgType
Definition: dtls_misc.h:177
error_t wilc1000Init(NetInterface *interface)
WILC1000 initialization.
int bool_t
Definition: compiler_port.h:47
Network interface controller abstraction layer.