Diff: LPC2368/drv/zg2100/zg_defs.h

Revision:

3:e02ec42cf9c8

Parent:

2:1f10f8ab527b

--- a/LPC2368/drv/zg2100/zg_defs.h	Thu Jul 22 11:31:59 2010 +0000
+++ b/LPC2368/drv/zg2100/zg_defs.h	Fri Aug 06 10:42:05 2010 +0000
@@ -21,14 +21,15 @@
 THE SOFTWARE.
 */
 
-//ZG2100 Low-level driver definitions
+/**
+@file
+ZG2100 Low-level driver definitions
+*/
 //Donatien Garnier 2010
 
 #ifndef ZG_DEFS_H
 #define ZG_DEFS_H
 
-#include "zg_err.h" //Error codes
-
 /* Parameters */
 
 #define ZG_HEAD_BUF_SIZE 64//16
@@ -188,6 +189,21 @@
 #define ZG_INT_MASK_F0 0x40
 #define ZG_INT_MASK_F1 0x80
 
+/* Internal Error Codes */
+
+typedef enum __ZG_INT_ERR 
+{
+  ZG_INT_OK = 1,
+  ZG_INT_RESOURCES = 12, //Not enough resources
+  ZG_INT_TIMEOUT,
+  ZG_INT_FRAME_ERROR,
+  ZG_INT_AUTH_REFUSED,
+  ZG_INT_ASSOC_REFUSED,
+  ZG_INT_IN_PROGRESS,
+  ZG_INT_SUPPLICANT_FAILED = 21
+
+} ZG_INT_ERR;
+
 /* F0 / F1 helpers */
 #define ZG_REG_F_CTRL0(n)   ((n==0)?ZG_REG_F0_CTRL0:ZG_REG_F1_CTRL0)
 #define ZG_REG_F_CTRL1(n)   ((n==0)?ZG_REG_F0_CTRL1:ZG_REG_F1_CTRL1)
@@ -236,11 +252,12 @@
   byte revision;
 } ZG_SYSV;
 
+///BSS types
 typedef enum __ZG_BSS_TYPE
 {
-  ZG_BSS_INFRA = 1,
-  ZG_BSS_ADHOC = 2,
-  ZG_BSS_ANY = 3
+  ZG_BSS_INFRA = 1, ///< Infrastructure
+  ZG_BSS_ADHOC = 2, ///< Ad-Hoc
+  ZG_BSS_ANY = 3 ///< Either
 } ZG_BSS_TYPE;
 
 typedef enum __ZG_PROBE_TYPE
@@ -333,13 +350,14 @@
   byte key[ZG_PMK_LEN]; //PSK key returned
 } ZG_PMK_REQ;
 
+///Security type
 typedef enum __ZG_SECURITY
 {
-  ZG_SECURITY_NONE = 0x00,
-  ZG_SECURITY_WEP  = 0x01,
-  ZG_SECURITY_WPA  = 0x02,
-  ZG_SECURITY_WPA2 = 0x03,
-  ZG_SECURITY_TRY  = 0xFF
+  ZG_SECURITY_NONE = 0x00, ///< None
+  ZG_SECURITY_WEP  = 0x01, ///< WEP
+  ZG_SECURITY_WPA  = 0x02, ///< WPA
+  ZG_SECURITY_WPA2 = 0x03, ///< WPA2
+  ZG_SECURITY_TRY  = 0xFF ///< Try all (not recommanded)
 } ZG_SECURITY;
 
 typedef __packed struct __ZG_CONNECT_REQ