WCM Library Constants

Definitions


#include <nitroWiFi/wcm.h>

#define   WCM_RESULT_SUCCESS         0
#define   WCM_RESULT_FAILURE         1
#define   WCM_RESULT_PROGRESS        2
#define   WCM_RESULT_ACCEPT          3
#define   WCM_RESULT_REJECT          4
#define   WCM_RESULT_WMDISABLE       5
#define   WCM_RESULT_NOT_ENOUGH_MEM  6
#define   WCM_RESULT_FATAL_ERROR     7

#define   WCM_PHASE_NULL             0
#define   WCM_PHASE_WAIT             1
#define   WCM_PHASE_WAIT_TO_IDLE     2
#define   WCM_PHASE_IDLE             3
#define   WCM_PHASE_IDLE_TO_WAIT     4
#define   WCM_PHASE_IDLE_TO_SEARCH   5
#define   WCM_PHASE_SEARCH           6
#define   WCM_PHASE_SEARCH_TO_IDLE   7
#define   WCM_PHASE_IDLE_TO_DCF      8
#define   WCM_PHASE_DCF              9
#define   WCM_PHASE_DCF_TO_IDLE      10
#define   WCM_PHASE_FATAL_ERROR      11
#define   WCM_PHASE_IRREGULAR        12
#define   WCM_PHASE_TERMINATING      13

#define   WCM_NOTIFY_COMMON          0
#define   WCM_NOTIFY_STARTUP         1
#define   WCM_NOTIFY_CLEANUP         2
#define   WCM_NOTIFY_BEGIN_SEARCH    3
#define   WCM_NOTIFY_END_SEARCH      4
#define   WCM_NOTIFY_CONNECT         5
#define   WCM_NOTIFY_DISCONNECT      6
#define   WCM_NOTIFY_FOUND_AP        7
#define   WCM_NOTIFY_SEARCH_AROUND   8
#define   WCM_NOTIFY_TERMINAME       9

#define   WCM_WEPMODE_NONE           0
#define   WCM_WEPMODE_40             1
#define   WCM_WEPMODE_104            2
#define   WCM_WEPMODE_128            3

#define   WCM_BSSID_ANY              ( (void*)WCM_Bssid_Any )
#define   WCM_ESSID_ANY              ( (void*)WCM_Essid_Any )
				

Process Result Constants

WCM_RESULT_SUCCESS This result can be returned as a synchronous or asynchronous process result. It indicates that the process was successful.
WCM_RESULT_FAILURE This result can be returned as a synchronous or asynchronous process result. Indicates that the process failed for some reason.
This result is returned when an argument passed at invocation was invalid, an asynchronous function was called in an invalid internal state, or when an asynchronous process that changes the internal state has failed and retry is not possible.
WCM_RESULT_PROGRESS This result can be returned only as a synchronous process result. Indicates that a request identical to the requested process is accepted and the process is executing.
WCM_RESULT_ACCEPT This result can be returned only as an asynchronous process result. It indicates that the request to start the asynchronous process was accepted normally.
When the asynchronous process is complete, a corresponding asynchronous process notification will always be sent once.
WCM_RESULT_REJECT This result can be returned only as an asynchronous process result. It indicates that the request to start the asynchronous process was rejected.
It was rejected because it was unsuccessful in issuing a PXI process request to the ARM7. Accordingly, a retry is possible after waiting briefly.
WCM_RESULT_WMDISABLE This result can be returned only as a synchronous process result of the WCM_StartupAsync function. It indicates that the wireless driver is not operating on the ARM7 side.
If the ARM7 component is ichneumon, the wireless driver may have been forcibly stopped by the WVR library.
WCM_RESULT_NOT_ENOUGH_MEM This result can be returned only to the WCM_Initfunction. Indicates that the work buffer size was insufficient.
WCM_RESULT_FATAL_ERROR This result can be returned as a synchronous or asynchronous process result. Indicates that an unrecoverable error occurred in the library.
This error indicates that an unexpected event has occurred inside the library. For example, the internal work memory was corrupted or the WCM library's internal state management was corrupted by directly using the WM or WVR libraries from an external location.
This error should not occur under normal circumstances. But if it does occur, recovery is not possible. Display a screen to prompt the end user to turn off the power or prevent wireless communication from occuring while the power is on.

