modules/devices/radio/xbee/xbee_neighbor.h

   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 #ifndef _XBEE_NEIGHBOR_H_
  29 #define _XBEE_NEIGHBOR_H_
  30
  31 #include <aversive/queue.h>
  32
  33 struct xbee_neigh {
  34         LIST_ENTRY(xbee_neigh) next;
  35         char name[21];
  36         uint64_t addr;
  37 };
  38
  39 struct xbee_dev;
  40
  41 /* define struct xbee_neigh_list */
  42 LIST_HEAD(xbee_neigh_list, xbee_neigh);
  43
  44 /* init neighbor list of an xbee device */
  45 void xbee_neigh_init(struct xbee_dev *dev);
  46
  47 /* return a neighbor from its name */
  48 struct xbee_neigh *xbee_neigh_lookup(struct xbee_dev *dev, const char *name);
  49
  50 /* return a neighbor from its address (in host order) */
  51 struct xbee_neigh *xbee_neigh_rlookup(struct xbee_dev *dev, uint64_t addr);
  52
  53 /* add a neighbor */
  54 struct xbee_neigh *xbee_neigh_add(struct xbee_dev *dev, const char *name,
  55                                   uint64_t addr);
  56
  57 /* del a neighbor from list */
  58 void xbee_neigh_del(struct xbee_dev *dev, struct xbee_neigh *neigh);
  59
  60 #endif /* _XBEE_NEIGHBOR_H_ */