Cdd_Ipc.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2024 Texas Instruments Incorporated
*
* 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.
*
*/

/*
 * Below are the global requirements which are met by this IPC CDD
 * driver
 */

/*
 * Design: MCAL-3699,MCAL-3697
 */

#ifndef CDD_IPC_H_
#define CDD_IPC_H_


/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include "Std_Types.h"
#include "Cdd_IpcCfg.h"



#ifdef __cplusplus
extern "C"
{
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

#define CDD_IPC_SW_MAJOR_VERSION            (10U)

#define CDD_IPC_SW_MINOR_VERSION            (0U)

#define CDD_IPC_SW_PATCH_VERSION            (1U)
/* @} */

#define CDD_IPC_AR_RELEASE_MAJOR_VERSION        (4U)

#define CDD_IPC_AR_RELEASE_MINOR_VERSION        (3U)

#define CDD_IPC_AR_RELEASE_REVISION_VERSION     (1U)
/* @} */

/*
 * Design: MCAL-7226,MCAL-7225,MCAL-7205,MCAL-7177,MCAL-7193,MCAL-7176,MCAL-7155,MCAL-7179,MCAL-7160
 */
#define CDD_IPC_MODULE_ID                       ((uint16) 255U)

#define CDD_IPC_VENDOR_ID                       ((uint16) 44U)

#define CDD_IPC_INSTANCE_ID                     ((uint8) 0U)

/* @} */


/*
 * Design: MCAL-7153,MCAL-7196,MCAL-7168,MCAL-7151,MCAL-7241,MCAL-7206,MCAL-3736,MCAL-7167
 */

#define CDD_IPC_SID_GETVERSIONINFO      (0x01U)

#define CDD_IPC_SID_INIT                (0x02U)

#define CDD_IPC_SID_SEND                (0x03U)

#define CDD_IPC_SID_RECEIVE             (0x04U)

#define CDD_IPC_SID_ANNOUNCE            (0x05U)

#define CDD_IPC_SID_INTERNAL_ISR_ID     (0x06U)

#define CDD_IPC_SID_REG_READBACK        (0x07U)

#define CDD_IPC_SID_DEINIT              (0x08U)

#define CDD_IPC_SID_CTRL_RECEIVE        (0x09U)

#define CDD_IPC_SID_IS_INIT_DONE        (0x0AU)

#define CDD_IPC_SID_GET_MAX_MSG_SIZE    (0x0BU)

#define CDD_IPC_SID_MAILBOX_STATE       (0x0CU)

/* @} */

/*
 * Design: MCAL-7226,MCAL-7225,MCAL-7205,MCAL-7177,MCAL-7193,MCAL-7176,MCAL-7155,MCAL-7179,MCAL-7160
 */
#define CDD_IPC_E_OK                            (0x00U)

#define CDD_IPC_E_INIT_FAILED                   (0x01U)

#define CDD_IPC_E_UNINIT                        (0x02U)

#define CDD_IPC_E_PARAM_POINTER                 (0x03U)

#define CDD_IPC_E_ALREADY_INITIALIZED           (0x04U)

#define CDD_IPC_E_INVALID_CONFIG                (0x05U)

#define CDD_IPC_E_SEND                          (0x06U)

#define CDD_IPC_E_RECEIVE_RETRY                 (0x07U)

#define CDD_IPC_E_NOT_SUPPORTED                 (0x08U)

#define CDD_IPC_E_CALLBACK_NULL                 (0x09U)

/* @} */

#define CDD_IPC_MAX_MSG_LEN         (496U)

#define CDD_IPC_MAX_CTRL_MSG_LEN    (32U)

#define CDD_IPC_MAX_RETRY_NOTIFY    (2U)

typedef void (*Cdd_Ipc_NewMessage)(void);
/*Function pointer for a new message from remote core at a specific channel*/

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
/*
 * Design: MCAL-7210,MCAL-7204,MCAL-7223,MCAL-7161
 */
typedef struct Cdd_IpcMpType_s
{
    uint32  ownProcID;
    uint32  numProcs;
    uint32  remoteProcID[CDD_IPC_CORE_ID_MAX];
    uint32  reserved;
} Cdd_IpcMpType;
/* @} */

/*
 * Design: MCAL-7194,MCAL-7180,MCAL-7152,MCAL-7197,MCAL-7199
 */
typedef struct Cdd_IpcVertIoType_s
{
    void    *vertIoRingAddr;
    uint32  vertIoRingSize;
    uint32  vertIoObjSize;
    uint32  reserved;
} Cdd_IpcVertIoType;
/* @} */

/*
 * Design: MCAL-7218,MCAL-7243,MCAL-7192,MCAL-7245,MCAL-7182,MCAL-7231,MCAL-7216
 */
typedef struct Cdd_IpcChannelType_s
{
    uint32  id;
    uint32  localEp;
    uint32  remoteEp;
    uint32  remoteProcId;
    uint32  numMsgQueued;
    uint32  maxMsgSize;
    Cdd_Ipc_NewMessage NewMessageNotify;
    uint32  reserved;
} Cdd_IpcChannelType;
/* @} */

/*
 * Design: MCAL-7233,MCAL-7229
 */
typedef struct Cdd_IpcConfigType_s
{
    Cdd_IpcMpType       coreIds;
    Cdd_IpcVertIoType   vertIoCfg;
    uint32              channelCount;
    P2CONST(Cdd_IpcChannelType, AUTOMATIC, CDD_IPC_CONST) pChCfg;
    uint32              reserved;
} Cdd_IpcConfigType;

/* @} */

typedef struct
{
    uint32  numRegisters;
    uint32  regValues[CDD_IPC_CORE_ID_MAX];
    uint32 cddipcRev;
    uint32 cddipcsyscfg;
    uint32 cddipceoi;
    uint32 cddipcmsg;
    uint32 cddipcfifosts;
    uint32 cddipcmsgsts;
    uint32 cddipcirqrawsts;
    uint32 cddipcclrsts;
    uint32 cddipcenbclr;
    uint32 cddipcenbset;
    uint32  reserved;
} Cdd_IpcRegRbValues;

/* @} */

typedef struct Cdd_IpcChannelBufType_s
{
    uint8 *pBuf;
    uint32  bufSize;
}Cdd_IpcChannelBufType;


/* @} */
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

#if (STD_ON == CDD_IPC_VERSION_INFO_API)
FUNC(void, CDD_IPC_CODE) Cdd_IpcGetVersionInfo(
                                        P2VAR(Std_VersionInfoType, AUTOMATIC,
                                        CDD_APP_DATA) VersionInfoPtr);
#endif

FUNC(void, CDD_IPC_CODE) Cdd_IpcInit(void);

#if (STD_ON == CDD_IPC_DEINIT_API)
FUNC(Std_ReturnType, CDD_IPC_CODE) Cdd_IpcDeinit(void);
#endif

FUNC(Std_ReturnType, CDD_IPC_CODE) Cdd_IpcSendMsg(
                                    VAR(uint32, AUTOMATIC) chId,
                                    P2CONST(void, AUTOMATIC, CDD_APP_DATA) pBuf,
                                    VAR(uint32, AUTOMATIC) bufLen);
FUNC(Std_ReturnType, CDD_IPC_CODE)Cdd_IpcReceiveMsg(
                            VAR(uint32, AUTOMATIC) chId,
                            P2VAR(void, AUTOMATIC, CDD_APP_DATA) pBuf,
                            P2VAR(uint32, AUTOMATIC, CDD_APP_DATA) bufLen);

#if (STD_ON == CDD_IPC_ANNOUNCE_API)
FUNC(Std_ReturnType, CDD_IPC_CODE) Cdd_IpcAnnounce(
                                    P2CONST(UCHAR, AUTOMATIC, CDD_APP_DATA) pBuf,
                                    VAR(uint32, AUTOMATIC) chId);
#endif /* CDD_IPC_ANNOUNCE_API */

#if (STD_ON == CDD_IPC_ANNOUNCE_API)
FUNC(Std_ReturnType, CDD_IPC_CODE) Cdd_IpcReceiveCtrlMsg (
                        P2VAR (uint32, AUTOMATIC, CDD_APP_DATA) pRemoteProcId,
                        P2VAR (uint32, AUTOMATIC, CDD_APP_DATA) pRemoteEndPt,
                        P2VAR (void, AUTOMATIC, CDD_APP_DATA) pBuf,
                        P2VAR (uint32, AUTOMATIC, CDD_APP_DATA) bufLen);
#endif /* CDD_IPC_ANNOUNCE_API */

#if (STD_ON == CDD_IPC_REGISTER_READBACK_API)
FUNC(Std_ReturnType, CDD_IPC_CODE) Cdd_IpcRegisterReadBack(uint32 remoteProcId,
                P2VAR(Cdd_IpcRegRbValues, AUTOMATIC, CDD_APP_DATA) pRegArgs);
#endif

#if (STD_ON == CDD_IPC_IS_INIT_DONE_API)
FUNC(boolean, CDD_IPC_CODE) Cdd_IpcIsInitDone(void);
#endif

#if (STD_ON == CDD_IPC_GET_MAX_MSG_SIZE_API)
FUNC(uint32, CDD_IPC_CODE) Cdd_IpcGetMaxMsgSize(VAR(uint32, AUTOMATIC) chId);
#endif

#if (STD_ON == CDD_IPC_SAFETY_DIAGNOSTIC_API)
FUNC(uint32, CDD_IPC_CODE) Cdd_IpcGetMailboxStatus(VAR(uint32, AUTOMATIC) remoteProcId);
#endif


#ifdef __cplusplus
}
#endif

#endif  /* #ifndef CDD_IPC_H_ */

/* @} */