ipc_rpmsg.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2023 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 IPC_RPMSG_H_
#define IPC_RPMSG_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <kernel/dpl/SemaphoreP.h>
#include <drivers/hw_include/cslr_soc.h>
#include <drivers/ipc_rpmsg/ipc_rpmsg_queue.h>
#include <drivers/ipc_rpmsg/include/ipc_rpmsg_linux_resource_table.h>
 
#define RPMESSAGE_MAX_LOCAL_ENDPT       (64U)
 
#define RPMESSAGE_VRING_ADDR_INVALID      (0xFFFFFFFFU)
 
#define RPMESSAGE_VRING_SIZE(numBuf, bufSize)       (((numBuf)*(uint16_t)((bufSize)+32U))+32U)
 
#define RPMESSAGE_OBJECT_SIZE_MAX    (192U)
 
#define RPMESSAGE_CRC_SIZE           (2U)
 
struct RPMessage_Object_s;
 
typedef void (*RPMessage_RecvCallback)(struct RPMessage_Object_s *obj, void *arg,
    void *data, uint16_t dataLen, int32_t crcStatus,
    uint16_t remoteCoreId, uint16_t remoteEndPt);
 
typedef void (*RPMessage_RecvNotifyCallback)(struct RPMessage_Object_s *obj, void *arg);
 
 
typedef void (*RPMessage_ControlEndPtCallback)(void *arg,
    uint16_t remoteCoreId, uint16_t remoteEndPt, const char *remoteServiceName);
 
typedef int32_t (*RPMessage_CrcHookFxn)(uint8_t *data, uint16_t dataLen, uint8_t crcSize, void *crc);
 
/* structure to hold state of RPMessage end point */
typedef struct RPMessage_Object_s
{
    uint16_t localEndPt;    /* local end point number, MUST be < RPMESSAGE_MAX_LOCAL_ENDPT */
    RPMessage_RecvCallback recvCallback;    /* when not NULL, received messages are handled in callback that via RPMessage_recv */
    void *recvCallbackArgs;     /* arguments passed to the recvCallback callback */
    uint32_t doRecvUnblock;     /* flag to unblock RPMessage_recv, if its blocked for every waiting for messages and user wants to shutdown or exit */
    RPMessage_Queue endPtQ;     /* end point specific queue to hold received messages pending for processing at this end point */
    SemaphoreP_Object newEndPtMsgSem; /* semaphore to indicate that there messages pending endPtQ */
    RPMessage_RecvNotifyCallback recvNotifyCallback;    /* when not NULL, this callback is whenever a message is received */
    void *recvNotifyCallbackArgs;     /* arguments passed to the recvNotifyCallback callback */
} RPMessage_Object;
 
typedef struct
{
    uint16_t localEndPt;    
    RPMessage_RecvCallback recvCallback;    
    void *recvCallbackArgs; 
    RPMessage_RecvNotifyCallback recvNotifyCallback;    
    void *recvNotifyCallbackArgs; 
} RPMessage_CreateParams;
 
typedef struct
{
    uintptr_t vringTxBaseAddr[CSL_CORE_ID_MAX];  
    uintptr_t vringRxBaseAddr[CSL_CORE_ID_MAX];  
    uint32_t vringSize;                   
    uint16_t vringNumBuf;                 
    uint16_t vringMsgSize;                
    const RPMessage_ResourceTable *linuxResourceTable;  
    uint16_t linuxCoreId; 
    uint8_t  isCrcEnabled; /* CRC Enable/Disable flag */
    RPMessage_CrcHookFxn crcHookFxn; /* Hook Function to be provided by application for CRC calculation */
} RPMessage_Params;
 
void     RPMessage_Params_init(RPMessage_Params *params);
 
void     RPMessage_CreateParams_init(RPMessage_CreateParams *params);
 
int32_t  RPMessage_init(const RPMessage_Params *params);
 
void     RPMessage_deInit(void);
 
int32_t  RPMessage_waitForLinuxReady(uint32_t timeout);
 
void RPMessage_controlEndPtCallback(RPMessage_ControlEndPtCallback controlEndPtCallback,
    void  *controlEndPtCallbackArgs);
 
int32_t  RPMessage_construct(RPMessage_Object *obj, const RPMessage_CreateParams *createParams);
 
void     RPMessage_destruct(RPMessage_Object *obj);
 
void     RPMessage_unblock(RPMessage_Object *obj);
 
uint16_t RPMessage_getLocalEndPt(const RPMessage_Object *obj);
 
int32_t  RPMessage_announce(uint16_t remoteProcId, uint16_t localEndPt, const char* name);
 
int32_t  RPMessage_send( void   *data,
                        uint16_t dataLen,
                        uint16_t remoteCoreId,
                        uint16_t remoteEndPt,
                        uint16_t localEndPt,
                        uint32_t timeout
                      );
 
int32_t  RPMessage_recv(RPMessage_Object *obj, void* data, uint16_t *dataLen,
                      uint16_t *remoteCoreId, uint16_t *remoteEndPt, uint32_t timeout);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPC_RPMSG_H_ */