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