Nios® V プロセッサー・ソフトウェア開発者ハンドブック

ID 743810
日付 7/08/2024
Public
ドキュメント目次

16.1.1.9. alt_alarm_start()

プロトタイプ

int alt_alarm_start

( alt_alarm* alarm,

alt_u32 nticks,

alt_u32 (*callback) (void* context),

void* context)

一般的な呼び出し元

C/C++ プログラム

デバイスドライバー

スレッドセーフ

はい

ISRから利用可能

はい

インクルード

<sys/alt_alarm.h>

説明

alt_alarm_start() 関数は、アラーム・ コールバックをスケジュールします。

HAL は、callback() 関数を呼び出す前に、nticks システム・クロック・ティックだけを待ちます。HAL が callback() を呼び出す際、それに入力引数 context が渡されます。 HAL は context パラメーターを使用せず、パラメーターとして callback() 関数に渡します。

alarm 引数は、このアラームを表す構造体へのポインターです。この構造体を作成する必要があり、その寿命はアラームの寿命と少なくとも同じくらい長くなければなりません。ただし、alarm によって指される構造体の内容を初期化する責任はありません。 このアクションは、alt_alarm_start()の呼び出しによって実行されます。

alt_alarm_start() への呼び出しごとに 1 つのアラームが作成されます。複数のアラームを同時に実行できます。

戻り値

aalt_alarm_start() の戻り値は、成功した場合は 0、それ以外の場合は負です。 利用可能なシステムクロックがない場合、この関数は失敗します。