Skip to content

Commit

Permalink
PR #13576 from Eran: improve FW-update progress callback frequency & …
Browse files Browse the repository at this point in the history 
…debug
  • Loading branch information
@maloel
maloel authored Dec 5, 2024
2 parents c6bcb35 + 26317f1 commit 22f2345
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 53 deletions.
8 changes: 3 additions & 5 deletions src/ds/d500/d500-fw-update-device.cpp
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// License: Apache 2.0. See LICENSE file in root directory.
// Copyright(c) 2023 Intel Corporation. All Rights Reserved.
// Copyright(c) 2023-4 Intel Corporation. All Rights Reserved.

#include "d500-fw-update-device.h"
#include "d500-private.h"
Expand Down Expand Up @@ -75,10 +75,8 @@ ds_d500_update_device::ds_d500_update_device( std::shared_ptr< const device_info
return true;
}

std::stringstream ss;
ss << "DFU_GETSTATUS called, state is: " << to_string(dfu_state);
ss << ", iString equals: " << percentage_of_transfer << ", and bwPollTimeOut equals: " << status.bwPollTimeout << std::endl;
LOG_DEBUG(ss.str().c_str());
LOG_DEBUG( "DFU_GETSTATUS called, state is: " << dfu_state << ", iString equals: " << percentage_of_transfer
<< ", and bwPollTimeOut equals: " << status.bwPollTimeout );

if (update_progress_callback)
{
Expand Down
97 changes: 50 additions & 47 deletions src/fw-update/fw-update-device.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#include "ds/d400/d400-private.h"

#include <rsutils/string/hexdump.h>
#include <rsutils/time/stopwatch.h>

#include <chrono>
#include <stdexcept>
Expand Down Expand Up @@ -58,12 +59,20 @@ namespace librealsense
LOG_WARNING("DFU - failed to detach device");
}

void update_device::read_device_info(std::shared_ptr<platform::usb_messenger> messenger)
void update_device::read_device_info( std::shared_ptr< platform::usb_messenger > messenger )
{
auto state = get_dfu_state(messenger);

if (state != RS2_DFU_STATE_DFU_IDLE)
throw std::runtime_error("DFU detach failed!");
auto state = get_dfu_state( messenger );
if( state != RS2_DFU_STATE_DFU_IDLE )
{
LOG_DEBUG( "DFU state is: " << state << "; detaching..." );
detach( messenger );
state = get_dfu_state( messenger );
if( state != RS2_DFU_STATE_DFU_IDLE )
{
LOG_ERROR( "DFU detach failed!" << "; state is " << state );
throw std::runtime_error( "DFU detach failed!" );
}
}

dfu_fw_status_payload payload;
uint32_t transferred = 0;
Expand All @@ -77,40 +86,32 @@ namespace librealsense
_highest_fw_version = get_formatted_fw_version(payload.fw_highest_version);
_last_fw_version = get_formatted_fw_version(payload.fw_last_version);

std::string lock_status = _is_dfu_locked ? "device is locked" : "device is unlocked";
LOG_INFO("This device is in DFU mode, previously-installed firmware: " << _last_fw_version <<
", the highest firmware ever installed: " << _highest_fw_version);

LOG_INFO("DFU status: " << lock_status << " , DFU version is: " << payload.dfu_version);
LOG_INFO( "DFU payload for " << get_device_info()->get_address() << ":"
<< "\n\tSerial number: "
<< rsutils::string::hexdump( payload.serial_number.serial, sizeof( payload.serial_number.serial ) )
<< "\n\tDevice is " << ( _is_dfu_locked ? "locked" : "unlocked" )
<< "\n\tDFU version is: " << payload.dfu_version
<< "\n\tPrevious version: " << _last_fw_version
<< "\n\tHighest ever installed: " << _highest_fw_version );
}

