Skip to content

Convert htool cmds to new error formatting #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
esnguyen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Convert htool cmds to new error formatting #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions examples/htool.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,11 +571,17 @@ static int command_console(const struct htool_invocation* inv) {
return -1;
}

libhoth_error err = HOTH_SUCCESS;
if (opts.snapshot) {
return htool_console_snapshot(dev, &opts);
err = htool_console_snapshot(dev, &opts);
} else {
return htool_console_run(dev, &opts);
err = htool_console_run(dev, &opts);
}
if (err != HOTH_SUCCESS) {
htool_report_error("console", err);
return -1;
}
return 0;
}

static int command_flash_spi_info(const struct htool_invocation* inv) {
Expand Down
72 changes: 39 additions & 33 deletions examples/htool_console.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,27 @@ void restore_terminal(int fd, const struct termios* old_termios) {
tcsetattr(fd, TCSANOW, old_termios);
}

int htool_console_run(struct libhoth_device* dev,
const struct libhoth_htool_console_opts* opts) {
libhoth_error htool_console_run(struct libhoth_device* dev,
const struct libhoth_htool_console_opts* opts) {
printf("%sStarting Interactive Console\n", kAnsiRed);

struct hoth_channel_uart_config uart_config = {};
int status = libhoth_get_uart_config(dev, opts, &uart_config);
if (status == LIBHOTH_OK) {
libhoth_error status = libhoth_get_uart_config(dev, opts, &uart_config);
if (status == HOTH_SUCCESS) {
if (opts->baud_rate != 0) {
uart_config.baud_rate = opts->baud_rate;
status = libhoth_set_uart_config(dev, opts, &uart_config);
if (status != LIBHOTH_OK) {
fprintf(
stderr,
"libhoth_set_uart_config() failed: %d; unable to set baud-rate\n",
status);
if (status != HOTH_SUCCESS) {
fprintf(stderr,
"libhoth_set_uart_config() failed: 0x%016llx; unable to set "
"baud-rate\n",
(unsigned long long)status);
return status;
}
status = libhoth_get_uart_config(dev, opts, &uart_config);
}
}
if (status == LIBHOTH_OK) {
if (status == HOTH_SUCCESS) {
printf("Using baud-rate %d\n", uart_config.baud_rate);
}
printf("[ Use Ctrl+T-Q to quit ]%s\n", kAnsiReset);
Expand All @@ -90,8 +90,9 @@ int htool_console_run(struct libhoth_device* dev,
// will be stored at this offset)
uint32_t offset;
status = libhoth_get_channel_status(dev, opts, &offset);
if (status != LIBHOTH_OK) {
fprintf(stderr, "libhoth_get_channel_status() failed: %d\n", status);
if (status != HOTH_SUCCESS) {
fprintf(stderr, "libhoth_get_channel_status() failed: 0x%016llx\n",
(unsigned long long)status);
return status;
}

Expand All @@ -106,15 +107,15 @@ int htool_console_run(struct libhoth_device* dev,

while (!quit) {
// Any previous failure should reset all of the USB state before retrying
while (status != LIBHOTH_OK) {
while (status != HOTH_SUCCESS) {
// TODO: Read STDIN during this time and buffer it so we can capture
// quit events even when the console is disconnected. We will also want
// to tune the reconnect time to match.
if (libhoth_device_reconnect(dev) != HOTH_SUCCESS) {
// Make sure we don't end up in a tight retry loop
usleep(100 * 1000);
} else {
status = LIBHOTH_OK;
status = HOTH_SUCCESS;
}
}
// Give an opportunity for other clients to use the interface.
Expand All @@ -123,20 +124,21 @@ int htool_console_run(struct libhoth_device* dev,
if (libhoth_claim_device(dev, 1000 * 1000 * opts->claim_timeout_secs) !=
HOTH_SUCCESS) {
// If USB is down we might fail claim, just go back and retry
status = LIBHOTH_ERR_FAIL;
status = LIBHOTH_ERR_CONSTRUCT(HOTH_CTX_CMD_EXEC, HOTH_HOST_SPACE_LIBHOTH,
LIBHOTH_ERR_FAIL);
continue;
}

status = libhoth_read_console(dev, STDOUT_FILENO, false, opts->channel_id,
&offset);
if (status != LIBHOTH_OK) {
if (status != HOTH_SUCCESS) {
// Device resets cause failures, just loop and allow reconnection
continue;
}

status = libhoth_write_console(dev, opts->channel_id, opts->force_drive_tx,
&quit);
if (status != LIBHOTH_OK) {
if (status != HOTH_SUCCESS) {
// Device resets cause failures, just loop and allow reconnection
continue;
}
Expand All @@ -147,12 +149,14 @@ int htool_console_run(struct libhoth_device* dev,
return status;
}

int htool_console_snapshot_legacy(struct libhoth_device* dev) {
libhoth_error htool_console_snapshot_legacy(struct libhoth_device* dev) {
size_t response_bytes_written;
int status = libhoth_hostcmd_exec(dev, HOTH_CMD_CONSOLE_REQUEST, 0, NULL, 0,
NULL, 0, &response_bytes_written);
if (status != LIBHOTH_OK) {
fprintf(stderr, "HOTH_CMD_CONSOLE_REQUEST status: %d\n", status);
libhoth_error status =
libhoth_hostcmd_exec_v2(dev, HOTH_CMD_CONSOLE_REQUEST, 0, NULL, 0, NULL,
0, &response_bytes_written);
if (status != HOTH_SUCCESS) {
fprintf(stderr, "HOTH_CMD_CONSOLE_REQUEST status: 0x%016llx\n",
(unsigned long long)status);
return status;
}

Expand All @@ -162,11 +166,12 @@ int htool_console_snapshot_legacy(struct libhoth_device* dev) {
MAILBOX_SIZE - sizeof(struct hoth_host_response);
while (true) {
char buf[MAILBOX_SIZE];
status = libhoth_hostcmd_exec(dev, HOTH_CMD_CONSOLE_READ, 0, &read_request,
sizeof(read_request), buf, max_bytes_per_read,
&response_bytes_written);
if (status != LIBHOTH_OK) {
fprintf(stderr, "HOTH_CMD_CONSOLE_READ status: %d\n", status);
status = libhoth_hostcmd_exec_v2(
dev, HOTH_CMD_CONSOLE_READ, 0, &read_request, sizeof(read_request), buf,
max_bytes_per_read, &response_bytes_written);
if (status != HOTH_SUCCESS) {
fprintf(stderr, "HOTH_CMD_CONSOLE_READ status: 0x%016llx\n",
(unsigned long long)status);
return status;
}
fwrite(buf, strnlen(buf, sizeof(buf)), 1, stdout);
Expand All @@ -176,8 +181,8 @@ int htool_console_snapshot_legacy(struct libhoth_device* dev) {
return status;
}

int htool_console_snapshot(struct libhoth_device* dev,
const struct libhoth_htool_console_opts* opts) {
libhoth_error htool_console_snapshot(
struct libhoth_device* dev, const struct libhoth_htool_console_opts* opts) {
// Legacy host commands for console snapshot.
if (!opts->channel_id) {
return htool_console_snapshot_legacy(dev);
Expand All @@ -186,17 +191,18 @@ int htool_console_snapshot(struct libhoth_device* dev,
// Starting from current_offset - 0x80000000 so it's guaranteed to be outside
// of the Hoth buffer. Repeat read until reaching current offset.
uint32_t current_offset;
int status = libhoth_get_channel_status(dev, opts, &current_offset);
if (status != LIBHOTH_OK) {
fprintf(stderr, "libhoth_get_channel_status) failed: %d\n", status);
libhoth_error status = libhoth_get_channel_status(dev, opts, &current_offset);
if (status != HOTH_SUCCESS) {
fprintf(stderr, "libhoth_get_channel_status failed: 0x%016llx\n",
(unsigned long long)status);
return status;
}
uint32_t offset = current_offset - 0x80000000;

while (true) {
status = libhoth_read_console(dev, STDOUT_FILENO, false, opts->channel_id,
&offset);
if (status != LIBHOTH_OK) {
if (status != HOTH_SUCCESS) {
break;
}
// Extra check in case UINT32_MAX wrap-around.
Expand Down
8 changes: 4 additions & 4 deletions examples/htool_console.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ extern "C" {

struct libhoth_device;

int htool_console_run(struct libhoth_device* dev,
const struct libhoth_htool_console_opts* opts);
libhoth_error htool_console_run(struct libhoth_device* dev,
const struct libhoth_htool_console_opts* opts);

int htool_console_snapshot(struct libhoth_device* dev,
const struct libhoth_htool_console_opts* opts);
libhoth_error htool_console_snapshot(
struct libhoth_device* dev, const struct libhoth_htool_console_opts* opts);

#ifdef __cplusplus
}
Expand Down
15 changes: 15 additions & 0 deletions protocol/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,11 +542,26 @@ cc_library(
hdrs = ["console.h"],
deps = [
":host_cmd",
":libhoth_status",
":util",
"//transports:libhoth_device",
],
)

cc_test(
name = "console_test",
srcs = ["console_test.cc"],
deps = [
":console",
":host_cmd",
":libhoth_status",
"//protocol/test:libhoth_device_mock",
"//transports:libhoth_device",
"@googletest//:gtest",
"@googletest//:gtest_main",
],
)

cc_library(
name = "dfu_hostcmd",
srcs = ["dfu_hostcmd.c"],
Expand Down
Loading
Loading