Results: Implement namespaced, type-safe results.

Because I was working on multiple things at once, this commit also:
- Adds wrappers for/linker flags to wrap CXX exceptions to make them
  abort. This saves ~0x8000 of memory in every system module.
- Broadly replaces lines of the pattern if (cond) { return ResultX; }
  with R_UNLESS(!cond, ResultX());.
- Reworks the R_TRY_CATCH macros (and the result macros in general).
This commit is contained in:
Michael Scire 2019-10-24 01:40:44 -07:00 committed by SciresM
parent 15773e4755
commit 4059dc6187
169 changed files with 2172 additions and 1868 deletions

View file

@ -67,7 +67,7 @@ namespace sts::boot {
const u16 new_val = (cur_val & ~mask) | val;
R_TRY(this->Write(addr, new_val));
return ResultSuccess;
return ResultSuccess();
}
bool BatteryDriver::WriteValidate(u8 addr, u16 val) {
@ -99,20 +99,20 @@ namespace sts::boot {
Result BatteryDriver::LockModelTable() {
R_TRY(this->Write(Max17050ModelAccess0, 0x0000));
R_TRY(this->Write(Max17050ModelAccess1, 0x0000));
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::UnlockModelTable() {
R_TRY(this->Write(Max17050ModelAccess0, 0x0059));
R_TRY(this->Write(Max17050ModelAccess1, 0x00C4));
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::SetModelTable(const u16 *model_table) {
for (size_t i = 0; i < Max17050ModelChrTblSize; i++) {
R_TRY(this->Write(Max17050ModelChrTblStart + i, model_table[i]));
}
return ResultSuccess;
return ResultSuccess();
}
bool BatteryDriver::IsModelTableLocked() {
@ -173,7 +173,7 @@ namespace sts::boot {
if (lock_i >= 8) {
/* This is regarded as guaranteed success. */
return ResultSuccess;
return ResultSuccess();
}
}
@ -235,7 +235,7 @@ namespace sts::boot {
R_TRY(this->Write(Max17050CGain, 0x7FFF));
}
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::IsBatteryRemoved(bool *out) {
@ -243,28 +243,28 @@ namespace sts::boot {
u16 val = 0;
R_TRY(this->Read(Max17050Status, &val));
*out = (val & 0x0008) == 0x0008;
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::GetTemperature(double *out) {
u16 val = 0;
R_TRY(this->Read(Max17050Temperature, &val));
*out = static_cast<double>(val) * double(0.00390625);
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::GetAverageVCell(u32 *out) {
u16 val = 0;
R_TRY(this->Read(Max17050AverageVCell, &val));
*out = (625 * u32(val >> 3)) / 1000;
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::GetSocRep(double *out) {
u16 val = 0;
R_TRY(this->Read(Max17050SocRep, &val));
*out = static_cast<double>(val) * double(0.00390625);
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::GetBatteryPercentage(size_t *out) {
@ -278,7 +278,7 @@ namespace sts::boot {
} else {
*out = static_cast<size_t>(converted_percentage);
}
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::SetShutdownTimer() {
@ -289,7 +289,7 @@ namespace sts::boot {
u16 val = 0;
R_TRY(this->Read(Max17050Config, &val));
*out = (val & 0x0040) != 0;
return ResultSuccess;
return ResultSuccess();
}
Result BatteryDriver::SetShutdownEnabled(bool enabled) {

View file

@ -29,8 +29,6 @@ namespace sts::boot {
constexpr u32 DefaultBatteryVendor = static_cast<u32>('A');
constexpr u32 DefaultBatteryVersion = 0;
constexpr Result ResultCalInvalidCrc = 0xCAC6; /* TODO: Verify this really is cal, move to libstrat results. */
/* Helpers. */
constexpr u16 GetCrc16(const void *data, size_t size) {
constexpr u16 s_crc_table[0x10] = {
@ -51,10 +49,9 @@ namespace sts::boot {
Result ValidateCalibrationCrc16(const void *data, size_t size) {
const u8 *data_u8 = reinterpret_cast<const u8 *>(data);
if (GetCrc16(data, size - sizeof(u16)) != *(reinterpret_cast<const u16 *>(&data_u8[size - sizeof(u16)]))) {
return ResultCalInvalidCrc;
}
return ResultSuccess;
const bool crc_valid = GetCrc16(data, size - sizeof(u16)) == *(reinterpret_cast<const u16 *>(&data_u8[size - sizeof(u16)]));
R_UNLESS(crc_valid, cal::ResultCalibrationDataCrcError());
return ResultSuccess();
}
Result GetBatteryVendorImpl(u32 *vendor) {
@ -68,7 +65,7 @@ namespace sts::boot {
R_TRY(ValidateCalibrationCrc16(battery_lot, sizeof(battery_lot)));
*vendor = battery_lot[7];
return ResultSuccess;
return ResultSuccess();
}
Result GetBatteryVersionImpl(u32 *version) {
@ -82,7 +79,7 @@ namespace sts::boot {
R_TRY(ValidateCalibrationCrc16(battery_version, sizeof(battery_version)));
*version = battery_version[0];
return ResultSuccess;
return ResultSuccess();
}
}

View file

@ -35,7 +35,7 @@ namespace sts::boot {
const u8 new_val = (cur_val & ~mask) | val;
R_TRY(this->Write(addr, new_val));
return ResultSuccess;
return ResultSuccess();
}
Result ChargerDriver::Initialize() {
@ -59,7 +59,7 @@ namespace sts::boot {
R_TRY(this->SetBoostModeCurrentLimit(bq24193::BoostModeCurrentLimit_500mA));
R_TRY(this->SetHiZEnabled(false));
return ResultSuccess;
return ResultSuccess();
}
Result ChargerDriver::SetChargeEnabled(bool enabled) {
@ -123,14 +123,14 @@ namespace sts::boot {
u8 limit;
R_TRY(this->Read(bq24193::InputSourceControl, &limit));
*out = static_cast<bq24193::InputCurrentLimit>(limit);
return ResultSuccess;
return ResultSuccess();
}
Result ChargerDriver::GetChargeVoltageLimit(u32 *out) {
u8 reg;
R_TRY(this->Read(bq24193::ChargeVoltageControl, &reg));
*out = bq24193::DecodeChargeVoltageLimit(reg);
return ResultSuccess;
return ResultSuccess();
}
}

View file

@ -27,14 +27,16 @@ namespace sts::boot {
u64 cur_time = 0;
while (true) {
R_TRY_CLEANUP(f(), {
cur_time += retry_interval;
if (cur_time < timeout) {
svcSleepThread(retry_interval);
continue;
}
});
return ResultSuccess;
const auto retry_result = f();
R_UNLESS(R_FAILED(retry_result), ResultSuccess());
cur_time += retry_interval;
if (cur_time < timeout) {
svcSleepThread(retry_interval);
continue;
}
return retry_result;
}
}

View file

@ -72,6 +72,12 @@ namespace sts::ams {
}
namespace sts::result {
bool CallFatalOnResultAssertion = false;
}
using namespace sts;
void __libnx_exception_handler(ThreadExceptionDump *ctx) {

View file

@ -44,19 +44,19 @@ namespace sts::pcv {
reg::ReadWrite(regs.clk_src_reg, 0, 0xE0000000);
svcSleepThread(2000ul);
return ResultSuccess;
return ResultSuccess();
}
Result SetClockEnabled(PcvModule module, bool enabled) {
return ResultSuccess;
return ResultSuccess();
}
Result SetVoltageEnabled(u32 domain, bool enabled) {
return ResultSuccess;
return ResultSuccess();
}
Result SetVoltageValue(u32 domain, u32 voltage) {
return ResultSuccess;
return ResultSuccess();
}
Result SetReset(PcvModule module, bool reset) {
@ -71,7 +71,7 @@ namespace sts::pcv {
reg::ClearBits(regs.rst_reg, regs.mask);
}
return ResultSuccess;
return ResultSuccess();
}
}

View file

@ -34,7 +34,7 @@ namespace sts::boot {
u8 power_status;
R_TRY(this->GetPowerStatus(&power_status));
*out = (power_status & 0x02) != 0;
return ResultSuccess;
return ResultSuccess();
}
Result PmicDriver::GetPowerIntr(u8 *out) {
@ -56,7 +56,7 @@ namespace sts::boot {
u8 power_intr;
R_TRY(this->GetPowerIntr(&power_intr));
*out = (power_intr & 0x08) != 0;
return ResultSuccess;
return ResultSuccess();
}
Result PmicDriver::ShutdownSystem(bool reboot) {

View file

@ -40,7 +40,7 @@ namespace sts::i2c::driver {
R_TRY(Send(session, *cur_cmd, num_bytes, option));
(*cur_cmd) += num_bytes;
return ResultSuccess;
return ResultSuccess();
}
Result ReceiveHandler(const u8 **cur_cmd, u8 **cur_dst, Session& session) {
@ -55,7 +55,7 @@ namespace sts::i2c::driver {
R_TRY(Receive(session, *cur_dst, num_bytes, option));
(*cur_dst) += num_bytes;
return ResultSuccess;
return ResultSuccess();
}
Result SubCommandHandler(const u8 **cur_cmd, u8 **cur_dst, Session& session) {
@ -72,7 +72,7 @@ namespace sts::i2c::driver {
break;
STS_UNREACHABLE_DEFAULT_CASE();
}
return ResultSuccess;
return ResultSuccess();
}
/* Command handler list. */
@ -155,7 +155,7 @@ namespace sts::i2c::driver {
R_TRY(g_cmd_handlers[static_cast<size_t>(cmd)](&cur_cmd, &cur_dst, session));
}
return ResultSuccess;
return ResultSuccess();
}
/* Power management. */

View file

@ -118,7 +118,7 @@ namespace sts::i2c::driver::impl {
Result BusAccessor::StartTransaction(Command command, AddressingMode addressing_mode, u32 slave_address) {
/* Nothing actually happens here... */
return ResultSuccess;
return ResultSuccess();
}
Result BusAccessor::Send(const u8 *data, size_t num_bytes, I2cTransactionOption option, AddressingMode addressing_mode, u32 slave_address) {
@ -158,9 +158,9 @@ namespace sts::i2c::driver::impl {
this->interrupt_event.Reset();
if (!this->interrupt_event.TimedWait(InterruptTimeout)) {
this->HandleTransactionResult(ResultI2cBusBusy);
this->HandleTransactionResult(i2c::ResultBusBusy());
this->interrupt_event.Reset();
return ResultI2cTimedOut;
return i2c::ResultTimedOut();
}
R_TRY(this->GetAndHandleTransactionResult());
@ -181,13 +181,13 @@ namespace sts::i2c::driver::impl {
this->interrupt_event.Reset();
if (!this->interrupt_event.TimedWait(InterruptTimeout)) {
this->HandleTransactionResult(ResultI2cBusBusy);
this->HandleTransactionResult(i2c::ResultBusBusy());
this->interrupt_event.Reset();
return ResultI2cTimedOut;
return i2c::ResultTimedOut();
}
}
return ResultSuccess;
return ResultSuccess();
}
Result BusAccessor::Receive(u8 *out_data, size_t num_bytes, I2cTransactionOption option, AddressingMode addressing_mode, u32 slave_address) {
@ -206,10 +206,10 @@ namespace sts::i2c::driver::impl {
while (remaining > 0) {
this->interrupt_event.Reset();
if (!this->interrupt_event.TimedWait(InterruptTimeout)) {
this->HandleTransactionResult(ResultI2cBusBusy);
this->HandleTransactionResult(i2c::ResultBusBusy());
this->ClearInterruptMask();
this->interrupt_event.Reset();
return ResultI2cTimedOut;
return i2c::ResultTimedOut();
}
R_TRY(this->GetAndHandleTransactionResult());
@ -230,7 +230,7 @@ namespace sts::i2c::driver::impl {
}
/* N doesn't do ClearInterruptMask. */
return ResultSuccess;
return ResultSuccess();
}
void BusAccessor::SetBus(Bus bus) {
@ -383,13 +383,11 @@ namespace sts::i2c::driver::impl {
/* Wait for flush to finish, check every ms for 5 ms. */
for (size_t i = 0; i < 5; i++) {
if (!(reg::Read(&this->i2c_registers->I2C_FIFO_CONTROL_0) & 3)) {
return ResultSuccess;
}
R_UNLESS((reg::Read(&this->i2c_registers->I2C_FIFO_CONTROL_0) & 3), ResultSuccess());
svcSleepThread(1'000'000ul);
}
return ResultI2cBusBusy;
return i2c::ResultBusBusy();
}
Result BusAccessor::GetTransactionResult() const {
@ -397,22 +395,23 @@ namespace sts::i2c::driver::impl {
const u32 interrupt_status = reg::Read(&this->i2c_registers->I2C_INTERRUPT_STATUS_REGISTER_0);
/* Check for no ack. */
if ((packet_status & 0xC) || (interrupt_status & 0x8)) {
return ResultI2cNoAck;
}
R_UNLESS(!(packet_status & 0xC), i2c::ResultNoAck());
R_UNLESS(!(interrupt_status & 0x8), i2c::ResultNoAck());
/* Check for arb lost. */
if ((packet_status & 0x2) || (interrupt_status & 0x4)) {
this->ClearBus();
return ResultI2cBusBusy;
{
auto bus_guard = SCOPE_GUARD { this->ClearBus(); };
R_UNLESS(!(packet_status & 0x2), i2c::ResultBusBusy());
R_UNLESS(!(interrupt_status & 0x4), i2c::ResultBusBusy());
bus_guard.Cancel();
}
return ResultSuccess;
return ResultSuccess();
}
void BusAccessor::HandleTransactionResult(Result result) {
R_TRY_CATCH(result) {
R_CATCH_MANY(ResultI2cNoAck, ResultI2cBusBusy) {
R_CATCH(i2c::ResultNoAck, i2c::ResultBusBusy) {
this->ResetController();
this->SetClock(this->speed_mode);
this->SetPacketMode();
@ -422,12 +421,12 @@ namespace sts::i2c::driver::impl {
}
Result BusAccessor::GetAndHandleTransactionResult() {
R_TRY_CLEANUP(this->GetTransactionResult(), {
this->HandleTransactionResult(R_CLEANUP_RESULT);
this->ClearInterruptMask();
this->interrupt_event.Reset();
});
return ResultSuccess;
const auto transaction_result = this->GetTransactionResult();
R_UNLESS(R_FAILED(transaction_result), ResultSuccess());
this->HandleTransactionResult(transaction_result);
this->ClearInterruptMask();
this->interrupt_event.Reset();
return transaction_result;
}
void BusAccessor::WriteTransferHeader(TransferMode transfer_mode, I2cTransactionOption option, AddressingMode addressing_mode, u32 slave_address, size_t num_bytes) {

View file

@ -60,9 +60,7 @@ namespace sts::i2c::driver::impl {
Result Session::DoTransaction(void *dst, const void *src, size_t num_bytes, I2cTransactionOption option, Command command) {
std::scoped_lock lk(this->bus_accessor_mutex);
if (this->bus_accessor->GetBusy()) {
return ResultI2cBusBusy;
}
R_UNLESS(!this->bus_accessor->GetBusy(), i2c::ResultBusBusy());
this->bus_accessor->OnStartTransaction();
ON_SCOPE_EXIT { this->bus_accessor->OnStopTransaction(); };
@ -79,23 +77,22 @@ namespace sts::i2c::driver::impl {
STS_UNREACHABLE_DEFAULT_CASE();
}
return ResultSuccess;
return ResultSuccess();
}
Result Session::DoTransactionWithRetry(void *dst, const void *src, size_t num_bytes, I2cTransactionOption option, Command command) {
size_t i = 0;
while (true) {
R_TRY_CATCH(this->DoTransaction(dst, src, num_bytes, option, command)) {
R_CATCH(ResultI2cTimedOut) {
i++;
if (i <= this->max_retries) {
R_CATCH(i2c::ResultTimedOut) {
if ((++i) <= this->max_retries) {
svcSleepThread(this->retry_wait_time);
continue;
}
return ResultI2cBusBusy;
return i2c::ResultBusBusy();
}
} R_END_TRY_CATCH;
return ResultSuccess;
return ResultSuccess();
}
}

View file

@ -32,10 +32,8 @@ namespace sts::i2c {
}
Result CommandListFormatter::CanEnqueue(size_t size) const {
if (this->cmd_list_size - this->cur_index < size) {
return ResultI2cFullCommandList;
}
return ResultSuccess;
R_UNLESS(this->cmd_list_size - this->cur_index >= size, ResultFullCommandList());
return ResultSuccess();
}
Result CommandListFormatter::EnqueueSendCommand(I2cTransactionOption option, const void *src, size_t size) {
@ -52,7 +50,7 @@ namespace sts::i2c {
for (size_t i = 0; i < size; i++) {
this->cmd_list[this->cur_index++] = src_u8[i];
}
return ResultSuccess;
return ResultSuccess();
}
Result CommandListFormatter::EnqueueReceiveCommand(I2cTransactionOption option, size_t size) {
@ -64,7 +62,7 @@ namespace sts::i2c {
this->cur_index++;
this->cmd_list[this->cur_index++] = size;
return ResultSuccess;
return ResultSuccess();
}
Result CommandListFormatter::EnqueueSleepCommand(size_t us) {
@ -75,7 +73,7 @@ namespace sts::i2c {
this->cur_index++;
this->cmd_list[this->cur_index++] = us;
return ResultSuccess;
return ResultSuccess();
}
}