pruicss/m_v0/pruicss.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  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 PRUICSS_H_
#define PRUICSS_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <kernel/dpl/HwiP.h>
#include <drivers/hw_include/cslr_icss.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define PRUICSS_PRU0                                (0U)
#define PRUICSS_PRU1                                (1U)
 
#define PRUICSS_NUM_CORES                           (2U)
 
#define PRUICSS_DATARAM(n)                          (0x00000U + ((n) * 0x02000U))
 
#define PRUICSS_SHARED_RAM                          (0x10000U)
 
#define PRUICSS_IRAM_PRU(n)                         (0x34000U + ((n) * 0x04000U))
 
#define PRUICSS_INTC_NUM_HOST_INTERRUPTS            (10U)
 
#define PRUICSS_INTC_NUM_CHANNELS                   (10U)
 
#define PRUICSS_INTC_NUM_SYS_EVTS                   (64U)
 
 
#define PRUICSS_CONST_TBL_ENTRY_C24                 (0U)
#define PRUICSS_CONST_TBL_ENTRY_C25                 (1U)
#define PRUICSS_CONST_TBL_ENTRY_C26                 (2U)
#define PRUICSS_CONST_TBL_ENTRY_C27                 (3U)
#define PRUICSS_CONST_TBL_ENTRY_C28                 (4U)
#define PRUICSS_CONST_TBL_ENTRY_C29                 (5U)
#define PRUICSS_CONST_TBL_ENTRY_C30                 (6U)
#define PRUICSS_CONST_TBL_ENTRY_C31                 (7U)
#define PRUICSS_NUM_CONST_TBL_ENTRY                 (8U)
 
#define PRUICSS_GP_MUX_SEL_MODE_GP                  (0U)
#define PRUICSS_GP_MUX_SEL_MODE_ENDAT               (1U)
#define PRUICSS_GP_MUX_SEL_MODE_MII                 (2U)
#define PRUICSS_GP_MUX_SEL_MODE_SD                  (3U)
 
#define PRUICSS_NUM_GP_MUX_SEL_MODES                (4U)
 
#define PRUICSS_GPI_MODE_DIRECT_R31_STATUS          (0U)
 
#define PRUICSS_GPI_MODE_PARALLEL_16_BIT_CAPTURE    (1U)
 
#define PRUICSS_GPI_MODE_29_BIT_SHIFT               (2U)
 
#define PRUICSS_GPI_MODE_MII_RT                     (3U)
 
#define PRUICSS_NUM_GPI_MODES                       (4U)
 
#define PRUICSS_SA_MUX_MODE_DEFAULT                 (0U)
 
#define PRUICSS_SA_MUX_MODE_SD_ENDAT                (1U)
 
#define PRUICSS_NUM_SA_MUX_MODES                    (2U)
 
#define PRUICSS_ICSS_CFG_MII_MODE_MII               (0U)
 
#define PRUICSS_ICSS_CFG_MII_MODE_RGMII             (1U)
 
#define PRUICSS_NUM_ICSS_CFG_MII_MODES              (2U)
 
#define PRUICSS_TX_L1_FIFO                          (0U)
#define PRUICSS_TX_L2_FIFO                          (1U)
 
typedef void (*PRUICSS_IrqHandler)(void* buf);
 
typedef struct PRUICSS_Config_s         *PRUICSS_Handle;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct PRUICSS_SysevtToChannelMap_s
{
    uint8_t sysevt;
    uint8_t channel;
    uint8_t polarity;
    uint8_t type;
} PRUICSS_SysevtToChannelMap;
 
typedef struct PRUICSS_ChannelToHostMap_s
{
    int16_t channel;
    int16_t host;
} PRUICSS_ChannelToHostMap;
 
typedef struct PRUICSS_IntcInitData_s
{
    uint8_t                     sysevtsEnabled[PRUICSS_INTC_NUM_SYS_EVTS];
    PRUICSS_SysevtToChannelMap  sysevtToChannelMap[PRUICSS_INTC_NUM_SYS_EVTS];
    PRUICSS_ChannelToHostMap    channelToHostMap[PRUICSS_INTC_NUM_CHANNELS];
    uint32_t                    hostEnableBitmask;
} PRUICSS_IntcInitData;
 
typedef struct PRUICSS_IrqFunMap_s
{
    PRUICSS_IrqHandler  irqHandler;
    HwiP_Object         hwiObj;
    uint8_t             waitEnable;
    SemaphoreP_Object   semObj;
    PRUICSS_Handle      pruicssHandle;
} PRUICSS_IrqFunMap;
 
typedef struct PRUICSS_Object_s
{
    uint32_t            pruicssVersion;
    PRUICSS_IrqFunMap   pruEvntOutFnMapArray[PRUICSS_INTC_NUM_HOST_INTERRUPTS];
    /* IRQ Handler mapping structure for all host interrupts*/
} PRUICSS_Object;
 
