Commit 3be29357 authored by Niklas Cassel's avatar Niklas Cassel Committed by Tomasz Zawadzki
Browse files

nvme: move ZNS specific functions to their own header file 



Move ZNS specific functions to their own header file:
include/spdk/nvme_zns.h.
This is similar to how it's done for e.g. NVMe-oF with
include/spdk/nvmf.h.

This avoids cluttering the nvme.h header with ZNS specific functions.

A SPDK program that wants to use the spdk_nvme_zns_* functions will
need to include include/spdk/nvme_zns.h, however, this is similar
to how e.g. spdk_nvmf namespaced functions work.
This change is safe to do now, since there is no SPDK release with
ZNS so far.

Signed-off-by: default avatarNiklas Cassel <niklas.cassel@wdc.com>
Change-Id: If39fab4e7a6924cc3bd67aa0c03e9c6de5f8a324
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4681


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent 198a3ad2

include/spdk/nvme.h

+0 −28
Original line number Diff line number Diff line
@@ -3188,34 +3188,6 @@ int spdk_nvme_map_prps(void *prv, struct spdk_nvme_cmd *cmd, struct iovec *iovs, 
		       uint32_t len, size_t mps,

		       void *(*gpa_to_vva)(void *prv, uint64_t addr, uint64_t len));



/**

 * Get the Zoned Namespace Command Set Specific Identify Namespace data

 * as defined by the NVMe Zoned Namespace Command Set Specification.

 *

 * This function is thread safe and can be called at any point while the controller

 * is attached to the SPDK NVMe driver.

 *

 * \param ns Namespace.

 *

 * \return a pointer to the namespace data, or NULL if the namespace is not

 * a Zoned Namespace.

 */

const struct spdk_nvme_zns_ns_data *spdk_nvme_zns_ns_get_data(struct spdk_nvme_ns *ns);



/**

 * Get the Zoned Namespace Command Set Specific Identify Controller data

 * as defined by the NVMe Zoned Namespace Command Set Specification.

 *

 * This function is thread safe and can be called at any point while the controller

 * is attached to the SPDK NVMe driver.

 *

 * \param ctrlr Opaque handle to NVMe controller.

 *

 * \return pointer to the controller data, or NULL if the controller does not

 * support the Zoned Command Set.

 */

const struct spdk_nvme_zns_ctrlr_data *spdk_nvme_zns_ctrlr_get_data(struct spdk_nvme_ctrlr *ctrlr);



/**

 * Opaque handle for a transport poll group. Used by the transport function table.

 */

include/spdk/nvme_zns.h

0 → 100644
+81 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) 2020, Western Digital 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.

 */



/**

 * \file

 * NVMe driver public API extension for Zoned Namespace Command Set

 */



#ifndef SPDK_NVME_ZNS_H

#define SPDK_NVME_ZNS_H



#include "spdk/stdinc.h"



#ifdef __cplusplus

extern "C" {

#endif



#include "spdk/nvme.h"



/**

 * Get the Zoned Namespace Command Set Specific Identify Namespace data

 * as defined by the NVMe Zoned Namespace Command Set Specification.

 *

 * This function is thread safe and can be called at any point while the controller

 * is attached to the SPDK NVMe driver.

 *

 * \param ns Namespace.

 *

 * \return a pointer to the namespace data, or NULL if the namespace is not

 * a Zoned Namespace.

 */

const struct spdk_nvme_zns_ns_data *spdk_nvme_zns_ns_get_data(struct spdk_nvme_ns *ns);



/**

 * Get the Zoned Namespace Command Set Specific Identify Controller data

 * as defined by the NVMe Zoned Namespace Command Set Specification.

 *

 * This function is thread safe and can be called at any point while the controller

 * is attached to the SPDK NVMe driver.

 *

 * \param ctrlr Opaque handle to NVMe controller.

 *

 * \return pointer to the controller data, or NULL if the controller does not

 * support the Zoned Command Set.

 */

const struct spdk_nvme_zns_ctrlr_data *spdk_nvme_zns_ctrlr_get_data(struct spdk_nvme_ctrlr *ctrlr);



#ifdef __cplusplus

}

#endif



#endif

lib/nvme/nvme_zns.c

+1 −0
Original line number Diff line number Diff line
@@ -30,6 +30,7 @@ 
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



#include "spdk/nvme_zns.h"

#include "nvme_internal.h"



const struct spdk_nvme_zns_ns_data *

lib/nvme/spdk_nvme.map

+1 −0
Original line number Diff line number Diff line
@@ -156,6 +156,7 @@ 


	spdk_nvme_map_prps;



	# public functions from nvme_zns.h

	spdk_nvme_zns_ns_get_data;

	spdk_nvme_zns_ctrlr_get_data;