atasmart.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef fooatasmarthfoo
   4 #define fooatasmarthfoo
   5
   6 /***
   7     This file is part of libatasmart.
   8
   9     Copyright 2008 Lennart Poettering
  10
  11     libatasmart is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU Lesser General Public License as
  13     published by the Free Software Foundation, either version 2.1 of the
  14     License, or (at your option) any later version.
  15
  16     libatasmart is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19     Lesser General Public License for more details.
  20
  21     You should have received a copy of the GNU Lesser General Public
  22     License along with libatasmart. If not, If not, see
  23     <http://www.gnu.org/licenses/>.
  24 ***/
  25
  26 #include <inttypes.h>
  27
  28 /* Please note that all enums defined here may be extended at any time
  29  * without this being considered an ABI change. So take care when
  30  * using them as indexes! */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef unsigned SkBool;
  37
  38 #ifndef FALSE
  39 #define FALSE (0)
  40 #endif
  41
  42 #ifndef TRUE
  43 #define TRUE (!FALSE)
  44 #endif
  45
  46 /* ATA SMART test type (ATA8 7.52.5.2) */
  47 typedef enum SkSmartSelfTest {
  48         SK_SMART_SELF_TEST_SHORT = 1,
  49         SK_SMART_SELF_TEST_EXTENDED = 2,
  50         SK_SMART_SELF_TEST_CONVEYANCE = 3,
  51         SK_SMART_SELF_TEST_ABORT = 127
  52
  53         /* This enum may be extended at any time without this being
  54          * considered an ABI change. So take care when you use this
  55          * type! */
  56 } SkSmartSelfTest;
  57
  58 const char* sk_smart_self_test_to_string(SkSmartSelfTest test);
  59
  60 typedef struct SkIdentifyParsedData {
  61         char serial[21];
  62         char firmware[9];
  63         char model[41];
  64
  65         /* This structure may be extended at any time without this being
  66          * considered an ABI change. So take care when you copy it. */
  67 } SkIdentifyParsedData;
  68
  69 typedef enum SkSmartOfflineDataCollectionStatus {
  70         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_NEVER,
  71         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_SUCCESS,
  72         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_INPROGRESS,
  73         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_SUSPENDED,
  74         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_ABORTED,
  75         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_FATAL,
  76         SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_UNKNOWN,
  77         _SK_SMART_OFFLINE_DATA_COLLECTION_STATUS_MAX
  78
  79         /* This enum may be extended at any time without this being
  80          * considered an ABI change. So take care when you use this
  81          * type! */
  82 } SkSmartOfflineDataCollectionStatus;
  83
  84 const char* sk_smart_offline_data_collection_status_to_string(SkSmartOfflineDataCollectionStatus status);
  85
  86 typedef enum SkSmartSelfTestExecutionStatus {
  87         SK_SMART_SELF_TEST_EXECUTION_STATUS_SUCCESS_OR_NEVER = 0,
  88         SK_SMART_SELF_TEST_EXECUTION_STATUS_ABORTED = 1,
  89         SK_SMART_SELF_TEST_EXECUTION_STATUS_INTERRUPTED = 2,
  90         SK_SMART_SELF_TEST_EXECUTION_STATUS_FATAL = 3,
  91         SK_SMART_SELF_TEST_EXECUTION_STATUS_ERROR_UNKNOWN = 4,
  92         SK_SMART_SELF_TEST_EXECUTION_STATUS_ERROR_ELECTRICAL = 5,
  93         SK_SMART_SELF_TEST_EXECUTION_STATUS_ERROR_SERVO = 6,
  94         SK_SMART_SELF_TEST_EXECUTION_STATUS_ERROR_READ = 7,
  95         SK_SMART_SELF_TEST_EXECUTION_STATUS_ERROR_HANDLING = 8,
  96         SK_SMART_SELF_TEST_EXECUTION_STATUS_INPROGRESS = 15,
  97         _SK_SMART_SELF_TEST_EXECUTION_STATUS_MAX
  98
  99         /* This enum may be extended at any time without this being
 100          * considered an ABI change. So take care when you use this
 101          * type! */
 102 } SkSmartSelfTestExecutionStatus;
 103
 104 const char *sk_smart_self_test_execution_status_to_string(SkSmartSelfTestExecutionStatus status);
 105
 106 typedef struct SkSmartParsedData {
 107         /* Volatile data */
 108         SkSmartOfflineDataCollectionStatus offline_data_collection_status;
 109         unsigned total_offline_data_collection_seconds;
 110         SkSmartSelfTestExecutionStatus self_test_execution_status;
 111         unsigned self_test_execution_percent_remaining;
 112
 113         /* Fixed data */
 114         SkBool short_and_extended_test_available:1;
 115         SkBool conveyance_test_available:1;
 116         SkBool start_test_available:1;
 117         SkBool abort_test_available:1;
 118
 119         unsigned short_test_polling_minutes;
 120         unsigned extended_test_polling_minutes;
 121         unsigned conveyance_test_polling_minutes;
 122
 123         /* This structure may be extended at any time without this being
 124          * considered an ABI change. So take care when you copy it.  */
 125 } SkSmartParsedData;
 126
 127 SkBool sk_smart_self_test_available(const SkSmartParsedData *d, SkSmartSelfTest test);
 128 unsigned sk_smart_self_test_polling_minutes(const SkSmartParsedData *d, SkSmartSelfTest test);
 129
 130 typedef enum SkSmartAttributeUnit {
 131         SK_SMART_ATTRIBUTE_UNIT_UNKNOWN,
 132         SK_SMART_ATTRIBUTE_UNIT_NONE,
 133         SK_SMART_ATTRIBUTE_UNIT_MSECONDS,    /* milliseconds */
 134         SK_SMART_ATTRIBUTE_UNIT_SECTORS,
 135         SK_SMART_ATTRIBUTE_UNIT_MKELVIN,     /* millikelvin */
 136         SK_SMART_ATTRIBUTE_UNIT_PERCENT,
 137         _SK_SMART_ATTRIBUTE_UNIT_MAX
 138
 139         /* This enum may be extended at any time without this being
 140          * considered an ABI change. So take care when you use this
 141          * type! */
 142 } SkSmartAttributeUnit;
 143
 144 const char* sk_smart_attribute_unit_to_string(SkSmartAttributeUnit unit);
 145
 146 typedef struct SkSmartAttributeParsedData {
 147         /* Fixed data */
 148         uint8_t id;
 149         const char *name;
 150         SkSmartAttributeUnit pretty_unit; /* for pretty_value */
 151
 152         uint16_t flags;
 153
 154         uint8_t threshold;
 155         SkBool threshold_valid:1;
 156
 157         SkBool online:1;
 158         SkBool prefailure:1;
 159
 160         /* Volatile data */
 161         SkBool good_now:1, good_now_valid:1;
 162         SkBool good_in_the_past:1, good_in_the_past_valid:1;
 163         SkBool current_value_valid:1, worst_value_valid:1;
 164         SkBool warn:1;
 165         uint8_t current_value, worst_value;
 166         uint64_t pretty_value;
 167         uint8_t raw[6];
 168
 169         /* This structure may be extended at any time without this being
 170          * considered an ABI change. So take care when you copy it. */
 171 } SkSmartAttributeParsedData;
 172
 173 typedef struct SkDisk SkDisk;
 174
 175 typedef enum SkSmartOverall  {
 176         SK_SMART_OVERALL_GOOD,
 177         SK_SMART_OVERALL_BAD_ATTRIBUTE_IN_THE_PAST,  /* At least one pre-fail attribute exceeded its threshold in the past */
 178         SK_SMART_OVERALL_BAD_SECTOR,                 /* At least one bad sector */
 179         SK_SMART_OVERALL_BAD_ATTRIBUTE_NOW,          /* At least one pre-fail attribute is exceeding its threshold now */
 180         SK_SMART_OVERALL_BAD_SECTOR_MANY,            /* Many bad sectors */
 181         SK_SMART_OVERALL_BAD_STATUS,                 /* Smart Self Assessment negative */
 182         _SK_SMART_OVERALL_MAX
 183
 184         /* This enum may be extended at any time without this being
 185          * considered an ABI change. So take care when you use this
 186          * type! */
 187 } SkSmartOverall;
 188
 189 const char* sk_smart_overall_to_string(SkSmartOverall overall);
 190
 191 int sk_disk_open(const char *name, SkDisk **d);
 192
 193 int sk_disk_get_size(SkDisk *d, uint64_t *bytes);
 194
 195 int sk_disk_check_sleep_mode(SkDisk *d, SkBool *awake);
 196
 197 int sk_disk_identify_is_available(SkDisk *d, SkBool *available);
 198 int sk_disk_identify_parse(SkDisk *d, const SkIdentifyParsedData **data);
 199
 200 typedef void (*SkSmartAttributeParseCallback)(SkDisk *d, const SkSmartAttributeParsedData *a, void* userdata);
 201
 202 int sk_disk_smart_is_available(SkDisk *d, SkBool *available);
 203 int sk_disk_smart_status(SkDisk *d, SkBool *good);
 204
 205 /* Reading SMART data might cause the disk to wake up from
 206  * sleep. Hence from monitoring daemons make sure to call
 207  * sk_disk_check_power_mode() to check wether the disk is sleeping and
 208  * skip the read if so. */
 209 int sk_disk_smart_read_data(SkDisk *d);
 210
 211 int sk_disk_get_blob(SkDisk *d, const void **blob, size_t *size);
 212 int sk_disk_set_blob(SkDisk *d, const void *blob, size_t size);
 213
 214 int sk_disk_smart_parse(SkDisk *d, const SkSmartParsedData **data);
 215 int sk_disk_smart_parse_attributes(SkDisk *d, SkSmartAttributeParseCallback cb, void* userdata);
 216 int sk_disk_smart_self_test(SkDisk *d, SkSmartSelfTest test);
 217
 218 /* High level API to get the power on time */
 219 int sk_disk_smart_get_power_on(SkDisk *d, uint64_t *mseconds);
 220
 221 /* High level API to get the power cycle count */
 222 int sk_disk_smart_get_power_cycle(SkDisk *d, uint64_t *count);
 223
 224 /* High level API to get the number of bad sectors (i.e. pending and reallocated) */
 225 int sk_disk_smart_get_bad(SkDisk *d, uint64_t *sectors);
 226
 227 /* High level API to get the temperature */
 228 int sk_disk_smart_get_temperature(SkDisk *d, uint64_t *mkelvin);
 229
 230 /* Get overall status. This integrates the values of a couple of fields into a single overall status */
 231 int sk_disk_smart_get_overall(SkDisk *d, SkSmartOverall *overall);
 232
 233 /* Dump the current parsed status to STDOUT */
 234 int sk_disk_dump(SkDisk *d);
 235
 236 void sk_disk_free(SkDisk *d);
 237
 238 #ifdef __cplusplus
 239 }
 240 #endif
 241
 242 #endif