Blame view

RIOT/drivers/ethos/ethos.c 8.73 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
  /*
   * Copyright (C) 2016 Kaspar Schleiser <kaspar@schleiser.de>
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @ingroup     drivers_ethos
   * @{
   *
   * @file
   * @brief       Implementation of a simple ethernet-over-serial driver
   *
   * @author      Kaspar Schleiser <kaspar@schleiser.de>
   *
   * @}
   */
  
  #include <assert.h>
  #include <errno.h>
  #include <string.h>
  
  #include "random.h"
  #include "ethos.h"
  #include "periph/uart.h"
  #include "tsrb.h"
  #include "irq.h"
  
  #include "net/netdev.h"
  #include "net/netdev/eth.h"
  #include "net/eui64.h"
  #include "net/ethernet.h"
  
  #ifdef USE_ETHOS_FOR_STDIO
  #include "uart_stdio.h"
  #include "isrpipe.h"
  extern isrpipe_t uart_stdio_isrpipe;
  #endif
  
  #define ENABLE_DEBUG (0)
  #include "debug.h"
  
  static void _get_mac_addr(netdev_t *dev, uint8_t* buf);
  static void ethos_isr(void *arg, uint8_t c);
  static const netdev_driver_t netdev_driver_ethos;
  
  static const uint8_t _esc_esc[] = {ETHOS_ESC_CHAR, (ETHOS_ESC_CHAR ^ 0x20)};
  static const uint8_t _esc_delim[] = {ETHOS_ESC_CHAR, (ETHOS_FRAME_DELIMITER ^ 0x20)};
  
  
  void ethos_setup(ethos_t *dev, const ethos_params_t *params)
  {
      dev->netdev.driver = &netdev_driver_ethos;
      dev->uart = params->uart;
      dev->state = WAIT_FRAMESTART;
      dev->framesize = 0;
      dev->frametype = 0;
      dev->last_framesize = 0;
  
      tsrb_init(&dev->inbuf, (char*)params->buf, params->bufsize);
      mutex_init(&dev->out_mutex);
  
      uint32_t a = random_uint32();
      memcpy(dev->mac_addr, (char*)&a, 4);
      a = random_uint32();
      memcpy(dev->mac_addr+4, (char*)&a, 2);
  
      dev->mac_addr[0] &= (0x2);      /* unset globally unique bit */
      dev->mac_addr[0] &= ~(0x1);     /* set unicast bit*/
  
      uart_init(params->uart, params->baudrate, ethos_isr, (void*)dev);
  
      uint8_t frame_delim = ETHOS_FRAME_DELIMITER;
      uart_write(dev->uart, &frame_delim, 1);
      ethos_send_frame(dev, dev->mac_addr, 6, ETHOS_FRAME_TYPE_HELLO);
  }
  
  static void _reset_state(ethos_t *dev)
  {
      dev->state = WAIT_FRAMESTART;
      dev->frametype = 0;
      dev->framesize = 0;
  }
  
  static void _handle_char(ethos_t *dev, char c)
  {
      switch (dev->frametype) {
          case ETHOS_FRAME_TYPE_DATA:
          case ETHOS_FRAME_TYPE_HELLO:
          case ETHOS_FRAME_TYPE_HELLO_REPLY:
               if (tsrb_add_one(&dev->inbuf, c) == 0) {
                  dev->framesize++;
              } else {
                  //puts("lost frame");
                  dev->inbuf.reads = 0;
                  dev->inbuf.writes = 0;
                  _reset_state(dev);
              }
              break;
  #ifdef USE_ETHOS_FOR_STDIO
          case ETHOS_FRAME_TYPE_TEXT:
              dev->framesize++;
              isrpipe_write_one(&uart_stdio_isrpipe, c);
  #endif
      }
  }
  
  static void _end_of_frame(ethos_t *dev)
  {
      switch(dev->frametype) {
          case ETHOS_FRAME_TYPE_DATA:
              if (dev->framesize) {
                  dev->last_framesize = dev->framesize;
                  dev->netdev.event_callback((netdev_t*) dev, NETDEV_EVENT_ISR);
              }
              break;
          case ETHOS_FRAME_TYPE_HELLO:
              ethos_send_frame(dev, dev->mac_addr, 6, ETHOS_FRAME_TYPE_HELLO_REPLY);
              /* fall through */
          case ETHOS_FRAME_TYPE_HELLO_REPLY:
              if (dev->framesize == 6) {
                  tsrb_get(&dev->inbuf, (char*)dev->remote_mac_addr, 6);
              }
              break;
      }
  
      _reset_state(dev);
  }
  
  static void ethos_isr(void *arg, uint8_t c)
  {
      ethos_t *dev = (ethos_t *) arg;
  
      switch (dev->state) {
          case WAIT_FRAMESTART:
              if (c == ETHOS_FRAME_DELIMITER) {
                  _reset_state(dev);
                  dev->state = IN_FRAME;
              }
              break;
          case IN_FRAME:
              if (c == ETHOS_ESC_CHAR) {
                  dev->state = IN_ESCAPE;
              }
              else if (c == ETHOS_FRAME_DELIMITER) {
                  if (dev->framesize) {
                      _end_of_frame(dev);
                  }
              }
              else {
                  _handle_char(dev, c);
              }
              break;
          case IN_ESCAPE:
              switch (c) {
                  case (ETHOS_FRAME_DELIMITER ^ 0x20):
                      _handle_char(dev, ETHOS_FRAME_DELIMITER);
                      break;
                  case (ETHOS_ESC_CHAR ^ 0x20):
                      _handle_char(dev, ETHOS_ESC_CHAR);
                      break;
                  case (ETHOS_FRAME_TYPE_TEXT ^ 0x20):
                      dev->frametype = ETHOS_FRAME_TYPE_TEXT;
                      break;
                  case (ETHOS_FRAME_TYPE_HELLO ^ 0x20):
                      dev->frametype = ETHOS_FRAME_TYPE_HELLO;
                      break;
                  case (ETHOS_FRAME_TYPE_HELLO_REPLY ^ 0x20):
                      dev->frametype = ETHOS_FRAME_TYPE_HELLO_REPLY;
                      break;
              }
              dev->state = IN_FRAME;
              break;
      }
  }
  
  static void _isr(netdev_t *netdev)
  {
      ethos_t *dev = (ethos_t *) netdev;
      dev->netdev.event_callback((netdev_t*) dev, NETDEV_EVENT_RX_COMPLETE);
  }
  
  static int _init(netdev_t *encdev)
  {
      ethos_t *dev = (ethos_t *) encdev;
      (void)dev;
      return 0;
  }
  
  static size_t iovec_count_total(const struct iovec *vector, int count)
  {
      size_t result = 0;
      while(count--) {
          result += vector->iov_len;
          vector++;
      }
      return result;
  }
  
  static void _write_escaped(uart_t uart, uint8_t c)
  {
      uint8_t *out;
      int n;
  
      switch(c) {
          case ETHOS_FRAME_DELIMITER:
              out = (uint8_t*)_esc_delim;
              n = 2;
              break;
          case ETHOS_ESC_CHAR:
              out = (uint8_t*)_esc_esc;
              n = 2;
              break;
          default:
              out = &c;
              n = 1;
      }
  
      uart_write(uart, out, n);
  }
  
  void ethos_send_frame(ethos_t *dev, const uint8_t *data, size_t len, unsigned frame_type)
  {
      uint8_t frame_delim = ETHOS_FRAME_DELIMITER;
  
      if (!irq_is_in()) {
          mutex_lock(&dev->out_mutex);
      }
      else {
          /* Send frame delimiter. This cancels the current frame,
           * but enables in-ISR writes.  */
          uart_write(dev->uart, &frame_delim, 1);
      }
  
      /* send frame delimiter */
      uart_write(dev->uart, &frame_delim, 1);
  
      /* set frame type */
      if (frame_type) {
          uint8_t out[2] = { ETHOS_ESC_CHAR, (frame_type ^ 0x20) };
          uart_write(dev->uart, out, 2);
      }
  
      /* send frame content */
      while(len--) {
          _write_escaped(dev->uart, *(uint8_t*)data++);
      }
  
      /* end of frame */
      uart_write(dev->uart, &frame_delim, 1);
  
      if (!irq_is_in()) {
          mutex_unlock(&dev->out_mutex);
      }
  }
  
  static int _send(netdev_t *netdev, const struct iovec *vector, unsigned count)
  {
      ethos_t * dev = (ethos_t *) netdev;
      (void)dev;
  
      /* count total packet length */
      size_t pktlen = iovec_count_total(vector, count);
  
      /* lock line in order to prevent multiple writes */
      mutex_lock(&dev->out_mutex);
  
      /* send start-frame-delimiter */
      uint8_t frame_delim = ETHOS_FRAME_DELIMITER;
      uart_write(dev->uart, &frame_delim, 1);
  
      /* send iovec */
      while(count--) {
          size_t n = vector->iov_len;
          uint8_t *ptr = vector->iov_base;
          while(n--) {
              _write_escaped(dev->uart, *ptr++);
          }
          vector++;
      }
  
      uart_write(dev->uart, &frame_delim, 1);
  
      mutex_unlock(&dev->out_mutex);
  
      return pktlen;
  }
  
  static void _get_mac_addr(netdev_t *encdev, uint8_t* buf)
  {
      ethos_t * dev = (ethos_t *) encdev;
      memcpy(buf, dev->mac_addr, 6);
  }
  
  static int _recv(netdev_t *netdev, void *buf, size_t len, void* info)
  {
      (void) info;
      ethos_t * dev = (ethos_t *) netdev;
  
      if (buf) {
          if (len < (int)dev->last_framesize) {
              DEBUG("ethos _recv(): receive buffer too small.\n");
              return -1;
          }
  
          len = dev->last_framesize;
          dev->last_framesize = 0;
  
          if ((tsrb_get(&dev->inbuf, buf, len) != len)) {
              DEBUG("ethos _recv(): inbuf doesn't contain enough bytes.\n");
              return -1;
          }
  
          return (int)len;
      }
      else {
          return dev->last_framesize;
      }
  }
  
  static int _get(netdev_t *dev, netopt_t opt, void *value, size_t max_len)
  {
      int res = 0;
  
      switch (opt) {
          case NETOPT_ADDRESS:
              if (max_len < ETHERNET_ADDR_LEN) {
                  res = -EINVAL;
              }
              else {
                  _get_mac_addr(dev, (uint8_t*)value);
                  res = ETHERNET_ADDR_LEN;
              }
              break;
          default:
              res = netdev_eth_get(dev, opt, value, max_len);
              break;
      }
  
      return res;
  }
  
  /* netdev interface */
  static const netdev_driver_t netdev_driver_ethos = {
      .send = _send,
      .recv = _recv,
      .init = _init,
      .isr = _isr,
      .get = _get,
      .set = netdev_eth_set
  };