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