lldenet.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 LLDENET_H_
#define LLDENET_H_
 
#include "lldtype.h"
 
typedef struct LLDEnet LLDEnet_t;
 
typedef struct {
    uint32_t enetType;
    uint32_t instId;
    void (*txNotifyCb)(void *cbArg);
    void (*rxNotifyCb)(void *cbArg);
    void *txCbArg;
    void *rxCbArg;
    uint8_t dstMacAddr[6];
    uint32_t vlanId;
    uint32_t ethType;
    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];
    bool unusedDmaRx;
    bool unusedDmaTx;
    bool dmaTxShared;
    bool dmaRxShared;
    bool dmaRxOwner;
    uint32_t numRxChannels;
} LLDEnetCfg_t;
 
typedef struct {
    uint8_t *buf;
    uint32_t size;
    int port;
    int tc;
    uint64_t rxts;
} LLDEnetFrame_t;
 
#define MAX_BUF_IN_SCATTER_FRAME 32
 
typedef struct {
    uint8_t *buf[MAX_BUF_IN_SCATTER_FRAME];
    uint16_t size[MAX_BUF_IN_SCATTER_FRAME];
    uint8_t nBufs;
    int8_t port;
    int8_t tc;
    uint64_t rxts;
} LLDEnetFrameScatter_t;
 
void LLDEnetCfgInit(LLDEnetCfg_t *cfg);
 
LLDEnet_t *LLDEnetOpen(LLDEnetCfg_t *cfg);
 
void LLDEnetClose(LLDEnet_t *hLLDEnet);
 
int LLDEnetFilter(LLDEnet_t *hLLDEnet, uint8_t *dstMacAddr,
                  uint32_t vlanId, uint32_t ethType);
 
int LLDEnetAllocMac(LLDEnet_t *hLLDEnet, uint8_t *srcMacAddr);
 
void LLDEnetFreeMac(LLDEnet_t *hLLDEnet, uint8_t *srcMacAddr);
 
int LLDEnetSend(LLDEnet_t *hLLDEnet, LLDEnetFrame_t *frame);
 
int LLDEnetSendMulti(LLDEnet_t *hLLDEnet, LLDEnetFrame_t *frames, uint32_t nFrames);
 
int LLDEnetSendScatter(LLDEnet_t *hLLDEnet, LLDEnetFrameScatter_t *frame);
 
int LLDEnetSendMultiScatter(LLDEnet_t *hLLDEnet, LLDEnetFrameScatter_t *frames,
                            uint32_t nFrames);
 
int LLDEnetRecv(LLDEnet_t *hLLDEnet, LLDEnetFrame_t *frame);
 
typedef void (*LLDEnetRecvCb_t)(LLDEnetFrame_t *frame, void *cbArg);
 
int LLDEnetRecvZeroCopy(LLDEnet_t *hLLDEnet, LLDEnetRecvCb_t LLDEnetRecvCb, void *cbArg);
 
bool LLDEnetIsPortUp(LLDEnet_t *hLLDEnet, uint8_t portNum);
 
int LLDEnetGetLinkInfo(LLDEnet_t *hLLDEnet, uint8_t portNum,
                       uint32_t *speed, uint32_t *duplex);
 
int LLDEnetSetTxNotifyCb(LLDEnet_t *hLLDEnet, void (*txNotifyCb)(void *arg), void *arg);
 
int LLDEnetSetRxNotifyCb(LLDEnet_t *hLLDEnet, void (*rxNotifyCb)(void *arg), void *arg);
 
int LLDEnetSetDefaultRxDataCb(LLDEnet_t *hLLDEnet,
        void (*rxDefaultDataCb)(void *data, int size, int port, void *arg), void *arg);
 
bool LLDEnetIsRxTsInPkt(LLDEnet_t *hLLDEnet);
 
#endif //LLDENET_H_