numam-spdk/include/spdk/opal.h
Chunyang Hui 0fae4f64c4 Opal: Add support for erase locking range
Change-Id: Ie40ea642bc266f84ad5a3dbad8012b9eac178360
Signed-off-by: Chunyang Hui <chunyang.hui@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/465244
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
2019-08-20 20:38:54 +00:00

204 lines
6.6 KiB
C

/*-
* 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_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"
#define SPDK_OPAL_NOT_SUPPORTED 0xFF
#define MAX_PASSWORD_SIZE 32 /* in byte */
/*
* TCG Storage Architecture Core Spec v2.01 r1.00
* 5.1.5 Method Status Codes
*/
#define SPDK_OPAL_FAILED 0x3F
static const char *const spdk_opal_errors[] = {
"SUCCESS",
"NOT AUTHORIZED",
"OBSOLETE/UNKNOWN ERROR",
"SP BUSY",
"SP FAILED",
"SP DISABLED",
"SP FROZEN",
"NO SESSIONS AVAILABLE",
"UNIQUENESS CONFLICT",
"INSUFFICIENT SPACE",
"INSUFFICIENT ROWS",
"UNKNOWN ERROR",
"INVALID PARAMETER",
"OBSOLETE/UNKNOWN ERROR",
"UNKNOWN ERROR",
"TPER MALFUNCTION",
"TRANSACTION FAILURE",
"RESPONSE OVERFLOW",
"AUTHORITY LOCKED OUT",
};
struct spdk_opal_info {
uint8_t tper : 1;
uint8_t locking : 1;
uint8_t geometry : 1;
uint8_t single_user_mode : 1;
uint8_t datastore : 1;
uint8_t opal_v200 : 1;
uint8_t opal_v100 : 1;
uint8_t vendor_specific : 1;
uint8_t opal_ssc_dev : 1;
uint8_t tper_acknack : 1;
uint8_t tper_async : 1;
uint8_t tper_buffer_mgt : 1;
uint8_t tper_comid_mgt : 1;
uint8_t tper_streaming : 1;
uint8_t tper_sync : 1;
uint8_t locking_locked : 1;
uint8_t locking_locking_enabled : 1;
uint8_t locking_locking_supported : 1;
uint8_t locking_mbr_done : 1;
uint8_t locking_mbr_enabled : 1;
uint8_t locking_media_encrypt : 1;
uint8_t geometry_align : 1;
uint64_t geometry_alignment_granularity;
uint32_t geometry_logical_block_size;
uint64_t geometry_lowest_aligned_lba;
uint8_t single_user_any : 1;
uint8_t single_user_all : 1;
uint8_t single_user_policy : 1;
uint32_t single_user_locking_objects;
uint16_t datastore_max_tables;
uint32_t datastore_max_table_size;
uint32_t datastore_alignment;
uint16_t opal_v100_base_comid;
uint16_t opal_v100_num_comid;
uint8_t opal_v100_range_crossing : 1;
uint16_t opal_v200_base_comid;
uint16_t opal_v200_num_comid;
uint8_t opal_v200_initial_pin;
uint8_t opal_v200_reverted_pin;
uint16_t opal_v200_num_admin;
uint16_t opal_v200_num_user;
uint8_t opal_v200_range_crossing : 1;
uint16_t vu_feature_code; /* vendor specific feature */
};
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_init_dev(void *dev_handler);
void spdk_opal_close(struct spdk_opal_dev *dev);
struct spdk_opal_info *spdk_opal_get_info(struct spdk_opal_dev *dev);
bool spdk_opal_supported(struct spdk_opal_dev *dev);
int spdk_opal_cmd_scan(struct spdk_opal_dev *dev);
int spdk_opal_cmd_take_ownership(struct spdk_opal_dev *dev, char *new_passwd);
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);
struct spdk_opal_locking_range_info *spdk_opal_get_locking_range_info(struct spdk_opal_dev *dev,
enum spdk_opal_locking_range id);
uint8_t spdk_opal_get_max_locking_ranges(struct spdk_opal_dev *dev);
#endif