enet_mod.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_MOD_H_
#define ENET_MOD_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_ioctl.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_MOD(mod)                         ((EnetMod_Handle)mod)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct EnetMod_Obj_s *EnetMod_Handle;
 
typedef int32_t (*const EnetMod_Open)(EnetMod_Handle hMod,
                                Enet_Type enetType,
                                uint32_t instId,
                                const void *cfg,
                                uint32_t cfgSize);
 
typedef int32_t (* const EnetMod_Rejoin)(EnetMod_Handle hMod,
                                  Enet_Type enetType,
                                  uint32_t instId);
 
typedef int32_t (* const EnetMod_Ioctl)(EnetMod_Handle hMod,
                                 uint32_t cmd,
                                 Enet_IoctlPrms *prms);
 
typedef void (* const EnetMod_Close)(EnetMod_Handle hMod);
 
typedef void (* const EnetMod_SaveCtxt)(EnetMod_Handle hMod);
 
typedef int32_t (* const EnetMod_RestoreCtxt)(EnetMod_Handle hMod,
                                              Enet_Type enetType,
                                              uint32_t instId,
                                              const void *cfg,
                                              uint32_t cfgSize);
typedef struct EnetMod_Obj_s
{
    const char *name;
 
    uint64_t physAddr;
 
    void *virtAddr;
 
    uint64_t physAddr2;
 
    void *virtAddr2;
 
    uint32_t features;
 
    uint32_t errata;
 
    Enet_Magic magic;
 
    EnetMod_Open open;
 
    EnetMod_Rejoin rejoin;
 
    EnetMod_Ioctl ioctl;
 
    EnetMod_Close close;
 
    EnetMod_SaveCtxt saveCtxt;
 
    EnetMod_RestoreCtxt restoreCtxt;
} EnetMod_Obj;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t EnetMod_open(EnetMod_Handle hMod,
                     Enet_Type enetType,
                     uint32_t instId,
                     const void *cfg,
                     uint32_t cfgSize);
 
int32_t EnetMod_rejoin(EnetMod_Handle hMod,
                       Enet_Type enetType,
                       uint32_t instId);
 
int32_t EnetMod_ioctl(EnetMod_Handle hMod,
                      uint32_t cmd,
                      Enet_IoctlPrms *prms);
 
int32_t EnetMod_registerMacportIoctlHandler(EnetMod_Handle hMod,
                                            uint32_t cmdBase,
                                            uint32_t cmd,
                                            Enet_IoctlPrms *prms);
int32_t EnetMod_ioctlFromIsr(EnetMod_Handle hMod,
                             uint32_t cmd,
                             Enet_IoctlPrms *prms);
 
void EnetMod_close(EnetMod_Handle hMod);
 
void EnetMod_saveCtxt(EnetMod_Handle hMod);
 
int32_t EnetMod_restoreCtxt(EnetMod_Handle hMod,
                            Enet_Type enetType,
                            uint32_t instId,
                            const void *cfg,
                           uint32_t cfgSize);
static inline bool EnetMod_isOpen(EnetMod_Handle hMod);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline bool EnetMod_isOpen(EnetMod_Handle hMod)
{
    return (hMod->magic == ENET_MAGIC);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_MOD_H_ */