ipc_virtio.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2018
 *  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.
 */
 
#ifndef IPC_VIRTIO_H_
#define IPC_VIRTIO_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <ti/drv/ipc/soc/ipc_soc.h>
#include <ti/drv/ipc/include/ipc_types.h>
 
typedef struct Ipc_VirtIoParams_s
{
    void      *vqObjBaseAddr;
    uint32_t  vqBufSize;
    /* Add padding members below to fix PORTING.STORAGE.STRUCT KW issue */
    uint32_t         padding;
    void      *vringBaseAddr;
    uint32_t  vringBufSize;
    uint32_t  timeoutCnt;
} Ipc_VirtIoParams;
 
uint32_t Ipc_getVqObjMemoryRequired(void);
 
uint32_t Ipc_getVqObjMemoryRequiredPerCore(void);
 
int32_t Ipc_initVirtIO(Ipc_VirtIoParams *vqParam);
 
 
int32_t Ipc_loadResourceTable(void *rsctable);
 
void * Ipc_getResourceTraceBufPtr(void);
 
Bool Ipc_isRemoteReady(uint16_t procId);
 
int32_t Ipc_lateVirtioCreate(uint16_t procId);
 
Bool Ipc_isRemoteVirtioCreated(uint32_t remoteId);
 
void Ipc_resetCoreVirtIO(uint32_t remoteId);
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef IPC_VIRTIO_H_ */
 
/* @} */