drv/ser_p.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 2003,2004 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Hardware dependent serial driver (interface)
  34  *
  35  * \version $Id$
  36  *
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  * \author Giovanni Bajo <rasky@develer.com>
  39  */
  40
  41
  42 #ifndef DRV_SER_P_H
  43 #define DRV_SER_P_H
  44
  45 #include <cfg/compiler.h> /* size_t */
  46
  47 struct SerialHardware;
  48 struct Serial;
  49
  50 struct SerialHardwareVT
  51 {
  52         void (*init)(struct SerialHardware *ctx, struct Serial *ser);
  53         void (*cleanup)(struct SerialHardware *ctx);
  54         void (*setBaudrate)(struct SerialHardware *ctx, unsigned long rate);
  55         void (*setParity)(struct SerialHardware *ctx, int parity);
  56         void (*txStart)(struct SerialHardware *ctx);
  57         bool (*txSending)(struct SerialHardware *ctx);
  58 };
  59
  60 struct SerialHardware
  61 {
  62         const struct SerialHardwareVT *table;
  63         unsigned char *txbuffer;
  64         unsigned char *rxbuffer;
  65         size_t         txbuffer_size;
  66         size_t         rxbuffer_size;
  67 };
  68
  69 struct SerialHardware *ser_hw_getdesc(int unit);
  70
  71 #endif /* DRV_SER_P_H */