sipc_notify.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2022 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 SIPC_NOTIFY_H_
#define SIPC_NOTIFY_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/secure_ipc_notify/soc/sipc_notify_soc.h>
 
typedef void (*SIPC_FxnCallback)(uint8_t remoteSecCoreId, uint8_t localClientId, uint8_t remoteClientId ,uint8_t *msgValue, void *args);
 
 
typedef struct SIPC_Params_ {
 
    uint32_t numCores;  
    uint32_t coreIdList[MAX_SEC_CORES_WITH_HSM]; 
    uint32_t ipcQueue_length ; 
    uint32_t ipcQueue_eleSize_inBytes ; 
    uint32_t ipcQueue_totalSize_inBytes ; 
    uintptr_t tx_SipcQueues[MAX_SEC_CORES_WITH_HSM]; 
    uintptr_t rx_SipcQueues[MAX_SEC_CORES_WITH_HSM]; 
    /* The size of SecureMaster_CoreId array is 2 so the coreId value written on INDEX = 0 will represent the
     * Secure Master 1's CORE ID and so on */
    uint32_t secHostCoreId[MAX_SEC_CORES_WITH_HSM - 1];
    /* This field is for soc extension if user wants to configure different interrupt for SIPC communication*/
    /* for am263x it is fixed to zero */
    uint8_t interruptConfig_Num ;
 
} SIPC_Params;
 
typedef enum SIPC_fifoFlags_
{
    ABORT_ON_FIFO_FULL,
    WAIT_IF_FIFO_FULL,
 
}SIPC_fifoFlags;
 
void SIPC_Params_init(SIPC_Params *params);
 
int32_t SIPC_init(SIPC_Params *params);
 
void  SIPC_deInit();
 
int32_t SIPC_sendMsg(uint8_t remoteSecCoreId, uint8_t remoteClientId, uint8_t localClientId ,uint8_t* msgValue, SIPC_fifoFlags waitForFifoNotFull);
 
int32_t SIPC_registerClient(uint8_t localClientId, SIPC_FxnCallback msgCallback, void *args);
 
 
int32_t SIPC_unregisterClient(uint16_t localClientId);
 
uint32_t SIPC_getSelfCoreId();
 
uint32_t SIPC_getSelfSecMasterId();
 
uint32_t SIPC_isCoreEnabled(uint32_t coreId);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPC_NOTIFY_H_ */