firm/sample/simple_mp3_player/os/ntl.h

   1 /**
   2  * @file ntl.h
   3  * @author Shinichiro Nakamura
   4  * @brief NT-Logger\e$B%a%$%s%b%8%e!<%k$NDj5A!#\e(B
   5  */
   6
   7 /*
   8  * ===============================================================
   9  *  Natural Tiny Logger (NT-Logger)
  10  * ===============================================================
  11  * Copyright (c) 2010-2012 Shinichiro Nakamura
  12  *
  13  * Permission is hereby granted, free of charge, to any person
  14  * obtaining a copy of this software and associated documentation
  15  * files (the "Software"), to deal in the Software without
  16  * restriction, including without limitation the rights to use,
  17  * copy, modify, merge, publish, distribute, sublicense, and/or
  18  * sell copies of the Software, and to permit persons to whom the
  19  * Software is furnished to do so, subject to the following
  20  * conditions:
  21  *
  22  * The above copyright notice and this permission notice shall be
  23  * included in all copies or substantial portions of the Software.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  27  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  29  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  30  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  31  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  32  * OTHER DEALINGS IN THE SOFTWARE.
  33  * ===============================================================
  34  */
  35
  36 #ifndef NTL_H
  37 #define NTL_H
  38
  39 #define NTLEVT_START(TRACK,EVENT)   ntl_event_start(TRACK,EVENT)
  40 #define NTLEVT_END(TRACK,EVENT)     ntl_event_end(TRACK,EVENT)
  41
  42 /**
  43  * @brief NT-Logger\e$B$r=i4|2=$9$k!#\e(B
  44  *
  45  * @retval 0 \e$B@.8y!#\e(B
  46  * @retval -1 \e$B<:GT!#\e(B
  47  */
  48 int ntl_init(void);
  49
  50 /**
  51  * @brief \e$B%$%Y%s%H3+;OE@$rJs9p$9$k!#\e(B
  52  *
  53  * @param track \e$B%H%i%C%/HV9f!#\e(B
  54  * @param event \e$B%$%Y%s%HHV9f!#\e(B
  55  *
  56  * @retval 0 \e$B@.8y!#\e(B
  57  * @retval -1 \e$B<:GT!#\e(B
  58  */
  59 int ntl_event_start(const int track, const int event);
  60
  61 /**
  62  * @brief \e$B%$%Y%s%H=*N;E@$rJs9p$9$k!#\e(B
  63  *
  64  * @param track \e$B%H%i%C%/HV9f!#\e(B
  65  * @param event \e$B%$%Y%s%HHV9f!#\e(B
  66  *
  67  * @retval 0 \e$B@.8y!#\e(B
  68  * @retval -1 \e$B<:GT!#\e(B
  69  */
  70 int ntl_event_end(const int track, const int event);
  71
  72 #endif
  73