User | Revision | Line number | New contents of line |
donatien |
0:0f5a52711275
|
1
|
|
donatien |
0:0f5a52711275
|
2
|
/*
|
donatien |
0:0f5a52711275
|
3
|
Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
|
donatien |
0:0f5a52711275
|
4
|
|
donatien |
0:0f5a52711275
|
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
donatien |
0:0f5a52711275
|
6
|
of this software and associated documentation files (the "Software"), to deal
|
donatien |
0:0f5a52711275
|
7
|
in the Software without restriction, including without limitation the rights
|
donatien |
0:0f5a52711275
|
8
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
donatien |
0:0f5a52711275
|
9
|
copies of the Software, and to permit persons to whom the Software is
|
donatien |
0:0f5a52711275
|
10
|
furnished to do so, subject to the following conditions:
|
donatien |
0:0f5a52711275
|
11
|
|
donatien |
0:0f5a52711275
|
12
|
The above copyright notice and this permission notice shall be included in
|
donatien |
0:0f5a52711275
|
13
|
all copies or substantial portions of the Software.
|
donatien |
0:0f5a52711275
|
14
|
|
donatien |
0:0f5a52711275
|
15
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
donatien |
0:0f5a52711275
|
16
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
donatien |
0:0f5a52711275
|
17
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
donatien |
0:0f5a52711275
|
18
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
donatien |
0:0f5a52711275
|
19
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
donatien |
0:0f5a52711275
|
20
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
donatien |
0:0f5a52711275
|
21
|
THE SOFTWARE.
|
donatien |
0:0f5a52711275
|
22
|
*/
|
donatien |
0:0f5a52711275
|
23
|
|
donatien |
3:e02ec42cf9c8
|
24
|
/**
|
donatien |
3:e02ec42cf9c8
|
25
|
@file
|
donatien |
3:e02ec42cf9c8
|
26
|
ZG2100 Low-level driver
|
donatien |
3:e02ec42cf9c8
|
27
|
*/
|
donatien |
0:0f5a52711275
|
28
|
//Donatien Garnier 2010
|
donatien |
0:0f5a52711275
|
29
|
|
donatien |
0:0f5a52711275
|
30
|
#ifndef ZG_DRV_H
|
donatien |
0:0f5a52711275
|
31
|
#define ZG_DRV_H
|
donatien |
0:0f5a52711275
|
32
|
|
donatien |
0:0f5a52711275
|
33
|
#include "zg_defs.h"
|
donatien |
3:e02ec42cf9c8
|
34
|
#include "zg_err.h"
|
donatien |
0:0f5a52711275
|
35
|
|
donatien |
3:e02ec42cf9c8
|
36
|
//Stores relevant data
|
donatien |
0:0f5a52711275
|
37
|
typedef struct _ZG_DATA
|
donatien |
0:0f5a52711275
|
38
|
{
|
donatien |
0:0f5a52711275
|
39
|
byte mac_addr[6];
|
donatien |
0:0f5a52711275
|
40
|
ZG_SYSV sys_version;
|
donatien |
3:e02ec42cf9c8
|
41
|
|
donatien |
0:0f5a52711275
|
42
|
} ZG_DATA;
|
donatien |
0:0f5a52711275
|
43
|
|
donatien |
3:e02ec42cf9c8
|
44
|
//Stores which data is actually available
|
donatien |
0:0f5a52711275
|
45
|
typedef struct _ZG_DATA_MASK
|
donatien |
0:0f5a52711275
|
46
|
{
|
donatien |
0:0f5a52711275
|
47
|
bool mac_addr;
|
donatien |
0:0f5a52711275
|
48
|
bool sys_version;
|
donatien |
0:0f5a52711275
|
49
|
|
donatien |
0:0f5a52711275
|
50
|
} ZG_DATA_MASK; //true when the corresponding data field is valid, false otherwise
|
donatien |
0:0f5a52711275
|
51
|
|
donatien |
0:0f5a52711275
|
52
|
//Exported Data
|
donatien |
0:0f5a52711275
|
53
|
extern byte fifo_buf[ZG_FIFO_BUF_SIZE] ZG_MEM; //Big buffer used for fifo transfers
|
donatien |
0:0f5a52711275
|
54
|
extern ZG_DATA zg_data; //Container for all data received from the chip
|
donatien |
0:0f5a52711275
|
55
|
extern ZG_DATA_MASK zg_data_mask; //Flags valid data
|
donatien |
0:0f5a52711275
|
56
|
|
donatien |
0:0f5a52711275
|
57
|
//Spi intf, Chip Select pin, Interrupt pin
|
donatien |
3:e02ec42cf9c8
|
58
|
///Initializes driver (zg_com_init must be called before).
|
donatien |
0:0f5a52711275
|
59
|
zg_err zg_drv_init();
|
donatien |
0:0f5a52711275
|
60
|
|
donatien |
3:e02ec42cf9c8
|
61
|
//FIXME: Not implemented, not used (to be deleted?)
|
donatien |
0:0f5a52711275
|
62
|
void zg_on_data_attach( void (*on_data)() );
|
donatien |
0:0f5a52711275
|
63
|
|
donatien |
3:e02ec42cf9c8
|
64
|
///Must be called regularly to process interrupts.
|
donatien |
0:0f5a52711275
|
65
|
void zg_process(); //Must be called regularly by user
|
donatien |
0:0f5a52711275
|
66
|
|
donatien |
3:e02ec42cf9c8
|
67
|
///Processes interrupt. (Called by zg_process if needed)
|
donatien |
0:0f5a52711275
|
68
|
void zg_int_process(); //Process interrupt
|
donatien |
0:0f5a52711275
|
69
|
|
donatien |
3:e02ec42cf9c8
|
70
|
///Can a management request be sent?
|
donatien |
0:0f5a52711275
|
71
|
bool zg_mgmt_is_busy();
|
donatien |
0:0f5a52711275
|
72
|
|
donatien |
3:e02ec42cf9c8
|
73
|
///Sends management request
|
donatien |
0:0f5a52711275
|
74
|
void zg_mgmt_req(byte subtype, byte* buf, int len, bool close = true);
|
donatien |
3:e02ec42cf9c8
|
75
|
|
donatien |
3:e02ec42cf9c8
|
76
|
///Writes additional management data
|
donatien |
0:0f5a52711275
|
77
|
void zg_mgmt_data(byte* buf, int len, bool close = true);
|
donatien |
0:0f5a52711275
|
78
|
|
donatien |
3:e02ec42cf9c8
|
79
|
///Gets parameter
|
donatien |
0:0f5a52711275
|
80
|
void zg_mgmt_get_param(byte param);
|
donatien |
3:e02ec42cf9c8
|
81
|
|
donatien |
3:e02ec42cf9c8
|
82
|
///Sets parameter
|
donatien |
0:0f5a52711275
|
83
|
void zg_mgmt_set_param(byte param, byte* buf, int len);
|
donatien |
0:0f5a52711275
|
84
|
|
donatien |
3:e02ec42cf9c8
|
85
|
///Called on management request result
|
donatien |
0:0f5a52711275
|
86
|
void zg_on_mgmt_avl(byte subtype, byte* buf, int len); //Data is available
|
donatien |
3:e02ec42cf9c8
|
87
|
|
donatien |
3:e02ec42cf9c8
|
88
|
///Called on management event
|
donatien |
0:0f5a52711275
|
89
|
void zg_on_mgmt_evt(byte subtype, byte* buf, int len); //Management event
|
donatien |
0:0f5a52711275
|
90
|
|
donatien |
3:e02ec42cf9c8
|
91
|
///Called when get parameter request completes
|
donatien |
0:0f5a52711275
|
92
|
void zg_on_mgmt_get_param(byte* buf, int len); //Get param completed
|
donatien |
0:0f5a52711275
|
93
|
|
donatien |
0:0f5a52711275
|
94
|
//uint32_t zg_fifo_room();
|
donatien |
0:0f5a52711275
|
95
|
|
donatien |
0:0f5a52711275
|
96
|
//Useful to be split in several function because Lwip stores buffers in chunks
|
donatien |
3:e02ec42cf9c8
|
97
|
///Sends Data (start)
|
donatien |
0:0f5a52711275
|
98
|
void zg_send_start();
|
donatien |
3:e02ec42cf9c8
|
99
|
///Sends Data (main)
|
donatien |
0:0f5a52711275
|
100
|
void zg_send(byte* buf, int len);
|
donatien |
3:e02ec42cf9c8
|
101
|
///Sends Data (end)
|
donatien |
0:0f5a52711275
|
102
|
void zg_send_end();
|
donatien |
0:0f5a52711275
|
103
|
|
donatien |
3:e02ec42cf9c8
|
104
|
///Can more data be sent?
|
donatien |
0:0f5a52711275
|
105
|
bool zg_send_is_busy();
|
donatien |
0:0f5a52711275
|
106
|
|
donatien |
0:0f5a52711275
|
107
|
//Callbacks implemented in zg_if
|
donatien |
0:0f5a52711275
|
108
|
void zg_on_scan_results(byte* buf, int len);
|
donatien |
0:0f5a52711275
|
109
|
void zg_on_psk_key(byte* buf, int len);
|
donatien |
0:0f5a52711275
|
110
|
void zg_on_connect(zg_err result);
|
donatien |
0:0f5a52711275
|
111
|
|
donatien |
0:0f5a52711275
|
112
|
//Handled by zg_net
|
donatien |
3:e02ec42cf9c8
|
113
|
///Data received
|
donatien |
0:0f5a52711275
|
114
|
void zg_on_input(byte* buf, int len);
|
donatien |
0:0f5a52711275
|
115
|
|
donatien |
0:0f5a52711275
|
116
|
//Callbacks from zg_com
|
donatien |
0:0f5a52711275
|
117
|
void zg_on_int(); //On data available interrupt
|
donatien |
0:0f5a52711275
|
118
|
|
donatien |
0:0f5a52711275
|
119
|
#endif
|