source: asp3_wo_tecs/trunk/extension/drift/kernel/time_event.h@ 302

/*
 *  TOPPERS/ASP Kernel
 *      Toyohashi Open Platform for Embedded Real-Time Systems/
 *      Advanced Standard Profile Kernel
 * 
 *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
 *                              Toyohashi Univ. of Technology, JAPAN
 *  Copyright (C) 2005-2015 by Embedded and Real-Time Systems Laboratory
 *              Graduate School of Information Science, Nagoya Univ., JAPAN
 * 
 *  上記著作権者
は，以下の(1)〜(4)ã®æ¡ä»¶ã‚’æº€ãŸã™å ´åˆã«é™ã‚Šï¼Œæœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§
 *  ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
 *  変・再é…
å¸ƒï¼ˆä»¥ä¸‹ï¼Œåˆ©ç”¨ã¨å‘¼ã¶ï¼‰ã™ã‚‹ã“とを無償で許諾する．
 *  (1) æœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚’ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã®å½¢ã§åˆ©ç”¨ã™ã‚‹å ´åˆã«ã¯ï¼Œä¸Šè¨˜ã®è‘—ä½œ
 *      権表示，この利用条件および下記の無保証規定が，そのままの形でソー
 *      スコード中に含まれていること．
 *  (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
 *      用できる形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œå†é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨
 *      者
マニュアルなど）に，上記の著作権表示，この利用条件および下記
 *      の無保証規定を掲載すること．
 *  (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
 *      用できない形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œæ¬¡ã®ã„ずれかの条件を満たすこ
 *      と．
 *    (a) 再é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨è€…
マニュアルなど）に，上記の著
 *        作権表示，この利用条件および下記の無保証規定を掲載すること．
 *    (b) 再é…
å¸ƒã®å½¢æ…
‹ã‚’，別に定める方法によって，TOPPERSプロジェクトに
 *        å ±å‘Šã™ã‚‹ã“ã¨ï¼Ž
 *  (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
 *      害からも，上記著作権者
およびTOPPERSプロジェクトをå…
è²¬ã™ã‚‹ã“と．
 *      また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
 *      由に基づく請求からも，上記著作権者
およびTOPPERSプロジェクトを
 *      å…
è²¬ã™ã‚‹ã“と．
 * 
 *  本ソフトウェアは，無保証で提供されているものである．上記著作権者
お
 *  よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
 *  に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
 *  アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
 *  ã®è²¬ä»»ã‚’è² ã‚ãªã„ï¼Ž
 * 
 *  $Id: time_event.h 451 2015-08-14 15:29:07Z ertl-hiro $
 */

/*
 *              タイムイベント管理モジュール
 */

#ifndef TOPPERS_TIME_EVENT_H
#define TOPPERS_TIME_EVENT_H

#include "kernel_impl.h"
#include "target_timer.h"

/*
 *  イベント時刻のデータ型の定義［ASPD1001］
 *
 *  タイムイベントヒープに登録するタイムイベントの発生時刻を表現するた
 *  めのデータ型．オーバヘッド低減のために，32ビットで扱う．
 */
typedef uint32_t        EVTTIM;

/*
 *  タイムイベントヒープ中のノードのデータ型の前方参ç…
§
 */
typedef union time_event_node TMEVTN;

/* 
 *  タイムイベントブロックのデータ型の定義
 */
typedef void    (*CBACK)(void *);       /* コールバック関数の型 */

typedef struct time_event_block {
        EVTTIM  evttim;                 /* タイムイベントの発生時刻 */
        TMEVTN  *p_tmevtn;              /* タイムイベントヒープ中での位置 */
        CBACK   callback;               /* コールバック関数 */
        void    *arg;                   /* コールバック関数へ渡す引数 */
} TMEVTB;

/*
 *  タイムイベントヒープ中のノードのデータ型の定義
 *
 *  タイムイベントヒープのå…
ˆé ­ã®ãƒŽãƒ¼ãƒ‰ï¼ˆtmevt_heap[0]ï¼‰ã«ï¼Œæœ€å¾Œã®ä½¿ç”¨é ˜
 *  域を指すポインタ（p_lastï¼‰ã‚’æ ¼ç´ã—ï¼Œãã‚Œä»¥é™ã‚’ã‚¿ã‚¤ãƒ ã‚¤ãƒ™ãƒ³ãƒˆãƒ’ãƒ¼ãƒ—
 *  として使用する．(tmevt_heap[0].p_last - tmevt_heap) が，タイムイベ
 *  ントヒープに登録されているタイムイベントの数となる．
 */
