xref: /linux-6.15/include/uapi/linux/sed-opal.h (revision 7fb2e072)
1 /*
2  * Copyright © 2016 Intel Corporation
3  *
4  * Authors:
5  *    Rafael Antognolli <[email protected]>
6  *    Scott  Bauer      <[email protected]>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms and conditions of the GNU General Public License,
10  * version 2, as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  * more details.
16  */
17 
18 #ifndef _UAPI_SED_OPAL_H
19 #define _UAPI_SED_OPAL_H
20 
21 #include <linux/types.h>
22 
23 #define OPAL_KEY_MAX 256
24 #define OPAL_MAX_LRS 9
25 
26 enum opal_mbr {
27 	OPAL_MBR_ENABLE = 0x0,
28 	OPAL_MBR_DISABLE = 0x01,
29 };
30 
31 enum opal_user {
32 	OPAL_ADMIN1 = 0x0,
33 	OPAL_USER1 = 0x01,
34 	OPAL_USER2 = 0x02,
35 	OPAL_USER3 = 0x03,
36 	OPAL_USER4 = 0x04,
37 	OPAL_USER5 = 0x05,
38 	OPAL_USER6 = 0x06,
39 	OPAL_USER7 = 0x07,
40 	OPAL_USER8 = 0x08,
41 	OPAL_USER9 = 0x09,
42 };
43 
44 enum opal_lock_state {
45 	OPAL_RO = 0x01, /* 0001 */
46 	OPAL_RW = 0x02, /* 0010 */
47 	OPAL_LK = 0x04, /* 0100 */
48 };
49 
50 struct opal_key {
51 	__u8 lr;
52 	__u8 key_len;
53 	__u8 __align[6];
54 	__u8 key[OPAL_KEY_MAX];
55 };
56 
57 struct opal_lr_act {
58 	struct opal_key key;
59 	__u32 sum;
60 	__u8    num_lrs;
61 	__u8 lr[OPAL_MAX_LRS];
62 	__u8 align[2]; /* Align to 8 byte boundary */
63 };
64 
65 struct opal_session_info {
66 	__u32 sum;
67 	__u32 who;
68 	struct opal_key opal_key;
69 };
70 
71 struct opal_user_lr_setup {
72 	__u64 range_start;
73 	__u64 range_length;
74 	__u32 RLE; /* Read Lock enabled */
75 	__u32 WLE; /* Write Lock Enabled */
76 	struct opal_session_info session;
77 };
78 
79 struct opal_lock_unlock {
80 	struct opal_session_info session;
81 	__u32 l_state;
82 	__u8 __align[4];
83 };
84 
85 struct opal_new_pw {
86 	struct opal_session_info session;
87 
88 	/* When we're not operating in sum, and we first set
89 	 * passwords we need to set them via ADMIN authority.
90 	 * After passwords are changed, we can set them via,
91 	 * User authorities.
92 	 * Because of this restriction we need to know about
93 	 * Two different users. One in 'session' which we will use
94 	 * to start the session and new_userr_pw as the user we're
95 	 * chaning the pw for.
96 	 */
97 	struct opal_session_info new_user_pw;
98 };
99 
100 struct opal_mbr_data {
101 	struct opal_key key;
102 	__u8 enable_disable;
103 	__u8 __align[7];
104 };
105 
106 #define IOC_OPAL_SAVE		    _IOW('p', 220, struct opal_lock_unlock)
107 #define IOC_OPAL_LOCK_UNLOCK	    _IOW('p', 221, struct opal_lock_unlock)
108 #define IOC_OPAL_TAKE_OWNERSHIP	    _IOW('p', 222, struct opal_key)
109 #define IOC_OPAL_ACTIVATE_LSP       _IOW('p', 223, struct opal_lr_act)
110 #define IOC_OPAL_SET_PW             _IOW('p', 224, struct opal_new_pw)
111 #define IOC_OPAL_ACTIVATE_USR       _IOW('p', 225, struct opal_session_info)
112 #define IOC_OPAL_REVERT_TPR         _IOW('p', 226, struct opal_key)
113 #define IOC_OPAL_LR_SETUP           _IOW('p', 227, struct opal_user_lr_setup)
114 #define IOC_OPAL_ADD_USR_TO_LR      _IOW('p', 228, struct opal_lock_unlock)
115 #define IOC_OPAL_ENABLE_DISABLE_MBR _IOW('p', 229, struct opal_mbr_data)
116 #define IOC_OPAL_ERASE_LR           _IOW('p', 230, struct opal_session_info)
117 #define IOC_OPAL_SECURE_ERASE_LR    _IOW('p', 231, struct opal_session_info)
118 
119 #endif /* _UAPI_SED_OPAL_H */
120