harddisk_identify_device_data.h

Go to the documentation of this file.

#ifndef HARDDISK_IDENTIFY_DEVICE_DATA_H
#define HARDDISK_IDENTIFY_DEVICE_DATA_H

#include <stdint.h>

#define HARDDISK_SERIAL_NUMBER_LENGTH 20

#define HARDDISK_FIRMWARE_VERSION_LENGTH 8

#define HARDDISK_MODEL_NUMBER_LENGTH 40

typedef struct general_configuration_fields
{      
    // Reserved
    uint8_t                                                  : 1;
    // Retried
    uint8_t                                                  : 1;
    uint8_t response_incomplete                              : 1;
    // Retried
    uint8_t                                                  : 3;
    // Obsolete
    uint8_t                                                  : 1;
    uint8_t removable_media_device                           : 1;
    // Retried
    uint8_t                                                  : 7;
    uint8_t ata_device                                       : 1;
} __attribute__((packed)) general_configuration_fields;

typedef struct trusted_computing_fields
{
    uint8_t trusted_computing_feature_set_supported          : 1;
    uint16_t trusted_computing_reserved                      : 13;
    uint8_t trusted_computing_set_to_one                     : 1;
    uint8_t trusted_computing_set_to_zero                    : 1;
} __attribute__((packed)) trusted_computing_fields;

typedef struct capabilities_fields
{
    // Retired
    uint8_t                                                  : 8;
    uint8_t dma_supported                                    : 1;
    uint8_t lba_supported                                    : 1;
    uint8_t iordy_may_be_disabled_or_supported               : 1;
    uint8_t iordy_supported                                  : 1;
    // Reserved for IDENTIFY PACKET DEVICE command
    uint8_t                                                  : 1;
    uint8_t standby_timer_type                               : 1;
    // Reserved for IDENTIFY PACKET DEVICE command
    uint8_t                                                  : 2;

    uint8_t standby_timer_value_min                          : 1;
    // Obsolete
    uint8_t                                                  : 1;
    // Reserved
    uint16_t                                                 : 12;
    uint8_t capabilities_set_to_one                          : 1;
    uint8_t capabilities_set_to_zero                         : 1;
} __attribute__((packed)) capabilities_fields;

typedef struct additional_supported_fields
{  
    // Reserved
    uint8_t                                                  : 2;
    uint8_t all_write_cache_is_non_volatile                  : 1;
    uint8_t extended_number_of_user_addressable_sectors_is_supported : 1;
    uint8_t device_encrypts_all_user_data_on_the_device      : 1;
    uint8_t trimmed_lba_range_returning_zeroed_data_is_supported : 1;
    uint8_t optional_ata_device_28_bit_command_support       : 1;
    uint8_t                                                  : 1;
    uint8_t download_microcode_dma_is_supported              : 1;
    uint8_t                                                  : 1;
    uint8_t write_buffer_dma_is_supported                    : 1;
    uint8_t read_buffer_dma_is_supported                     : 1;
    uint8_t                                                  : 1;
    uint8_t long_physical_sector_alignment_error_reporting_control_is_supported : 1;
    uint8_t determinic_read_after_trim_supported             : 1;
    // Reserved for CFA.
    uint8_t                                                  : 1;
} __attribute__((packed)) additional_supported_fields;

typedef struct serial_ata_capabilities_fields
{
    
    // Will be cleared to zero.
    uint8_t                                                  : 1;
    uint8_t sata_gen1                                        : 1;
    uint8_t sata_gen2                                        : 1;
    uint8_t sata_gen3                                        : 1;
    uint8_t                                                  : 4;
    uint8_t ncq                                              : 1;
    uint8_t hipm                                             : 1;
    uint8_t phy_event_counters                               : 1;
    uint8_t unload_while_ncq                                 : 1;
    uint8_t ncq_priority                                     : 1;
    uint8_t host_auto_ps_transactions                        : 1;
    uint8_t device_auto_ps_transactions                      : 1;
    uint8_t read_log_dma_ext                                 : 1;

    // Will be cleared to zero.
    uint8_t                                                  : 1;
    uint8_t coded_value_for_current_sata_speed               : 3;
    uint8_t ncq_streaming                                    : 1;
    uint8_t mcq_queue_management_command                     : 1;
    uint8_t receive_send_fpdma_queued                        : 1;
    // Reserved for Serial ATA.
    uint16_t                                                 : 9;
} __attribute__((packed)) serial_ata_capabilities_fields;

