modules/devices/radio/xbee/xbee_stats.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_STATS_H_
  29 #define _XBEE_STATS_H_
  30
  31 /* per-device statistics */
  32 struct xbee_stats {
  33         uint32_t rx_frame;
  34         uint32_t rx_atresp;
  35         uint32_t rx_atresp_error;
  36         uint32_t rx_modem_status;
  37         uint32_t rx_xmit_status;
  38         uint32_t rx_xmit_status_error;
  39         uint32_t rx_data;
  40         uint32_t rx_expl_data;
  41         uint32_t rx_node_id;
  42         uint32_t rx_rmt_atresp;
  43         uint32_t rx_rmt_atresp_error;
  44         uint32_t rx_frame_too_small;
  45         uint32_t rx_frame_too_large;
  46         uint32_t rx_invalid_cksum;
  47         uint32_t rx_invalid_type;
  48         uint32_t rx_no_delim;
  49         uint32_t rx_usr_error;
  50
  51         uint32_t tx_frame;
  52         uint32_t tx_atcmd;
  53         uint32_t tx_atcmd_q;
  54         uint32_t tx_data;
  55         uint32_t tx_expl_data;
  56         uint32_t tx_xmit_retries;
  57         uint32_t tx_rmt_atcmd;
  58         uint32_t tx_invalid_type;
  59         uint32_t tx_invalid_channel;
  60 };
  61
  62 struct xbee_dev;
  63
  64 /* return pointer to device stats */
  65 struct xbee_stats *xbee_get_stats(struct xbee_dev *dev);
  66
  67 /* reset statistics of device */
  68 void xbee_reset_stats(struct xbee_dev *dev);
  69
  70 /* dump statistics on stdout */
  71 void xbee_dump_stats(struct xbee_dev *dev);
  72
  73 #endif /* _XBEE_STATS_H_ */