Donatien Garnier
ZG2100 Network interface source
drv/zg2100/zg_drv.h@4:e00281c7453d, 2010-08-06 (annotated)
- Committer:
- donatien
- Date:
- Fri Aug 06 10:46:03 2010 +0000
- Revision:
- 4:e00281c7453d
- Parent:
- 3:c4f7efa7d8c3
Who changed what in which revision?
| User | Revision | Line number | New 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 | 3:c4f7efa7d8c3 | 25 | @file |
| donatien | 3:c4f7efa7d8c3 | 26 | ZG2100 Low-level driver |
| donatien | 2:ac860ad9e490 | 27 | */ |
| donatien | 0:b802fc31f1db | 28 | //Donatien Garnier 2010 |
| donatien | 0:b802fc31f1db | 29 | |
| donatien | 0:b802fc31f1db | 30 | #ifndef ZG_DRV_H |
| donatien | 0:b802fc31f1db | 31 | #define ZG_DRV_H |
| donatien | 0:b802fc31f1db | 32 | |
| donatien | 0:b802fc31f1db | 33 | #include "zg_defs.h" |
| donatien | 1:3a7c15057192 | 34 | #include "zg_err.h" |
| donatien | 0:b802fc31f1db | 35 | |
| donatien | 1:3a7c15057192 | 36 | //Stores relevant data |
| donatien | 0:b802fc31f1db | 37 | typedef struct _ZG_DATA |
| donatien | 0:b802fc31f1db | 38 | { |
| donatien | 0:b802fc31f1db | 39 | byte mac_addr[6]; |
| donatien | 0:b802fc31f1db | 40 | ZG_SYSV sys_version; |
| donatien | 1:3a7c15057192 | 41 | |
| donatien | 0:b802fc31f1db | 42 | } ZG_DATA; |
| donatien | 0:b802fc31f1db | 43 | |
| donatien | 1:3a7c15057192 | 44 | //Stores which data is actually available |
| donatien | 0:b802fc31f1db | 45 | typedef struct _ZG_DATA_MASK |
| donatien | 0:b802fc31f1db | 46 | { |
| donatien | 0:b802fc31f1db | 47 | bool mac_addr; |
| donatien | 0:b802fc31f1db | 48 | bool sys_version; |
| donatien | 0:b802fc31f1db | 49 | |
| donatien | 0:b802fc31f1db | 50 | } ZG_DATA_MASK; //true when the corresponding data field is valid, false otherwise |
| donatien | 0:b802fc31f1db | 51 | |
| donatien | 0:b802fc31f1db | 52 | //Exported Data |
| donatien | 0:b802fc31f1db | 53 | extern byte fifo_buf[ZG_FIFO_BUF_SIZE] ZG_MEM; //Big buffer used for fifo transfers |
| donatien | 0:b802fc31f1db | 54 | extern ZG_DATA zg_data; //Container for all data received from the chip |
| donatien | 0:b802fc31f1db | 55 | extern ZG_DATA_MASK zg_data_mask; //Flags valid data |
| donatien | 0:b802fc31f1db | 56 | |
| donatien | 0:b802fc31f1db | 57 | //Spi intf, Chip Select pin, Interrupt pin |
| donatien | 1:3a7c15057192 | 58 | ///Initializes driver (zg_com_init must be called before). |
| donatien | 0:b802fc31f1db | 59 | zg_err zg_drv_init(); |
| donatien | 0:b802fc31f1db | 60 | |
| donatien | 1:3a7c15057192 | 61 | //FIXME: Not implemented, not used (to be deleted?) |
| donatien | 0:b802fc31f1db | 62 | void zg_on_data_attach( void (*on_data)() ); |
| donatien | 0:b802fc31f1db | 63 | |
| donatien | 1:3a7c15057192 | 64 | ///Must be called regularly to process interrupts. |
| donatien | 0:b802fc31f1db | 65 | void zg_process(); //Must be called regularly by user |
| donatien | 0:b802fc31f1db | 66 | |
| donatien | 1:3a7c15057192 | 67 | ///Processes interrupt. (Called by zg_process if needed) |
| donatien | 0:b802fc31f1db | 68 | void zg_int_process(); //Process interrupt |
| donatien | 0:b802fc31f1db | 69 | |
| donatien | 1:3a7c15057192 | 70 | ///Can a management request be sent? |
| donatien | 0:b802fc31f1db | 71 | bool zg_mgmt_is_busy(); |
| donatien | 0:b802fc31f1db | 72 | |
| donatien | 1:3a7c15057192 | 73 | ///Sends management request |
| donatien | 0:b802fc31f1db | 74 | void zg_mgmt_req(byte subtype, byte* buf, int len, bool close = true); |
| donatien | 1:3a7c15057192 | 75 | |
| donatien | 1:3a7c15057192 | 76 | ///Writes additional management data |
| donatien | 0:b802fc31f1db | 77 | void zg_mgmt_data(byte* buf, int len, bool close = true); |
| donatien | 0:b802fc31f1db | 78 | |
| donatien | 1:3a7c15057192 | 79 | ///Gets parameter |
| donatien | 0:b802fc31f1db | 80 | void zg_mgmt_get_param(byte param); |
| donatien | 1:3a7c15057192 | 81 | |
| donatien | 1:3a7c15057192 | 82 | ///Sets parameter |
| donatien | 0:b802fc31f1db | 83 | void zg_mgmt_set_param(byte param, byte* buf, int len); |
| donatien | 0:b802fc31f1db | 84 | |
| donatien | 1:3a7c15057192 | 85 | ///Called on management request result |
| donatien | 0:b802fc31f1db | 86 | void zg_on_mgmt_avl(byte subtype, byte* buf, int len); //Data is available |
| donatien | 1:3a7c15057192 | 87 | |
| donatien | 1:3a7c15057192 | 88 | ///Called on management event |
| donatien | 0:b802fc31f1db | 89 | void zg_on_mgmt_evt(byte subtype, byte* buf, int len); //Management event |
| donatien | 0:b802fc31f1db | 90 | |
| donatien | 1:3a7c15057192 | 91 | ///Called when get parameter request completes |
| donatien | 0:b802fc31f1db | 92 | void zg_on_mgmt_get_param(byte* buf, int len); //Get param completed |
| donatien | 0:b802fc31f1db | 93 | |
| donatien | 0:b802fc31f1db | 94 | //uint32_t zg_fifo_room(); |
| donatien | 0:b802fc31f1db | 95 | |
| donatien | 0:b802fc31f1db | 96 | //Useful to be split in several function because Lwip stores buffers in chunks |
| donatien | 1:3a7c15057192 | 97 | ///Sends Data (start) |
| donatien | 0:b802fc31f1db | 98 | void zg_send_start(); |
| donatien | 1:3a7c15057192 | 99 | ///Sends Data (main) |
| donatien | 0:b802fc31f1db | 100 | void zg_send(byte* buf, int len); |
| donatien | 1:3a7c15057192 | 101 | ///Sends Data (end) |
| donatien | 0:b802fc31f1db | 102 | void zg_send_end(); |
| donatien | 0:b802fc31f1db | 103 | |
| donatien | 1:3a7c15057192 | 104 | ///Can more data be sent? |
| donatien | 0:b802fc31f1db | 105 | bool zg_send_is_busy(); |
| donatien | 0:b802fc31f1db | 106 | |
| donatien | 0:b802fc31f1db | 107 | //Callbacks implemented in zg_if |
| donatien | 0:b802fc31f1db | 108 | void zg_on_scan_results(byte* buf, int len); |
| donatien | 0:b802fc31f1db | 109 | void zg_on_psk_key(byte* buf, int len); |
| donatien | 0:b802fc31f1db | 110 | void zg_on_connect(zg_err result); |
| donatien | 0:b802fc31f1db | 111 | |
| donatien | 0:b802fc31f1db | 112 | //Handled by zg_net |
| donatien | 1:3a7c15057192 | 113 | ///Data received |
| donatien | 0:b802fc31f1db | 114 | void zg_on_input(byte* buf, int len); |
| donatien | 0:b802fc31f1db | 115 | |
| donatien | 0:b802fc31f1db | 116 | //Callbacks from zg_com |
| donatien | 0:b802fc31f1db | 117 | void zg_on_int(); //On data available interrupt |
| donatien | 0:b802fc31f1db | 118 | |
| donatien | 0:b802fc31f1db | 119 | #endif |