typedef struct serial_ata_features_supported_fields
{  
    // Will be cleared to zero.
    uint8_t                                                  : 1;
    uint8_t non_zero_buffer_offset                           : 1;
    uint8_t dma_setup_auto_activation                        : 1;
    uint8_t initiating_power_management                      : 1;
    uint8_t in_order_data_delivery                           : 1;
    uint8_t hardware_feature_control                         : 1;
    uint8_t hardware_setting_preservation                    : 1;
    uint8_t ncq_autosense                                    : 1;
    // Reserved for Serial ATA.
    uint8_t                                                  : 8;
} __attribute__((packed)) serial_ata_features_supported_fields;

typedef struct serial_ata_features_enabled_fields
{
    
    // Will be cleared to zero.
    uint8_t                                                  : 1;
    uint8_t non_zero_buffer_offset                           : 1;
    uint8_t dma_setup_auto_activation                        : 1;
    uint8_t initiating_power_management                      : 1;
    uint8_t in_order_data_delivery                           : 1;
    uint8_t hardware_feature_control                         : 1;
    uint8_t hardware_setting_preservation                    : 1;
    uint8_t auto_ps_transictions                             : 1;
    // Reserved for Serial ATA.
    uint8_t                                                  : 8;
} __attribute__((packed)) serial_ata_features_enabled_fields;

typedef struct major_revision_fields
{
    // Reserved
    uint8_t                                                  : 1;
    // Obsolete
    uint8_t                                                  : 4;
    uint8_t supports_ata_atapi_5                             : 1;
    uint8_t supports_ata_atapi_6                             : 1;
    uint8_t supports_ata_atapi_7                             : 1;
    uint8_t supports_ata8_acs                                : 1;
    uint8_t supports_acs_2                                   : 1;
    uint8_t supports_acs_3                                   : 1;
    // Reserved
    uint8_t                                                  : 5;
} __attribute__((packed)) major_revision_fields;

typedef struct command_set_support_fields
{
    uint8_t smart                                            : 1;
    uint8_t security_mode                                    : 1;
    uint8_t removable_media                                  : 1;
    uint8_t mandatory_power_management                       : 1;
    uint8_t packet_command                                   : 1;
    uint8_t write_cache                                      : 1;
    uint8_t look_ahead                                       : 1;
    uint8_t release_interrupt                                : 1;
    uint8_t service_interrupt                                : 1;
    uint8_t device_reset_command                             : 1;
    uint8_t host_protected_area                              : 1;
    uint8_t                                                  : 1;
    uint8_t write_buffer_command                             : 1;
    uint8_t read_buffer_command                              : 1;
    uint8_t nop_command                                      : 1;
    uint8_t                                                  : 1;

    uint8_t download_microcode                               : 1;
    uint8_t read_write_dma_queued                            : 1;
    uint8_t cfa                                              : 1;
    uint8_t advanced_power_management                        : 1;
    uint8_t removable_media_status_notification              : 1;
    uint8_t powerup_in_standby                               : 1;
    uint8_t manual_powerup                                   : 1;
    uint8_t                                                  : 1;
    uint8_t set_max                                          : 1;
    uint8_t automatic_acoustic_management                    : 1;
    uint8_t address_48_bit                                   : 1;
    uint8_t device_configuration_overlay                     : 1;
    uint8_t mandatory_flush_cache                            : 1;
    uint8_t flush_cache_ext                                  : 1;
    // Will be cleared to one.
    uint8_t                                                  : 1;
    // Will be cleared to zero.
    uint8_t                                                  : 1;

    uint8_t smart_error_logging                              : 1;
    uint8_t smart_self_test                                  : 1;
    uint8_t media_serial_number                              : 1;
    uint8_t media__card_pass_through                         : 1;
    uint8_t streaming                                        : 1;
    uint8_t general_purpose_logging                          : 1;
    uint8_t write_dma_fua_ext                                : 1;
    uint8_t write_dma_queued_fua_ext                         : 1;
    uint8_t worldwide_name_64_bit                            : 1;
    uint8_t urg_for_read_stream                              : 1;
    uint8_t urg_for_write_stream                             : 1;
    uint8_t reserved_for_tech_report_1                       : 1;
    uint8_t reserved_for_tech_report_2                       : 1;
    uint8_t idle_with_unload_feature                         : 1;
    // Will be cleared to one.
    uint8_t                                                  : 1;
    // Will be cleared to zero.
    uint8_t                                                  : 1;
} __attribute__((packed)) command_set_support_fields;

