WCM ライブラリ定数

定義


#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_PRIVACYMODE_NONE           0
#define   WCM_PRIVACYMODE_40             1
#define   WCM_PRIVACYMODE_104            2
#define   WCM_PRIVACYMODE_128            3
#define   WCM_PRIVACYMODE_WPA_TKIP       4
#define   WCM_PRIVACYMODE_WPA2_TKIP      5
#define   WCM_PRIVACYMODE_WPA_AES        6
#define   WCM_PRIVACYMODE_WPA2_AES       7

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

処理結果定数

WCM_RESULT_SUCCESS 同期的な処理結果、非同期的な処理結果の両方に返されうる結果であり、処理に成功したことを示します。
WCM_RESULT_FAILURE 同期的な処理結果、非同期的な処理結果の両方に返されうる結果であり、なんらかの理由で処理に失敗したことを示します。
関数呼び出し時の引数が不正であった場合や、不正な内部状態での非同期関数呼び出し、内部状態を変更する非同期処理が失敗してかつリトライできない場合などに この結果が得られます。
WCM_RESULT_PROGRESS 同期的な処理結果にのみ返されうる結果であり、要求した処理とまったく同じ要求を受け付けて実行中であることを示します。
WCM_RESULT_ACCEPT 同期的な処理結果にのみ返されうる結果であり、非同期的な処理の開始要求が正常に受け付けられたことを示します。
非同期処理終了次第、対応する非同期処理通知が必ず一回発生します。
WCM_RESULT_REJECT 同期的な処理結果にのみ返されうる結果であり、非同期的な処理の開始要求が受け付け拒否されたことを示します。
ARM7 への PXI 処理要求への発行に失敗したことが原因ですので、少し待ってからリトライを試みることができます。
WCM_RESULT_WMDISABLE WCM_StartupAsync()の同期的な処理結果としてのみ返されうる結果であり、ARM7 側で無線ドライバが動作していないことを示します。
ARM7 コンポーネントが ichneumon である場合は、WVR ライブラリによって無線ドライバが強制停止されている可能性があります。
WCM_RESULT_NOT_ENOUGH_MEM WCM_Init()にのみ返されうる結果であり、ワークバッファサイズが不十分であったことを示します。
WCM_RESULT_FATAL_ERROR 同期的な処理結果、非同期的な処理結果の両方に返されうる結果であり、ライブラリ内部で復旧不可能なエラーが発生したことを示します。
このエラーはライブラリ内部で想定されない現象が発生したことを示すものであり、例えば内部ワークメモリが破壊された場合や、 外部から WM ライブラリや WVR ライブラリを直接使用することにより WCM ライブラリの内部状態管理が破綻した場合などに発生します。
本来発生してはいけないエラーですが、万一発生してしまった場合には復旧不可能ですので、エンドユーザーに電源断を促す画面表示をするか 電源が入っている間は無線通信を行うことを諦める必要があります。

無線ハードウェア指定定数

WCM_DEVICEID_DEFAULT 動作しているハードウェア上で TWL 無線が使用できる場合は TWL 無線を使用し、使用できない場合は NITRO 無線を使用します。NITRO ビルドでは常に NITRO 無線を使用します。
WCM_DEVICEID_WM NITRO 無線を使用します。
WCM_DEVICEID_NWM TWL 無線を使用します。動作しているハードウェア上で TWL 無線が利用できない場合はエラーになります。

内部状態定数

