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