netdev.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Kaspar Schleiser <kaspar@schleiser.de>
3  * 2015 Ell-i open source co-operative
4  * 2015-2017 Freie Universit├Ąt Berlin
5  * 2014 Martine Lenders <mlenders@inf.fu-berlin.de>
6  *
7  * This file is subject to the terms and conditions of the GNU Lesser General
8  * Public License v2.1. See the file LICENSE in the top level directory for
9  * more details.
10  */
11 
190 #ifndef NET_NETDEV_H
191 #define NET_NETDEV_H
192 
193 #ifdef __cplusplus
194 extern "C" {
195 #endif
196 
197 #include <stdint.h>
198 #include <errno.h>
199 
200 #include "iolist.h"
201 #include "net/netopt.h"
202 #include "kernel_defines.h"
203 
204 #ifdef MODULE_L2FILTER
205 #include "net/l2filter.h"
206 #endif
207 
215 enum {
216  NETDEV_TYPE_UNKNOWN,
217  NETDEV_TYPE_TEST,
218  NETDEV_TYPE_RAW,
219  NETDEV_TYPE_ETHERNET,
220  NETDEV_TYPE_IEEE802154,
221  NETDEV_TYPE_BLE,
222  NETDEV_TYPE_CC110X,
223  NETDEV_TYPE_LORA,
224  NETDEV_TYPE_NRFMIN,
225  NETDEV_TYPE_NRF24L01P_NG,
226  NETDEV_TYPE_SLIP,
227  NETDEV_TYPE_ESP_NOW,
228 };
235 typedef enum {
271  /* expand this list if needed */
273 
280  int16_t rssi;
281  uint8_t lqi;
282 };
283 
287 typedef struct netdev netdev_t;
288 
295 
304 typedef enum {
306  NETDEV_AT86RF215,
307  NETDEV_AT86RF2XX,
308  NETDEV_CC2538,
309  NETDEV_DOSE,
310  NETDEV_ENC28J60,
311  NETDEV_KW41ZRF,
312  NETDEV_MRF24J40,
313  NETDEV_NRF802154,
314  NETDEV_STM32_ETH,
315  NETDEV_CC110X,
316  NETDEV_SX127X,
317  NETDEV_SAM0_ETH,
318  NETDEV_ESP_NOW,
319  NETDEV_NRF24L01P_NG,
320  NETDEV_SOCKET_ZEP,
321  NETDEV_SX126X,
322  NETDEV_CC2420,
323  NETDEV_ETHOS,
324  NETDEV_SLIPDEV,
325  /* add more if needed */
326 } netdev_type_t;
332 #define NETDEV_INDEX_ANY (0xFF)
333 
334 #if DOXYGEN
339 #define CONFIG_NETDEV_REGISTER_SIGNAL 0
340 #endif
341 
351 struct netdev {
352  const struct netdev_driver *driver;
354  void *context;
355 #ifdef MODULE_NETDEV_LAYER
356  netdev_t *lower;
357 #endif
358 #ifdef MODULE_L2FILTER
360 #endif
361 #ifdef MODULE_NETDEV_REGISTER
362  netdev_type_t type;
363  uint8_t index;
364 #endif
365 };
366 
380 void netdev_register_signal(struct netdev *dev, netdev_type_t type, uint8_t index);
381 
390 static inline void netdev_register(struct netdev *dev, netdev_type_t type, uint8_t index)
391 {
392 #ifdef MODULE_NETDEV_REGISTER
393  dev->type = type;
394  dev->index = index;
395 #else
396  (void) dev;
397  (void) type;
398  (void) index;
399 #endif
400 
402  netdev_register_signal(dev, type, index);
403  }
404 }
405 
412 typedef struct netdev_driver {
442  int (*send)(netdev_t *dev, const iolist_t *iolist);
443 
472  int (*confirm_send)(netdev_t *dev, void *info);
473 
509  int (*recv)(netdev_t *dev, void *buf, size_t len, void *info);
510 
521  int (*init)(netdev_t *dev);
522 
539  void (*isr)(netdev_t *dev);
540 
562  int (*get)(netdev_t *dev, netopt_t opt,
563  void *value, size_t max_len);
564 
588  int (*set)(netdev_t *dev, netopt_t opt,
589  const void *value, size_t value_len);
591 
602 static inline int netdev_get_notsup(netdev_t *dev, netopt_t opt,
603  void *value, size_t max_len)
604 {
605  (void)dev;
606  (void)opt;
607  (void)value;
608  (void)max_len;
609  return -ENOTSUP;
610 }
611 
622 static inline int netdev_set_notsup(netdev_t *dev, netopt_t opt,
623  const void *value, size_t value_len)
624 {
625  (void)dev;
626  (void)opt;
627  (void)value;
628  (void)value_len;
629  return -ENOTSUP;
630 }
631 
641 {
642  if (netdev->event_callback) {
644  }
645 }
646 #ifdef __cplusplus
647 }
648 #endif
649 
650 #endif /* NET_NETDEV_H */
#define ENOTSUP
Not supported (may be the same value as [EOPNOTSUPP]).
Definition: errno.h:130
static void netdev_trigger_event_isr(netdev_t *netdev)
Informs netdev there was an interrupt request from the network device.
Definition: netdev.h:640
void netdev_register_signal(struct netdev *dev, netdev_type_t type, uint8_t index)
Signal that the netdev_register function registered the device.
static int netdev_get_notsup(netdev_t *dev, netopt_t opt, void *value, size_t max_len)
Convenience function for declaring get() as not supported in general.
Definition: netdev.h:602
#define CONFIG_NETDEV_REGISTER_SIGNAL
Call netdev_register_signal when the netdev device is registered.
Definition: netdev.h:339
static void netdev_register(struct netdev *dev, netdev_type_t type, uint8_t index)
Register a device with netdev.
Definition: netdev.h:390
netdev_type_t
Driver types for netdev.
Definition: netdev.h:304
struct netdev_driver netdev_driver_t
Structure to hold driver interface -> function mapping.
void(* netdev_event_cb_t)(netdev_t *dev, netdev_event_t event)
Event callback for signaling event to upper layers.
Definition: netdev.h:294
static int netdev_set_notsup(netdev_t *dev, netopt_t opt, const void *value, size_t value_len)
Convenience function for declaring set() as not supported in general.
Definition: netdev.h:622
netdev_event_t
Possible event types that are send from the device driver to the upper layer.
Definition: netdev.h:235
@ NETDEV_ANY
Will match any device type.
Definition: netdev.h:305
@ NETDEV_EVENT_TX_STARTED
started to transfer a frame
Definition: netdev.h:239
@ NETDEV_EVENT_ISR
driver needs it's ISR handled
Definition: netdev.h:236
@ NETDEV_EVENT_LINK_UP
link established
Definition: netdev.h:264
@ NETDEV_EVENT_TX_NOACK
ACK requested but not received.
Definition: netdev.h:256
@ NETDEV_EVENT_RX_COMPLETE
finished receiving a frame
Definition: netdev.h:238
@ NETDEV_EVENT_CRC_ERROR
wrong CRC
Definition: netdev.h:268
@ NETDEV_EVENT_TX_MEDIUM_BUSY
couldn't transfer frame
Definition: netdev.h:263
@ NETDEV_EVENT_TX_TIMEOUT
timeout when sending
Definition: netdev.h:266
@ NETDEV_EVENT_FHSS_CHANGE_CHANNEL
channel changed
Definition: netdev.h:269
@ NETDEV_EVENT_RX_STARTED
started to receive a frame
Definition: netdev.h:237
@ NETDEV_EVENT_TX_COMPLETE_DATA_PENDING
transfer frame complete and data pending flag
Definition: netdev.h:248
@ NETDEV_EVENT_TX_COMPLETE
transfer frame complete
Definition: netdev.h:240
@ NETDEV_EVENT_RX_TIMEOUT
timeout when receiving
Definition: netdev.h:267
@ NETDEV_EVENT_LINK_DOWN
link gone
Definition: netdev.h:265
@ NETDEV_EVENT_CAD_DONE
channel activity detection done
Definition: netdev.h:270
#define CONFIG_L2FILTER_LISTSIZE
Number of slots in each filter list (filter entries per device)
Definition: l2filter.h:59
netopt_t
Global list of configuration options available throughout the network stack, e.g.
Definition: netopt.h:42
iolist scatter / gather IO
Common macros and compiler attributes/pragmas configuration.
#define IS_ACTIVE(macro)
Allows to verify a macro definition outside the preprocessor.
Link layer address filter interface definition.
Definition of global configuration options.
event structure
Definition: event.h:147
iolist structure definition
Definition: iolist.h:39
Filter list entries.
Definition: l2filter.h:70
Structure to hold driver interface -> function mapping.
Definition: netdev.h:412
int(* get)(netdev_t *dev, netopt_t opt, void *value, size_t max_len)
Get an option value from a given network device.
Definition: netdev.h:562
int(* send)(netdev_t *dev, const iolist_t *iolist)
Start transmission of the given frame and return directly.
Definition: netdev.h:442
int(* confirm_send)(netdev_t *dev, void *info)
Fetch the status of a transmission and perform any potential cleanup.
Definition: netdev.h:472
int(* set)(netdev_t *dev, netopt_t opt, const void *value, size_t value_len)
Set an option value for a given network device.
Definition: netdev.h:588
int(* recv)(netdev_t *dev, void *buf, size_t len, void *info)
Drop a received frame, OR get the length of a received frame, OR get a received frame.
Definition: netdev.h:509
int(* init)(netdev_t *dev)
the driver's initialization function
Definition: netdev.h:521
void(* isr)(netdev_t *dev)
a driver's user-space ISR handler
Definition: netdev.h:539
Received frame status information for most radios.
Definition: netdev.h:279
uint8_t lqi
LQI of a received frame.
Definition: netdev.h:281
int16_t rssi
RSSI of a received frame in dBm.
Definition: netdev.h:280
Structure to hold driver state.
Definition: netdev.h:351
const struct netdev_driver * driver
ptr to that driver's interface.
Definition: netdev.h:352
void * context
ptr to network stack context
Definition: netdev.h:354
netdev_event_cb_t event_callback
callback for device events
Definition: netdev.h:353