1 /*
2 * COPYRIGHT (C) 2012, Real-Thread Information Technology Ltd
3 * All rights reserved
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Change Logs:
8 * Date Author Notes
9 * 2013-04-14 Grissiom initial implementation
10 */
11
12 #include <rthw.h>
13 #include "ymodem.h"
14
15 static const rt_uint16_t ccitt_table[256] = {
16 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
17 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
18 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
19 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
20 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
21 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
22 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
23 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
24 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
25 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
26 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
27 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
28 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
29 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
30 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
31 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
32 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
33 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
34 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
35 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
36 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
37 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
38 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
39 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
40 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
41 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
42 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
43 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
44 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
45 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
46 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
47 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
48 };
CRC16(unsigned char * q,int len)49 rt_uint16_t CRC16(unsigned char *q, int len)
50 {
51 rt_uint16_t crc = 0;
52
53 while (len-- > 0)
54 crc = (crc << 8) ^ ccitt_table[((crc >> 8) ^ *q++) & 0xff];
55 return crc;
56 }
57
58 // we could only use global varible because we could not use
59 // rt_device_t->user_data(it is used by the serial driver)...
60 static struct rym_ctx *_rym_the_ctx;
61
_rym_rx_ind(rt_device_t dev,rt_size_t size)62 static rt_err_t _rym_rx_ind(rt_device_t dev, rt_size_t size)
63 {
64 return rt_sem_release(&_rym_the_ctx->sem);
65 }
66
67 /* SOH/STX + seq + payload + crc */
68 #define _RYM_SOH_PKG_SZ (1+2+128+2)
69 #define _RYM_STX_PKG_SZ (1+2+1024+2)
70
_rym_read_code(struct rym_ctx * ctx,rt_tick_t timeout)71 static enum rym_code _rym_read_code(
72 struct rym_ctx *ctx,
73 rt_tick_t timeout)
74 {
75 /* Fast path */
76 if (rt_device_read(ctx->dev, 0, ctx->buf, 1) == 1)
77 return (enum rym_code)(*ctx->buf);
78
79 /* Slow path */
80 do {
81 rt_size_t rsz;
82
83 /* No data yet, wait for one */
84 if (rt_sem_take(&ctx->sem, timeout) != RT_EOK)
85 return RYM_CODE_NONE;
86
87 /* Try to read one */
88 rsz = rt_device_read(ctx->dev, 0, ctx->buf, 1);
89 if (rsz == 1)
90 return (enum rym_code)(*ctx->buf);
91 } while (1);
92 }
93
94 /* the caller should at least alloc _RYM_STX_PKG_SZ buffer */
_rym_read_data(struct rym_ctx * ctx,rt_size_t len)95 static rt_size_t _rym_read_data(
96 struct rym_ctx *ctx,
97 rt_size_t len)
98 {
99 /* we should already have had the code */
100 rt_uint8_t *buf = ctx->buf + 1;
101 rt_size_t readlen = 0;
102
103 do
104 {
105 readlen += rt_device_read(ctx->dev,
106 0, buf+readlen, len-readlen);
107 if (readlen >= len)
108 return readlen;
109 } while (rt_sem_take(&ctx->sem, RYM_WAIT_CHR_TICK) == RT_EOK);
110
111 return readlen;
112 }
113
_rym_putchar(struct rym_ctx * ctx,rt_uint8_t code)114 static rt_size_t _rym_putchar(struct rym_ctx *ctx, rt_uint8_t code)
115 {
116 rt_device_write(ctx->dev, 0, &code, sizeof(code));
117 return 1;
118 }
119
_rym_do_handshake(struct rym_ctx * ctx,int tm_sec)120 static rt_err_t _rym_do_handshake(
121 struct rym_ctx *ctx,
122 int tm_sec)
123 {
124 enum rym_code code;
125 rt_size_t i;
126 rt_uint16_t recv_crc, cal_crc;
127 rt_size_t data_sz;
128
129 ctx->stage = RYM_STAGE_ESTABLISHING;
130 /* send C every second, so the sender could know we are waiting for it. */
131 for (i = 0; i < tm_sec; i++)
132 {
133 _rym_putchar(ctx, RYM_CODE_C);
134 code = _rym_read_code(ctx,
135 RYM_CHD_INTV_TICK);
136 if (code == RYM_CODE_SOH)
137 {
138 data_sz = _RYM_SOH_PKG_SZ;
139 break;
140 }
141 else if(code == RYM_CODE_STX)
142 {
143 data_sz = _RYM_STX_PKG_SZ;
144 break;
145 }
146 }
147 if (i == tm_sec)
148 {
149 return -RYM_ERR_TMO;
150 }
151
152 i = _rym_read_data(ctx, data_sz-1);
153 if (i != (data_sz-1))
154 return -RYM_ERR_DSZ;
155
156 /* sanity check */
157 if (ctx->buf[1] != 0 || ctx->buf[2] != 0xFF)
158 return -RYM_ERR_SEQ;
159
160 recv_crc = (rt_uint16_t)(*(ctx->buf+data_sz-2) << 8) | *(ctx->buf+data_sz-1);
161 cal_crc = CRC16(ctx->buf+3, data_sz-5);
162 if (recv_crc != cal_crc)
163 return -RYM_ERR_CRC;
164
165 /* congratulations, check passed. */
166 if (ctx->on_begin && ctx->on_begin(ctx, ctx->buf+3, data_sz-5) != RYM_CODE_ACK)
167 return -RYM_ERR_CAN;
168
169 return RT_EOK;
170 }
171
_rym_trans_data(struct rym_ctx * ctx,rt_size_t data_sz,enum rym_code * code)172 static rt_err_t _rym_trans_data(
173 struct rym_ctx *ctx,
174 rt_size_t data_sz,
175 enum rym_code *code)
176 {
177 const rt_size_t tsz = 2+data_sz+2;
178 rt_uint16_t recv_crc;
179
180 /* seq + data + crc */
181 rt_size_t i = _rym_read_data(ctx, tsz);
182 if (i != tsz)
183 return -RYM_ERR_DSZ;
184
185 if ((ctx->buf[1] + ctx->buf[2]) != 0xFF)
186 {
187 return -RYM_ERR_SEQ;
188 }
189
190 /* As we are sending C continuously, there is a chance that the
191 * sender(remote) receive an C after sending the first handshake package.
192 * So the sender will interpret it as NAK and re-send the package. So we
193 * just ignore it and proceed. */
194 if (ctx->stage == RYM_STAGE_ESTABLISHED && ctx->buf[1] == 0x00)
195 {
196 *code = RYM_CODE_NONE;
197 return RT_EOK;
198 }
199
200 ctx->stage = RYM_STAGE_TRANSMITTING;
201
202 /* sanity check */
203 recv_crc = (rt_uint16_t)(*(ctx->buf+tsz-1) << 8) | *(ctx->buf+tsz);
204 if (recv_crc != CRC16(ctx->buf+3, data_sz))
205 return -RYM_ERR_CRC;
206
207 /* congratulations, check passed. */
208 if (ctx->on_data)
209 *code = ctx->on_data(ctx, ctx->buf+3, data_sz);
210 else
211 *code = RYM_CODE_ACK;
212 return RT_EOK;
213 }
214
_rym_do_trans(struct rym_ctx * ctx)215 static rt_err_t _rym_do_trans(struct rym_ctx *ctx)
216 {
217 _rym_putchar(ctx, RYM_CODE_ACK);
218 _rym_putchar(ctx, RYM_CODE_C);
219 ctx->stage = RYM_STAGE_ESTABLISHED;
220
221 while (1)
222 {
223 rt_err_t err;
224 enum rym_code code;
225 rt_size_t data_sz, i;
226
227 code = _rym_read_code(ctx,
228 RYM_WAIT_PKG_TICK);
229 switch (code)
230 {
231 case RYM_CODE_SOH:
232 data_sz = 128;
233 break;
234 case RYM_CODE_STX:
235 data_sz = 1024;
236 break;
237 case RYM_CODE_EOT:
238 return RT_EOK;
239 default:
240 return -RYM_ERR_CODE;
241 };
242
243 err = _rym_trans_data(ctx, data_sz, &code);
244 if (err != RT_EOK)
245 return err;
246 switch (code)
247 {
248 case RYM_CODE_CAN:
249 /* the spec require multiple CAN */
250 for (i = 0; i < RYM_END_SESSION_SEND_CAN_NUM; i++) {
251 _rym_putchar(ctx, RYM_CODE_CAN);
252 }
253 return -RYM_ERR_CAN;
254 case RYM_CODE_ACK:
255 _rym_putchar(ctx, RYM_CODE_ACK);
256 break;
257 default:
258 // wrong code
259 break;
260 };
261 }
262 }
263
_rym_do_fin(struct rym_ctx * ctx)264 static rt_err_t _rym_do_fin(struct rym_ctx *ctx)
265 {
266 enum rym_code code;
267 rt_uint16_t recv_crc;
268 rt_size_t i;
269
270 ctx->stage = RYM_STAGE_FINISHING;
271 /* we already got one EOT in the caller. invoke the callback if there is
272 * one. */
273 if (ctx->on_end)
274 ctx->on_end(ctx, ctx->buf+3, 128);
275
276 _rym_putchar(ctx, RYM_CODE_NAK);
277 code = _rym_read_code(ctx, RYM_WAIT_PKG_TICK);
278 if (code != RYM_CODE_EOT)
279 return -RYM_ERR_CODE;
280
281 _rym_putchar(ctx, RYM_CODE_ACK);
282 _rym_putchar(ctx, RYM_CODE_C);
283
284 code = _rym_read_code(ctx, RYM_WAIT_PKG_TICK);
285 if (code != RYM_CODE_SOH)
286 return -RYM_ERR_CODE;
287
288 i = _rym_read_data(ctx, _RYM_SOH_PKG_SZ-1);
289 if (i != (_RYM_SOH_PKG_SZ-1))
290 return -RYM_ERR_DSZ;
291
292 /* sanity check
293 *
294 * TODO: multiple files transmission
295 */
296 if (ctx->buf[1] != 0 || ctx->buf[2] != 0xFF)
297 return -RYM_ERR_SEQ;
298
299 recv_crc = (rt_uint16_t)(*(ctx->buf+_RYM_SOH_PKG_SZ-2) << 8) | *(ctx->buf+_RYM_SOH_PKG_SZ-1);
300 if (recv_crc != CRC16(ctx->buf+3, _RYM_SOH_PKG_SZ-5))
301 return -RYM_ERR_CRC;
302
303 /* congratulations, check passed. */
304 ctx->stage = RYM_STAGE_FINISHED;
305
306 /* put the last ACK */
307 _rym_putchar(ctx, RYM_CODE_ACK);
308
309 return RT_EOK;
310 }
311
_rym_do_recv(struct rym_ctx * ctx,int handshake_timeout)312 static rt_err_t _rym_do_recv(
313 struct rym_ctx *ctx,
314 int handshake_timeout)
315 {
316 rt_err_t err;
317
318 ctx->stage = RYM_STAGE_NONE;
319
320 ctx->buf = rt_malloc(_RYM_STX_PKG_SZ);
321 if (ctx->buf == RT_NULL)
322 return -RT_ENOMEM;
323
324 err = _rym_do_handshake(ctx, handshake_timeout);
325 if (err != RT_EOK)
326 return err;
327
328 err = _rym_do_trans(ctx);
329 if (err != RT_EOK)
330 return err;
331
332 return _rym_do_fin(ctx);
333 }
334
rym_recv_on_device(struct rym_ctx * ctx,rt_device_t dev,rt_uint16_t oflag,rym_callback on_begin,rym_callback on_data,rym_callback on_end,int handshake_timeout)335 rt_err_t rym_recv_on_device(
336 struct rym_ctx *ctx,
337 rt_device_t dev,
338 rt_uint16_t oflag,
339 rym_callback on_begin,
340 rym_callback on_data,
341 rym_callback on_end,
342 int handshake_timeout)
343 {
344 rt_err_t res;
345 rt_err_t (*odev_rx_ind)(rt_device_t dev, rt_size_t size);
346 rt_uint16_t odev_flag;
347 int int_lvl;
348
349 RT_ASSERT(_rym_the_ctx == 0);
350 _rym_the_ctx = ctx;
351
352 ctx->on_begin = on_begin;
353 ctx->on_data = on_data;
354 ctx->on_end = on_end;
355 ctx->dev = dev;
356 rt_sem_init(&ctx->sem, "rymsem", 0, RT_IPC_FLAG_FIFO);
357
358 odev_rx_ind = dev->rx_indicate;
359 /* no data should be received before the device has been fully setted up.
360 */
361 int_lvl = rt_hw_interrupt_disable();
362 rt_device_set_rx_indicate(dev, _rym_rx_ind);
363
364 odev_flag = dev->flag;
365 /* make sure the device don't change the content. */
366 dev->flag &= ~RT_DEVICE_FLAG_STREAM;
367 rt_hw_interrupt_enable(int_lvl);
368
369 res = rt_device_open(dev, oflag);
370 if (res != RT_EOK)
371 goto __exit;
372
373 res = _rym_do_recv(ctx, handshake_timeout);
374
375 rt_device_close(dev);
376
377 __exit:
378 /* no rx_ind should be called before the callback has been fully detached.
379 */
380 int_lvl = rt_hw_interrupt_disable();
381 rt_sem_detach(&ctx->sem);
382
383 dev->flag = odev_flag;
384 rt_device_set_rx_indicate(dev, odev_rx_ind);
385 rt_hw_interrupt_enable(int_lvl);
386
387 rt_free(ctx->buf);
388 _rym_the_ctx = RT_NULL;
389
390 return res;
391 }
392