2 * Copyright © 2016 Intel Corporation
5 * Rafael Antognolli <rafael.antognolli@intel.com>
6 * Scott Bauer <scott.bauer@intel.com>
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.
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
17 #include <linux/types.h>
23 * These constant values come from:
25 * 6.30 SECURITY PROTOCOL IN command / table 265.
33 * Token defs derived from:
34 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
35 * 3.2.2 Data Stream Encoding
37 enum opal_response_token {
38 OPAL_DTA_TOKENID_BYTESTRING = 0xe0,
39 OPAL_DTA_TOKENID_SINT = 0xe1,
40 OPAL_DTA_TOKENID_UINT = 0xe2,
41 OPAL_DTA_TOKENID_TOKEN = 0xe3, /* actual token is returned */
42 OPAL_DTA_TOKENID_INVALID = 0X0
45 #define DTAERROR_NO_METHOD_STATUS 0x89
46 #define GENERIC_HOST_SESSION_NUM 0x41
48 #define TPER_SYNC_SUPPORTED 0x01
50 #define TINY_ATOM_DATA_MASK 0x3F
51 #define TINY_ATOM_SIGNED 0x40
53 #define SHORT_ATOM_ID 0x80
54 #define SHORT_ATOM_BYTESTRING 0x20
55 #define SHORT_ATOM_SIGNED 0x10
56 #define SHORT_ATOM_LEN_MASK 0xF
58 #define MEDIUM_ATOM_ID 0xC0
59 #define MEDIUM_ATOM_BYTESTRING 0x10
60 #define MEDIUM_ATOM_SIGNED 0x8
61 #define MEDIUM_ATOM_LEN_MASK 0x7
63 #define LONG_ATOM_ID 0xe0
64 #define LONG_ATOM_BYTESTRING 0x2
65 #define LONG_ATOM_SIGNED 0x1
67 /* Derived from TCG Core spec 2.01 Section:
71 #define TINY_ATOM_BYTE 0x7F
72 #define SHORT_ATOM_BYTE 0xBF
73 #define MEDIUM_ATOM_BYTE 0xDF
74 #define LONG_ATOM_BYTE 0xE3
76 #define OPAL_INVAL_PARAM 12
77 #define OPAL_MANUFACTURED_INACTIVE 0x08
78 #define OPAL_DISCOVERY_COMID 0x0001
80 #define LOCKING_RANGE_NON_GLOBAL 0x03
82 * User IDs used in the TCG storage SSCs
83 * Derived from: TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
84 * Section: 6.3 Assigned UIDs
86 #define OPAL_UID_LENGTH 8
87 #define OPAL_METHOD_LENGTH 8
88 #define OPAL_MSID_KEYLEN 15
89 #define OPAL_UID_LENGTH_HALF 4
91 /* Enum to index OPALUID array */
98 OPAL_ENTERPRISE_LOCKINGSP_UID,
105 OPAL_ENTERPRISE_BANDMASTER0_UID,
106 OPAL_ENTERPRISE_ERASEMASTER_UID,
108 OPAL_LOCKINGRANGE_GLOBAL,
109 OPAL_LOCKINGRANGE_ACE_RDLOCKED,
110 OPAL_LOCKINGRANGE_ACE_WRLOCKED,
113 OPAL_AUTHORITY_TABLE,
115 OPAL_LOCKING_INFO_TABLE,
116 OPAL_ENTERPRISE_LOCKING_INFO_TABLE,
117 /* C_PIN_TABLE object ID's */
121 /* half UID's (only first 4 bytes used) */
122 OPAL_HALF_UID_AUTHORITY_OBJ_REF,
123 OPAL_HALF_UID_BOOLEAN_ACE,
124 /* omitted optional parameter */
128 #define OPAL_METHOD_LENGTH 8
130 /* Enum for indexing the OPALMETHOD array */
154 OPAL_BOOLEAN_EXPR = 0x03,
157 OPAL_STARTROW = 0x01,
159 OPAL_STARTCOLUMN = 0x03,
160 OPAL_ENDCOLUMN = 0x04,
162 /* authority table */
165 OPAL_RANGESTART = 0x03,
166 OPAL_RANGELENGTH = 0x04,
167 OPAL_READLOCKENABLED = 0x05,
168 OPAL_WRITELOCKENABLED = 0x06,
169 OPAL_READLOCKED = 0x07,
170 OPAL_WRITELOCKED = 0x08,
171 OPAL_ACTIVEKEY = 0x0A,
172 /* locking info table */
173 OPAL_MAXRANGES = 0x04,
175 OPAL_MBRENABLE = 0x01,
178 OPAL_HOSTPROPERTIES = 0x00,
180 OPAL_STARTLIST = 0xf0,
182 OPAL_STARTNAME = 0xf2,
185 OPAL_ENDOFDATA = 0xf9,
186 OPAL_ENDOFSESSION = 0xfa,
187 OPAL_STARTTRANSACTON = 0xfb,
188 OPAL_ENDTRANSACTON = 0xfC,
189 OPAL_EMPTYATOM = 0xff,
193 /* Locking state for a locking range */
194 enum opal_lockingstate {
195 OPAL_LOCKING_READWRITE = 0x01,
196 OPAL_LOCKING_READONLY = 0x02,
197 OPAL_LOCKING_LOCKED = 0x03,
200 /* Packets derived from:
201 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
202 * Secion: 3.2.3 ComPackets, Packets & Subpackets
205 /* Comm Packet (header) for transmissions. */
206 struct opal_compacket {
209 __be32 outstandingData;
214 /* Packet structure. */
221 __be32 acknowledgment;
225 /* Data sub packet header */
226 struct opal_data_subpacket {
232 /* header of a response */
234 struct opal_compacket cp;
235 struct opal_packet pkt;
236 struct opal_data_subpacket subpkt;
239 #define FC_TPER 0x0001
240 #define FC_LOCKING 0x0002
241 #define FC_GEOMETRY 0x0003
242 #define FC_ENTERPRISE 0x0100
243 #define FC_DATASTORE 0x0202
244 #define FC_SINGLEUSER 0x0201
245 #define FC_OPALV100 0x0200
246 #define FC_OPALV200 0x0203
249 * The Discovery 0 Header. As defined in
250 * Opal SSC Documentation
251 * Section: 3.3.5 Capability Discovery
254 __be32 length; /* the length of the header 48 in 2.00.100 */
255 __be32 revision; /**< revision of the header 1 in 2.00.100 */
259 * the remainder of the structure is vendor specific and will not be
266 * TPer Feature Descriptor. Contains flags indicating support for the
267 * TPer features described in the OPAL specification. The names match the
270 * code == 0x001 in 2.00.100
272 struct d0_tper_features {
274 * supported_features bits:
276 * bit 6: com ID management
278 * bit 4: streaming support
279 * bit 3: buffer management
284 u8 supported_features;
286 * bytes 5 through 15 are reserved, but we represent the first 3 as
287 * u8 to keep the other two 32bits integers aligned.
295 * Locking Feature Descriptor. Contains flags indicating support for the
296 * locking features described in the OPAL specification. The names match the
299 * code == 0x0002 in 2.00.100
301 struct d0_locking_features {
303 * supported_features bits:
307 * bit 3: media encryption
309 * bit 1: locking enabled
310 * bit 0: locking supported
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 * Geometry Feature Descriptor. Contains flags indicating support for the
324 * geometry features described in the OPAL specification. The names match the
327 * code == 0x0003 in 2.00.100
329 struct d0_geometry_features {
331 * skip 32 bits from header, needed to align the struct to 64 bits.
341 __be32 logical_block_size;
342 __be64 alignment_granularity;
343 __be64 lowest_aligned_lba;
347 * Enterprise SSC Feature
351 struct d0_enterprise_ssc {
356 * bit 0: range crossing
370 struct d0_opal_v100 {
376 * Single User Mode feature
380 struct d0_single_user_mode {
381 __be32 num_locking_objects;
395 * Additonal Datastores feature
399 struct d0_datastore_table {
402 __be32 max_size_tables;
403 __be32 table_size_alignment;
411 struct d0_opal_v200 {
416 * bit 0: range crossing
419 /* num_locking_admin_auth:
420 * not aligned to 16 bits, so use two u8.
421 * stored in big endian:
425 u8 num_locking_admin_auth[2];
426 /* num_locking_user_auth:
427 * not aligned to 16 bits, so use two u8.
428 * stored in big endian:
432 u8 num_locking_user_auth[2];
439 /* Union of features used to parse the discovery 0 response */
452 #endif /* _OPAL_PROTO_H */