typedef struct command_set_active_fields
{
    uint8_t smart                                            : 1;
    uint8_t security_mode                                    : 1;
    uint8_t removable_media                                  : 1;
    uint8_t mandatory_power_management                       : 1;
    uint8_t packet_command                                   : 1;
    uint8_t write_cache                                      : 1;
    uint8_t look_ahead                                       : 1;
    uint8_t release_interrupt                                : 1;
    uint8_t service_interrupt                                : 1;
    uint8_t device_reset_command                             : 1;
    uint8_t host_protected_area                              : 1;
    uint8_t                                                  : 1;
    uint8_t write_buffer_command                             : 1;
    uint8_t read_buffer_command                              : 1;
    uint8_t nop_command                                      : 1;
    uint8_t                                                  : 1;

    uint8_t download_microcode                               : 1;
    uint8_t read_write_dma_queued                            : 1;
    uint8_t cfa                                              : 1;
    uint8_t advanced_power_management                        : 1;
    uint8_t removable_media_status_notification              : 1;
    uint8_t powerup_in_standby                               : 1;
    uint8_t manual_powerup                                   : 1;
    uint8_t                                                  : 1;
    uint8_t set_max                                          : 1;
    uint8_t automatic_acoustic_management                    : 1;
    uint8_t address_48_bit                                   : 1;
    uint8_t device_configuration_overlay                     : 1;
    uint8_t mandatory_flush_cache                            : 1;
    uint8_t flush_cache_ext                                  : 1;
    // Reserved.
    uint8_t                                                  : 2;

    uint8_t smart_error_logging                              : 1;
    uint8_t smart_self_test                                  : 1;
    uint8_t media_serial_number_valid                        : 1;
    uint8_t media__card_pass_through                         : 1;
    uint8_t configure_stream_executed                        : 1;
    uint8_t general_purpose_logging                          : 1;
    uint8_t write_dma_fua_ext                                : 1;
    uint8_t write_dma_queued_fua_ext                         : 1;
    uint8_t worldwide_name_64_bit                            : 1;
    uint8_t urg_for_read_stream                              : 1;
    uint8_t urg_for_write_stream                             : 1;
    // Reserved for technical report.
    uint8_t                                                  : 1;
    // Reserved for technical report.
    uint8_t                                                  : 1;
    uint8_t idle_with_unload_feature                         : 1;
    // Will be cleared to one.
    uint8_t                                                  : 1;
    // Will be cleared to zero.
    uint8_t                                                  : 1;
} __attribute__((packed)) command_set_active_fields;

typedef struct ultra_dma_modes_fields
{
    uint8_t ultra_dma_mode_0_supported                       : 1;
    uint8_t ultra_dma_mode_1_and_below_supported             : 1;
    uint8_t ultra_dma_mode_2_and_below_supported             : 1;
    uint8_t ultra_dma_mode_3_and_below_supported             : 1;
    uint8_t ultra_dma_mode_4_and_below_supported             : 1;
    uint8_t ultra_dma_mode_5_and_below_supported             : 1;
    uint8_t ultra_dma_mode_6_and_below_supported             : 1;
    // Reserved
    uint8_t                                                  : 1;
    uint8_t ultra_dma_mode_0_selected                        : 1;
    uint8_t ultra_dma_mode_1_selected                        : 1;
    uint8_t ultra_dma_mode_2_selected                        : 1;
    uint8_t ultra_dma_mode_3_selected                        : 1;
    uint8_t ultra_dma_mode_4_selected                        : 1;
    uint8_t ultra_dma_mode_5_selected                        : 1;
    uint8_t ultra_dma_mode_6_selected                        : 1;
    // Reserved
    uint8_t                                                  : 1;
} __attribute__((packed)) ultra_dma_modes_fields;

