netdev.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-FileCopyrightText: 2015 Ell-i open source co-operative
 * SPDX-FileCopyrightText: 2015-2017 Freie Universität Berlin
 * SPDX-FileCopyrightText: 2014 Martine Lenders <mlenders@inf.fu-berlin.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <errno.h>
 
#include "iolist.h"
#include "net/netopt.h"
#include "kernel_defines.h"
 
#ifdef MODULE_L2FILTER
#include "net/l2filter.h"
#endif

enum {
    NETDEV_TYPE_UNKNOWN,
    NETDEV_TYPE_TEST,
    NETDEV_TYPE_RAW,
    NETDEV_TYPE_ETHERNET,
    NETDEV_TYPE_IEEE802154,
    NETDEV_TYPE_BLE,
    NETDEV_TYPE_CC110X,
    NETDEV_TYPE_LORA,
    NETDEV_TYPE_NRFMIN,
    NETDEV_TYPE_NRF24L01P_NG,
    NETDEV_TYPE_SLIP,
    NETDEV_TYPE_ESP_NOW,
};

typedef enum {
    NETDEV_EVENT_ISR,                       
    NETDEV_EVENT_RX_STARTED,                
    NETDEV_EVENT_RX_COMPLETE,               
    NETDEV_EVENT_TX_STARTED,                
    NETDEV_EVENT_TX_COMPLETE,               
#if IS_USED(MODULE_NETDEV_LEGACY_API) || DOXYGEN
    NETDEV_EVENT_TX_COMPLETE_DATA_PENDING,
    NETDEV_EVENT_TX_NOACK,
    NETDEV_EVENT_TX_MEDIUM_BUSY,
#endif
    NETDEV_EVENT_LINK_UP,                   
    NETDEV_EVENT_LINK_DOWN,                 
    NETDEV_EVENT_TX_TIMEOUT,                
    NETDEV_EVENT_RX_TIMEOUT,                
    NETDEV_EVENT_CRC_ERROR,                 
    NETDEV_EVENT_FHSS_CHANGE_CHANNEL,       
    NETDEV_EVENT_CAD_DONE,                  
    /* expand this list if needed */
} netdev_event_t;

struct netdev_radio_rx_info {
    int16_t rssi;       
    uint8_t lqi;        
};

typedef struct netdev netdev_t;

typedef void (*netdev_event_cb_t)(netdev_t *dev, netdev_event_t event);

typedef enum {
    NETDEV_ANY = 0,         
    NETDEV_AT86RF215,
    NETDEV_AT86RF2XX,
    NETDEV_CC2538,
    NETDEV_DOSE,
    NETDEV_ENC28J60,
    NETDEV_KW41ZRF,
    NETDEV_MRF24J40,
    NETDEV_NRF802154,
    NETDEV_STM32_ETH,
    NETDEV_CC110X,
    NETDEV_SX127X,
    NETDEV_SAM0_ETH,
    NETDEV_ESP_NOW,
    NETDEV_NRF24L01P_NG,
    NETDEV_SOCKET_ZEP,
    NETDEV_SX126X,
    NETDEV_SX1280,
    NETDEV_CC2420,
    NETDEV_ETHOS,
    NETDEV_SLIPDEV,
    NETDEV_TAP,
    NETDEV_W5100,
    NETDEV_ENCX24J600,
    NETDEV_ATWINC15X0,
    NETDEV_KW2XRF,
    NETDEV_ESP_ETH,
    NETDEV_ESP_WIFI,
    NETDEV_CDC_ECM,
    NETDEV_TINYUSB,
    NETDEV_W5500,
    NETDEV_ESP_IEEE802154,
    /* add more if needed */
} netdev_type_t;


#define NETDEV_INDEX_ANY    (0xFF)
 
#if DOXYGEN
#define CONFIG_NETDEV_REGISTER_SIGNAL 0
#endif

struct netdev {
    const struct netdev_driver *driver;             
    netdev_event_cb_t event_callback;               
    void *context;                                  
#ifdef MODULE_NETDEV_LAYER
    netdev_t *lower;                                
#endif
#ifdef MODULE_L2FILTER
    l2filter_t filter[CONFIG_L2FILTER_LISTSIZE];   
#endif
#ifdef MODULE_NETDEV_REGISTER
    netdev_type_t type;                     
    uint8_t index;                          
#endif
};

void netdev_register_signal(struct netdev *dev, netdev_type_t type, uint8_t index);

static inline void netdev_register(struct netdev *dev, netdev_type_t type, uint8_t index)
{
#ifdef MODULE_NETDEV_REGISTER
    dev->type = type;
    dev->index = index;
#else
    (void)dev;
    (void)type;
    (void)index;
#endif
 
    if (IS_ACTIVE(CONFIG_NETDEV_REGISTER_SIGNAL)) {
        netdev_register_signal(dev, type, index);
    }
}

typedef struct netdev_driver {
    int (*send)(netdev_t *dev, const iolist_t *iolist);

    int (*confirm_send)(netdev_t *dev, void *info);

    int (*recv)(netdev_t *dev, void *buf, size_t len, void *info);

    int (*init)(netdev_t *dev);

    void (*isr)(netdev_t *dev);

    int (*get)(netdev_t *dev, netopt_t opt,
               void *value, size_t max_len);

    int (*set)(netdev_t *dev, netopt_t opt,
               const void *value, size_t value_len);
} netdev_driver_t;

static inline int netdev_get_notsup(netdev_t *dev, netopt_t opt,
                                    void *value, size_t max_len)
{
    (void)dev;
    (void)opt;
    (void)value;
    (void)max_len;
    return -ENOTSUP;
}

static inline int netdev_set_notsup(netdev_t *dev, netopt_t opt,
                                    const void *value, size_t value_len)
{
    (void)dev;
    (void)opt;
    (void)value;
    (void)value_len;
    return -ENOTSUP;
}

static inline void netdev_trigger_event_isr(netdev_t *netdev)
{
    if (netdev->event_callback) {
        netdev->event_callback(netdev, NETDEV_EVENT_ISR);
    }
}
#ifdef __cplusplus
}
#endif