[linux-block.git] / include / uapi / linux / sed-opal.h

/* 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 _UAPI_SED_OPAL_H
#define _UAPI_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 */
};

struct opal_key {
	__u8 lr;
	__u8 key_len;
	__u8 __align[6];
	__u8 key[OPAL_KEY_MAX];
};

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_lock_unlock {
	struct opal_session_info session;
	__u32 l_state;
	__u8 __align[4];
};

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;
};

#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)

#endif /* _UAPI_SED_OPAL_H */
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
19641f2d SB	2	/*
	3	* Copyright © 2016 Intel Corporation
	4	*
	5	* Authors:
	6	* Rafael Antognolli <rafael.antognolli@intel.com>
	7	* Scott Bauer <scott.bauer@intel.com>
19641f2d SB	8	*/
	9
	10	#ifndef _UAPI_SED_OPAL_H
	11	#define _UAPI_SED_OPAL_H
	12
	13	#include <linux/types.h>
	14
	15	#define OPAL_KEY_MAX 256
	16	#define OPAL_MAX_LRS 9
	17
	18	enum opal_mbr {
	19	OPAL_MBR_ENABLE = 0x0,
	20	OPAL_MBR_DISABLE = 0x01,
	21	};
	22
c9888443 JR	23	enum opal_mbr_done_flag {
	24	OPAL_MBR_NOT_DONE = 0x0,
	25	OPAL_MBR_DONE = 0x01
	26	};
	27
19641f2d SB	28	enum opal_user {
	29	OPAL_ADMIN1 = 0x0,
	30	OPAL_USER1 = 0x01,
	31	OPAL_USER2 = 0x02,
	32	OPAL_USER3 = 0x03,
	33	OPAL_USER4 = 0x04,
	34	OPAL_USER5 = 0x05,
	35	OPAL_USER6 = 0x06,
	36	OPAL_USER7 = 0x07,
	37	OPAL_USER8 = 0x08,
	38	OPAL_USER9 = 0x09,
	39	};
	40
	41	enum opal_lock_state {
	42	OPAL_RO = 0x01, /* 0001 */
	43	OPAL_RW = 0x02, /* 0010 */
	44	OPAL_LK = 0x04, /* 0100 */
	45	};
	46
	47	struct opal_key {
8c87fe72 SB	48	__u8 lr;
	49	__u8 key_len;
	50	__u8 __align[6];
	51	__u8 key[OPAL_KEY_MAX];
19641f2d SB	52	};
	53
	54	struct opal_lr_act {
19641f2d	55	struct opal_key key;
8c87fe72	56	__u32 sum;
1e815b33	57	__u8 num_lrs;
8c87fe72 SB	58	__u8 lr[OPAL_MAX_LRS];
8c87fe72 SB	59	__u8 align[2]; /* Align to 8 byte boundary */
19641f2d SB	60	};
	61
	62	struct opal_session_info {
8c87fe72 SB	63	__u32 sum;
8c87fe72 SB	64	__u32 who;
19641f2d	65	struct opal_key opal_key;
19641f2d SB	66	};
	67
	68	struct opal_user_lr_setup {
8c87fe72 SB	69	__u64 range_start;
	70	__u64 range_length;
	71	__u32 RLE; /* Read Lock enabled */
	72	__u32 WLE; /* Write Lock Enabled */
19641f2d	73	struct opal_session_info session;
19641f2d SB	74	};
	75
	76	struct opal_lock_unlock {
19641f2d	77	struct opal_session_info session;
8c87fe72 SB	78	__u32 l_state;
8c87fe72 SB	79	__u8 __align[4];
19641f2d SB	80	};
	81
	82	struct opal_new_pw {
	83	struct opal_session_info session;
	84
	85	/* When we're not operating in sum, and we first set
	86	* passwords we need to set them via ADMIN authority.
	87	* After passwords are changed, we can set them via,
	88	* User authorities.
	89	* Because of this restriction we need to know about
	90	* Two different users. One in 'session' which we will use
	91	* to start the session and new_userr_pw as the user we're
	92	* chaning the pw for.
	93	*/
	94	struct opal_session_info new_user_pw;
	95	};
	96
	97	struct opal_mbr_data {
19641f2d	98	struct opal_key key;
8c87fe72 SB	99	__u8 enable_disable;
8c87fe72 SB	100	__u8 __align[7];
19641f2d SB	101	};
19641f2d SB	102
c9888443 JR	103	struct opal_mbr_done {
	104	struct opal_key key;
	105	__u8 done_flag;
	106	__u8 __align[7];
	107	};
	108
a9b25b4c JR	109	struct opal_shadow_mbr {
	110	struct opal_key key;
	111	const __u64 data;
	112	__u64 offset;
	113	__u64 size;
	114	};
	115
19641f2d SB	116	#define IOC_OPAL_SAVE _IOW('p', 220, struct opal_lock_unlock)
	117	#define IOC_OPAL_LOCK_UNLOCK _IOW('p', 221, struct opal_lock_unlock)
	118	#define IOC_OPAL_TAKE_OWNERSHIP _IOW('p', 222, struct opal_key)
24bff4d7	119	#define IOC_OPAL_ACTIVATE_LSP _IOW('p', 223, struct opal_lr_act)
19641f2d SB	120	#define IOC_OPAL_SET_PW _IOW('p', 224, struct opal_new_pw)
	121	#define IOC_OPAL_ACTIVATE_USR _IOW('p', 225, struct opal_session_info)
	122	#define IOC_OPAL_REVERT_TPR _IOW('p', 226, struct opal_key)
	123	#define IOC_OPAL_LR_SETUP _IOW('p', 227, struct opal_user_lr_setup)
	124	#define IOC_OPAL_ADD_USR_TO_LR _IOW('p', 228, struct opal_lock_unlock)
	125	#define IOC_OPAL_ENABLE_DISABLE_MBR _IOW('p', 229, struct opal_mbr_data)
	126	#define IOC_OPAL_ERASE_LR _IOW('p', 230, struct opal_session_info)
	127	#define IOC_OPAL_SECURE_ERASE_LR _IOW('p', 231, struct opal_session_info)
5e4c7cf6	128	#define IOC_OPAL_PSID_REVERT_TPR _IOW('p', 232, struct opal_key)
c9888443	129	#define IOC_OPAL_MBR_DONE _IOW('p', 233, struct opal_mbr_done)
a9b25b4c	130	#define IOC_OPAL_WRITE_SHADOW_MBR _IOW('p', 234, struct opal_shadow_mbr)
19641f2d SB	131
19641f2d SB	132	#endif /* _UAPI_SED_OPAL_H */