ecm.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Koen Zandberg
 *
 * 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.
 */
 
#ifndef USB_USBUS_CDC_ECM_H
#define USB_USBUS_CDC_ECM_H
 
#include <stdint.h>
#include <stdlib.h>
#include "net/ethernet.h"
#include "net/ethernet/hdr.h"
#include "usb/descriptor.h"
#include "usb/usbus.h"
#include "usb/usbus/control.h"
#include "macros/math.h"
#include "net/netdev.h"
#include "mutex.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_USBUS_CDC_ECM_CONFIG_SPEED
#define CONFIG_USBUS_CDC_ECM_CONFIG_SPEED  1000000
#endif
 
#ifndef CONFIG_USBUS_CDC_ECM_CONFIG_SPEED_DOWNSTREAM
#define CONFIG_USBUS_CDC_ECM_CONFIG_SPEED_DOWNSTREAM CONFIG_USBUS_CDC_ECM_CONFIG_SPEED
#endif
 
#ifndef CONFIG_USBUS_CDC_ECM_CONFIG_SPEED_UPSTREAM
#define CONFIG_USBUS_CDC_ECM_CONFIG_SPEED_UPSTREAM   CONFIG_USBUS_CDC_ECM_CONFIG_SPEED
#endif
 
#define USBUS_CDCECM_EP_CTRL_SIZE  16
 
#ifndef MODULE_PERIPH_USBDEV_HS
#define USBUS_CDCECM_EP_DATA_SIZE  64
#else
#define USBUS_CDCECM_EP_DATA_SIZE  512
#endif
 
#define USBUS_ETHERNET_FRAME_BUF   MATH_ALIGN(ETHERNET_FRAME_LEN, USBUS_CDCECM_EP_DATA_SIZE)
 
#define USBUS_CDC_ECM_EP_IN_REQUIRED_NUMOF   2
 
#define USBUS_CDC_ECM_EP_OUT_REQUIRED_NUMOF  1
 
typedef enum {
    USBUS_CDCECM_NOTIF_NONE,    
    USBUS_CDCECM_NOTIF_LINK_UP, 
    USBUS_CDCECM_NOTIF_SPEED,   
} usbus_cdcecm_notif_t;
 
typedef struct usbus_cdcecm_device {
    usbus_handler_t handler_ctrl;           
    usbus_interface_t iface_data;           
    usbus_interface_t iface_ctrl;           
    usbus_interface_alt_t iface_data_alt;   
    usbus_endpoint_t *ep_in;                
    usbus_endpoint_t *ep_out;               
    usbus_endpoint_t *ep_ctrl;              
    usbus_descr_gen_t ecm_descr;            
    event_t rx_flush;                       
    event_t tx_xmit;                        
    netdev_t netdev;                        
    uint8_t mac_netdev[ETHERNET_ADDR_LEN];  
    char mac_host[13];                      
    usbus_string_t mac_str;                 
    usbus_t *usbus;                         
    mutex_t out_lock;                       
    size_t tx_len;                          
    usbus_cdcecm_notif_t notif;             
    unsigned active_iface;                  
    usbdev_ep_buf_t data_out[USBUS_ETHERNET_FRAME_BUF];
 
    usbdev_ep_buf_t data_in[USBUS_CDCECM_EP_DATA_SIZE];
 
    usbdev_ep_buf_t control_in[USBUS_CDCECM_EP_CTRL_SIZE];
    usbus_urb_t out_urb;
} usbus_cdcecm_device_t;
 
void usbus_cdcecm_init(usbus_t *usbus, usbus_cdcecm_device_t *handler);
 
#ifdef __cplusplus
}
#endif
 
#endif /* USB_USBUS_CDC_ECM_H */