Donatien Garnier / ZG2100NetIfSource
Committer:
donatien
Date:
Fri Aug 06 10:32:40 2010 +0000
Revision:
2:ac860ad9e490
Parent:
1:3a7c15057192
Child:
3:c4f7efa7d8c3

        

Who changed what in which revision?

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