remoteproc_virtio.h

Go to the documentation of this file.

/*
 * Remoteproc Virtio Framework
 *
 * Copyright(c) 2018 Xilinx Ltd.
 * Copyright(c) 2011 Texas Instruments, Inc.
 * Copyright(c) 2011 Google, Inc.
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef REMOTEPROC_VIRTIO_H
#define REMOTEPROC_VIRTIO_H
 
#include <metal/io.h>
#include <metal/list.h>
#include <openamp/virtio.h>
#include <metal/cache.h>
 
#if defined __cplusplus
extern "C" {
#endif
 
/* maximum number of vring descriptors for a vdev limited by 16-bit data type */
#define RPROC_MAX_VRING_DESC    USHRT_MAX
 
/* cache invalidation helpers for resource table */
#if defined(VIRTIO_USE_DCACHE)
#define RSC_TABLE_FLUSH(x, s)           metal_cache_flush(x, s)
#define RSC_TABLE_INVALIDATE(x, s)      metal_cache_invalidate(x, s)
#else
#define RSC_TABLE_FLUSH(x, s)           do { } while (0)
#define RSC_TABLE_INVALIDATE(x, s)      do { } while (0)
#endif /* VIRTIO_USE_DCACHE */
 
/* define vdev notification function user should implement */
typedef int (*rpvdev_notify_func)(void *priv, uint32_t id);
 
struct remoteproc_virtio {
        void *priv;
 
        void *vdev_rsc;
 
        struct metal_io_region *vdev_rsc_io;
 
        rpvdev_notify_func notify;
 
        struct virtio_device vdev;
 
        struct metal_list node;
};
 
struct virtio_device *
rproc_virtio_create_vdev(unsigned int role, unsigned int notifyid,
                         void *rsc, struct metal_io_region *rsc_io,
                         void *priv,
                         rpvdev_notify_func notify,
                         virtio_dev_reset_cb rst_cb);
 
void rproc_virtio_remove_vdev(struct virtio_device *vdev);
 
int rproc_virtio_init_vring(struct virtio_device *vdev, unsigned int index,
                            unsigned int notifyid, void *va,
                            struct metal_io_region *io,
                            unsigned int num_descs, unsigned int align);
 
int rproc_virtio_notified(struct virtio_device *vdev, uint32_t notifyid);
 
void rproc_virtio_wait_remote_ready(struct virtio_device *vdev);
 
#if defined __cplusplus
}
#endif
 
#endif /* REMOTEPROC_VIRTIO_H */