c6f13e3715dee230db91032bf872529e68e1b394
[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\r\n"), atcmd_str, result->u8);
207         else if (cmd.flags & XBEE_ATCMD_F_PARAM_U16 && len == sizeof(uint16_t))
208                 printf_P(PSTR("<%s> is 0x%x\r\n"),
209                          atcmd_str,
210                          ntohs(result->u16));
211         else if (cmd.flags & XBEE_ATCMD_F_PARAM_U32 && len == sizeof(uint32_t))
212                 printf_P(PSTR("<%s> is 0x%"PRIx32"\r\n"),
213                          atcmd_str,
214                          ntohl(result->u32));
215         else if (cmd.flags & XBEE_ATCMD_F_PARAM_S16 && len == sizeof(int16_t))
216                 printf_P(PSTR("<%s> is %d\r\n"), atcmd_str, ntohs(result->s16));
217         else if (len == 0)
218                 printf_P(PSTR("no data, status ok\r\n"));
219         else
220                 hexdump("atcmd answer", frame->data, len);
221
222
223         return 0;
224 }
225
226
227 int xbee_recv_data(struct xbee_recv_hdr *recvframe, unsigned len)
228 {
229         unsigned int datalen;
230         struct rc_proto_hdr *rch = (struct rc_proto_hdr *) &recvframe->data;
231
232         if (len <  sizeof(*recvframe))
233                 return -1;
234
235         datalen = len - sizeof(*recvframe);
236         if (datalen < sizeof(struct rc_proto_hdr))
237                 return -1;
238
239         switch (rch->type) {
240 #if 0
241                 case RC_PROTO_TYPE_CHANNEL: {
242                         struct rc_proto_channel *rcc =
243                                 (struct rc_proto_channel *) recvframe->data;
244                         int16_t val;
245                         if (datalen != sizeof(struct rc_proto_channel))
246                                 return -1;
247                         val = ntohs(rcc->axis[0]);
248                         val >>= 6;
249                         val += 512;
250                         spi_servo_set(0, val);
251                         break;
252                 }
253                 case RC_PROTO_TYPE_RANGE: {
254                         struct rc_proto_range *rcr =
255                                 (struct rc_proto_range *) recvframe->data;
256
257                         if (datalen != sizeof(struct rc_proto_range))
258                                 return -1;
259
260                         if (rcr->power_level >= MAX_POWER_LEVEL)
261                                 return -1;
262
263                         rc_proto_rx_range(rcr->power_level);
264
265                         break;
266                 }
267 #endif
268                 default:
269                         return -1;
270         }
271
272         return 0;
273 }
274
275 /* socat /dev/ttyUSB0,raw,echo=0,b115200 /dev/ttyACM1,raw,echo=0,b115200 */
276 void xbeeapp_rx(struct xbee_dev *dev, int channel, int type,
277              void *frame, unsigned len, void *opaque)
278 {
279         struct xbee_ctx *ctx = opaque;
280         int do_hexdump = xbee_hexdump;
281
282         if (xbee_debug)
283                 printf_P(PSTR("type=0x%x, channel=%d, ctx=%p\r\n"),
284                          type, channel, ctx);
285
286         /* if ctx is !NULL, it is an answer to a query */
287         if (ctx != NULL) {
288                 /* XXX only delete timeout if answer matched */
289                 xbee_unload_timeout(ctx);
290                 if (xbee_debug && ctx->atcmd_query)
291                         printf_P(PSTR("Received answer to query <%c%c>\r\n"),
292                                  ctx->atcmd_query[0], ctx->atcmd_query[1]);
293         }
294
295         /* some additional checks before sending */
296         switch (type) {
297                 case XBEE_TYPE_MODEM_STATUS: {
298                         printf_P(PSTR("Received Modem Status frame\r\n"));
299                         break;
300                 }
301
302                 case XBEE_TYPE_RMT_ATRESP: {
303                         union {
304                                 uint64_t u64;
305                                 struct {
306 #if BYTE_ORDER == LITTLE_ENDIAN
307                                         uint32_t low;
308                                         uint32_t high;
309 #else
310                                         uint32_t high;
311                                         uint32_t low;
312 #endif
313                                 } u32;
314                         } addr;
315                         memcpy(&addr, frame, sizeof(addr));
316                         addr.u64 = ntohll(addr.u64);
317                         printf_P(PSTR("from remote address %"PRIx32"%"PRIx32"\r\n"),
318                                  addr.u32.high, addr.u32.low);
319
320                         /* this answer contains an atcmd answer at offset 10 */
321                         if (dump_atcmd(ctx, frame + 10, len - 10) < 0)
322                                 do_hexdump = 1;
323                         break;
324                 }
325                 case XBEE_TYPE_ATRESP: {
326                         if (dump_atcmd(ctx, frame, len) < 0)
327                                 do_hexdump = 1;
328                         break;
329                 }
330
331                 case XBEE_TYPE_XMIT_STATUS: {
332                         if (parse_xmit_status(ctx, frame, len) < 0)
333                                 do_hexdump = 1;
334                         break;
335                 }
336
337                 case XBEE_TYPE_RECV: {
338                         if (xbee_recv_data(frame, len) < 0)
339                                 do_hexdump = 1;
340                         break;
341                 }
342
343                 case XBEE_TYPE_ATCMD:
344                 case XBEE_TYPE_ATCMD_Q:
345                 case XBEE_TYPE_XMIT:
346                 case XBEE_TYPE_EXPL_XMIT:
347                 case XBEE_TYPE_RMT_ATCMD:
348                 case XBEE_TYPE_EXPL_RECV:
349                 case XBEE_TYPE_NODE_ID:
350                 default:
351                         printf_P(PSTR("Invalid frame\r\n"));
352                         do_hexdump = 1;
353                         break;
354         }
355
356         if (do_hexdump)
357                 hexdump("undecoded rx frame", frame, len);
358
359         /* restart command line if it was a blocking query */
360         if (ctx != NULL) {
361                 xbee_unregister_channel(dev, channel);
362                 if (ctx->foreground) {
363                         xbee_stdin_enable();
364                         rdline_newline(&xbeeboard.rdl, xbeeboard.prompt);
365                 }
366         }
367 }
368
369 static int xbeeapp_send(struct xbee_ctx *ctx, int type, void *buf, unsigned len,
370                         int foreground)
371 {
372         int ret;
373         int channel;
374
375         if (len > XBEE_MAX_FRAME_LEN) {
376                 printf_P(PSTR("frame too large\r\n"));
377                 return -1;
378         }
379
380         /* register a channel */
381         channel = xbee_register_channel(xbee_dev, XBEE_CHANNEL_ANY,
382                                         xbeeapp_rx, NULL);
383         if (channel < 0) {
384                 printf_P(PSTR("cannot send: no free channel\r\n"));
385                 return -1;
386         }
387
388         /* copy context in the static struct table (avoiding a malloc) */
389         memcpy(&xbee_ctx[channel], ctx, sizeof(*ctx));
390         ctx = &xbee_ctx[channel];
391         xbee_set_opaque(xbee_dev, channel, ctx);
392
393         if (xbee_debug)
394                 printf_P(PSTR("send frame channel=%d type=0x%x len=%d\r\n"),
395                          channel, type, len);
396         if (xbee_hexdump)
397                 hexdump("xmit frame", buf, len);
398
399         /* transmit the frame on this channel */
400         ret = xbee_tx(xbee_dev, channel, type, buf, len);
401         if (ret < 0) {
402                 printf_P(PSTR("cannot send\r\n"));
403                 xbee_unregister_channel(xbee_dev, channel);
404                 return -1;
405         }
406
407         ctx->channel = channel;
408         xbee_load_timeout(ctx);   /* load a timeout event */
409
410         /* suspend command line until we have answer or timeout */
411         if (foreground) {
412                 ctx->foreground = 1;
413                 rdline_stop(&xbeeboard.rdl); /* don't display prompt when return */
414                 xbee_stdin_disable();  /* unload file descriptor polling */
415         }
416
417         return 0;
418 }
419
420 /* send an AT command with parameters filled by caller. Disable
421  * command line until we get the answer or until a timeout occurs */
422 int xbeeapp_send_atcmd(const char *atcmd_str,
423                        void *param, unsigned param_len, int foreground,
424                        int (*func)(void *frame, unsigned len, void *arg), void *arg)
425 {
426         struct xbee_ctx ctx;
427         struct {
428                 struct xbee_atcmd_hdr atcmd;
429                 char buf[XBEE_MAX_FRAME_LEN];
430         } __attribute__((packed)) frame;
431
432         memset(&ctx, 0, sizeof(ctx));
433         ctx.atcmd_query[0] = atcmd_str[0];
434         ctx.atcmd_query[1] = atcmd_str[1];
435         ctx.func = func;
436         ctx.arg = arg;
437
438         memcpy(&frame.atcmd.cmd, atcmd_str, 2);
439         memcpy(&frame.buf, param, param_len);
440
441         if (xbeeapp_send(&ctx, XBEE_TYPE_ATCMD, &frame,
442                          sizeof(struct xbee_atcmd_hdr) +
443                          param_len, foreground) < 0) {
444                 return -1;
445         }
446
447         return 0;
448 }
449
450 int xbeeapp_send_msg(uint64_t addr, void *data,
451                      unsigned data_len, int foreground)
452 {
453         struct xbee_ctx ctx;
454         struct {
455                 struct xbee_xmit_hdr xmit;
456                 char buf[XBEE_MAX_FRAME_LEN];
457         } __attribute__((packed)) frame;
458
459         memset(&ctx, 0, sizeof(ctx));
460         ctx.atcmd_query[0] = '\0';
461
462         frame.xmit.dstaddr = htonll(addr);
463         frame.xmit.reserved = htons(0xFFFE);
464         frame.xmit.bcast_radius = 0;
465         frame.xmit.opts = 0;
466         memcpy(&frame.buf, data, data_len);
467
468         if (xbeeapp_send(&ctx, XBEE_TYPE_XMIT, &frame,
469                          sizeof(struct xbee_xmit_hdr) +
470                          data_len, foreground) < 0) {
471                 return -1;
472         }
473
474         return 0;
475 }
476
477 void xbee_stdin_enable(void)
478 {
479         xbee_cmdline_input_enabled = 1;
480 }
481
482 void xbee_stdin_disable(void)
483 {
484         xbee_cmdline_input_enabled = 0;
485 }
486
487 static void evt_timeout(struct callout_manager *cm, struct callout *clt,
488                         void *arg)
489 {
490         struct xbee_ctx *ctx = arg;
491
492         (void)cm;
493         (void)clt;
494
495         printf_P(PSTR("Timeout\r\n"));
496
497         /* restart command line */
498         xbee_stdin_enable();
499         rdline_newline(&xbeeboard.rdl, xbeeboard.prompt);
500
501         /* free event */
502         xbee_unregister_channel(xbee_dev, ctx->channel);
503 }
504
505 void xbee_load_timeout(struct xbee_ctx *ctx)
506 {
507         callout_reset(&cm, &ctx->timeout, TIMEOUT_MS, SINGLE, evt_timeout, ctx);
508 }
509
510 void xbee_unload_timeout(struct xbee_ctx *ctx)
511 {
512         callout_stop(&cm, &ctx->timeout);
513 }
514
515 void bootloader(void)
516 {
517 #define BOOTLOADER_ADDR 0x3f000
518         if (pgm_read_byte_far(BOOTLOADER_ADDR) == 0xff) {
519                 printf_P(PSTR("Bootloader is not present\r\n"));
520                 return;
521         }
522         cli();
523         /* ... very specific :( */
524         TIMSK0 = 0;
525         TIMSK1 = 0;
526         TIMSK2 = 0;
527         TIMSK3 = 0;
528         EIMSK = 0;
529         UCSR0B = 0;
530         UCSR1B = 0;
531         SPCR = 0;
532         TWCR = 0;
533         ACSR = 0;
534         ADCSRA = 0;
535
536         /* XXX */
537         /* __asm__ __volatile__ ("ldi r31,0xf8\n"); */
538         /* __asm__ __volatile__ ("ldi r30,0x00\n"); */
539         /* __asm__ __volatile__ ("eijmp\n"); */
540 }
541
542 void xbee_mainloop(void)
543 {
544         while (1) {
545                 callout_manage(&cm);
546
547                 if (xbee_raw) {
548                         int16_t c;
549
550                         /* from xbee to cmdline */
551                         c = xbee_dev_recv(NULL);
552                         if (c >= 0)
553                                 cmdline_dev_send((uint8_t)c, NULL);
554
555                         /* from cmdline to xbee */
556                         c = cmdline_dev_recv(NULL);
557                         if (c == 4) { /* CTRL-d */
558                                 xbee_dev_send('A', NULL);
559                                 xbee_dev_send('T', NULL);
560                                 xbee_dev_send('C', NULL);
561                                 xbee_dev_send('N', NULL);
562                                 xbee_dev_send('\n', NULL);
563                                 xbee_raw = 0;
564                                 rdline_newline(&xbeeboard.rdl,
565                                                xbeeboard.prompt);
566                         }
567                         else if (c >= 0) {
568                                 /* send to xbee */
569                                 xbee_dev_send((uint8_t)c, NULL);
570
571                                 /* echo on cmdline */
572                                 cmdline_dev_send((uint8_t)c, NULL);
573                         }
574                 }
575                 else {
576                         if (xbee_cmdline_input_enabled)
577                                 cmdline_poll();
578                         xbee_rx(xbee_dev);
579                 }
580         }
581 }
582
583 /* return time in milliseconds on unsigned 16 bits */
584 static uint16_t get_time_ms(void)
585 {
586         return global_ms;
587 }
588
589 static void main_timer_interrupt(void)
590 {
591         static uint16_t cycles;
592         static uint8_t cpt;
593
594         cpt++;
595
596         /* interrupt every 2048 cycles */
597         cycles += 2048;
598         if (cycles >= 12000) {
599                 cycles -= 12000;
600                 global_ms ++;
601         }
602
603         /* LED blink */
604         if (global_ms & 0x80)
605                 LED1_ON();
606         else
607                 LED1_OFF();
608
609         if (cpt & beep_mask)
610                 BUZZER_ON();
611         else
612                 BUZZER_OFF();
613
614         /* call scheduler every 682us with interrupt unlocked */
615         sei();
616         if ((cpt & 0x3) == 0)
617                 scheduler_interrupt();
618 }
619
620 int main(void)
621 {
622         //struct callout t1;
623         FILE *xbee_file;
624         int8_t err;
625         struct xbee_dev dev;
626
627         DDRA = 0x07 /* LEDs */ | 0x10 /* buzzer */;
628
629         uart_init();
630         uart_register_rx_event(CMDLINE_UART, emergency);
631
632         fdevopen(cmdline_dev_send, cmdline_dev_recv);
633         xbee_file = fdevopen(xbee_dev_send, xbee_dev_recv);
634         scheduler_init();
635         timer_init();
636         timer0_register_OV_intr(main_timer_interrupt);
637
638         cmdline_init();
639         spi_servo_init();
640         beep_init();
641
642         printf_P(PSTR("\r\n"));
643         rdline_newline(&xbeeboard.rdl, xbeeboard.prompt);
644
645         callout_manager_init(&cm, get_time_ms);
646         //callout_reset(&cm, &t1, 500, PERIODICAL, do_led_blink, NULL);
647
648         /* initialize libxbee */
649         err = xbee_init();
650         if (err < 0)
651                 return -1;
652
653         xbee_dev = &dev;
654
655         /* open xbee device */
656         if (xbee_open(xbee_dev, xbee_file) < 0)
657                 return -1;
658
659         /* register default channel with a callback */
660         if (xbee_register_channel(xbee_dev, XBEE_DEFAULT_CHANNEL,
661                                   xbeeapp_rx, NULL) < 0) {
662                 fprintf(stderr, "cannot register default channel\n");
663                 return -1;
664         }
665         sei();
666
667         eeprom_load_config();
668         xbee_mainloop();
669         return 0;
670 }