drivers/chibi/chb.h

   1 /*******************************************************************
   2     Copyright (C) 2009 FreakLabs
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     1. Redistributions of source code must retain the above copyright
  10        notice, this list of conditions and the following disclaimer.
  11     2. Redistributions in binary form must reproduce the above copyright
  12        notice, this list of conditions and the following disclaimer in the
  13        documentation and/or other materials provided with the distribution.
  14     3. Neither the name of the the copyright holder nor the names of its contributors
  15        may be used to endorse or promote products derived from this software
  16        without specific prior written permission.
  17
  18     THIS SOFTWARE IS PROVIDED BY THE THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
  19     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21     ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  22     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24     OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28     SUCH DAMAGE.
  29
  30     Originally written by Christopher Wang aka Akiba.
  31     Please post support questions to the FreakLabs forum.
  32
  33 *******************************************************************/
  34 #ifndef CHIBI_H
  35 #define CHIBI_H
  36
  37 #include "types.h"
  38
  39 #define CHB_HDR_SZ        9    // FCF + seq + pan_id + dest_addr + src_addr (2 + 1 + 2 + 2 + 2)
  40 #define CHB_FCS_LEN       2
  41 #define CHB_MAX_PAYLOAD   100
  42
  43
  44 // frame_type = data
  45 // security enabled = false
  46 // frame pending = false
  47 // ack request = false
  48 // pan ID compression = true
  49 #define CHB_FCF_BYTE_0    0x41
  50
  51 // dest addr = 16-bit
  52 // frame version = 802.15.4 (not 2003)
  53 // src addr = 16-bit
  54 #define CHB_FCF_BYTE_1    0x98
  55
  56 #define CHB_ACK_REQ_POS   5
  57
  58 enum
  59 {
  60     CHB_SUCCESS                 = 0,
  61     CHB_SUCCESS_DATA_PENDING    = 1,
  62     CHB_CHANNEL_ACCESS_FAILURE  = 3,
  63     CHB_NO_ACK                  = 5,
  64     CHB_INVALID                 = 7
  65 };
  66
  67 // Chibi Protocol control block
  68 typedef struct
  69 {
  70     U16 src_addr;
  71     U8 seq;
  72     volatile bool data_rcv;
  73     volatile bool tx_end;
  74
  75     // stats
  76     U16 rcvd_xfers;
  77     U16 txd_success;
  78     U16 txd_noack;
  79     U16 txd_channel_fail;
  80     U16 overflow;
  81     U16 underrun;
  82     U8 battlow;
  83     U8 ed;
  84     U8 crc;
  85 } chb_pcb_t;
  86
  87 typedef struct
  88 {
  89     U8 len;
  90     U16 src_addr;
  91     U16 dest_addr;
  92     U8 data[CHB_MAX_PAYLOAD];
  93 } chb_rx_data_t;
  94
  95 void chb_init();
  96 chb_pcb_t *chb_get_pcb();
  97 U8 chb_write(U16 addr, U8 *data, U8 len);
  98 U8 chb_read(chb_rx_data_t *rx);
  99
 100 #endif