propagate error to lower layer (xbee library)
[protos/xbee-avr.git] / main.c
1 /*
2  * Copyright (c) 2011, Olivier MATZ <zer0@droids-corp.org>
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of the University of California, Berkeley nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 /* fuses:
29  * avrdude -p atmega1284p -P usb -c avrispmkii -U lfuse:w:0xff:m -U hfuse:w:0x91:m -U efuse:w:0xff:m
30  */
31
32 #include <aversive.h>
33 #include <aversive/queue.h>
34 #include <aversive/endian.h>
35 #include <aversive/wait.h>
36 #include <aversive/error.h>
37
38 #include <uart.h>
39
40 #include <stdio.h>
41 #include <string.h>
42 #include <stdint.h>
43 #include <inttypes.h>
44 #include <stdlib.h>
45 #include <stdarg.h>
46 #include <errno.h>
47 #include <ctype.h>
48
49 #include <scheduler.h>
50 #include <clock_time.h>
51 #include <parse.h>
52 #include <rdline.h>
53 #include <timer.h>
54
55 #include "eeprom_config.h"
56 #include "beep.h"
57 #include "main.h"
58
59 struct xbeeboard xbeeboard;
60 volatile uint16_t global_ms;
61 struct callout_manager cm;
62
63 #define TIMEOUT_MS 1000
64
65 /* global xbee device */
66 struct xbee_dev *xbee_dev;
67
68 /* events */
69 //static struct event stdin_read_event, xbee_read_event;
70
71 /* parameters */
72 int xbee_raw = 0;
73 int xbee_hexdump = 0;
74 int xbee_debug = 0;
75
76 int xbee_cmdline_input_enabled = 1;
77
78 static struct xbee_ctx xbee_ctx[XBEE_MAX_CHANNEL];
79
80 static void hexdump(const char *title, const void *buf, unsigned int len)
81 {
82         unsigned int i, out, ofs;
83         const unsigned char *data = buf;
84 #define LINE_LEN 80
85         char line[LINE_LEN];    /* space needed 8+16*3+3+16 == 75 */
86
87         printf_P(PSTR("%s at [%p], len=%d\r\n"), title, data, len);
88         ofs = 0;
89         while (ofs < len) {
90                 /* format 1 line in the buffer, then use printk to print them */
91                 out = snprintf_P(line, LINE_LEN, PSTR("%08X"), ofs);
92                 for (i=0; ofs+i < len && i<16; i++)
93                         out += snprintf_P(line+out, LINE_LEN - out,
94                                           PSTR(" %02X"),
95                                           data[ofs+i]&0xff);
96                 for (;i<=16;i++)
97                         out += snprintf(line+out, LINE_LEN - out, "   ");
98                 for (i=0; ofs < len && i<16; i++, ofs++) {
99                         unsigned char c = data[ofs];
100                         if (!isascii(c) || !isprint(c))
101                                 c = '.';
102                         out += snprintf_P(line+out,
103                                           LINE_LEN - out,
104                                           PSTR("%c"), c);
105                 }
106                 printf_P(PSTR("%s\r\n"), line);
107         }
108 }
109
110 static int parse_xmit_status(struct xbee_ctx *ctx,
111                              struct xbee_xmit_status_hdr *frame, unsigned len)
112 {
113         (void)len;
114
115         if (ctx == NULL) {
116                 printf_P(PSTR("no context\r\n"));
117                 return -1;
118         }
119
120         /* see if it matches a xmit query (atcmd_query must be NULL) */
121         if (ctx->atcmd_query[0] != '\0') {
122                 printf_P(PSTR("invalid response 2\r\n"));
123                 return -1;
124         }
125
126         /* XXX use defines for these values */
127         if (frame->delivery_status == 0x00)
128                 printf_P(PSTR("Success\r\n"));
129         else if (frame->delivery_status == 0x01)
130                 printf_P(PSTR("MAC ACK Failure\r\n"));
131         else if (frame->delivery_status == 0x15)
132                 printf_P(PSTR("Invalid destination endpoint\r\n"));
133         else if (frame->delivery_status == 0x21)
134                 printf_P(PSTR("Network ACK Failure\r\n"));
135         else if (frame->delivery_status == 0x25)
136                 printf_P(PSTR("Route Not Found\r\n"));
137
138         return 0;
139 }
140
141 static int dump_atcmd(struct xbee_ctx *ctx, struct xbee_atresp_hdr *frame,
142                unsigned len)
143 {
144         char atcmd_str[3];
145         const struct xbee_atcmd *cmd_pgm;
146         struct xbee_atcmd cmd;
147         union {
148                 uint8_t u8;
149                 uint16_t u16;
150                 uint32_t u32;
151                 int16_t s16;
152         } __attribute__((packed)) *result;
153
154         if (ctx == NULL) {
155                 printf_P(PSTR("no context\r\n"));
156                 return -1;
157         }
158
159         /* get AT command from frame */
160         memcpy(atcmd_str, &frame->cmd, 2);
161         atcmd_str[2] = '\0';
162
163         /* see if it matches query */
164         if (memcmp(atcmd_str, ctx->atcmd_query, 2)) {
165                 printf_P(PSTR("invalid response <%c%c><%s><%s>\r\n"),
166                          frame->cmd & 0xFF,
167                          (frame->cmd >> 8) & 0xFF,
168                          atcmd_str, ctx->atcmd_query);
169                 return -1;
170         }
171
172         /* see if it exists */
173         cmd_pgm = xbee_atcmd_lookup_name(atcmd_str);
174         if (cmd_pgm == NULL) {
175                 printf_P(PSTR("unknown response\r\n"));
176                 return -1;
177         }
178         memcpy_P(&cmd, cmd_pgm, sizeof(cmd));
179
180         /* bad status */
181         if (frame->status == 1) {
182                 printf_P(PSTR("Status is error\r\n"));
183                 return -1;
184         }
185         else if (frame->status == 2) {
186                 printf_P(PSTR("Invalid command\r\n"));
187                 return -1;
188         }
189         else if (frame->status == 3) {
190                 printf_P(PSTR("Invalid parameter\r\n"));
191                 return -1;
192         }
193         else if (frame->status != 0) {
194                 printf_P(PSTR("Unknown status error %d\r\n"), frame->status);
195                 return -1;
196         }
197
198         /* callback */
199         if (ctx->func != NULL)
200                 ctx->func(frame, len, ctx->arg);
201
202         /* dump frame */
203         result = (void *)frame->data;
204         len -= offsetof(struct xbee_atresp_hdr, data);
205         if (cmd.flags & XBEE_ATCMD_F_PARAM_U8 && len == sizeof(uint8_t))
206                 printf_P(PSTR("<%s> is 0x%x (%d)\r\n"), atcmd_str, result->u8,
207                          result->u8);
208         else if (cmd.flags & XBEE_ATCMD_F_PARAM_U16 && len == sizeof(uint16_t))
209                 printf_P(PSTR("<%s> is 0x%x (%d)\r\n"),
210                          atcmd_str,
211                          ntohs(result->u16), ntohs(result->u16));
212         else if (cmd.flags & XBEE_ATCMD_F_PARAM_U32 && len == sizeof(uint32_t))
213                 printf_P(PSTR("<%s> is 0x%"PRIx32" (%"PRIu32")\r\n"),
214                          atcmd_str,
215                          ntohl(result->u32), ntohs(result->u32));
216         else if (cmd.flags & XBEE_ATCMD_F_PARAM_S16 && len == sizeof(int16_t))
217                 printf_P(PSTR("<%s> is %d\r\n"), atcmd_str, ntohs(result->s16));
218         else if (len == 0)
219                 printf_P(PSTR("no data, status ok\r\n"));
220         else
221                 hexdump("atcmd answer", frame->data, len);
222
223
224         return 0;
225 }
226
227
228 int xbee_recv_data(struct xbee_recv_hdr *recvframe, unsigned len)
229 {
230         unsigned int datalen;
231         struct rc_proto_hdr *rch = (struct rc_proto_hdr *) &recvframe->data;
232
233         if (len <  sizeof(*recvframe))
234                 return -1;
235
236         datalen = len - sizeof(*recvframe);
237         if (datalen < sizeof(struct rc_proto_hdr))
238                 return -1;
239
240         switch (rch->type) {
241 #if 0
242                 case RC_PROTO_TYPE_CHANNEL: {
243                         struct rc_proto_channel *rcc =
244                                 (struct rc_proto_channel *) recvframe->data;
245                         int16_t val;
246                         if (datalen != sizeof(struct rc_proto_channel))
247                                 return -1;
248                         val = ntohs(rcc->axis[0]);
249                         val >>= 6;
250                         val += 512;
251                         spi_servo_set(0, val);
252                         break;
253                 }
254                 case RC_PROTO_TYPE_RANGE: {
255                         struct rc_proto_range *rcr =
256                                 (struct rc_proto_range *) recvframe->data;
257
258                         if (datalen != sizeof(struct rc_proto_range))
259                                 return -1;
260
261                         if (rcr->power_level >= MAX_POWER_LEVEL)
262                                 return -1;
263
264                         rc_proto_rx_range(rcr->power_level);
265
266                         break;
267                 }
268 #endif
269                 default:
270                         return -1;
271         }
272
273         return 0;
274 }
275
276 /* socat /dev/ttyUSB0,raw,echo=0,b115200 /dev/ttyACM1,raw,echo=0,b115200 */
277 int8_t xbeeapp_rx(struct xbee_dev *dev, int channel, int type,
278              void *frame, unsigned len, void *opaque)
279 {
280         struct xbee_ctx *ctx = opaque;
281         int8_t ret = 0;
282
283         if (xbee_debug)
284                 printf_P(PSTR("type=0x%x, channel=%d, ctx=%p\r\n"),
285                          type, channel, ctx);
286
287         /* if ctx is !NULL, it is an answer to a query */
288         if (ctx != NULL) {
289                 /* XXX only delete timeout if answer matched */
290                 xbee_unload_timeout(ctx);
291                 if (xbee_debug && ctx->atcmd_query)
292                         printf_P(PSTR("Received answer to query <%c%c>\r\n"),
293                                  ctx->atcmd_query[0], ctx->atcmd_query[1]);
294         }
295
296         /* some additional checks before sending */
297         switch (type) {
298                 case XBEE_TYPE_MODEM_STATUS: {
299                         printf_P(PSTR("Received Modem Status frame\r\n"));
300                         break;
301                 }
302
303                 case XBEE_TYPE_RMT_ATRESP: {
304                         union {
305                                 uint64_t u64;
306                                 struct {
307 #if BYTE_ORDER == LITTLE_ENDIAN
308                                         uint32_t low;
309                                         uint32_t high;
310 #else
311                                         uint32_t high;
312                                         uint32_t low;
313 #endif
314                                 } u32;
315                         } addr;
316                         memcpy(&addr, frame, sizeof(addr));
317                         addr.u64 = ntohll(addr.u64);
318                         printf_P(PSTR("from remote address %"PRIx32"%"PRIx32"\r\n"),
319                                  addr.u32.high, addr.u32.low);
320
321                         /* this answer contains an atcmd answer at offset 10 */
322                         if (dump_atcmd(ctx, frame + 10, len - 10) < 0)
323                                 ret = -1;
324
325                         break;
326                 }
327                 case XBEE_TYPE_ATRESP: {
328                         if (dump_atcmd(ctx, frame, len) < 0)
329                                 ret = -1;
330
331                         break;
332                 }
333
334                 case XBEE_TYPE_XMIT_STATUS: {
335                         if (parse_xmit_status(ctx, frame, len) < 0)
336                                 ret = -1;
337
338                         break;
339                 }
340
341                 case XBEE_TYPE_RECV: {
342                         if (xbee_recv_data(frame, len) < 0)
343                                 ret = -1;
344
345                         break;
346                 }
347
348                 case XBEE_TYPE_ATCMD:
349                 case XBEE_TYPE_ATCMD_Q:
350                 case XBEE_TYPE_XMIT:
351                 case XBEE_TYPE_EXPL_XMIT:
352                 case XBEE_TYPE_RMT_ATCMD:
353                 case XBEE_TYPE_EXPL_RECV:
354                 case XBEE_TYPE_NODE_ID:
355                 default:
356                         printf_P(PSTR("Invalid frame\r\n"));
357                         ret = -1;
358                         break;
359         }
360
361         if (ret < 0)
362                 hexdump("undecoded rx frame", frame, len);
363         else if (xbee_hexdump)
364                 hexdump("undecoded rx frame", frame, len);
365
366         /* restart command line if it was a blocking query */
367         if (ctx != NULL) {
368                 xbee_unregister_channel(dev, channel);
369                 if (ctx->foreground) {
370                         xbee_stdin_enable();
371                         rdline_newline(&xbeeboard.rdl, xbeeboard.prompt);
372                 }
373         }
374 }
375
376 static int xbeeapp_send(struct xbee_ctx *ctx, int type, void *buf, unsigned len,
377                         int foreground)
378 {
379         int ret;
380         int channel;
381
382         if (len > XBEE_MAX_FRAME_LEN) {
383                 printf_P(PSTR("frame too large\r\n"));
384                 return -1;
385         }
386
387         /* register a channel */
388         channel = xbee_register_channel(xbee_dev, XBEE_CHANNEL_ANY,
389                                         xbeeapp_rx, NULL);
390         if (channel < 0) {
391                 printf_P(PSTR("cannot send: no free channel\r\n"));
392                 return -1;
393         }
394
395         /* copy context in the static struct table (avoiding a malloc) */
396         memcpy(&xbee_ctx[channel], ctx, sizeof(*ctx));
397         ctx = &xbee_ctx[channel];
398         xbee_set_opaque(xbee_dev, channel, ctx);
399
400         if (xbee_debug)
401                 printf_P(PSTR("send frame channel=%d type=0x%x len=%d\r\n"),
402                          channel, type, len);
403         if (xbee_hexdump)
404                 hexdump("xmit frame", buf, len);
405
406         /* transmit the frame on this channel */
407         ret = xbee_tx(xbee_dev, channel, type, buf, len);
408         if (ret < 0) {
409                 printf_P(PSTR("cannot send\r\n"));
410                 xbee_unregister_channel(xbee_dev, channel);
411                 return -1;
412         }
413
414         ctx->channel = channel;
415         xbee_load_timeout(ctx);   /* load a timeout event */
416
417         /* suspend command line until we have answer or timeout */
418         if (foreground) {
419                 ctx->foreground = 1;
420                 rdline_stop(&xbeeboard.rdl); /* don't display prompt when return */
421                 xbee_stdin_disable();  /* unload file descriptor polling */
422         }
423
424         return 0;
425 }
426
427 /* send an AT command with parameters filled by caller. Disable
428  * command line until we get the answer or until a timeout occurs */
429 int xbeeapp_send_atcmd(const char *atcmd_str,
430                        void *param, unsigned param_len, int foreground,
431                        int (*func)(void *frame, unsigned len, void *arg), void *arg)
432 {
433         struct xbee_ctx ctx;
434         struct {
435                 struct xbee_atcmd_hdr atcmd;
436                 char buf[XBEE_MAX_FRAME_LEN];
437         } __attribute__((packed)) frame;
438
439         memset(&ctx, 0, sizeof(ctx));
440         ctx.atcmd_query[0] = atcmd_str[0];
441         ctx.atcmd_query[1] = atcmd_str[1];
442         ctx.func = func;
443         ctx.arg = arg;
444
445         memcpy(&frame.atcmd.cmd, atcmd_str, 2);
446         memcpy(&frame.buf, param, param_len);
447
448         if (xbeeapp_send(&ctx, XBEE_TYPE_ATCMD, &frame,
449                          sizeof(struct xbee_atcmd_hdr) +
450                          param_len, foreground) < 0) {
451                 return -1;
452         }
453
454         return 0;
455 }
456
457 int xbeeapp_send_msg(uint64_t addr, void *data,
458                      unsigned data_len, int foreground)
459 {
460         struct xbee_ctx ctx;
461         struct {
462                 struct xbee_xmit_hdr xmit;
463                 char buf[XBEE_MAX_FRAME_LEN];
464         } __attribute__((packed)) frame;
465
466         memset(&ctx, 0, sizeof(ctx));
467         ctx.atcmd_query[0] = '\0';
468
469         frame.xmit.dstaddr = htonll(addr);
470         frame.xmit.reserved = htons(0xFFFE);
471         frame.xmit.bcast_radius = 0;
472         frame.xmit.opts = 0;
473         memcpy(&frame.buf, data, data_len);
474
475         if (xbeeapp_send(&ctx, XBEE_TYPE_XMIT, &frame,
476                          sizeof(struct xbee_xmit_hdr) +
477                          data_len, foreground) < 0) {
478                 return -1;
479         }
480
481         return 0;
482 }
483
484 void xbee_stdin_enable(void)
485 {
486         xbee_cmdline_input_enabled = 1;
487 }
488
489 void xbee_stdin_disable(void)
490 {
491         xbee_cmdline_input_enabled = 0;
492 }
493
494 static void evt_timeout(struct callout_manager *cm, struct callout *clt,
495                         void *arg)
496 {
497         struct xbee_ctx *ctx = arg;
498
499         (void)cm;
500         (void)clt;
501
502         printf_P(PSTR("Timeout\r\n"));
503
504         /* restart command line */
505         xbee_stdin_enable();
506         rdline_newline(&xbeeboard.rdl, xbeeboard.prompt);
507
508         /* free event */
509         xbee_unregister_channel(xbee_dev, ctx->channel);
510 }
511
512 void xbee_load_timeout(struct xbee_ctx *ctx)
513 {
514         callout_reset(&cm, &ctx->timeout, TIMEOUT_MS, SINGLE, evt_timeout, ctx);
515 }
516
517 void xbee_unload_timeout(struct xbee_ctx *ctx)
518 {
519         callout_stop(&cm, &ctx->timeout);
520 }
521
522 void bootloader(void)
523 {
524 #define BOOTLOADER_ADDR 0x3f000
525         if (pgm_read_byte_far(BOOTLOADER_ADDR) == 0xff) {
526                 printf_P(PSTR("Bootloader is not present\r\n"));
527                 return;
528         }
529         cli();
530         /* ... very specific :( */
531         TIMSK0 = 0;
532         TIMSK1 = 0;
533         TIMSK2 = 0;
534         TIMSK3 = 0;
535         EIMSK = 0;
536         UCSR0B = 0;
537         UCSR1B = 0;
538         SPCR = 0;
539         TWCR = 0;
540         ACSR = 0;
541         ADCSRA = 0;
542
543         /* XXX */
544         /* __asm__ __volatile__ ("ldi r31,0xf8\n"); */
545         /* __asm__ __volatile__ ("ldi r30,0x00\n"); */
546         /* __asm__ __volatile__ ("eijmp\n"); */
547 }
548
549 void xbee_mainloop(void)
550 {
551         while (1) {
552                 callout_manage(&cm);
553
554                 if (xbee_raw) {
555                         int16_t c;
556
557                         /* from xbee to cmdline */
558                         c = xbee_dev_recv(NULL);
559                         if (c >= 0)
560                                 cmdline_dev_send((uint8_t)c, NULL);
561
562                         /* from cmdline to xbee */
563                         c = cmdline_dev_recv(NULL);
564                         if (c == 4) { /* CTRL-d */
565                                 xbee_dev_send('A', NULL);
566                                 xbee_dev_send('T', NULL);
567                                 xbee_dev_send('C', NULL);
568                                 xbee_dev_send('N', NULL);
569                                 xbee_dev_send('\n', NULL);
570                                 xbee_raw = 0;
571                                 rdline_newline(&xbeeboard.rdl,
572                                                xbeeboard.prompt);
573                         }
574                         else if (c >= 0) {
575                                 /* send to xbee */
576                                 xbee_dev_send((uint8_t)c, NULL);
577
578                                 /* echo on cmdline */
579                                 cmdline_dev_send((uint8_t)c, NULL);
580                         }
581                 }
582                 else {
583                         if (xbee_cmdline_input_enabled)
584                                 cmdline_poll();
585                         xbee_rx(xbee_dev);
586                 }
587         }
588 }
589
590 /* return time in milliseconds on unsigned 16 bits */
591 static uint16_t get_time_ms(void)
592 {
593         return global_ms;
594 }
595
596 static void main_timer_interrupt(void)
597 {
598         static uint16_t cycles;
599         static uint8_t cpt;
600
601         cpt++;
602
603         /* interrupt every 2048 cycles */
604         cycles += 2048;
605         if (cycles >= 12000) {
606                 cycles -= 12000;
607                 global_ms ++;
608         }
609
610         /* LED blink */
611         if (global_ms & 0x80)
612                 LED1_ON();
613         else
614                 LED1_OFF();
615
616         if (cpt & beep_mask)
617                 BUZZER_ON();
618         else
619                 BUZZER_OFF();
620
621         /* call scheduler every 682us with interrupt unlocked */
622         sei();
623         if ((cpt & 0x3) == 0)
624                 scheduler_interrupt();
625 }
626
627 int main(void)
628 {
629         //struct callout t1;
630         FILE *xbee_file;
631         int8_t err;
632         struct xbee_dev dev;
633
634         DDRA = 0x07 /* LEDs */ | 0x10 /* buzzer */;
635
636         uart_init();
637         uart_register_rx_event(CMDLINE_UART, emergency);
638
639         fdevopen(cmdline_dev_send, cmdline_dev_recv);
640         xbee_file = fdevopen(xbee_dev_send, xbee_dev_recv);
641         scheduler_init();
642         timer_init();
643         timer0_register_OV_intr(main_timer_interrupt);
644
645         cmdline_init();
646         spi_servo_init();
647         beep_init();
648
649         printf_P(PSTR("\r\n"));
650         rdline_newline(&xbeeboard.rdl, xbeeboard.prompt);
651
652         callout_manager_init(&cm, get_time_ms);
653         //callout_reset(&cm, &t1, 500, PERIODICAL, do_led_blink, NULL);
654
655         /* initialize libxbee */
656         err = xbee_init();
657         if (err < 0)
658                 return -1;
659
660         xbee_dev = &dev;
661
662         /* open xbee device */
663         if (xbee_open(xbee_dev, xbee_file) < 0)
664                 return -1;
665
666         /* register default channel with a callback */
667         if (xbee_register_channel(xbee_dev, XBEE_DEFAULT_CHANNEL,
668                                   xbeeapp_rx, NULL) < 0) {
669                 fprintf(stderr, "cannot register default channel\n");
670                 return -1;
671         }
672         sei();
673
674         eeprom_load_config();
675         xbee_mainloop();
676         return 0;
677 }