RTC_GetAlarmParamAsync

構文

#include <nitro/rtc.h>

RTCResult RTC_GetAlarmParamAsync(
            RTCAlarmChan        chan,
            RTCAlarmParam*     param,
            RTCCallback		callback,
            void*		arg );

引数

chan	アラームチャンネルをRTCAlarmChan列挙型で指定します。
param	アラーム設定値を受け取るRTCAlarmParam型のバッファへのポインタ
callback	コールバック関数へのポインタこのコールバックは割り込みハンドラ内から呼び出されます。
arg	コールバック関数へ渡す引数

返り値

要求が成功した場合に 0 を返します。
要求が失敗した場合には 0 以外を返します。

説明

リアルタイムクロックから非同期的にアラーム割り込み設定値を読み出します。
この関数はARM7にアラーム割り込み設定値読み出し要求を発行し、ARM7からの応答を待たずに呼び出し元に戻ります。
ARM7における処理結果はユーザコールバック関数に渡されるresult引数によって取得する必要があります。

この関数が失敗した場合は非同期的な操作は行われず、ユーザコールバック関数も呼び出されません。

注意

RTCアラーム割り込み許可状態が"許可"でない場合はリアルタイムクロックから設定値を読み出すことはできませんので、この関数は成功してもユーザコールバック関数には処理に失敗したという結果が渡されます。
また、param引数によって指定したバッファには関数とは非同期に値が書き込まれますので、ユーザコールバック関数によって非同期処理の完了を確認するまでは別の用途に使用しないようにして下さい。

参照

RTC_GetAlarmParam, RTC_SetAlarmParam, RTC_SetAlarmParamAsync, RTCResult, RTCAlarmChan, RTCAlarmParam, RTCCallback

履歴

2005/06/27 コールバックが割り込みハンドラから呼び出される旨を補足
2005/03/08 用語統一 [割込み] → [割り込み]
2004/05/18 初版