mware/xmodem.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 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2001 Bernardo Innocenti <bernie@develer.com>
  31  * This file is part of DevLib - See README.devlib for information.
  32  * -->
  33  * \brief X-Modem serial transmission protocol (interface)
  34  *
  35  * \version $Id$
  36  * \author Bernardo Innocenti <bernie@develer.com>
  37  * \author Francesco Sacchi <batt@develer.com>
  38  */
  39
  40 /*#*
  41  *#* $Log$
  42  *#* Revision 1.7  2007/06/14 14:42:28  batt
  43  *#* Move kfile to kern/ directory; remove duplicate file.h.
  44  *#*
  45  *#* Revision 1.6  2007/06/07 09:10:44  batt
  46  *#* Fix some todos.
  47  *#*
  48  *#* Revision 1.5  2006/07/19 12:56:28  bernie
  49  *#* Convert to new Doxygen style.
  50  *#*
  51  *#* Revision 1.4  2005/11/04 16:20:02  bernie
  52  *#* Fix reference to README.devlib in header.
  53  *#*
  54  *#* Revision 1.3  2004/08/25 14:12:09  rasky
  55  *#* Aggiornato il comment block dei log RCS
  56  *#*
  57  *#* Revision 1.2  2004/08/15 05:31:46  bernie
  58  *#* Add an #error to spread some FUD about the quality of this module;
  59  *#* Add a few TODOs from Rasky's review;
  60  *#* Update to the new drv/ser.c API;
  61  *#* Move FlushSerial() to drv/ser.c and generalize.
  62  *#*
  63  *#* Revision 1.1  2004/08/11 19:54:22  bernie
  64  *#* Import XModem protocol into DevLib.
  65  *#*
  66  *#*/
  67 #ifndef MWARE_XMODEM_H
  68 #define MWARE_XMODEM_H
  69 #include <cfg/compiler.h>
  70 #include <kern/kfile.h>
  71
  72 /**
  73  * Called to know if we want to abort data tranfer.
  74  * Redefine to whatever you need.
  75  * \{
  76  */
  77 #ifndef XMODEM_CHECK_ABORT
  78 #define XMODEM_CHECK_ABORT (false)
  79 #endif
  80 /*\}*/
  81
  82
  83 /**
  84  * Called to printf progress messages.
  85  * Default to kprintf debug, redefine to whatever you need.
  86  * \{
  87  */
  88 #ifndef XMODEM_PROGRESS
  89 #define XMODEM_PROGRESS(msg, ...) kprintf(msg, ## __VA_ARGS__)
  90 #endif
  91
  92
  93 /* fwd decl */
  94 struct Serial;
  95
  96 bool xmodem_recv(struct Serial *port, KFile *fd);
  97 bool xmodem_send(struct Serial *port, KFile *fd);
  98
  99 #endif /* MWARE_XMODEM_H */