Skip to content

Commit

Permalink
Upload port detector improvements (#2288)
Browse files Browse the repository at this point in the history
* If the upload port-detector fails detection, fallback to the user-provided port

This will ensure that a port is always returned.

* Increased debug level

* Extend timeout if candidate port is lost in any case

Even if `waitForUploadPort` is true, we should extend the timeout to
allow USB enumeration to complete. In this case we extend by only 1
second instead of 5.

* Revert "Extend timeout if candidate port is lost in any case"

This reverts commit 7c77ed2.

The latest commit is not necessary since the detector has already 5 seconds of timeout.
  • Loading branch information
cmaglie authored Aug 31, 2023
1 parent 304d48c commit 048415c
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions commands/upload/upload.go
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,8 @@ func runProgramAction(pme *packagemanager.Explorer,

updatedPort := updatedUploadPort.Await()
if updatedPort == nil {
return nil, nil
// If the algorithms can not detect the new port, fallback to the user-provided port.
return userPort, nil
}
return updatedPort.ToRPC(), nil
}
Expand All @@ -526,7 +527,7 @@ func detectUploadPort(
result f.Future[*discovery.Port],
) {
log := logrus.WithField("task", "port_detection")
log.Tracef("Detecting new board port after upload")
log.Debugf("Detecting new board port after upload")

candidate := uploadPort.Clone()
defer func() {
Expand All @@ -542,11 +543,11 @@ func detectUploadPort(
return
}
if candidate != nil && ev.Type == "remove" && ev.Port.Equals(candidate) {
log.WithField("event", ev).Trace("User-specified port has been disconnected, forcing wait for upload port")
log.WithField("event", ev).Debug("User-specified port has been disconnected, forcing wait for upload port")
waitForUploadPort = true
candidate = nil
} else {
log.WithField("event", ev).Trace("Ignored watcher event before upload")
log.WithField("event", ev).Debug("Ignored watcher event before upload")
}
continue
case <-uploadCtx.Done():
Expand All @@ -568,17 +569,17 @@ func detectUploadPort(
return
}
if candidate != nil && ev.Type == "remove" && candidate.Equals(ev.Port) {
log.WithField("event", ev).Trace("Candidate port is no longer available")
log.WithField("event", ev).Debug("Candidate port is no longer available")
candidate = nil
if !waitForUploadPort {
waitForUploadPort = true
timeout = time.After(5 * time.Second)
log.Trace("User-specified port has been disconnected, now waiting for upload port, timeout extended by 5 seconds")
log.Debug("User-specified port has been disconnected, now waiting for upload port, timeout extended by 5 seconds")
}
continue
}
if ev.Type != "add" {
log.WithField("event", ev).Trace("Ignored non-add event")
log.WithField("event", ev).Debug("Ignored non-add event")
continue
}

Expand All @@ -601,21 +602,21 @@ func detectUploadPort(
evPortPriority := portPriority(ev.Port)
candidatePriority := portPriority(candidate)
if evPortPriority <= candidatePriority {
log.WithField("event", ev).Tracef("New upload port candidate is worse than the current one (prio=%d)", evPortPriority)
log.WithField("event", ev).Debugf("New upload port candidate is worse than the current one (prio=%d)", evPortPriority)
continue
}
log.WithField("event", ev).Tracef("Found new upload port candidate (prio=%d)", evPortPriority)
log.WithField("event", ev).Debugf("Found new upload port candidate (prio=%d)", evPortPriority)
candidate = ev.Port

// If the current candidate have the desired HW-ID return it quickly.
if candidate.HardwareID == ev.Port.HardwareID {
timeout = time.After(time.Second)
log.Trace("New candidate port match the desired HW ID, timeout reduced to 1 second.")
log.Debug("New candidate port match the desired HW ID, timeout reduced to 1 second.")
continue
}

case <-timeout:
log.WithField("selected_port", candidate).Trace("Timeout waiting for candidate port")
log.WithField("selected_port", candidate).Debug("Timeout waiting for candidate port")
return
}
}
Expand Down

0 comments on commit 048415c

Please sign in to comment.