bertos/drv/sipo.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 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Macro for SIPO_H
  34  *
  35  *
  36  * \version $Id$
  37  *
  38  * \author Andrea Grandi <andrea@develer.com>
  39  * \author Daniele Basile <asterix@develer.com>
  40  */
  41
  42 #ifndef DRV_SIPO_H
  43 #define DRV_SIPO_H
  44
  45 #include <kern/kfile.h>
  46
  47 /**
  48  * Sipo KFile context structure.
  49  */
  50 typedef struct Sipo
  51 {
  52         KFile fd;                       ///< File descriptor.
  53 } Sipo;
  54
  55 /**
  56  * ID for sipo.
  57  */
  58 #define KFT_SIPO MAKE_ID('S', 'I', 'P', 'O')
  59
  60 /**
  61  * Convert + ASSERT from generic KFile to Sipo.
  62  */
  63 INLINE Sipo * SIPO_CAST(KFile *fd)
  64 {
  65         ASSERT(fd->_type == KFT_SIPO);
  66         return (Sipo *)fd;
  67 }
  68
  69 void sipo_init(Sipo *fd);
  70
  71 #endif // DRV_SIPO_H
  72