bertos/net/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 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  * \brief X-Modem serial transmission protocol.
  34  *
  35  * \version $Id$
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  * \author Francesco Sacchi <batt@develer.com>
  38  *
  39  * $WIZ$ module_name = "xmodem"
  40  * $WIZ$ module_depends = "kfile", "crc16"
  41  * $WIZ$ module_configuration = "bertos/cfg/cfg_xmodem.h"
  42  */
  43
  44
  45 #ifndef NET_XMODEM_H
  46 #define NET_XMODEM_H
  47
  48 #include <cfg/compiler.h>
  49 #include <kern/kfile.h>
  50
  51 /**
  52  * Called to know if we want to abort data tranfer.
  53  * Redefine to whatever you need.
  54  * \{
  55  */
  56 #ifndef XMODEM_CHECK_ABORT
  57 #define XMODEM_CHECK_ABORT (false)
  58 #endif
  59 /*\}*/
  60
  61
  62 /**
  63  * Called to printf progress messages.
  64  * Default to kprintf debug, redefine to whatever you need.
  65  * \{
  66  */
  67 #ifndef XMODEM_PROGRESS
  68 #define XMODEM_PROGRESS(msg, ...) kprintf(msg, ## __VA_ARGS__)
  69 #endif
  70
  71 bool xmodem_recv(KFile *ch, KFile *fd);
  72 bool xmodem_send(KFile *ch, KFile *fd);
  73
  74 #endif /* NET_XMODEM_H */