488570ebd4
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>
116 lines
3.7 KiB
C
116 lines
3.7 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#ifndef SPDK_OPAL_H
|
|
#define SPDK_OPAL_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
#include "spdk/nvme.h"
|
|
#include "spdk/log.h"
|
|
#include "spdk/endian.h"
|
|
#include "spdk/string.h"
|
|
#include "spdk/opal_spec.h"
|
|
|
|
struct spdk_opal_d0_features_info {
|
|
struct spdk_opal_d0_tper_feat tper;
|
|
struct spdk_opal_d0_locking_feat locking;
|
|
struct spdk_opal_d0_single_user_mode_feat single_user;
|
|
struct spdk_opal_d0_geo_feat geo;
|
|
struct spdk_opal_d0_datastore_feat datastore;
|
|
struct spdk_opal_d0_v100_feat v100;
|
|
struct spdk_opal_d0_v200_feat v200;
|
|
};
|
|
|
|
enum spdk_opal_lock_state {
|
|
OPAL_READONLY = 0x01,
|
|
OPAL_RWLOCK = 0x02,
|
|
OPAL_READWRITE = 0x04,
|
|
};
|
|
|
|
enum spdk_opal_user {
|
|
OPAL_ADMIN1 = 0x0,
|
|
OPAL_USER1 = 0x01,
|
|
OPAL_USER2 = 0x02,
|
|
OPAL_USER3 = 0x03,
|
|
OPAL_USER4 = 0x04,
|
|
OPAL_USER5 = 0x05,
|
|
OPAL_USER6 = 0x06,
|
|
OPAL_USER7 = 0x07,
|
|
OPAL_USER8 = 0x08,
|
|
OPAL_USER9 = 0x09,
|
|
};
|
|
|
|
enum spdk_opal_locking_range {
|
|
OPAL_LOCKING_RANGE_GLOBAL = 0x0,
|
|
OPAL_LOCKING_RANGE_1,
|
|
OPAL_LOCKING_RANGE_2,
|
|
OPAL_LOCKING_RANGE_3,
|
|
OPAL_LOCKING_RANGE_4,
|
|
OPAL_LOCKING_RANGE_5,
|
|
OPAL_LOCKING_RANGE_6,
|
|
OPAL_LOCKING_RANGE_7,
|
|
OPAL_LOCKING_RANGE_8,
|
|
OPAL_LOCKING_RANGE_9,
|
|
OPAL_LOCKING_RANGE_10,
|
|
};
|
|
|
|
struct spdk_opal_locking_range_info {
|
|
uint8_t locking_range_id;
|
|
uint8_t _padding[7];
|
|
uint64_t range_start;
|
|
uint64_t range_length;
|
|
bool read_lock_enabled;
|
|
bool write_lock_enabled;
|
|
bool read_locked;
|
|
bool write_locked;
|
|
};
|
|
|
|
struct spdk_opal_dev;
|
|
|
|
struct spdk_opal_dev *spdk_opal_dev_construct(struct spdk_nvme_ctrlr *ctrlr);
|
|
void spdk_opal_dev_destruct(struct spdk_opal_dev *dev);
|
|
|
|
struct spdk_opal_d0_features_info *spdk_opal_get_d0_features_info(struct spdk_opal_dev *dev);
|
|
|
|
int spdk_opal_cmd_take_ownership(struct spdk_opal_dev *dev, char *new_passwd);
|
|
|
|
/**
|
|
* synchronous function: send and then receive.
|
|
*
|
|
* Wait until response is received.
|
|
*/
|
|
int spdk_opal_cmd_revert_tper(struct spdk_opal_dev *dev, const char *passwd);
|
|
|
|
int spdk_opal_cmd_activate_locking_sp(struct spdk_opal_dev *dev, const char *passwd);
|
|
int spdk_opal_cmd_lock_unlock(struct spdk_opal_dev *dev, enum spdk_opal_user user,
|
|
enum spdk_opal_lock_state flag, enum spdk_opal_locking_range locking_range,
|
|
const char *passwd);
|
|
int spdk_opal_cmd_setup_locking_range(struct spdk_opal_dev *dev, enum spdk_opal_user user,
|
|
enum spdk_opal_locking_range locking_range_id, uint64_t range_start,
|
|
uint64_t range_length, const char *passwd);
|
|
|
|
int spdk_opal_cmd_get_max_ranges(struct spdk_opal_dev *dev, const char *passwd);
|
|
int spdk_opal_cmd_get_locking_range_info(struct spdk_opal_dev *dev, const char *passwd,
|
|
enum spdk_opal_user user_id,
|
|
enum spdk_opal_locking_range locking_range_id);
|
|
int spdk_opal_cmd_enable_user(struct spdk_opal_dev *dev, enum spdk_opal_user user_id,
|
|
const char *passwd);
|
|
int spdk_opal_cmd_add_user_to_locking_range(struct spdk_opal_dev *dev, enum spdk_opal_user user_id,
|
|
enum spdk_opal_locking_range locking_range_id,
|
|
enum spdk_opal_lock_state lock_flag, const char *passwd);
|
|
int spdk_opal_cmd_set_new_passwd(struct spdk_opal_dev *dev, enum spdk_opal_user user_id,
|
|
const char *new_passwd, const char *old_passwd, bool new_user);
|
|
|
|
int spdk_opal_cmd_erase_locking_range(struct spdk_opal_dev *dev, enum spdk_opal_user user_id,
|
|
enum spdk_opal_locking_range locking_range_id, const char *password);
|
|
|
|
int spdk_opal_cmd_secure_erase_locking_range(struct spdk_opal_dev *dev, enum spdk_opal_user user_id,
|
|
enum spdk_opal_locking_range locking_range_id, const char *password);
|
|
|
|
struct spdk_opal_locking_range_info *spdk_opal_get_locking_range_info(struct spdk_opal_dev *dev,
|
|
enum spdk_opal_locking_range id);
|
|
void spdk_opal_free_locking_range_info(struct spdk_opal_dev *dev, enum spdk_opal_locking_range id);
|
|
#endif
|