WL05 Driver Library – API Documentation

Header image

Main page


Data Structures | Macros | Typedefs | Enumerations
WL05 Public data structures, constants and enums

Data Structures

struct  WL05_HW_Cfg
 WL05 hardware configuration. More...
 
struct  WL05_Rssi_Threshold
 WL05 RSSI threshold settings. More...
 
struct  WL05_Scan_Reply
 Scanned wireless station information. More...
 
struct  WL05_Scan_Reply_Pool
 Array of WL05_Scan_Reply with number of valid entries. More...
 
struct  WL05_Scan_Params
 WL05 Scan parameters. More...
 
struct  WL05_Connect_Params
 WL05 Connect parameters. More...
 

Macros

#define WL05_MAX_SCAN_REPLY   12
 Maximum number of scanned Access Points. More...
 
#define WL05_SSID_LEN   34
 Maximum length of SSID. More...
 
#define WL05_PSK_LEN   64
 Maximum length of PSK. More...
 
#define WL05_WPS_PIN_LEN   8
 Maximum WPS PIN length. More...
 
#define WL05_WEP128_HEXSTR_LEN   26
 Length of a 128 bit WEP key. More...
 
#define WL05_SPI_MAX_CLOCKDIV   1
 Maximum SPI clock divider. More...
 
#define WL05_SPI_MAX_CLOCKDIV   1
 Maximum SPI clock divider. More...
 
#define WL05_INIT_CB   0
 Callback on initialization errors. More...
 
#define WL05_STATUS_CB   1
 Callback on status indications at run time. More...
 
#define WL05_TX_CB   2
 Callback on outgoing data packets. More...
 
#define WL05_RX_CB   3
 Callback on incoming data packets. More...
 

Typedefs

typedef int(huge * WL05_RSSI_CbPtr) (int32 rssi)
 RSSI callback function pointer. More...
 

Enumerations

enum  WL05_ApiErrorCode {
  WL05_API_FAILURE = -1,
  WL05_API_SUCCESS = 0,
  WL05_API_SEMAPHORE_TIMEOUT = 1,
  WL05_API_MGMT_REQ_NOT_ALLOWED = 2,
  WL05_API_MGMT_REQ_NOT_EXECUTED = 3,
  WL05_API_MGMT_RESP_TIMEOUT = 4,
  WL05_API_BAD_PARAMETERS = 5,
  WL05_API_TIMEOUT = 6,
  WL05_API_DEV_NOT_READY = 7
}
 Error codes returned by several API functions e.g. wl05_connect. More...
 
enum  WL05_Band {
  BAND_2P4GHZ = 0x00,
  BAND_5GHZ = 0x01,
  BAND_DUAL = 0x02
}
 Module's operating band. If the user wishes to change the module's band, the module has to be restarted by calling the wl05_restart function. More...
 
enum  WL05_DrvIndicationCodes {
  NO_INDICATION = 0,
  ASSOCIATED = 1,
  IBSS_COMPLETE = 2,
  IBSS_JOINED = 3,
  IBSS_ALONE = 4,
  IBSS_LOSS = 5,
  MGMT_ERROR = 0x80,
  MGMT_TIMEOUT = 0x81,
  BAD_PARAMETERS = 0x82,
  SCAN_FAILURE = 0x83,
  SCAN_NOT_FOUND = 0x84,
  JOIN_FAILURE = 0x85,
  JOIN_TIMEOUT = 0x86,
  AUTH_FAILURE = 0x87,
  DEAUTHENTICATED = 0x88,
  ASSOC_FAILURE = 0x89,
  DISASSOCIATED = 0x8A,
  WEP_PAIRKEY_FAULT = 0x8B,
  WEP_GROUPKEY_FAULT = 0x8C,
  DISCONNECTED = 0x8D,
  TARGET_HUNG = 0x90,
  KEEPALIVE_FAULT = 0x91
}
 Possible indication codes during the association process, retrievable by wl05_get_drv_indication. More...
 
enum  WL05_InitErrorCodes {
  INIT_DONE = 0,
  RESP_TIMEOUT = 1,
  HW_SPI_ERROR = 2,
  FW_LOAD_ERROR = 3,
  DEV_CLOSED = 4,
  INIT_STARTED = 5
}
 Error codes returned by wl05_get_init_error. More...
 
enum  WL05_PowerLevel {
  POWER_LEVEL_LOW = 0,
  POWER_LEVEL_MEDIUM = 1,
  POWER_LEVEL_HIGH = 2
}
 Power level constants, for use inside the WL05_Connect_Params data structure. More...
 
enum  WL05_DataRate
 Transmission data rate constants, for use inside the WL05_Connect_Params data structure. More...
 
enum  WL05_Region {
  REGION_US = 1,
  REGION_JP = 2,
  REGION_EU = 3,
  REGION_WORLD = 4
}
 Region codes to be used when calling wl05_set_regdomain. More...
 
enum  WL05_SecurityType {
  SECURITY_TYPE_OPEN = 0,
  SECURITY_TYPE_WPA = 1,
  SECURITY_TYPE_WPA2 = 2,
  SECURITY_TYPE_WEP = 3,
  SECURITY_TYPE_WPA_EAP = 4,
  SECURITY_TYPE_WPA2_EAP = 5,
  SECURITY_TYPE_MIXED = 6,
  SECURITY_TYPE_WPS = 7
}
 Security type for connecting to an Access Point. More...
 

Detailed Description






Top of page | Main page

Copyright © 2016 Beck IPC GmbH
Generated by Doxygen 1.8.12