1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright © 2016 Intel Corporation
6 * Rafael Antognolli <rafael.antognolli@intel.com>
7 * Scott Bauer <scott.bauer@intel.com>
9 #include <linux/types.h>
15 * These constant values come from:
17 * 6.30 SECURITY PROTOCOL IN command / table 265.
25 * Token defs derived from:
26 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
27 * 3.2.2 Data Stream Encoding
29 enum opal_response_token {
30 OPAL_DTA_TOKENID_BYTESTRING = 0xe0,
31 OPAL_DTA_TOKENID_SINT = 0xe1,
32 OPAL_DTA_TOKENID_UINT = 0xe2,
33 OPAL_DTA_TOKENID_TOKEN = 0xe3, /* actual token is returned */
34 OPAL_DTA_TOKENID_INVALID = 0X0
37 #define DTAERROR_NO_METHOD_STATUS 0x89
38 #define GENERIC_HOST_SESSION_NUM 0x41
39 #define FIRST_TPER_SESSION_NUM 4096
41 #define TPER_SYNC_SUPPORTED 0x01
42 /* FC_LOCKING features */
43 #define LOCKING_SUPPORTED_MASK 0x01
44 #define LOCKING_ENABLED_MASK 0x02
45 #define LOCKED_MASK 0x04
46 #define MBR_ENABLED_MASK 0x10
47 #define MBR_DONE_MASK 0x20
49 #define TINY_ATOM_DATA_MASK 0x3F
50 #define TINY_ATOM_SIGNED 0x40
52 #define SHORT_ATOM_ID 0x80
53 #define SHORT_ATOM_BYTESTRING 0x20
54 #define SHORT_ATOM_SIGNED 0x10
55 #define SHORT_ATOM_LEN_MASK 0xF
57 #define MEDIUM_ATOM_ID 0xC0
58 #define MEDIUM_ATOM_BYTESTRING 0x10
59 #define MEDIUM_ATOM_SIGNED 0x8
60 #define MEDIUM_ATOM_LEN_MASK 0x7
62 #define LONG_ATOM_ID 0xe0
63 #define LONG_ATOM_BYTESTRING 0x2
64 #define LONG_ATOM_SIGNED 0x1
66 /* Derived from TCG Core spec 2.01 Section:
70 #define TINY_ATOM_BYTE 0x7F
71 #define SHORT_ATOM_BYTE 0xBF
72 #define MEDIUM_ATOM_BYTE 0xDF
73 #define LONG_ATOM_BYTE 0xE3
75 #define OPAL_INVAL_PARAM 12
76 #define OPAL_MANUFACTURED_INACTIVE 0x08
77 #define OPAL_DISCOVERY_COMID 0x0001
79 #define LOCKING_RANGE_NON_GLOBAL 0x03
81 * User IDs used in the TCG storage SSCs
82 * Derived from: TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
83 * Section: 6.3 Assigned UIDs
85 #define OPAL_METHOD_LENGTH 8
86 #define OPAL_MSID_KEYLEN 15
87 #define OPAL_UID_LENGTH_HALF 4
90 * Boolean operators from TCG Core spec 2.01 Section:
94 #define OPAL_BOOLEAN_AND 0
95 #define OPAL_BOOLEAN_OR 1
96 #define OPAL_BOOLEAN_NOT 2
98 /* Enum to index OPALUID array */
105 OPAL_ENTERPRISE_LOCKINGSP_UID,
112 OPAL_ENTERPRISE_BANDMASTER0_UID,
113 OPAL_ENTERPRISE_ERASEMASTER_UID,
116 OPAL_LOCKINGRANGE_GLOBAL,
117 OPAL_LOCKINGRANGE_ACE_START_TO_KEY,
118 OPAL_LOCKINGRANGE_ACE_RDLOCKED,
119 OPAL_LOCKINGRANGE_ACE_WRLOCKED,
122 OPAL_AUTHORITY_TABLE,
124 OPAL_LOCKING_INFO_TABLE,
125 OPAL_ENTERPRISE_LOCKING_INFO_TABLE,
127 /* C_PIN_TABLE object ID's */
131 /* half UID's (only first 4 bytes used) */
132 OPAL_HALF_UID_AUTHORITY_OBJ_REF,
133 OPAL_HALF_UID_BOOLEAN_ACE,
134 /* omitted optional parameter */
138 /* Enum for indexing the OPALMETHOD array */
162 OPAL_BOOLEAN_EXPR = 0x03,
165 OPAL_STARTROW = 0x01,
167 OPAL_STARTCOLUMN = 0x03,
168 OPAL_ENDCOLUMN = 0x04,
171 OPAL_TABLE_UID = 0x00,
172 OPAL_TABLE_NAME = 0x01,
173 OPAL_TABLE_COMMON = 0x02,
174 OPAL_TABLE_TEMPLATE = 0x03,
175 OPAL_TABLE_KIND = 0x04,
176 OPAL_TABLE_COLUMN = 0x05,
177 OPAL_TABLE_COLUMNS = 0x06,
178 OPAL_TABLE_ROWS = 0x07,
179 OPAL_TABLE_ROWS_FREE = 0x08,
180 OPAL_TABLE_ROW_BYTES = 0x09,
181 OPAL_TABLE_LASTID = 0x0A,
182 OPAL_TABLE_MIN = 0x0B,
183 OPAL_TABLE_MAX = 0x0C,
184 /* authority table */
187 OPAL_RANGESTART = 0x03,
188 OPAL_RANGELENGTH = 0x04,
189 OPAL_READLOCKENABLED = 0x05,
190 OPAL_WRITELOCKENABLED = 0x06,
191 OPAL_READLOCKED = 0x07,
192 OPAL_WRITELOCKED = 0x08,
193 OPAL_ACTIVEKEY = 0x0A,
194 /* lockingsp table */
195 OPAL_LIFECYCLE = 0x06,
196 /* locking info table */
197 OPAL_MAXRANGES = 0x04,
199 OPAL_MBRENABLE = 0x01,
202 OPAL_HOSTPROPERTIES = 0x00,
204 OPAL_STARTLIST = 0xf0,
206 OPAL_STARTNAME = 0xf2,
209 OPAL_ENDOFDATA = 0xf9,
210 OPAL_ENDOFSESSION = 0xfa,
211 OPAL_STARTTRANSACTON = 0xfb,
212 OPAL_ENDTRANSACTON = 0xfC,
213 OPAL_EMPTYATOM = 0xff,
217 /* Locking state for a locking range */
218 enum opal_lockingstate {
219 OPAL_LOCKING_READWRITE = 0x01,
220 OPAL_LOCKING_READONLY = 0x02,
221 OPAL_LOCKING_LOCKED = 0x03,
224 enum opal_parameter {
225 OPAL_SUM_SET_LIST = 0x060000,
228 /* Packets derived from:
229 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
230 * Secion: 3.2.3 ComPackets, Packets & Subpackets
233 /* Comm Packet (header) for transmissions. */
234 struct opal_compacket {
237 __be32 outstandingData;
242 /* Packet structure. */
249 __be32 acknowledgment;
253 /* Data sub packet header */
254 struct opal_data_subpacket {
260 /* header of a response */
262 struct opal_compacket cp;
263 struct opal_packet pkt;
264 struct opal_data_subpacket subpkt;
267 #define FC_TPER 0x0001
268 #define FC_LOCKING 0x0002
269 #define FC_GEOMETRY 0x0003
270 #define FC_ENTERPRISE 0x0100
271 #define FC_DATASTORE 0x0202
272 #define FC_SINGLEUSER 0x0201
273 #define FC_OPALV100 0x0200
274 #define FC_OPALV200 0x0203
277 * The Discovery 0 Header. As defined in
278 * Opal SSC Documentation
279 * Section: 3.3.5 Capability Discovery
282 __be32 length; /* the length of the header 48 in 2.00.100 */
283 __be32 revision; /**< revision of the header 1 in 2.00.100 */
287 * the remainder of the structure is vendor specific and will not be
294 * TPer Feature Descriptor. Contains flags indicating support for the
295 * TPer features described in the OPAL specification. The names match the
298 * code == 0x001 in 2.00.100
300 struct d0_tper_features {
302 * supported_features bits:
304 * bit 6: com ID management
306 * bit 4: streaming support
307 * bit 3: buffer management
312 u8 supported_features;
314 * bytes 5 through 15 are reserved, but we represent the first 3 as
315 * u8 to keep the other two 32bits integers aligned.
323 * Locking Feature Descriptor. Contains flags indicating support for the
324 * locking features described in the OPAL specification. The names match the
327 * code == 0x0002 in 2.00.100
329 struct d0_locking_features {
331 * supported_features bits:
335 * bit 3: media encryption
337 * bit 1: locking enabled
338 * bit 0: locking supported
340 u8 supported_features;
342 * bytes 5 through 15 are reserved, but we represent the first 3 as
343 * u8 to keep the other two 32bits integers aligned.
351 * Geometry Feature Descriptor. Contains flags indicating support for the
352 * geometry features described in the OPAL specification. The names match the
355 * code == 0x0003 in 2.00.100
357 struct d0_geometry_features {
359 * skip 32 bits from header, needed to align the struct to 64 bits.
369 __be32 logical_block_size;
370 __be64 alignment_granularity;
371 __be64 lowest_aligned_lba;
375 * Enterprise SSC Feature
379 struct d0_enterprise_ssc {
384 * bit 0: range crossing
398 struct d0_opal_v100 {
404 * Single User Mode feature
408 struct d0_single_user_mode {
409 __be32 num_locking_objects;
423 * Additonal Datastores feature
427 struct d0_datastore_table {
430 __be32 max_size_tables;
431 __be32 table_size_alignment;
439 struct d0_opal_v200 {
444 * bit 0: range crossing
447 /* num_locking_admin_auth:
448 * not aligned to 16 bits, so use two u8.
449 * stored in big endian:
453 u8 num_locking_admin_auth[2];
454 /* num_locking_user_auth:
455 * not aligned to 16 bits, so use two u8.
456 * stored in big endian:
460 u8 num_locking_user_auth[2];
467 /* Union of features used to parse the discovery 0 response */
480 #endif /* _OPAL_PROTO_H */