1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
23enum {
24 OSDv1_ADDITIONAL_CDB_LENGTH = 192,
25 OSDv1_TOTAL_CDB_LEN = OSDv1_ADDITIONAL_CDB_LENGTH + 8,
26 OSDv1_CAP_LEN = 80,
27
28
29 OSDv2_ADDITIONAL_CDB_LENGTH = 228,
30 OSD_ADDITIONAL_CDB_LENGTH =
31 OSDv2_ADDITIONAL_CDB_LENGTH,
32 OSD_TOTAL_CDB_LEN = OSD_ADDITIONAL_CDB_LENGTH + 8,
33 OSD_CAP_LEN = 104,
34
35 OSD_SYSTEMID_LEN = 20,
36 OSDv1_CRYPTO_KEYID_SIZE = 20,
37 OSDv2_CRYPTO_KEYID_SIZE = 32,
38 OSD_CRYPTO_KEYID_SIZE = OSDv2_CRYPTO_KEYID_SIZE,
39 OSD_CRYPTO_SEED_SIZE = 4,
40 OSD_CRYPTO_NONCE_SIZE = 12,
41 OSD_MAX_SENSE_LEN = 252,
42
43 OSD_PARTITION_FIRST_ID = 0x10000,
44 OSD_OBJECT_FIRST_ID = 0x10000,
45};
46
47
48
49
50enum osd_options_byte {
51 OSD_CDB_FUA = 0x08,
52 OSD_CDB_DPO = 0x10,
53};
54
55
56
57
58
59
60enum osd_options_byte_isolation {
61 OSD_ISOLATION_DEFAULT = 0,
62 OSD_ISOLATION_NONE = 1,
63 OSD_ISOLATION_STRICT = 2,
64 OSD_ISOLATION_RANGE = 4,
65 OSD_ISOLATION_FUNCTIONAL = 5,
66 OSD_ISOLATION_VENDOR = 7,
67};
68
69
70
71
72enum osd_options_flush_scope_values {
73 OSD_CDB_FLUSH_ALL = 0,
74 OSD_CDB_FLUSH_ATTR_ONLY = 1,
75
76 OSD_CDB_FLUSH_ALL_RECURSIVE = 2,
77
78 OSD_CDB_FLUSH_ALL_RANGE = 2,
79};
80
81
82enum {
83 OSD_CDB_NORMAL_TIMESTAMPS = 0,
84 OSD_CDB_BYPASS_TIMESTAMPS = 0x7f,
85};
86
87
88
89
90
91enum osd_attributes_mode {
92
93 OSD_CDB_SET_ONE_ATTR = 0x10,
94
95 OSD_CDB_GET_ATTR_PAGE_SET_ONE = 0x20,
96 OSD_CDB_GET_SET_ATTR_LISTS = 0x30,
97
98 OSD_CDB_GET_SET_ATTR_MASK = 0x30,
99};
100
101
102
103
104
105
106
107
108
109typedef __be32 __bitwise osd_cdb_offset;
110
111enum {
112 OSD_OFFSET_UNUSED = 0xFFFFFFFF,
113 OSD_OFFSET_MAX_BITS = 28,
114
115 OSDv1_OFFSET_MIN_SHIFT = 8,
116 OSD_OFFSET_MIN_SHIFT = 3,
117 OSD_OFFSET_MAX_SHIFT = 16,
118};
119
120
121
122
123
124
125osd_cdb_offset __osd_encode_offset(u64 offset, unsigned *padding,
126 int min_shift, int max_shift);
127
128
129
130
131
132static inline osd_cdb_offset osd_encode_offset_v1(u64 offset, unsigned *padding)
133{
134 return __osd_encode_offset(offset, padding,
135 OSDv1_OFFSET_MIN_SHIFT, OSD_OFFSET_MAX_SHIFT);
136}
137
138
139
140
141
142static inline osd_cdb_offset osd_encode_offset_v2(u64 offset, unsigned *padding)
143{
144 return __osd_encode_offset(offset, padding,
145 OSD_OFFSET_MIN_SHIFT, OSD_OFFSET_MAX_SHIFT);
146}
147
148
149struct osd_cdb_head {
150 struct scsi_varlen_cdb_hdr varlen_cdb;
151 u8 options;
152 u8 command_specific_options;
153 u8 timestamp_control;
154 u8 reserved1[3];
155 __be64 partition;
156 __be64 object;
157 union {
158 struct __osdv1_cdb_addr_len {
159 __be32 list_identifier;
160 __be64 length;
161 __be64 start_address;
162 } __packed v1;
163
164 struct __osdv2_cdb_addr_len {
165
166 __be64 length;
167 __be64 start_address;
168 union {
169 __be32 list_identifier;
170
171 __be32 cdb_continuation_length;
172 };
173 } __packed v2;
174 };
175 union {
176 struct osd_attributes_page_mode {
177 __be32 get_attr_page;
178 __be32 get_attr_alloc_length;
179 osd_cdb_offset get_attr_offset;
180
181 __be32 set_attr_page;
182 __be32 set_attr_id;
183 __be32 set_attr_length;
184 osd_cdb_offset set_attr_offset;
185 } __packed attrs_page;
186
187 struct osd_attributes_list_mode {
188 __be32 get_attr_desc_bytes;
189 osd_cdb_offset get_attr_desc_offset;
190
191 __be32 get_attr_alloc_length;
192 osd_cdb_offset get_attr_offset;
193
194 __be32 set_attr_bytes;
195 osd_cdb_offset set_attr_offset;
196 __be32 not_used;
197 } __packed attrs_list;
198
199
200 struct osd_attributes_cdb_mode {
201 __be32 set_attr_page;
202 __be32 set_attr_id;
203 __be16 set_attr_len;
204 u8 set_attr_val[18];
205 } __packed attrs_cdb;
206 u8 get_set_attributes_parameters[28];
207 };
208} __packed;
209
210
211
212struct osdv1_security_parameters {
213u8 integrity_check_value[OSDv1_CRYPTO_KEYID_SIZE];
214u8 request_nonce[OSD_CRYPTO_NONCE_SIZE];
215osd_cdb_offset data_in_integrity_check_offset;
216osd_cdb_offset data_out_integrity_check_offset;
217} __packed;
218
219
220
221struct osdv2_security_parameters {
222u8 integrity_check_value[OSDv2_CRYPTO_KEYID_SIZE];
223u8 request_nonce[OSD_CRYPTO_NONCE_SIZE];
224osd_cdb_offset data_in_integrity_check_offset;
225osd_cdb_offset data_out_integrity_check_offset;
226} __packed;
227
228
229struct osd_security_parameters {
230 union {
231 struct osdv1_security_parameters v1;
232 struct osdv2_security_parameters v2;
233 };
234};
235
236struct osdv1_cdb {
237 struct osd_cdb_head h;
238 u8 caps[OSDv1_CAP_LEN];
239 struct osdv1_security_parameters sec_params;
240} __packed;
241
242struct osdv2_cdb {
243 struct osd_cdb_head h;
244 u8 caps[OSD_CAP_LEN];
245 struct osdv2_security_parameters sec_params;
246} __packed;
247
248struct osd_cdb {
249 union {
250 struct osdv1_cdb v1;
251 struct osdv2_cdb v2;
252 u8 buff[OSD_TOTAL_CDB_LEN];
253 };
254} __packed;
255
256static inline struct osd_cdb_head *osd_cdb_head(struct osd_cdb *ocdb)
257{
258 return (struct osd_cdb_head *)ocdb->buff;
259}
260
261
262
263
264#define OSD_ACT___(Name, Num) \
265 OSD_ACT_##Name = __constant_cpu_to_be16(0x8880 + Num), \
266 OSDv1_ACT_##Name = __constant_cpu_to_be16(0x8800 + Num),
267
268
269#define OSD_ACT_V2(Name, Num) \
270 OSD_ACT_##Name = __constant_cpu_to_be16(0x8880 + Num),
271
272#define OSD_ACT_V1_V2(Name, Num1, Num2) \
273 OSD_ACT_##Name = __constant_cpu_to_be16(Num2), \
274 OSDv1_ACT_##Name = __constant_cpu_to_be16(Num1),
275
276enum osd_service_actions {
277 OSD_ACT_V2(OBJECT_STRUCTURE_CHECK, 0x00)
278 OSD_ACT___(FORMAT_OSD, 0x01)
279 OSD_ACT___(CREATE, 0x02)
280 OSD_ACT___(LIST, 0x03)
281 OSD_ACT_V2(PUNCH, 0x04)
282 OSD_ACT___(READ, 0x05)
283 OSD_ACT___(WRITE, 0x06)
284 OSD_ACT___(APPEND, 0x07)
285 OSD_ACT___(FLUSH, 0x08)
286 OSD_ACT_V2(CLEAR, 0x09)
287 OSD_ACT___(REMOVE, 0x0A)
288 OSD_ACT___(CREATE_PARTITION, 0x0B)
289 OSD_ACT___(REMOVE_PARTITION, 0x0C)
290 OSD_ACT___(GET_ATTRIBUTES, 0x0E)
291 OSD_ACT___(SET_ATTRIBUTES, 0x0F)
292 OSD_ACT___(CREATE_AND_WRITE, 0x12)
293 OSD_ACT___(CREATE_COLLECTION, 0x15)
294 OSD_ACT___(REMOVE_COLLECTION, 0x16)
295 OSD_ACT___(LIST_COLLECTION, 0x17)
296 OSD_ACT___(SET_KEY, 0x18)
297 OSD_ACT___(SET_MASTER_KEY, 0x19)
298 OSD_ACT___(FLUSH_COLLECTION, 0x1A)
299 OSD_ACT___(FLUSH_PARTITION, 0x1B)
300 OSD_ACT___(FLUSH_OSD, 0x1C)
301
302 OSD_ACT_V2(QUERY, 0x20)
303 OSD_ACT_V2(REMOVE_MEMBER_OBJECTS, 0x21)
304 OSD_ACT_V2(GET_MEMBER_ATTRIBUTES, 0x22)
305 OSD_ACT_V2(SET_MEMBER_ATTRIBUTES, 0x23)
306
307 OSD_ACT_V2(CREATE_CLONE, 0x28)
308 OSD_ACT_V2(CREATE_SNAPSHOT, 0x29)
309 OSD_ACT_V2(DETACH_CLONE, 0x2A)
310 OSD_ACT_V2(REFRESH_SNAPSHOT_CLONE, 0x2B)
311 OSD_ACT_V2(RESTORE_PARTITION_FROM_SNAPSHOT, 0x2C)
312
313 OSD_ACT_V2(READ_MAP, 0x31)
314 OSD_ACT_V2(READ_MAPS_COMPARE, 0x32)
315
316 OSD_ACT_V1_V2(PERFORM_SCSI_COMMAND, 0x8F7E, 0x8F7C)
317 OSD_ACT_V1_V2(SCSI_TASK_MANAGEMENT, 0x8F7F, 0x8F7D)
318
319};
320
321
322struct osd_attributes_list_attrid {
323 __be32 attr_page;
324 __be32 attr_id;
325} __packed;
326
327
328
329
330struct osdv1_attributes_list_element {
331 __be32 attr_page;
332 __be32 attr_id;
333 __be16 attr_bytes;
334 u8 attr_val[0];
335} __packed;
336
337
338
339
340
341
342struct osdv2_attributes_list_element {
343 __be32 attr_page;
344 __be32 attr_id;
345 u8 reserved[6];
346 __be16 attr_bytes;
347 u8 attr_val[0];
348} __packed;
349
350enum {
351 OSDv1_ATTRIBUTES_ELEM_ALIGN = 1,
352 OSD_ATTRIBUTES_ELEM_ALIGN = 8,
353};
354
355enum {
356 OSD_ATTR_LIST_ALL_PAGES = 0xFFFFFFFF,
357 OSD_ATTR_LIST_ALL_IN_PAGE = 0xFFFFFFFF,
358};
359
360static inline unsigned osdv1_attr_list_elem_size(unsigned len)
361{
362 return ALIGN(len + sizeof(struct osdv1_attributes_list_element),
363 OSDv1_ATTRIBUTES_ELEM_ALIGN);
364}
365
366static inline unsigned osdv2_attr_list_elem_size(unsigned len)
367{
368 return ALIGN(len + sizeof(struct osdv2_attributes_list_element),
369 OSD_ATTRIBUTES_ELEM_ALIGN);
370}
371
372
373
374
375enum osd_attr_list_types {
376 OSD_ATTR_LIST_GET = 0x1,
377 OSD_ATTR_LIST_SET_RETRIEVE = 0x9,
378 OSD_V2_ATTR_LIST_MULTIPLE = 0xE,
379 OSD_V1_ATTR_LIST_CREATE_MULTIPLE = 0xF,
380};
381
382
383struct osd_attributes_list_multi_header {
384 __be64 object_id;
385 u8 object_type;
386 u8 reserved[5];
387 __be16 list_bytes;
388
389};
390
391struct osdv1_attributes_list_header {
392 u8 type;
393 u8 pad;
394 __be16 list_bytes;
395
396
397
398
399} __packed;
400
401static inline unsigned osdv1_list_size(struct osdv1_attributes_list_header *h)
402{
403 return be16_to_cpu(h->list_bytes);
404}
405
406struct osdv2_attributes_list_header {
407 u8 type;
408 u8 pad[3];
409 __be32 list_bytes;
410
411
412
413
414} __packed;
415
416static inline unsigned osdv2_list_size(struct osdv2_attributes_list_header *h)
417{
418 return be32_to_cpu(h->list_bytes);
419}
420
421
422
423
424
425enum {
426 OSD_OBJ_ID_LIST_PAR = 0x1,
427 OSD_OBJ_ID_LIST_LSTCHG = 0x2,
428};
429
430
431
432
433
434struct osd_obj_id_list {
435 __be64 list_bytes;
436 __be64 continuation_id;
437 __be32 list_identifier;
438 u8 pad[3];
439 u8 root_lstchg;
440 __be64 object_ids[0];
441} __packed;
442
443static inline bool osd_is_obj_list_done(struct osd_obj_id_list *list,
444 bool *is_changed)
445{
446 *is_changed = (0 != (list->root_lstchg & OSD_OBJ_ID_LIST_LSTCHG));
447 return 0 != list->continuation_id;
448}
449
450
451
452
453struct osd_data_out_integrity_info {
454 __be64 data_bytes;
455 __be64 set_attributes_bytes;
456 __be64 get_attributes_bytes;
457 __u8 integrity_check_value[OSD_CRYPTO_KEYID_SIZE];
458} __packed;
459
460
461
462
463
464static inline int osd_data_out_integrity_info_sizeof(bool is_ver1)
465{
466 return sizeof(struct osd_data_out_integrity_info) -
467 (is_ver1 * (OSDv2_CRYPTO_KEYID_SIZE - OSDv1_CRYPTO_KEYID_SIZE));
468}
469
470struct osd_data_in_integrity_info {
471 __be64 data_bytes;
472 __be64 retrieved_attributes_bytes;
473 __u8 integrity_check_value[OSD_CRYPTO_KEYID_SIZE];
474} __packed;
475
476
477
478
479
480static inline int osd_data_in_integrity_info_sizeof(bool is_ver1)
481{
482 return sizeof(struct osd_data_in_integrity_info) -
483 (is_ver1 * (OSDv2_CRYPTO_KEYID_SIZE - OSDv1_CRYPTO_KEYID_SIZE));
484}
485
486struct osd_timestamp {
487 u8 time[6];
488} __packed;
489
490
491
492
493
494
495
496
497struct osd_key_identifier {
498 u8 id[7];
499} __packed;
500
501
502enum {
503 OSD_SEC_CAP_FORMAT_NO_CAPS = 0,
504 OSD_SEC_CAP_FORMAT_VER1 = 1,
505 OSD_SEC_CAP_FORMAT_VER2 = 2,
506};
507
508
509enum {
510 OSD_SEC_NOSEC = 0,
511 OSD_SEC_CAPKEY = 1,
512 OSD_SEC_CMDRSP = 2,
513 OSD_SEC_ALLDATA = 3,
514};
515
516enum object_type {
517 OSD_SEC_OBJ_ROOT = 0x1,
518 OSD_SEC_OBJ_PARTITION = 0x2,
519 OSD_SEC_OBJ_COLLECTION = 0x40,
520 OSD_SEC_OBJ_USER = 0x80,
521};
522
523enum osd_capability_bit_masks {
524 OSD_SEC_CAP_APPEND = BIT(0),
525 OSD_SEC_CAP_OBJ_MGMT = BIT(1),
526 OSD_SEC_CAP_REMOVE = BIT(2),
527 OSD_SEC_CAP_CREATE = BIT(3),
528 OSD_SEC_CAP_SET_ATTR = BIT(4),
529 OSD_SEC_CAP_GET_ATTR = BIT(5),
530 OSD_SEC_CAP_WRITE = BIT(6),
531 OSD_SEC_CAP_READ = BIT(7),
532
533 OSD_SEC_CAP_NONE1 = BIT(8),
534 OSD_SEC_CAP_NONE2 = BIT(9),
535 OSD_SEC_GBL_REM = BIT(10),
536 OSD_SEC_CAP_QUERY = BIT(11),
537 OSD_SEC_CAP_M_OBJECT = BIT(12),
538 OSD_SEC_CAP_POL_SEC = BIT(13),
539 OSD_SEC_CAP_GLOBAL = BIT(14),
540 OSD_SEC_CAP_DEV_MGMT = BIT(15),
541};
542
543
544enum {
545 OSD_SEC_OBJ_DESC_NONE = 0,
546 OSD_SEC_OBJ_DESC_OBJ = 1 << 4,
547 OSD_SEC_OBJ_DESC_PAR = 2 << 4,
548 OSD_SEC_OBJ_DESC_COL = 3 << 4,
549};
550
551
552
553
554struct osd_capability_head {
555 u8 format;
556 u8 integrity_algorithm__key_version;
557 u8 security_method;
558 u8 reserved1;
559 struct osd_timestamp expiration_time;
560 u8 audit[20];
561 u8 discriminator[12];
562 struct osd_timestamp object_created_time;
563 u8 object_type;
564 u8 permissions_bit_mask[5];
565 u8 reserved2;
566 u8 object_descriptor_type;
567} __packed;
568
569
570struct osdv1_cap_object_descriptor {
571 union {
572 struct {
573 __be32 policy_access_tag;
574 __be64 allowed_partition_id;
575 __be64 allowed_object_id;
576 __be32 reserved;
577 } __packed obj_desc;
578
579 u8 object_descriptor[24];
580 };
581} __packed;
582
583
584
585struct osd_cap_object_descriptor {
586 union {
587 struct {
588 __be32 allowed_attributes_access;
589 __be32 policy_access_tag;
590 __be16 boot_epoch;
591 u8 reserved[6];
592 __be64 allowed_partition_id;
593 __be64 allowed_object_id;
594 __be64 allowed_range_length;
595 __be64 allowed_range_start;
596 } __packed obj_desc;
597
598 u8 object_descriptor[48];
599 };
600} __packed;
601
602
603struct osdv1_capability {
604 struct osd_capability_head h;
605 struct osdv1_cap_object_descriptor od;
606} __packed;
607
608struct osd_capability {
609 struct osd_capability_head h;
610 struct osd_cap_object_descriptor od;
611} __packed;
612
613
614
615
616
617
618
619
620
621
622static inline void osd_sec_set_caps(struct osd_capability_head *cap,
623 u16 bit_mask)
624{
625
626
627
628
629
630 put_unaligned_le16(bit_mask, &cap->permissions_bit_mask);
631}
632
633#endif
634