typedef struct PRUICSS_HWAttrs
{
    uint32_t    instance;
    uintptr_t   baseAddr;
    uintptr_t   pru0CtrlRegBase;
    uintptr_t   pru1CtrlRegBase;
    uintptr_t   intcRegBase;
    uintptr_t   cfgRegBase;
    uintptr_t   uartRegBase;
    uintptr_t   iep0RegBase;
    uintptr_t   ecapRegBase;
    uintptr_t   miiRtCfgRegBase;
    uintptr_t   miiGRtCfgRegBase;
    uintptr_t   miiMdioRegBase;
    uintptr_t   pru0DramBase;
    uintptr_t   pru1DramBase;
    uintptr_t   pru0IramBase;
    uintptr_t   pru1IramBase;
    uintptr_t   sharedDramBase;
    uint32_t    pru0DramSize;
    uint32_t    pru1DramSize;
    uint32_t    pru0IramSize;
    uint32_t    pru1IramSize;
    uint32_t    sharedDramSize;
} PRUICSS_HwAttrs;
 
typedef struct PRUICSS_Config_s
{
    PRUICSS_Object        *object;
    PRUICSS_HwAttrs const *hwAttrs;
} PRUICSS_Config;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
int32_t PRUICSS_init(void);
 
int32_t PRUICSS_deinit(void);
 
PRUICSS_Handle PRUICSS_open(uint32_t instance);
 
int32_t PRUICSS_close(PRUICSS_Handle handle);
 
int32_t PRUICSS_intcInit(PRUICSS_Handle              handle,
                         const PRUICSS_IntcInitData  *intcInitData);
 
int32_t PRUICSS_registerIrqHandler(PRUICSS_Handle           handle,
                                   uint32_t                 pruEvtoutNum,
                                   int32_t                  intrNum,
                                   int32_t                  eventNum,
                                   uint8_t                  waitEnable,
                                   PRUICSS_IrqHandler       irqHandler);
 
int32_t PRUICSS_resetCore(PRUICSS_Handle handle, uint8_t pruNum);
 
int32_t PRUICSS_disableCore(PRUICSS_Handle handle, uint8_t pruNum);
 
int32_t PRUICSS_enableCore(PRUICSS_Handle handle, uint8_t pruNum);
 
uint32_t PRUICSS_initMemory(PRUICSS_Handle handle, uint32_t pruicssMem);
 
uint32_t PRUICSS_writeMemory(PRUICSS_Handle   handle,
                             uint32_t         pruicssMem,
                             uint32_t         wordoffset,
                             const uint32_t   *source_mem,
                             uint32_t         bytelength);
 
uint32_t PRUICSS_readMemory(PRUICSS_Handle    handle,
                            uint32_t          pruicssMem,
                            uint32_t          wordoffset,
                            uint32_t          *dest_mem,
                            uint32_t          bytelength);
 
int32_t PRUICSS_sendEvent(PRUICSS_Handle handle, uint32_t eventnum);
 
int32_t PRUICSS_waitEvent(PRUICSS_Handle handle, uint32_t pruEvtoutNum);
 
int32_t PRUICSS_clearEvent(PRUICSS_Handle handle, uint32_t eventnum);
 
int32_t PRUICSS_sendWaitClearEvent(PRUICSS_Handle    handle,
                                   uint32_t          sendEventNum,
                                   uint32_t          pruEvtoutNum,
                                   uint32_t          ackEventNum);
 
uint32_t PRUICSS_getVersion(PRUICSS_Handle handle);
 
int32_t PRUICSS_setConstantTblEntry(PRUICSS_Handle  handle,
                                    uint8_t         pruNum,
                                    int32_t         constantTblEntry,
                                    uint32_t        constantTblVal);
 
int32_t PRUICSS_setIepClkSrc(PRUICSS_Handle handle, uint32_t source);
 
int32_t PRUICSS_setGpMuxSelect(PRUICSS_Handle handle, uint8_t pruNum, uint8_t mode);
 
int32_t PRUICSS_setGpiMode(PRUICSS_Handle handle, uint8_t pruNum, uint8_t mode);
 
/*TODO: Review this*/
int32_t PRUICSS_setSaMuxMode(PRUICSS_Handle handle, uint8_t mode);
 
int32_t PRUICSS_configureCycleCounter(PRUICSS_Handle handle, uint8_t pruNum, uint8_t enable);
 
int32_t PRUICSS_controlIepCounter(PRUICSS_Handle handle, uint8_t iepInstance, uint8_t enable);
 
int32_t PRUICSS_setIepCounterIncrementValue(PRUICSS_Handle handle, uint8_t iepInstance, uint8_t value);
 
int32_t PRUICSS_readEfuse(PRUICSS_Handle handle, uint8_t *data);
 
int32_t PRUICSS_setIcssCfgMiiMode(PRUICSS_Handle handle, uint8_t miiInstance, uint8_t mode);
 
int32_t PRUICSS_setIcssCfgTxFifo(PRUICSS_Handle handle, uint8_t fifoInstance, uint8_t enable);
 
const PRUICSS_HwAttrs *PRUICSS_getAttrs(uint32_t instance);
 
int32_t PRUICSS_loadFirmware(PRUICSS_Handle handle, uint8_t pruIcssCore, const uint32_t pruFirmware[], uint32_t byteLength);
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef PRUICSS_H_ */