xbee_user.h

   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 #ifndef _XBEE_USER_H_
  29 #define _XBEE_USER_H_
  30
  31 #include <callout.h>
  32 #include <xbee_rxtx.h>
  33
  34 /* used for timeouts and xbee rx callback */
  35 struct xbee_ctx {
  36         int foreground;
  37         int channel;
  38         char atcmd_query[2];
  39         int (*func)(void *frame, unsigned len, void *arg);
  40         void *arg;
  41         struct callout timeout;
  42 };
  43
  44 //extern cmdline_parse_ctx_t main_ctx;
  45 extern struct xbee_dev *xbee_dev;
  46 extern int xbee_raw;
  47
  48 /* we use a specific structure to send packets. It allows to prepend some
  49  * data in the frame without doing a copy. */
  50 struct xbeeapp_pkt {
  51         char *buf;
  52         unsigned len;
  53         unsigned headroom;
  54         unsigned tailroom;
  55 };
  56
  57 /* callback registered to xbee module, called when a xbee frame is received */
  58 int8_t xbeeapp_rx(struct xbee_dev *dev, int channel, int type,
  59         void *frame, unsigned len, void *opaque);
  60
  61 /* Send an AT command to the xbee device. The callback function for the answer
  62  * is given as a parameter */
  63 int xbeeapp_send_atcmd(char *atcmd_str, void *param,
  64         unsigned param_len, int foreground,
  65         int (*func)(void *frame, unsigned len, void *arg),
  66         void *arg);
  67
  68 /* send a message to a peer */
  69 int xbeeapp_send_msg(uint64_t addr, struct xbee_msg *msg, int foreground);
  70
  71 void xbee_stdin_enable(void);
  72 void xbee_stdin_disable(void);
  73
  74 void xbee_load_timeout(struct xbee_ctx *ctx);
  75 void xbee_unload_timeout(struct xbee_ctx *ctx);
  76
  77 void xbee_mainloop(void);
  78
  79 void xbeeapp_init(void);
  80
  81 #endif /* _XBEE_USER_H_ */