/*
 * Copyright (c) 2014, Google, Inc. All rights reserved
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include <lib/sm.h>
#include <list.h>
#include <sys/types.h>

__BEGIN_CDECLS

enum {
    VDEV_STATE_RESET = 0,
    VDEV_STATE_ACTIVE,
};

struct vdev;

struct vdev_ops {
    size_t (*descr_sz)(struct vdev* vd);
    ssize_t (*get_descr)(struct vdev* vd, void* descr);
    status_t (*probe)(struct vdev* vd, void* descr);
    status_t (*reset)(struct vdev* vd);
    status_t (*kick_vqueue)(struct vdev* vd, uint vqid);
};

struct vdev {
    volatile int state;
    uint devid;
    uint descr_offset;
    ext_mem_client_id_t client_id;
    struct list_node node;
    const struct vdev_ops* ops;
};

struct trusty_virtio_bus;

typedef uint64_t ns_paddr_t;

/*
 * Register virtio device
 */
status_t virtio_register_device(struct trusty_virtio_bus* vb, struct vdev* vd);

/*
 * Retrieve device description to be shared with NS side
 */
ssize_t virtio_get_description(ext_mem_client_id_t client_id,
                               ext_mem_obj_id_t descr_id,
                               ns_size_t sz,
                               uint mmu_flags);

/*
 * Called by NS side to finilize initialization
 */
status_t virtio_start(ext_mem_client_id_t client_id,
                      ext_mem_obj_id_t descr_id,
                      ns_size_t sz,
                      uint mmu_flags);

/*
 * Called by NS side to deinitialize virtio subsystem
 */
status_t virtio_stop(ext_mem_client_id_t client_id,
                     ext_mem_obj_id_t descr_id,
                     ns_size_t sz,
                     uint mmu_flags,
                     bool unregister_vm_notifier);

/*
 *  Reset virtio device with specified device id
 */
status_t virtio_device_reset(ext_mem_client_id_t client_id, uint devid);

/*
 *  Kick vq for specified device
 */
status_t virtio_kick_vq(ext_mem_client_id_t client_id, uint devid, uint vqid);

struct trusty_virtio_bus_notifier {
    struct list_node node;
    status_t (*on_create)(struct trusty_virtio_bus* vb);
};

void trusty_virtio_register_bus_notifier(struct trusty_virtio_bus_notifier* n);

__END_CDECLS