gitproxy/RTLPlayground
1
0 Fork 0
mirror of https://github.com/logicog/RTLPlayground.git synced 2026-10-29 17:54:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #463 from DrDoof/fix/cmd-error-status

Browse Source 
cmd: report a rejected command as an error and keep it out of the history
This commit is contained in:
René van Dorst authored and GitHub committed 2026-09-17 17:33:56 +00:00
2 parents c02623a610 bece4a20a1
commit bf41fbd202
5 files changed
+73 -54
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

cmd_parser.c
+62 -47
View File
@@ -426,6 +426,14 @@ err:
return 0; return 0;
} }
static void cmd_error(__code const char *msg)
{
err_status = ERR_INVALID_ARGUMENT;
print_string("Error: ");
print_string(msg);
}
// Sets the management MAC from a "mac <aa:bb:cc:dd:ee:ff>" command (or prints // Sets the management MAC from a "mac <aa:bb:cc:dd:ee:ff>" command (or prints
// the current one with a bare "mac"). Refuses blank/multicast/locally // the current one with a bare "mac"). Refuses blank/multicast/locally
// administered/all-zero-OUI addresses so the running MAC stays reachable, and // administered/all-zero-OUI addresses so the running MAC stays reachable, and
@@ -441,11 +449,11 @@ void parse_mac_cmd(void)
return; return;
} }
if (cmd_words_len != 2 || !parse_mac(cmd_words_b[1])) { if (cmd_words_len != 2 || !parse_mac(cmd_words_b[1])) {
print_string("Error: mac [<aa:bb:cc:dd:ee:ff>]\n"); cmd_error("mac [<aa:bb:cc:dd:ee:ff>]\n");
return; return;
} }
if ((mac_parse_result[0] & 0x03) || ((mac_parse_result[0] | mac_parse_result[1] | mac_parse_result[2]) == 0)) { if ((mac_parse_result[0] & 0x03) || ((mac_parse_result[0] | mac_parse_result[1] | mac_parse_result[2]) == 0)) {
print_string("refusing: must be unicast, globally administered\n"); cmd_error("the MAC must be unicast and globally administered\n");
return; return;
} }
if (memcmp(mac_parse_result, uip_ethaddr.addr, 6) == 0) { if (memcmp(mac_parse_result, uip_ethaddr.addr, 6) == 0) {
@@ -523,7 +531,7 @@ void parse_lag(void)
port_lag_members_set(group, members); port_lag_members_set(group, members);
return; return;
err: err:
print_string("Error: lag (show | <1-4> (d | <port>...))\n"); cmd_error("lag (show | <1-4> (d | <port>...))\n");
} }
@@ -565,7 +573,7 @@ void parse_lag_hash(void)
port_lag_hash_set(group, hash); port_lag_hash_set(group, hash);
return; return;
err: err:
print_string("Error: laghash <1-4> [smac|dmac|sip|dip|sport|dport]\n"); cmd_error("laghash <1-4> [smac|dmac|sip|dip|sport|dport]\n");
} }
@@ -663,7 +671,7 @@ void parse_vlan(void)
} }
return; return;
err: err:
print_string("Error: vlan (<vlan-id>|show) [port][t]...\n"); cmd_error("vlan (<vlan-id>|show) [port][t]...\n");
} }
@@ -714,7 +722,7 @@ void parse_isolate(void)
return; return;
err: err:
print_string("Error: isolate <port> [show|off] [port]...\n"); cmd_error("isolate <port> [show|off] [port]...\n");
} }
@@ -751,7 +759,7 @@ void parse_ingress(void)
// Setting mode for all ports at once // Setting mode for all ports at once
for (log_port = machine.min_port; log_port <= machine.max_port; log_port++) { for (log_port = machine.min_port; log_port <= machine.max_port; log_port++) {
if (!port_ingress_filter(log_port, mode)) { if (!port_ingress_filter(log_port, mode)) {
print_string("Error setting ingress filter for port "); print_phys_port(log_port); write_char('\n'); cmd_error("cannot set the ingress filter for port "); print_phys_port(log_port); write_char('\n');
return; return;
} }
print_string("All ports ingress filter set to: "); print_string("All ports ingress filter set to: ");
@@ -762,18 +770,18 @@ void parse_ingress(void)
idx = cmd_words_b[w]; idx = cmd_words_b[w];
uint8_t ret = cmd_parse_port(idx); uint8_t ret = cmd_parse_port(idx);
if (ret != 1) { if (ret != 1) {
print_string("Invalid physical port number\n"); cmd_error("Invalid physical port number\n");
continue; continue;
} }
log_port = atoi_results_u8; log_port = atoi_results_u8;
idx += ret; idx += ret;
if (!vlan_ingress_mode_parse(cmd_buffer[idx++], &mode) || !cmd_is_space_or_nul(idx)) { if (!vlan_ingress_mode_parse(cmd_buffer[idx++], &mode) || !cmd_is_space_or_nul(idx)) {
print_string("Invalid ingress mode for port "); print_phys_port(log_port); print_string(" in ingress command\n"); cmd_error("Invalid ingress mode for port "); print_phys_port(log_port); print_string(" in ingress command\n");
goto err; goto err;
} }
if (!port_ingress_filter(log_port, mode)) { if (!port_ingress_filter(log_port, mode)) {
print_string("Error setting ingress filter for port "); print_phys_port(log_port); write_char('\n'); cmd_error("cannot set the ingress filter for port "); print_phys_port(log_port); write_char('\n');
return; return;
} }
print_string("Port "); print_phys_port(log_port); print_string("Port "); print_phys_port(log_port);
@@ -783,7 +791,7 @@ void parse_ingress(void)
} }
return; return;
err: err:
print_string("Error: ingress [p]<u/t/a>...\n"); cmd_error("ingress [p]<u/t/a>...\n");
} }
void parse_mirror(void) void parse_mirror(void)
@@ -848,7 +856,7 @@ void parse_mirror(void)
return; return;
err: err:
print_string("Port/command missing: mirror [status/off/<mirroring port> [port][t/r]]...\n"); cmd_error("Port/command missing: mirror [status/off/<mirroring port> [port][t/r]]...\n");
return; return;
} }
@@ -856,7 +864,7 @@ err:
void parse_port(void) void parse_port(void)
{ {
if (cmd_words_len < 3) { if (cmd_words_len < 3) {
print_string("\nUsage:" \ cmd_error("\nUsage:" \
"\nport <port> [show|on|off]" \ "\nport <port> [show|on|off]" \
"\nport <port> [10m|100m|1g|2g5|duplex] [half|full]" \ "\nport <port> [10m|100m|1g|2g5|duplex] [half|full]" \
"\nport <port> name [custom port name]\n"); "\nport <port> name [custom port name]\n");
@@ -864,7 +872,7 @@ void parse_port(void)
} }
if (cmd_parse_port_separator(cmd_words_b[1]) == 0) { if (cmd_parse_port_separator(cmd_words_b[1]) == 0) {
print_string("Invalid port number\n"); cmd_error("Invalid port number\n");
return; return;
} }
phy_settings.port = atoi_results_u8; phy_settings.port = atoi_results_u8;
@@ -942,7 +950,7 @@ void parse_port(void)
phy_settings.duplex = PHY_DUPLEX_HALF; phy_settings.duplex = PHY_DUPLEX_HALF;
phy_set_duplex(); phy_set_duplex();
} else { } else {
print_string("Unknown port command\n"); cmd_error("Unknown port command\n");
} }
} }
@@ -970,7 +978,7 @@ void parse_mtu(void)
print_byte(p); print_byte(p);
if (atoi_short(cmd_words_b[2]) == 0 || atoi_results_short < 64 || atoi_results_short > 0x3fff) { if (atoi_short(cmd_words_b[2]) == 0 || atoi_results_short < 64 || atoi_results_short > 0x3fff) {
print_string("MTU must be 64..16383\n"); cmd_error("MTU must be 64..16383\n");
return; return;
} }
REG_WRITE(RTL8373_REG_MAC_L2_PORT_MAX_LEN + ((uint16_t) p << 8), (atoi_results_short >> 10) & 0xf, (atoi_results_short >> 2) & 0xff, REG_WRITE(RTL8373_REG_MAC_L2_PORT_MAX_LEN + ((uint16_t) p << 8), (atoi_results_short >> 10) & 0xf, (atoi_results_short >> 2) & 0xff,
@@ -979,7 +987,7 @@ void parse_mtu(void)
return; return;
err: err:
print_string("mtu [port] [size]\n"); cmd_error("mtu [port] [size]\n");
return; return;
} }
@@ -1036,11 +1044,11 @@ void parse_sfp(void)
idx += ret; idx += ret;
slot = atoi_results_u8 - 1; slot = atoi_results_u8 - 1;
if (ret == 0 || !cmd_is_space(idx) || slot > 1) { if (ret == 0 || !cmd_is_space(idx) || slot > 1) {
print_string("Illegal SFP slot number\n"); cmd_error("Illegal SFP slot number\n");
return; return;
} }
if (slot >= machine.n_sfp) { if (slot >= machine.n_sfp) {
print_string("SFP slot not present\n"); cmd_error("SFP slot not present\n");
return; return;
} }
@@ -1066,7 +1074,7 @@ void parse_sfp(void)
handle_sfp(); handle_sfp();
return; return;
err: err:
print_string("\nUsage:\n\tsfp\n\tsfp [1|2] [1g|2g5|10g]\n"); cmd_error("\nUsage:\n\tsfp\n\tsfp [1|2] [1g|2g5|10g]\n");
} }
@@ -1098,7 +1106,7 @@ void parse_regget(void)
return; return;
err: err:
print_string("usage: regget <hexvalue>\n\tlike: regget 0BB0 or regget 0c"); cmd_error("regget <hexvalue>\n\tlike: regget 0BB0 or regget 0c");
return; return;
} }
@@ -1145,7 +1153,7 @@ void parse_regset(void)
return; return;
err: err:
print_string("usage: regset <hexvalue> <hexvalue>\n\tlike regset 0b abcd1234."); cmd_error("regset <hexvalue> <hexvalue>\n\tlike regset 0b abcd1234.");
} }
@@ -1188,7 +1196,7 @@ void parse_sdsget(void)
return; return;
err: err:
print_string("usage: sdsget <sds-id> <hex:page> <hex:reg>\n"); cmd_error("sdsget <sds-id> <hex:page> <hex:reg>\n");
return; return;
} }
@@ -1244,7 +1252,7 @@ void parse_sdsset(void)
return; return;
err: err:
print_string("usage: sdsset <sds-id> <hex:page> <hex:reg> <hex:val>\n"); cmd_error("sdsset <sds-id> <hex:page> <hex:reg> <hex:val>\n");
return; return;
} }
@@ -1293,7 +1301,7 @@ void parse_phyget(void)
return; return;
err: err:
print_string("usage: phyget <phy-id> <dev-id> <hex:reg>\n"); cmd_error("phyget <phy-id> <dev-id> <hex:reg>\n");
return; return;
} }
@@ -1353,7 +1361,7 @@ void parse_physet(void)
return; return;
err: err:
print_string("usage: physet <phy-id> <dev-id> <hex:reg> <hex:val>\n"); cmd_error("physet <phy-id> <dev-id> <hex:reg> <hex:val>\n");
return; return;
} }
@@ -1388,7 +1396,7 @@ void parse_passwd(void)
passwd[j] = NUL; passwd[j] = NUL;
return; return;
} }
print_string("Missing password\n"); cmd_error("Missing password\n");
} }
@@ -1412,7 +1420,7 @@ void parse_eee(void)
} else if (cmd_is_space_or_nul(idx)) { } else if (cmd_is_space_or_nul(idx)) {
// Word 2 is a port number // Word 2 is a port number
if (cmd_parse_port_separator(idx) == 0) { if (cmd_parse_port_separator(idx) == 0) {
print_string("Speed word invalid, use: [100m|1g|2g5]\n"); cmd_error("Speed word invalid, use: [100m|1g|2g5]\n");
return; return;
} }
port = atoi_results_u8; port = atoi_results_u8;
@@ -1431,7 +1439,7 @@ void parse_eee(void)
speed = EEE_2G5; speed = EEE_2G5;
else else
{ {
print_string("Speed word invalid, use: [100m|1g|2g5]\n"); cmd_error("Speed word invalid, use: [100m|1g|2g5]\n");
return; return;
} }
} }
@@ -1451,7 +1459,7 @@ void parse_eee(void)
else else
port_eee_status_all(); port_eee_status_all();
} else { } else {
print_string("eee [on|off|status] [port] [100m|1g|2g5]\n"); cmd_error("eee [on|off|status] [port] [100m|1g|2g5]\n");
} }
} }
@@ -1522,7 +1530,7 @@ void parse_bw(void)
return; return;
err: err:
print_string("usage: bw [in|out|status] <port> [<hexvalue>|off|drop|fc]\n"); cmd_error("bw [in|out|status] <port> [<hexvalue>|off|drop|fc]\n");
} }
void parse_syslog(void) void parse_syslog(void)
@@ -1560,7 +1568,7 @@ void parse_syslog(void)
if (was_enabled) if (was_enabled)
syslog_start(); syslog_start();
} else { } else {
print_string("Invalid IP address\n"); cmd_error("Invalid IP address\n");
} }
} else if (cmd_compare(1, "port")) { } else if (cmd_compare(1, "port")) {
if (cmd_words_len < 3) { // no additional argument -> print current port if (cmd_words_len < 3) { // no additional argument -> print current port
@@ -1571,7 +1579,7 @@ void parse_syslog(void)
/* atoi_short() returns zero for no digits and for a value past /* atoi_short() returns zero for no digits and for a value past
* 65535; port zero is not a port either, so both tests are needed. */ * 65535; port zero is not a port either, so both tests are needed. */
if (!atoi_short(cmd_words_b[2]) || !atoi_results_short) { if (!atoi_short(cmd_words_b[2]) || !atoi_results_short) {
print_string("Invalid port\n"); cmd_error("Invalid port\n");
return; return;
} }
/* The port is frozen into the connection by uip_udp_new(), so /* The port is frozen into the connection by uip_udp_new(), so
@@ -1587,9 +1595,9 @@ void parse_syslog(void)
} }
else else
{ {
print_string("Error: syslog [on|off|ip [ip-address]|port [number]]\n"); cmd_error("syslog [on|off|ip [ip-address]|port [number]]\n"
print_string(" on/off enables or disables syslog, ip sets the syslog server IP address,\n"); " on/off enables or disables syslog, ip sets the syslog server IP address,\n"
print_string(" port sets the destination UDP port (default 514)\n"); " port sets the destination UDP port (default 514)\n");
} }
} }
@@ -1757,7 +1765,7 @@ void cmd_parser(void) __banked
print_string("Setting ip: "); print_string("Setting ip: ");
print_ip(ip); write_char('\n'); print_ip(ip); write_char('\n');
} else { } else {
print_string("Invalid IP address\n" \ cmd_error("Invalid IP address\n" \
"Error: ip [<ip-address>|dhcp]\n" \ "Error: ip [<ip-address>|dhcp]\n" \
" The dhcp option enables the dhcp client, calling ip without options prints the current IP\n" \ " The dhcp option enables the dhcp client, calling ip without options prints the current IP\n" \
" Calling with a valid IP address will stop any ongoing dhcp client and set the IP address\n"); " Calling with a valid IP address will stop any ongoing dhcp client and set the IP address\n");
@@ -1773,7 +1781,7 @@ void cmd_parser(void) __banked
print_string("Setting gw: "); print_string("Setting gw: ");
print_ip(ip); write_char('\n'); print_ip(ip); write_char('\n');
} else { } else {
print_string("Invalid IP address\n" \ cmd_error("Invalid IP address\n" \
"Error: gw <ip-address>\n"); "Error: gw <ip-address>\n");
} }
} }
@@ -1787,7 +1795,7 @@ void cmd_parser(void) __banked
print_string("Setting netmask: "); print_string("Setting netmask: ");
print_ip(ip); write_char('\n'); print_ip(ip); write_char('\n');
} else { } else {
print_string("Invalid IP address\n"); cmd_error("Invalid IP address\n");
} }
} }
write_char('\n'); write_char('\n');
@@ -1803,8 +1811,9 @@ void cmd_parser(void) __banked
igmp_setup(); igmp_setup();
else if (cmd_compare(1, "show")) else if (cmd_compare(1, "show"))
igmp_show(); igmp_show();
else else {
print_string("Error: igmp on|off|show\n"); cmd_error("igmp on|off|show\n");
}
} else if (cmd_compare(0, "mac")) { } else if (cmd_compare(0, "mac")) {
parse_mac_cmd(); parse_mac_cmd();
} else if (cmd_compare(0, "hostname")) { } else if (cmd_compare(0, "hostname")) {
@@ -1828,7 +1837,7 @@ void cmd_parser(void) __banked
} }
*dst = NUL; *dst = NUL;
} else { } else {
print_string("Error: hostname [name] - the name must not contain spaces\n"); cmd_error("hostname [name] - the name must not contain spaces\n");
} }
} else if (cmd_compare(0, "stp")) { } else if (cmd_compare(0, "stp")) {
stp_parse(); stp_parse();
@@ -1836,8 +1845,9 @@ void cmd_parser(void) __banked
if (cmd_words_len == 3 && cmd_parse_port_separator(cmd_words_b[1]) != 0 if (cmd_words_len == 3 && cmd_parse_port_separator(cmd_words_b[1]) != 0
&& atoi_short(cmd_words_b[2]) && atoi_results_short && atoi_results_short <= 4094) && atoi_short(cmd_words_b[2]) && atoi_results_short && atoi_results_short <= 4094)
port_pvid_set(atoi_results_u8, atoi_results_short); port_pvid_set(atoi_results_u8, atoi_results_short);
else else {
print_string("Error: pvid <port> <1-4094>\n"); cmd_error("pvid <port> <1-4094>\n");
}
} else if (cmd_compare(0, "vlan")) { } else if (cmd_compare(0, "vlan")) {
parse_vlan(); parse_vlan();
} else if (cmd_compare(0, "isolate")) { } else if (cmd_compare(0, "isolate")) {
@@ -1897,11 +1907,11 @@ void cmd_parser(void) __banked
parse_ingress(); parse_ingress();
} }
else { else {
print_string("Unknown command\n"); cmd_error("Unknown command\n");
} }
if (save_cmd && cmd_words_len) { if (save_cmd && cmd_words_len && err_status == ERR_OK) {
// Find end of the cmd-buffer, looking for the NUL-byte. // Find end of the cmd-buffer, looking for the NUL-byte.
uint8_t i = cmd_words_b[cmd_words_len - 1]; uint8_t i = cmd_words_b[cmd_words_len - 1];
do { do {
@@ -1995,6 +2005,7 @@ config_done:
// If a command is too long or can't be tokenized, remaining commands are not executed // If a command is too long or can't be tokenized, remaining commands are not executed
// Returns the status via `err_status`-variable. // Returns the status via `err_status`-variable.
void execute_commands(__xdata uint8_t *p) __banked { void execute_commands(__xdata uint8_t *p) __banked {
__xdata uint8_t failed = ERR_OK;
err_status = ERR_OK; err_status = ERR_OK;
uint8_t cmd_idx = 0; uint8_t cmd_idx = 0;
while (1) { while (1) {
@@ -2005,9 +2016,13 @@ void execute_commands(__xdata uint8_t *p) __banked {
if (err_status != ERR_OK) if (err_status != ERR_OK)
return; return;
cmd_parser(); cmd_parser();
if (failed == ERR_OK)
failed = err_status;
} }
if (*p == 0) if (*p == 0) {
err_status = failed;
return; return;
}
cmd_idx = 0; cmd_idx = 0;
} else { } else {
if (cmd_idx < (CMD_BUF_SIZE - 1)) { if (cmd_idx < (CMD_BUF_SIZE - 1)) {
rtl837x_common.h
+4 -3
View File
@@ -54,6 +54,7 @@ extern __xdata uint8_t sbuf[SBUF_SIZE];
#define ERR_OK 0 #define ERR_OK 0
#define ERR_TOO_MANY_ARGUMENTS 1 #define ERR_TOO_MANY_ARGUMENTS 1
#define ERR_CMD_TOO_LONG 2 #define ERR_CMD_TOO_LONG 2
#define ERR_INVALID_ARGUMENT 3
// For RX data, a propriatary RTL FRAME is inserted. Instead of 0x0800 for IPv4, // For RX data, a propriatary RTL FRAME is inserted. Instead of 0x0800 for IPv4,
// the RTL_FRAME_TAG_ID is used as part of an 8-byte tag. When VLAN is activated, // the RTL_FRAME_TAG_ID is used as part of an 8-byte tag. When VLAN is activated,
@@ -134,9 +135,9 @@ extern __xdata uint8_t uip_buf[UIP_CONF_BUFFER_SIZE+2];
extern __xdata struct uip_eth_addr uip_ethaddr; extern __xdata struct uip_eth_addr uip_ethaddr;
// Headers for calls in the common code area (HOME/BANK0) // Headers for calls in the common code area (HOME/BANK0)
void print_string_no_syslog(__code char *p); void print_string_no_syslog(__code const char *p);
void print_string_newline_no_syslog(__code char *p); void print_string_newline_no_syslog(__code const char *p);
void print_string(__code char *p); void print_string(__code const char *p);
void print_string_x(__xdata char *p); void print_string_x(__xdata char *p);
void print_long(uint32_t a); void print_long(uint32_t a);
void print_short(uint16_t a); void print_short(uint16_t a);
rtl837x_stp.c
+3
View File
@@ -15,6 +15,8 @@
#include "uip.h" #include "uip.h"
#include "machine.h" #include "machine.h"
extern __xdata uint8_t err_status;
// All entry points are __banked and nothing here runs from an interrupt, // All entry points are __banked and nothing here runs from an interrupt,
// so the module does not need to stay in the resident bank // so the module does not need to stay in the resident bank
#pragma codeseg BANK2 #pragma codeseg BANK2
@@ -1134,5 +1136,6 @@ void stp_parse(void) __banked __reentrant
} }
return; return;
err: err:
err_status = ERR_INVALID_ARGUMENT;
print_string("Error: stp on|off|status | prio <0-15> | hello <1-10> | maxage <6-40> | fwd <4-30> | txhold <1-10> | version rstp|stp | port <1-9>|lag <1-4> on|off|edge|cost|prio|guard|filter ...\n"); print_string("Error: stp on|off|status | prio <0-15> | hello <1-10> | maxage <6-40> | fwd <4-30> | txhold <1-10> | version rstp|stp | port <1-9>|lag <1-4> on|off|edge|cost|prio|guard|filter ...\n");
} }
rtlplayground.c
+3 -3
View File
@@ -303,19 +303,19 @@ void itoa_short(uint16_t v)
} }
void print_string(__code char *p) void print_string(__code const char *p)
{ {
while (*p) while (*p)
write_char(*p++); write_char(*p++);
} }
void print_string_no_syslog(__code char *p) void print_string_no_syslog(__code const char *p)
{ {
while (*p) while (*p)
write_char_no_syslog(*p++); write_char_no_syslog(*p++);
} }
void print_string_newline_no_syslog(__code char *p) void print_string_newline_no_syslog(__code const char *p)
{ {
write_char_no_syslog('\n'); write_char_no_syslog('\n');
print_string_no_syslog(p); print_string_no_syslog(p);
test/support.c
+1 -1
View File
@@ -47,7 +47,7 @@ static void out_putc(char c) {
/* --- mocked print helpers (signatures match rtl837x_common.h post-shim) ---- */ /* --- mocked print helpers (signatures match rtl837x_common.h post-shim) ---- */
void write_char(char c) { out_putc(c); } void write_char(char c) { out_putc(c); }
void print_string(char *p) { while (*p) out_putc(*p++); } void print_string(const char *p) { while (*p) out_putc(*p++); }
void print_string_x(char *p) { while (*p) out_putc(*p++); } void print_string_x(char *p) { while (*p) out_putc(*p++); }
void print_cmd_prompt(void) { print_string((char *)"> "); } void print_cmd_prompt(void) { print_string((char *)"> "); }
void itoa(uint8_t v) { /* firmware prints a decimal number */ void itoa(uint8_t v) { /* firmware prints a decimal number */