add code to load/save configuration in eeprom
[protos/xbee-avr.git] / xbee_proto.c
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 #include <aversive.h>
29 #include <aversive/pgmspace.h>
30 #include <aversive/queue.h>
31 #include <aversive/endian.h>
32
33 #include <uart.h>
34
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <stdint.h>
38 #include <string.h>
39 #include <ctype.h>
40
41 #include "xbee_neighbor.h"
42 #include "xbee_stats.h"
43 #include "xbee_buf.h"
44 #include "xbee_proto.h"
45 #include "xbee.h"
46
47 /* return -1 if the frame is invalid */
48 static int xbee_proto_parse_atresp(struct xbee_dev *dev, void *buf,
49                                    unsigned len)
50 {
51         struct xbee_atresp_hdr *atresp_hdr;
52
53         dev->stats.rx_atresp++;
54
55         if (len < sizeof(struct xbee_hdr) + sizeof(struct xbee_atresp_hdr)) {
56                 dev->stats.rx_frame_too_small++;
57                 return -1;
58         }
59
60         atresp_hdr = buf + sizeof(struct xbee_hdr);
61
62         /* bad status, but let the frame continue */
63         if (atresp_hdr->status != 0)
64                 dev->stats.rx_atresp_error++;
65
66         return 0;
67 }
68
69 /* return -1 if the frame is invalid */
70 static int xbee_proto_parse_rmt_atresp(struct xbee_dev *dev, void *buf,
71                                    unsigned len)
72 {
73         struct xbee_rmt_atresp_hdr *rmt_atresp_hdr;
74
75         dev->stats.rx_rmt_atresp++;
76
77         if (len < sizeof(struct xbee_hdr) + sizeof(struct xbee_rmt_atresp_hdr)) {
78                 dev->stats.rx_frame_too_small++;
79                 return -1;
80         }
81
82         rmt_atresp_hdr = buf + sizeof(struct xbee_hdr);
83
84         /* bad status, but let the frame continue */
85         if (rmt_atresp_hdr->status != 0)
86                 dev->stats.rx_rmt_atresp_error++;
87
88         return 0;
89 }
90
91 /* return -1 if the frame is invalid */
92 static int xbee_proto_parse_xmit_status(struct xbee_dev *dev, void *buf,
93                                         unsigned len)
94 {
95         struct xbee_xmit_status_hdr *xmit_status_hdr;
96
97         dev->stats.rx_xmit_status++;
98
99         if (len < sizeof(struct xbee_hdr) + sizeof(struct xbee_xmit_status_hdr)) {
100                 dev->stats.rx_frame_too_small++;
101                 return -1;
102         }
103
104         xmit_status_hdr = buf + sizeof(struct xbee_hdr);
105         dev->stats.tx_xmit_retries += xmit_status_hdr->xmit_retry_cnt;
106
107         /* bad status, but let the frame continue */
108         if (xmit_status_hdr->delivery_status != 0)
109                 dev->stats.rx_xmit_status_error++;
110
111         return 0;
112 }
113
114 /* parse the frame stored in the device: return 0 if the frame is
115  * valid, else a negative value */
116 static int xbee_proto_parse_frame(struct xbee_dev *dev)
117 {
118         void *buf = dev->frame;
119         uint8_t len = dev->frame_len;
120         uint8_t hdrlen;
121         struct xbee_hdr *hdr = buf;
122         int i;
123         uint8_t cksum = 0;
124         int channel = XBEE_DEFAULT_CHANNEL;
125
126         dev->stats.rx_frame++;
127
128         switch (hdr->type) {
129                 case XBEE_TYPE_MODEM_STATUS:
130                 case XBEE_TYPE_RECV:
131                 case XBEE_TYPE_EXPL_RECV:
132                         hdrlen = sizeof(struct xbee_hdr) - 1; /* no frame ID */
133                         break;
134                 default:
135                         hdrlen = sizeof(struct xbee_hdr);
136                         break;
137         }
138
139         /* check frame len */
140         if (len < (hdrlen + 1)) {
141                 dev->stats.rx_frame_too_small++;
142                 fprintf_P(stderr, PSTR("Frame too small\r\n"));
143                 return -1;
144         }
145
146         /* validate the cksum */
147         for (i = 3; i < (len - 1); i++)
148                 cksum += ((uint8_t *)buf)[i];
149         cksum = 0xff - cksum;
150         if (cksum != ((uint8_t *)buf)[len-1]) {
151                 fprintf_P(stderr, PSTR("Invalid cksum\r\n"));
152                 dev->stats.rx_invalid_cksum++;
153                 return -1;
154         }
155
156         /* dispatch */
157         switch (hdr->type) {
158                 case XBEE_TYPE_MODEM_STATUS:
159                         dev->stats.rx_modem_status++;
160                         channel = XBEE_DEFAULT_CHANNEL;
161                         break;
162                 case XBEE_TYPE_ATRESP:
163                         if (xbee_proto_parse_atresp(dev, buf, len) < 0)
164                                 return -1;
165                         channel = hdr->id;
166                         break;
167                 case XBEE_TYPE_RMT_ATRESP:
168                         if (xbee_proto_parse_rmt_atresp(dev, buf, len) < 0)
169                                 return -1;
170                         channel = hdr->id;
171                         break;
172                 case XBEE_TYPE_XMIT_STATUS:
173                         if (xbee_proto_parse_xmit_status(dev, buf, len) < 0)
174                                 return -1;
175                         channel = hdr->id;
176                         break;
177                 case XBEE_TYPE_RECV:
178                         dev->stats.rx_data++;
179                         channel = XBEE_DEFAULT_CHANNEL;
180                         break;
181                 case XBEE_TYPE_EXPL_RECV:
182                         dev->stats.rx_expl_data++;
183                         channel = XBEE_DEFAULT_CHANNEL;
184                         break;
185                 case XBEE_TYPE_NODE_ID:
186                         dev->stats.rx_node_id++;
187                         channel = hdr->id; //XXX
188                         break;
189                         /* invalid commands */
190                 case XBEE_TYPE_ATCMD:
191                 case XBEE_TYPE_ATCMD_Q:
192                 case XBEE_TYPE_XMIT:
193                 case XBEE_TYPE_EXPL_XMIT:
194                 case XBEE_TYPE_RMT_ATCMD:
195                 default:
196                         dev->stats.rx_invalid_type++;
197                         break;
198         }
199
200         /* fallback to default channel if not registered */
201         if (channel < 0 || channel >= XBEE_MAX_CHANNEL ||
202             dev->channel[channel].registered == 0)
203                 channel = XBEE_DEFAULT_CHANNEL;
204
205         /* execute the callback if any */
206         if (dev->channel[channel].rx_cb != NULL)
207                 dev->channel[channel].rx_cb(dev, channel, hdr->type,
208                                             buf + hdrlen,
209                                             len - hdrlen - 1,
210                                             dev->channel[channel].arg);
211
212         return 0;
213 }
214
215 int xbee_proto_xmit(struct xbee_dev *dev, uint8_t channel_id, uint8_t type,
216                     void *buf, unsigned len)
217 {
218         struct xbee_hdr hdr;
219         unsigned i;
220         uint8_t cksum = 0;
221
222         /* there is no empty message, so return an error */
223         if (len == 0)
224                 return -1;
225
226         /* prepare an iovec to avoid a copy: prepend a header to the
227          * buffer and append a checksum */
228         hdr.delimiter = XBEE_DELIMITER;
229         hdr.len = htons(len + 2);
230         hdr.type = type;
231         hdr.id = channel_id;
232
233         if (channel_id >= XBEE_MAX_CHANNEL ||
234             dev->channel[channel_id].registered == 0) {
235                 dev->stats.tx_invalid_channel ++;
236                 return -1;
237         }
238
239         /* calculate the cksum */
240         cksum = hdr.type;
241         cksum += hdr.id;
242         for (i = 0; i < len; i++)
243                 cksum += ((uint8_t *)buf)[i];
244         cksum = 0xff - cksum;
245         dev->stats.tx_frame ++;
246
247         /* some additional checks before sending */
248         switch (hdr.type) {
249
250                 case XBEE_TYPE_ATCMD:
251                         // XXX some checks ?
252                         dev->stats.tx_atcmd ++;
253                         break;
254                 case XBEE_TYPE_ATCMD_Q:
255                         dev->stats.tx_atcmd_q ++;
256                         break;
257                 case XBEE_TYPE_XMIT:
258                         dev->stats.tx_data ++;
259                         break;
260                 case XBEE_TYPE_EXPL_XMIT:
261                         dev->stats.tx_expl_data ++;
262                         break;
263                 case XBEE_TYPE_RMT_ATCMD:
264                         dev->stats.tx_rmt_atcmd ++;
265                         break;
266
267                 /* invalid commands */
268                 case XBEE_TYPE_XMIT_STATUS:
269                 case XBEE_TYPE_MODEM_STATUS:
270                 case XBEE_TYPE_ATRESP:
271                 case XBEE_TYPE_RECV:
272                 case XBEE_TYPE_EXPL_RECV:
273                 case XBEE_TYPE_NODE_ID:
274                 case XBEE_TYPE_RMT_ATRESP:
275                 default:
276                         dev->stats.tx_invalid_type ++;
277                         fprintf_P(stderr, PSTR("unhandled xmit type=%x\r\n"),
278                                   hdr.type);
279                         return -1;
280         }
281
282         /* send the frame on the wire */
283         fwrite((uint8_t *)&hdr, 1, sizeof(hdr), dev->file);
284         fwrite((uint8_t *)buf, 1, len, dev->file);
285         fwrite(&cksum, 1, 1, dev->file);
286
287         return 0;
288 }
289
290 void xbee_proto_rx(struct xbee_dev *dev)
291 {
292         uint8_t framelen;
293         struct xbee_hdr *hdr = (struct xbee_hdr *)dev->frame;
294         int c;
295
296         while (1) {
297
298                 /* read from UART */
299                 c = fgetc(dev->file);
300                 if (c == EOF)
301                         break;
302
303                 /* frame too long XXX stats */
304                 if (dev->frame_len >= XBEE_MAX_FRAME_LEN) {
305                         dev->frame_len = 0;
306                         continue;
307                 }
308
309                 if (dev->frame_len == 0 && c != XBEE_DELIMITER)
310                         continue;
311
312                 dev->frame[dev->frame_len++] = c;
313
314                 /* not enough data to read len */
315                 if (dev->frame_len < sizeof(*hdr))
316                         continue;
317
318                 framelen = ntohs(hdr->len);
319                 framelen += 4; /* 1 for delimiter, 2 for len, 1 for cksum */
320
321                 /* frame too long XXX stats */
322                 if (framelen >= XBEE_MAX_FRAME_LEN) {
323                         dev->frame_len = 0;
324                         continue;
325                 }
326
327                 /* not enough data */
328                 if (dev->frame_len < framelen)
329                         continue;
330                 if (xbee_proto_parse_frame(dev) < 0) {
331                         ;//XXX stats
332                 }
333                 dev->frame_len = 0;
334         }
335 }