enet_rm.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "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 THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS 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 ENET_RM_H_
#define ENET_RM_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <include/core/enet_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_RM_PUBLIC_IOCTL(x)               (ENET_IOCTL_TYPE_PUBLIC | \
                                               ENET_IOCTL_RM_BASE |     \
                                               ENET_IOCTL_PER_GENERIC | \
                                               ENET_IOCTL_MIN(x))
 
#define ENET_RM_TXCHNUM_INVALID                          (0xABCDABCDU)
 
#define ENET_RM_RXFLOWIDX_INVALID                        (0xABCDABCDU)
 
#define ENET_RM_INVALIDCORE                              (0x5562AEFEU)
 
#define ENET_RM_NUM_IOCTL_PERM_ENTRY_MAX                 (16U)
 
#define ENET_RM_NUM_MACADDR_MAX                          (10U)
 
#define ENET_RM_NUM_RXCHAN_MAX                           (2U)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum EnetRm_Ioctls_e
{
    ENET_RM_IOCTL_ALLOC_MAC_ADDR = ENET_RM_PUBLIC_IOCTL(0U),
 
    ENET_RM_IOCTL_FREE_MAC_ADDR = ENET_RM_PUBLIC_IOCTL(1U),
 
    ENET_RM_IOCTL_ALLOC_RX_FLOW = ENET_RM_PUBLIC_IOCTL(2U),
 
    ENET_RM_IOCTL_FREE_RX_FLOW = ENET_RM_PUBLIC_IOCTL(3U),
 
    ENET_RM_IOCTL_ALLOC_TX_CH_PEERID = ENET_RM_PUBLIC_IOCTL(4U),
 
    ENET_RM_IOCTL_FREE_TX_CH_PEERID = ENET_RM_PUBLIC_IOCTL(5U),
} EnetRm_Ioctls;
 
typedef struct EnetRm_ResourceInfo_s
{
    uint32_t coreId;
 
    uint32_t numTxCh;
 
    uint32_t numRxCh;
 
    uint32_t numRxFlows;
 
    uint32_t numMacAddress;
} EnetRm_ResourceInfo;
 
typedef struct EnetRm_ResPrms_s
{
    uint32_t numCores;
 
    EnetRm_ResourceInfo coreDmaResInfo[ENET_CFG_REMOTE_CLIENT_CORES_MAX];
} EnetRm_ResPrms;
 
typedef struct EnetRm_IoctlPermissionEntry_s
{
    uint32_t cmd;
 
    uint32_t permittedCoreMask;
} EnetRm_IoctlPermissionEntry;
 
typedef struct EnetRm_IoctlPermissionTable_s
{
    uint32_t defaultPermittedCoreMask;
 
    uint32_t numEntries;
 
    EnetRm_IoctlPermissionEntry entry[ENET_RM_NUM_IOCTL_PERM_ENTRY_MAX];
} EnetRm_IoctlPermissionTable;
 
typedef struct EnetRm_MacAddressPool_s
{
    uint32_t numMacAddress;
 
    uint8_t macAddress[ENET_RM_NUM_MACADDR_MAX][ENET_MAC_ADDR_LEN];
} EnetRm_MacAddressPool;
 
typedef struct EnetRm_AllocRxFlowInArgs_s
{
    uint32_t coreKey;
 
    uint32_t chIdx;
} EnetRm_AllocRxFlowInArgs;
 
typedef struct EnetRm_AllocRxFlow_s
{
    uint32_t startIdx;
 
    uint32_t flowIdx;
} EnetRm_AllocRxFlow;
 
typedef struct EnetRm_AllocMacAddrOutArgs_s
{
    uint8_t macAddr[ENET_MAC_ADDR_LEN];
} EnetRm_AllocMacAddrOutArgs;
 
typedef struct EnetRm_FreeTxChInArgs_s
{
    uint32_t coreKey;
 
    uint32_t txChNum;
} EnetRm_FreeTxChInArgs;
 
typedef struct EnetRm_FreeRxFlowInArgs_s
{
    uint32_t coreKey;
 
    uint32_t chIdx;
 
    uint32_t flowIdx;
} EnetRm_FreeRxFlowInArgs;
 
typedef struct EnetRm_FreeMacAddrInArgs_s
{
    uint32_t coreKey;
 
    uint8_t macAddr[ENET_MAC_ADDR_LEN];
} EnetRm_FreeMacAddrInArgs;
 
typedef struct EnetRm_ResCfg_s
{
    uint32_t selfCoreId;
 
    EnetRm_ResPrms resPartInfo;
 
    EnetRm_IoctlPermissionTable ioctlPermissionInfo;
 
    EnetRm_MacAddressPool macList;
} EnetRm_ResCfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_RM_H_ */