[ceph.git] / ceph / src / spdk / lib / bdev / nvme / bdev_nvme.h

/*-
 *   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_NVME_H
#define SPDK_BDEV_NVME_H

#include "spdk/stdinc.h"

#include "spdk/queue.h"
#include "spdk/nvme.h"
#include "spdk/bdev_module.h"

enum spdk_bdev_timeout_action {
	SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE = 0,
	SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET,
	SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT,
};

struct spdk_bdev_nvme_opts {
	enum spdk_bdev_timeout_action action_on_timeout;
	uint64_t timeout_us;
	uint32_t retry_count;
	uint64_t nvme_adminq_poll_period_us;
	uint64_t nvme_ioq_poll_period_us;
};

typedef void (*spdk_bdev_create_nvme_fn)(void *ctx, int rc);
struct spdk_nvme_qpair *spdk_bdev_nvme_get_io_qpair(struct spdk_io_channel *ctrlr_io_ch);
void spdk_bdev_nvme_get_opts(struct spdk_bdev_nvme_opts *opts);
int spdk_bdev_nvme_set_opts(const struct spdk_bdev_nvme_opts *opts);
int spdk_bdev_nvme_set_hotplug(bool enabled, uint64_t period_us, spdk_msg_fn cb, void *cb_ctx);

int spdk_bdev_nvme_create(struct spdk_nvme_transport_id *trid,
			  struct spdk_nvme_host_id *hostid,
			  const char *base_name,
			  const char **names, size_t *count,
			  const char *hostnqn,
			  uint32_t prchk_flags,
			  spdk_bdev_create_nvme_fn cb_fn,
			  void *cb_ctx);
struct spdk_nvme_ctrlr *spdk_bdev_nvme_get_ctrlr(struct spdk_bdev *bdev);

/**
 * Delete NVMe controller with all bdevs on top of it.
 * Requires to pass name of NVMe controller.
 *
 * \param name NVMe controller name
 * \return zero on success, -EINVAL on wrong parameters or -ENODEV if controller is not found
 */
int spdk_bdev_nvme_delete(const char *name);

#endif /* SPDK_BDEV_NVME_H */
Commit	Line	Data
11fdf7f2 TL	1	/*-
	2	* BSD LICENSE
	3	*
	4	* Copyright (c) Intel Corporation.
	5	* All rights reserved.
	6	*
	7	* Redistribution and use in source and binary forms, with or without
	8	* modification, are permitted provided that the following conditions
	9	* are met:
	10	*
	11	* * Redistributions of source code must retain the above copyright
	12	* notice, this list of conditions and the following disclaimer.
	13	* * Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in
	15	* the documentation and/or other materials provided with the
	16	* distribution.
	17	* * Neither the name of Intel Corporation nor the names of its
	18	* contributors may be used to endorse or promote products derived
	19	* from this software without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	22	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	23	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	24	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	25	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	26	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	27	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	28	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	29	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	30	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	31	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	32	*/
	33
	34	#ifndef SPDK_BDEV_NVME_H
	35	#define SPDK_BDEV_NVME_H
	36
	37	#include "spdk/stdinc.h"
	38
	39	#include "spdk/queue.h"
	40	#include "spdk/nvme.h"
	41	#include "spdk/bdev_module.h"
	42
11fdf7f2 TL	43	enum spdk_bdev_timeout_action {
	44	SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE = 0,
	45	SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET,
	46	SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT,
	47	};
	48
	49	struct spdk_bdev_nvme_opts {
	50	enum spdk_bdev_timeout_action action_on_timeout;
	51	uint64_t timeout_us;
	52	uint32_t retry_count;
	53	uint64_t nvme_adminq_poll_period_us;
9f95a23c	54	uint64_t nvme_ioq_poll_period_us;
11fdf7f2 TL	55	};
11fdf7f2 TL	56
9f95a23c	57	typedef void (spdk_bdev_create_nvme_fn)(void ctx, int rc);
11fdf7f2	58	struct spdk_nvme_qpair spdk_bdev_nvme_get_io_qpair(struct spdk_io_channel ctrlr_io_ch);
11fdf7f2 TL	59	void spdk_bdev_nvme_get_opts(struct spdk_bdev_nvme_opts *opts);
11fdf7f2 TL	60	int spdk_bdev_nvme_set_opts(const struct spdk_bdev_nvme_opts *opts);
9f95a23c	61	int spdk_bdev_nvme_set_hotplug(bool enabled, uint64_t period_us, spdk_msg_fn cb, void *cb_ctx);
11fdf7f2 TL	62
11fdf7f2 TL	63	int spdk_bdev_nvme_create(struct spdk_nvme_transport_id *trid,
9f95a23c	64	struct spdk_nvme_host_id *hostid,
11fdf7f2 TL	65	const char *base_name,
11fdf7f2 TL	66	const char *names, size_t count,
9f95a23c TL	67	const char *hostnqn,
	68	uint32_t prchk_flags,
	69	spdk_bdev_create_nvme_fn cb_fn,
	70	void *cb_ctx);
11fdf7f2 TL	71	struct spdk_nvme_ctrlr spdk_bdev_nvme_get_ctrlr(struct spdk_bdev bdev);
	72
	73	/**
	74	* Delete NVMe controller with all bdevs on top of it.
	75	* Requires to pass name of NVMe controller.
	76	*
	77	* \param name NVMe controller name
	78	* \return zero on success, -EINVAL on wrong parameters or -ENODEV if controller is not found
	79	*/
	80	int spdk_bdev_nvme_delete(const char *name);
	81
9f95a23c	82	#endif /* SPDK_BDEV_NVME_H */