cb_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_ETHERNET_H_
#define CB_ETHERNET_H_
 
#ifdef CB_ETHERNET_NON_POSIX_H
/* non-posix platforms need to support necessary POSIX compatible
 * functions and types which are defined as CB_* macros below.
 * And provide them in a header file defined as CB_SOCKET_NON_POSIX_H */
#include CB_ETHERNET_NON_POSIX_H
#else
#include <unistd.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <netinet/in.h>
#include <net/if.h>
#include <net/if_arp.h>
#include <ifaddrs.h>
#include <fcntl.h>
#include <netpacket/packet.h>
#include <net/ethernet.h>
 
#define CB_MAX_NETDEVNAME IFNAMSIZ
#define CB_SOCKET_T int
#define CB_SOCKET_VALID(x) ((x)>=0)
#define CB_SOCKET_INVALID_VALUE -1
#define CB_STDIN_FILENO STDIN_FILENO
#define CB_STDOUT_FILENO STDOUT_FILENO
#define CB_STDERR_FILENO STDERR_FILENO
#define CB_SOCKET_INC(x) ((x)+1)
#define CB_ETHHDR_T struct ethhdr
#define CB_SOCKLEN_T socklen_t
#define CB_SOCKADDR_T struct sockaddr
#define CB_SOCKADDR_LL_T struct sockaddr_ll
#define CB_SOCKADDR_IN_T struct sockaddr_in
#define CB_SOCKADDR_IN6_T struct sockaddr_in6
#define CB_SOCKADDR_STORAGE_T struct sockaddr_storage
#define CB_IN_ADDR_T struct in_addr
#define CB_IN6_ADDR_T struct in6_addr
#define CB_IFREQ_T struct ifreq
 
#define CB_OPEN open
#define CB_CLOSE close
#define CB_WRITE write
#define CB_SOCKET socket
#define CB_IF_NAMETOINDEX if_nametoindex
#define CB_SOCK_BIND bind
#define CB_SOCK_IOCTL ioctl
#define CB_SOCK_CLOSE close
#define CB_SETSOCKOPT setsockopt
#define CB_SOCK_SENDTO sendto
#define CB_SELECT select
#define CB_SOCK_RECVFROM recvfrom
#define CB_SOCK_RECVMSG recvmsg
#define CB_SOCK_WRITE write
#define CB_SOCK_CONNECT connect
 
#define CB_FCNTL fcntl
#define CB_FD_SET_T fd_set
#define CB_FDSET FD_SET
#define CB_FDCLR FD_CLR
#define CB_FDISSET FD_ISSET
#define CB_FDZERO FD_ZERO
 
#endif // CB_ETHERNET_NON_POSIX_H
 
/* virtual eth ports and ptp devices are used in the ovip mode.
 * common suffix should be added after these prefixes */
#define CB_VIRTUAL_ETHDEV_PREFIX "cbeth"
 
#define CB_VIRTUAL_PTPDEV_PREFIX "cbptp"
 
#define CB_VIRTUAL_ETHDEV_MACU32 {0x02,0x01,0x45,0x10}
 
/* the following definitions have some variations for platforms */
#ifndef H_SOURCE
#define H_SOURCE h_source
#endif
 
#ifndef H_DEST
#define H_DEST h_dest
#endif
 
#ifndef H_PROTO
#define H_PROTO h_proto
#endif
 
/************************************************************
 * definitions to handle PTP messages
 ************************************************************/
#define PTP_HEAD_MSGTYPE(x) ((*(uint8_t *) (&((uint8_t *)(x))[0])) & 0x0F)
 
#define PTP_HEAD_SEQID(x) ((((uint8_t *)(x))[30]<<8u)|(((uint8_t *)(x))[31]))
 
#define PTP_HEAD_DOMAIN_NUMBER(x) (*(uint8_t *)(&((uint8_t *)(x))[4]))
 
#define MAX_PTPDEV_NAME 32
 
typedef char ptpdevname_t[MAX_PTPDEV_NAME];
 
 
/************************************************************
 * definitions to handle raw socket
 ************************************************************/
typedef enum {
    CB_RAWSOCK_RDWR = 0,
    CB_RAWSOCK_RDONLY,
    CB_RAWSOCK_WRONLY,
} cb_rawsock_rw_t;
 
typedef struct cb_rawsock_ovip_para {
    uint32_t laddr; 
    uint16_t lport; 
    uint32_t daddr; 
    uint16_t dport; 
} cb_rawsock_ovip_para_t;
 
typedef enum {
    CB_SOCK_MODE_OVIP = -1, 
    CB_SOCK_MODE_NORMAL, 
    CB_SOCK_MODE_LSM, 
} cb_sock_mode_t;
 
typedef struct cb_rawsock_paras{
    const char *dev; 
    uint16_t proto; 
    uint16_t vlan_proto; 
    int priority; 
    cb_rawsock_rw_t rw_type; 
    cb_sock_mode_t sock_mode; 
    cb_rawsock_ovip_para_t *ovipp; 
    uint16_t vlanid; 
    uint32_t sndbuf; 
    uint32_t rcvbuf; 
} cb_rawsock_paras_t;
 
typedef char netdevname_t[CB_MAX_NETDEVNAME];
 
/************************************************************
 * functions
 ************************************************************/
int cb_get_mac_bydev(CB_SOCKET_T sfd, const char *dev, ub_macaddr_t bmac);
 
int cb_get_ip_bydev(CB_SOCKET_T sfd, const char *dev, CB_IN_ADDR_T *inp);
 
int cb_get_brdip_bydev(CB_SOCKET_T sfd, const char *dev, CB_IN_ADDR_T *inp);
 
int cb_rawsock_open(cb_rawsock_paras_t *llrawp, CB_SOCKET_T *fd, CB_SOCKADDR_LL_T *addr,
            int *mtusize, ub_macaddr_t bmac);
 
int cb_rawsock_close(CB_SOCKET_T fd);
 
int cb_sock_set_priority(CB_SOCKET_T fd, int priority);
 
int cb_expand_mtusize(CB_SOCKET_T fd, const char *dev, int *mtusize);
 
int cb_set_promiscuous_mode(CB_SOCKET_T sfd, const char *dev, bool enable);
 
int cb_reg_multicast_address(CB_SOCKET_T fd, const char *dev,
                 const unsigned char *mcastmac, int del);
 
int cb_get_all_netdevs(int maxdevnum, netdevname_t *netdevs);
 
int cb_get_ethtool_linkstate(CB_SOCKET_T cfd, const char *dev, uint32_t *linkstate);
 
int cb_get_ethtool_info(CB_SOCKET_T cfd, const char *dev, uint32_t *speed, uint32_t *duplex);
 
int cb_get_netdev_from_ptpdev(char *ptpdev, char *netdev);
 
int cb_get_ptpdev_from_netdev(char *netdev, char *ptpdev);
 
#endif