doryan/BloomPatched
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Renaming and other tidying

Browse Source
This commit is contained in:
Nav
2024-12-21 13:45:32 +00:00
parent bcdae97638
commit 28e0a6d9e4
3 changed files with 61 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/Targets/Microchip/AVR8/Avr8.cpp
View File

@@ -611,14 +611,12 @@ namespace Targets::Microchip::Avr8
: gpioPadDescriptor.inputRegisterDescriptor; : gpioPadDescriptor.inputRegisterDescriptor;
output.emplace_back( output.emplace_back(
TargetGpioPadDescriptorAndStatePair{ *padDescriptor,
*padDescriptor, TargetGpioPadState{
TargetGpioPadState{ (readGpioReg(stateRegisterDescriptor) & gpioPadDescriptor.registerMask) != 0
(readGpioReg(stateRegisterDescriptor) & gpioPadDescriptor.registerMask) != 0 ? TargetGpioPadState::State::HIGH
? TargetGpioPadState::State::HIGH : TargetGpioPadState::State::LOW,
: TargetGpioPadState::State::LOW, ddrValue
ddrValue
}
} }
); );
} }

116
src/Targets/RiscV/Wch/WchRiscV.cpp
View File

@@ -64,8 +64,8 @@ namespace Targets::RiscV::Wch
} }
Logger::info( Logger::info(
"Selected program memory segment: \"" + this->selectedProgramSegmentDescriptor.name + "\" (\"" "Selected program memory segment: \"" + this->selectedProgramSegmentDescriptor.name + "\" (`"
+ this->selectedProgramSegmentDescriptor.key + "\")" + this->selectedProgramSegmentDescriptor.key + "`)"
); );
if ( if (
@@ -156,9 +156,9 @@ namespace Targets::RiscV::Wch
sysAddressSpaceDescriptor.getMemorySegmentDescriptor("boot_program").inspectionEnabled = true; sysAddressSpaceDescriptor.getMemorySegmentDescriptor("boot_program").inspectionEnabled = true;
/* /*
* WCH targets typically possess a memory segment that is mapped to program memory. We cannot write to this * We cannot write to the mapped program memory segment directly, which is why it's described as read-only in
* segment directly, which is why it's described as read-only in Bloom's TDFs. However, we enable writing to * Bloom's TDFs. However, we enable writing to the segment by forwarding any write operations to the selected
* the segment by forwarding any write operations to the appropriate (aliased) segment. * program segment.
* *
* For this reason, we adjust the access member on the memory segment descriptor so that other components * For this reason, we adjust the access member on the memory segment descriptor so that other components
* within Bloom will see the segment as writeable. * within Bloom will see the segment as writeable.
@@ -177,20 +177,17 @@ namespace Targets::RiscV::Wch
breakpoint.type == TargetProgramBreakpoint::Type::SOFTWARE breakpoint.type == TargetProgramBreakpoint::Type::SOFTWARE
&& breakpoint.memorySegmentDescriptor == this->mappedSegmentDescriptor && breakpoint.memorySegmentDescriptor == this->mappedSegmentDescriptor
) { ) {
if ( if (!this->selectedProgramSegmentDescriptor.programmingModeAccess.writeable) {
!this->selectedProgramSegmentDescriptor.debugModeAccess.writeable
&& (!this->programmingMode || !this->selectedProgramSegmentDescriptor.programmingModeAccess.writeable)
) {
throw Exceptions::Exception{ throw Exceptions::Exception{
"The selected program memory segment (\"" + this->selectedProgramSegmentDescriptor.key "The selected program memory segment (`" + this->selectedProgramSegmentDescriptor.key
+ "\") is not writable - cannot insert software breakpoint" + "`) is not writable - cannot insert software breakpoint"
}; };
} }
this->riscVDebugInterface->setProgramBreakpoint(TargetProgramBreakpoint{ this->riscVDebugInterface->setProgramBreakpoint(TargetProgramBreakpoint{
.addressSpaceDescriptor = this->sysAddressSpaceDescriptor, .addressSpaceDescriptor = this->sysAddressSpaceDescriptor,
.memorySegmentDescriptor = this->selectedProgramSegmentDescriptor, .memorySegmentDescriptor = this->selectedProgramSegmentDescriptor,
.address = this->transformMappedAddress(breakpoint.address, this->selectedProgramSegmentDescriptor), .address = this->deAliasMappedAddress(breakpoint.address, this->selectedProgramSegmentDescriptor),
.size = breakpoint.size, .size = breakpoint.size,
.type = breakpoint.type .type = breakpoint.type
}); });
@@ -206,20 +203,17 @@ namespace Targets::RiscV::Wch
breakpoint.type == TargetProgramBreakpoint::Type::SOFTWARE breakpoint.type == TargetProgramBreakpoint::Type::SOFTWARE
&& breakpoint.memorySegmentDescriptor == this->mappedSegmentDescriptor && breakpoint.memorySegmentDescriptor == this->mappedSegmentDescriptor
) { ) {
if ( if (!this->selectedProgramSegmentDescriptor.programmingModeAccess.writeable) {
!this->selectedProgramSegmentDescriptor.debugModeAccess.writeable
&& (!this->programmingMode || !this->selectedProgramSegmentDescriptor.programmingModeAccess.writeable)
) {
throw Exceptions::Exception{ throw Exceptions::Exception{
"The selected program memory segment (\"" + this->selectedProgramSegmentDescriptor.key "The selected program memory segment (`" + this->selectedProgramSegmentDescriptor.key
+ "\") is not writable - cannot remove software breakpoint" + "`) is not writable - cannot remove software breakpoint"
}; };
} }
this->riscVDebugInterface->removeProgramBreakpoint(TargetProgramBreakpoint{ this->riscVDebugInterface->removeProgramBreakpoint(TargetProgramBreakpoint{
.addressSpaceDescriptor = this->sysAddressSpaceDescriptor, .addressSpaceDescriptor = this->sysAddressSpaceDescriptor,
.memorySegmentDescriptor = this->selectedProgramSegmentDescriptor, .memorySegmentDescriptor = this->selectedProgramSegmentDescriptor,
.address = this->transformMappedAddress(breakpoint.address, this->selectedProgramSegmentDescriptor), .address = this->deAliasMappedAddress(breakpoint.address, this->selectedProgramSegmentDescriptor),
.size = breakpoint.size, .size = breakpoint.size,
.type = breakpoint.type .type = breakpoint.type
}); });
@@ -241,7 +235,7 @@ namespace Targets::RiscV::Wch
if (memorySegmentDescriptor == this->mappedSegmentDescriptor) { if (memorySegmentDescriptor == this->mappedSegmentDescriptor) {
const auto& aliasedSegment = this->selectedProgramSegmentDescriptor; const auto& aliasedSegment = this->selectedProgramSegmentDescriptor;
const auto transformedAddress = this->transformMappedAddress(startAddress, aliasedSegment); const auto transformedAddress = this->deAliasMappedAddress(startAddress, aliasedSegment);
const auto addressRange = TargetMemoryAddressRange{ const auto addressRange = TargetMemoryAddressRange{
transformedAddress, transformedAddress,
@@ -252,8 +246,8 @@ namespace Targets::RiscV::Wch
throw Exceptions::Exception{ throw Exceptions::Exception{
"Read access range (0x" + StringService::toHex(addressRange.startAddress) + " -> 0x" "Read access range (0x" + StringService::toHex(addressRange.startAddress) + " -> 0x"
+ StringService::toHex(addressRange.endAddress) + ", " + std::to_string(addressRange.size()) + StringService::toHex(addressRange.endAddress) + ", " + std::to_string(addressRange.size())
+ " bytes) exceeds the boundary of the selected program segment \"" + aliasedSegment.key + " bytes) exceeds the boundary of the selected program segment `" + aliasedSegment.key
+ "\" (0x" + StringService::toHex(aliasedSegment.addressRange.startAddress) + " -> 0x" + "` (0x" + StringService::toHex(aliasedSegment.addressRange.startAddress) + " -> 0x"
+ StringService::toHex(aliasedSegment.addressRange.endAddress) + ", " + StringService::toHex(aliasedSegment.addressRange.endAddress) + ", "
+ std::to_string(aliasedSegment.addressRange.size()) + " bytes)" + std::to_string(aliasedSegment.addressRange.size()) + " bytes)"
}; };
@@ -293,11 +287,11 @@ namespace Targets::RiscV::Wch
&& (!this->programmingMode || !aliasedSegment.programmingModeAccess.writeable) && (!this->programmingMode || !aliasedSegment.programmingModeAccess.writeable)
) { ) {
throw Exceptions::Exception{ throw Exceptions::Exception{
"The selected program memory segment (\"" + aliasedSegment.key + "\") is not writable" "The selected program memory segment (`" + aliasedSegment.key + "`) is not writable"
}; };
} }
const auto transformedAddress = this->transformMappedAddress(startAddress, aliasedSegment); const auto transformedAddress = this->deAliasMappedAddress(startAddress, aliasedSegment);
const auto addressRange = TargetMemoryAddressRange{ const auto addressRange = TargetMemoryAddressRange{
transformedAddress, transformedAddress,
@@ -308,8 +302,8 @@ namespace Targets::RiscV::Wch
throw Exceptions::Exception{ throw Exceptions::Exception{
"Write access range (0x" + StringService::toHex(addressRange.startAddress) + " -> 0x" "Write access range (0x" + StringService::toHex(addressRange.startAddress) + " -> 0x"
+ StringService::toHex(addressRange.endAddress) + ", " + std::to_string(addressRange.size()) + StringService::toHex(addressRange.endAddress) + ", " + std::to_string(addressRange.size())
+ " bytes) exceeds the boundary of the selected program segment \"" + aliasedSegment.key + " bytes) exceeds the boundary of the selected program segment `" + aliasedSegment.key
+ "\" (0x" + StringService::toHex(aliasedSegment.addressRange.startAddress) + " -> 0x" + "` (0x" + StringService::toHex(aliasedSegment.addressRange.startAddress) + " -> 0x"
+ StringService::toHex(aliasedSegment.addressRange.endAddress) + ", " + StringService::toHex(aliasedSegment.addressRange.endAddress) + ", "
+ std::to_string(aliasedSegment.addressRange.size()) + " bytes)" + std::to_string(aliasedSegment.addressRange.size()) + " bytes)"
}; };
@@ -358,18 +352,18 @@ namespace Targets::RiscV::Wch
* So, we have a program counter that's addressing a totally different program, but to most external * So, we have a program counter that's addressing a totally different program, but to most external
* entities, it will appear as if it's addressing the same program. * entities, it will appear as if it's addressing the same program.
* *
* In order to avoid causing havoc and potentially misleading the user, we transform the PC to its * In order to avoid causing havoc and potentially misleading the user, we de-alias the program
* aliased address. That way, it will be clear to all external entities, that the target is currently * counter in this scenario. That way, it will be clear to all external entities, that the target is
* executing code in a different memory segment to the one that was selected for debugging. * currently executing code in a different memory segment to the one that was selected for debugging.
*/ */
const auto transformedAddress = this->transformMappedAddress(programCounter, actualAliasedSegment); const auto deAliasedAddress = this->deAliasMappedAddress(programCounter, actualAliasedSegment);
Logger::warning( Logger::warning(
"The mapped program memory segment is currently aliasing a foreign segment (\"" "The mapped program memory segment is currently aliasing a foreign segment (`"
+ actualAliasedSegment.key + "\") - the program counter (0x" + actualAliasedSegment.key + "`) - the program counter (0x"
+ StringService::toHex(programCounter) + ") has been transformed to the aliased address (0x" + StringService::toHex(programCounter) + ") has been de-aliased to 0x"
+ StringService::toHex(transformedAddress) + ")" + StringService::toHex(deAliasedAddress)
); );
return transformedAddress; return deAliasedAddress;
} }
} }
@@ -412,14 +406,12 @@ namespace Targets::RiscV::Wch
if (padMode == static_cast<std::uint8_t>(GpioPadDirection::INPUT)) { if (padMode == static_cast<std::uint8_t>(GpioPadDirection::INPUT)) {
output.emplace_back( output.emplace_back(
TargetGpioPadDescriptorAndStatePair{ *padDescriptor,
*padDescriptor, TargetGpioPadState{
TargetGpioPadState{ readGpioReg(gpioPadDescriptor.inputDataRegisterDescriptor).bitFieldAs<bool>(
readGpioReg(gpioPadDescriptor.inputDataRegisterDescriptor).bitFieldAs<bool>( gpioPadDescriptor.inputDataBitFieldDescriptor
gpioPadDescriptor.inputDataBitFieldDescriptor ) ? TargetGpioPadState::State::HIGH : TargetGpioPadState::State::LOW,
) ? TargetGpioPadState::State::HIGH : TargetGpioPadState::State::LOW, TargetGpioPadState::DataDirection::INPUT
TargetGpioPadState::DataDirection::INPUT
}
} }
); );
@@ -427,14 +419,12 @@ namespace Targets::RiscV::Wch
} }
output.emplace_back( output.emplace_back(
TargetGpioPadDescriptorAndStatePair{ *padDescriptor,
*padDescriptor, TargetGpioPadState{
TargetGpioPadState{ readGpioReg(gpioPadDescriptor.outputDataRegisterDescriptor).bitFieldAs<bool>(
readGpioReg(gpioPadDescriptor.outputDataRegisterDescriptor).bitFieldAs<bool>( gpioPadDescriptor.outputDataBitFieldDescriptor
gpioPadDescriptor.outputDataBitFieldDescriptor ) ? TargetGpioPadState::State::HIGH : TargetGpioPadState::State::LOW,
) ? TargetGpioPadState::State::HIGH : TargetGpioPadState::State::LOW, TargetGpioPadState::DataDirection::OUTPUT
TargetGpioPadState::DataDirection::OUTPUT
}
} }
); );
} }
@@ -502,11 +492,11 @@ namespace Targets::RiscV::Wch
output += leftPadding + "mon " + StringService::applyTerminalColor("program_mode", CMD_COLOR) + " " output += leftPadding + "mon " + StringService::applyTerminalColor("program_mode", CMD_COLOR) + " "
+ StringService::applyTerminalColor("boot", PARAM_COLOR) + "\n"; + StringService::applyTerminalColor("boot", PARAM_COLOR) + "\n";
output += leftPadding + " To switch to boot mode, where the mapped program memory segment aliases the boot" output += leftPadding + " To switch to boot mode, where the mapped program memory segment aliases the boot"
" segment (key: \"" + this->bootProgramSegmentDescriptor.key + "\").\n\n"; " segment (`" + this->bootProgramSegmentDescriptor.key + "`).\n\n";
output += leftPadding + "mon " + StringService::applyTerminalColor("program_mode", CMD_COLOR) + " " output += leftPadding + "mon " + StringService::applyTerminalColor("program_mode", CMD_COLOR) + " "
+ StringService::applyTerminalColor("user", PARAM_COLOR) + "\n"; + StringService::applyTerminalColor("user", PARAM_COLOR) + "\n";
output += leftPadding + " To switch to user mode, where the mapped program memory segment aliases the main" output += leftPadding + " To switch to user mode, where the mapped program memory segment aliases the main"
" program segment (key: \"" + this->mainProgramSegmentDescriptor.key + "\").\n"; " program segment (`" + this->mainProgramSegmentDescriptor.key + "`).\n";
return output; return output;
} }
@@ -530,11 +520,11 @@ namespace Targets::RiscV::Wch
actualAliasedSegment == this->bootProgramSegmentDescriptor ? "boot mode" : "user mode", actualAliasedSegment == this->bootProgramSegmentDescriptor ? "boot mode" : "user mode",
StringService::TerminalColor::DARK_YELLOW StringService::TerminalColor::DARK_YELLOW
) + "\"\n"; ) + "\"\n";
response.output += "Aliased memory segment key: \"" response.output += "Aliased memory segment key: `"
+ StringService::applyTerminalColor( + StringService::applyTerminalColor(
actualAliasedSegment.key, actualAliasedSegment.key,
StringService::TerminalColor::DARK_YELLOW StringService::TerminalColor::DARK_YELLOW
) + "\"\n"; ) + "`\n";
response.output += "Mapped address -> aliased address: " + StringService::applyTerminalColor( response.output += "Mapped address -> aliased address: " + StringService::applyTerminalColor(
"0x" + StringService::asciiToUpper( "0x" + StringService::asciiToUpper(
StringService::toHex(this->mappedSegmentDescriptor.addressRange.startAddress) StringService::toHex(this->mappedSegmentDescriptor.addressRange.startAddress)
@@ -629,25 +619,25 @@ namespace Targets::RiscV::Wch
probeAddress probeAddress
) ? this->mainProgramSegmentDescriptor : this->bootProgramSegmentDescriptor; ) ? this->mainProgramSegmentDescriptor : this->bootProgramSegmentDescriptor;
Logger::debug("Aliased program memory segment: \"" + segment.key + "\""); Logger::debug("Aliased program memory segment: `" + segment.key + "`");
return segment; return segment;
} }
TargetMemoryAddress WchRiscV::transformMappedAddress( TargetMemoryAddress WchRiscV::deAliasMappedAddress(
TargetMemoryAddress address, TargetMemoryAddress address,
const TargetMemorySegmentDescriptor& segmentDescriptor const TargetMemorySegmentDescriptor& aliasedSegmentDescriptor
) { ) {
using Services::StringService; using Services::StringService;
const auto transformedAddress = address - this->mappedSegmentDescriptor.addressRange.startAddress const auto deAliasedAddress = address - this->mappedSegmentDescriptor.addressRange.startAddress
+ segmentDescriptor.addressRange.startAddress; + aliasedSegmentDescriptor.addressRange.startAddress;
Logger::debug( Logger::debug(
"Transformed mapped program memory address 0x" + StringService::toHex(address) + " to 0x" "De-aliased mapped program memory address 0x" + StringService::toHex(address) + " to 0x"
+ StringService::toHex(transformedAddress) + " (segment: \"" + segmentDescriptor.key + "\")" + StringService::toHex(deAliasedAddress) + " (segment: `" + aliasedSegmentDescriptor.key + "`)"
); );
return transformedAddress; return deAliasedAddress;
} }
void WchRiscV::unlockFlash() { void WchRiscV::unlockFlash() {

4
src/Targets/RiscV/Wch/WchRiscV.hpp
View File

@@ -100,9 +100,9 @@ namespace Targets::RiscV::Wch
std::map<TargetPadId, GpioPadDescriptor> gpioPadDescriptorsByPadId; std::map<TargetPadId, GpioPadDescriptor> gpioPadDescriptorsByPadId;
const TargetMemorySegmentDescriptor& resolveAliasedMemorySegment(); const TargetMemorySegmentDescriptor& resolveAliasedMemorySegment();
TargetMemoryAddress transformMappedAddress( TargetMemoryAddress deAliasMappedAddress(
TargetMemoryAddress address, TargetMemoryAddress address,
const TargetMemorySegmentDescriptor& segmentDescriptor const TargetMemorySegmentDescriptor& aliasedSegmentDescriptor
); );
void unlockFlash(); void unlockFlash();