#error This module has not been revised for the API changes in several DevLib modules
-/*!
+/**
* \file
* <!--
* Copyright 2004 Develer S.r.l. (http://www.develer.com/)
* Copyright 1999, 2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ * This file is part of DevLib - See README.devlib for information.
* -->
* \brief X-Modem serial transmission protocol (implementation)
*
* \author Bernardo Innocenti <bernie@develer.com>
*/
-/*
- * $Log$
- * Revision 1.7 2004/08/15 06:30:06 bernie
- * Make the buffer a local variable, as documented.
- *
- * Revision 1.6 2004/08/15 05:31:46 bernie
- * Add an #error to spread some FUD about the quality of this module;
- * Add a few TODOs from Rasky's review;
- * Update to the new drv/ser.c API;
- * Move FlushSerial() to drv/ser.c and generalize.
- *
- * Revision 1.5 2004/08/12 23:46:21 bernie
- * Remove extra indentation level in switch statements.
- *
- * Revision 1.4 2004/08/12 23:35:50 bernie
- * Replace a handmade loop with memset().
- *
- * Revision 1.3 2004/08/12 23:34:36 bernie
- * Replace if/else with continue to reduce indentation level.
- *
- * Revision 1.2 2004/08/12 23:24:07 bernie
- * Rename UPDCRC() to UPDCRC16().
- *
- * Revision 1.1 2004/08/11 19:54:22 bernie
- * Import XModem protocol into DevLib.
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.10 2006/07/19 12:56:28 bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.9 2005/11/04 16:20:02 bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.8 2004/08/25 14:12:09 rasky
+ *#* Aggiornato il comment block dei log RCS
+ *#*
+ *#* Revision 1.7 2004/08/15 06:30:06 bernie
+ *#* Make the buffer a local variable, as documented.
+ *#*
+ *#* Revision 1.6 2004/08/15 05:31:46 bernie
+ *#* Add an #error to spread some FUD about the quality of this module;
+ *#* Add a few TODOs from Rasky's review;
+ *#* Update to the new drv/ser.c API;
+ *#* Move FlushSerial() to drv/ser.c and generalize.
+ *#*
+ *#* Revision 1.5 2004/08/12 23:46:21 bernie
+ *#* Remove extra indentation level in switch statements.
+ *#*
+ *#* Revision 1.4 2004/08/12 23:35:50 bernie
+ *#* Replace a handmade loop with memset().
+ *#*
+ *#* Revision 1.3 2004/08/12 23:34:36 bernie
+ *#* Replace if/else with continue to reduce indentation level.
+ *#*
+ *#* Revision 1.2 2004/08/12 23:24:07 bernie
+ *#* Rename UPDCRC() to UPDCRC16().
+ *#*
+ *#* Revision 1.1 2004/08/11 19:54:22 bernie
+ *#* Import XModem protocol into DevLib.
+ *#*
+ *#*/
#include "xmodem.h"
#include <string.h> /* for memset() */
-/*!
+/**
* \name Protocol control codes
* \{
*/
-#define XM_SOH 0x01 /*!< Start Of Header (128-byte block) */
-#define XM_STX 0x02 /*!< Start Of Header (1024-byte block) */
-#define XM_EOT 0x04 /*!< End Of Transmission */
-#define XM_ACK 0x06 /*!< Acknowledge block */
-#define XM_NAK 0x15 /*!< Negative Acknowledge */
-#define XM_C 0x43 /*!< Request CRC-16 transmission */
-#define XM_CAN 0x18 /*!< CANcel transmission */
+#define XM_SOH 0x01 /**< Start Of Header (128-byte block) */
+#define XM_STX 0x02 /**< Start Of Header (1024-byte block) */
+#define XM_EOT 0x04 /**< End Of Transmission */
+#define XM_ACK 0x06 /**< Acknowledge block */
+#define XM_NAK 0x15 /**< Negative Acknowledge */
+#define XM_C 0x43 /**< Request CRC-16 transmission */
+#define XM_CAN 0x18 /**< CANcel transmission */
/*\}*/
-#define XM_MAXRETRIES 15 /*!< Max retries before giving up */
-#define XM_MAXCRCRETRIES 7 /*!< Max retries before switching to BCC */
-#define XM_BUFSIZE 1024 /*!< Size of block buffer */
+#define XM_MAXRETRIES 15 /**< Max retries before giving up */
+#define XM_MAXCRCRETRIES 7 /**< Max retries before switching to BCC */
+#define XM_BUFSIZE 1024 /**< Size of block buffer */
#if (ARCH & ARCH_BOOT)
#endif /* ARCH_BOOT */
-/*!
+/**
* Decode serial driver errors and print them on the display.
*/
static void print_serial_error(struct Serial *port, int retries)
}
-/*!
+/**
* \brief Receive a file using the XModem protocol.
*
* \param port Serial port to use for transfer
}
-/*!
+/**
* \brief Transmit a file using the XModem protocol.
*
* \param port Serial port to use for transfer