\e$B%A%1%C%H\e(B #30712 Doxygen\e$B$N\e(BJavaDoc\e$B%9%?%$%k:NMQ\e(B

[uzume/uzume_bfin.git] / uzumeapp / kernel / uzume / bsp_bluetank.h

diff --git a/uzumeapp/kernel/uzume/bsp_bluetank.h b/uzumeapp/kernel/uzume/bsp_bluetank.h
index 2ade94a..414e578 100644 (file)
--- a/uzumeapp/kernel/uzume/bsp_bluetank.h
+++ b/uzumeapp/kernel/uzume/bsp_bluetank.h
@@ -33,9 +33,19 @@
 #define BSP_BLUETANK_H
 
 /**
- * \brief ボード・イニシャライザ
- * \param exinf 0を渡す。関数からは無視される。
- * \details
+ * \breif ボリューム入力のチャンネル数
+ * @details
+ * BSPが持つボリュームのチャンネル数。ここでいうボリュームはポテンショメータに限らない。
+ * ロータリーエンコーダーなども含む。また、システムが複数種のボリューム（例えばADCと
+ * ロータリーエンコーダー）を持つ場合には、それらのチャンネル数の総和である。
+ */
+
+#define UZUME_NUM_VOLUME 4
+
+/**
+ * @brief ボード・イニシャライザ
+ * @param exinf 0を渡す。関数からは無視される。
+ * @details
  * BSP用のイニシャライザである。アプリケーションに依存せず、uzumeが
  * 必要とする初期化処理をおここで行う。具体的にはI2S用のピンの割付を行う
  */