1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright © 2016 Intel Corporation 4 * 5 * Authors: 6 * Rafael Antognolli <[email protected]> 7 * Scott Bauer <[email protected]> 8 */ 9 #include <linux/types.h> 10 11 #ifndef _OPAL_PROTO_H 12 #define _OPAL_PROTO_H 13 14 /* 15 * These constant values come from: 16 * SPC-4 section 17 * 6.30 SECURITY PROTOCOL IN command / table 265. 18 */ 19 enum { 20 TCG_SECP_00 = 0, 21 TCG_SECP_01, 22 }; 23 24 /* 25 * Token defs derived from: 26 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00 27 * 3.2.2 Data Stream Encoding 28 */ 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 35 }; 36 37 #define DTAERROR_NO_METHOD_STATUS 0x89 38 #define GENERIC_HOST_SESSION_NUM 0x41 39 40 #define TPER_SYNC_SUPPORTED 0x01 41 #define MBR_ENABLED_MASK 0x10 42 43 #define TINY_ATOM_DATA_MASK 0x3F 44 #define TINY_ATOM_SIGNED 0x40 45 46 #define SHORT_ATOM_ID 0x80 47 #define SHORT_ATOM_BYTESTRING 0x20 48 #define SHORT_ATOM_SIGNED 0x10 49 #define SHORT_ATOM_LEN_MASK 0xF 50 51 #define MEDIUM_ATOM_ID 0xC0 52 #define MEDIUM_ATOM_BYTESTRING 0x10 53 #define MEDIUM_ATOM_SIGNED 0x8 54 #define MEDIUM_ATOM_LEN_MASK 0x7 55 56 #define LONG_ATOM_ID 0xe0 57 #define LONG_ATOM_BYTESTRING 0x2 58 #define LONG_ATOM_SIGNED 0x1 59 60 /* Derived from TCG Core spec 2.01 Section: 61 * 3.2.2.1 62 * Data Type 63 */ 64 #define TINY_ATOM_BYTE 0x7F 65 #define SHORT_ATOM_BYTE 0xBF 66 #define MEDIUM_ATOM_BYTE 0xDF 67 #define LONG_ATOM_BYTE 0xE3 68 69 #define OPAL_INVAL_PARAM 12 70 #define OPAL_MANUFACTURED_INACTIVE 0x08 71 #define OPAL_DISCOVERY_COMID 0x0001 72 73 #define LOCKING_RANGE_NON_GLOBAL 0x03 74 /* 75 * User IDs used in the TCG storage SSCs 76 * Derived from: TCG_Storage_Architecture_Core_Spec_v2.01_r1.00 77 * Section: 6.3 Assigned UIDs 78 */ 79 #define OPAL_UID_LENGTH 8 80 #define OPAL_METHOD_LENGTH 8 81 #define OPAL_MSID_KEYLEN 15 82 #define OPAL_UID_LENGTH_HALF 4 83 84 /* Enum to index OPALUID array */ 85 enum opal_uid { 86 /* users */ 87 OPAL_SMUID_UID, 88 OPAL_THISSP_UID, 89 OPAL_ADMINSP_UID, 90 OPAL_LOCKINGSP_UID, 91 OPAL_ENTERPRISE_LOCKINGSP_UID, 92 OPAL_ANYBODY_UID, 93 OPAL_SID_UID, 94 OPAL_ADMIN1_UID, 95 OPAL_USER1_UID, 96 OPAL_USER2_UID, 97 OPAL_PSID_UID, 98 OPAL_ENTERPRISE_BANDMASTER0_UID, 99 OPAL_ENTERPRISE_ERASEMASTER_UID, 100 /* tables */ 101 OPAL_TABLE_TABLE, 102 OPAL_LOCKINGRANGE_GLOBAL, 103 OPAL_LOCKINGRANGE_ACE_RDLOCKED, 104 OPAL_LOCKINGRANGE_ACE_WRLOCKED, 105 OPAL_MBRCONTROL, 106 OPAL_MBR, 107 OPAL_AUTHORITY_TABLE, 108 OPAL_C_PIN_TABLE, 109 OPAL_LOCKING_INFO_TABLE, 110 OPAL_ENTERPRISE_LOCKING_INFO_TABLE, 111 /* C_PIN_TABLE object ID's */ 112 OPAL_C_PIN_MSID, 113 OPAL_C_PIN_SID, 114 OPAL_C_PIN_ADMIN1, 115 /* half UID's (only first 4 bytes used) */ 116 OPAL_HALF_UID_AUTHORITY_OBJ_REF, 117 OPAL_HALF_UID_BOOLEAN_ACE, 118 /* omitted optional parameter */ 119 OPAL_UID_HEXFF, 120 }; 121 122 #define OPAL_METHOD_LENGTH 8 123 124 /* Enum for indexing the OPALMETHOD array */ 125 enum opal_method { 126 OPAL_PROPERTIES, 127 OPAL_STARTSESSION, 128 OPAL_REVERT, 129 OPAL_ACTIVATE, 130 OPAL_EGET, 131 OPAL_ESET, 132 OPAL_NEXT, 133 OPAL_EAUTHENTICATE, 134 OPAL_GETACL, 135 OPAL_GENKEY, 136 OPAL_REVERTSP, 137 OPAL_GET, 138 OPAL_SET, 139 OPAL_AUTHENTICATE, 140 OPAL_RANDOM, 141 OPAL_ERASE, 142 }; 143 144 enum opal_token { 145 /* Boolean */ 146 OPAL_TRUE = 0x01, 147 OPAL_FALSE = 0x00, 148 OPAL_BOOLEAN_EXPR = 0x03, 149 /* cellblocks */ 150 OPAL_TABLE = 0x00, 151 OPAL_STARTROW = 0x01, 152 OPAL_ENDROW = 0x02, 153 OPAL_STARTCOLUMN = 0x03, 154 OPAL_ENDCOLUMN = 0x04, 155 OPAL_VALUES = 0x01, 156 /* table table */ 157 OPAL_TABLE_UID = 0x00, 158 OPAL_TABLE_NAME = 0x01, 159 OPAL_TABLE_COMMON = 0x02, 160 OPAL_TABLE_TEMPLATE = 0x03, 161 OPAL_TABLE_KIND = 0x04, 162 OPAL_TABLE_COLUMN = 0x05, 163 OPAL_TABLE_COLUMNS = 0x06, 164 OPAL_TABLE_ROWS = 0x07, 165 OPAL_TABLE_ROWS_FREE = 0x08, 166 OPAL_TABLE_ROW_BYTES = 0x09, 167 OPAL_TABLE_LASTID = 0x0A, 168 OPAL_TABLE_MIN = 0x0B, 169 OPAL_TABLE_MAX = 0x0C, 170 /* authority table */ 171 OPAL_PIN = 0x03, 172 /* locking tokens */ 173 OPAL_RANGESTART = 0x03, 174 OPAL_RANGELENGTH = 0x04, 175 OPAL_READLOCKENABLED = 0x05, 176 OPAL_WRITELOCKENABLED = 0x06, 177 OPAL_READLOCKED = 0x07, 178 OPAL_WRITELOCKED = 0x08, 179 OPAL_ACTIVEKEY = 0x0A, 180 /* lockingsp table */ 181 OPAL_LIFECYCLE = 0x06, 182 /* locking info table */ 183 OPAL_MAXRANGES = 0x04, 184 /* mbr control */ 185 OPAL_MBRENABLE = 0x01, 186 OPAL_MBRDONE = 0x02, 187 /* properties */ 188 OPAL_HOSTPROPERTIES = 0x00, 189 /* atoms */ 190 OPAL_STARTLIST = 0xf0, 191 OPAL_ENDLIST = 0xf1, 192 OPAL_STARTNAME = 0xf2, 193 OPAL_ENDNAME = 0xf3, 194 OPAL_CALL = 0xf8, 195 OPAL_ENDOFDATA = 0xf9, 196 OPAL_ENDOFSESSION = 0xfa, 197 OPAL_STARTTRANSACTON = 0xfb, 198 OPAL_ENDTRANSACTON = 0xfC, 199 OPAL_EMPTYATOM = 0xff, 200 OPAL_WHERE = 0x00, 201 }; 202 203 /* Locking state for a locking range */ 204 enum opal_lockingstate { 205 OPAL_LOCKING_READWRITE = 0x01, 206 OPAL_LOCKING_READONLY = 0x02, 207 OPAL_LOCKING_LOCKED = 0x03, 208 }; 209 210 /* Packets derived from: 211 * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00 212 * Secion: 3.2.3 ComPackets, Packets & Subpackets 213 */ 214 215 /* Comm Packet (header) for transmissions. */ 216 struct opal_compacket { 217 __be32 reserved0; 218 u8 extendedComID[4]; 219 __be32 outstandingData; 220 __be32 minTransfer; 221 __be32 length; 222 }; 223 224 /* Packet structure. */ 225 struct opal_packet { 226 __be32 tsn; 227 __be32 hsn; 228 __be32 seq_number; 229 __be16 reserved0; 230 __be16 ack_type; 231 __be32 acknowledgment; 232 __be32 length; 233 }; 234 235 /* Data sub packet header */ 236 struct opal_data_subpacket { 237 u8 reserved0[6]; 238 __be16 kind; 239 __be32 length; 240 }; 241 242 /* header of a response */ 243 struct opal_header { 244 struct opal_compacket cp; 245 struct opal_packet pkt; 246 struct opal_data_subpacket subpkt; 247 }; 248 249 #define FC_TPER 0x0001 250 #define FC_LOCKING 0x0002 251 #define FC_GEOMETRY 0x0003 252 #define FC_ENTERPRISE 0x0100 253 #define FC_DATASTORE 0x0202 254 #define FC_SINGLEUSER 0x0201 255 #define FC_OPALV100 0x0200 256 #define FC_OPALV200 0x0203 257 258 /* 259 * The Discovery 0 Header. As defined in 260 * Opal SSC Documentation 261 * Section: 3.3.5 Capability Discovery 262 */ 263 struct d0_header { 264 __be32 length; /* the length of the header 48 in 2.00.100 */ 265 __be32 revision; /**< revision of the header 1 in 2.00.100 */ 266 __be32 reserved01; 267 __be32 reserved02; 268 /* 269 * the remainder of the structure is vendor specific and will not be 270 * addressed now 271 */ 272 u8 ignored[32]; 273 }; 274 275 /* 276 * TPer Feature Descriptor. Contains flags indicating support for the 277 * TPer features described in the OPAL specification. The names match the 278 * OPAL terminology 279 * 280 * code == 0x001 in 2.00.100 281 */ 282 struct d0_tper_features { 283 /* 284 * supported_features bits: 285 * bit 7: reserved 286 * bit 6: com ID management 287 * bit 5: reserved 288 * bit 4: streaming support 289 * bit 3: buffer management 290 * bit 2: ACK/NACK 291 * bit 1: async 292 * bit 0: sync 293 */ 294 u8 supported_features; 295 /* 296 * bytes 5 through 15 are reserved, but we represent the first 3 as 297 * u8 to keep the other two 32bits integers aligned. 298 */ 299 u8 reserved01[3]; 300 __be32 reserved02; 301 __be32 reserved03; 302 }; 303 304 /* 305 * Locking Feature Descriptor. Contains flags indicating support for the 306 * locking features described in the OPAL specification. The names match the 307 * OPAL terminology 308 * 309 * code == 0x0002 in 2.00.100 310 */ 311 struct d0_locking_features { 312 /* 313 * supported_features bits: 314 * bits 6-7: reserved 315 * bit 5: MBR done 316 * bit 4: MBR enabled 317 * bit 3: media encryption 318 * bit 2: locked 319 * bit 1: locking enabled 320 * bit 0: locking supported 321 */ 322 u8 supported_features; 323 /* 324 * bytes 5 through 15 are reserved, but we represent the first 3 as 325 * u8 to keep the other two 32bits integers aligned. 326 */ 327 u8 reserved01[3]; 328 __be32 reserved02; 329 __be32 reserved03; 330 }; 331 332 /* 333 * Geometry Feature Descriptor. Contains flags indicating support for the 334 * geometry features described in the OPAL specification. The names match the 335 * OPAL terminology 336 * 337 * code == 0x0003 in 2.00.100 338 */ 339 struct d0_geometry_features { 340 /* 341 * skip 32 bits from header, needed to align the struct to 64 bits. 342 */ 343 u8 header[4]; 344 /* 345 * reserved01: 346 * bits 1-6: reserved 347 * bit 0: align 348 */ 349 u8 reserved01; 350 u8 reserved02[7]; 351 __be32 logical_block_size; 352 __be64 alignment_granularity; 353 __be64 lowest_aligned_lba; 354 }; 355 356 /* 357 * Enterprise SSC Feature 358 * 359 * code == 0x0100 360 */ 361 struct d0_enterprise_ssc { 362 __be16 baseComID; 363 __be16 numComIDs; 364 /* range_crossing: 365 * bits 1-6: reserved 366 * bit 0: range crossing 367 */ 368 u8 range_crossing; 369 u8 reserved01; 370 __be16 reserved02; 371 __be32 reserved03; 372 __be32 reserved04; 373 }; 374 375 /* 376 * Opal V1 feature 377 * 378 * code == 0x0200 379 */ 380 struct d0_opal_v100 { 381 __be16 baseComID; 382 __be16 numComIDs; 383 }; 384 385 /* 386 * Single User Mode feature 387 * 388 * code == 0x0201 389 */ 390 struct d0_single_user_mode { 391 __be32 num_locking_objects; 392 /* reserved01: 393 * bit 0: any 394 * bit 1: all 395 * bit 2: policy 396 * bits 3-7: reserved 397 */ 398 u8 reserved01; 399 u8 reserved02; 400 __be16 reserved03; 401 __be32 reserved04; 402 }; 403 404 /* 405 * Additonal Datastores feature 406 * 407 * code == 0x0202 408 */ 409 struct d0_datastore_table { 410 __be16 reserved01; 411 __be16 max_tables; 412 __be32 max_size_tables; 413 __be32 table_size_alignment; 414 }; 415 416 /* 417 * OPAL 2.0 feature 418 * 419 * code == 0x0203 420 */ 421 struct d0_opal_v200 { 422 __be16 baseComID; 423 __be16 numComIDs; 424 /* range_crossing: 425 * bits 1-6: reserved 426 * bit 0: range crossing 427 */ 428 u8 range_crossing; 429 /* num_locking_admin_auth: 430 * not aligned to 16 bits, so use two u8. 431 * stored in big endian: 432 * 0: MSB 433 * 1: LSB 434 */ 435 u8 num_locking_admin_auth[2]; 436 /* num_locking_user_auth: 437 * not aligned to 16 bits, so use two u8. 438 * stored in big endian: 439 * 0: MSB 440 * 1: LSB 441 */ 442 u8 num_locking_user_auth[2]; 443 u8 initialPIN; 444 u8 revertedPIN; 445 u8 reserved01; 446 __be32 reserved02; 447 }; 448 449 /* Union of features used to parse the discovery 0 response */ 450 struct d0_features { 451 __be16 code; 452 /* 453 * r_version bits: 454 * bits 4-7: version 455 * bits 0-3: reserved 456 */ 457 u8 r_version; 458 u8 length; 459 u8 features[]; 460 }; 461 462 #endif /* _OPAL_PROTO_H */ 463