xbee_user.c

   1 /*
   2  * Copyright (c) 2014, 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 #include <stdio.h>
  29 #include <stdint.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <stddef.h>
  33 #include <ctype.h>
  34
  35 #include <aversive.h>
  36 #include <aversive/endian.h>
  37 #include <aversive/wait.h>
  38 #include <aversive/pgmspace.h>
  39
  40 #include <callout.h>
  41 #include <rdline.h>
  42 #include <xbee.h>
  43 #include <xbee_rxtx.h>
  44
  45 #include "rc_proto.h"
  46 #include "xbee_user.h"
  47 #include "main.h"
  48
  49 #define XBEE_TIMEOUT_MS    1000
  50 #define XBEE_POLL_TIMER_MS 5
  51
  52 static struct xbee_ctx xbee_ctx[XBEE_MAX_CHANNEL];
  53
  54 int xbee_cmdline_input_enabled = 1;
  55
  56 /* parameters */
  57 int xbee_raw = 0;
  58
  59 static struct callout xbee_rx_poll_timer;
  60
  61 static void __hexdump(const void *buf, unsigned int len)
  62 {
  63         unsigned int i, out, ofs;
  64         const unsigned char *data = buf;
  65 #define LINE_LEN 80
  66         char line[LINE_LEN];    /* space needed 8+16*3+3+16 == 75 */
  67
  68         ofs = 0;
  69         while (ofs < len) {
  70                 /* format 1 line in the buffer, then use printk to print them */
  71                 out = snprintf_P(line, LINE_LEN, PSTR("%08X"), ofs);
  72                 for (i=0; ofs+i < len && i<16; i++)
  73                         out += snprintf_P(line+out, LINE_LEN - out,
  74                                           PSTR(" %02X"),
  75                                           data[ofs+i]&0xff);
  76                 for (;i<=16;i++)
  77                         out += snprintf(line+out, LINE_LEN - out, "   ");
  78                 for (i=0; ofs < len && i<16; i++, ofs++) {
  79                         unsigned char c = data[ofs];
  80                         if (!isascii(c) || !isprint(c))
  81                                 c = '.';
  82                         out += snprintf_P(line+out,
  83                                           LINE_LEN - out,
  84                                           PSTR("%c"), c);
  85                 }
  86                 DEBUG(E_USER_XBEE, "%s", line);
  87         }
  88 }
  89
  90 static void hexdump_msg(const char *title, const struct xbee_msg *msg)
  91 {
  92         unsigned i;
  93
  94         DEBUG(E_USER_XBEE, "dump %s", title);
  95
  96         for (i = 0; i < msg->iovlen; i++) {
  97                 DEBUG(E_USER_XBEE, "iovec %d at %p, len=%d", i,
  98                         msg->iov[i].buf, msg->iov[i].len);
  99                 __hexdump(msg->iov[i].buf, msg->iov[i].len);
 100         }
 101 }
 102
 103 void hexdump(const char *title, const void *buf, unsigned int len)
 104 {
 105         DEBUG(E_USER_XBEE, "dump %s at [%p], len=%d", title, buf, len);
 106         __hexdump(buf, len);
 107 }
 108
 109 static int parse_xmit_status(struct xbee_ctx *ctx,
 110         struct xbee_xmit_status_hdr *frame, unsigned len)
 111 {
 112         (void)len;
 113
 114         if (ctx == NULL) {
 115                 ERROR(E_USER_XBEE, "no context");
 116                 return -1;
 117         }
 118
 119         /* see if it matches a xmit query (atcmd_query must be \0) */
 120         if (ctx->atcmd_query[0] != '\0') {
 121                 ERROR(E_USER_XBEE, "invalid response 2");
 122                 return -1;
 123         }
 124
 125         /* XXX use defines for these values */
 126         if (frame->delivery_status == 0x00)
 127                 NOTICE(E_USER_XBEE, "Success");
 128         else if (frame->delivery_status == 0x01)
 129                 WARNING(E_USER_XBEE, "MAC ACK Failure");
 130         else if (frame->delivery_status == 0x15)
 131                 WARNING(E_USER_XBEE, "Invalid destination endpoint");
 132         else if (frame->delivery_status == 0x21)
 133                 WARNING(E_USER_XBEE, "Network ACK Failure");
 134         else if (frame->delivery_status == 0x25)
 135                 WARNING(E_USER_XBEE, "Route Not Found");
 136
 137         return 0;
 138 }
 139
 140 /* Write in a human readable format the content of an atcmd response frame. It
 141  * assumes the frame is valid .*/
 142 void atresp_to_str(char *buf, unsigned len, const struct xbee_atresp_hdr *frame)
 143 {
 144         union {
 145                 uint8_t u8;
 146                 uint16_t u16;
 147                 uint32_t u32;
 148                 int16_t s16;
 149         } __attribute__((packed)) *result;
 150         char atcmd_str[3];
 151         const struct xbee_atcmd *cmd_pgm;
 152         struct xbee_atcmd cmd;
 153
 154         /* get AT command from frame */
 155         memcpy(atcmd_str, &frame->cmd, 2);
 156         atcmd_str[2] = '\0';
 157
 158         /* see if it exists */
 159         cmd_pgm = xbee_atcmd_lookup_name(atcmd_str);
 160         if (cmd_pgm == NULL) {
 161                 snprintf(buf, len, "<%s> (unknown cmd)", atcmd_str);
 162                 return;
 163         }
 164         memcpy_P(&cmd, cmd_pgm, sizeof(cmd));
 165
 166         /* dump frame */
 167         result = (void *)frame->data;
 168         len -= offsetof(struct xbee_atresp_hdr, data);
 169         if (cmd.flags & XBEE_ATCMD_F_PARAM_U8 && len == sizeof(uint8_t))
 170                 snprintf(buf, len, "<%s> is 0x%x (%d)", atcmd_str,
 171                         result->u8, result->u8);
 172         else if (cmd.flags & XBEE_ATCMD_F_PARAM_U16 && len == sizeof(uint16_t))
 173                 snprintf(buf, len, "<%s> is 0x%x (%d)", atcmd_str,
 174                         ntohs(result->u16), ntohs(result->u16));
 175         else if (cmd.flags & XBEE_ATCMD_F_PARAM_U32 && len == sizeof(uint32_t))
 176                 snprintf(buf, len, "<%s> is 0x%"PRIx32" (%"PRIu32")",
 177                         atcmd_str, ntohl(result->u32), ntohl(result->u32));
 178         else if (cmd.flags & XBEE_ATCMD_F_PARAM_S16 && len == sizeof(int16_t))
 179                 snprintf(buf, len, "<%s> is %d",
 180                         atcmd_str, ntohs(result->s16));
 181         else if (len == 0)
 182                 snprintf(buf, len, "<%s> no data", atcmd_str);
 183 }
 184
 185 static int parse_atcmd(struct xbee_ctx *ctx, struct xbee_atresp_hdr *frame,
 186         unsigned len)
 187 {
 188         char atcmd_str[3];
 189         char buf[32];
 190
 191         if (ctx == NULL) {
 192                 ERROR(E_USER_XBEE, "no context");
 193                 return -1;
 194         }
 195
 196         /* get AT command from frame */
 197         memcpy(atcmd_str, &frame->cmd, 2);
 198         atcmd_str[2] = '\0';
 199
 200         /* see if it matches query */
 201         if (memcmp(atcmd_str, ctx->atcmd_query, 2)) {
 202                 ERROR(E_USER_XBEE, "invalid response <%c%c><%s><%s>",
 203                          frame->cmd & 0xFF,
 204                          (frame->cmd >> 8) & 0xFF,
 205                          atcmd_str, ctx->atcmd_query);
 206                 return -1;
 207         }
 208
 209         /* bad status */
 210         if (frame->status == 1) {
 211                 WARNING(E_USER_XBEE, "Status is error");
 212                 return -1;
 213         }
 214         else if (frame->status == 2) {
 215                 WARNING(E_USER_XBEE, "Invalid command");
 216                 return -1;
 217         }
 218         else if (frame->status == 3) {
 219                 WARNING(E_USER_XBEE, "Invalid parameter");
 220                 return -1;
 221         }
 222         else if (frame->status != 0) {
 223                 WARNING(E_USER_XBEE, "Unknown status error %d",
 224                         frame->status);
 225                 return -1;
 226         }
 227
 228         len -= offsetof(struct xbee_atresp_hdr, data);
 229
 230         atresp_to_str(buf, sizeof(buf), frame);
 231         NOTICE(E_USER_XBEE, "status ok, len=%d, %s", len, buf);
 232
 233         if (len != 0)
 234                 hexdump("atcmd answer", frame->data, len);
 235
 236         return 0;
 237 }
 238
 239
 240 /* Main xbee rx entry point for application. It decodes the xbee frame type and
 241  * dispatch to the application layer. Then "len" argument does not include the
 242  * xbee_hdr structure (delimiter, len, type, id) and checksum. */
 243 int8_t xbeeapp_rx(struct xbee_dev *dev, int channel, int type,
 244              void *frame, unsigned len, void *opaque)
 245 {
 246         struct xbee_ctx *ctx = opaque;
 247         int8_t ret = XBEE_USER_RETCODE_OK;
 248
 249         NOTICE(E_USER_XBEE, "type=0x%x, channel=%d, ctx=%p",
 250                 type, channel, ctx);
 251
 252         /* if ctx is !NULL, it is an answer to a query */
 253         if (ctx != NULL) {
 254                 xbee_unload_timeout(ctx);
 255                 if (ctx->atcmd_query)
 256                         NOTICE(E_USER_XBEE, "Received answer to query <%c%c>",
 257                                 ctx->atcmd_query[0], ctx->atcmd_query[1]);
 258         }
 259
 260         /* some additional checks before sending */
 261         switch (type) {
 262                 case XBEE_TYPE_MODEM_STATUS: {
 263                         NOTICE(E_USER_XBEE, "Received Modem Status frame");
 264                         break;
 265                 }
 266
 267                 case XBEE_TYPE_RMT_ATRESP: {
 268                         union {
 269                                 uint64_t u64;
 270                                 struct {
 271 #if BYTE_ORDER == LITTLE_ENDIAN
 272                                         uint32_t low;
 273                                         uint32_t high;
 274 #else
 275                                         uint32_t high;
 276                                         uint32_t low;
 277 #endif
 278                                 } u32;
 279                         } addr;
 280                         memcpy(&addr, frame, sizeof(addr));
 281                         addr.u64 = ntohll(addr.u64);
 282                         NOTICE(E_USER_XBEE,
 283                                 "from remote address %"PRIx32"%"PRIx32"",
 284                                  addr.u32.high, addr.u32.low);
 285
 286                         /* this answer contains an atcmd answer at offset 10 */
 287                         if (parse_atcmd(ctx, frame + 10, len - 10) < 0)
 288                                 ret = XBEE_USER_RETCODE_BAD_FRAME;
 289
 290                         break;
 291                 }
 292                 case XBEE_TYPE_ATRESP: {
 293                         if (parse_atcmd(ctx, frame, len) < 0)
 294                                 ret = XBEE_USER_RETCODE_BAD_FRAME;
 295
 296                         break;
 297                 }
 298
 299                 case XBEE_TYPE_XMIT_STATUS: {
 300                         if (parse_xmit_status(ctx, frame, len) < 0)
 301                                 ret = XBEE_USER_RETCODE_BAD_FRAME;
 302
 303                         break;
 304                 }
 305
 306                 case XBEE_TYPE_RECV: {
 307                         if (rc_proto_rx(frame, len) < 0)
 308                                 ret = XBEE_USER_RETCODE_BAD_FRAME;
 309
 310                         break;
 311                 }
 312
 313                 case XBEE_TYPE_ATCMD:
 314                 case XBEE_TYPE_ATCMD_Q:
 315                 case XBEE_TYPE_XMIT:
 316                 case XBEE_TYPE_EXPL_XMIT:
 317                 case XBEE_TYPE_RMT_ATCMD:
 318                 case XBEE_TYPE_EXPL_RECV:
 319                 case XBEE_TYPE_NODE_ID:
 320                 default:
 321                         ERROR(E_USER_XBEE, "Invalid frame");
 322                         ret = XBEE_USER_RETCODE_BAD_FRAME;
 323                         break;
 324         }
 325
 326         WARNING(E_USER_XBEE, "undecoded rx frame");
 327         hexdump("undecoded rx frame", frame, len);
 328
 329         if (ctx != NULL) {
 330                 /* callback */
 331                 if (ctx->rx_cb != NULL)
 332                         ret = ctx->rx_cb(ret, frame, len, ctx->arg);
 333
 334                 /* free channel now, it implicitely frees the context too */
 335                 xbee_unregister_channel(dev, channel);
 336         }
 337
 338         return ret;
 339 }
 340
 341 /* called with callout prio == XBEE_PRIO */
 342 static int xbeeapp_send(struct xbee_ctx *ctx, int type, struct xbee_msg *msg)
 343 {
 344         int ret;
 345         int channel;
 346
 347         /* register a channel */
 348         channel = xbee_register_channel(xbee_dev, XBEE_CHANNEL_ANY,
 349                                         xbeeapp_rx, NULL);
 350         if (channel < 0) {
 351                 ERROR(E_USER_XBEE, "cannot send: no free channel");
 352                 return -1;
 353         }
 354
 355         /* copy context in the static struct table (avoiding a malloc) */
 356         memcpy(&xbee_ctx[channel], ctx, sizeof(*ctx));
 357         ctx = &xbee_ctx[channel];
 358         xbee_set_opaque(xbee_dev, channel, ctx);
 359
 360         NOTICE(E_USER_XBEE, "send frame channel=%d type=0x%x", channel, type);
 361         hexdump_msg("xmit frame", msg);
 362
 363         /* transmit the frame on this channel */
 364         ret = xbee_tx_iovec(xbee_dev, channel, type, msg);
 365         if (ret < 0) {
 366                 ERROR(E_USER_XBEE, "cannot send");
 367                 xbee_unregister_channel(xbee_dev, channel);
 368                 return -1;
 369         }
 370
 371         ctx->channel = channel;
 372         xbee_load_timeout(ctx);   /* load a timeout event */
 373
 374         return 0;
 375 }
 376
 377 /* send an AT command with parameters filled by caller. param is the argument
 378  * of the atcmd (if any). */
 379 int xbeeapp_send_atcmd(char *atcmd_str, void *param, unsigned param_len,
 380         xbee_user_rx_cb_t *rx_cb, void *arg)
 381 {
 382         struct xbee_ctx ctx;
 383         /* struct xbee_atcmd_hdr atcmd_hdr; -> no needed same than atcmd_str */
 384         struct xbee_msg msg;
 385         uint8_t prio;
 386         int ret;
 387
 388         memset(&ctx, 0, sizeof(ctx));
 389         ctx.atcmd_query[0] = atcmd_str[0];
 390         ctx.atcmd_query[1] = atcmd_str[1];
 391         ctx.rx_cb = rx_cb;
 392         ctx.arg = arg;
 393
 394         msg.iovlen = 2;
 395         msg.iov[0].buf = atcmd_str;
 396         msg.iov[0].len = 2;
 397         msg.iov[1].buf = param;
 398         msg.iov[1].len = param_len;
 399
 400         prio = callout_mgr_set_prio(&xbeeboard.intr_cm, XBEE_PRIO);
 401         if (prio > XBEE_PRIO)
 402                 ERROR(E_USER_XBEE, "invalid prio = %d\n", prio);
 403         ret = xbeeapp_send(&ctx, XBEE_TYPE_ATCMD, &msg);
 404         callout_mgr_restore_prio(&xbeeboard.intr_cm, prio);
 405
 406         return ret;
 407 }
 408
 409 int xbeeapp_send_msg(uint64_t addr, struct xbee_msg *msg,
 410         xbee_user_rx_cb_t *rx_cb, void *arg)
 411 {
 412         struct xbee_ctx ctx;
 413         struct xbee_xmit_hdr xmit_hdr;
 414         struct xbee_msg msg2;
 415         unsigned i;
 416         uint8_t prio;
 417         int ret;
 418
 419         if (msg->iovlen + 2 > XBEE_MSG_MAXIOV) {
 420                 ERROR(E_USER_XBEE, "too many iovecs");
 421                 return -1;
 422         }
 423
 424         xmit_hdr.dstaddr = htonll(addr);
 425         xmit_hdr.reserved = htons(0xFFFE);
 426         xmit_hdr.bcast_radius = 0;
 427         xmit_hdr.opts = 0;
 428
 429         msg2.iovlen = msg->iovlen + 1;
 430         msg2.iov[0].buf = &xmit_hdr;
 431         msg2.iov[0].len = sizeof(xmit_hdr);
 432         for (i = 0; i < msg->iovlen; i++)
 433                 msg2.iov[i+1] = msg->iov[i];
 434
 435         memset(&ctx, 0, sizeof(ctx));
 436         ctx.rx_cb = rx_cb;
 437         ctx.arg = arg;
 438
 439         prio = callout_mgr_set_prio(&xbeeboard.intr_cm, XBEE_PRIO);
 440         if (prio > XBEE_PRIO)
 441                 ERROR(E_USER_XBEE, "invalid prio = %d\n", prio);
 442         ret = xbeeapp_send(&ctx, XBEE_TYPE_XMIT, &msg2);
 443         callout_mgr_restore_prio(&xbeeboard.intr_cm, prio);
 444
 445         return ret;
 446 }
 447
 448 static void evt_timeout(struct callout_mgr *cm, struct callout *clt,
 449         void *arg)
 450 {
 451         struct xbee_ctx *ctx = arg;
 452
 453         (void)cm;
 454         (void)clt;
 455
 456         WARNING(E_USER_XBEE, "Timeout");
 457
 458         /* callback */
 459         if (ctx->rx_cb != NULL)
 460                 ctx->rx_cb(XBEE_USER_RETCODE_TIMEOUT, NULL, 0, ctx->arg);
 461
 462         /* free channel, it implicitely frees the context too */
 463         xbee_unregister_channel(xbee_dev, ctx->channel);
 464         callout_stop(cm, clt);
 465 }
 466
 467 void xbee_load_timeout(struct xbee_ctx *ctx)
 468 {
 469         uint8_t prio;
 470
 471         callout_init(&ctx->timeout, evt_timeout, ctx, XBEE_PRIO);
 472         prio = callout_mgr_set_prio(&xbeeboard.intr_cm, XBEE_PRIO);
 473         callout_schedule(&xbeeboard.intr_cm, &ctx->timeout, XBEE_TIMEOUT_MS);
 474         callout_mgr_restore_prio(&xbeeboard.intr_cm, prio);
 475 }
 476
 477 void xbee_unload_timeout(struct xbee_ctx *ctx)
 478 {
 479         uint8_t prio;
 480
 481         prio = callout_mgr_set_prio(&xbeeboard.intr_cm, XBEE_PRIO);
 482         callout_stop(&xbeeboard.intr_cm, &ctx->timeout);
 483         callout_mgr_restore_prio(&xbeeboard.intr_cm, prio);
 484 }
 485
 486 static void xbee_rx_poll_timer_cb(struct callout_mgr *cm, struct callout *tim,
 487         void *arg)
 488 {
 489         (void) arg;
 490         xbee_rx(xbee_dev);
 491         callout_reschedule(cm, tim, XBEE_POLL_TIMER_MS);
 492 }
 493
 494 void xbee_mainloop(void)
 495 {
 496         uint8_t prio;
 497
 498         while (1) {
 499                 if (xbee_raw) {
 500                         int16_t c;
 501
 502                         /* from xbee to cmdline */
 503                         c = xbee_dev_recv(NULL);
 504                         if (c >= 0)
 505                                 cmdline_dev_send((uint8_t)c, NULL);
 506
 507                         /* from cmdline to xbee */
 508                         c = cmdline_dev_recv(NULL);
 509                         if (c == 4) { /* CTRL-d */
 510                                 prio = callout_mgr_set_prio(&xbeeboard.intr_cm,
 511                                         XBEE_PRIO);
 512                                 xbee_dev_send('A', NULL);
 513                                 xbee_dev_send('T', NULL);
 514                                 xbee_dev_send('C', NULL);
 515                                 xbee_dev_send('N', NULL);
 516                                 xbee_dev_send('\n', NULL);
 517                                 callout_mgr_restore_prio(&xbeeboard.intr_cm, prio);
 518                                 xbee_raw = 0;
 519                                 rdline_newline(&xbeeboard.rdl,
 520                                                xbeeboard.prompt);
 521                         }
 522                         else if (c >= 0) {
 523                                 /* send to xbee */
 524                                 xbee_dev_send((uint8_t)c, NULL);
 525
 526                                 /* echo on cmdline */
 527                                 cmdline_dev_send((uint8_t)c, NULL);
 528                         }
 529                 }
 530                 else {
 531                         if (xbee_cmdline_input_enabled)
 532                                 cmdline_poll();
 533                         /* xbee rx polling is done in a timer, so we can block
 534                          * the cmdline without loosing incoming packets */
 535                 }
 536         }
 537 }
 538
 539 void xbee_stdin_enable(void)
 540 {
 541         xbee_cmdline_input_enabled = 1;
 542 }
 543
 544 void xbee_stdin_disable(void)
 545 {
 546         xbee_cmdline_input_enabled = 0;
 547 }
 548
 549 void xbeeapp_init(void)
 550 {
 551         callout_init(&xbee_rx_poll_timer, xbee_rx_poll_timer_cb,
 552                 NULL, XBEE_PRIO);
 553         callout_schedule(&xbeeboard.intr_cm, &xbee_rx_poll_timer,
 554                 XBEE_POLL_TIMER_MS);
 555 }