Repository navigation
Expand file tree
/
Copy pathIOStorageProtocolCharacteristics.h
More file actions
645 lines (557 loc) · 15.1 KB
/
Copy pathIOStorageProtocolCharacteristics.h
File metadata and controls
645 lines (557 loc) · 15.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
/*
* Copyright (c) 1998-2014 Apple Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef _IOKIT_IO_STORAGE_PROTOCOL_CHARACTERISTICS_H_
#define _IOKIT_IO_STORAGE_PROTOCOL_CHARACTERISTICS_H_
#include <IOKit/storage/IOStorageControllerCharacteristics.h>
/*
* Protocol Characteristics - Characteristics defined for protocols.
*/
/*!
@defined kIOPropertyProtocolCharacteristicsKey
@discussion This key is used to define Protocol Characteristics for a particular
protocol and it has an associated dictionary which lists the
protocol characteristics.
Requirement: Mandatory
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>ATAPI</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyProtocolCharacteristicsKey "Protocol Characteristics"
/*!
@defined kIOPropertySCSIInitiatorIdentifierKey
@discussion An identifier that will uniquely identify this SCSI Initiator for the
SCSI Domain.
Requirement: Mandatory for SCSI Parallel Interface, SAS,
and Fibre Channel Interface.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
<key>SCSI Initiator Identifier</key>
<integer>7</integer>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertySCSIInitiatorIdentifierKey "SCSI Initiator Identifier"
/*!
@defined kIOPropertySCSIDomainIdentifierKey
@discussion An identifier that will uniquely identify this SCSI Domain for the
Physical Interconnect type. This identifier is only guaranteed to be unique for
any given Physical Interconnect and is not guaranteed to be the same across
restarts or shutdowns.
Requirement: Mandatory for SCSI Parallel Interface and Fibre Channel Interface.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
<key>SCSI Domain Identifier</key>
<integer>0</integer>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertySCSIDomainIdentifierKey "SCSI Domain Identifier"
/*!
@defined kIOPropertySCSITargetIdentifierKey
@discussion This is the SCSI Target Identifier for a given SCSI Target Device.
Requirement: Mandatory for SCSI Parallel Interface and Fibre Channel Interface.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
<key>SCSI Target Identifier</key>
<integer>3</integer>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertySCSITargetIdentifierKey "SCSI Target Identifier"
/*!
@defined kIOPropertySCSILogicalUnitNumberKey
@discussion This key is the SCSI Logical Unit Number for the device server
controlled by the driver.
Requirement: Mandatory for SCSI Parallel Interface, SAS, and Fibre Channel Interface.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
<key>SCSI Logical Unit Number</key>
<integer>2</integer>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertySCSILogicalUnitNumberKey "SCSI Logical Unit Number"
/*!
@defined kIOPropertyPhysicalInterconnectTypeKey
@discussion This key is used to define the Physical Interconnect to which
a device is attached.
Requirement: Mandatory.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeKey "Physical Interconnect"
/*!
@defined kIOPropertyPhysicalInterconnectLocationKey
@discussion This key is used to define the Physical Interconnect
Location.
Requirement: Mandatory.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectLocationKey "Physical Interconnect Location"
/*!
@defined kIOPropertySCSIProtocolMultiInitKey
@discussion This protocol characteristics key is used to inform the system
that the protocol supports having multiple devices that act as initiators.
Requirement: Optional.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Fibre Channel Interface</string>
<key>Physical Interconnect Location</key>
<string>External</string>
<key>Multiple Initiators</key>
<string>True</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertySCSIProtocolMultiInitKey "Multiple Initiators"
/*
* Values - Values for the characteristics defined above.
*/
/*!
@defined kIOPropertyInternalKey
@discussion This key defines the value of Internal for the key
kIOPropertyPhysicalInterconnectLocationKey. If the device is
connected to an internal bus, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>ATA</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyInternalKey "Internal"
/*!
@defined kIOPropertyExternalKey
@discussion This key defines the value of External for the key
kIOPropertyPhysicalInterconnectLocationKey. If the device is
connected to an external bus, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Fibre Channel Interface</string>
<key>Physical Interconnect Location</key>
<string>External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyExternalKey "External"
/*!
@defined kIOPropertyInternalExternalKey
@discussion This key defines the value of Internal/External for the key
kIOPropertyPhysicalInterconnectLocationKey. If the device is connected
to a bus and it is indeterminate whether it is internal or external,
this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>Internal/External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyInternalExternalKey "Internal/External"
/*!
@defined kIOPropertyInterconnectFileKey
@discussion This key defines the value of File for the key
kIOPropertyPhysicalInterconnectLocationKey. If the device is a file
that is being represented as a storage device, this key should be set.
NOTE: This key should only be used when the Physical Interconnect is set to
Virtual Interface.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Virtual Interface</string>
<key>Physical Interconnect Location</key>
<string>File</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyInterconnectFileKey "File"
/*!
@defined kIOPropertyInterconnectRAMKey
@discussion This key defines the value of RAM for the key
kIOPropertyPhysicalInterconnectLocationKey. If the device is system memory
that is being represented as a storage device, this key should be set.
NOTE: This key should only be used when the Physical Interconnect is set to
Virtual Interface.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Virtual Interface</string>
<key>Physical Interconnect Location</key>
<string>RAM</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyInterconnectRAMKey "RAM"
/*!
@defined kIOPropertyPhysicalInterconnectTypeATA
@discussion This key defines the value of ATA for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to an ATA bus, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>ATA</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeATA "ATA"
/*!
@defined kIOPropertyPhysicalInterconnectTypeSerialATA
@discussion This key defines the value of SATA for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to a SATA bus, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SATA</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeSerialATA "SATA"
/*!
@defined kIOPropertyPhysicalInterconnectTypeSerialAttachedSCSI
@discussion This key defines the value of SAS for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to a SAS bus, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SAS</string>
<key>Physical Interconnect Location</key>
<string>External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeSerialAttachedSCSI "SAS"
/*!
@defined kIOPropertyPhysicalInterconnectTypeATAPI
@discussion This key defines the value of ATAPI for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to an ATA bus and follows the ATAPI command specification, this key
should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>ATAPI</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeATAPI "ATAPI"
/*!
@defined kIOPropertyPhysicalInterconnectTypeUSB
@discussion This key defines the value of USB for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to a USB port, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>USB</string>
<key>Physical Interconnect Location</key>
<string>External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeUSB "USB"
/*!
@defined kIOPropertyPhysicalInterconnectTypeFireWire
@discussion This key defines the value of USB for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to a FireWire port, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>FireWire</string>
<key>Physical Interconnect Location</key>
<string>External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeFireWire "FireWire"
/*!
@defined kIOPropertyPhysicalInterconnectTypeSecureDigital
@discussion This key defines the value of Secure Digital for the key
kIOPropertyPhysicalInterconnectTypeSecureDigital. If the device is
connected to a Secure Digital port and follows the Secure Digital
specification, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Secure Digital</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeSecureDigital "Secure Digital"
/*!
@defined kIOPropertyPhysicalInterconnectTypeSCSIParallel
@discussion This key defines the value of SCSI Parallel Interface for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to a SCSI Parallel port, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>SCSI Parallel Interface</string>
<key>Physical Interconnect Location</key>
<string>External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeSCSIParallel "SCSI Parallel Interface"
/*!
@defined kIOPropertyPhysicalInterconnectTypeFibreChannel
@discussion This key defines the value of Fibre Channel Interface for the key
kIOPropertyPhysicalInterconnectTypeKey. If the device is connected
to a Fibre Channel port, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Fibre Channel Interface</string>
<key>Physical Interconnect Location</key>
<string>External</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeFibreChannel "Fibre Channel Interface"
/*!
@defined kIOPropertyPhysicalInterconnectTypeVirtual
@discussion This key defines the value of Virtual Interface for the key
kIOPropertyPhysicalInterconnectTypeVirtual. If the device is being made to look
like a storage device, but is not such in actuality, such as a File or RAM, this
key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>Virtual Interface</string>
<key>Physical Interconnect Location</key>
<string>File</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypeVirtual "Virtual Interface"
/*!
@defined kIOPropertyPhysicalInterconnectTypePCI
@discussion This key defines the value of PCI for the key
kIOPropertyPhysicalInterconnectTypePCI. If the device is connected
via PCI, this key should be set.
Example:
<pre>
@textblock
<dict>
<key>Protocol Characteristics</key>
<dict>
<key>Physical Interconnect</key>
<string>PCI</string>
<key>Physical Interconnect Location</key>
<string>Internal</string>
</dict>
</dict>
@/textblock
</pre>
*/
#define kIOPropertyPhysicalInterconnectTypePCI "PCI"
#endif /* _IOKIT_IO_STORAGE_PROTOCOL_CHARACTERISTICS_H_ */