WCM_PHASE_NULL WCM_Init()によって WCM ライブラリが初期化される前、 もしくは WCM_Finish()によって WCM ライブラリが終了された後の状態です。
WCM_PHASE_WAIT WCM_Init()によって初期化された直後、もしくは WCM_CleanupAsync()WCM_TerminateAsync()によって無線機能が停止された後の状態です。
WCM_PHASE_WAIT_TO_IDLE WCM_StartupAsync()によって無線機能の起動中である状態です。
WCM_PHASE_IDLE 無線機能が起動されており、無線アクセスポイントを探索したり無線アクセスポイントに接続したりする処理待ちの状態です。
WCM_PHASE_IDLE_TO_WAIT WCM_CleanupAsync()によって無線機能の停止中である状態です。
WCM_PHASE_IDLE_TO_SEARCH WCM_BeginSearchAsync()によって無線アクセスポイントの自動探索を開始中である状態です。
WCM_PHASE_SEARCH 無線アクセスポイントの自動探索を実行中である状態です。
WCM_PHASE_SEARCH_TO_IDLE WCM_EndSearchAsync()によって無線アクセスポイントの自動探索を停止中である状態です。
WCM_PHASE_IDLE_TO_DCF WCM_ConnectAsync()によって無線アクセスポイントへの接続処理中である状態です。
WCM_PHASE_DCF 無線アクセスポイントへ接続された状態であり、DCF 通信可能な状態です。
WCM_PHASE_DCF_TO_IDLE WCM_DisconnectAsync()によって無線アクセスポイントとの接続を切断中である状態です。
WCM_PHASE_FATAL_ERROR WCM ライブラリ内部で想定外の現象が発生したことを示す状態です。一旦この状態になると以後状態は変更されません。
WCM_PHASE_IRREGULAR WCM ライブラリ内部で行われる非同期処理の途中でなんらかのエラーが発生し、非同期処理を継続することができなくなった状態です。
この状態からは WCM_TerminateAsync()によってのみ復旧を試みることができます。
WCM_PHASE_TERMINATING WCM_TerminateAsync()によって WCM ライブラリの強制停止中である状態です。

通知種別定数

WCM_NOTIFY_COMMON デフォルトの通知種別です。デバッグ用途に用意されており、この種別で通知が行われた場合はメモリ破壊等の想定外の現象が発生しています。
WCM_NOTIFY_STARTUP WCM_StartupAsync()により開始した非同期処理の結果通知時の通知種別です。
WCM_NOTIFY_CLEANUP WCM_CleanupAsync()により開始した非同期処理の結果通知時の通知種別です。
WCM_NOTIFY_BEGIN_SEARCH WCM_BeginSearchAsync()により開始した非同期処理の結果通知時の通知種別です。
WCM_NOTIFY_END_SEARCH WCM_EndSearchAsync()により開始した非同期処理の結果通知時の通知種別です。
WCM_NOTIFY_CONNECT WCM_ConnectAsync()により開始した非同期処理の結果通知時の通知種別です。
WCM_NOTIFY_DISCONNECT WCM_DisconnectAsync()により開始した非同期処理の結果通知時の通知種別であり、 無線アクセスポイントに接続された状態での途中経過通知 ( 被切断通知 ) 時の通知種別でもあります。
WCM_NOTIFY_FOUND_AP 無線アクセスポイントの自動探索における途中経過通知時の通知種別です。
WCM_NOTIFY_SEARCH_AROUND 無線アクセスポイントの自動探索における巡回探索が一巡したことを示す通知時の通知種別です。
WCM_NOTIFY_TERMINAME WCM_TerminateAsync()により開始した非同期処理の結果通知時の通知種別です。

WEP 暗号化種別定数

WCM_PRIVACYMODE_NONE WEP 暗号化を行わない場合の暗号化種別です。
WCM_PRIVACYMODE_40 40 ビット ( 5 バイト ) WEP 暗号化を行う場合の暗号化種別です。
WCM_PRIVACYMODE_104 104 ビット ( 13 バイト ) WEP 暗号化を行う場合の暗号化種別です。
WCM_PRIVACYMODE_128 128 ビット ( 16 バイト ) WEP 暗号化を行う場合の暗号化種別です。
WCM_PRIVACYMODE_WPA_TKIP WPA-PSK(TKIP) 暗号化を行う場合の暗号化種別です。 TWL 無線を使用する場合にのみ利用できます。
WCM_PRIVACYMODE_WPA2_TKIP WPA2-PSK(TKIP) 暗号化を行う場合の暗号化種別です。 TWL 無線を使用する場合にのみ利用できます。
WCM_PRIVACYMODE_WPA_AES WPA-PSK(AES) 暗号化を行う場合の暗号化種別です。 TWL 無線を使用する場合にのみ利用できます。
WCM_PRIVACYMODE_WPA2_AES WPA2-PSK(AES) 暗号化を行う場合の暗号化種別です。 TWL 無線を使用する場合にのみ利用できます。

探索時の任意フィルター定数

WCM_BSSID_ANY 任意の BSS-ID であることを示す定数です。実体は全て 0xff である 6 バイトのデータ列へのポインタです。
WCM_ESSID_ANY 任意の ESS-ID であることを示す定数です。実体は全て 0xff である 32 バイトのデータ列へのポインタです。

履歴

2008/01/17 無線デバイス指定用定数の追加
2005/07/22 初版