typedef struct hardware_reset_result_fields
{  

    struct
    {
        // Will be cleared to one.
        uint8_t                                                  : 1;

        uint8_t how_determined_device_0_number                   : 2;
        uint8_t passed_diagnostics                               : 1;
        uint8_t assertion_of_pdiag                               : 1;
        uint8_t assertion_of_dasp                                : 1;
        uint8_t respond_when_device_1                            : 1;
        // Reserved
        uint8_t                                                  : 1;
    } hardware_device_0_reset_result_fields;

    struct
    {
        // Will be cleared to one.
        uint8_t                                                  : 1;

        uint8_t how_determined_device_1_number                   : 2;
        uint8_t asserted_pdiag                                   : 1;
        // Reserved
        uint8_t                                                  : 1;
    } hardware_device_1_reset_result_fields;
    uint8_t cblid_detection                                  : 1;
    // Will be cleared to one.
    uint8_t                                                  : 1;
    // Will be cleared to zero.
    uint8_t                                                  : 1;
} __attribute__((packed)) hardware_reset_result_fields;

typedef struct physical_logical_sector_size_fields
{
    
    uint8_t logical_per_physical_sectors                     : 4;
    // Reserved
    uint8_t logical_sector_per_physical_sectors              : 8;
    uint8_t logical_sector_longer_than_256_words             : 4;
    uint8_t multiple_logical_sector_per_physical_sector      : 4;
    // Will be cleared to one.
    uint8_t                                                  : 1;
    // Will be cleared to zero.
    uint8_t                                                  : 1;
} __attribute__((packed)) physical_logical_sector_size_fields;

typedef struct worldwide_name_fields
{
    uint16_t ieee_oui_12_23                                  : 12;
    uint16_t naa_0_3                                         : 4;

    uint16_t unique_id_32_35                                 : 4;
    uint16_t ieee_oui_0_11                                   : 12;

    uint16_t unique_id_16_31                                 : 16;

    uint16_t unique_id_0_15                                  : 16;
} __attribute__((packed)) worldwide_name_fields;

typedef struct security_status_fields
{    
    uint8_t security_supported                               : 1;
    uint8_t security_enabled                                 : 1;
    uint8_t security_locked                                  : 1;
    uint8_t security_frozen                                  : 1;
    uint8_t security_count_expired                           : 1;
    uint8_t enhanced_security_erase_supported                : 1;
    // Reserved
    uint8_t                                                  : 2;

    uint8_t security_level                                   : 1;
    // Reserved
    uint8_t                                                  : 7;
} __attribute__((packed)) security_status_fields;

typedef struct cfa_power_mode_1_fields
{ 
    uint16_t maximum_current_in_ma                           : 12;
    uint8_t cfa_power_mode_1_disabled                        : 1;
    uint8_t cfa_powe_mode_1_required                         : 1;
    // Reserved
    uint8_t                                                  : 1;
    uint8_t word_160_supported                               : 1;
} __attribute__((packed)) cfa_power_mode_1_fields;


