Sysman: add firmware flash API (#1368)

* Sysman: add firmware flash API

Signed-off-by: Vilvaraj, T J Vivek <[email protected]>

* Sysman: fixed windows implementation of firmware flash API.

Signed-off-by: Vilvaraj, T J Vivek <[email protected]>

* add unit tests to test flashing.

Signed-off-by: Vilvaraj, T J Vivek <[email protected]>

* sysman: add firmware flashing support to zello sysman

Signed-off-by: T J Vivek Vilvaraj <[email protected]>

* sysman: added progress update function to firmware flash API

Signed-off-by: T J Vivek Vilvaraj <[email protected]>

Author: vilvarajintel

level_zero/api/sysman/zes_sysman.cpp

@@ -388,7 +388,7 @@ zesFirmwareFlash(
     zes_firmware_handle_t hFirmware,
     void *pImage,
     uint32_t size) {
-    return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
+    return L0::Firmware::fromHandle(hFirmware)->firmwareFlash(pImage, size);
 }
 
 ZE_APIEXPORT ze_result_t ZE_APICALL

level_zero/tools/source/sysman/firmware/firmware.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -22,6 +22,7 @@ class Firmware : _zes_firmware_handle_t {
   public:
     virtual ~Firmware() {}
     virtual ze_result_t firmwareGetProperties(zes_firmware_properties_t *pProperties) = 0;
+    virtual ze_result_t firmwareFlash(void *pImage, uint32_t size) = 0;
 
     inline zes_firmware_handle_t toHandle() { return this; }
 

level_zero/tools/source/sysman/firmware/firmware_imp.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -20,6 +20,10 @@ ze_result_t FirmwareImp::firmwareGetProperties(zes_firmware_properties_t *pPrope
     return ZE_RESULT_SUCCESS;
 }
 
+ze_result_t FirmwareImp::firmwareFlash(void *pImage, uint32_t size) {
+    return pOsFirmware->osFirmwareFlash(pImage, size);
+}
+
 void FirmwareImp::init() {
     this->isFirmwareEnabled = pOsFirmware->isFirmwareSupported();
 }

level_zero/tools/source/sysman/firmware/firmware_imp.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -19,6 +19,7 @@ class OsFirmware;
 class FirmwareImp : public Firmware, NEO::NonCopyableOrMovableClass {
   public:
     ze_result_t firmwareGetProperties(zes_firmware_properties_t *pProperties) override;
+    ze_result_t firmwareFlash(void *pImage, uint32_t size) override;
     FirmwareImp() = default;
     FirmwareImp(OsSysman *pOsSysman);
     ~FirmwareImp() override;

level_zero/tools/source/sysman/firmware/linux/os_firmware_imp.cpp

@@ -27,6 +27,11 @@ void LinuxFirmwareImp::osGetFwProperties(zes_firmware_properties_t *pProperties)
         strncpy_s(pProperties->version, ZES_STRING_PROPERTY_SIZE, unknown.c_str(), ZES_STRING_PROPERTY_SIZE);
     }
 }
+
+ze_result_t LinuxFirmwareImp::osFirmwareFlash(void *pImage, uint32_t size) {
+    return pFwInterface->fwFlashGSC(pImage, size);
+}
+
 void LinuxFirmwareImp::getFirmwareVersion(char *firmwareVersion) {
     std::string fwVersion;
     pFwInterface->fwGetVersion(fwVersion);

level_zero/tools/source/sysman/firmware/linux/os_firmware_imp.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -18,6 +18,7 @@ class LinuxFirmwareImp : public OsFirmware, NEO::NonCopyableOrMovableClass {
   public:
     bool isFirmwareSupported(void) override;
     void osGetFwProperties(zes_firmware_properties_t *pProperties) override;
+    ze_result_t osFirmwareFlash(void *pImage, uint32_t size) override;
     LinuxFirmwareImp() = default;
     LinuxFirmwareImp(OsSysman *pOsSysman);
     ~LinuxFirmwareImp() override = default;

level_zero/tools/source/sysman/firmware/os_firmware.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -16,7 +16,7 @@ class OsFirmware {
   public:
     virtual bool isFirmwareSupported(void) = 0;
     virtual void osGetFwProperties(zes_firmware_properties_t *pProperties) = 0;
-
+    virtual ze_result_t osFirmwareFlash(void *pImage, uint32_t size) = 0;
     static OsFirmware *create(OsSysman *pOsSysman);
     virtual ~OsFirmware() {}
 };

level_zero/tools/source/sysman/firmware/windows/os_firmware_imp.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -14,6 +14,9 @@ bool WddmFirmwareImp::isFirmwareSupported(void) {
 }
 
 void WddmFirmwareImp::osGetFwProperties(zes_firmware_properties_t *pProperties){};
+ze_result_t WddmFirmwareImp::osFirmwareFlash(void *pImage, uint32_t size) {
+    return ZE_RESULT_ERROR_UNSUPPORTED_FEATURE;
+};
 
 OsFirmware *OsFirmware::create(OsSysman *pOsSysman) {
     WddmFirmwareImp *pWddmFirmwareImp = new WddmFirmwareImp();

level_zero/tools/source/sysman/firmware/windows/os_firmware_imp.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -16,6 +16,7 @@ class WddmFirmwareImp : public OsFirmware {
   public:
     bool isFirmwareSupported(void) override;
     void osGetFwProperties(zes_firmware_properties_t *pProperties) override;
+    ze_result_t osFirmwareFlash(void *pImage, uint32_t size) override;
 };
 
 } // namespace L0

level_zero/tools/source/sysman/linux/firmware_util/firmware_util.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Intel Corporation
+ * Copyright (C) 2020-2021 Intel Corporation
  *
  * SPDX-License-Identifier: MIT
  *
@@ -27,6 +27,7 @@ class FirmwareUtil {
     virtual ze_result_t fwDeviceInit() = 0;
     virtual ze_result_t getFirstDevice(igsc_device_info *) = 0;
     virtual ze_result_t fwGetVersion(std::string &fwVersion) = 0;
+    virtual ze_result_t fwFlashGSC(void *pImage, uint32_t size) = 0;
     virtual ~FirmwareUtil() = default;
 };
 } // namespace L0