std::string update_device::to_string(rs2_dfu_state state) const
std::ostream & operator<<( std::ostream & os, rs2_dfu_state state )
{
switch (state)
switch( state )
{
case(RS2_DFU_STATE_APP_IDLE):
return "APP_IDLE";
case(RS2_DFU_STATE_APP_DETACH):
return "APP_DETACH";
case(RS2_DFU_STATE_DFU_DOWNLOAD_SYNC):
return "DFU_DOWNLOAD_SYNC";
case(RS2_DFU_STATE_DFU_DOWNLOAD_BUSY):
return "DFU_DOWNLOAD_BUSY";
case(RS2_DFU_STATE_DFU_DOWNLOAD_IDLE):
return "DFU_DOWNLOAD_IDLE";
case(RS2_DFU_STATE_DFU_MANIFEST_SYNC):
return "DFU_MANIFEST_SYNC";
case(RS2_DFU_STATE_DFU_MANIFEST):
return "DFU_MANIFEST";
case(RS2_DFU_STATE_DFU_MANIFEST_WAIT_RESET):
return "DFU_MANIFEST_WAIT_RESET";
case(RS2_DFU_STATE_DFU_UPLOAD_IDLE):
return "DFU_UPLOAD_IDLE";
case(RS2_DFU_STATE_DFU_ERROR):
return "DFU_ERROR";
default:
return "DFU_STATE_???";
case RS2_DFU_STATE_DFU_IDLE: return os << "IDLE";
case RS2_DFU_STATE_DFU_ERROR: return os << "ERROR";
case RS2_DFU_STATE_APP_IDLE: return os << "APP_IDLE";
case RS2_DFU_STATE_APP_DETACH: return os << "APP_DETACH";
case RS2_DFU_STATE_DFU_DOWNLOAD_SYNC: return os << "DFU_DOWNLOAD_SYNC";
case RS2_DFU_STATE_DFU_DOWNLOAD_BUSY: return os << "DFU_DOWNLOAD_BUSY";
case RS2_DFU_STATE_DFU_DOWNLOAD_IDLE: return os << "DFU_DOWNLOAD_IDLE";
case RS2_DFU_STATE_DFU_MANIFEST_SYNC: return os << "DFU_MANIFEST_SYNC";
case RS2_DFU_STATE_DFU_MANIFEST: return os << "DFU_MANIFEST";
case RS2_DFU_STATE_DFU_MANIFEST_WAIT_RESET: return os << "DFU_MANIFEST_WAIT_RESET";
case RS2_DFU_STATE_DFU_UPLOAD_IDLE: return os << "DFU_UPLOAD_IDLE";
}
return os << (int)state;
}

bool update_device::wait_for_state(std::shared_ptr<platform::usb_messenger> messenger, const rs2_dfu_state state, size_t timeout) const
Expand Down Expand Up @@ -162,20 +163,15 @@ namespace librealsense
{
if (auto messenger = _usb_device->open(FW_UPDATE_INTERFACE_NUMBER))
{
auto state = get_dfu_state(messenger);
LOG_DEBUG("DFU state is: " << state);
if (state != RS2_DFU_STATE_DFU_IDLE)
detach(messenger);

read_device_info(messenger);
read_device_info( messenger );
}
else
{
std::stringstream s;
std::ostringstream s;
s << "access failed for " << std::hex << _usb_device->get_info().vid << ":"
<<_usb_device->get_info().pid << " uid: " << _usb_device->get_info().id << std::dec;
LOG_ERROR(s.str().c_str());
throw std::runtime_error(s.str().c_str());
LOG_ERROR( s.str() );
throw std::runtime_error( s.str() );
}
}

Expand Down Expand Up @@ -221,6 +217,7 @@ namespace librealsense
size_t offset = 0;
uint32_t transferred = 0;
int retries = 10;
rsutils::time::stopwatch sw;

while (remaining_bytes > 0)
{
Expand Down Expand Up @@ -251,11 +248,17 @@ namespace librealsense
offset += chunk_size;

float progress = (float)block_number / (float)blocks_count;
LOG_DEBUG("fw update progress: " << progress);
if (update_progress_callback)
if( sw.get_elapsed_ms() >= 500. )
{
auto progress_for_bar = compute_progress(progress, 0.f, 20.f, 5.f) / 100.f;
update_progress_callback->on_update_progress(progress_for_bar);
// Only update every half-second to avoid spurious callbacks
// (we can get here many many times in a split second)
LOG_DEBUG( "fw update progress: " << progress );
if( update_progress_callback )
{
auto progress_for_bar = compute_progress( progress, 0.f, 20.f, 5.f ) / 100.f;
update_progress_callback->on_update_progress( progress_for_bar );
}
sw.reset();
}
}

Expand Down
4 changes: 3 additions & 1 deletion src/fw-update/fw-update-device.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#include "fw-update-device-interface.h"
#include "usb/usb-device.h"
#include "platform/mipi-device.h"
#include <iosfwd>

namespace librealsense
{
Expand Down Expand Up @@ -42,6 +43,8 @@ namespace librealsense
RS2_DFU_STATE_DFU_ERROR = 10
} rs2_dfu_state;

std::ostream & operator<<( std::ostream &, rs2_dfu_state );

typedef enum rs2_dfu_command {
RS2_DFU_DETACH = 0,
RS2_DFU_DOWNLOAD = 1,
Expand Down Expand Up @@ -161,7 +164,6 @@ namespace librealsense
const std::string & get_product_line() const { return _product_line; }
const std::string & get_serial_number() const { return _serial_number; }
std::string to_string(platform::usb_status state) const;
std::string to_string(rs2_dfu_state state) const;
virtual float compute_progress(float progress, float start, float end, float threshold) const;

const int DEFAULT_TIMEOUT = 100;
Expand Down

0 comments on commit 22f2345

Please sign in to comment.