Doxygenコメントを追加した。

[uzume/uzume_bfin.git] / uzume_prototype / kernel / uzume / i2s_subsystem.c

diff --git a/uzume_prototype/kernel/uzume/i2s_subsystem.c b/uzume_prototype/kernel/uzume/i2s_subsystem.c
index a5951e1..eb87f1f 100644 (file)
--- a/uzume_prototype/kernel/uzume/i2s_subsystem.c
+++ b/uzume_prototype/kernel/uzume/i2s_subsystem.c
@@ -1,6 +1,6 @@
 
 /**
- * @file uzume.c
+ * @file i2s_subsystem.c
  * @brief CODECの初期化と制御
  */
 #include "i2s_subsystem.h"
@@ -17,8 +17,8 @@
 /**
  * @brief DMAデスクリプタ型
  * 
- * ADSP-BF533のDMA用デスクリプタ型。 avairablebufメンバーはDMAが使わないフィールドで、
- * これは@ref task_CODEC()が利用できるバッファを特定するためのIDとして使う。
+ * ADSP-BF533のDMA用デスクリプタ型。 avairablebuf メンバーはDMAが使わないフィールドで、
+ * これは task_audiocodec() が利用できるバッファを特定するためのIDとして使う。
  */
 struct DMA_DESCRIPTOR{
        struct DMA_DESCRIPTOR * next;   ///< 次のデスクリプタへのポインタ
@@ -29,7 +29,7 @@ struct DMA_DESCRIPTOR{
        /**
         * @brief バッファ特定用フィールド
         * 
-        * 初期化時に定数を設定しておく。@ref task_CODEC()はDMAが使用中のデスクリプタの
+        * 初期化時に定数を設定しておく。@ref task_audiocodec() はDMAが使用中のデスクリプタの
         * このフィールドを読み、有効なバッファにアクセスするためのインデックスとして使う。
         */
        short avairableBuf;     
@@ -70,7 +70,7 @@ static struct DMA_DESCRIPTOR rxDesc[3];
  * @brief 左入力データ引渡し変数
  * 
  * 
- * @ref codec_callback()関数に入力オーディオデータを渡すための引数。
+ * @ref codec_callback() 関数に入力オーディオデータを渡すための引数。
  * 左右チャンネルそれぞれに配列を与える。配列内部にはサンプル順にデータが並ぶ。
  * ステレオは2系統あるので左チャンネルも２系統分のデータがある。
  */
@@ -79,7 +79,7 @@ static AUDIOSAMPLE leftIn[UZUME_BLOCKSIZE];
  * @brief 右入力データ引渡し変数
  * 
  * 
- * @ref codec_callback()関数に入力オーディオデータを渡すための引数。
+ * @ref codec_callback() 関数に入力オーディオデータを渡すための引数。
  * 左右チャンネルそれぞれに配列を与える。配列内部にはサンプル順にデータが並ぶ。
  * ステレオは2系統あるので右チャンネルも２系統分のデータがある。
  */
@@ -88,7 +88,7 @@ static AUDIOSAMPLE rightIn[UZUME_BLOCKSIZE];
  * @brief 左出力データ引渡し変数
  * 
  * 
- * @ref codec_callback()関数から出力オーディオデータをうけとるための引数。
+ * @ref codec_callback() 関数から出力オーディオデータをうけとるための引数。
  * 左右チャンネルそれぞれに配列を与える。配列内部にはサンプル順にデータが並ぶ。
  */
 static AUDIOSAMPLE leftOut[UZUME_BLOCKSIZE];
@@ -96,7 +96,7 @@ static AUDIOSAMPLE leftOut[UZUME_BLOCKSIZE];
  * @brief 右出力データ引渡し変数
  * 
  * 
- * @ref codec_callback()関数から出力オーディオデータをうけとるための引数。
+ * @ref codec_callback() 関数から出力オーディオデータをうけとるための引数。
  * 左右チャンネルそれぞれに配列を与える。配列内部にはサンプル順にデータが並ぶ。
  */
 static AUDIOSAMPLE rightOut[UZUME_BLOCKSIZE];
@@ -147,7 +147,7 @@ static void setup_sport0(void)
  * CODEC用のオーディオDMAを設定する。DMAはデスクリプタのリンクからなる。トリプルバッファを
  * 使うため、デスクリプタは送受それぞれに3つ用意する。
  * 
- * デスクリプタ変数のavairableBufフィールドはDMAハードウェア用ではなく、管理ソフトウェア
+ * デスクリプタ変数 のavairableBuf フィールドはDMAハードウェア用ではなく、管理ソフトウェア
  *　用である。DMAエンジンが次にフェッチするDMAデスクリプタのアドレスは、DMA_NEXT_PTRレジスタ
  * からしることができる。そこで、DMA_NEXT_PTRレジスタが示すデスクリプタのavairableBuf
  * メンバーを読めば、CPUが「現在」データを読み書きしてもよいバッファのインデックスがわかるよう
@@ -262,7 +262,7 @@ static void stop_audio(void)
  * できるようにしている。
  * 
  * 割り込み待ちのループ内部ではsport0_semを使ってSPORT RX割り込みハンドらである
- * @ref inh_codec_sport()からの割り込み通知を待つ。通知を受けたらCODECの構造に依存した
+ * @ref inh_codec_sport() からの割り込み通知を待つ。通知を受けたらCODECの構造に依存した
  * バッファを解いてフラットな入力配列をL/R両方に用意する。これは @ref codec_callback()に
  * 渡すためのものである。
  *