OpenModem/bertos/cfg/kfile_debug.h

77 lines
2.1 KiB
C

/**
* \file
* <!--
* This file is part of BeRTOS.
*
* Bertos is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As a special exception, you may use this file as part of a free software
* library without restriction. Specifically, if other files instantiate
* templates or use macros or inline functions from this file, or you compile
* this file and link it with other files to produce an executable, this
* file does not by itself cause the resulting executable to be covered by
* the GNU General Public License. This exception does not however
* invalidate any other reasons why the executable file might be covered by
* the GNU General Public License.
*
* Copyright 2010 Develer S.r.l. (http://www.develer.com/)
*
* -->
*
* \brief KFile interface over a debug console.
*
*
* \author Francesco Sacchi <batt@develer.com>
*
* $WIZ$ module_name = "kfiledebug"
* $WIZ$ module_depends = "kfile"
*/
#ifndef CFG_KFILE_DEBUG
#define CFG_KFILE_DEBUG
#include <io/kfile.h>
/**
* Context for KFile over debug console.
*/
typedef struct KFileDebug
{
KFile fd; ///< KFile base class
} KFileDebug;
/**
* ID for KFileDebug.
*/
#define KFT_KFILEDEBUG MAKE_ID('K', 'D', 'B', 'G')
/**
* Convert + ASSERT from generic KFile to KFileDebug.
*/
INLINE KFileDebug * KFILEDEBUG_CAST(KFile *fd)
{
ASSERT(fd->_type == KFT_KFILEDEBUG);
return (KFileDebug *)fd;
}
/**
* Initialize KFileMem struct.
*
* \param km Interface to initialize.
*/
void kfiledebug_init(KFileDebug *km);
#endif /* CFG_KFILE_DEBUG */