Internal State Constants

WCM_PHASE_NULL State before the WCM library is initialized using WCM_Init function or after the WCM library is terminated using WCM_Finish function.
WCM_PHASE_WAIT The state after the WCM is initialized using WCM_Init function or after the wireless functionality has been stopped using WCM_CleanupAsync function or WCM_TerminateAsync function.
WCM_PHASE_WAIT_TO_IDLE The state during startup of the wireless functionality using WCM_StartupAsync function.
WCM_PHASE_IDLE The wireless functionality has been started up and it is waiting for the process that searches for or connects to a wireless access point.
WCM_PHASE_IDLE_TO_WAIT The state while the wireless functionality is stopped using WCM_CleanupAsync function.
WCM_PHASE_IDLE_TO_SEARCH The state while the WCM is starting a wireless access point auto-search using WCM_BeginSearchAsync function.
WCM_PHASE_SEARCH The state while executing a wireless access point auto-search.
WCM_PHASE_SEARCH_TO_IDLE The state while the wireless access point auto-search is stopped using WCM_EndSearchAsync function.
WCM_PHASE_IDLE_TO_DCF State while performing processing to connect to a wireless access point using WCM_ConnectAsync function.
WCM_PHASE_DCF State while connected to a wireless access point and in which DCF communication is possible.
WCM_PHASE_DCF_TO_IDLE The state while the WCM is disconnecting form a wireless access point using WCM_DisconnectAsync function.
WCM_PHASE_FATAL_ERROR State that indicates an unexpected event has occurred inside the WCM library. Once the WCM enters this state, it cannot be changed.
WCM_PHASE_IRREGULAR An error occurred during an asynchronous process performed in the WCM library, and the asynchronous process can no longer be continued.
From this state, a recovery can be attempted only by using WCM_TerminateAsync function.
WCM_PHASE_TERMINATING The state while the WCM library has been forcibly stopped using WCM_TerminateAsync function.

Notification Type Constants

WCM_NOTIFY_COMMON The default notification type. Provided for debugging. When a notification of this type occurs, it means that an unexpected event has occurred, such as memory corruption.
WCM_NOTIFY_STARTUP Notification type used in result notifications for asynchronous processes initiated with WCM_StartupAsync function.
WCM_NOTIFY_CLEANUP Notification type used in result notifications for asynchronous processes initiated with WCM_CleanupAsync function.
WCM_NOTIFY_BEGIN_SEARCH Notification type used in result notifications for asynchronous processes initiated with WCM_BeginSearchAsync function.
WCM_NOTIFY_END_SEARCH Notification type used in result notifications for asynchronous processes initiated with WCM_EndSearchAsync function.
WCM_NOTIFY_CONNECT Notification type used in result notifications for asynchronous processes initiated with WCM_ConnectAsync function.
WCM_NOTIFY_DISCONNECT Notification type used in result notifications for asynchronous processes initiated with WCM_DisconnectAsync function. Also used as a notification type for progress notification (received disconnection notification) while connected to a wireless access point.
WCM_NOTIFY_FOUND_AP Notification type for progress notification during wireless access point auto-search.
WCM_NOTIFY_SEARCH_AROUND Notification type used when indicating that a wireless access point auto-search search cycle has completed.
WCM_NOTIFY_TERMINAME Notification type used in result notifications for asynchronous processes initiated with WCM_TerminateAsync function.

WEP Encryption Type Constants

WCM_WEPMODE_NONE Encryption type when not using WEP encryption.
WCM_WEPMODE_40 Encryption type when using 40 bit (5 byte) WEP encryption.
WCM_WEPMODE_104 Encryption type when using 104 bit (13 byte) WEP encryption.
WCM_WEPMODE_128 Encryption type when using 128 bit (16 byte) WEP encryption.

Optional Filter Constants for Searching

WCM_BSSID_ANY Constant that indicates search is for any BSS-ID. Entity is a pointer to a 6-byte data string filled with 0xff.
WCM_ESSID_ANY Constant that indicates search is for any ESS-ID. Entity is a pointer to a 32-byte data string filled with 0xff.

Revision History

07/22/2005 Initial version.