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  * Convenient way to push data into a FIFO using the KFile interface.
  36  * For example, it's possible to read from a serial port and put the characters
  37  * into a fifo:
  38  * \code
  39  * // serial reader process
  40  * {
  41  *   // other stuff here...
  42  *   kfile_read(&ser_port.fd, buffer, sizeof(buffer));
  43  *   kfile_write(&kfifo.fd, buffer, sizeof(buffer));
  44  *   // ...
  45  * }
  46  *
  47  * // controller process
  48  * {
  49  *   //...
  50  *   kfile_read(&kfifo.fd, buffer2, sizeof(buffer2));
  51  *   // use read data
  52  * }
  53  * \endcode
  54  *
  55  *
  56  * \author Francesco Sacchi <asterix@develer.com>
  57  *
  58  * $WIZ$ module_name = "kfilefifo"
  59  * $WIZ$ module_depends = "kfile"
  60  */
  61
  62 #ifndef STRUCT_KFILE_FIFO
  63 #define STRUCT_KFILE_FIFO
  64
  65 #include "fifobuf.h"
  66 #include <io/kfile.h>
  67
  68 typedef struct KFileFifo
  69 {
  70                 KFile fd;
  71                 FIFOBuffer *fifo;
  72 } KFileFifo;
  73
  74 /**
  75  * ID for KFile FIFO.
  76  */
  77 #define KFT_KFILEFIFO MAKE_ID('F', 'I', 'F', '0')
  78
  79 /**
  80  * Convert + ASSERT from generic KFile to KFileFifo.
  81  */
  82 INLINE KFileFifo * KFILEFIFO_CAST(KFile *fd)
  83 {
  84         ASSERT(fd->_type == KFT_KFILEFIFO);
  85         return (KFileFifo *)fd;
  86 }
  87
  88 /**
  89  * Initialize KFileFifo struct.
  90  *
  91  * \param kf Interface to initialize.
  92  * \param fifo Fifo buffer to operate on.
  93  */
  94 void kfilefifo_init(KFileFifo *kf, FIFOBuffer *fifo);
  95
  96 int kfilefifo_testSetup(void);
  97 int kfilefifo_testRun(void);
  98 int kfilefifo_testTearDown(void);
  99 #endif /* STRUCT_KFILE_FIFO */