bertos/struct/kfile_fifo.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 KFile interface over a FIFO buffer.
  34  *
  35  * \version $Id: cfg_adc.h 2348 2009-02-16 13:43:44Z duplo $
  36  * \author Francesco Sacchi <asterix@develer.com>
  37  *
  38  * $WIZ$ module_name = "kfilefifo"
  39  * $WIZ$ module_depends = "kfile"
  40  */
  41
  42 #ifndef STRUCT_KFILE_FIFO
  43 #define STRUCT_KFILE_FIFO
  44
  45 #include "fifobuf.h"
  46 #include <kern/kfile.h>
  47
  48 typedef struct KFileFifo
  49 {
  50                 KFile fd;
  51                 FIFOBuffer *fifo;
  52 } KFileFifo;
  53
  54 /**
  55  * ID for KFile FIFO.
  56  */
  57 #define KFT_KFILEFIFO MAKE_ID('F', 'I', 'F', '0')
  58
  59 /**
  60  * Convert + ASSERT from generic KFile to KFileFifo.
  61  */
  62 INLINE KFileFifo * KFILEFIFO_CAST(KFile *fd)
  63 {
  64         ASSERT(fd->_type == KFT_KFILEFIFO);
  65         return (KFileFifo *)fd;
  66 }
  67
  68 void kfilefifo_init(KFileFifo *kf, FIFOBuffer *fifo);
  69
  70 #endif /* STRUCT_KFILE_FIFO */