WCM_Init, WCM_InitEx

構文


#include <nitroWiFi/wcm.h>

s32   WCM_Init( void* buf , s32 len );
s32   WCM_InitEx( void* buf, s32 len, u8 deviceId );
				

説明

WCM ライブラリを初期化する同期関数です。WCM ライブラリに含まれる他の API を呼び出す前に一回呼び出して下さい。

初期化処理に成功した場合、WCM ライブラリの内部状態は WCM_PHASE_WAIT になり、オプション設定等は全てデフォルトの設定値に初期化されます。
また、キープアライブ機能を実現するために、OS ライブラリの Tick 機能、Alarm 機能が有効になっていない場合には OS_InitTick()OS_InitAlarm() を自動的に実行しこれらの機能を有効にします。

引数

buf WCM ライブラリが内部的に使用するワークバッファへのポインタを指定します。このワークバッファは 32 バイトアラインされていなければなりません。 初期化が正常に完了した後は、WCM_Finish()を用いて WCM ライブラリを終了するまで与えたバッファを別の用途に用いてはいけません。
len buf で指定するワークバッファのサイズを指定します。WCM_WORK_SIZE 以上のサイズを指定する必要があります。
deviceId 使用する無線ハードウェアの ID を指定します。WCM_Init()を使用した場合は、deviceIdWCM_DEVICEID_WM を指定した場合と同じ動作になります。

返り値

以下のいずれかの処理結果を返します。

WCM_RESULT_SUCCESS 初期化処理が正常に完了したことを示します。
WCM_RESULT_FAILURE WCM ライブラリが既に初期化されている、与えられたパラメータが不正である、などの原因で初期化に失敗したことを示します。
WCM_RESULT_NOT_ENOUGH_MEM 与えられたワークバッファのサイズが WCM_WORK_SIZE 未満であり、WCM ライブラリを動作させるにはメモリが不足していることを示します。

参照

WCM_Finish, WCM_StartupAsync

履歴

2008/01/17 WCM_InitEx の説明を追加
2005/09/02 OSアラーム機能を使用することを追記
2005/07/22 初版