app_ipc.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) 2017 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.
 *
 */

#ifndef APP_IPC_H_
#define APP_IPC_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>

/* #define APP_IPC_DEBUG */

#if defined (SOC_J721E)

#define APP_IPC_CPU_MPU1_0  ( 0u)

#define APP_IPC_CPU_MCU1_0  ( 1u)

#define APP_IPC_CPU_MCU1_1  ( 2u)

#define APP_IPC_CPU_MCU2_0  ( 3u)

#define APP_IPC_CPU_MCU2_1  ( 4u)

#define APP_IPC_CPU_MCU3_0  ( 5u)

#define APP_IPC_CPU_MCU3_1  ( 6u)

#define APP_IPC_CPU_C6x_1   ( 7u)

#define APP_IPC_CPU_C6x_2   ( 8u)

#define APP_IPC_CPU_C7x_1   ( 9u)

#define APP_IPC_CPU_MAX     (10u)

#define APP_IPC_CPU_INVALID (0xFFu)
#endif

#if defined (SOC_J721S2)

#define APP_IPC_CPU_MPU1_0  ( 0u)

#define APP_IPC_CPU_MCU1_0  ( 1u)

#define APP_IPC_CPU_MCU1_1  ( 2u)

#define APP_IPC_CPU_MCU2_0  ( 3u)

#define APP_IPC_CPU_MCU2_1  ( 4u)

#define APP_IPC_CPU_MCU3_0  ( 5u)

#define APP_IPC_CPU_MCU3_1  ( 6u)

#define APP_IPC_CPU_C7x_1   ( 7u)

#define APP_IPC_CPU_C7x_2   ( 8u)

#define APP_IPC_CPU_MAX     ( 9u)

#define APP_IPC_CPU_INVALID (0xFFu)
#endif

#if defined (SOC_J784S4)

#define APP_IPC_CPU_MPU1_0  ( 0u)

#define APP_IPC_CPU_MCU1_0  ( 1u)

#define APP_IPC_CPU_MCU1_1  ( 2u)

#define APP_IPC_CPU_MCU2_0  ( 3u)

#define APP_IPC_CPU_MCU2_1  ( 4u)

#define APP_IPC_CPU_MCU3_0  ( 5u)

#define APP_IPC_CPU_MCU3_1  ( 6u)

#define APP_IPC_CPU_MCU4_0  ( 7u)

#define APP_IPC_CPU_MCU4_1  ( 8u)

#define APP_IPC_CPU_C7x_1   ( 9u)

#define APP_IPC_CPU_C7x_2   (10u)

#define APP_IPC_CPU_C7x_3   (11u)

#define APP_IPC_CPU_C7x_4   (12u)

#define APP_IPC_CPU_MAX     (13u)

#define APP_IPC_CPU_INVALID (0xFFu)
#endif

#if defined (SOC_J742S2)

#define APP_IPC_CPU_MPU1_0  ( 0u)

#define APP_IPC_CPU_MCU1_0  ( 1u)

#define APP_IPC_CPU_MCU1_1  ( 2u)

#define APP_IPC_CPU_MCU2_0  ( 3u)

#define APP_IPC_CPU_MCU2_1  ( 4u)

#define APP_IPC_CPU_MCU3_0  ( 5u)

#define APP_IPC_CPU_MCU3_1  ( 6u)

#define APP_IPC_CPU_MCU4_0  ( 7u)

#define APP_IPC_CPU_MCU4_1  ( 8u)

#define APP_IPC_CPU_C7x_1   ( 9u)

#define APP_IPC_CPU_C7x_2   (10u)

#define APP_IPC_CPU_C7x_3   (11u)

#define APP_IPC_CPU_MAX     (12u)

#define APP_IPC_CPU_INVALID (0xFFu)
#endif

#if defined (SOC_AM62A)

#define APP_IPC_CPU_MPU1_0  ( 0u)

