uzumeapp/kernel/uzume/bsp_bluetank.h

   1 /**
   2  * @file bsp_bluetank.h
   3  * @author takemasa
   4  * @brief BlueTank ACB-BF592ボード用のリソース
   5  * @details
   6  * ここにはBSP専用のリソースを置く。実際にはボードの初期化子を置く。
   7  */
   8
   9 /**
  10  * @mainpage
  11  * BlueTank ACB-BF592 ボードのBSP (Board Support Package)
  12  *
  13  * Uzumeを使う上のBSPは以下の構成になっている
  14  * @li uzume/bsp_bluetank.cfg アプリケーションから読み込むべき
  15  * 静的コンフィギュレーション・ファイル
  16  * @li config/blackfin/bsp_bluetank BSPのシステム依存部
  17  * @li uzume_callback.c ユーザー用オーディオコールバックと初期化部の実装
  18  * @li uzume_app.c ユーザーアプリケーションが使うタスク。
  19  * @li uzume_app.cfg アプリケーション
  20  *
  21  * BSPを使う場合には、次のようにする
  22  * @li システム依存部から適切なBSPを選び、configure_projectの中で使用する。
  23  * @li kernel/uzumeの中からBSPに合わせた.cfgファイルを選び、uzume_app.cfgから
  24  * インクルードする
  25  * @li configure_projectを実行する
  26  *
  27  * これでプロジェクトがmake可能になる。
  28  *
  29  * 信号処理のアルゴリズムは uzume_callback.c のなかの process_audio() に記述する。
  30  * また、信号処理の前に初期以下が必要であれば init_audio() に初期化コードを記述する。
  31  */
  32 #ifndef BSP_BLUETANK_H
  33 #define BSP_BLUETANK_H
  34
  35 /**
  36  * \breif ボリューム入力のチャンネル数
  37  * \details
  38  * BSPが持つボリュームのチャンネル数。ここでいうボリュームはポテンショメータに限らない。
  39  * ロータリーエンコーダーなども含む。また、システムが複数種のボリューム（例えばADCと
  40  * ロータリーエンコーダー）を持つ場合には、それらのチャンネル数の総和である。
  41  */
  42
  43 #define UZUME_NUM_VOLUME 4
  44
  45 /**
  46  * \brief ボード・イニシャライザ
  47  * \param exinf 0を渡す。関数からは無視される。
  48  * \details
  49  * BSP用のイニシャライザである。アプリケーションに依存せず、uzumeが
  50  * 必要とする初期化処理をおここで行う。具体的にはI2S用のピンの割付を行う
  51  */
  52 void board_initialize(VP_INT exinf);
  53
  54 #endif /* BSP_BLUETANK_H */
  55