block/opal_proto.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright © 2016 Intel Corporation
   4  *
   5  * Authors:
   6  *    Rafael Antognolli <rafael.antognolli@intel.com>
   7  *    Scott  Bauer      <scott.bauer@intel.com>
   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 #define FIRST_TPER_SESSION_NUM  4096
  40
  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
  48
  49 #define TINY_ATOM_DATA_MASK 0x3F
  50 #define TINY_ATOM_SIGNED 0x40
  51
  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
  56
  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
  61
  62 #define LONG_ATOM_ID 0xe0
  63 #define LONG_ATOM_BYTESTRING 0x2
  64 #define LONG_ATOM_SIGNED 0x1
  65
  66 /* Derived from TCG Core spec 2.01 Section:
  67  * 3.2.2.1
  68  * Data Type
  69  */
  70 #define TINY_ATOM_BYTE   0x7F
  71 #define SHORT_ATOM_BYTE  0xBF
  72 #define MEDIUM_ATOM_BYTE 0xDF
  73 #define LONG_ATOM_BYTE   0xE3
  74
  75 #define OPAL_INVAL_PARAM 12
  76 #define OPAL_MANUFACTURED_INACTIVE 0x08
  77 #define OPAL_DISCOVERY_COMID 0x0001
  78
  79 #define LOCKING_RANGE_NON_GLOBAL 0x03
  80 /*
  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
  84  */
  85 #define OPAL_METHOD_LENGTH 8
  86 #define OPAL_MSID_KEYLEN 15
  87 #define OPAL_UID_LENGTH_HALF 4
  88
  89 /*
  90  * Boolean operators from TCG Core spec 2.01 Section:
  91  * 5.1.3.11
  92  * Table 61
  93  */
  94 #define OPAL_BOOLEAN_AND 0
  95 #define OPAL_BOOLEAN_OR  1
  96 #define OPAL_BOOLEAN_NOT 2
  97
  98 /* Enum to index OPALUID array */
  99 enum opal_uid {
 100         /* users */
 101         OPAL_SMUID_UID,
 102         OPAL_THISSP_UID,
 103         OPAL_ADMINSP_UID,
 104         OPAL_LOCKINGSP_UID,
 105         OPAL_ENTERPRISE_LOCKINGSP_UID,
 106         OPAL_ANYBODY_UID,
 107         OPAL_SID_UID,
 108         OPAL_ADMIN1_UID,
 109         OPAL_USER1_UID,
 110         OPAL_USER2_UID,
 111         OPAL_PSID_UID,
 112         OPAL_ENTERPRISE_BANDMASTER0_UID,
 113         OPAL_ENTERPRISE_ERASEMASTER_UID,
 114         /* tables */
 115         OPAL_TABLE_TABLE,
 116         OPAL_LOCKINGRANGE_GLOBAL,
 117         OPAL_LOCKINGRANGE_ACE_START_TO_KEY,
 118         OPAL_LOCKINGRANGE_ACE_RDLOCKED,
 119         OPAL_LOCKINGRANGE_ACE_WRLOCKED,
 120         OPAL_MBRCONTROL,
 121         OPAL_MBR,
 122         OPAL_AUTHORITY_TABLE,
 123         OPAL_C_PIN_TABLE,
 124         OPAL_LOCKING_INFO_TABLE,
 125         OPAL_ENTERPRISE_LOCKING_INFO_TABLE,
 126         OPAL_DATASTORE,
 127         /* C_PIN_TABLE object ID's */
 128         OPAL_C_PIN_MSID,
 129         OPAL_C_PIN_SID,
 130         OPAL_C_PIN_ADMIN1,
 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 */
 135         OPAL_UID_HEXFF,
 136 };
 137
 138 /* Enum for indexing the OPALMETHOD array */
 139 enum opal_method {
 140         OPAL_PROPERTIES,
 141         OPAL_STARTSESSION,
 142         OPAL_REVERT,
 143         OPAL_ACTIVATE,
 144         OPAL_EGET,
 145         OPAL_ESET,
 146         OPAL_NEXT,
 147         OPAL_EAUTHENTICATE,
 148         OPAL_GETACL,
 149         OPAL_GENKEY,
 150         OPAL_REVERTSP,
 151         OPAL_GET,
 152         OPAL_SET,
 153         OPAL_AUTHENTICATE,
 154         OPAL_RANDOM,
 155         OPAL_ERASE,
 156 };
 157
 158 enum opal_token {
 159         /* Boolean */
 160         OPAL_TRUE = 0x01,
 161         OPAL_FALSE = 0x00,
 162         OPAL_BOOLEAN_EXPR = 0x03,
 163         /* cellblocks */
 164         OPAL_TABLE = 0x00,
 165         OPAL_STARTROW = 0x01,
 166         OPAL_ENDROW = 0x02,
 167         OPAL_STARTCOLUMN = 0x03,
 168         OPAL_ENDCOLUMN = 0x04,
 169         OPAL_VALUES = 0x01,
 170         /* table table */
 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 */
 185         OPAL_PIN = 0x03,
 186         /* locking tokens */
 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,
 198         /* mbr control */
 199         OPAL_MBRENABLE = 0x01,
 200         OPAL_MBRDONE = 0x02,
 201         /* properties */
 202         OPAL_HOSTPROPERTIES = 0x00,
 203         /* atoms */
 204         OPAL_STARTLIST = 0xf0,
 205         OPAL_ENDLIST = 0xf1,
 206         OPAL_STARTNAME = 0xf2,
 207         OPAL_ENDNAME = 0xf3,
 208         OPAL_CALL = 0xf8,
 209         OPAL_ENDOFDATA = 0xf9,
 210         OPAL_ENDOFSESSION = 0xfa,
 211         OPAL_STARTTRANSACTON = 0xfb,
 212         OPAL_ENDTRANSACTON = 0xfC,
 213         OPAL_EMPTYATOM = 0xff,
 214         OPAL_WHERE = 0x00,
 215 };
 216
 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,
 222 };
 223
 224 enum opal_parameter {
 225         OPAL_SUM_SET_LIST = 0x060000,
 226 };
 227
 228 /* Packets derived from:
 229  * TCG_Storage_Architecture_Core_Spec_v2.01_r1.00
 230  * Secion: 3.2.3 ComPackets, Packets & Subpackets
 231  */
 232
 233 /* Comm Packet (header) for transmissions. */
 234 struct opal_compacket {
 235         __be32 reserved0;
 236         u8 extendedComID[4];
 237         __be32 outstandingData;
 238         __be32 minTransfer;
 239         __be32 length;
 240 };
 241
 242 /* Packet structure. */
 243 struct opal_packet {
 244         __be32 tsn;
 245         __be32 hsn;
 246         __be32 seq_number;
 247         __be16 reserved0;
 248         __be16 ack_type;
 249         __be32 acknowledgment;
 250         __be32 length;
 251 };
 252
 253 /* Data sub packet header */
 254 struct opal_data_subpacket {
 255         u8 reserved0[6];
 256         __be16 kind;
 257         __be32 length;
 258 };
 259
 260 /* header of a response */
 261 struct opal_header {
 262         struct opal_compacket cp;
 263         struct opal_packet pkt;
 264         struct opal_data_subpacket subpkt;
 265 };
 266
 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
 275
 276 /*
 277  * The Discovery 0 Header. As defined in
 278  * Opal SSC Documentation
 279  * Section: 3.3.5 Capability Discovery
 280  */
 281 struct d0_header {
 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 */
 284         __be32 reserved01;
 285         __be32 reserved02;
 286         /*
 287          * the remainder of the structure is vendor specific and will not be
 288          * addressed now
 289          */
 290         u8 ignored[32];
 291 };
 292
 293 /*
 294  * TPer Feature Descriptor. Contains flags indicating support for the
 295  * TPer features described in the OPAL specification. The names match the
 296  * OPAL terminology
 297  *
 298  * code == 0x001 in 2.00.100
 299  */
 300 struct d0_tper_features {
 301         /*
 302          * supported_features bits:
 303          * bit 7: reserved
 304          * bit 6: com ID management
 305          * bit 5: reserved
 306          * bit 4: streaming support
 307          * bit 3: buffer management
 308          * bit 2: ACK/NACK
 309          * bit 1: async
 310          * bit 0: sync
 311          */
 312         u8 supported_features;
 313         /*
 314          * bytes 5 through 15 are reserved, but we represent the first 3 as
 315          * u8 to keep the other two 32bits integers aligned.
 316          */
 317         u8 reserved01[3];
 318         __be32 reserved02;
 319         __be32 reserved03;
 320 };
 321
 322 /*
 323  * Locking Feature Descriptor. Contains flags indicating support for the
 324  * locking features described in the OPAL specification. The names match the
 325  * OPAL terminology
 326  *
 327  * code == 0x0002 in 2.00.100
 328  */
 329 struct d0_locking_features {
 330         /*
 331          * supported_features bits:
 332          * bits 6-7: reserved
 333          * bit 5: MBR done
 334          * bit 4: MBR enabled
 335          * bit 3: media encryption
 336          * bit 2: locked
 337          * bit 1: locking enabled
 338          * bit 0: locking supported
 339          */
 340         u8 supported_features;
 341         /*
 342          * bytes 5 through 15 are reserved, but we represent the first 3 as
 343          * u8 to keep the other two 32bits integers aligned.
 344          */
 345         u8 reserved01[3];
 346         __be32 reserved02;
 347         __be32 reserved03;
 348 };
 349
 350 /*
 351  * Geometry Feature Descriptor. Contains flags indicating support for the
 352  * geometry features described in the OPAL specification. The names match the
 353  * OPAL terminology
 354  *
 355  * code == 0x0003 in 2.00.100
 356  */
 357 struct d0_geometry_features {
 358         /*
 359          * skip 32 bits from header, needed to align the struct to 64 bits.
 360          */
 361         u8 header[4];
 362         /*
 363          * reserved01:
 364          * bits 1-6: reserved
 365          * bit 0: align
 366          */
 367         u8 reserved01;
 368         u8 reserved02[7];
 369         __be32 logical_block_size;
 370         __be64 alignment_granularity;
 371         __be64 lowest_aligned_lba;
 372 };
 373
 374 /*
 375  * Enterprise SSC Feature
 376  *
 377  * code == 0x0100
 378  */
 379 struct d0_enterprise_ssc {
 380         __be16 baseComID;
 381         __be16 numComIDs;
 382         /* range_crossing:
 383          * bits 1-6: reserved
 384          * bit 0: range crossing
 385          */
 386         u8 range_crossing;
 387         u8 reserved01;
 388         __be16 reserved02;
 389         __be32 reserved03;
 390         __be32 reserved04;
 391 };
 392
 393 /*
 394  * Opal V1 feature
 395  *
 396  * code == 0x0200
 397  */
 398 struct d0_opal_v100 {
 399         __be16 baseComID;
 400         __be16 numComIDs;
 401 };
 402
 403 /*
 404  * Single User Mode feature
 405  *
 406  * code == 0x0201
 407  */
 408 struct d0_single_user_mode {
 409         __be32 num_locking_objects;
 410         /* reserved01:
 411          * bit 0: any
 412          * bit 1: all
 413          * bit 2: policy
 414          * bits 3-7: reserved
 415          */
 416         u8 reserved01;
 417         u8 reserved02;
 418         __be16 reserved03;
 419         __be32 reserved04;
 420 };
 421
 422 /*
 423  * Additonal Datastores feature
 424  *
 425  * code == 0x0202
 426  */
 427 struct d0_datastore_table {
 428         __be16 reserved01;
 429         __be16 max_tables;
 430         __be32 max_size_tables;
 431         __be32 table_size_alignment;
 432 };
 433
 434 /*
 435  * OPAL 2.0 feature
 436  *
 437  * code == 0x0203
 438  */
 439 struct d0_opal_v200 {
 440         __be16 baseComID;
 441         __be16 numComIDs;
 442         /* range_crossing:
 443          * bits 1-6: reserved
 444          * bit 0: range crossing
 445          */
 446         u8 range_crossing;
 447         /* num_locking_admin_auth:
 448          * not aligned to 16 bits, so use two u8.
 449          * stored in big endian:
 450          * 0: MSB
 451          * 1: LSB
 452          */
 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:
 457          * 0: MSB
 458          * 1: LSB
 459          */
 460         u8 num_locking_user_auth[2];
 461         u8 initialPIN;
 462         u8 revertedPIN;
 463         u8 reserved01;
 464         __be32 reserved02;
 465 };
 466
 467 /* Union of features used to parse the discovery 0 response */
 468 struct d0_features {
 469         __be16 code;
 470         /*
 471          * r_version bits:
 472          * bits 4-7: version
 473          * bits 0-3: reserved
 474          */
 475         u8 r_version;
 476         u8 length;
 477         u8 features[];
 478 };
 479
 480 #endif /* _OPAL_PROTO_H */