feat: Adding support for --showFARM option

Adding new option to read and dump the FARM log to the screen.
Currently this is human readable only, but eventually we will get JSON too.

[#75]

Signed-off-by: Tyler Erickson <[email protected]>

Author: vonericsen

include/openseachest_util_options.h

@@ -479,6 +479,11 @@ extern "C"
         SMART_ATTRIBUTES_LONG_OPT_STRING, required_argument, M_NULLPTR, 0                                              \
     }
 
+    #define SHOW_FARM_FLAG  showFARMData
+    #define SHOW_FARM_VAR getOptBool SHOW_FARM_FLAG = goFalse;
+    #define SHOW_FARM_LONG_OPT_STRING "showFARM"
+    #define SHOW_FARM_LONG_OPT { SHOW_FARM_LONG_OPT_STRING, no_argument, &SHOW_FARM_FLAG, goTrue }
+
 #define NVME_HEALTH_FLAG            showNVMeHealthData
 #define NVME_HEALTH_VAR             getOptBool NVME_HEALTH_FLAG = goFalse;
 #define NVME_HEALTH_LONG_OPT_STRING "showNvmeHealth"
@@ -4073,6 +4078,8 @@ extern "C"
     //-----------------------------------------------------------------------------
     void print_SMART_Attributes_Help(bool shortHelp);
 
+    void print_Show_FARM_Help(bool shortHelp);
+
     //-----------------------------------------------------------------------------
     //
     //  print_Abort_DST_Help()

src/openseachest_util_options.c

@@ -976,6 +976,26 @@ void print_SMART_Attributes_Help(bool shortHelp)
     }
 }
 
+void print_Show_FARM_Help(bool shortHelp)
+{
+    printf("\t--%s\n", SHOW_FARM_LONG_OPT_STRING);
+    if (!shortHelp)
+    {
+        printf("\t\tUse this option to show the data in the FARM log.\n");
+        printf("\t\tFARM is the Field Accessible Reliability Metrics that\n");
+        printf("\t\tcan be reported from a Seagate hard drive.\n");
+        printf("\t\tFarm data has a few sections available:\n");
+        printf("\t\t\tGeneral Drive Info\n");
+        printf("\t\t\tWorkload Statistics\n");
+        printf("\t\t\tError Statistics\n");
+        printf("\t\t\tEnvironment Statistics\n");
+        printf("\t\t\tReliability Statistics\n");
+        printf("\t\tNewer Seagate HDDs may be able to report more information than\n");
+        printf("\t\tolder models. Data that can be reported may vary depending on the\n");
+        printf("\t\tcapabilities of a given product.\n\n");
+    }
+}
+
 void print_NVME_Health_Help(bool shortHelp)
 {
     printf("\t--%s\t(NVMe Only)\n", NVME_HEALTH_LONG_OPT_STRING);

subprojects/opensea-common

@@ -29,6 +29,7 @@
 #include "device_statistics.h"
 #include "drive_info.h"
 #include "dst.h"
+#include "farm_log.h"
 #include "getopt.h"
 #include "openseachest_util_options.h"
 #include "operations.h"
@@ -122,6 +123,7 @@ int main(int argc, char* argv[])
     NVME_HEALTH_VAR
     LOWLEVEL_INFO_VAR
     SMART_OFFLINE_SCAN_VAR
+    SHOW_FARM_VAR
 
     int args        = 0;
     int argIndex    = 0;
@@ -186,6 +188,7 @@ int main(int argc, char* argv[])
         DEVICE_STATISTICS_LONG_OPT,
         NVME_HEALTH_LONG_OPT,
         SMART_OFFLINE_SCAN_LONG_OPT,
+        SHOW_FARM_LONG_OPT,
         LONG_OPT_TERMINATOR
     };
 
@@ -817,7 +820,7 @@ int main(int argc, char* argv[])
           RUN_IDD_FLAG || DST_AND_CLEAN_FLAG || SMART_FEATURE_FLAG || SMART_ATTR_AUTOSAVE_FEATURE_FLAG ||
           SMART_INFO_FLAG || SMART_AUTO_OFFLINE_FEATURE_FLAG || SHOW_DST_LOG_FLAG || CONVEYANCE_DST_FLAG ||
           SET_MRIE_MODE_FLAG || SCSI_DEFECTS_FLAG || SHOW_SMART_ERROR_LOG_FLAG || DEVICE_STATISTICS_FLAG ||
-          NVME_HEALTH_FLAG || SMART_OFFLINE_SCAN_FLAG
+          NVME_HEALTH_FLAG || SMART_OFFLINE_SCAN_FLAG || SHOW_FARM_FLAG
           // check for other tool specific options here
           ))
     {
@@ -1127,6 +1130,22 @@ int main(int argc, char* argv[])
             }
         }
 
+
+        if (SHOW_FARM_FLAG)
+        {
+            farmLogData farmdata;
+            safe_memset(&farmdata, sizeof(farmLogData), 0, sizeof(farmLogData));
+            switch(read_FARM_Data(&deviceList[deviceIter], &farmdata))
+            {
+            case SUCCESS:
+                print_FARM_Data(&farmdata);
+                break;
+            default:
+                printf("Unable to read FARM data\n");
+                break;
+            }
+        }
+
         if (LOWLEVEL_INFO_FLAG)
         {
             print_Low_Level_Info(&deviceList[deviceIter]);
@@ -2280,6 +2299,7 @@ void utility_Usage(bool shortUsage)
     print_Long_DST_Help(shortUsage, commandWindowType);
     print_Short_DST_Help(shortUsage);
     print_Show_DST_Log_Help(shortUsage);
+    print_Show_FARM_Help(shortUsage);
     print_SMART_Check_Help(shortUsage);
     print_SMART_Feature_Help(shortUsage);
     // SATA Only