139 lines
9.0 KiB
C++
139 lines
9.0 KiB
C++
#include "HelpMonitorInfo.hpp"
|
|
|
|
#include <string>
|
|
|
|
#include "src/DebugServer/Gdb/ResponsePackets/ResponsePacket.hpp"
|
|
|
|
#include "src/Services/StringService.hpp"
|
|
#include "src/Logger/Logger.hpp"
|
|
|
|
#include "src/Targets/TargetFamily.hpp"
|
|
|
|
namespace DebugServer::Gdb::CommandPackets
|
|
{
|
|
using Services::TargetControllerService;
|
|
using Services::StringService;
|
|
|
|
using ResponsePackets::ResponsePacket;
|
|
|
|
HelpMonitorInfo::HelpMonitorInfo(Monitor&& monitorPacket)
|
|
: Monitor(std::move(monitorPacket))
|
|
{}
|
|
|
|
void HelpMonitorInfo::handle(
|
|
DebugSession& debugSession,
|
|
const TargetDescriptor& gdbTargetDescriptor,
|
|
const Targets::TargetDescriptor& targetDescriptor,
|
|
TargetControllerService&
|
|
) {
|
|
Logger::info("Handling HelpMonitorInfo packet");
|
|
|
|
static constexpr auto CMD_COLOR = StringService::TerminalColor::DARK_YELLOW;
|
|
static constexpr auto PARAM_COLOR = StringService::TerminalColor::BLUE;
|
|
|
|
static const auto leftPadding = std::string{std::string::size_type{3}, ' ', std::string::allocator_type{}};
|
|
|
|
auto output = std::string{"\nSupported Bloom commands:\n\n"};
|
|
|
|
output += StringService::applyTerminalColor("help", CMD_COLOR) + "\n\n";
|
|
output += leftPadding + "Displays this help text.\n\n";
|
|
|
|
output += StringService::applyTerminalColor("version", CMD_COLOR) + "\n\n";
|
|
output += leftPadding + "Outputs Bloom's version information.\n\n";
|
|
|
|
output += StringService::applyTerminalColor( "version machine", CMD_COLOR) + "\n\n";
|
|
output += leftPadding + "Outputs Bloom's version information in JSON format.\n\n";
|
|
|
|
#ifndef EXCLUDE_INSIGHT
|
|
output += StringService::applyTerminalColor("insight", CMD_COLOR) + "\n\n";
|
|
output += leftPadding + "Activates the Insight GUI.\n\n";
|
|
#endif
|
|
|
|
output += StringService::applyTerminalColor("reset", CMD_COLOR) + "\n\n";
|
|
output += leftPadding + "Resets the target and holds it in a stopped state.\n\n";
|
|
|
|
output += StringService::applyTerminalColor("lr", CMD_COLOR) + " ["
|
|
+ StringService::applyTerminalColor("PERIPHERAL_KEY", PARAM_COLOR) + "] ["
|
|
+ StringService::applyTerminalColor("ABS_REG_GROUP_KEY", PARAM_COLOR) + "]\n\n";
|
|
output += leftPadding + "Lists all target registers in the given peripheral and register group.\n";
|
|
output += leftPadding + "If a peripheral key is not provided, all registers across all peripherals will be listed.\n\n";
|
|
output += leftPadding + "Examples:\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("lr", CMD_COLOR) + "\n";
|
|
output += leftPadding + " To list all target registers across all peripherals.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("lr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("tca0", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To list all target registers in the `tca0` peripheral.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("lr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("tca0", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("tca.single", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To list all target registers in the `tca.single` register group, in the `tca0` peripheral.\n\n";
|
|
|
|
output += StringService::applyTerminalColor("rr", CMD_COLOR) + " ["
|
|
+ StringService::applyTerminalColor("PERIPHERAL_KEY", PARAM_COLOR) + "] ["
|
|
+ StringService::applyTerminalColor("ABS_REG_GROUP_KEY", PARAM_COLOR) + "] ["
|
|
+ StringService::applyTerminalColor("REG_KEY", PARAM_COLOR) + "]\n\n";
|
|
output += leftPadding + "Reads the value of the given register.\n";
|
|
output += leftPadding + "If a register key is not provided, all registers in the given peripheral and register group will be read.\n";
|
|
output += leftPadding + "The register group key can be omitted if the peripheral contains a single register group,\n";
|
|
output += leftPadding + "and the subject register resides directly within that group (not in any subgroup).\n\n";
|
|
output += leftPadding + "Examples:\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("rr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("porta", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("port", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("dir", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To read the `dir` register in the `port` register group, in the `porta` peripheral.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("rr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("porta", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("dir", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " Same as above, excluding the register group key.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("rr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("tca0", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("tca.split", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To read all registers in the `tca.split` register group, in the `tca0` peripheral.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("rr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("porta", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To read all registers in the `porta` peripheral.\n\n";
|
|
|
|
output += StringService::applyTerminalColor("wr", CMD_COLOR) + " ["
|
|
+ StringService::applyTerminalColor("PERIPHERAL_KEY", PARAM_COLOR) + "] ["
|
|
+ StringService::applyTerminalColor("ABS_REG_GROUP_KEY", PARAM_COLOR) + "] ["
|
|
+ StringService::applyTerminalColor("REG_KEY", PARAM_COLOR) + "] ["
|
|
+ StringService::applyTerminalColor("VALUE_HEX", PARAM_COLOR) + "]\n\n";
|
|
output += leftPadding + "Writes the given value to the given register. The value must take the form of a hexadecimal string.\n";
|
|
output += leftPadding + "The register group key can be omitted if the peripheral contains a single register group,\n";
|
|
output += leftPadding + "and the subject register resides directly within that group (not in any subgroup).\n\n";
|
|
output += leftPadding + "Examples:\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("wr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("porta", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("port", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("dir", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("0x40", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To write 0x40 to the `dir` register in the `port` register group, in the `porta` peripheral.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("wr", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("porta", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("dir", PARAM_COLOR) + " "
|
|
+ StringService::applyTerminalColor("0x40", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " Same as above, excluding the register group key.\n\n";
|
|
|
|
if (targetDescriptor.family == Targets::TargetFamily::AVR_8) {
|
|
output += StringService::applyTerminalColor("eeprom fill", CMD_COLOR) + " ["
|
|
+ StringService::applyTerminalColor("VALUE", PARAM_COLOR) + "]\n\n";
|
|
output += leftPadding + "Fills the target's EEPROM with the specified value. The value must take the form of a hexadecimal string.\n";
|
|
output += leftPadding + "If the specified value is smaller than the EEPROM memory segment size, it will be repeated\n";
|
|
output += leftPadding + "across the entire segment address range. If the value size is not a multiple of the segment\n";
|
|
output += leftPadding + "size, the value will be truncated in the final repetition. The value size must not\n";
|
|
output += leftPadding + "exceed the segment size.\n\n";
|
|
output += leftPadding + "Examples:\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("eeprom fill", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("0xFF", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To write 0xFF to the entirety of the target's EEPROM memory segment.\n\n";
|
|
output += leftPadding + "mon " + StringService::applyTerminalColor("eeprom fill", CMD_COLOR) + " "
|
|
+ StringService::applyTerminalColor("FF00FF00AABBCC", PARAM_COLOR) + "\n";
|
|
output += leftPadding + " To repeat the hexadecimal sequence 'FF00FF00AABBCC' across the entirety of the target's EEPROM memory segment.\n\n";
|
|
}
|
|
|
|
output += "\n";
|
|
debugSession.connection.writePacket(ResponsePacket{Services::StringService::toHex(output)});
|
|
}
|
|
}
|