#define APP_IPC_CPU_MCU1_0  ( 1u)

#define APP_IPC_CPU_C7x_1   ( 2u)

#define APP_IPC_CPU_MAX     ( 3u)

#define APP_IPC_CPU_INVALID (0xFFu)
#if defined(MCU_PLUS_SDK)
#define    IPC_MAX_PROCS        (3U)    
#endif
#endif

#if defined (SOC_J722S)

#define APP_IPC_CPU_MPU1_0  ( 0u)

#define APP_IPC_CPU_MCU1_0  ( 1u)

#define APP_IPC_CPU_MCU2_0  ( 2u)

#define APP_IPC_CPU_C7x_1   ( 3u)

#define APP_IPC_CPU_C7x_2   ( 4u)

#define APP_IPC_CPU_MCU_R5F ( 5u)

#define APP_IPC_CPU_MAX     ( 6u)

#define APP_IPC_CPU_INVALID (0xFFu)
#if defined(MCU_PLUS_SDK)
#define    IPC_MAX_PROCS        (6U)    
#endif
#endif

/* @} */

#define APP_IPC_HW_LOCK_MAX     (256u)

#define APP_IPC_WAIT_FOREVER    (0xFFFFFFFFu)

#define APP_IPC_TIOVX_RPMSG_PORT_ID      (13u)

#define APP_IPC_REMOTE_SERVICE_RPMSG_PORT_ID      (21u)

#define APP_IPC_ECHO_TEST_RPMSG_PORT_ID  (14u)

#define APP_IPC_RPMSG_PROTO_ECHO_TEST_RPMSG_PORT_ID  (12u)

/* @} */

typedef void (*app_ipc_notify_handler_f)(uint32_t src_cpu_id, uint32_t payload);


typedef struct {

    uint32_t num_cpus; 
    uint32_t enabled_cpu_id_list[APP_IPC_CPU_MAX]; 
    uint32_t tiovx_rpmsg_port_id; 
    void     *tiovx_obj_desc_mem;  
    uint32_t tiovx_obj_desc_mem_size; 
    void     *ipc_vring_mem; 
    uint32_t ipc_vring_mem_size; 
    void     *tiovx_log_rt_mem;  
    uint32_t tiovx_log_rt_mem_size; 
    uint32_t self_cpu_id;  
    void     *ipc_resource_tbl; 
    uint32_t enable_tiovx_ipc_announce; 
} app_ipc_init_prm_t;

void appIpcInitPrmSetDefault(app_ipc_init_prm_t *prm);

int32_t appIpcInit(app_ipc_init_prm_t *prm);

int32_t appIpcDeInit(void);

int32_t appIpcRegisterNotifyHandler(app_ipc_notify_handler_f handler);

int32_t appIpcSendNotify(uint32_t dest_cpu_id, uint32_t payload);

int32_t appIpcSendNotifyPort(uint32_t dest_cpu_id, uint32_t payload, uint32_t port_id);

uint32_t appIpcGetSelfCpuId(void);

uint32_t appIpcGetHostPortId(uint16_t cpu_id);

uint32_t appIpcIsCpuEnabled(uint32_t cpu_id);

int32_t appIpcHwLockAcquire(uint32_t lock_id, uint32_t timeout);

int32_t appIpcHwLockRelease(uint32_t lock_id);

int32_t appIpcGetTiovxObjDescSharedMemInfo(void **addr, uint32_t *size);

void appIpcGetTiovxLogRtSharedMemInfo(void **shm_base, uint32_t *shm_size);

uint32_t appIpcGetIpcCpuId(uint32_t app_cpu_id);


uint32_t appIpcGetAppCpuId(char *name);

const char *appIpcGetCpuName(uint32_t app_cpu_id);

int32_t appIpcEchoTestStart(void);

#ifdef __cplusplus
}
#endif

/* @} */

#endif /* APP_IPC_H_ */