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  *#* $Log$
  43  *#* Revision 1.10  2006/07/19 12:56:26  bernie
  44  *#* Convert to new Doxygen style.
  45  *#*
  46  *#* Revision 1.9  2006/02/17 22:23:06  bernie
  47  *#* Update POSIX serial emulator.
  48  *#*
  49  *#* Revision 1.8  2005/11/04 16:20:02  bernie
  50  *#* Fix reference to README.devlib in header.
  51  *#*
  52  *#* Revision 1.7  2005/01/14 00:47:56  aleph
  53  *#* Rename callbacks; SerialHardwareVT.txSending: New callback.
  54  *#*
  55  *#* Revision 1.6  2004/12/08 08:56:58  bernie
  56  *#* Reformat.
  57  *#*
  58  *#* Revision 1.5  2004/09/06 21:40:50  bernie
  59  *#* Move buffer handling in chip-specific driver.
  60  *#*
  61  *#* Revision 1.4  2004/08/25 14:12:08  rasky
  62  *#* Aggiornato il comment block dei log RCS
  63  *#*
  64  *#* Revision 1.3  2004/06/03 11:27:09  bernie
  65  *#* Add dual-license information.
  66  *#*
  67  *#* Revision 1.2  2004/05/23 18:21:53  bernie
  68  *#* Trim CVS logs and cleanup header info.
  69  *#*
  70  *#*/
  71
  72 #ifndef DRV_SER_P_H
  73 #define DRV_SER_P_H
  74
  75 #include <cfg/compiler.h> /* size_t */
  76
  77 struct SerialHardware;
  78 struct Serial;
  79
  80 struct SerialHardwareVT
  81 {
  82         void (*init)(struct SerialHardware *ctx, struct Serial *ser);
  83         void (*cleanup)(struct SerialHardware *ctx);
  84         void (*setBaudrate)(struct SerialHardware *ctx, unsigned long rate);
  85         void (*setParity)(struct SerialHardware *ctx, int parity);
  86         void (*txStart)(struct SerialHardware *ctx);
  87         bool (*txSending)(struct SerialHardware *ctx);
  88 };
  89
  90 struct SerialHardware
  91 {
  92         const struct SerialHardwareVT *table;
  93         unsigned char *txbuffer;
  94         unsigned char *rxbuffer;
  95         size_t         txbuffer_size;
  96         size_t         rxbuffer_size;
  97 };
  98
  99 struct SerialHardware *ser_hw_getdesc(int unit);
 100
 101 #endif /* DRV_SER_P_H */