Spdk/module/bdev/iscsi/bdev_iscsi.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

48 lines
1.4 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
*/
#ifndef SPDK_BDEV_ISCSI_H
#define SPDK_BDEV_ISCSI_H
#include "spdk/bdev.h"
typedef void (*spdk_delete_iscsi_complete)(void *cb_arg, int bdeverrno);
/**
* SPDK bdev iSCSI callback type.
*
* \param cb_arg Completion callback custom arguments
* \param bdev created bdev
* \param status operation status. Zero on success.
*/
typedef void (*spdk_bdev_iscsi_create_cb)(void *cb_arg, struct spdk_bdev *bdev, int status);
/**
* Create new iSCSI bdev.
*
* \warning iSCSI URL allow providing login and password. Be careful because
* they will show up in configuration dump.
*
* \param name name for new bdev.
* \param url iSCSI URL string.
* \param initiator_iqn connection iqn name we identify to target as
* \param cb_fn Completion callback
* \param cb_arg Completion callback custom arguments
* \return 0 on success or negative error code. If success bdev with provided name was created.
*/
int create_iscsi_disk(const char *bdev_name, const char *url, const char *initiator_iqn,
spdk_bdev_iscsi_create_cb cb_fn, void *cb_arg);
/**
* Delete iSCSI bdev.
*
* \param bdev_name Name of iSCSI bdev.
* \param cb_fn Completion callback
* \param cb_arg Completion callback custom arguments
*/
void delete_iscsi_disk(const char *bdev_name, spdk_delete_iscsi_complete cb_fn, void *cb_arg);
#endif /* SPDK_BDEV_ISCSI_H */