ipc_rsctypes.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2020, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 */
 
/*
 *  \file ipc_rsctypes.h
 *
 *  \brief Include common definitions for sizes and type of resources
 *  used by the the resource table in each base image, which is
 *  read from remoteproc on host side.
 *
 */
 
#ifndef IPC_RSCTYPES_H_
#define IPC_RSCTYPES_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <ti/drv/ipc/include/ipc_types.h>
 
/* Virtio Ids: keep in sync with the linux "include/linux/virtio_ids.h" */
#define VIRTIO_ID_CONSOLE       3
 
#define VIRTIO_ID_RPMSG         7
 
/* Indices of rpmsg virtio features we support */
#define VIRTIO_RPMSG_F_NS       0
#define VIRTIO_RING_F_SYMMETRIC 30
 
#define IPC_RP_MBOX_READY                     ((uint32_t)0xFFFFFF00U)
#define IPC_RP_MBOX_PENDING_MSG               ((uint32_t)0xFFFFFF01U)
#define IPC_RP_MBOX_CRASH                     ((uint32_t)0xFFFFFF02U)
#define IPC_RP_MBOX_ECHO_REQUEST              ((uint32_t)0xFFFFFF03U)
#define IPC_RP_MBOX_ECHO_REPLY                ((uint32_t)0xFFFFFF04U)
#define IPC_RP_MBOX_ABORT_REQUEST             ((uint32_t)0xFFFFFF05U)
#define IPC_RP_MBOX_SUSPEND_AUTO              ((uint32_t)0xFFFFFF10U)
#define IPC_RP_MBOX_SUSPEND_SYSTEM            ((uint32_t)0xFFFFFF11U)
#define IPC_RP_MBOX_SUSPEND_ACK               ((uint32_t)0xFFFFFF12U)
#define IPC_RP_MBOX_SUSPEND_CANCEL            ((uint32_t)0xFFFFFF13U)
#define IPC_RP_MBOX_SHUTDOWN                  ((uint32_t)0xFFFFFF14U)
#define IPC_RP_MBOX_SHUTDOWN_ACK              ((uint32_t)0xFFFFFF15U)
#define IPC_RP_MBOX_END_MSG                   ((uint32_t)0xFFFFFF16U)
/* @} */
 
/* Resource info: Must match include/linux/remoteproc.h: */
#define TYPE_CARVEOUT    0U
#define TYPE_DEVMEM      1U
#define TYPE_TRACE       2U
#define TYPE_VDEV        3U
 
/* Linux kernel defines this as (-1), below define avoids compile warnings */
#define FW_RSC_ADDR_ANY (~0)
 
#define NUM_ENTRIES      2
 
#define NAME_LEN         32
 
 
#define TRACE_INTS_VER0        (0 << 16)
#define TRACE_INTS_VER1        (1 << 16)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t ver;
    uint32_t num;
    uint32_t reserved[2];
}Ipc_Hdr;
 
typedef struct
{
    uint32_t  type;
#if defined(BUILD_C7X)
    /* Add padding members below to fix PORTING.STORAGE.STRUCT KW issue */
    uint32_t  padding;
    uint64_t  da;
#else
    uint32_t  da;
#endif
    uint32_t  len;
    uint32_t  reserved;
    uint8_t   name[NAME_LEN];
}Ipc_Trace;
 
typedef struct
{
    uint32_t  da;
    uint32_t  align;
    uint32_t  num;
    uint32_t  notifyid;
    uint32_t  reserved;
    /* Add padding members below to fix PORTING.STORAGE.STRUCT KW issue */
    uint32_t  padding;
}Ipc_VDevVRing;
 
typedef struct
{
    uint32_t  type;
    uint32_t  id;
    uint32_t  notifyid;
    uint32_t  dfeatures;
    uint32_t  gfeatures;
    uint32_t  config_len;
    uint8_t   status;
    uint8_t   num_of_vrings;
    uint8_t   reserved[2];
    /* Add padding members below to fix PORTING.STORAGE.STRUCT KW issue */
    uint32_t  padding;
}Ipc_VDev;
 
typedef struct
{
    Ipc_Hdr base;
    uint32_t offset[NUM_ENTRIES];
    Ipc_VDev       rpmsg_vdev;
    Ipc_VDevVRing  rpmsg_vring0;
    Ipc_VDevVRing  rpmsg_vring1;
    /* trace entry */
    Ipc_Trace     trace;
}Ipc_ResourceTable;
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* IPC_RSCTYPES_H_ */
 
/* @} */