SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/scsi/osd_protocol.h

   1 /*
   2  * osd_protocol.h - OSD T10 standard C definitions.
   3  *
   4  * Copyright (C) 2008 Panasas Inc.  All rights reserved.
   5  *
   6  * Authors:
   7  *   Boaz Harrosh <bharrosh@panasas.com>
   8  *   Benny Halevy <bhalevy@panasas.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2
  12  *
  13  * This file contains types and constants that are defined by the protocol
  14  * Note: All names and symbols are taken from the OSD standard's text.
  15  */
  16 #ifndef __OSD_PROTOCOL_H__
  17 #define __OSD_PROTOCOL_H__
  18
  19 #include <linux/types.h>
  20 #include <asm/unaligned.h>
  21 #include <scsi/scsi.h>
  22
  23 enum {
  24         OSDv1_ADDITIONAL_CDB_LENGTH = 192,
  25         OSDv1_TOTAL_CDB_LEN = OSDv1_ADDITIONAL_CDB_LENGTH + 8,
  26         OSDv1_CAP_LEN = 80,
  27         /* Latest supported version */
  28         OSD_ADDITIONAL_CDB_LENGTH = OSDv1_ADDITIONAL_CDB_LENGTH,
  29         OSD_TOTAL_CDB_LEN = OSDv1_TOTAL_CDB_LEN,
  30         OSD_CAP_LEN = OSDv1_CAP_LEN,
  31
  32         OSD_SYSTEMID_LEN = 20,
  33         OSD_CRYPTO_KEYID_SIZE = 20,
  34         OSD_CRYPTO_SEED_SIZE = 4,
  35         OSD_CRYPTO_NONCE_SIZE = 12,
  36         OSD_MAX_SENSE_LEN = 252, /* from SPC-3 */
  37
  38         OSD_PARTITION_FIRST_ID = 0x10000,
  39         OSD_OBJECT_FIRST_ID = 0x10000,
  40 };
  41
  42 /* (osd-r10 5.2.4)
  43  * osd2r03: 5.2.3 Caching control bits
  44  */
  45 enum osd_options_byte {
  46         OSD_CDB_FUA = 0x08,     /* Force Unit Access */
  47         OSD_CDB_DPO = 0x10,     /* Disable Page Out */
  48 };
  49
  50 /*
  51  * osd2r03: 5.2.5 Isolation.
  52  * First 3 bits, V2-only.
  53  * Also for attr 110h "default isolation method" at Root Information page
  54  */
  55 enum osd_options_byte_isolation {
  56         OSD_ISOLATION_DEFAULT = 0,
  57         OSD_ISOLATION_NONE = 1,
  58         OSD_ISOLATION_STRICT = 2,
  59         OSD_ISOLATION_RANGE = 4,
  60         OSD_ISOLATION_FUNCTIONAL = 5,
  61         OSD_ISOLATION_VENDOR = 7,
  62 };
  63
  64 /* (osd-r10: 6.7)
  65  * osd2r03: 6.8 FLUSH, FLUSH COLLECTION, FLUSH OSD, FLUSH PARTITION
  66  */
  67 enum osd_options_flush_scope_values {
  68         OSD_CDB_FLUSH_ALL = 0,
  69         OSD_CDB_FLUSH_ATTR_ONLY = 1,
  70
  71         OSD_CDB_FLUSH_ALL_RECURSIVE = 2,
  72         /* V2-only */
  73         OSD_CDB_FLUSH_ALL_RANGE = 2,
  74 };
  75
  76 /* osd2r03: 5.2.10 Timestamps control */
  77 enum {
  78         OSD_CDB_NORMAL_TIMESTAMPS = 0,
  79         OSD_CDB_BYPASS_TIMESTAMPS = 0x7f,
  80 };
  81
  82 /* (osd-r10: 5.2.2.1)
  83  * osd2r03: 5.2.4.1 Get and set attributes CDB format selection
  84  *      2 bits at second nibble of command_specific_options byte
  85  */
  86 enum osd_attributes_mode {
  87         /* V2-only */
  88         OSD_CDB_SET_ONE_ATTR = 0x10,
  89
  90         OSD_CDB_GET_ATTR_PAGE_SET_ONE = 0x20,
  91         OSD_CDB_GET_SET_ATTR_LISTS = 0x30,
  92
  93         OSD_CDB_GET_SET_ATTR_MASK = 0x30,
  94 };
  95
  96 /* (osd-r10: 4.12.5)
  97  * osd2r03: 4.14.5 Data-In and Data-Out buffer offsets
  98  *      byte offset = mantissa * (2^(exponent+8))
  99  *      struct {
 100  *              unsigned mantissa: 28;
 101  *              int exponent: 04;
 102  *      }
 103  */
 104 typedef __be32 __bitwise osd_cdb_offset;
 105
 106 enum {
 107         OSD_OFFSET_UNUSED = 0xFFFFFFFF,
 108         OSD_OFFSET_MAX_BITS = 28,
 109
 110         OSDv1_OFFSET_MIN_SHIFT = 8,
 111         OSD_OFFSET_MAX_SHIFT = 16,
 112 };
 113
 114 /* Return the smallest allowed encoded offset that contains @offset.
 115  *
 116  * The actual encoded offset returned is @offset + *padding.
 117  * (up to max_shift, non-inclusive)
 118  */
 119 osd_cdb_offset __osd_encode_offset(u64 offset, unsigned *padding,
 120         int min_shift, int max_shift);
 121
 122 /* Minimum alignment is 256 bytes
 123  * Note: Seems from std v1 that exponent can be from 0+8 to 0xE+8 (inclusive)
 124  * which is 8 to 23 but IBM code restricts it to 16, so be it.
 125  */
 126 static inline osd_cdb_offset osd_encode_offset_v1(u64 offset, unsigned *padding)
 127 {
 128         return __osd_encode_offset(offset, padding,
 129                                 OSDv1_OFFSET_MIN_SHIFT, OSD_OFFSET_MAX_SHIFT);
 130 }
 131
 132 /* osd2r03: 5.2.1 Overview */
 133 struct osd_cdb_head {
 134         struct scsi_varlen_cdb_hdr varlen_cdb;
 135 /*10*/  u8              options;
 136         u8              command_specific_options;
 137         u8              timestamp_control;
 138 /*13*/  u8              reserved1[3];
 139 /*16*/  __be64          partition;
 140 /*24*/  __be64          object;
 141 /*32*/  union { /* V1 vs V2 alignment differences */
 142                 struct __osdv1_cdb_addr_len {
 143 /*32*/                  __be32          list_identifier;/* Rarely used */
 144 /*36*/                  __be64          length;
 145 /*44*/                  __be64          start_address;
 146                 } __packed v1;
 147         };
 148 /*52*/  union { /* selected attributes mode Page/List/Single */
 149                 struct osd_attributes_page_mode {
 150 /*52*/                  __be32          get_attr_page;
 151 /*56*/                  __be32          get_attr_alloc_length;
 152 /*60*/                  osd_cdb_offset  get_attr_offset;
 153
 154 /*64*/                  __be32          set_attr_page;
 155 /*68*/                  __be32          set_attr_id;
 156 /*72*/                  __be32          set_attr_length;
 157 /*76*/                  osd_cdb_offset  set_attr_offset;
 158 /*80*/          } __packed attrs_page;
 159
 160                 struct osd_attributes_list_mode {
 161 /*52*/                  __be32          get_attr_desc_bytes;
 162 /*56*/                  osd_cdb_offset  get_attr_desc_offset;
 163
 164 /*60*/                  __be32          get_attr_alloc_length;
 165 /*64*/                  osd_cdb_offset  get_attr_offset;
 166
 167 /*68*/                  __be32          set_attr_bytes;
 168 /*72*/                  osd_cdb_offset  set_attr_offset;
 169                         __be32 not_used;
 170 /*80*/          } __packed attrs_list;
 171
 172                 /* osd2r03:5.2.4.2 Set one attribute value using CDB fields */
 173                 struct osd_attributes_cdb_mode {
 174 /*52*/                  __be32          set_attr_page;
 175 /*56*/                  __be32          set_attr_id;
 176 /*60*/                  __be16          set_attr_len;
 177 /*62*/                  u8              set_attr_val[18];
 178 /*80*/          } __packed attrs_cdb;
 179 /*52*/          u8 get_set_attributes_parameters[28];
 180         };
 181 } __packed;
 182 /*80*/
 183
 184 /*160 v1*/
 185 struct osd_security_parameters {
 186 /*160*/u8       integrity_check_value[OSD_CRYPTO_KEYID_SIZE];
 187 /*180*/u8       request_nonce[OSD_CRYPTO_NONCE_SIZE];
 188 /*192*/osd_cdb_offset   data_in_integrity_check_offset;
 189 /*196*/osd_cdb_offset   data_out_integrity_check_offset;
 190 } __packed;
 191 /*200 v1*/
 192
 193 struct osdv1_cdb {
 194         struct osd_cdb_head h;
 195         u8 caps[OSDv1_CAP_LEN];
 196         struct osd_security_parameters sec_params;
 197 } __packed;
 198
 199 struct osd_cdb {
 200         union {
 201                 struct osdv1_cdb v1;
 202                 u8 buff[OSD_TOTAL_CDB_LEN];
 203         };
 204 } __packed;
 205
 206 static inline struct osd_cdb_head *osd_cdb_head(struct osd_cdb *ocdb)
 207 {
 208         return (struct osd_cdb_head *)ocdb->buff;
 209 }
 210
 211 /* define both version actions
 212  * Ex name = FORMAT_OSD we have OSD_ACT_FORMAT_OSD && OSDv1_ACT_FORMAT_OSD
 213  */
 214 #define OSD_ACT___(Name, Num) \
 215         OSD_ACT_##Name = __constant_cpu_to_be16(0x8880 + Num), \
 216         OSDv1_ACT_##Name = __constant_cpu_to_be16(0x8800 + Num),
 217
 218 /* V2 only actions */
 219 #define OSD_ACT_V2(Name, Num) \
 220         OSD_ACT_##Name = __constant_cpu_to_be16(0x8880 + Num),
 221
 222 #define OSD_ACT_V1_V2(Name, Num1, Num2) \
 223         OSD_ACT_##Name = __constant_cpu_to_be16(Num2), \
 224         OSDv1_ACT_##Name = __constant_cpu_to_be16(Num1),
 225
 226 enum osd_service_actions {
 227         OSD_ACT_V2(OBJECT_STRUCTURE_CHECK,      0x00)
 228         OSD_ACT___(FORMAT_OSD,                  0x01)
 229         OSD_ACT___(CREATE,                      0x02)
 230         OSD_ACT___(LIST,                        0x03)
 231         OSD_ACT_V2(PUNCH,                       0x04)
 232         OSD_ACT___(READ,                        0x05)
 233         OSD_ACT___(WRITE,                       0x06)
 234         OSD_ACT___(APPEND,                      0x07)
 235         OSD_ACT___(FLUSH,                       0x08)
 236         OSD_ACT_V2(CLEAR,                       0x09)
 237         OSD_ACT___(REMOVE,                      0x0A)
 238         OSD_ACT___(CREATE_PARTITION,            0x0B)
 239         OSD_ACT___(REMOVE_PARTITION,            0x0C)
 240         OSD_ACT___(GET_ATTRIBUTES,              0x0E)
 241         OSD_ACT___(SET_ATTRIBUTES,              0x0F)
 242         OSD_ACT___(CREATE_AND_WRITE,            0x12)
 243         OSD_ACT___(CREATE_COLLECTION,           0x15)
 244         OSD_ACT___(REMOVE_COLLECTION,           0x16)
 245         OSD_ACT___(LIST_COLLECTION,             0x17)
 246         OSD_ACT___(SET_KEY,                     0x18)
 247         OSD_ACT___(SET_MASTER_KEY,              0x19)
 248         OSD_ACT___(FLUSH_COLLECTION,            0x1A)
 249         OSD_ACT___(FLUSH_PARTITION,             0x1B)
 250         OSD_ACT___(FLUSH_OSD,                   0x1C)
 251
 252         OSD_ACT_V2(QUERY,                       0x20)
 253         OSD_ACT_V2(REMOVE_MEMBER_OBJECTS,       0x21)
 254         OSD_ACT_V2(GET_MEMBER_ATTRIBUTES,       0x22)
 255         OSD_ACT_V2(SET_MEMBER_ATTRIBUTES,       0x23)
 256         OSD_ACT_V2(READ_MAP,                    0x31)
 257
 258         OSD_ACT_V1_V2(PERFORM_SCSI_COMMAND,     0x8F7E, 0x8F7C)
 259         OSD_ACT_V1_V2(SCSI_TASK_MANAGEMENT,     0x8F7F, 0x8F7D)
 260         /* 0x8F80 to 0x8FFF are Vendor specific */
 261 };
 262
 263 /* osd2r03: 7.1.3.2 List entry format for retrieving attributes */
 264 struct osd_attributes_list_attrid {
 265         __be32 attr_page;
 266         __be32 attr_id;
 267 } __packed;
 268
 269 /*
 270  * osd2r03: 7.1.3.3 List entry format for retrieved attributes and
 271  *                  for setting attributes
 272  */
 273 struct osd_attributes_list_element {
 274         __be32 attr_page;
 275         __be32 attr_id;
 276         __be16 attr_bytes;
 277         u8 attr_val[0];
 278 } __packed;
 279
 280 enum {
 281         OSDv1_ATTRIBUTES_ELEM_ALIGN = 1,
 282 };
 283
 284 enum {
 285         OSD_ATTR_LIST_ALL_PAGES = 0xFFFFFFFF,
 286         OSD_ATTR_LIST_ALL_IN_PAGE = 0xFFFFFFFF,
 287 };
 288
 289 static inline unsigned osdv1_attr_list_elem_size(unsigned len)
 290 {
 291         return ALIGN(len + sizeof(struct osd_attributes_list_element),
 292                      OSDv1_ATTRIBUTES_ELEM_ALIGN);
 293 }
 294
 295 /*
 296  * osd2r03: 7.1.3 OSD attributes lists (Table 184) — List type values
 297  */
 298 enum osd_attr_list_types {
 299         OSD_ATTR_LIST_GET = 0x1,        /* descriptors only */
 300         OSD_ATTR_LIST_SET_RETRIEVE = 0x9, /*descriptors/values variable-length*/
 301         OSD_V2_ATTR_LIST_MULTIPLE = 0xE,  /* ver2, Multiple Objects lists*/
 302         OSD_V1_ATTR_LIST_CREATE_MULTIPLE = 0xF,/*ver1, used by create_multple*/
 303 };
 304
 305 /* osd2r03: 7.1.3.4 Multi-object retrieved attributes format */
 306 struct osd_attributes_list_multi_header {
 307         __be64 object_id;
 308         u8 object_type; /* object_type enum below */
 309         u8 reserved[5];
 310         __be16 list_bytes;
 311         /* followed by struct osd_attributes_list_element's */
 312 };
 313
 314 struct osdv1_attributes_list_header {
 315         u8 type;        /* low 4-bit only */
 316         u8 pad;
 317         __be16 list_bytes; /* Initiator shall set to Zero. Only set by target */
 318         /*
 319          * type=9 followed by struct osd_attributes_list_element's
 320          * type=E followed by struct osd_attributes_list_multi_header's
 321          */
 322 } __packed;
 323
 324 static inline unsigned osdv1_list_size(struct osdv1_attributes_list_header *h)
 325 {
 326         return be16_to_cpu(h->list_bytes);
 327 }
 328
 329 /* (osd-r10 6.13)
 330  * osd2r03: 6.15 LIST (Table 79) LIST command parameter data.
 331  *      for root_lstchg below
 332  */
 333 enum {
 334         OSD_OBJ_ID_LIST_PAR = 0x1, /* V1-only. Not used in V2 */
 335         OSD_OBJ_ID_LIST_LSTCHG = 0x2,
 336 };
 337
 338 /*
 339  * osd2r03: 6.15.2 LIST command parameter data
 340  * (Also for LIST COLLECTION)
 341  */
 342 struct osd_obj_id_list {
 343         __be64 list_bytes; /* bytes in list excluding list_bytes (-8) */
 344         __be64 continuation_id;
 345         __be32 list_identifier;
 346         u8 pad[3];
 347         u8 root_lstchg;
 348         __be64 object_ids[0];
 349 } __packed;
 350
 351 static inline bool osd_is_obj_list_done(struct osd_obj_id_list *list,
 352         bool *is_changed)
 353 {
 354         *is_changed = (0 != (list->root_lstchg & OSD_OBJ_ID_LIST_LSTCHG));
 355         return 0 != list->continuation_id;
 356 }
 357
 358 /*
 359  * osd2r03: 4.12.4.5 The ALLDATA security method
 360  */
 361 struct osd_data_out_integrity_info {
 362         __be64 data_bytes;
 363         __be64 set_attributes_bytes;
 364         __be64 get_attributes_bytes;
 365         __be64 integrity_check_value;
 366 } __packed;
 367
 368 struct osd_data_in_integrity_info {
 369         __be64 data_bytes;
 370         __be64 retrieved_attributes_bytes;
 371         __be64 integrity_check_value;
 372 } __packed;
 373
 374 struct osd_timestamp {
 375         u8 time[6]; /* number of milliseconds since 1/1/1970 UT (big endian) */
 376 } __packed;
 377 /* FIXME: define helper functions to convert to/from osd time format */
 378
 379 /*
 380  * Capability & Security definitions
 381  * osd2r03: 4.11.2.2 Capability format
 382  * osd2r03: 5.2.8 Security parameters
 383  */
 384
 385 struct osd_key_identifier {
 386         u8 id[7]; /* if you know why 7 please email bharrosh@panasas.com */
 387 } __packed;
 388
 389 /* for osd_capability.format */
 390 enum {
 391         OSD_SEC_CAP_FORMAT_NO_CAPS = 0,
 392         OSD_SEC_CAP_FORMAT_VER1 = 1,
 393         OSD_SEC_CAP_FORMAT_VER2 = 2,
 394 };
 395
 396 /* security_method */
 397 enum {
 398         OSD_SEC_NOSEC = 0,
 399         OSD_SEC_CAPKEY = 1,
 400         OSD_SEC_CMDRSP = 2,
 401         OSD_SEC_ALLDATA = 3,
 402 };
 403
 404 enum object_type {
 405         OSD_SEC_OBJ_ROOT = 0x1,
 406         OSD_SEC_OBJ_PARTITION = 0x2,
 407         OSD_SEC_OBJ_COLLECTION = 0x40,
 408         OSD_SEC_OBJ_USER = 0x80,
 409 };
 410
 411 enum osd_capability_bit_masks {
 412         OSD_SEC_CAP_APPEND      = BIT(0),
 413         OSD_SEC_CAP_OBJ_MGMT    = BIT(1),
 414         OSD_SEC_CAP_REMOVE      = BIT(2),
 415         OSD_SEC_CAP_CREATE      = BIT(3),
 416         OSD_SEC_CAP_SET_ATTR    = BIT(4),
 417         OSD_SEC_CAP_GET_ATTR    = BIT(5),
 418         OSD_SEC_CAP_WRITE       = BIT(6),
 419         OSD_SEC_CAP_READ        = BIT(7),
 420
 421         OSD_SEC_CAP_NONE1       = BIT(8),
 422         OSD_SEC_CAP_NONE2       = BIT(9),
 423         OSD_SEC_CAP_NONE3       = BIT(10),
 424         OSD_SEC_CAP_QUERY       = BIT(11), /*v2 only*/
 425         OSD_SEC_CAP_M_OBJECT    = BIT(12), /*v2 only*/
 426         OSD_SEC_CAP_POL_SEC     = BIT(13),
 427         OSD_SEC_CAP_GLOBAL      = BIT(14),
 428         OSD_SEC_CAP_DEV_MGMT    = BIT(15),
 429 };
 430
 431 /* for object_descriptor_type (hi nibble used) */
 432 enum {
 433         OSD_SEC_OBJ_DESC_NONE = 0,     /* Not allowed */
 434         OSD_SEC_OBJ_DESC_OBJ = 1 << 4, /* v1: also collection */
 435         OSD_SEC_OBJ_DESC_PAR = 2 << 4, /* also root */
 436         OSD_SEC_OBJ_DESC_COL = 3 << 4, /* v2 only */
 437 };
 438
 439 /* (osd-r10:4.9.2.2)
 440  * osd2r03:4.11.2.2 Capability format
 441  */
 442 struct osd_capability_head {
 443         u8 format; /* low nibble */
 444         u8 integrity_algorithm__key_version; /* MAKE_BYTE(integ_alg, key_ver) */
 445         u8 security_method;
 446         u8 reserved1;
 447 /*04*/  struct osd_timestamp expiration_time;
 448 /*10*/  u8 audit[20];
 449 /*30*/  u8 discriminator[12];
 450 /*42*/  struct osd_timestamp object_created_time;
 451 /*48*/  u8 object_type;
 452 /*49*/  u8 permissions_bit_mask[5];
 453 /*54*/  u8 reserved2;
 454 /*55*/  u8 object_descriptor_type; /* high nibble */
 455 } __packed;
 456
 457 /*56 v1*/
 458 struct osdv1_cap_object_descriptor {
 459         union {
 460                 struct {
 461 /*56*/                  __be32 policy_access_tag;
 462 /*60*/                  __be64 allowed_partition_id;
 463 /*68*/                  __be64 allowed_object_id;
 464 /*76*/                  __be32 reserved;
 465                 } __packed obj_desc;
 466
 467 /*56*/          u8 object_descriptor[24];
 468         };
 469 } __packed;
 470 /*80 v1*/
 471
 472 struct osd_capability {
 473         struct osd_capability_head h;
 474         struct osdv1_cap_object_descriptor od;
 475 } __packed;
 476
 477 /**
 478  * osd_sec_set_caps - set cap-bits into the capabilities header
 479  *
 480  * @cap:        The osd_capability_head to set cap bits to.
 481  * @bit_mask:   Use an ORed list of enum osd_capability_bit_masks values
 482  *
 483  * permissions_bit_mask is unaligned use below to set into caps
 484  * in a version independent way
 485  */
 486 static inline void osd_sec_set_caps(struct osd_capability_head *cap,
 487         u16 bit_mask)
 488 {
 489         /*
 490          *Note: The bits above are defined LE order this is because this way
 491          *      they can grow in the future to more then 16, and still retain
 492          *      there constant values.
 493          */
 494         put_unaligned_le16(bit_mask, &cap->permissions_bit_mask);
 495 }
 496
 497 #endif /* ndef __OSD_PROTOCOL_H__ */