Donatien Garnier
ZG2100 Network interface source
drv/zg2100/zg_if.h@1:3a7c15057192, 2010-08-06 (annotated)
- Committer:
- donatien
- Date:
- Fri Aug 06 10:23:41 2010 +0000
- Revision:
- 1:3a7c15057192
- Parent:
- 0:b802fc31f1db
- Child:
- 2:ac860ad9e490
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 | 1:3a7c15057192 | 24 | /// \file ZG2100 NetServices high-level interface : configuration & setup |
| donatien | 0:b802fc31f1db | 25 | //Donatien Garnier 2010 |
| donatien | 0:b802fc31f1db | 26 | |
| donatien | 0:b802fc31f1db | 27 | #ifndef ZG_IF_H |
| donatien | 0:b802fc31f1db | 28 | #define ZG_IF_H |
| donatien | 0:b802fc31f1db | 29 | |
| donatien | 0:b802fc31f1db | 30 | #include "zg_defs.h" |
| donatien | 0:b802fc31f1db | 31 | |
| donatien | 1:3a7c15057192 | 32 | ///Scans for available networks on given \a channel. |
| donatien | 0:b802fc31f1db | 33 | void zg_scan(byte channel); |
| donatien | 0:b802fc31f1db | 34 | |
| donatien | 1:3a7c15057192 | 35 | ///Will be called on scan completion, for now it is just a debug dump. |
| donatien | 0:b802fc31f1db | 36 | void zg_on_scan_results(byte* buf, int len); |
| donatien | 0:b802fc31f1db | 37 | |
| donatien | 1:3a7c15057192 | 38 | ///Sets the SSID of the network to be joined. |
| donatien | 0:b802fc31f1db | 39 | void zg_set_ssid(const char* ssid); |
| donatien | 0:b802fc31f1db | 40 | |
| donatien | 1:3a7c15057192 | 41 | ///Sets WEP key. |
| donatien | 0:b802fc31f1db | 42 | void zg_set_wep_key(const byte* key, int len); |
| donatien | 0:b802fc31f1db | 43 | |
| donatien | 1:3a7c15057192 | 44 | ///Sets WPA passphrase (will compute PSK key and set it). |
| donatien | 0:b802fc31f1db | 45 | void zg_set_wpa_pass(const char* pass); |
| donatien | 0:b802fc31f1db | 46 | |
| donatien | 1:3a7c15057192 | 47 | ///On completion of the passphrase computation. |
| donatien | 0:b802fc31f1db | 48 | void zg_on_psk_key(byte* buf, int len); |
| donatien | 0:b802fc31f1db | 49 | |
| donatien | 1:3a7c15057192 | 50 | ///Sets PSK key (preferred to be called directly than recomputing it every time using \a zg_set_wpa_pass). |
| donatien | 0:b802fc31f1db | 51 | void zg_set_psk_key(const byte* key, int len); |
| donatien | 0:b802fc31f1db | 52 | |
| donatien | 1:3a7c15057192 | 53 | ///Connects to network. |
| donatien | 0:b802fc31f1db | 54 | void zg_connect(ZG_BSS_TYPE type, ZG_SECURITY security); |
| donatien | 0:b802fc31f1db | 55 | |
| donatien | 1:3a7c15057192 | 56 | ///On connection result. |
| donatien | 0:b802fc31f1db | 57 | void zg_on_connect(zg_err result); |
| donatien | 0:b802fc31f1db | 58 | |
| donatien | 1:3a7c15057192 | 59 | ///Gets connection result. |
| donatien | 0:b802fc31f1db | 60 | zg_err zg_get_connection_result(); |
| donatien | 0:b802fc31f1db | 61 | |
| donatien | 1:3a7c15057192 | 62 | ///Disconnects from network. |
| donatien | 0:b802fc31f1db | 63 | void zg_disconnect(); |
| donatien | 0:b802fc31f1db | 64 | |
| donatien | 0:b802fc31f1db | 65 | void hexdump(byte* buffer, int size); |
| donatien | 0:b802fc31f1db | 66 | |
| donatien | 0:b802fc31f1db | 67 | #endif |