/*
 *  TOPPERS ATK2
 *      Toyohashi Open Platform for Embedded Real-Time Systems
 *      Automotive Kernel Version 2
 *
 *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
 *                              Toyohashi Univ. of Technology, JAPAN
 *  Copyright (C) 2004-2015 by Center for Embedded Computing Systems
 *              Graduate School of Information Science, Nagoya Univ., JAPAN
 *  Copyright (C) 2011-2015 by FUJI SOFT INCORPORATED, JAPAN
 *  Copyright (C) 2011-2013 by Spansion LLC, USA
 *  Copyright (C) 2011-2015 by NEC Communication Systems, Ltd., JAPAN
 *  Copyright (C) 2011-2015 by Panasonic Advanced Technology Development Co., Ltd., JAPAN
 *  Copyright (C) 2011-2014 by Renesas Electronics Corporation, JAPAN
 *  Copyright (C) 2011-2015 by Sunny Giken Inc., JAPAN
 *  Copyright (C) 2011-2015 by TOSHIBA CORPORATION, JAPAN
 *  Copyright (C) 2004-2015 by Witz Corporation
 *  Copyright (C) 2014-2015 by AISIN COMCRUISE Co., Ltd., JAPAN
 *  Copyright (C) 2014-2015 by eSOL Co.,Ltd., JAPAN
 *  Copyright (C) 2014-2015 by SCSK Corporation, JAPAN
 *  Copyright (C) 2015 by SUZUKI MOTOR CORPORATION
 *
 *  上記著作権者は，以下の(1)〜(4)の条件を満たす場合に限り，本ソフトウェ
 *  ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
 *  変・再配布（以下，利用と呼ぶ）することを無償で許諾する．
 *  (1) 本ソフトウェアをソースコードの形で利用する場合には，上記の著作
 *      権表示，この利用条件および下記の無保証規定が，そのままの形でソー
 *      スコード中に含まれていること．
 *  (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
 *      用できる形で再配布する場合には，再配布に伴うドキュメント（利用
 *      者マニュアルなど）に，上記の著作権表示，この利用条件および下記
 *      の無保証規定を掲載すること．
 *  (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
 *      用できない形で再配布する場合には，次のいずれかの条件を満たすこ
 *      と．
 *    (a) 再配布に伴うドキュメント（利用者マニュアルなど）に，上記の著
 *        作権表示，この利用条件および下記の無保証規定を掲載すること．
 *    (b) 再配布の形態を，別に定める方法によって，TOPPERSプロジェクトに
 *        報告すること．
 *  (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
 *      害からも，上記著作権者およびTOPPERSプロジェクトを免責すること．
 *      また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
 *      由に基づく請求からも，上記著作権者およびTOPPERSプロジェクトを
 *      免責すること．
 *
 *  本ソフトウェアは，AUTOSAR（AUTomotive Open System ARchitecture）仕
 *  様に基づいている．上記の許諾は，AUTOSARの知的財産権を許諾するもので
 *  はない．AUTOSARは，AUTOSAR仕様に基づいたソフトウェアを商用目的で利
 *  用する者に対して，AUTOSARパートナーになることを求めている．
 *
 *  本ソフトウェアは，無保証で提供されているものである．上記著作権者お
 *  よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
 *  に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
 *  アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
 *  の責任を負わない．
 *
 *  $Id: alarm.h 425 2015-12-07 08:06:19Z witz-itoyo $
 */

/*
 *		アラーム機能
 */

#ifndef TOPPERS_ALARM_H
#define TOPPERS_ALARM_H

#include "counter.h"

/*
 *  アラームIDからアラーム管理ブロックを取り出すためのマクロ
 */
#define get_almcb(almid)	(&(almcb_table[(almid)]))

/*
 *  アラーム初期化ブロック
 */
typedef struct alarm_initialization_block {
	CNTCB			*p_cntcb;       /* 駆動カウンタ管理ブロックのポインタ */
	FunctionRefType	action;         /* アラーム満了アクション */
	AppModeType		autosta;        /* 起動するモード */
	TickType		almval;         /* expire するティック値 */
	TickType		cycle;          /* アラームの周期 */
	AttributeType	actatr;         /* 満了アクション・自動起動の属性 */
	OSAPCB			*p_osapcb;      /* 所属するOSアプリケーションの管理ブロック */
	uint32			acsbtmp;        /* アクセス許可OSアプリケーション ビットマップ */
} ALMINIB;

/*
 *  アラーム管理ブロック
 */
typedef struct alarm_control_block {
	CNTEXPINFO		cntexpinfo;     /* カウンタ満了情報(構造体の先頭に入る必要) */
	const ALMINIB	*p_alminib;     /* アラーム初期化ブロックポインタ */
	TickType		cycle;          /* アラームの周期 */
} ALMCB;

/*
 *  アラーム数を保持する変数の宣言（Os_Lcfg.c）
 */
extern const AlarmType	tnum_alarm;       /* アラームの数 */

/*
 *  アラーム初期化ブロックのエリア（Os_Lcfg.c）
 */
extern const ALMINIB	alminib_table[];

/*
 *  アラーム管理ブロックのエリア（Os_Lcfg.c）
 */
extern ALMCB			almcb_table[];

/*
 *  アラーム機能の初期化
 */
extern void alarm_initialize(void);

/*
 *  アラーム満了アクション処理用関数
 */
extern void alarm_expire(CNTEXPINFO *p_cntexpinfo, const CNTCB *p_cntcb);

/*
 *  OSAP所属するアラームの強制終了
 */
extern void force_term_osap_alarm(OSAPCB *p_osapcb);

#endif /* TOPPERS_ALARM_H */