wps_userapi.h

WiFi Protected Setup (WPS) 又叫Simple config。 是无线局域网领域推出的新协议

/*
 *  WPS_USERAPI.H : WPS User Application Interface Definition
 * 
 *  ver       date        author      comment
 *  0.0.1     08/02/21    Gao Hua     First
 */

#ifndef _WPS_USERAPI_H
#define _WPS_USERAPI_H

#include "wps_types.h"


typedef enum _tag_user_wps_mode {
	USER_WPS_PIN_MODE = 1,
	USER_WPS_PBC_MODE = 2,
} USER_WPS_MODE;

#define SSID_MAXLENGTH			32
#define NETWORKKEY_MAXLENGTH	64
typedef struct _tag_user_wlan_param {
	WPS_u8 param_SSID[SSID_MAXLENGTH];
	WPS_u16 param_SSID_Length;
	WPS_u16 param_AuthenticationType;
	WPS_u16 param_EncryptionType;
	WPS_u8 param_NetworkKeyIndex;
	WPS_u8 param_NetworkKey[NETWORKKEY_MAXLENGTH];
	WPS_u16 param_NetworkKey_Length;
}USER_WLAN_PARAM;

typedef enum _tag_user_callback_event {
	USER_CALLBACK_EVENT_ERROR		= 0x0001,
	USER_CALLBACK_EVENT_OVERLAP		= 0x0002,
	USER_CALLBACK_EVENT_SUCCESS		= 0x0003,
	USER_CALLBACK_EVENT_STOPPED		= 0x0004,
}USER_CALLBACK_EVENT;
	
typedef void (*WPS_USER_CALLBACK)(USER_CALLBACK_EVENT event);


/* WPS Error Code Definition */
#define WPS_ERROR_SUCCESS            0
#define WPS_ERROR_INVALID_PARAM     -1001
#define WPS_ERROR_NO_MEM            -1002
#define WPS_ERROR_ALREADY_STARTED   -1003
#define WPS_ERROR_ALREADY_STOPPED   -1004
#define WPS_ERROR_MODE_NOT_SET      -1005
#define WPS_ERROR_PIN_NOT_SET       -1006
#define WPS_ERROR_CALLBACK_NOT_SET  -1007
#define WPS_ERROR_NO_WLAN_PARAM     -1008


/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_NO_MEM
*/
int wps_enrol_initialize(void);

/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_INVALID_PARAM
*/
int wps_enrol_set_mode(WPS_u8 mode);

/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_INVALID_PARAM
*/
int wps_enrol_set_pin(WPS_char *pin);

/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_INVALID_PARAM
*/
int wps_enrol_set_callback(WPS_USER_CALLBACK callback);

/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_ALREADY_STARTED
 *  WPS_ERROR_MODE_NOT_SET
 *  WPS_ERROR_PIN_NOT_SET
 *  WPS_ERROR_CALLBACK_NOT_SET
*/
int wps_enrol_start(void);

/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_ALREADY_STOPPED
*/
int wps_enrol_stop(void);


/* 
 * Return value:
 *  WPS_ERROR_SUCCESS
 *  WPS_ERROR_INVALID_PARAM
 *  WPS_ERROR_NO_WLAN_PARAM
*/
int wps_enrol_get_wlan_param(USER_WLAN_PARAM *param);


#endif /* _WPS_USERAPI_H */