cb_lld_ethernet.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Texas Instruments Incorporated
 * Copyright (c) 2023 Excelfore Corporation (https://excelfore.com)
 *
 * All rights reserved not granted herein.
 * Limited License.
 *
 * Texas Instruments Incorporated grants a world-wide, royalty-free,
 * non-exclusive license under copyrights and patents it now or hereafter
 * owns or controls to make, have made, use, import, offer to sell and sell ("Utilize")
 * this software subject to the terms herein. With respect to the foregoing patent
 * license, such license is granted solely to the extent that any such patent is necessary
 * to Utilize the software alone. The patent license shall not apply to any combinations which
 * include this software, other than combinations with devices manufactured by or for TI ("TI Devices").
 * No hardware patent is licensed hereunder.
 *
 * Redistributions must preserve existing copyright notices and reproduce this license (including the
 * above copyright notice and the disclaimer and (if applicable) source code license limitations below)
 * in the documentation and/or other materials provided with the distribution
 *
 * Redistribution and use in binary form, without modification, are permitted provided that the following
 * conditions are met:
 *
 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any
 * software provided in binary form.
 * * any redistribution and use are licensed by TI for use only with TI Devices.
 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
 *
 * If software source code is provided to you, modification and redistribution of the source code are permitted
 * provided that the following conditions are met:
 *
 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by
 * TI for use only with TI Devices.
 * * any redistribution and use of any object code compiled from the source code and any resulting derivative
 * works, are licensed by TI for use only with TI Devices.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or
 * promote products derived from this software without specific prior written permission.
 *
 * DISCLAIMER.
 *
 * THIS SOFTWARE IS PROVIDED BY TI AND TI"S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TI AND TI"S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef CB_LLD_ETHERNET_H
#define CB_LLD_ETHERNET_H
 
#include <sys/types.h>
#include <errno.h>
#include "lldenet.h"
#include "lldtsync.h"
#ifdef __cplusplus
extern "C" {
#endif
 
// To prevent dupplicated declaration of below APIs
#define LWIP_DONT_PROVIDE_BYTEORDER_FUNCTIONS
#ifndef htons
#define htons __htons
#endif
#ifndef ntohs
#define ntohs __ntohs
#endif
#ifndef htonl
#define htonl __htonl
#endif
#ifndef ntohl
#define ntohl __ntohl
#endif
 
#define MAX_NUMBER_ENET_DEVS LLDENET_MAX_PORTS
 
#define CB_SOCKET_VALID(x) ((x)!=NULL)
#define CB_SOCKET_INVALID_VALUE NULL
#define CB_SOCKET_T lld_socket_t*
#define CB_ETHHDR_T struct lld_ethhdr
#define CB_SOCKADDR_LL_T struct lld_sockaddr
#define CB_SOCKADDR_T struct lld_sockaddr
#define CB_SOCK_SENDTO cb_lld_sendto
#define CB_SOCK_CLOSE cb_rawsock_close
 
#define CB_OPEN open
#define CB_CLOSE close
#define CB_WRITE write
 
/* does not support */
#define CB_IN_ADDR_T void*
 
#ifndef IFNAMSIZ
#define IFNAMSIZ        16
#endif
 
#define ETH_ALEN        6       /* Octets in one ethernet addr   */
#define ETH_HLEN        14      /* Total octets in header.   */
#define ETH_DATA_LEN    1500    /* Max. octets in payload    */
 
#define ETH_P_8021Q     0x8100  /* 802.1Q VLAN Extended Header  */
#define ETH_P_1588      0x88F7  /* IEEE 1588 Timesync */
#define ETH_P_LLDP      0x88CC  /* 802.1AB LLDP */
#define ETH_P_TSN       0x22F0  /* TSN (IEEE 1722) packet   */
#define ETH_P_NETLINK       0x22F1  /* A virtual prototol for netlink rawsockt on TI platforms */
 
#define CB_MAX_NETDEVNAME 16
 
#define MKPIPE(x)       (-1)
 
#define CB_LLD_MAX_ETH_FRAME_SIZE (1522U)
 
struct lld_ethhdr {
    uint8_t h_dest[ETH_ALEN];
    uint8_t h_source[ETH_ALEN];
    uint16_t h_proto;
} __attribute__((packed));
 
struct lld_sockaddr {
    unsigned char sll_addr[6];
    int macport;
    int tcid;
    uint64_t rxts;
};
 
typedef struct lld_socket lld_socket_t;
 
typedef struct {
    char *netdev;
    uint8_t macport;
    uint8_t srcmac[ETH_ALEN];
} lld_ethdev_t;
 
typedef struct {
    /* below are keys to match the expected socket */
    const char *dev;
    uint16_t proto;
    uint16_t vlanid;
    /* below are params can be updated to LLDEnetCfg_t */
    uint32_t nTxPkts;
    uint32_t nRxPkts[MAX_NUM_RX_DMA_CH_PER_INSTANCE];
    uint32_t pktSize;
    int dmaTxChId;
    int dmaRxChId[MAX_NUM_RX_DMA_CH_PER_INSTANCE];
    int dmaTxShared;
    int dmaRxShared;
    int dmaRxOwner;
    void (*rxDefaultDataCb)(void *data, int size, int port, void *cbArg);
    void *rxDefaultCbArg;
    int numRxChannels;
} cb_socket_lldcfg_update_t;
 
/* Number of elements in a statistics block */
#define CB_TILLD_STATS_BLOCK_ELEM_NUM             (128U)
typedef struct cb_tilld_port_stats {
    uint64_t val[CB_TILLD_STATS_BLOCK_ELEM_NUM];
} cb_tilld_port_stats_t;
 
typedef int (*cb_socket_lldcfg_update_cb_t)(cb_socket_lldcfg_update_t *update_cfg);
 
int cb_lld_init_devs_table(lld_ethdev_t *ethdevs, uint32_t ndevs,
                           uint32_t enet_type, uint32_t instance_id,
                           const LLDTsyncTsSource tsSource);
 
int cb_socket_set_lldcfg_update_cb(cb_socket_lldcfg_update_cb_t lldcfg_update_cb);
 
int cb_lld_netdev_to_macport(const char *netdev);
 
int cb_lld_sendto(CB_SOCKET_T sfd, void *sdata, int psize, int flags,
                 const CB_SOCKADDR_LL_T *addr, int addrsize);
 
int cb_lld_sendto_scatter(CB_SOCKET_T sfd, LLDEnetFrameScatter_t *frame,
                          const CB_SOCKADDR_LL_T *addr);
 
int cb_lld_recv(CB_SOCKET_T sfd, void *buf, int size,
        CB_SOCKADDR_LL_T *addr, int addrsize);
 
int cb_lld_recv_zerocopy(CB_SOCKET_T sfd, LLDEnetRecvCb_t cblld_recv_cb, void *cbarg);
 
int cb_lld_set_txnotify_cb(CB_SOCKET_T sfd, void (*txnotify_cb)(void *arg), void *arg);
 
int cb_lld_set_rxnotify_cb(CB_SOCKET_T sfd, void (*rxnotify_cb)(void *arg), void *arg);
 
int cb_lld_set_default_rxdata_cb(CB_SOCKET_T sfd,
        void (*default_rxdata_cb)(void *data, int size, int port, void *arg), void *arg);
 
int cb_lld_get_type_instance(uint32_t *enet_type, uint32_t *instance_id);
 
int cb_lld_get_ts_source(LLDTsyncTsSource *tsSource);
 
int cb_lld_get_netdevs(char* netdevs[], int *len);
 
int cb_lld_get_link_state(CB_SOCKET_T cfd, const char *dev, uint32_t *linkstate);
 
int cb_lld_get_link_info(CB_SOCKET_T cfd, const char *dev, uint32_t *speed, uint32_t *duplex);
 
int cb_lld_get_port_stats(CB_SOCKET_T sfd, int port, cb_tilld_port_stats_t *stats);
 
void cb_lld_reset_port_stats(CB_SOCKET_T sfd, int port);
 
int cb_lld_process_status_frames(CB_SOCKET_T sfd);
 
#ifdef __cplusplus
}
#endif
#endif //CB_LLD_ETHERNET_H