Commit | Line | Data |
---|---|---|
4ef1a3d7 BH |
1 | #ifndef __OSD_ATTRIBUTES_H__ |
2 | #define __OSD_ATTRIBUTES_H__ | |
3 | ||
4 | #include "osd_protocol.h" | |
5 | ||
6 | /* | |
7 | * Contains types and constants that define attribute pages and attribute | |
8 | * numbers and their data types. | |
9 | */ | |
10 | ||
11 | #define ATTR_SET(pg, id, l, ptr) \ | |
12 | { .attr_page = pg, .attr_id = id, .len = l, .val_ptr = ptr } | |
13 | ||
14 | #define ATTR_DEF(pg, id, l) ATTR_SET(pg, id, l, NULL) | |
15 | ||
16 | /* osd-r10 4.7.3 Attributes pages */ | |
17 | enum { | |
18 | OSD_APAGE_OBJECT_FIRST = 0x0, | |
19 | OSD_APAGE_OBJECT_DIRECTORY = 0, | |
20 | OSD_APAGE_OBJECT_INFORMATION = 1, | |
21 | OSD_APAGE_OBJECT_QUOTAS = 2, | |
22 | OSD_APAGE_OBJECT_TIMESTAMP = 3, | |
23 | OSD_APAGE_OBJECT_COLLECTIONS = 4, | |
24 | OSD_APAGE_OBJECT_SECURITY = 5, | |
25 | OSD_APAGE_OBJECT_LAST = 0x2fffffff, | |
26 | ||
27 | OSD_APAGE_PARTITION_FIRST = 0x30000000, | |
28 | OSD_APAGE_PARTITION_DIRECTORY = OSD_APAGE_PARTITION_FIRST + 0, | |
29 | OSD_APAGE_PARTITION_INFORMATION = OSD_APAGE_PARTITION_FIRST + 1, | |
30 | OSD_APAGE_PARTITION_QUOTAS = OSD_APAGE_PARTITION_FIRST + 2, | |
31 | OSD_APAGE_PARTITION_TIMESTAMP = OSD_APAGE_PARTITION_FIRST + 3, | |
32 | OSD_APAGE_PARTITION_SECURITY = OSD_APAGE_PARTITION_FIRST + 5, | |
33 | OSD_APAGE_PARTITION_LAST = 0x5FFFFFFF, | |
34 | ||
35 | OSD_APAGE_COLLECTION_FIRST = 0x60000000, | |
36 | OSD_APAGE_COLLECTION_DIRECTORY = OSD_APAGE_COLLECTION_FIRST + 0, | |
37 | OSD_APAGE_COLLECTION_INFORMATION = OSD_APAGE_COLLECTION_FIRST + 1, | |
38 | OSD_APAGE_COLLECTION_TIMESTAMP = OSD_APAGE_COLLECTION_FIRST + 3, | |
39 | OSD_APAGE_COLLECTION_SECURITY = OSD_APAGE_COLLECTION_FIRST + 5, | |
40 | OSD_APAGE_COLLECTION_LAST = 0x8FFFFFFF, | |
41 | ||
42 | OSD_APAGE_ROOT_FIRST = 0x90000000, | |
43 | OSD_APAGE_ROOT_DIRECTORY = OSD_APAGE_ROOT_FIRST + 0, | |
44 | OSD_APAGE_ROOT_INFORMATION = OSD_APAGE_ROOT_FIRST + 1, | |
45 | OSD_APAGE_ROOT_QUOTAS = OSD_APAGE_ROOT_FIRST + 2, | |
46 | OSD_APAGE_ROOT_TIMESTAMP = OSD_APAGE_ROOT_FIRST + 3, | |
47 | OSD_APAGE_ROOT_SECURITY = OSD_APAGE_ROOT_FIRST + 5, | |
48 | OSD_APAGE_ROOT_LAST = 0xBFFFFFFF, | |
49 | ||
50 | OSD_APAGE_RESERVED_TYPE_FIRST = 0xC0000000, | |
51 | OSD_APAGE_RESERVED_TYPE_LAST = 0xEFFFFFFF, | |
52 | ||
53 | OSD_APAGE_COMMON_FIRST = 0xF0000000, | |
54 | OSD_APAGE_COMMON_LAST = 0xFFFFFFFE, | |
55 | ||
56 | OSD_APAGE_REQUEST_ALL = 0xFFFFFFFF, | |
57 | }; | |
58 | ||
59 | /* subcategories of attr pages within each range above */ | |
60 | enum { | |
61 | OSD_APAGE_STD_FIRST = 0x0, | |
62 | OSD_APAGE_STD_DIRECTORY = 0, | |
63 | OSD_APAGE_STD_INFORMATION = 1, | |
64 | OSD_APAGE_STD_QUOTAS = 2, | |
65 | OSD_APAGE_STD_TIMESTAMP = 3, | |
66 | OSD_APAGE_STD_COLLECTIONS = 4, | |
67 | OSD_APAGE_STD_POLICY_SECURITY = 5, | |
68 | OSD_APAGE_STD_LAST = 0x0000007F, | |
69 | ||
70 | OSD_APAGE_RESERVED_FIRST = 0x00000080, | |
71 | OSD_APAGE_RESERVED_LAST = 0x00007FFF, | |
72 | ||
73 | OSD_APAGE_OTHER_STD_FIRST = 0x00008000, | |
74 | OSD_APAGE_OTHER_STD_LAST = 0x0000EFFF, | |
75 | ||
76 | OSD_APAGE_PUBLIC_FIRST = 0x0000F000, | |
77 | OSD_APAGE_PUBLIC_LAST = 0x0000FFFF, | |
78 | ||
79 | OSD_APAGE_APP_DEFINED_FIRST = 0x00010000, | |
80 | OSD_APAGE_APP_DEFINED_LAST = 0x1FFFFFFF, | |
81 | ||
82 | OSD_APAGE_VENDOR_SPECIFIC_FIRST = 0x20000000, | |
83 | OSD_APAGE_VENDOR_SPECIFIC_LAST = 0x2FFFFFFF, | |
84 | }; | |
85 | ||
86 | enum { | |
87 | OSD_ATTR_PAGE_IDENTIFICATION = 0, /* in all pages 40 bytes */ | |
88 | }; | |
89 | ||
90 | struct page_identification { | |
91 | u8 vendor_identification[8]; | |
92 | u8 page_identification[32]; | |
93 | } __packed; | |
94 | ||
95 | struct osd_attr_page_header { | |
96 | __be32 page_number; | |
97 | __be32 page_length; | |
98 | } __packed; | |
99 | ||
100 | /* 7.1.2.8 Root Information attributes page (OSD_APAGE_ROOT_INFORMATION) */ | |
101 | enum { | |
102 | OSD_ATTR_RI_OSD_SYSTEM_ID = 0x3, /* 20 */ | |
103 | OSD_ATTR_RI_VENDOR_IDENTIFICATION = 0x4, /* 8 */ | |
104 | OSD_ATTR_RI_PRODUCT_IDENTIFICATION = 0x5, /* 16 */ | |
105 | OSD_ATTR_RI_PRODUCT_MODEL = 0x6, /* 32 */ | |
106 | OSD_ATTR_RI_PRODUCT_REVISION_LEVEL = 0x7, /* 4 */ | |
107 | OSD_ATTR_RI_PRODUCT_SERIAL_NUMBER = 0x8, /* variable */ | |
108 | OSD_ATTR_RI_OSD_NAME = 0x9, /* variable */ | |
109 | OSD_ATTR_RI_TOTAL_CAPACITY = 0x80, /* 8 */ | |
110 | OSD_ATTR_RI_USED_CAPACITY = 0x81, /* 8 */ | |
111 | OSD_ATTR_RI_NUMBER_OF_PARTITIONS = 0xC0, /* 8 */ | |
112 | OSD_ATTR_RI_CLOCK = 0x100, /* 6 */ | |
113 | }; | |
114 | /* Root_Information_attributes_page does not have a get_page structure */ | |
115 | ||
116 | /* 7.1.2.9 Partition Information attributes page | |
117 | * (OSD_APAGE_PARTITION_INFORMATION) | |
118 | */ | |
119 | enum { | |
120 | OSD_ATTR_PI_PARTITION_ID = 0x1, /* 8 */ | |
121 | OSD_ATTR_PI_USERNAME = 0x9, /* variable */ | |
122 | OSD_ATTR_PI_USED_CAPACITY = 0x81, /* 8 */ | |
123 | OSD_ATTR_PI_NUMBER_OF_OBJECTS = 0xC1, /* 8 */ | |
124 | }; | |
125 | /* Partition Information attributes page does not have a get_page structure */ | |
126 | ||
127 | /* 7.1.2.10 Collection Information attributes page | |
128 | * (OSD_APAGE_COLLECTION_INFORMATION) | |
129 | */ | |
130 | enum { | |
131 | OSD_ATTR_CI_PARTITION_ID = 0x1, /* 8 */ | |
132 | OSD_ATTR_CI_COLLECTION_OBJECT_ID = 0x2, /* 8 */ | |
133 | OSD_ATTR_CI_USERNAME = 0x9, /* variable */ | |
134 | OSD_ATTR_CI_USED_CAPACITY = 0x81, /* 8 */ | |
135 | }; | |
136 | /* Collection Information attributes page does not have a get_page structure */ | |
137 | ||
138 | /* 7.1.2.11 User Object Information attributes page | |
139 | * (OSD_APAGE_OBJECT_INFORMATION) | |
140 | */ | |
141 | enum { | |
142 | OSD_ATTR_OI_PARTITION_ID = 0x1, /* 8 */ | |
143 | OSD_ATTR_OI_OBJECT_ID = 0x2, /* 8 */ | |
144 | OSD_ATTR_OI_USERNAME = 0x9, /* variable */ | |
145 | OSD_ATTR_OI_USED_CAPACITY = 0x81, /* 8 */ | |
146 | OSD_ATTR_OI_LOGICAL_LENGTH = 0x82, /* 8 */ | |
147 | }; | |
148 | /* Object Information attributes page does not have a get_page structure */ | |
149 | ||
150 | /* 7.1.2.12 Root Quotas attributes page (OSD_APAGE_ROOT_QUOTAS) */ | |
151 | enum { | |
152 | OSD_ATTR_RQ_DEFAULT_MAXIMUM_USER_OBJECT_LENGTH = 0x1, /* 8 */ | |
153 | OSD_ATTR_RQ_PARTITION_CAPACITY_QUOTA = 0x10001, /* 8 */ | |
154 | OSD_ATTR_RQ_PARTITION_OBJECT_COUNT = 0x10002, /* 8 */ | |
155 | OSD_ATTR_RQ_PARTITION_COLLECTIONS_PER_USER_OBJECT = 0x10081, /* 4 */ | |
156 | OSD_ATTR_RQ_PARTITION_COUNT = 0x20002, /* 8 */ | |
157 | }; | |
158 | ||
159 | struct Root_Quotas_attributes_page { | |
160 | struct osd_attr_page_header hdr; /* id=R+2, size=0x24 */ | |
161 | __be64 default_maximum_user_object_length; | |
162 | __be64 partition_capacity_quota; | |
163 | __be64 partition_object_count; | |
164 | __be64 partition_collections_per_user_object; | |
165 | __be64 partition_count; | |
166 | } __packed; | |
167 | ||
168 | /* 7.1.2.13 Partition Quotas attributes page (OSD_APAGE_PARTITION_QUOTAS)*/ | |
169 | enum { | |
170 | OSD_ATTR_PQ_DEFAULT_MAXIMUM_USER_OBJECT_LENGTH = 0x1, /* 8 */ | |
171 | OSD_ATTR_PQ_CAPACITY_QUOTA = 0x10001, /* 8 */ | |
172 | OSD_ATTR_PQ_OBJECT_COUNT = 0x10002, /* 8 */ | |
173 | OSD_ATTR_PQ_COLLECTIONS_PER_USER_OBJECT = 0x10081, /* 4 */ | |
174 | }; | |
175 | ||
176 | struct Partition_Quotas_attributes_page { | |
177 | struct osd_attr_page_header hdr; /* id=P+2, size=0x1C */ | |
178 | __be64 default_maximum_user_object_length; | |
179 | __be64 capacity_quota; | |
180 | __be64 object_count; | |
181 | __be64 collections_per_user_object; | |
182 | } __packed; | |
183 | ||
184 | /* 7.1.2.14 User Object Quotas attributes page (OSD_APAGE_OBJECT_QUOTAS) */ | |
185 | enum { | |
186 | OSD_ATTR_OQ_MAXIMUM_LENGTH = 0x1, /* 8 */ | |
187 | }; | |
188 | ||
189 | struct Object_Quotas_attributes_page { | |
190 | struct osd_attr_page_header hdr; /* id=U+2, size=0x8 */ | |
191 | __be64 maximum_length; | |
192 | } __packed; | |
193 | ||
194 | /* 7.1.2.15 Root Timestamps attributes page (OSD_APAGE_ROOT_TIMESTAMP) */ | |
195 | enum { | |
196 | OSD_ATTR_RT_ATTRIBUTES_ACCESSED_TIME = 0x2, /* 6 */ | |
197 | OSD_ATTR_RT_ATTRIBUTES_MODIFIED_TIME = 0x3, /* 6 */ | |
198 | OSD_ATTR_RT_TIMESTAMP_BYPASS = 0xFFFFFFFE, /* 1 */ | |
199 | }; | |
200 | ||
201 | struct root_timestamps_attributes_page { | |
202 | struct osd_attr_page_header hdr; /* id=R+3, size=0xD */ | |
203 | struct osd_timestamp attributes_accessed_time; | |
204 | struct osd_timestamp attributes_modified_time; | |
205 | u8 timestamp_bypass; | |
206 | } __packed; | |
207 | ||
208 | /* 7.1.2.16 Partition Timestamps attributes page | |
209 | * (OSD_APAGE_PARTITION_TIMESTAMP) | |
210 | */ | |
211 | enum { | |
212 | OSD_ATTR_PT_CREATED_TIME = 0x1, /* 6 */ | |
213 | OSD_ATTR_PT_ATTRIBUTES_ACCESSED_TIME = 0x2, /* 6 */ | |
214 | OSD_ATTR_PT_ATTRIBUTES_MODIFIED_TIME = 0x3, /* 6 */ | |
215 | OSD_ATTR_PT_DATA_ACCESSED_TIME = 0x4, /* 6 */ | |
216 | OSD_ATTR_PT_DATA_MODIFIED_TIME = 0x5, /* 6 */ | |
217 | OSD_ATTR_PT_TIMESTAMP_BYPASS = 0xFFFFFFFE, /* 1 */ | |
218 | }; | |
219 | ||
220 | struct partition_timestamps_attributes_page { | |
221 | struct osd_attr_page_header hdr; /* id=P+3, size=0x1F */ | |
222 | struct osd_timestamp created_time; | |
223 | struct osd_timestamp attributes_accessed_time; | |
224 | struct osd_timestamp attributes_modified_time; | |
225 | struct osd_timestamp data_accessed_time; | |
226 | struct osd_timestamp data_modified_time; | |
227 | u8 timestamp_bypass; | |
228 | } __packed; | |
229 | ||
230 | /* 7.1.2.17/18 Collection/Object Timestamps attributes page | |
231 | * (OSD_APAGE_COLLECTION_TIMESTAMP/OSD_APAGE_OBJECT_TIMESTAMP) | |
232 | */ | |
233 | enum { | |
234 | OSD_ATTR_OT_CREATED_TIME = 0x1, /* 6 */ | |
235 | OSD_ATTR_OT_ATTRIBUTES_ACCESSED_TIME = 0x2, /* 6 */ | |
236 | OSD_ATTR_OT_ATTRIBUTES_MODIFIED_TIME = 0x3, /* 6 */ | |
237 | OSD_ATTR_OT_DATA_ACCESSED_TIME = 0x4, /* 6 */ | |
238 | OSD_ATTR_OT_DATA_MODIFIED_TIME = 0x5, /* 6 */ | |
239 | }; | |
240 | ||
241 | /* same for collection */ | |
242 | struct object_timestamps_attributes_page { | |
243 | struct osd_attr_page_header hdr; /* id=C+3/3, size=0x1E */ | |
244 | struct osd_timestamp created_time; | |
245 | struct osd_timestamp attributes_accessed_time; | |
246 | struct osd_timestamp attributes_modified_time; | |
247 | struct osd_timestamp data_accessed_time; | |
248 | struct osd_timestamp data_modified_time; | |
249 | } __packed; | |
250 | ||
251 | /* 7.1.2.19 Collections attributes page */ | |
252 | /* TBD */ | |
253 | ||
254 | /* 7.1.2.20 Root Policy/Security attributes page (OSD_APAGE_ROOT_SECURITY) */ | |
255 | enum { | |
256 | OSD_ATTR_RS_DEFAULT_SECURITY_METHOD = 0x1, /* 1 */ | |
257 | OSD_ATTR_RS_OLDEST_VALID_NONCE_LIMIT = 0x2, /* 6 */ | |
258 | OSD_ATTR_RS_NEWEST_VALID_NONCE_LIMIT = 0x3, /* 6 */ | |
259 | OSD_ATTR_RS_PARTITION_DEFAULT_SECURITY_METHOD = 0x6, /* 1 */ | |
260 | OSD_ATTR_RS_SUPPORTED_SECURITY_METHODS = 0x7, /* 2 */ | |
261 | OSD_ATTR_RS_ADJUSTABLE_CLOCK = 0x9, /* 6 */ | |
262 | OSD_ATTR_RS_MASTER_KEY_IDENTIFIER = 0x7FFD, /* 0 or 7 */ | |
263 | OSD_ATTR_RS_ROOT_KEY_IDENTIFIER = 0x7FFE, /* 0 or 7 */ | |
264 | OSD_ATTR_RS_SUPPORTED_INTEGRITY_ALGORITHM_0 = 0x80000000,/* 1,(x16)*/ | |
265 | OSD_ATTR_RS_SUPPORTED_DH_GROUP_0 = 0x80000010,/* 1,(x16)*/ | |
266 | }; | |
267 | ||
268 | struct root_security_attributes_page { | |
269 | struct osd_attr_page_header hdr; /* id=R+5, size=0x3F */ | |
270 | u8 default_security_method; | |
271 | u8 partition_default_security_method; | |
272 | __be16 supported_security_methods; | |
273 | u8 mki_valid_rki_valid; | |
274 | struct osd_timestamp oldest_valid_nonce_limit; | |
275 | struct osd_timestamp newest_valid_nonce_limit; | |
276 | struct osd_timestamp adjustable_clock; | |
277 | u8 master_key_identifier[32-25]; | |
278 | u8 root_key_identifier[39-32]; | |
279 | u8 supported_integrity_algorithm[16]; | |
280 | u8 supported_dh_group[16]; | |
281 | } __packed; | |
282 | ||
283 | /* 7.1.2.21 Partition Policy/Security attributes page | |
284 | * (OSD_APAGE_PARTITION_SECURITY) | |
285 | */ | |
286 | enum { | |
287 | OSD_ATTR_PS_DEFAULT_SECURITY_METHOD = 0x1, /* 1 */ | |
288 | OSD_ATTR_PS_OLDEST_VALID_NONCE = 0x2, /* 6 */ | |
289 | OSD_ATTR_PS_NEWEST_VALID_NONCE = 0x3, /* 6 */ | |
290 | OSD_ATTR_PS_REQUEST_NONCE_LIST_DEPTH = 0x4, /* 2 */ | |
291 | OSD_ATTR_PS_FROZEN_WORKING_KEY_BIT_MASK = 0x5, /* 2 */ | |
292 | OSD_ATTR_PS_PARTITION_KEY_IDENTIFIER = 0x7FFF, /* 0 or 7 */ | |
293 | OSD_ATTR_PS_WORKING_KEY_IDENTIFIER_FIRST = 0x8000, /* 0 or 7 */ | |
294 | OSD_ATTR_PS_WORKING_KEY_IDENTIFIER_LAST = 0x800F, /* 0 or 7 */ | |
295 | OSD_ATTR_PS_POLICY_ACCESS_TAG = 0x40000001, /* 4 */ | |
296 | OSD_ATTR_PS_USER_OBJECT_POLICY_ACCESS_TAG = 0x40000002, /* 4 */ | |
297 | }; | |
298 | ||
299 | struct partition_security_attributes_page { | |
300 | struct osd_attr_page_header hdr; /* id=p+5, size=0x8f */ | |
301 | u8 reserved[3]; | |
302 | u8 default_security_method; | |
303 | struct osd_timestamp oldest_valid_nonce; | |
304 | struct osd_timestamp newest_valid_nonce; | |
305 | __be16 request_nonce_list_depth; | |
306 | __be16 frozen_working_key_bit_mask; | |
307 | __be32 policy_access_tag; | |
308 | __be32 user_object_policy_access_tag; | |
309 | u8 pki_valid; | |
310 | __be16 wki_00_0f_vld; | |
311 | struct osd_key_identifier partition_key_identifier; | |
312 | struct osd_key_identifier working_key_identifiers[16]; | |
313 | } __packed; | |
314 | ||
315 | /* 7.1.2.22/23 Collection/Object Policy-Security attributes page | |
316 | * (OSD_APAGE_COLLECTION_SECURITY/OSD_APAGE_OBJECT_SECURITY) | |
317 | */ | |
318 | enum { | |
319 | OSD_ATTR_OS_POLICY_ACCESS_TAG = 0x40000001, /* 4 */ | |
320 | }; | |
321 | ||
322 | struct object_security_attributes_page { | |
323 | struct osd_attr_page_header hdr; /* id=C+5/5, size=4 */ | |
324 | __be32 policy_access_tag; | |
325 | } __packed; | |
326 | ||
327 | #endif /*ndef __OSD_ATTRIBUTES_H__*/ |