bfin32.h

   1 /**
   2  * \file bfin32.h
   3  * \brief Blackfin 32bit algorithm library include file.
   4  */
   5
   6 /**
   7  * \mainpage Blackfin 32bit Algorithm library
   8  * \arthur Takemasa Nakamura
   9  * \data 2014/Apr/6
  10  * \version 1.0
  11  *
  12  * \details
  13  *
  14  * Libbfin32 is a Blackfin 32bit Algorithm library. This library provides a small set of functions like
  15  * filters, NCO and vector algorithm.
  16  *
  17  * \section devenv Development environment
  18  * This library is tested by Blackfin Toolchain 2013R1-RC1 by Blackfin Koop.
  19  *
  20  * \section howtoget How to get this library
  21  * This library is delivered from libbfin32 porject in the sourceforge.
  22  * http://sourceforge.jp/projects/libbfin32/
  23  *
  24  * \section installing How to install
  25  * Make sure the Blackfin tool chain is installed and path is appropriately set. And then, execute
  26  * following command from the shell.
  27  *
  28  * \code
  29  * make all
  30  * make install
  31  * \endcode
  32  *
  33  * The installer will copy the libbfin32.a in the /opt/libbfin32/bin and copy the
  34  * include files into the /opt/libbfin32/include.
  35  *
  36  * \section usage How to use
  37  * The library can be linked with executable by static link. Use -m bfin32 as option to linker.
  38  * The library path should be correctly set. before linking.
  39  *
  40  * The source code should include bfin32.h to include the function prototype. The path should be
  41  * set correctly before compile.
  42  *
  43  * The libbfin32 is depend on the 32bit fixed point header file fract.h.
  44  *
  45  *
  46  */
  47
  48 #ifndef _BFIN32_H_
  49 #define _BFIN32_H_
  50
  51 #include <fract.h>
  52
  53 #include "fr32_fir.h"
  54 #include "fr32_vector.h"
  55 #include "fr32_nco.h"
  56
  57 #endif /* _BFIN32_H_ */