/*-
 *   BSD LICENSE
 *
 *   Copyright (c) Intel Corporation.
 *   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 Intel Corporation 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 SPDK_BDEV_VIRTIO_H
#define SPDK_BDEV_VIRTIO_H

#include "spdk/bdev.h"

typedef void (*virtio_create_device_cb)(void *, int, struct spdk_bdev **, size_t size);

/**
 * Add new Virtio SCSI device and scan it. When LUN is found bdev is automaticly
 * added to point this LUN.
 *
 * \param path
 *   Path to socket.
 * \param base_name
 *   Name to used for all bdevs created from this device.
 * \param vq_size
 *   Max queue size.
 * \param cb_fn
 *   An optional callback to be called after scanning all targets on the controller.
 *   First parameter is \c cb_arg
 *   Second parameter is error code. Zero on succes or negative error code.
 *   Third parameter is bdevs array found on created device. NULL in case of error.
 *   Fourth is number of bdevs in array. Zero in case of error.
 * \param cb_arg1
 *   First argument of \c cb_fn
 * \return
 *   Zero on success (device scan is started) or negative error code.
 *   In case of error \c done_cb is not called.
 */
int create_virtio_user_scsi_device(const char *base_name, const char *path, unsigned num_queues,
				   unsigned queue_size, virtio_create_device_cb cb_fn, void *cb_arg);

#endif /* SPDK_BDEV_VIRTIO_H */