#ifndef _MACRO_ONLY
+
+ // Following mode macro can be used only the demodulator
+
+ /** \brief 受信機はワイドFMモードである */
+#define radio_mode_WFM 2
+ /** \brief 受信機はナローFMモードである */
+#define radio_mode_NFM 4
+ /** \brief 受信機は振幅変調モードである */
+#define radio_mode_AM 5
+ /** \brief 受信機は振幅変調モードの同期復調モードである */
+#define radio_mode_SAM 6
+ /** \brief 受信機はLSB復調モードである */
+#define radio_mode_LSB 7
+ /** \brief 受信機はUSB復調モードである */
+#define radio_mode_USB 8
+ /** \brief 受信機はCW復調モードである */
+#define radio_mode_CW 9
+
+
/**
* \defgroup radioAPI ラジオAPI
- * \brief 復調器がTRX-305の制御部と情報の授受を行うためのAPI群
+ * \brief 復調器がSHマイコン/FPGAと情報の授受を行うためのAPI群
* \details
* このモジュールに含まれるAPIは、復調器の中でユーザー復調アルゴリズムが使うために
* 公開されている。制御情報取得用APIはTRX-305からの制御情報を受け取るためのものである。
/**
* \defgroup getInfo 制御情報取得API
- * \brief 復調器がTRX-305から受け取る制御情報取得用のAPI
+ * \brief 復調器がSHマイコン/FPGAから受け取る制御情報取得用のAPI
* \details
* ここに列挙されるAPIは、いずれも復調器内のユーザーアルゴリズムから自由に使ってよい。
*
*/
/*@{*/
- // Following mode macro can be used only the demodulator
-
- /** \brief 受信機はワイドFMモードである */
-#define radio_mode_WFM 2
- /** \brief 受信機はナローFMモードである */
-#define radio_mode_NFM 4
- /** \brief 受信機は振幅変調モードである */
-#define radio_mode_AM 5
- /** \brief 受信機は振幅変調モードの同期復調モードである */
-#define radio_mode_SAM 6
- /** \brief 受信機はLSB復調モードである */
-#define radio_mode_LSB 7
- /** \brief 受信機はUSB復調モードである */
-#define radio_mode_USB 8
- /** \brief 受信機はCW復調モードである */
-#define radio_mode_CW 9
// These APIs are published for the demodulator programmer
/**
/**
* \defgroup setStat 状態報告API
+ * \brief DSPがFPGA/SHマイコンに情報を送るためのAPI群
*/
/*@{*/
-// Set S meter
+/**
+ * \def radio_api_set_S_meter
+ * \brief Sメータ値のセット
+ * \details
+ * このAPIはDSPからFPGA/SHマイコンに渡すSメータ値を設定する。値の範囲は
+ * 15bit符号なし整数である。APIは受け取った値をそのままFPGAに送信する。
+ */
#define radio_api_set_S_meter(s) radio.smeter = s
+ /**
+ * \def radio_api_set_stereo
+ * \brief FMステレオ受信状態の報告
+ * \details
+ * FM復調がモノラルかステレオを報告する。引数は以下のように与える
+ * \li 0 : モノラル
+ * \li 非1 : ステレオ
+ */
+#define radio_api_set_stereo(s) s ? radio.flags |= (1<<1) : radio.flags &= ~(1<<1)
+
+ /**
+ * \def radio_api_set_voice_squelch
+ * \brief ボイススケルチ状態の報告
+ * \details
+ * 復調器がボイススケルチを持っている場合、その状態を報告する。
+ * \li 0 : ボイススケルチは開いていない
+ * \li 1 : ボイススケルチは開いている
+ */
+#define radio_api_set_voice_squelch(s) s ? radio.flags |= (1<<2) : radio.flags &= ~(1<<2)
+
+/**
+ * \def radio_api_set_noise_squelch
+ * \brief ノイズスケルチ状態の報告
+ * \details
+ * 復調器がノイズスケルチを持っている場合、その状態を報告する。
+ * \li 0 : ノイズスケルチは開いていない
+ * \li 1 : ノイズスケルチは開いている
+ */
+#define radio_api_set_noise_squelch(s) s ? radio.flags |= (1<<3) : radio.flags &= ~(1<<3)
+
+
/*@}*/
/* end of defgroup setStat */
/**
* \defgroup callbacks 復調用コールバック関数
+ * \brief フレームワークが復調ように呼び出すコールバック関数群
* \details
* 復調器のためにフレームワークから呼び出すコールバック関数。復調アルゴリズムは全てこの中に記述する。
*
* 関数は大きく分けて2種類に分けられる。ひとつは初期化関数で \ref init_demodulator() がこれである。
* その他の関数は実際の復調を行う関数である。
*/
- */
+
/*@{*/
-/**
- * \brief 復調アルゴリズム初期化関数
- * \detail
- */
/**
* \brief 復調器の初期化
OSDN Git Service
