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  *
  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 #ifndef MWARE_XMODEM_H
  42 #define MWARE_XMODEM_H
  43 #include <cfg/compiler.h>
  44 #include <kern/kfile.h>
  45
  46 /**
  47  * Called to know if we want to abort data tranfer.
  48  * Redefine to whatever you need.
  49  * \{
  50  */
  51 #ifndef XMODEM_CHECK_ABORT
  52 #define XMODEM_CHECK_ABORT (false)
  53 #endif
  54 /*\}*/
  55
  56
  57 /**
  58  * Called to printf progress messages.
  59  * Default to kprintf debug, redefine to whatever you need.
  60  * \{
  61  */
  62 #ifndef XMODEM_PROGRESS
  63 #define XMODEM_PROGRESS(msg, ...) kprintf(msg, ## __VA_ARGS__)
  64 #endif
  65
  66
  67 /* fwd decl */
  68 struct Serial;
  69
  70 bool xmodem_recv(struct Serial *port, KFile *fd);
  71 bool xmodem_send(struct Serial *port, KFile *fd);
  72
  73 #endif /* MWARE_XMODEM_H */