EthernetApi.h

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef HIDE_FROM_DOXYGEN
#ifndef __ETHERNETAPI_H__
#define __ETHERNETAPI_H__
 
#include <stdint.h>
 
#ifndef TX_BUFF_CNT
#define TX_BUFF_CNT (8)
#endif
 
#ifndef RX_BUFF_CNT
#define RX_BUFF_CNT (16)
#endif
 
#ifndef TX_BUFFER_SIZE
#define TX_BUFFER_SIZE (520)
#endif
 
#ifndef RX_BUFFER_SIZE
#define RX_BUFFER_SIZE (128)
#endif
 
typedef union {
    struct {
uint32_t OWN :
        1;     
uint32_t WRAP :
        1;    
uint32_t ADDR :
        30;   
uint32_t LEN :
        13;    
uint32_t FCS :
        1;     
uint32_t SF :
        1;      
        uint32_t EF : 1;      
        uint32_t CFI : 1;     
        uint32_t VLAN : 3;    
        uint32_t PTAG : 1;    
        uint32_t VTAG : 1;    
uint32_t CSM :
        2;     
uint32_t SNAP :
        1;    
uint32_t SPAMI :
        2;   
uint32_t SPAM :
        1;    
        uint32_t: 1;          
        uint32_t UHM : 1;     
        uint32_t MHM : 1;     
        uint32_t GAO : 1;     
    } bit;
    uint32_t reg[2];
} GMAC_RX_DESC;
 
typedef union {
    struct {
        uint32_t ADDR : 32;   
        uint32_t LEN : 14;    
        uint32_t: 1;          
        uint32_t LB : 1;      
uint32_t CRC :
        1;     
        uint32_t: 3;          
uint32_t CSER :
        3;    
        uint32_t: 3;          
uint32_t LCERR :
        1;   
uint32_t FCERR :
        1;   
        uint32_t: 1;          
uint32_t RLERR :
        1;   
uint32_t WRAP :
        1;    
        uint32_t OWN : 1;     
    } bit;
    uint32_t reg[2];
} GMAC_TX_DESC;
 
typedef struct {
    GMAC_RX_DESC *rxDesc;       /* Receive buffer descriptor address */
    GMAC_TX_DESC *txDesc;       /* Transmit buffer descriptor address */
    uint8_t *rxBuffIndex;       /* Receive buffer index */
    uint16_t *txBuffIndex;      /* Transmit buffer index */
    uint8_t mac[6];             /* MAC address */
} ethInt;
 
typedef struct netif netInt;
typedef struct pbuf packetBuf;
 
#endif // !__ETHERNETAPI_H__
#endif // !HIDE_FROM_DOXYGEN