forked from hiyohiyo/CrystalDiskInfo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AtaSmart.h
1873 lines (1585 loc) · 55 KB
/
AtaSmart.h
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
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------------------------*/
// Author : hiyohiyo
// Mail : [email protected]
// Web : https://crystalmark.info/
// License : The MIT License
/*---------------------------------------------------------------------------*/
// Reference : http://www.usefullcode.net/2007/02/hddsmart.html (ja)
#pragma once
#include "winioctl.h"
#include "SPTIUtil.h"
#include "SlotSpeedGetter.h"
#include "NVMeInterpreter.h"
#include "StorageQuery.h"
typedef struct _VOLUME_DISK_EXTENTS_LX {
DWORD NumberOfDiskExtents;
DISK_EXTENT Extents[4];
} VOLUME_DISK_EXTENTS_LX, *PVOLUME_DISK_EXTENTS_LX;
class CAtaSmart
{
public:
static const int MAX_DISK = 64;// FIX
static const int MAX_ATTRIBUTE = 30; // FIX
static const int MAX_SEARCH_PHYSICAL_DRIVE = 56;
static const int MAX_SEARCH_SCSI_PORT = 16;
static const int MAX_SEARCH_SCSI_TARGET_ID = 8;
static const int SCSI_MINIPORT_BUFFER_SIZE = 512;
public:
CAtaSmart();
virtual ~CAtaSmart();
enum SMART_STATUS
{
SMART_STATUS_NO_CHANGE = 0,
SMART_STATUS_MINOR_CHANGE,
SMART_STATUS_MAJOR_CHANGE
};
enum TRANSFER_MODE
{
TRANSFER_MODE_UNKNOWN = 0,
TRANSFER_MODE_PIO,
TRANSFER_MODE_PIO_DMA,
TRANSFER_MODE_ULTRA_DMA_16,
TRANSFER_MODE_ULTRA_DMA_25,
TRANSFER_MODE_ULTRA_DMA_33,
TRANSFER_MODE_ULTRA_DMA_44,
TRANSFER_MODE_ULTRA_DMA_66,
TRANSFER_MODE_ULTRA_DMA_100,
TRANSFER_MODE_ULTRA_DMA_133,
TRANSFER_MODE_SATA_150,
TRANSFER_MODE_SATA_300,
TRANSFER_MODE_SATA_600
};
enum DISK_STATUS
{
DISK_STATUS_UNKNOWN = 0,
DISK_STATUS_GOOD,
DISK_STATUS_CAUTION,
DISK_STATUS_BAD
};
enum POWER_ON_HOURS_UNIT
{
POWER_ON_UNKNOWN = 0,
POWER_ON_HOURS,
POWER_ON_MINUTES,
POWER_ON_HALF_MINUTES,
POWER_ON_SECONDS,
POWER_ON_10_MINUTES,
POWER_ON_MILLI_SECONDS,
};
enum HOST_READS_WRITES_UNIT
{
HOST_READS_WRITES_UNKNOWN = 0,
HOST_READS_WRITES_512B,
HOST_READS_WRITES_32MB,
HOST_READS_WRITES_GB,
};
enum COMMAND_TYPE
{
CMD_TYPE_UNKNOWN = 0,
CMD_TYPE_PHYSICAL_DRIVE,
CMD_TYPE_SCSI_MINIPORT,
CMD_TYPE_SILICON_IMAGE,
CMD_TYPE_SAT, // SAT = SCSI_ATA_TRANSLATION
CMD_TYPE_SUNPLUS,
CMD_TYPE_IO_DATA,
CMD_TYPE_LOGITEC1,
CMD_TYPE_LOGITEC2,
CMD_TYPE_JMICRON,
CMD_TYPE_CYPRESS,
CMD_TYPE_SAT_ASM1352R, // AMS1352 2nd drive
CMD_TYPE_CSMI, // CSMI = Common Storage Management Interface
CMD_TYPE_CSMI_PHYSICAL_DRIVE, // CSMI = Common Storage Management Interface
CMD_TYPE_WMI,
CMD_TYPE_NVME_SAMSUNG,
CMD_TYPE_NVME_INTEL,
CMD_TYPE_NVME_STORAGE_QUERY,
CMD_TYPE_NVME_JMICRON,
CMD_TYPE_NVME_ASMEDIA,
CMD_TYPE_NVME_REALTEK,
CMD_TYPE_NVME_INTEL_RST,
CMD_TYPE_MEGARAID,
CMD_TYPE_DEBUG
};
enum CSMI_TYPE
{
CSMI_TYPE_DISABLE = 0,
CSMI_TYPE_ENABLE_AUTO,
CSMI_TYPE_ENABLE_RAID,
CSMI_TYPE_ENABLE_ALL,
};
enum SMART_WMI_TYPE
{
WMI_SMART_DATA = 0,
WMI_SMART_THRESHOLD
};
enum VENDOR_ID
{
HDD_GENERAL = 0,
SSD_GENERAL = 1,
SSD_VENDOR_MTRON = 2,
SSD_VENDOR_INDILINX = 3,
SSD_VENDOR_JMICRON = 4,
SSD_VENDOR_INTEL = 5,
SSD_VENDOR_SAMSUNG = 6,
SSD_VENDOR_SANDFORCE = 7,
SSD_VENDOR_MICRON = 8,
SSD_VENDOR_OCZ = 9,
HDD_SSD_VENDOR_SEAGATE= 10,
HDD_VENDOR_WESTERN_DIGITAL=11,
SSD_VENDOR_PLEXTOR = 12,
SSD_VENDOR_SANDISK = 13,
SSD_VENDOR_OCZ_VECTOR = 14,
HDD_SSD_VENDOR_TOSHIBA= 15,
SSD_VENDOR_CORSAIR = 16,
SSD_VENDOR_KINGSTON = 17,
SSD_VENDOR_MICRON_MU02= 18,
SSD_VENDOR_NVME = 19,
SSD_VENDOR_REALTEK = 20,
SSD_VENDOR_SKhynix = 21,
SSD_VENDOR_KIOXIA = 22,
SSD_VENDOR_MAX = 99,
VENDOR_UNKNOWN = 0x0000,
USB_VENDOR_BUFFALO = 0x0411,
USB_VENDOR_IO_DATA = 0x04BB,
USB_VENDOR_LOGITEC = 0x0789,
USB_VENDOR_INITIO = 0x13FD,
USB_VENDOR_SUNPLUS = 0x04FC,
USB_VENDOR_JMICRON = 0x152D,
USB_VENDOR_CYPRESS = 0x04B4,
USB_VENDOR_OXFORD = 0x0928,
USB_VENDOR_PROLIFIC = 0x067B,
USB_VENDOR_REALTEK = 0x0BDA,
USB_VENDOR_ALL = 0xFFFF,
};
enum INTERFACE_TYPE
{
INTERFACE_TYPE_UNKNOWN = 0,
INTERFACE_TYPE_PATA,
INTERFACE_TYPE_SATA,
INTERFACE_TYPE_USB,
INTERFACE_TYPE_IEEE1394,
// INTERFACE_TYPE_UASP,
INTERFACE_TYPE_SCSI,
INTERFACE_TYPE_NVME,
// INTERFACE_TYPE_USB_NVME,
};
protected:
enum IO_CONTROL_CODE
{
DFP_SEND_DRIVE_COMMAND = 0x0007C084,
DFP_RECEIVE_DRIVE_DATA = 0x0007C088,
IOCTL_SCSI_MINIPORT = 0x0004D008,
IOCTL_IDE_PASS_THROUGH = 0x0004D028, // 2000 or later
IOCTL_ATA_PASS_THROUGH = 0x0004D02C, // XP SP2 and 2003 or later
};
#pragma pack(push,1)
typedef struct _IDENTIFY_DEVICE_OUTDATA
{
SENDCMDOUTPARAMS SendCmdOutParam;
BYTE Data[IDENTIFY_BUFFER_SIZE - 1];
} IDENTIFY_DEVICE_OUTDATA, *PIDENTIFY_DEVICE_OUTDATA;
typedef struct _SMART_READ_DATA_OUTDATA
{
SENDCMDOUTPARAMS SendCmdOutParam;
BYTE Data[READ_ATTRIBUTE_BUFFER_SIZE - 1];
} SMART_READ_DATA_OUTDATA, *PSMART_READ_DATA_OUTDATA;
typedef struct _CMD_IDE_PATH_THROUGH
{
IDEREGS reg;
DWORD length;
BYTE buffer[1];
} CMD_IDE_PATH_THROUGH, *PCMD_IDE_PATH_THROUGH;
static const int ATA_FLAGS_DRDY_REQUIRED = 0x01;
static const int ATA_FLAGS_DATA_IN = 0x02;
static const int ATA_FLAGS_DATA_OUT = 0x04;
static const int ATA_FLAGS_48BIT_COMMAND = 0x08;
typedef struct _ATA_PASS_THROUGH_EX
{
WORD Length;
WORD AtaFlags;
BYTE PathId;
BYTE TargetId;
BYTE Lun;
BYTE ReservedAsUchar;
DWORD DataTransferLength;
DWORD TimeOutValue;
DWORD ReservedAsUlong;
// DWORD DataBufferOffset;
#ifdef _WIN64
DWORD padding;
#endif
DWORD_PTR DataBufferOffset;
IDEREGS PreviousTaskFile;
IDEREGS CurrentTaskFile;
} ATA_PASS_THROUGH_EX, *PCMD_ATA_PASS_THROUGH_EX;
typedef struct
{
ATA_PASS_THROUGH_EX Apt;
DWORD Filer;
BYTE Buf[512];
} ATA_PASS_THROUGH_EX_WITH_BUFFERS;
typedef struct _SMART_THRESHOLD
{
BYTE Id;
BYTE ThresholdValue;
BYTE Reserved[10];
} SMART_THRESHOLD;
typedef struct _SRB_IO_CONTROL
{
ULONG HeaderLength;
UCHAR Signature[8];
ULONG Timeout;
ULONG ControlCode;
ULONG ReturnCode;
ULONG Length;
} SRB_IO_CONTROL;
typedef struct _SRB_IO_COMMAND
{
SRB_IO_CONTROL Cntrol;
IDEREGS IdeRegs;
BYTE Data[512];
} SRB_IO_COMMAND;
typedef struct {
SRB_IO_CONTROL sic ;
USHORT port ;
USHORT maybe_always1 ;
ULONG unknown[5] ;
//IDENTIFY_DEVICE id_data ;
WORD id_data[256] ;
} SilIdentDev ;
struct BIN_IDENTIFY_DEVICE
{
BYTE Bin[512];
};
struct NVME_IDENTIFY_DEVICE
{
CHAR Reserved1[4];
CHAR SerialNumber[20];
CHAR Model[40];
CHAR FirmwareRev[8];
CHAR Reserved2[9];
CHAR MinorVersion;
SHORT MajorVersion;
CHAR Reserved3[428];
};
struct ATA_IDENTIFY_DEVICE
{
WORD GeneralConfiguration; //0
WORD LogicalCylinders; //1 Obsolete
WORD SpecificConfiguration; //2
WORD LogicalHeads; //3 Obsolete
WORD Retired1[2]; //4-5
WORD LogicalSectors; //6 Obsolete
DWORD ReservedForCompactFlash; //7-8
WORD Retired2; //9
CHAR SerialNumber[20]; //10-19
WORD Retired3; //20
WORD BufferSize; //21 Obsolete
WORD Obsolute4; //22
CHAR FirmwareRev[8]; //23-26
CHAR Model[40]; //27-46
WORD MaxNumPerInterupt; //47
WORD Reserved1; //48
WORD Capabilities1; //49
WORD Capabilities2; //50
DWORD Obsolute5; //51-52
WORD Field88and7064; //53
WORD Obsolute6[5]; //54-58
WORD MultSectorStuff; //59
DWORD TotalAddressableSectors; //60-61
WORD Obsolute7; //62
WORD MultiWordDma; //63
WORD PioMode; //64
WORD MinMultiwordDmaCycleTime; //65
WORD RecommendedMultiwordDmaCycleTime; //66
WORD MinPioCycleTimewoFlowCtrl; //67
WORD MinPioCycleTimeWithFlowCtrl; //68
WORD Reserved2[6]; //69-74
WORD QueueDepth; //75
WORD SerialAtaCapabilities; //76
WORD SerialAtaAdditionalCapabilities; //77
WORD SerialAtaFeaturesSupported; //78
WORD SerialAtaFeaturesEnabled; //79
WORD MajorVersion; //80
WORD MinorVersion; //81
WORD CommandSetSupported1; //82
WORD CommandSetSupported2; //83
WORD CommandSetSupported3; //84
WORD CommandSetEnabled1; //85
WORD CommandSetEnabled2; //86
WORD CommandSetDefault; //87
WORD UltraDmaMode; //88
WORD TimeReqForSecurityErase; //89
WORD TimeReqForEnhancedSecure; //90
WORD CurrentPowerManagement; //91
WORD MasterPasswordRevision; //92
WORD HardwareResetResult; //93
WORD AcoustricManagement; //94
WORD StreamMinRequestSize; //95
WORD StreamingTimeDma; //96
WORD StreamingAccessLatency; //97
DWORD StreamingPerformance; //98-99
ULONGLONG MaxUserLba; //100-103
WORD StremingTimePio; //104
WORD Reserved3; //105
WORD SectorSize; //106
WORD InterSeekDelay; //107
WORD IeeeOui; //108
WORD UniqueId3; //109
WORD UniqueId2; //110
WORD UniqueId1; //111
WORD Reserved4[4]; //112-115
WORD Reserved5; //116
DWORD WordsPerLogicalSector; //117-118
WORD Reserved6[8]; //119-126
WORD RemovableMediaStatus; //127
WORD SecurityStatus; //128
WORD VendorSpecific[31]; //129-159
WORD CfaPowerMode1; //160
WORD ReservedForCompactFlashAssociation[7]; //161-167
WORD DeviceNominalFormFactor; //168
WORD DataSetManagement; //169
WORD AdditionalProductIdentifier[4]; //170-173
WORD Reserved7[2]; //174-175
CHAR CurrentMediaSerialNo[60]; //176-205
WORD SctCommandTransport; //206
WORD ReservedForCeAta1[2]; //207-208
WORD AlignmentOfLogicalBlocks; //209
DWORD WriteReadVerifySectorCountMode3; //210-211
DWORD WriteReadVerifySectorCountMode2; //212-213
WORD NvCacheCapabilities; //214
DWORD NvCacheSizeLogicalBlocks; //215-216
WORD NominalMediaRotationRate; //217
WORD Reserved8; //218
WORD NvCacheOptions1; //219
WORD NvCacheOptions2; //220
WORD Reserved9; //221
WORD TransportMajorVersionNumber; //222
WORD TransportMinorVersionNumber; //223
WORD ReservedForCeAta2[10]; //224-233
WORD MinimumBlocksPerDownloadMicrocode; //234
WORD MaximumBlocksPerDownloadMicrocode; //235
WORD Reserved10[19]; //236-254
WORD IntegrityWord; //255
};
#pragma pack(pop)
///////////////////////////////////////////////////
// from http://naraeon.net/en/archives/1126
///////////////////////////////////////////////////
#define NVME_STORPORT_DRIVER 0xE000
#define NVME_PASS_THROUGH_SRB_IO_CODE \
CTL_CODE( NVME_STORPORT_DRIVER, 0x800, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define NVME_SIG_STR "NvmeMini"
#define NVME_SIG_STR_LEN 8
#define NVME_FROM_DEV_TO_HOST 2
#define NVME_IOCTL_VENDOR_SPECIFIC_DW_SIZE 6
#define NVME_IOCTL_CMD_DW_SIZE 16
#define NVME_IOCTL_COMPLETE_DW_SIZE 4
#define NVME_PT_TIMEOUT 40
#define IOCTL_SCSI_GET_ADDRESS \
CTL_CODE(IOCTL_SCSI_BASE, 0x0406, METHOD_BUFFERED, FILE_ANY_ACCESS)
typedef struct _SCSI_ADDRESS {
ULONG Length;
UCHAR PortNumber;
UCHAR PathId;
UCHAR TargetId;
UCHAR Lun;
} SCSI_ADDRESS, *PSCSI_ADDRESS;
struct NVME_PASS_THROUGH_IOCTL {
SRB_IO_CONTROL SrbIoCtrl;
DWORD VendorSpecific[NVME_IOCTL_VENDOR_SPECIFIC_DW_SIZE];
DWORD NVMeCmd[NVME_IOCTL_CMD_DW_SIZE];
DWORD CplEntry[NVME_IOCTL_COMPLETE_DW_SIZE];
DWORD Direction;
DWORD QueueId;
DWORD DataBufferLen;
DWORD MetaDataLen;
DWORD ReturnBufferLen;
UCHAR DataBuffer[4096];
};
///////////////////
// from csmisas.h
///////////////////
// IOCTL Control Codes
// (IoctlHeader.ControlCode)
// Control Codes requiring CSMI_ALL_SIGNATURE
#define CC_CSMI_SAS_GET_DRIVER_INFO 1
#define CC_CSMI_SAS_GET_CNTLR_CONFIG 2
#define CC_CSMI_SAS_GET_CNTLR_STATUS 3
#define CC_CSMI_SAS_FIRMWARE_DOWNLOAD 4
// Control Codes requiring CSMI_RAID_SIGNATURE
#define CC_CSMI_SAS_GET_RAID_INFO 10
#define CC_CSMI_SAS_GET_RAID_CONFIG 11
#define CC_CSMI_SAS_GET_RAID_FEATURES 12
#define CC_CSMI_SAS_SET_RAID_CONTROL 13
#define CC_CSMI_SAS_GET_RAID_ELEMENT 14
#define CC_CSMI_SAS_SET_RAID_OPERATION 15
// Control Codes requiring CSMI_SAS_SIGNATURE
#define CC_CSMI_SAS_GET_PHY_INFO 20
#define CC_CSMI_SAS_SET_PHY_INFO 21
#define CC_CSMI_SAS_GET_LINK_ERRORS 22
#define CC_CSMI_SAS_SMP_PASSTHRU 23
#define CC_CSMI_SAS_SSP_PASSTHRU 24
#define CC_CSMI_SAS_STP_PASSTHRU 25
#define CC_CSMI_SAS_GET_SATA_SIGNATURE 26
#define CC_CSMI_SAS_GET_SCSI_ADDRESS 27
#define CC_CSMI_SAS_GET_DEVICE_ADDRESS 28
#define CC_CSMI_SAS_TASK_MANAGEMENT 29
#define CC_CSMI_SAS_GET_CONNECTOR_INFO 30
#define CC_CSMI_SAS_GET_LOCATION 31
// Control Codes requiring CSMI_PHY_SIGNATURE
#define CC_CSMI_SAS_PHY_CONTROL 60
#define IOCTL_HEADER SRB_IO_CONTROL
#define PIOCTL_HEADER PSRB_IO_CONTROL
/*************************************************************************/
/* OS INDEPENDENT CODE */
/*************************************************************************/
/* * * * * * * * * * Class Independent IOCTL Constants * * * * * * * * * */
// Return codes for all IOCTL's regardless of class
// (IoctlHeader.ReturnCode)
#define CSMI_SAS_STATUS_SUCCESS 0
#define CSMI_SAS_STATUS_FAILED 1
#define CSMI_SAS_STATUS_BAD_CNTL_CODE 2
#define CSMI_SAS_STATUS_INVALID_PARAMETER 3
#define CSMI_SAS_STATUS_WRITE_ATTEMPTED 4
// Signature value
// (IoctlHeader.Signature)
#define CSMI_ALL_SIGNATURE "CSMIALL"
// Timeout value default of 60 seconds
// (IoctlHeader.Timeout)
#define CSMI_ALL_TIMEOUT 60
// Direction values for data flow on this IOCTL
// (IoctlHeader.Direction, Linux only)
#define CSMI_SAS_DATA_READ 0
#define CSMI_SAS_DATA_WRITE 1
// I/O Bus Types
// ISA and EISA bus types are not supported
// (bIoBusType)
#define CSMI_SAS_BUS_TYPE_PCI 3
#define CSMI_SAS_BUS_TYPE_PCMCIA 4
// Controller Status
// (uStatus)
#define CSMI_SAS_CNTLR_STATUS_GOOD 1
#define CSMI_SAS_CNTLR_STATUS_FAILED 2
#define CSMI_SAS_CNTLR_STATUS_OFFLINE 3
#define CSMI_SAS_CNTLR_STATUS_POWEROFF 4
// Offline Status Reason
// (uOfflineReason)
#define CSMI_SAS_OFFLINE_REASON_NO_REASON 0
#define CSMI_SAS_OFFLINE_REASON_INITIALIZING 1
#define CSMI_SAS_OFFLINE_REASON_BACKSIDE_BUS_DEGRADED 2
#define CSMI_SAS_OFFLINE_REASON_BACKSIDE_BUS_FAILURE 3
// Controller Class
// (bControllerClass)
#define CSMI_SAS_CNTLR_CLASS_HBA 5
// Controller Flag bits
// (uControllerFlags)
#define CSMI_SAS_CNTLR_SAS_HBA 0x00000001
#define CSMI_SAS_CNTLR_SAS_RAID 0x00000002
#define CSMI_SAS_CNTLR_SATA_HBA 0x00000004
#define CSMI_SAS_CNTLR_SATA_RAID 0x00000008
#define CSMI_SAS_CNTLR_SMART_ARRAY 0x00000010
// for firmware download
#define CSMI_SAS_CNTLR_FWD_SUPPORT 0x00010000
#define CSMI_SAS_CNTLR_FWD_ONLINE 0x00020000
#define CSMI_SAS_CNTLR_FWD_SRESET 0x00040000
#define CSMI_SAS_CNTLR_FWD_HRESET 0x00080000
#define CSMI_SAS_CNTLR_FWD_RROM 0x00100000
// for RAID configuration supported
#define CSMI_SAS_CNTLR_RAID_CFG_SUPPORT 0x01000000
// Download Flag bits
// (uDownloadFlags)
#define CSMI_SAS_FWD_VALIDATE 0x00000001
#define CSMI_SAS_FWD_SOFT_RESET 0x00000002
#define CSMI_SAS_FWD_HARD_RESET 0x00000004
// Firmware Download Status
// (usStatus)
#define CSMI_SAS_FWD_SUCCESS 0
#define CSMI_SAS_FWD_FAILED 1
#define CSMI_SAS_FWD_USING_RROM 2
#define CSMI_SAS_FWD_REJECT 3
#define CSMI_SAS_FWD_DOWNREV 4
// Firmware Download Severity
// (usSeverity>
#define CSMI_SAS_FWD_INFORMATION 0
#define CSMI_SAS_FWD_WARNING 1
#define CSMI_SAS_FWD_ERROR 2
#define CSMI_SAS_FWD_FATAL 3
/* * * * * * * * * * SAS RAID Class IOCTL Constants * * * * * * * * */
// Return codes for the RAID IOCTL's regardless of class
// (IoctlHeader.ReturnCode)
#define CSMI_SAS_RAID_SET_OUT_OF_RANGE 1000
#define CSMI_SAS_RAID_SET_BUFFER_TOO_SMALL 1001
#define CSMI_SAS_RAID_SET_DATA_CHANGED 1002
// Signature value
// (IoctlHeader.Signature)
#define CSMI_RAID_SIGNATURE "CSMIARY"
// Timeout value default of 60 seconds
// (IoctlHeader.Timeout)
#define CSMI_RAID_TIMEOUT 60
// RAID Types
// (bRaidType)
#define CSMI_SAS_RAID_TYPE_NONE 0
#define CSMI_SAS_RAID_TYPE_0 1
#define CSMI_SAS_RAID_TYPE_1 2
#define CSMI_SAS_RAID_TYPE_10 3
#define CSMI_SAS_RAID_TYPE_5 4
#define CSMI_SAS_RAID_TYPE_15 5
#define CSMI_SAS_RAID_TYPE_6 6
#define CSMI_SAS_RAID_TYPE_50 7
#define CSMI_SAS_RAID_TYPE_VOLUME 8
#define CSMI_SAS_RAID_TYPE_1E 9
#define CSMI_SAS_RAID_TYPE_OTHER 255
// the last value 255 was already defined for other
// so end is defined as 254
#define CSMI_SAS_RAID_TYPE_END 254
// RAID Status
// (bStatus)
#define CSMI_SAS_RAID_SET_STATUS_OK 0
#define CSMI_SAS_RAID_SET_STATUS_DEGRADED 1
#define CSMI_SAS_RAID_SET_STATUS_REBUILDING 2
#define CSMI_SAS_RAID_SET_STATUS_FAILED 3
#define CSMI_SAS_RAID_SET_STATUS_OFFLINE 4
#define CSMI_SAS_RAID_SET_STATUS_TRANSFORMING 5
#define CSMI_SAS_RAID_SET_STATUS_QUEUED_FOR_REBUILD 6
#define CSMI_SAS_RAID_SET_STATUS_QUEUED_FOR_TRANSFORMATION 7
// RAID Drive Count
// (bDriveCount, 0xF1 to 0xFF are reserved)
#define CSMI_SAS_RAID_DRIVE_COUNT_TOO_BIG 0xF1
#define CSMI_SAS_RAID_DRIVE_COUNT_SUPRESSED 0xF2
// RAID Data Type
// (bDataType)
#define CSMI_SAS_RAID_DATA_DRIVES 0
#define CSMI_SAS_RAID_DATA_DEVICE_ID 1
#define CSMI_SAS_RAID_DATA_ADDITIONAL_DATA 2
// RAID Drive Status
// (bDriveStatus)
#define CSMI_SAS_DRIVE_STATUS_OK 0
#define CSMI_SAS_DRIVE_STATUS_REBUILDING 1
#define CSMI_SAS_DRIVE_STATUS_FAILED 2
#define CSMI_SAS_DRIVE_STATUS_DEGRADED 3
#define CSMI_SAS_DRIVE_STATUS_OFFLINE 4
#define CSMI_SAS_DRIVE_STATUS_QUEUED_FOR_REBUILD 5
// RAID Drive Usage
// (bDriveUsage)
#define CSMI_SAS_DRIVE_CONFIG_NOT_USED 0
#define CSMI_SAS_DRIVE_CONFIG_MEMBER 1
#define CSMI_SAS_DRIVE_CONFIG_SPARE 2
#define CSMI_SAS_DRIVE_CONFIG_SPARE_ACTIVE 3
// RAID Drive Type
// (bDriveType)
#define CSMI_SAS_DRIVE_TYPE_UNKNOWN 0
#define CSMI_SAS_DRIVE_TYPE_SINGLE_PORT_SAS 1
#define CSMI_SAS_DRIVE_TYPE_DUAL_PORT_SAS 2
#define CSMI_SAS_DRIVE_TYPE_SATA 3
#define CSMI_SAS_DRIVE_TYPE_SATA_PS 4
#define CSMI_SAS_DRIVE_TYPE_OTHER 255
// RAID Write Protect
// (bWriteProtect)
#define CSMI_SAS_RAID_SET_WRITE_PROTECT_UNKNOWN 0
#define CSMI_SAS_RAID_SET_WRITE_PROTECT_UNCHANGED 0
#define CSMI_SAS_RAID_SET_WRITE_PROTECT_ENABLED 1
#define CSMI_SAS_RAID_SET_WRITE_PROTECT_DISABLED 2
// RAID Cache Setting
// (bCacheSetting)
#define CSMI_SAS_RAID_SET_CACHE_UNKNOWN 0
#define CSMI_SAS_RAID_SET_CACHE_UNCHANGED 0
#define CSMI_SAS_RAID_SET_CACHE_ENABLED 1
#define CSMI_SAS_RAID_SET_CACHE_DISABLED 2
#define CSMI_SAS_RAID_SET_CACHE_CORRUPT 3
// RAID Features
// (uFeatures)
#define CSMI_SAS_RAID_FEATURE_TRANSFORMATION 0x00000001
#define CSMI_SAS_RAID_FEATURE_REBUILD 0x00000002
#define CSMI_SAS_RAID_FEATURE_SPLIT_MIRROR 0x00000004
#define CSMI_SAS_RAID_FEATURE_MERGE_MIRROR 0x00000008
#define CSMI_SAS_RAID_FEATURE_LUN_RENUMBER 0x00000010
#define CSMI_SAS_RAID_FEATURE_SURFACE_SCAN 0x00000020
#define CSMI_SAS_RAID_FEATURE_SPARES_SHARED 0x00000040
// RAID Priority
// (bDefaultTransformPriority, etc.)
#define CSMI_SAS_PRIORITY_UNKNOWN 0
#define CSMI_SAS_PRIORITY_UNCHANGED 0
#define CSMI_SAS_PRIORITY_AUTO 1
#define CSMI_SAS_PRIORITY_OFF 2
#define CSMI_SAS_PRIORITY_LOW 3
#define CSMI_SAS_PRIORITY_MEDIUM 4
#define CSMI_SAS_PRIORITY_HIGH 5
// RAID Transformation Rules
// (uRaidSetTransformationRules)
#define CSMI_SAS_RAID_RULE_AVAILABLE_MEMORY 0x00000001
#define CSMI_SAS_RAID_RULE_OVERLAPPED_EXTENTS 0x00000002
// RAID Cache Ratios Supported
// (bCacheRatiosSupported)
// from 0 to 100 defines the write to read ratio, 0 is 100% write
#define CSMI_SAS_RAID_CACHE_RATIO_RANGE 101
#define CSMI_SAS_RAID_CACHE_RATIO_FIXED 102
#define CSMI_SAS_RAID_CACHE_RATIO_AUTO 103
#define CSMI_SAS_RAID_CACHE_RATIO_END 255
// RAID Cache Ratio Flag
// (bCacheRatioFlag)
#define CSMI_SAS_RAID_CACHE_RATIO_DISABLE 0
#define CSMI_SAS_RAID_CACHE_RATIO_ENABLE 1
// RAID Clear Configuration Signature
// (bClearConfiguration)
#define CSMI_SAS_RAID_CLEAR_CONFIGURATION_SIGNATURE "RAIDCLR"
// RAID Failure Codes
// (uFailureCode)
#define CSMI_SAS_FAIL_CODE_OK 0
#define CSMI_SAS_FAIL_CODE_PARAMETER_INVALID 1000
#define CSMI_SAS_FAIL_CODE_TRANSFORM_PRIORITY_INVALID 1001
#define CSMI_SAS_FAIL_CODE_REBUILD_PRIORITY_INVALID 1002
#define CSMI_SAS_FAIL_CODE_CACHE_RATIO_INVALID 1003
#define CSMI_SAS_FAIL_CODE_SURFACE_SCAN_INVALID 1004
#define CSMI_SAS_FAIL_CODE_CLEAR_CONFIGURATION_INVALID 1005
#define CSMI_SAS_FAIL_CODE_ELEMENT_INDEX_INVALID 1006
#define CSMI_SAS_FAIL_CODE_SUBELEMENT_INDEX_INVALID 1007
#define CSMI_SAS_FAIL_CODE_EXTENT_INVALID 1008
#define CSMI_SAS_FAIL_CODE_BLOCK_COUNT_INVALID 1009
#define CSMI_SAS_FAIL_CODE_DRIVE_INDEX_INVALID 1010
#define CSMI_SAS_FAIL_CODE_EXISTING_LUN_INVALID 1011
#define CSMI_SAS_FAIL_CODE_RAID_TYPE_INVALID 1012
#define CSMI_SAS_FAIL_CODE_STRIPE_SIZE_INVALID 1013
#define CSMI_SAS_FAIL_CODE_TRANSFORMATION_INVALID 1014
#define CSMI_SAS_FAIL_CODE_CHANGE_COUNT_INVALID 1015
#define CSMI_SAS_FAIL_CODE_ENUMERATION_TYPE_INVALID 1016
#define CSMI_SAS_FAIL_CODE_EXCEEDED_RAID_SET_COUNT 2000
#define CSMI_SAS_FAIL_CODE_DUPLICATE_LUN 2001
#define CSMI_SAS_FAIL_CODE_WAIT_FOR_OPERATION 3000
// RAID Enumeration Types
// (uEnumerationType)
#define CSMI_SAS_RAID_ELEMENT_TYPE_DRIVE 0
#define CSMI_SAS_RAID_ELEMENT_TYPE_MODULE 1
#define CSMI_SAS_RAID_ELEMENT_TYPE_DRIVE_RAID_SET 2
#define CSMI_SAS_RAID_ELEMENT_TYPE_EXTENT_DRIVE 3
// RAID Extent Types
// (bExtentType)
#define CSMI_SAS_RAID_EXTENT_RESERVED 0
#define CSMI_SAS_RAID_EXTENT_METADATA 1
#define CSMI_SAS_RAID_EXTENT_ALLOCATED 2
#define CSMI_SAS_RAID_EXTENT_UNALLOCATED 3
// RAID Operation Types
// (uOperationType)
#define CSMI_SAS_RAID_SET_CREATE 0
#define CSMI_SAS_RAID_SET_LABEL 1
#define CSMI_SAS_RAID_SET_TRANSFORM 2
#define CSMI_SAS_RAID_SET_DELETE 3
#define CSMI_SAS_RAID_SET_WRITE_PROTECT 4
#define CSMI_SAS_RAID_SET_CACHE 5
#define CSMI_SAS_RAID_SET_ONLINE_STATE 6
#define CSMI_SAS_RAID_SET_SPARE 7
// RAID Transform Types
// (bTransformType)
#define CSMI_SAS_RAID_SET_TRANSFORM_SPLIT_MIRROR 0
#define CSMI_SAS_RAID_SET_TRANSFORM_MERGE_RAID_0 1
#define CSMI_SAS_RAID_SET_TRANSFORM_LUN_RENUMBER 2
#define CSMI_SAS_RAID_SET_TRANSFORM_RAID_SET 3
// RAID Online State
// (bOnlineState)
#define CSMI_SAS_RAID_SET_STATE_UNKNOWN 0
#define CSMI_SAS_RAID_SET_STATE_ONLINE 1
#define CSMI_SAS_RAID_SET_STATE_OFFLINE 2
/* * * * * * * * * * SAS HBA Class IOCTL Constants * * * * * * * * * */
// Return codes for SAS IOCTL's
// (IoctlHeader.ReturnCode)
#define CSMI_SAS_PHY_INFO_CHANGED CSMI_SAS_STATUS_SUCCESS
#define CSMI_SAS_PHY_INFO_NOT_CHANGEABLE 2000
#define CSMI_SAS_LINK_RATE_OUT_OF_RANGE 2001
#define CSMI_SAS_PHY_DOES_NOT_EXIST 2002
#define CSMI_SAS_PHY_DOES_NOT_MATCH_PORT 2003
#define CSMI_SAS_PHY_CANNOT_BE_SELECTED 2004
#define CSMI_SAS_SELECT_PHY_OR_PORT 2005
#define CSMI_SAS_PORT_DOES_NOT_EXIST 2006
#define CSMI_SAS_PORT_CANNOT_BE_SELECTED 2007
#define CSMI_SAS_CONNECTION_FAILED 2008
#define CSMI_SAS_NO_SATA_DEVICE 2009
#define CSMI_SAS_NO_SATA_SIGNATURE 2010
#define CSMI_SAS_SCSI_EMULATION 2011
#define CSMI_SAS_NOT_AN_END_DEVICE 2012
#define CSMI_SAS_NO_SCSI_ADDRESS 2013
#define CSMI_SAS_NO_DEVICE_ADDRESS 2014
// Signature value
// (IoctlHeader.Signature)
#define CSMI_SAS_SIGNATURE "CSMISAS"
// Timeout value default of 60 seconds
// (IoctlHeader.Timeout)
#define CSMI_SAS_TIMEOUT 60
// Device types
// (bDeviceType)
#define CSMI_SAS_PHY_UNUSED 0x00
#define CSMI_SAS_NO_DEVICE_ATTACHED 0x00
#define CSMI_SAS_END_DEVICE 0x10
#define CSMI_SAS_EDGE_EXPANDER_DEVICE 0x20
#define CSMI_SAS_FANOUT_EXPANDER_DEVICE 0x30
// Protocol options
// (bInitiatorPortProtocol, bTargetPortProtocol)
#define CSMI_SAS_PROTOCOL_SATA 0x01
#define CSMI_SAS_PROTOCOL_SMP 0x02
#define CSMI_SAS_PROTOCOL_STP 0x04
#define CSMI_SAS_PROTOCOL_SSP 0x08
// Negotiated and hardware link rates
// (bNegotiatedLinkRate, bMinimumLinkRate, bMaximumLinkRate)
#define CSMI_SAS_LINK_RATE_UNKNOWN 0x00
#define CSMI_SAS_PHY_DISABLED 0x01
#define CSMI_SAS_LINK_RATE_FAILED 0x02
#define CSMI_SAS_SATA_SPINUP_HOLD 0x03
#define CSMI_SAS_SATA_PORT_SELECTOR 0x04
#define CSMI_SAS_LINK_RATE_1_5_GBPS 0x08
#define CSMI_SAS_LINK_RATE_3_0_GBPS 0x09
#define CSMI_SAS_LINK_VIRTUAL 0x10
// Discover state
// (bAutoDiscover)
#define CSMI_SAS_DISCOVER_NOT_SUPPORTED 0x00
#define CSMI_SAS_DISCOVER_NOT_STARTED 0x01
#define CSMI_SAS_DISCOVER_IN_PROGRESS 0x02
#define CSMI_SAS_DISCOVER_COMPLETE 0x03
#define CSMI_SAS_DISCOVER_ERROR 0x04
// Phy features
#define CSMI_SAS_PHY_VIRTUAL_SMP 0x01
// Programmed link rates
// (bMinimumLinkRate, bMaximumLinkRate)
// (bProgrammedMinimumLinkRate, bProgrammedMaximumLinkRate)
#define CSMI_SAS_PROGRAMMED_LINK_RATE_UNCHANGED 0x00
#define CSMI_SAS_PROGRAMMED_LINK_RATE_1_5_GBPS 0x08
#define CSMI_SAS_PROGRAMMED_LINK_RATE_3_0_GBPS 0x09
// Link rate
// (bNegotiatedLinkRate in CSMI_SAS_SET_PHY_INFO)
#define CSMI_SAS_LINK_RATE_NEGOTIATE 0x00
#define CSMI_SAS_LINK_RATE_PHY_DISABLED 0x01
// Signal class
// (bSignalClass in CSMI_SAS_SET_PHY_INFO)
#define CSMI_SAS_SIGNAL_CLASS_UNKNOWN 0x00
#define CSMI_SAS_SIGNAL_CLASS_DIRECT 0x01
#define CSMI_SAS_SIGNAL_CLASS_SERVER 0x02
#define CSMI_SAS_SIGNAL_CLASS_ENCLOSURE 0x03
// Link error reset
// (bResetCounts)
#define CSMI_SAS_LINK_ERROR_DONT_RESET_COUNTS 0x00
#define CSMI_SAS_LINK_ERROR_RESET_COUNTS 0x01
// Phy identifier
// (bPhyIdentifier)
#define CSMI_SAS_USE_PORT_IDENTIFIER 0xFF
// Port identifier
// (bPortIdentifier)
#define CSMI_SAS_IGNORE_PORT 0xFF
// Programmed link rates
// (bConnectionRate)
#define CSMI_SAS_LINK_RATE_NEGOTIATED 0x00
#define CSMI_SAS_LINK_RATE_1_5_GBPS 0x08
#define CSMI_SAS_LINK_RATE_3_0_GBPS 0x09
// Connection status
// (bConnectionStatus)
#define CSMI_SAS_OPEN_ACCEPT 0
#define CSMI_SAS_OPEN_REJECT_BAD_DESTINATION 1
#define CSMI_SAS_OPEN_REJECT_RATE_NOT_SUPPORTED 2
#define CSMI_SAS_OPEN_REJECT_NO_DESTINATION 3
#define CSMI_SAS_OPEN_REJECT_PATHWAY_BLOCKED 4
#define CSMI_SAS_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED 5
#define CSMI_SAS_OPEN_REJECT_RESERVE_ABANDON 6
#define CSMI_SAS_OPEN_REJECT_RESERVE_CONTINUE 7
#define CSMI_SAS_OPEN_REJECT_RESERVE_INITIALIZE 8
#define CSMI_SAS_OPEN_REJECT_RESERVE_STOP 9
#define CSMI_SAS_OPEN_REJECT_RETRY 10
#define CSMI_SAS_OPEN_REJECT_STP_RESOURCES_BUSY 11
#define CSMI_SAS_OPEN_REJECT_WRONG_DESTINATION 12
// SSP Status
// (bSSPStatus)
#define CSMI_SAS_SSP_STATUS_UNKNOWN 0x00
#define CSMI_SAS_SSP_STATUS_WAITING 0x01
#define CSMI_SAS_SSP_STATUS_COMPLETED 0x02
#define CSMI_SAS_SSP_STATUS_FATAL_ERROR 0x03
#define CSMI_SAS_SSP_STATUS_RETRY 0x04
#define CSMI_SAS_SSP_STATUS_NO_TAG 0x05
// SSP Flags
// (uFlags)
#define CSMI_SAS_SSP_READ 0x00000001
#define CSMI_SAS_SSP_WRITE 0x00000002
#define CSMI_SAS_SSP_UNSPECIFIED 0x00000004
#define CSMI_SAS_SSP_TASK_ATTRIBUTE_SIMPLE 0x00000000
#define CSMI_SAS_SSP_TASK_ATTRIBUTE_HEAD_OF_QUEUE 0x00000010
#define CSMI_SAS_SSP_TASK_ATTRIBUTE_ORDERED 0x00000020
#define CSMI_SAS_SSP_TASK_ATTRIBUTE_ACA 0x00000040
// SSP Data present
// (bDataPresent)
#define CSMI_SAS_SSP_NO_DATA_PRESENT 0x00
#define CSMI_SAS_SSP_RESPONSE_DATA_PRESENT 0x01
#define CSMI_SAS_SSP_SENSE_DATA_PRESENT 0x02
// STP Flags
// (uFlags)
#define CSMI_SAS_STP_READ 0x00000001
#define CSMI_SAS_STP_WRITE 0x00000002
#define CSMI_SAS_STP_UNSPECIFIED 0x00000004
#define CSMI_SAS_STP_PIO 0x00000010
#define CSMI_SAS_STP_DMA 0x00000020
#define CSMI_SAS_STP_PACKET 0x00000040
#define CSMI_SAS_STP_DMA_QUEUED 0x00000080
#define CSMI_SAS_STP_EXECUTE_DIAG 0x00000100
#define CSMI_SAS_STP_RESET_DEVICE 0x00000200
// Task Management Flags
// (uFlags)
#define CSMI_SAS_TASK_IU 0x00000001
#define CSMI_SAS_HARD_RESET_SEQUENCE 0x00000002
#define CSMI_SAS_SUPPRESS_RESULT 0x00000004
// Task Management Functions
// (bTaskManagement)
#define CSMI_SAS_SSP_ABORT_TASK 0x01
#define CSMI_SAS_SSP_ABORT_TASK_SET 0x02
#define CSMI_SAS_SSP_CLEAR_TASK_SET 0x04
#define CSMI_SAS_SSP_LOGICAL_UNIT_RESET 0x08
#define CSMI_SAS_SSP_CLEAR_ACA 0x40
#define CSMI_SAS_SSP_QUERY_TASK 0x80
// Task Management Information
// (uInformation)
#define CSMI_SAS_SSP_TEST 1
#define CSMI_SAS_SSP_EXCEEDED 2
#define CSMI_SAS_SSP_DEMAND 3
#define CSMI_SAS_SSP_TRIGGER 4
// Connector Pinout Information
// (uPinout)
#define CSMI_SAS_CON_UNKNOWN 0x00000001
#define CSMI_SAS_CON_SFF_8482 0x00000002
#define CSMI_SAS_CON_SFF_8470_LANE_1 0x00000100