/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ /* * Copyright © 2016 Intel Corporation * * Authors: * Rafael Antognolli <rafael.antognolli@intel.com> * Scott Bauer <scott.bauer@intel.com> */ #ifndef _SED_OPAL_H #define _SED_OPAL_H #include <linux/types.h> #define OPAL_KEY_MAX 256 #define OPAL_MAX_LRS 9 enum opal_mbr { OPAL_MBR_ENABLE = 0x0, OPAL_MBR_DISABLE = 0x01, }; enum opal_mbr_done_flag { OPAL_MBR_NOT_DONE = 0x0, OPAL_MBR_DONE = 0x01 }; enum 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 opal_lock_state { OPAL_RO = 0x01, /* 0001 */ OPAL_RW = 0x02, /* 0010 */ OPAL_LK = 0x04, /* 0100 */ }; enum opal_lock_flags { /* IOC_OPAL_SAVE will also store the provided key for locking */ OPAL_SAVE_FOR_LOCK = 0x01, }; enum opal_key_type { OPAL_INCLUDED = 0, /* key[] is the key */ OPAL_KEYRING, /* key is in keyring */ }; struct opal_key { __u8 lr; __u8 key_len; __u8 key_type; __u8 __align[5]; __u8 key[OPAL_KEY_MAX]; }; enum opal_revert_lsp_opts { OPAL_PRESERVE = 0x01, }; struct opal_lr_act { struct opal_key key; __u32 sum; __u8 num_lrs; __u8 lr[OPAL_MAX_LRS]; __u8 align[2]; /* Align to 8 byte boundary */ }; struct opal_session_info { __u32 sum; __u32 who; struct opal_key opal_key; }; struct opal_user_lr_setup { __u64 range_start; __u64 range_length; __u32 RLE; /* Read Lock enabled */ __u32 WLE; /* Write Lock Enabled */ struct opal_session_info session; }; struct opal_lr_status { struct opal_session_info session; __u64 range_start; __u64 range_length; __u32 RLE; /* Read Lock enabled */ __u32 WLE; /* Write Lock Enabled */ __u32 l_state; __u8 align[4]; }; struct opal_lock_unlock { struct opal_session_info session; __u32 l_state; __u16 flags; __u8 __align[2]; }; struct opal_new_pw { struct opal_session_info session; /* When we're not operating in sum, and we first set * passwords we need to set them via ADMIN authority. * After passwords are changed, we can set them via, * User authorities. * Because of this restriction we need to know about * Two different users. One in 'session' which we will use * to start the session and new_userr_pw as the user we're * chaning the pw for. */ struct opal_session_info new_user_pw; }; struct opal_mbr_data { struct opal_key key; __u8 enable_disable; __u8 __align[7]; }; struct opal_mbr_done { struct opal_key key; __u8 done_flag; __u8 __align[7]; }; struct opal_shadow_mbr { struct opal_key key; const __u64 data; __u64 offset; __u64 size; }; /* Opal table operations */ enum opal_table_ops { OPAL_READ_TABLE, OPAL_WRITE_TABLE, }; #define OPAL_UID_LENGTH 8 struct opal_read_write_table { struct opal_key key; const __u64 data; const __u8 table_uid[OPAL_UID_LENGTH]; __u64 offset; __u64 size; #define OPAL_TABLE_READ (1 << OPAL_READ_TABLE) #define OPAL_TABLE_WRITE (1 << OPAL_WRITE_TABLE) __u64 flags; __u64 priv; }; #define OPAL_FL_SUPPORTED 0x00000001 #define OPAL_FL_LOCKING_SUPPORTED 0x00000002 #define OPAL_FL_LOCKING_ENABLED 0x00000004 #define OPAL_FL_LOCKED 0x00000008 #define OPAL_FL_MBR_ENABLED 0x00000010 #define OPAL_FL_MBR_DONE 0x00000020 #define OPAL_FL_SUM_SUPPORTED 0x00000040 struct opal_status { __u32 flags; __u32 reserved; }; /* * Geometry Reporting per TCG Storage OPAL SSC * section 3.1.1.4 */ struct opal_geometry { __u8 align; __u32 logical_block_size; __u64 alignment_granularity; __u64 lowest_aligned_lba; __u8 __align[3]; }; struct opal_discovery { __u64 data; __u64 size; }; struct opal_revert_lsp { struct opal_key key; __u32 options; __u32 __pad; }; #define IOC_OPAL_SAVE _IOW('p', 220, struct opal_lock_unlock) #define IOC_OPAL_LOCK_UNLOCK _IOW('p', 221, struct opal_lock_unlock) #define IOC_OPAL_TAKE_OWNERSHIP _IOW('p', 222, struct opal_key) #define IOC_OPAL_ACTIVATE_LSP _IOW('p', 223, struct opal_lr_act) #define IOC_OPAL_SET_PW _IOW('p', 224, struct opal_new_pw) #define IOC_OPAL_ACTIVATE_USR _IOW('p', 225, struct opal_session_info) #define IOC_OPAL_REVERT_TPR _IOW('p', 226, struct opal_key) #define IOC_OPAL_LR_SETUP _IOW('p', 227, struct opal_user_lr_setup) #define IOC_OPAL_ADD_USR_TO_LR _IOW('p', 228, struct opal_lock_unlock) #define IOC_OPAL_ENABLE_DISABLE_MBR _IOW('p', 229, struct opal_mbr_data) #define IOC_OPAL_ERASE_LR _IOW('p', 230, struct opal_session_info) #define IOC_OPAL_SECURE_ERASE_LR _IOW('p', 231, struct opal_session_info) #define IOC_OPAL_PSID_REVERT_TPR _IOW('p', 232, struct opal_key) #define IOC_OPAL_MBR_DONE _IOW('p', 233, struct opal_mbr_done) #define IOC_OPAL_WRITE_SHADOW_MBR _IOW('p', 234, struct opal_shadow_mbr) #define IOC_OPAL_GENERIC_TABLE_RW _IOW('p', 235, struct opal_read_write_table) #define IOC_OPAL_GET_STATUS _IOR('p', 236, struct opal_status) #define IOC_OPAL_GET_LR_STATUS _IOW('p', 237, struct opal_lr_status) #define IOC_OPAL_GET_GEOMETRY _IOR('p', 238, struct opal_geometry) #define IOC_OPAL_DISCOVERY _IOW('p', 239, struct opal_discovery) #define IOC_OPAL_REVERT_LSP _IOW('p', 240, struct opal_revert_lsp) #define IOC_OPAL_SET_SID_PW _IOW('p', 241, struct opal_new_pw) #endif /* _SED_OPAL_H */