bertos/cfg/kfile_debug.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief KFile interface over a debug console.
  34  *
  35  *
  36  * \author Francesco Sacchi <batt@develer.com>
  37  *
  38  * $WIZ$ module_name = "kfiledebug"
  39  * $WIZ$ module_depends = "kfile"
  40  */
  41
  42 #ifndef CFG_KFILE_DEBUG
  43 #define CFG_KFILE_DEBUG
  44
  45 #include <io/kfile.h>
  46
  47 /**
  48  * Context for KFile over debug console.
  49  */
  50 typedef struct KFileDebug
  51 {
  52         KFile fd;  ///< KFile base class
  53 } KFileDebug;
  54
  55 /**
  56  * ID for KFileDebug.
  57  */
  58 #define KFT_KFILEDEBUG MAKE_ID('K', 'D', 'B', 'G')
  59
  60 /**
  61  * Convert + ASSERT from generic KFile to KFileDebug.
  62  */
  63 INLINE KFileDebug * KFILEDEBUG_CAST(KFile *fd)
  64 {
  65         ASSERT(fd->_type == KFT_KFILEDEBUG);
  66         return (KFileDebug *)fd;
  67 }
  68
  69 /**
  70  * Initialize KFileMem struct.
  71  *
  72  * \param km Interface to initialize.
  73  */
  74 void kfiledebug_init(KFileDebug *km);
  75
  76 #endif /* CFG_KFILE_DEBUG */