union time_event_node {
        TMEVTB  *p_tmevtb;              /* 対応するタイムイベントブロック */
        TMEVTN  *p_last;                /* ã‚¿ã‚¤ãƒ ã‚¤ãƒ™ãƒ³ãƒˆãƒ’ãƒ¼ãƒ—ã®æœ€å¾Œã®ä½¿ç”¨é ˜åŸŸ */
};

/*
 *  タイムイベントヒープ（kernel_cfg.c）
 */
extern TMEVTN   tmevt_heap[];

/*
 *  境界イベント時刻［ASPD1008］
 */
extern EVTTIM   boundary_evttim;

/*
 *  現在のイベント時刻と境界イベント時刻の差［ASPD1010］
 */
#define BOUNDARY_MARGIN         (200000000U)

/*
 *  最後に現在時刻を算出した時点でのイベント時刻［ASPD1012］
 */
extern EVTTIM   current_evttim;                 /* 現在のイベント時刻 */
extern uint32_t current_evttim_frac;    /* 現在のイベント時刻の端数 */

/*
 *  最後に現在時刻を算出した時点での高分解能タイマのカウント値［ASPD1012］
 */
extern HRTCNT   current_hrtcnt;

/*
 *  最も進んでいた時のイベント時刻［ASPD1041］
 */
extern EVTTIM   monotonic_evttim;

/*
 *  ドリフト率
 */
extern uint32_t drift_rate;

/*
 *  イベント時間を遅
い方に丸めるための補正値
 */
extern EVTTIM   evttim_step;
extern uint32_t evttim_step_frac;

/*
 *  システム時刻のオフセット［ASPD1043］
 *
 *  get_timで参ç…
§ã™ã‚‹ã‚·ã‚¹ãƒ†ãƒ 時刻とmonotonic_evttimの差を保持する．
 */
extern SYSTIM   systim_offset;

/*
 *  高分解能タイマ割込みの処理中であることを示すフラグ［ASPD1032］
 */
extern bool_t   in_signal_time;

/*
 *  タイムイベント管理モジュールの初期化
 */
extern void     initialize_tmevt(void);

/*
 *  タイムイベントの挿å…
¥ä½ç½®ã®æŽ¢ç´¢
 */
extern TMEVTN   *tmevt_up(TMEVTN *p_tmevtn, EVTTIM evttim);
extern TMEVTN   *tmevt_down(TMEVTN *p_tmevtn, EVTTIM evttim);

/*
 *  現在のイベント時刻の更新
 *
 *  current_evttimとcurrent_hrtcntを，現在の値に更新する．
 */
extern void             update_current_evttim(void);

/*
 *  高分解能タイマ割込みの発生タイミングの設定
 *
 *  現在のイベント時刻を取得した後に呼び出すことを想定している．
 */
extern void             set_hrt_event(void);

/*
 *  タイムイベントの登録
 *
 *  p_tmevtbで指定したタイムイベントブロックを登録する．タイムイベント
 *  の発生時刻，コールバック関数，コールバック関数へ渡す引数は，
 *  p_tmevtbが指すタイムイベントブロック中に設定しておく．
 */
extern void             tmevtb_register(TMEVTB *p_tmevtb);

/*
 *  相対時間指定によるタイムイベントの登録
 *
 *  timeで指定した相対時間が経過した後にコールバック関数が呼び出される
 *  ように，p_tmevtbで指定したタイムイベントブロックを登録する．コール
 *  バック関数，コールバック関数へ渡す引数は，p_tmevtbが指すタイムイベ
 *  ントブロック中に設定しておく．
 */
extern void             tmevtb_enqueue(TMEVTB *p_tmevtb, RELTIM time);

/*
 *  タイムイベントの登録解除
 */
extern void             tmevtb_dequeue(TMEVTB *p_tmevtb);

/*
 *  システム時刻の調整時のエラーチェック
 *
 *  adjtimで指定された時間の分，システム時刻を調整してよいか判定する．
 *  èª¿æ•´ã—ã¦ã¯ãªã‚‰ãªã„å ´åˆã«trueï¼Œãã†ã§ãªã„å ´åˆã«falseを返す．現在のイ
 *  ベント時刻を取得した後に呼び出すことを想定している．
 */
extern bool_t   check_adjtim(int_t adjtim);

/*
 *  タイムイベントが発生するまでの時間の計算
 */
extern RELTIM   tmevt_lefttim(TMEVTB *p_tmevtb);

/*
 *  高分解能タイマ割込みの処理
 */
extern void     signal_time(void);

#endif /* TOPPERS_TIME_EVENT_H */