/
bcm43362.h
126 lines (113 loc) · 3.45 KB
/
bcm43362.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/**
* @file drivers/bcm43362.h
*
* @section License
* Copyright (C) 2014-2016, Erik Moqvist
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* This file is part of the Simba project.
*/
#ifndef __DRIVERS_BCM43362_H__
#define __DRIVERS_BCM43362_H__
#include "simba.h"
#include "lwip/pbuf.h"
struct bcm43362_driver_t {
struct sdio_driver_t sdio;
};
/**
* Initialize the BCM43362 module. This function must be called before
* calling any other function in this module.
*
* The module will only be initialized once even if this function is
* called multiple times.
*
* @return zero(0) or negative error code.
*/
int bcm43362_module_init(void);
/**
* Initialize driver object from given configuration.
*
* @param[in] self_p Driver object to be initialized.
* @param[in] sdio_dev_p SDIO device to use.
*
* @return zero(0) or negative error code.
*/
int bcm43362_init(struct bcm43362_driver_t *self_p,
struct sdio_device_t *sdio_dev_p);
/**
* Starts the BCM43362 device using given driver object.
*
* After a successful start of the device the application may call
* `bcm43362_connect()` to connect to an AP.
*
* @param[in] self_p Initialized driver object.
*
* @return zero(0) or negative error code.
*/
int bcm43362_start(struct bcm43362_driver_t *self_p);
/**
* Stops the BCM43362 device referenced by given driver object.
*
* @param[in] self_p Initialized driver object.
*
* @return zero(0) or negative error code.
*/
int bcm43362_stop(struct bcm43362_driver_t *self_p);
/**
* Connect to an WiFi Access Point (AP) with given SSID and password.
*
* @param[in] self_p Initialized driver object.
* @param[in] ssid_p SSID of the WiFi AP to connect to.
* @param[in] password_p Password.
*
* @return zero(0) or negative error code.
*/
int bcm43362_connect(struct bcm43362_driver_t *self_p,
const char *ssid_p,
const char *password_p);
/**
* Disconnect from any connected WiFi AP.
*
* @param[in] self_p Initialized driver object.
*
* @return zero(0) or negative error code.
*/
int bcm43362_disconnect(struct bcm43362_driver_t *self_p);
/**
* Read a packet from the BCM43362 device.
*
* @param[in] self_p Initialized driver object.
* @param[in] pbuf_p Buffer to read into.
* @param[in] size Number of bytes to receive.
*
* @return Number of read bytes or negative error code.
*/
ssize_t bcm43362_read(struct bcm43362_driver_t *self_p,
struct pbuf *pbuf_p,
size_t size);
/**
* Write given packet to the BCM43362 device to transmit it on the
* network.
*
* This function is normally called by a network interface to send a
* frame on the network.
*
* @param[in] self_p Initialized driver object.
* @param[in] pbuf_p Buffer to write.
* @param[in] size Number of bytes to write.
*
* @return Number of written bytes or negative error code.
*/
ssize_t bcm43362_write(struct bcm43362_driver_t *self_p,
struct pbuf *pbuf_p,
size_t size);
#endif