-/*
- * TOPPERS/JSP Kernel
- * Toyohashi Open Platform for Embedded Real-Time Systems/
- * Just Standard Profile Kernel
- *
- * Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
- * Toyohashi Univ. of Technology, JAPAN
- * Copyright (C) 2005 by Embedded and Real-Time Systems Laboratory
- * Graduate School of Information Science, Nagoya Univ., JAPAN
- *
- * 上記著作権者は,以下の (1)〜(4) の条件か,Free Software Foundation
- * によって公表されている GNU General Public License の Version 2 に記
- * 述されている条件を満たす場合に限り,本ソフトウェア(本ソフトウェア
- * を改変したものを含む.以下同じ)を使用・複製・改変・再配布(以下,
- * 利用と呼ぶ)することを無償で許諾する.
- * (1) 本ソフトウェアをソースコードの形で利用する場合には,上記の著作
- * 権表示,この利用条件および下記の無保証規定が,そのままの形でソー
- * スコード中に含まれていること.
- * (2) 本ソフトウェアを,ライブラリ形式など,他のソフトウェア開発に使
- * 用できる形で再配布する場合には,再配布に伴うドキュメント(利用
- * 者マニュアルなど)に,上記の著作権表示,この利用条件および下記
- * の無保証規定を掲載すること.
- * (3) 本ソフトウェアを,機器に組み込むなど,他のソフトウェア開発に使
- * 用できない形で再配布する場合には,次のいずれかの条件を満たすこ
- * と.
- * (a) 再配布に伴うドキュメント(利用者マニュアルなど)に,上記の著
- * 作権表示,この利用条件および下記の無保証規定を掲載すること.
- * (b) 再配布の形態を,別に定める方法によって,TOPPERSプロジェクトに
- * 報告すること.
- * (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
- * 害からも,上記著作権者およびTOPPERSプロジェクトを免責すること.
- *
- * 本ソフトウェアは,無保証で提供されているものである.上記著作権者お
- * よびTOPPERSプロジェクトは,本ソフトウェアに関して,その適用可能性も
- * 含めて,いかなる保証も行わない.また,本ソフトウェアの利用により直
- * 接的または間接的に生じたいかなる損害に関しても,その責任を負わない.
- *
- * @(#) $Id: sample1.h,v 1.3 2009/05/13 13:10:13 suikan Exp $
+/**
+ * \file framework.h
+ * \brief フレームワーク・インクルードファイル
+ * \details
+ * 原則としてこのファイルの中の宣言をユーザーが変更する必要はない。例外はデバッグマクロのコメントアウト制御である。
+ *
+ * このファイルの中には複数のデバッグマクロが用意されており、これらのコメントアウトを説いて宣言状態にすると、DSP UARTのシリアルポートから
+ * 内部状態を見ることができる。以下にマクロを列挙する。これらはフレームワークの開発中に使用したものをそのまま残している。
+ *
+ * ユーザーが使うとすれば、DEBUG_DSPLOADか、DEBUG_COMMANDだろう。
+ *
+ * \li DEBUG_QUEUEDEPTH シリアルポートから、タスク間Queueの深さを表示させる
+ * \li DEBUG_DSPLOAD シリアルポートからDSP負荷率を表示させる
+ * \li DEBUG_COMMAND DSPに送られてくるコマンドの表示
+ * \li DEBUG_COMMAND_API 復調器から使えるAPIのデバッグ用
+ * \li DEBUG_BLOCK_FLOAT WFMモードでブロック浮動小数点の整数化がうまく出来ているかダンプする。
+ *
*/
#ifndef _FRAMEWORK_H_
* 領域が必要である。
*
* なお、このソフトウェアは1サンプルあたり2[エントリ]をキューに格納するため、
- * キューの長さ[エントリ]は、割り込み周期[サンプル]の四倍になる。
+ * ã\81\93ã\82\8cã\82\92å\8b\98æ¡\88ã\81\99ã\82\8bã\81¨ã\80\81æ\9c\80ä½\8eã\81§ã\82\82ã\82ã\83¥ã\83¼ã\81®é\95·ã\81\95[ã\82¨ã\83³ã\83\88ã\83ª]ã\81¯ã\80\81å\89²ã\82\8aè¾¼ã\81¿å\91¨æ\9c\9f[ã\82µã\83³ã\83\97ã\83«]ã\81®å\9b\9bå\80\8dã\81«ã\81ªã\82\8bã\80\82
*
*
*/
*/
#ifndef _MACRO_ONLY
+/**
+ * \brief フレームワークがラジオとのやりとりに使う変数。
+ * \details
+ * フレームワークはFPGAから送られてきたデータをこの変数の中に格納する。復調アルゴリズムは \ref getInfo を通してこれらの値にアクセスする。
+ */
// ラジオアルゴリズムとのやりとりに使う変数
extern struct RADIO {