typedef struct harddisk_identify_device_data_fields
{
    // 0 word
    general_configuration_fields general_configuration;

    // 1 word
    // Obsolete
    uint16_t                                                 : 16;

    // 2 word
    uint16_t specific_configuration                          : 16;

    // 3 word
    // Obsolete
    uint16_t                                                 : 16;

    // 4 word
    // Retried
    uint16_t                                                 : 16;

    // 5 word
    // Retried
    uint16_t                                                 : 16;

    // 6 word
    // Obsolete
    uint16_t                                                 : 16;

    // 7-8 word
    // Reserved for assignment by the CompactFlash Association
    uint32_t                                                 : 32;

    // 9 word
    // Retried
    uint16_t                                                 : 16;

    // 10-19 word
    char serial_number[HARDDISK_SERIAL_NUMBER_LENGTH];

    // 20 word
    // Retried
    uint16_t                                                 : 16;

    // 21 word
    // Retried
    uint16_t                                                 : 16;

    // 22 word
    // Obsolete
    uint16_t                                                 : 16;

    // 23-26 word
    char firmware_version[HARDDISK_FIRMWARE_VERSION_LENGTH];

    // 27-46 word
    char model_number[HARDDISK_MODEL_NUMBER_LENGTH];

    // 47 word
    uint8_t value_80h                                        : 8;
    uint8_t max_number_of_sectors_per_interrupt              : 8;
    
    // 48 word
    trusted_computing_fields trusted_computing;

    // 49-50 word
    capabilities_fields capabilities;

    // 51 word
    // Obsolete
    uint16_t                                                 : 16;

    // 52 word
    // Obsolete
    uint16_t                                                 : 16;

    // 53 word
    // Obsolete
    uint8_t                                                  : 1;
    uint8_t fields_64_70_are_valid                           : 1;
    uint8_t fields_88_are_valid                              : 1;
    // Reserved
    uint8_t                                                  : 5;
    uint8_t freefall_control_sensitivity                     : 8;

    // 54 word
    // Obsolete
    uint16_t                                                 : 16;
    
    // 55 word
    // Obsolete
    uint16_t                                                 : 16;
    
    // 56 word
    // Obsolete
    uint16_t                                                 : 16;
    
    // 57 word
    // Obsolete
    uint16_t                                                 : 16;
    
    // 58 word
    // Obsolete
    uint16_t                                                 : 16;

    // 59 word
    uint8_t number_of_logical_sectors_per_drq                : 8;
    uint8_t multiple_logical_sector_setting_is_valid         : 1;
    // Reserved
    uint8_t                                                  : 3;
    uint8_t the_sanitize_feature_set_is_supported            : 1;
    uint8_t the_crypto_scramble_text_command_is_supported    : 1;
    uint8_t the_overwrite_text_command_is_supported          : 1;
    uint8_t the_block_erase_text_command_is_supported        : 1;

    // 60-61 word
    uint32_t total_number_of_user_addressable_sectors        : 32;

    // 62 word
    // Obsolete
    uint16_t                                                 : 16;

    // 63 word
    uint8_t multiword_dma_mode_0_is_supported                : 1;
    uint8_t multiword_dma_mode_1_and_below_are_supported     : 1;
    uint8_t multiword_dma_mode_2_and_below_are_supported     : 1;
    // Reserved
    uint8_t                                                  : 5;
    uint8_t multiword_dma_mode_0_is_selected                 : 1;
    uint8_t multiword_dma_mode_1__is_selected                : 1;
    uint8_t multiword_dma_mode_2_is_selected                 : 1;
    // Reserved
    uint8_t                                                  : 5;

    // 64 word
    uint8_t pio_modes_supported                              : 8;
    // Reserved
    uint8_t                                                  : 8;

    // 65 word
    uint16_t min_multiword_DMA_transfer_cycle_time_per_word : 16;

    // 66 word
    uint16_t manufaturers_recommended_multiword_DMA_transfer_cycle_time : 16;

    // 67 word
    uint16_t min_pio_transfer_cycle_time_without_flow_control : 16;

    // 68 word
    uint16_t min_pio_transfer_cycle_time_with_iordy_flow_control : 16;

    // 69 word
    additional_supported_fields additional_supported;

    // 70 word
    // Reserved
    uint16_t                                                 : 16;

    // 71 word
    // Reserved for the IDENTITY PACKET DEVICE command.
    uint16_t                                                 : 16;

    // 72 word
    // Reserved for the IDENTITY PACKET DEVICE command.
    uint16_t                                                 : 16;

    // 73 word
    // Reserved for the IDENTITY PACKET DEVICE command.
    uint16_t                                                 : 16;

    // 74 word
    // Reserved for the IDENTITY PACKET DEVICE command.
    uint16_t                                                 : 16;

    // 75 word
    uint8_t queue_depth                                      : 5;
    // Reserved
    uint16_t                                                 : 11;

    // 76-77 word
    serial_ata_capabilities_fields serial_ata_capabilities;

    // 78 word
    serial_ata_features_supported_fields serial_ata_features_supported;

    // 79 word
    serial_ata_features_enabled_fields serial_ata_features_enabled;

    // 80 word
    major_revision_fields major_revision;

    // 81 word
    uint16_t minor_revision                                  : 16;

    // 82-84 word
    command_set_support_fields command_set_support;

    // 85-87 word
    command_set_active_fields command_set_active;

    // 88 word
    ultra_dma_modes_fields ultra_dma_modes;

    // 89 word
    uint16_t time_required_for_security_erase                : 16;

    // 90 word
    uint16_t time_required_for_enhanced_security_erase       : 16;

    // 91 word
    uint16_t current_advanced_power_management_value         : 16;

    // 92 word
    uint16_t master_password_revision_code                   : 16;

    // 93 word
    hardware_reset_result_fields hardware_reset_result;

    // 94 word
    uint8_t current_acoustic_value                           : 8;
    uint8_t recommended_acoustic_value                       : 8;

    // 95 word
    uint16_t stream_min_request_size                         : 16;

    // 96 word
    uint16_t steraming_transfer_time_dma                     : 16;

    // 97 word
    uint16_t steraming_access_latency_dma_pio                : 16;

    // 98-99 word
    uint32_t steraming_performance_granularity               : 32;

    // 100-103 word
    uint64_t maximum_user_lba_for_48_bit                     : 64;

    // 104 word
    uint16_t steraming_transfer_time_pio                     : 16;

    // 105 word
    // Reserved
    uint16_t                                                 : 16;

    // 106 word
    physical_logical_sector_size_fields physical_logical_sector_size;

    // 107 word
    uint16_t inter_seek_delay                                : 16;

    // 108-111 word
    worldwide_name_fields worldwide_name;

    // 112-115 word
    // Reserved for worldwide name extension to 128 bits.
    uint64_t                                                 : 64;

    // 116 word
    // Reserved for technical report.
    uint16_t                                                 : 16;

    // 117-118 word
    uint32_t words_per_logical_sector                        : 32;

    // 119 word
    // Reserved
    uint16_t                                                 : 16;

    // 120 word
    // Reserved
    uint16_t                                                 : 16;

    // 121 word
    // Reserved
    uint16_t                                                 : 16;

    // 122 word
    // Reserved
    uint16_t                                                 : 16;

    // 123 word
    // Reserved
    uint16_t                                                 : 16;

    // 124 word
    // Reserved
    uint16_t                                                 : 16;

    // 125 word
    // Reserved
    uint16_t                                                 : 16;

    // 126 word
    // Reserved
    uint16_t                                                 : 16;

    // 127 word

    uint8_t removable_media_status_notification_support      : 2;
    // Reserved
    uint16_t                                                 : 14;

    // 128 word
    security_status_fields security_status;

    // 129-159 word
    uint16_t vendor_specific[31];

    // 160 word
    cfa_power_mode_1_fields cfa_power_mode_1;

    // 161-175 word
    // Reserved for assignment by the CompactFlash Association.
    uint16_t reserved_161_175[15];

    // 176-205 word
    uint16_t current_media_serial_number[30];

    // 206-254 word
    // Reserved
    uint16_t reserved_206_254[49];

    // 255 word
    uint8_t signature                                        : 8;
    uint8_t checksum                                         : 8;

} __attribute__((packed)) harddisk_identify_device_data_fields;


typedef union harddisk_identify_device_data
{
    harddisk_identify_device_data_fields fields;
    uint16_t values[256];
} harddisk_identify_device_data;

#endif