ra8_usb_hcdc_ecm.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_usb.h"
 
/* =============================================================================
 * Constants
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_hcdc_ecm_pipe_bulk_in  = 1U, 
  k_ra8_hcdc_ecm_pipe_bulk_out = 2U, 
  k_ra8_hcdc_ecm_pipe_intr_in  = 6U, 
} ra8_usb_hcdc_ecm_pipe_t;

typedef enum : uint16_t {
  k_ra8_hcdc_ecm_bulk_max_packet_fs = 64U,   
  k_ra8_hcdc_ecm_bulk_max_packet_hs = 512U,  
  k_ra8_hcdc_ecm_intr_max_packet    = 16U,   
  k_ra8_hcdc_ecm_max_ethernet_frame = 1514U, 
} ra8_usb_hcdc_ecm_packet_t;

typedef enum : uint8_t {
  k_ra8_hcdc_ecm_class_comms   = 0x02U, 
  k_ra8_hcdc_ecm_subclass_ecm  = 0x06U, 
  k_ra8_hcdc_ecm_protocol_none = 0x00U, 
  k_ra8_hcdc_ecm_class_data    = 0x0AU, 
  k_ra8_hcdc_ecm_subclass_zero = 0x00U, 
  k_ra8_hcdc_ecm_protocol_zero = 0x00U, 
} ra8_usb_hcdc_ecm_class_t;

typedef enum : uint8_t {
  k_ra8_hcdc_ecm_req_set_packet_filter = 0x43U, 
  k_ra8_hcdc_ecm_req_get_statistic     = 0x44U, 
} ra8_usb_hcdc_ecm_request_t;

typedef enum : uint16_t {
  k_ra8_hcdc_ecm_filter_promiscuous   = 0x01U, 
  k_ra8_hcdc_ecm_filter_all_multicast = 0x02U, 
  k_ra8_hcdc_ecm_filter_directed      = 0x04U, 
  k_ra8_hcdc_ecm_filter_broadcast     = 0x08U, 
  k_ra8_hcdc_ecm_filter_multicast     = 0x10U, 
  k_ra8_hcdc_ecm_filter_all           = 0x1FU, 
} ra8_usb_hcdc_ecm_filter_t;

typedef enum : uint8_t {
  k_ra8_hcdc_ecm_link_down = 0U, 
  k_ra8_hcdc_ecm_link_up   = 1U, 
} ra8_usb_hcdc_ecm_link_t;

typedef enum : uint8_t {
  k_ra8_hcdc_ecm_mac_bytes     = 6U,  
  k_ra8_hcdc_ecm_mac_hex_chars = 12U, 
} ra8_usb_hcdc_ecm_mac_t;

typedef struct {
  uint8_t  device_address;                        
  uint8_t  bulk_in_ep;                            
  uint8_t  bulk_out_ep;                           
  uint8_t  intr_in_ep;                            
  uint16_t bulk_in_max_packet;                    
  uint16_t bulk_out_max_packet;                   
  uint16_t vendor_id;                             
  uint16_t product_id;                            
  uint8_t  i_mac_address;                         
  uint8_t  mac_address[k_ra8_hcdc_ecm_mac_bytes]; 
} ra8_usb_hcdc_ecm_device_t;

typedef void (*ra8_usb_hcdc_ecm_attach_fn_t)(void* ctx, const ra8_usb_hcdc_ecm_device_t* device);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_init(ra8_usb_speed_t speed);

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_close(void);
 
/* =============================================================================
 * Attach callback
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_attach_callback(ra8_usb_hcdc_ecm_attach_fn_t on_attach,
                                                         void*                        ctx);
 
/* =============================================================================
 * Bulk frame pipe
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_send_frame(const uint8_t* buf, uint16_t len);

[[nodiscard]] ra8_err_t
ra8_usb_hcdc_ecm_recv_frame(uint8_t* buf, uint16_t max_len, uint16_t* got_len);
 
/* =============================================================================
 * Class control transfers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_set_packet_filter(uint16_t filter_mask);

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_get_link_status(ra8_usb_hcdc_ecm_link_t* out_link);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_step(void);

[[nodiscard]] ra8_err_t ra8_usb_hcdc_ecm_parse_mac(const char* chars, uint8_t* out_mac);
 
#ifdef __cplusplus
}
#endif