2 * osd_protocol.h - OSD T10 standard C definitions.
4 * Copyright (C) 2008 Panasas Inc. All rights reserved.
7 * Boaz Harrosh <bharrosh@panasas.com>
8 * Benny Halevy <bhalevy@panasas.com>
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
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.
16 #ifndef __OSD_PROTOCOL_H__
17 #define __OSD_PROTOCOL_H__
19 #include <linux/types.h>
20 #include <linux/kernel.h>
21 #include <asm/unaligned.h>
22 #include <scsi/scsi.h>
25 OSDv1_ADDITIONAL_CDB_LENGTH
= 192,
26 OSDv1_TOTAL_CDB_LEN
= OSDv1_ADDITIONAL_CDB_LENGTH
+ 8,
29 /* Latest supported version */
30 OSDv2_ADDITIONAL_CDB_LENGTH
= 228,
31 OSD_ADDITIONAL_CDB_LENGTH
=
32 OSDv2_ADDITIONAL_CDB_LENGTH
,
33 OSD_TOTAL_CDB_LEN
= OSD_ADDITIONAL_CDB_LENGTH
+ 8,
36 OSD_SYSTEMID_LEN
= 20,
37 OSDv1_CRYPTO_KEYID_SIZE
= 20,
38 OSDv2_CRYPTO_KEYID_SIZE
= 32,
39 OSD_CRYPTO_KEYID_SIZE
= OSDv2_CRYPTO_KEYID_SIZE
,
40 OSD_CRYPTO_SEED_SIZE
= 4,
41 OSD_CRYPTO_NONCE_SIZE
= 12,
42 OSD_MAX_SENSE_LEN
= 252, /* from SPC-3 */
44 OSD_PARTITION_FIRST_ID
= 0x10000,
45 OSD_OBJECT_FIRST_ID
= 0x10000,
49 * osd2r03: 5.2.3 Caching control bits
51 enum osd_options_byte
{
52 OSD_CDB_FUA
= 0x08, /* Force Unit Access */
53 OSD_CDB_DPO
= 0x10, /* Disable Page Out */
57 * osd2r03: 5.2.5 Isolation.
58 * First 3 bits, V2-only.
59 * Also for attr 110h "default isolation method" at Root Information page
61 enum osd_options_byte_isolation
{
62 OSD_ISOLATION_DEFAULT
= 0,
63 OSD_ISOLATION_NONE
= 1,
64 OSD_ISOLATION_STRICT
= 2,
65 OSD_ISOLATION_RANGE
= 4,
66 OSD_ISOLATION_FUNCTIONAL
= 5,
67 OSD_ISOLATION_VENDOR
= 7,
71 * osd2r03: 6.8 FLUSH, FLUSH COLLECTION, FLUSH OSD, FLUSH PARTITION
73 enum osd_options_flush_scope_values
{
74 OSD_CDB_FLUSH_ALL
= 0,
75 OSD_CDB_FLUSH_ATTR_ONLY
= 1,
77 OSD_CDB_FLUSH_ALL_RECURSIVE
= 2,
79 OSD_CDB_FLUSH_ALL_RANGE
= 2,
82 /* osd2r03: 5.2.10 Timestamps control */
84 OSD_CDB_NORMAL_TIMESTAMPS
= 0,
85 OSD_CDB_BYPASS_TIMESTAMPS
= 0x7f,
89 * osd2r03: 5.2.4.1 Get and set attributes CDB format selection
90 * 2 bits at second nibble of command_specific_options byte
92 enum osd_attributes_mode
{
94 OSD_CDB_SET_ONE_ATTR
= 0x10,
96 OSD_CDB_GET_ATTR_PAGE_SET_ONE
= 0x20,
97 OSD_CDB_GET_SET_ATTR_LISTS
= 0x30,
99 OSD_CDB_GET_SET_ATTR_MASK
= 0x30,
103 * osd2r03: 4.14.5 Data-In and Data-Out buffer offsets
104 * byte offset = mantissa * (2^(exponent+8))
106 * unsigned mantissa: 28;
110 typedef __be32 __bitwise osd_cdb_offset
;
113 OSD_OFFSET_UNUSED
= 0xFFFFFFFF,
114 OSD_OFFSET_MAX_BITS
= 28,
116 OSDv1_OFFSET_MIN_SHIFT
= 8,
117 OSD_OFFSET_MIN_SHIFT
= 3,
118 OSD_OFFSET_MAX_SHIFT
= 16,
121 /* Return the smallest allowed encoded offset that contains @offset.
123 * The actual encoded offset returned is @offset + *padding.
124 * (up to max_shift, non-inclusive)
126 osd_cdb_offset
__osd_encode_offset(u64 offset
, unsigned *padding
,
127 int min_shift
, int max_shift
);
129 /* Minimum alignment is 256 bytes
130 * Note: Seems from std v1 that exponent can be from 0+8 to 0xE+8 (inclusive)
131 * which is 8 to 23 but IBM code restricts it to 16, so be it.
133 static inline osd_cdb_offset
osd_encode_offset_v1(u64 offset
, unsigned *padding
)
135 return __osd_encode_offset(offset
, padding
,
136 OSDv1_OFFSET_MIN_SHIFT
, OSD_OFFSET_MAX_SHIFT
);
139 /* Minimum 8 bytes alignment
140 * Same as v1 but since exponent can be signed than a less than
141 * 256 alignment can be reached with small offsets (<2GB)
143 static inline osd_cdb_offset
osd_encode_offset_v2(u64 offset
, unsigned *padding
)
145 return __osd_encode_offset(offset
, padding
,
146 OSD_OFFSET_MIN_SHIFT
, OSD_OFFSET_MAX_SHIFT
);
149 /* osd2r03: 5.2.1 Overview */
150 struct osd_cdb_head
{
151 struct scsi_varlen_cdb_hdr varlen_cdb
;
153 u8 command_specific_options
;
154 u8 timestamp_control
;
155 /*13*/ u8 reserved1
[3];
156 /*16*/ __be64 partition
;
157 /*24*/ __be64 object
;
158 /*32*/ union { /* V1 vs V2 alignment differences */
159 struct __osdv1_cdb_addr_len
{
160 /*32*/ __be32 list_identifier
;/* Rarely used */
161 /*36*/ __be64 length
;
162 /*44*/ __be64 start_address
;
165 struct __osdv2_cdb_addr_len
{
166 /* called allocation_length in some commands */
167 /*32*/ __be64 length
;
168 /*40*/ __be64 start_address
;
170 /*48*/ __be32 list_identifier
;/* Rarely used */
171 /* OSD2r05 5.2.5 CDB continuation length */
172 /*48*/ __be32 cdb_continuation_length
;
176 /*52*/ union { /* selected attributes mode Page/List/Single */
177 struct osd_attributes_page_mode
{
178 /*52*/ __be32 get_attr_page
;
179 /*56*/ __be32 get_attr_alloc_length
;
180 /*60*/ osd_cdb_offset get_attr_offset
;
182 /*64*/ __be32 set_attr_page
;
183 /*68*/ __be32 set_attr_id
;
184 /*72*/ __be32 set_attr_length
;
185 /*76*/ osd_cdb_offset set_attr_offset
;
186 /*80*/ } __packed attrs_page
;
188 struct osd_attributes_list_mode
{
189 /*52*/ __be32 get_attr_desc_bytes
;
190 /*56*/ osd_cdb_offset get_attr_desc_offset
;
192 /*60*/ __be32 get_attr_alloc_length
;
193 /*64*/ osd_cdb_offset get_attr_offset
;
195 /*68*/ __be32 set_attr_bytes
;
196 /*72*/ osd_cdb_offset set_attr_offset
;
198 /*80*/ } __packed attrs_list
;
200 /* osd2r03:5.2.4.2 Set one attribute value using CDB fields */
201 struct osd_attributes_cdb_mode
{
202 /*52*/ __be32 set_attr_page
;
203 /*56*/ __be32 set_attr_id
;
204 /*60*/ __be16 set_attr_len
;
205 /*62*/ u8 set_attr_val
[18];
206 /*80*/ } __packed attrs_cdb
;
207 /*52*/ u8 get_set_attributes_parameters
[28];
213 struct osdv1_security_parameters
{
214 /*160*/u8 integrity_check_value
[OSDv1_CRYPTO_KEYID_SIZE
];
215 /*180*/u8 request_nonce
[OSD_CRYPTO_NONCE_SIZE
];
216 /*192*/osd_cdb_offset data_in_integrity_check_offset
;
217 /*196*/osd_cdb_offset data_out_integrity_check_offset
;
222 struct osdv2_security_parameters
{
223 /*184*/u8 integrity_check_value
[OSDv2_CRYPTO_KEYID_SIZE
];
224 /*216*/u8 request_nonce
[OSD_CRYPTO_NONCE_SIZE
];
225 /*228*/osd_cdb_offset data_in_integrity_check_offset
;
226 /*232*/osd_cdb_offset data_out_integrity_check_offset
;
230 struct osd_security_parameters
{
232 struct osdv1_security_parameters v1
;
233 struct osdv2_security_parameters v2
;
238 struct osd_cdb_head h
;
239 u8 caps
[OSDv1_CAP_LEN
];
240 struct osdv1_security_parameters sec_params
;
244 struct osd_cdb_head h
;
245 u8 caps
[OSD_CAP_LEN
];
246 struct osdv2_security_parameters sec_params
;
253 u8 buff
[OSD_TOTAL_CDB_LEN
];
257 static inline struct osd_cdb_head
*osd_cdb_head(struct osd_cdb
*ocdb
)
259 return (struct osd_cdb_head
*)ocdb
->buff
;
262 /* define both version actions
263 * Ex name = FORMAT_OSD we have OSD_ACT_FORMAT_OSD && OSDv1_ACT_FORMAT_OSD
265 #define OSD_ACT___(Name, Num) \
266 OSD_ACT_##Name = __constant_cpu_to_be16(0x8880 + Num), \
267 OSDv1_ACT_##Name = __constant_cpu_to_be16(0x8800 + Num),
269 /* V2 only actions */
270 #define OSD_ACT_V2(Name, Num) \
271 OSD_ACT_##Name = __constant_cpu_to_be16(0x8880 + Num),
273 #define OSD_ACT_V1_V2(Name, Num1, Num2) \
274 OSD_ACT_##Name = __constant_cpu_to_be16(Num2), \
275 OSDv1_ACT_##Name = __constant_cpu_to_be16(Num1),
277 enum osd_service_actions
{
278 OSD_ACT_V2(OBJECT_STRUCTURE_CHECK
, 0x00)
279 OSD_ACT___(FORMAT_OSD
, 0x01)
280 OSD_ACT___(CREATE
, 0x02)
281 OSD_ACT___(LIST
, 0x03)
282 OSD_ACT_V2(PUNCH
, 0x04)
283 OSD_ACT___(READ
, 0x05)
284 OSD_ACT___(WRITE
, 0x06)
285 OSD_ACT___(APPEND
, 0x07)
286 OSD_ACT___(FLUSH
, 0x08)
287 OSD_ACT_V2(CLEAR
, 0x09)
288 OSD_ACT___(REMOVE
, 0x0A)
289 OSD_ACT___(CREATE_PARTITION
, 0x0B)
290 OSD_ACT___(REMOVE_PARTITION
, 0x0C)
291 OSD_ACT___(GET_ATTRIBUTES
, 0x0E)
292 OSD_ACT___(SET_ATTRIBUTES
, 0x0F)
293 OSD_ACT___(CREATE_AND_WRITE
, 0x12)
294 OSD_ACT___(CREATE_COLLECTION
, 0x15)
295 OSD_ACT___(REMOVE_COLLECTION
, 0x16)
296 OSD_ACT___(LIST_COLLECTION
, 0x17)
297 OSD_ACT___(SET_KEY
, 0x18)
298 OSD_ACT___(SET_MASTER_KEY
, 0x19)
299 OSD_ACT___(FLUSH_COLLECTION
, 0x1A)
300 OSD_ACT___(FLUSH_PARTITION
, 0x1B)
301 OSD_ACT___(FLUSH_OSD
, 0x1C)
303 OSD_ACT_V2(QUERY
, 0x20)
304 OSD_ACT_V2(REMOVE_MEMBER_OBJECTS
, 0x21)
305 OSD_ACT_V2(GET_MEMBER_ATTRIBUTES
, 0x22)
306 OSD_ACT_V2(SET_MEMBER_ATTRIBUTES
, 0x23)
308 OSD_ACT_V2(CREATE_CLONE
, 0x28)
309 OSD_ACT_V2(CREATE_SNAPSHOT
, 0x29)
310 OSD_ACT_V2(DETACH_CLONE
, 0x2A)
311 OSD_ACT_V2(REFRESH_SNAPSHOT_CLONE
, 0x2B)
312 OSD_ACT_V2(RESTORE_PARTITION_FROM_SNAPSHOT
, 0x2C)
314 OSD_ACT_V2(READ_MAP
, 0x31)
315 OSD_ACT_V2(READ_MAPS_COMPARE
, 0x32)
317 OSD_ACT_V1_V2(PERFORM_SCSI_COMMAND
, 0x8F7E, 0x8F7C)
318 OSD_ACT_V1_V2(SCSI_TASK_MANAGEMENT
, 0x8F7F, 0x8F7D)
319 /* 0x8F80 to 0x8FFF are Vendor specific */
322 /* osd2r03: 7.1.3.2 List entry format for retrieving attributes */
323 struct osd_attributes_list_attrid
{
329 * NOTE: v1: is not aligned.
331 struct osdv1_attributes_list_element
{
334 __be16 attr_bytes
; /* valid bytes at attr_val without padding */
339 * osd2r03: 7.1.3.3 List entry format for retrieved attributes and
340 * for setting attributes
341 * NOTE: v2 is 8-bytes aligned
343 struct osdv2_attributes_list_element
{
347 __be16 attr_bytes
; /* valid bytes at attr_val without padding */
352 OSDv1_ATTRIBUTES_ELEM_ALIGN
= 1,
353 OSD_ATTRIBUTES_ELEM_ALIGN
= 8,
357 OSD_ATTR_LIST_ALL_PAGES
= 0xFFFFFFFF,
358 OSD_ATTR_LIST_ALL_IN_PAGE
= 0xFFFFFFFF,
361 static inline unsigned osdv1_attr_list_elem_size(unsigned len
)
363 return ALIGN(len
+ sizeof(struct osdv1_attributes_list_element
),
364 OSDv1_ATTRIBUTES_ELEM_ALIGN
);
367 static inline unsigned osdv2_attr_list_elem_size(unsigned len
)
369 return ALIGN(len
+ sizeof(struct osdv2_attributes_list_element
),
370 OSD_ATTRIBUTES_ELEM_ALIGN
);
374 * osd2r03: 7.1.3 OSD attributes lists (Table 184) — List type values
376 enum osd_attr_list_types
{
377 OSD_ATTR_LIST_GET
= 0x1, /* descriptors only */
378 OSD_ATTR_LIST_SET_RETRIEVE
= 0x9, /*descriptors/values variable-length*/
379 OSD_V2_ATTR_LIST_MULTIPLE
= 0xE, /* ver2, Multiple Objects lists*/
380 OSD_V1_ATTR_LIST_CREATE_MULTIPLE
= 0xF,/*ver1, used by create_multple*/
383 /* osd2r03: 7.1.3.4 Multi-object retrieved attributes format */
384 struct osd_attributes_list_multi_header
{
386 u8 object_type
; /* object_type enum below */
389 /* followed by struct osd_attributes_list_element's */
392 struct osdv1_attributes_list_header
{
393 u8 type
; /* low 4-bit only */
395 __be16 list_bytes
; /* Initiator shall set to Zero. Only set by target */
397 * type=9 followed by struct osd_attributes_list_element's
398 * type=E followed by struct osd_attributes_list_multi_header's
402 static inline unsigned osdv1_list_size(struct osdv1_attributes_list_header
*h
)
404 return be16_to_cpu(h
->list_bytes
);
407 struct osdv2_attributes_list_header
{
408 u8 type
; /* lower 4-bits only */
410 /*4*/ __be32 list_bytes
; /* Initiator shall set to zero. Only set by target */
412 * type=9 followed by struct osd_attributes_list_element's
413 * type=E followed by struct osd_attributes_list_multi_header's
417 static inline unsigned osdv2_list_size(struct osdv2_attributes_list_header
*h
)
419 return be32_to_cpu(h
->list_bytes
);
423 * osd2r03: 6.15 LIST (Table 79) LIST command parameter data.
424 * for root_lstchg below
427 OSD_OBJ_ID_LIST_PAR
= 0x1, /* V1-only. Not used in V2 */
428 OSD_OBJ_ID_LIST_LSTCHG
= 0x2,
432 * osd2r03: 6.15.2 LIST command parameter data
433 * (Also for LIST COLLECTION)
435 struct osd_obj_id_list
{
436 __be64 list_bytes
; /* bytes in list excluding list_bytes (-8) */
437 __be64 continuation_id
;
438 __be32 list_identifier
;
441 __be64 object_ids
[0];
444 static inline bool osd_is_obj_list_done(struct osd_obj_id_list
*list
,
447 *is_changed
= (0 != (list
->root_lstchg
& OSD_OBJ_ID_LIST_LSTCHG
));
448 return 0 != list
->continuation_id
;
452 * osd2r03: 4.12.4.5 The ALLDATA security method
454 struct osd_data_out_integrity_info
{
456 __be64 set_attributes_bytes
;
457 __be64 get_attributes_bytes
;
458 __u8 integrity_check_value
[OSD_CRYPTO_KEYID_SIZE
];
461 /* Same osd_data_out_integrity_info is used for OSD2/OSD1. The only difference
462 * Is the sizeof the structure since in OSD1 the last array is smaller. Use
463 * below for version independent handling of this structure
465 static inline int osd_data_out_integrity_info_sizeof(bool is_ver1
)
467 return sizeof(struct osd_data_out_integrity_info
) -
468 (is_ver1
* (OSDv2_CRYPTO_KEYID_SIZE
- OSDv1_CRYPTO_KEYID_SIZE
));
471 struct osd_data_in_integrity_info
{
473 __be64 retrieved_attributes_bytes
;
474 __u8 integrity_check_value
[OSD_CRYPTO_KEYID_SIZE
];
477 /* Same osd_data_in_integrity_info is used for OSD2/OSD1. The only difference
478 * Is the sizeof the structure since in OSD1 the last array is smaller. Use
479 * below for version independent handling of this structure
481 static inline int osd_data_in_integrity_info_sizeof(bool is_ver1
)
483 return sizeof(struct osd_data_in_integrity_info
) -
484 (is_ver1
* (OSDv2_CRYPTO_KEYID_SIZE
- OSDv1_CRYPTO_KEYID_SIZE
));
487 struct osd_timestamp
{
488 u8 time
[6]; /* number of milliseconds since 1/1/1970 UT (big endian) */
490 /* FIXME: define helper functions to convert to/from osd time format */
493 * Capability & Security definitions
494 * osd2r03: 4.11.2.2 Capability format
495 * osd2r03: 5.2.8 Security parameters
498 struct osd_key_identifier
{
499 u8 id
[7]; /* if you know why 7 please email bharrosh@panasas.com */
502 /* for osd_capability.format */
504 OSD_SEC_CAP_FORMAT_NO_CAPS
= 0,
505 OSD_SEC_CAP_FORMAT_VER1
= 1,
506 OSD_SEC_CAP_FORMAT_VER2
= 2,
509 /* security_method */
518 OSD_SEC_OBJ_ROOT
= 0x1,
519 OSD_SEC_OBJ_PARTITION
= 0x2,
520 OSD_SEC_OBJ_COLLECTION
= 0x40,
521 OSD_SEC_OBJ_USER
= 0x80,
524 enum osd_capability_bit_masks
{
525 OSD_SEC_CAP_APPEND
= BIT(0),
526 OSD_SEC_CAP_OBJ_MGMT
= BIT(1),
527 OSD_SEC_CAP_REMOVE
= BIT(2),
528 OSD_SEC_CAP_CREATE
= BIT(3),
529 OSD_SEC_CAP_SET_ATTR
= BIT(4),
530 OSD_SEC_CAP_GET_ATTR
= BIT(5),
531 OSD_SEC_CAP_WRITE
= BIT(6),
532 OSD_SEC_CAP_READ
= BIT(7),
534 OSD_SEC_CAP_NONE1
= BIT(8),
535 OSD_SEC_CAP_NONE2
= BIT(9),
536 OSD_SEC_GBL_REM
= BIT(10), /*v2 only*/
537 OSD_SEC_CAP_QUERY
= BIT(11), /*v2 only*/
538 OSD_SEC_CAP_M_OBJECT
= BIT(12), /*v2 only*/
539 OSD_SEC_CAP_POL_SEC
= BIT(13),
540 OSD_SEC_CAP_GLOBAL
= BIT(14),
541 OSD_SEC_CAP_DEV_MGMT
= BIT(15),
544 /* for object_descriptor_type (hi nibble used) */
546 OSD_SEC_OBJ_DESC_NONE
= 0, /* Not allowed */
547 OSD_SEC_OBJ_DESC_OBJ
= 1 << 4, /* v1: also collection */
548 OSD_SEC_OBJ_DESC_PAR
= 2 << 4, /* also root */
549 OSD_SEC_OBJ_DESC_COL
= 3 << 4, /* v2 only */
553 * osd2r03:4.11.2.2 Capability format
555 struct osd_capability_head
{
556 u8 format
; /* low nibble */
557 u8 integrity_algorithm__key_version
; /* MAKE_BYTE(integ_alg, key_ver) */
560 /*04*/ struct osd_timestamp expiration_time
;
562 /*30*/ u8 discriminator
[12];
563 /*42*/ struct osd_timestamp object_created_time
;
564 /*48*/ u8 object_type
;
565 /*49*/ u8 permissions_bit_mask
[5];
567 /*55*/ u8 object_descriptor_type
; /* high nibble */
571 struct osdv1_cap_object_descriptor
{
574 /*56*/ __be32 policy_access_tag
;
575 /*60*/ __be64 allowed_partition_id
;
576 /*68*/ __be64 allowed_object_id
;
577 /*76*/ __be32 reserved
;
580 /*56*/ u8 object_descriptor
[24];
586 struct osd_cap_object_descriptor
{
589 /*56*/ __be32 allowed_attributes_access
;
590 /*60*/ __be32 policy_access_tag
;
591 /*64*/ __be16 boot_epoch
;
592 /*66*/ u8 reserved
[6];
593 /*72*/ __be64 allowed_partition_id
;
594 /*80*/ __be64 allowed_object_id
;
595 /*88*/ __be64 allowed_range_length
;
596 /*96*/ __be64 allowed_range_start
;
599 /*56*/ u8 object_descriptor
[48];
604 struct osdv1_capability
{
605 struct osd_capability_head h
;
606 struct osdv1_cap_object_descriptor od
;
609 struct osd_capability
{
610 struct osd_capability_head h
;
611 struct osd_cap_object_descriptor od
;
615 * osd_sec_set_caps - set cap-bits into the capabilities header
617 * @cap: The osd_capability_head to set cap bits to.
618 * @bit_mask: Use an ORed list of enum osd_capability_bit_masks values
620 * permissions_bit_mask is unaligned use below to set into caps
621 * in a version independent way
623 static inline void osd_sec_set_caps(struct osd_capability_head
*cap
,
627 *Note: The bits above are defined LE order this is because this way
628 * they can grow in the future to more then 16, and still retain
629 * there constant values.
631 put_unaligned_le16(bit_mask
, &cap
->permissions_bit_mask
);
634 #endif /* ndef __OSD_PROTOCOL_H__ */