4 * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 1999, 2001 Bernardo Innocenti <bernie@develer.com>
6 * This file is part of DevLib - See devlib/README for information.
8 * \brief X-Modem serial transmission protocol (implementation)
10 * Suppots the CRC-16 and 1K-blocks variants of the standard.
11 * \see ymodem.txt for the protocol description.
14 * \author Bernardo Innocenti <bernie@develer.com>
19 * Revision 1.1 2004/08/11 19:54:22 bernie
20 * Import XModem protocol into DevLib.
28 #include <drv/buzzer.h>
29 #include <mware/crc.h>
30 #include <mware/kfile.h>
34 * \name Protocol control codes
37 #define XM_SOH 0x01 /*!< Start Of Header (128-byte block) */
38 #define XM_STX 0x02 /*!< Start Of Header (1024-byte block) */
39 #define XM_EOT 0x04 /*!< End Of Transmission */
40 #define XM_ACK 0x06 /*!< Acknowledge block */
41 #define XM_NAK 0x15 /*!< Negative Acknowledge */
42 #define XM_C 0x43 /*!< Request CRC-16 transmission */
43 #define XM_CAN 0x18 /*!< CANcel transmission */
46 #define XM_MAXRETRIES 15 /*!< Max retries before giving up */
47 #define XM_MAXCRCRETRIES 7 /*!< Max retries before switching to BCC */
48 #define XM_BUFSIZE 1024 /*!< Size of block buffer */
51 #if (ARCH & ARCH_BOOT)
53 #if (ARCH & ARCH_SLIM)
54 #define CHECK_ABORT KEYPRESSED_STOP
55 #elif (ARCH & ARCH_SARF)
56 #define CHECK_ABORT KEYPRESSED_ESC
60 #if (ARCH & ARCH_SLIM)
61 #define CHECK_ABORT (kbd_getchar() == K_STOP)
62 #elif (ARCH & ARCH_SARF)
63 #define CHECK_ABORT (kbd_getchar() == K_ESC)
65 #endif /* ARCH_BOOT */
68 /*! Buffer to hold a block of data */
69 static char block_buffer[XM_BUFSIZE];
73 * Decode serial driver errors and print
74 * them on the display.
76 static void SerialError(int retries)
78 serstatus_t err, status;
80 /* Get serial error code and reset it */
81 status = ser_getstatus();
84 /* Mostra tutti gli errori in sequenza */
85 for (err = 0; status != 0; status >>= 1, err++)
87 /* Se il bit dell'errore e' settato */
90 lcd_printf(0, 3, LCD_FILL, "%s %d", serial_errors[err], retries);
99 * Reset previous serial errors and flush the receive buffer
100 * (set a short timeout to speed up purge)
102 static void FlushSerial(void)
105 ser_settimeouts(200, SER_DEFTXTIMEOUT);
106 while (ser_getchar() != EOF) {}
107 ser_settimeouts(SER_DEFRXTIMEOUT, SER_DEFTXTIMEOUT);
112 bool xmodem_recv(KFile *fd)
115 int blocknr = 0, last_block_done = 0, retries = 0;
123 lcd_printf(0, 2, LCD_FILL, "Starting Transfer...");
126 ser_settimeouts(SER_DEFRXTIMEOUT, SER_DEFTXTIMEOUT);
129 /* Send initial NAK to start transmission */
136 lcd_printf(0, 2, LCD_FILL, "Transfer aborted");
141 * Discard incoming input until a timeout occurs, then send
142 * a NAK to the transmitter.
149 SerialError(retries);
154 if (retries >= XM_MAXRETRIES)
158 lcd_printf(0, 2, LCD_FILL, "Transfer aborted");
162 /* Transmission start? */
165 if (retries < XM_MAXCRCRETRIES)
167 lcd_printf(0, 2, LCD_FILL, "Request Tx (CRC)");
172 /* Give up with CRC and fall back to checksum */
174 lcd_printf(0, 2, LCD_FILL, "Request Tx (BCC)");
182 switch (ser_getchar())
184 case XM_STX: /* Start of header (1024-byte block) */
188 case XM_SOH: /* Start of header (128-byte block) */
192 /* Get block number */
195 /* Check complemented block number */
196 if ((~c & 0xff) != ser_getchar())
198 lcd_printf(0, 3, LCD_FILL, "Bad blk (%d)", c);
203 /* Determine which block is being sent */
204 if (c == (blocknr & 0xff))
205 /* Last block repeated */
206 lcd_printf(0, 2, LCD_FILL, "Repeat blk %d", blocknr);
207 else if (c == ((blocknr + 1) & 0xff))
209 lcd_printf(0, 2, LCD_FILL, "Recv blk %d", ++blocknr);
213 lcd_printf(0, 3, LCD_FILL, "Sync lost (%d/%d)", c, blocknr);
218 buf = block_buffer; /* Reset pointer to start of buffer */
221 for (i = 0; i < blocksize; i++)
223 if ((c = ser_getchar()) == EOF)
229 /* Store in buffer */
232 /* Calculate block checksum or CRC */
234 crc = UPDCRC(c, crc);
242 /* Get the checksum byte or the CRC-16 MSB */
243 if ((c = ser_getchar()) == EOF)
251 crc = UPDCRC(c, crc);
254 if ((c = ser_getchar()) == EOF)
260 crc = UPDCRC(c, crc);
264 lcd_printf(0, 3, LCD_FILL, "Bad CRC: %04x", crc);
269 /* Compare the checksum */
270 else if (c != checksum)
272 lcd_printf(0, 3, LCD_FILL, "Bad sum: %04x/%04x", checksum, c);
278 * Avoid flushing the same block twice.
279 * This could happen when the sender does not receive our
280 * acknowledge and resends the same block.
282 if (last_block_done < blocknr)
284 /* Call user function to flush the buffer */
285 if (fd->write(fd, block_buffer, blocksize))
287 /* Acknowledge block and clear error counter */
290 last_block_done = blocknr;
294 /* User callback failed: abort transfer immediately */
295 retries = XM_MAXRETRIES;
301 case XM_EOT: /* End of transmission */
303 lcd_printf(0, 2, LCD_FILL, "Transfer completed");
306 case EOF: /* Timeout or serial error */
311 lcd_printf(0, 3, LCD_FILL, "Skipping garbage");
319 bool xmodem_send(KFile *fd)
322 int blocknr = 1, retries = 0, c, i;
323 bool proceed, usecrc = false;
328 ser_settimeouts(SER_DEFRXTIMEOUT, SER_DEFTXTIMEOUT);
331 lcd_printf(0, 2, LCD_FILL, "Wait remote host");
341 switch (c = ser_getchar())
349 lcd_printf(0, 2, LCD_FILL, "Tx start (CRC)");
353 lcd_printf(0, 2, LCD_FILL, "Tx start (BCC)");
355 /* Call user function to read in one block */
356 size = fd->read(fd, block_buffer, XM_BUFSIZE);
359 lcd_printf(0, 2, LCD_FILL, "Resend blk %d", blocknr);
364 /* End of transfer? */
368 /* Call user function to read in one block */
369 size = fd->read(fd, block_buffer, XM_BUFSIZE);
373 lcd_printf(0, 2, LCD_FILL, "Send blk %d", blocknr);
378 SerialError(retries);
379 if (retries <= XM_MAXRETRIES)
381 /* falling through! */
384 lcd_printf(0, 2, LCD_FILL, "Transfer aborted");
388 lcd_printf(0, 3, LCD_FILL, "Skipping garbage");
398 /* Pad block with 0xFF if it's partially full */
399 if (size < XM_BUFSIZE)
400 for (i = size; i < XM_BUFSIZE; i++)
401 block_buffer[i] = (char)0xFF;
403 /* Send block header (STX, blocknr, ~blocknr) */
405 ser_putchar(blocknr & 0xFF);
406 ser_putchar(~blocknr & 0xFF);
408 /* Send block and compute its CRC/checksum */
411 for (i = 0; i < XM_BUFSIZE; i++)
413 ser_putchar(block_buffer[i]);
414 crc = UPDCRC(block_buffer[i], crc);
415 sum += block_buffer[i];
418 /* Send CRC/Checksum */
421 crc = UPDCRC(0, crc);
422 crc = UPDCRC(0, crc);
423 ser_putchar(crc >> 8);
424 ser_putchar(crc & 0xFF);