splitflap_task.cpp

/*
   Copyright 2021 Scott Bezek and the splitflap contributors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

#include <esp_task_wdt.h>

// General splitflap includes
#include "config.h"
#include "splitflap_module.h"
#include "spi_io_config.h"

// ESP32-specific includes
#include "semaphore_guard.h"
#include "task.h"
#include "splitflap_task.h"

static_assert(QCMD_FLAP + NUM_FLAPS <= 255, "Too many flaps to fit in uint8_t command structure");

SplitflapTask::SplitflapTask(const uint8_t task_core, const LedMode led_mode) : Task("Splitflap", 4096, 1, task_core), led_mode_(led_mode), state_semaphore_(xSemaphoreCreateMutex()), configuration_semaphore_(xSemaphoreCreateMutex()) {
  assert(state_semaphore_ != NULL);
  xSemaphoreGive(state_semaphore_);
  assert(configuration_semaphore_ != NULL);
  xSemaphoreGive(configuration_semaphore_);

  queue_ = xQueueCreate(5, sizeof(Command));
  assert(queue_ != NULL);
}

SplitflapTask::~SplitflapTask() {
  if (queue_ != NULL) {
    vQueueDelete(queue_);
  }
  if (state_semaphore_ != NULL) {
    vSemaphoreDelete(state_semaphore_);
  }
  if (configuration_semaphore_ != NULL) {
    vSemaphoreDelete(configuration_semaphore_);
  }
}


void SplitflapTask::run() {
    esp_err_t result = esp_task_wdt_add(NULL);
    ESP_ERROR_CHECK(result);

    initialize_modules();

    // Initialize shift registers before turning on shift register output-enable
    motor_sensor_io();

#ifdef OUTPUT_ENABLE_PIN
    pinMode(OUTPUT_ENABLE_PIN, OUTPUT);
    digitalWrite(OUTPUT_ENABLE_PIN, LOW);
#endif

#if (defined(CHAINLINK) && !defined(CHAINLINK_DRIVER_TESTER))
#if CHAINLINK_ENFORCE_LOOPBACKS
    bool loopback_result[NUM_LOOPBACKS][NUM_LOOPBACKS];
    bool loopback_off_result[NUM_LOOPBACKS];
    bool loopback_success = chainlink_test_all_loopbacks(loopback_result, loopback_off_result);

    if (!loopback_success) {
      for (uint8_t i = 0; i < NUM_LOOPBACKS; i++) {
        for (uint8_t j = 0; j < NUM_LOOPBACKS; j++) {
          if (!loopback_result[i][j]) {
            char buffer[200] = {};
            snprintf(buffer, sizeof(buffer), "Loopback ERROR. Set output %u but read incorrect value at input %u", i, j);
            log(buffer);
          }
        }
      }
      for (uint8_t j = 0; j < NUM_LOOPBACKS; j++) {
        if (!loopback_off_result[j]) {
            char buffer[200] = {};
            snprintf(buffer, sizeof(buffer), "Loopback ERROR. Loopback %u was set when all outputs off - should have been 0", j);
            log(buffer);
        }
      }

      disableAll();
    }
#else
    loopback_all_ok_ = true;
#endif

    if (led_mode_ == LedMode::AUTO) {
        for (uint8_t i = 0; i < NUM_MODULES; i++) {
            chainlink_set_led(i, 1);
            motor_sensor_io();
            delay(10);
            chainlink_set_led(i, 0);
            motor_sensor_io();
        }
        result = esp_task_wdt_reset();
        ESP_ERROR_CHECK(result);
    }
#endif

    for (uint8_t i = 0; i < NUM_MODULES; i++) {
        modules[i]->Init();
#if !defined(CHAINLINK_DRIVER_TESTER) && !defined(CHAINLINK_BASE)
        modules[i]->FindAndRecalibrateHome();
#endif
    }

    while(1) {
        processQueue();
        runUpdate();
        result = esp_task_wdt_reset();
        ESP_ERROR_CHECK(result);
    }
}

void SplitflapTask::processQueue() {
    if (xQueueReceive(queue_, &queue_receive_buffer_, 0) == pdTRUE) {
        switch (queue_receive_buffer_.command_type) {
            case CommandType::MODULES: {
                uint8_t* data = queue_receive_buffer_.data.module_command;
                bool any_leds = false;
                for (uint8_t i = 0; i < NUM_MODULES; i++) {
                    switch (data[i]) {
                        case QCMD_NO_OP:
                            // No-op
                            break;
                        case QCMD_RESET_AND_HOME:
                            modules[i]->ResetState();
                            modules[i]->FindAndRecalibrateHome();
                            break;
                        case QCMD_LED_ON:
                            any_leds = true;
    #ifdef CHAINLINK
                            chainlink_set_led(i, true);
    #endif
                            break;
                        case QCMD_LED_OFF:
                            any_leds = true;
    #ifdef CHAINLINK
                            chainlink_set_led(i, false);
    #endif
                            break;
                        case QCMD_DISABLE:
                            modules[i]->Disable();
                            break;
                        case QCMD_INCR_OFFSET_TENTH:
                            modules[i]->IncreaseOffset(1);
                            break;
                        case QCMD_INCR_OFFSET_HALF:
                            modules[i]->IncreaseOffset(5);
                            break;
                        case QCMD_SET_OFFSET:
                            modules[i]->SetOffset();
                            break;
                        default:
                            assert(data[i] >= QCMD_FLAP && data[i] < QCMD_FLAP + NUM_FLAPS);
                            modules[i]->GoToFlapIndex(data[i] - QCMD_FLAP);
                            break;
                    }
                }
                if (any_leds) {
                    motor_sensor_io();
                }
                break;
            }
            case CommandType::SENSOR_TEST_SET:
                sensor_test_ = true;
                break;
            case CommandType::SENSOR_TEST_CLEAR:
                sensor_test_ = false;
                break;
            case CommandType::CONFIG: {
                ModuleConfigs configs = queue_receive_buffer_.data.module_configs;
                for (uint8_t i = 0; i < NUM_MODULES; i++) {
                    ModuleConfig config = configs.config[i];

                    if (config.reset_nonce != current_configs_.config[i].reset_nonce) {
                        modules[i]->ResetErrorCounters();
                        modules[i]->FindAndRecalibrateHome();
                    }

                    if (config.target_flap_index != current_configs_.config[i].target_flap_index ||
                            config.target_flap_index != modules[i]->GetTargetFlapIndex() ||
                            config.movement_nonce != current_configs_.config[i].movement_nonce) {
                        if (config.target_flap_index >= NUM_FLAPS) {
                            char buffer[200] = {};
                            snprintf(buffer, sizeof(buffer), "Invalid flap index (%u) specified for module %u", config.target_flap_index, i);
                            log(buffer);
                        } else {
                            modules[i]->GoToFlapIndex(config.target_flap_index);
                        }
                    }
                }
                current_configs_ = configs;
                break;
            }
            case CommandType::SAVE_ALL_OFFSETS: {
                char buffer[200] = {};

                uint16_t offsets[NUM_MODULES];
                for (uint8_t i = 0; i < NUM_MODULES; i++) {
                    // Make sure all modules are stopped, since writing to config may take a while
                    if (modules[i]->current_accel_step != 0) {
                        snprintf(buffer, sizeof(buffer), "Can't save offsets; module %u isn't idle", i);
                        log(buffer);
                        return;
                    }

                    offsets[i] = modules[i]->GetOffset();
                }

                // Write to configuration
                Configuration* configuration;
                {
                    SemaphoreGuard lock(configuration_semaphore_);
                    configuration = configuration_;
                }
                if (configuration != nullptr) {
                    log("Saving calibration...");
                    bool success = configuration->setModuleOffsetsAndSave(offsets);
                    if (success) {
                        log("SUCCESS - saved calibration!");
                    } else {
                        log("ERROR - failed to save calibration");
                    }
                }
                break;
            }
            case CommandType::RESTORE_ALL_OFFSETS:
                for (uint8_t i = 0; i < NUM_MODULES; i++) {
                    uint16_t offset = queue_receive_buffer_.data.module_offsets[i];
                    modules[i]->RestoreOffset(offset);
                }
                break;
            default: {
                log("Unknown command");
                break;
            }
        }
    }
}

void SplitflapTask::runUpdate() {
    boolean all_idle = true;

    uint32_t iterationStartMillis = millis();

    uint32_t flashStep = iterationStartMillis / 200;
    uint32_t flashGroup = (flashStep % 16) / 2;
    uint8_t flashPhase = flashStep % 2;

    if (sensor_test_ && all_stopped_) {
      // Read sensor state
      motor_sensor_io();

#ifdef CHAINLINK
      if (led_mode_ == LedMode::AUTO) {
        for (uint8_t i = 0; i < NUM_MODULES; i++) {
          chainlink_set_led(i, modules[i]->GetHomeState());
        }
        // Output LED state
        motor_sensor_io();
      }
#endif
    } else {
      all_stopped_ = true;
      for (uint8_t i = 0; i < NUM_MODULES; i++) {
        modules[i]->Update();
        bool is_idle = modules[i]->state == PANIC
          || modules[i]->state == STATE_DISABLED
          || modules[i]->state == LOOK_FOR_HOME
          || modules[i]->state == SENSOR_ERROR
          || (modules[i]->state == NORMAL && modules[i]->current_accel_step == 0);

        bool is_stopped = modules[i]->state == PANIC
          || modules[i]->state == STATE_DISABLED
          || modules[i]->current_accel_step == 0;

#ifdef CHAINLINK
        if (led_mode_ == LedMode::AUTO) {
          chainlink_set_led(i, flashGroup < modules[i]->state && flashPhase == 0);
        }
#endif

        all_idle &= is_idle;
        all_stopped_ &= is_stopped;
      }
      motor_sensor_io();
    }


#if defined(CHAINLINK) && CHAINLINK_ENFORCE_LOOPBACKS
    // We test loopbacks iteratively, so as not to waste too many cycles/IO-roundtrips all at once. There are
    // two levels of iteration - loopback_step_index_ tracks the small intermediate steps of testing a single
    // loopback, and loopback_current_out_index_ tracks which loopback we're currently testing.
    loopback_step_index_++;
    if (loopback_step_index_ == 1) {
      chainlink_set_loopback(loopback_current_out_index_);
    } else if (loopback_step_index_ == 3) {
      bool ok = chainlink_validate_loopback(loopback_current_out_index_, nullptr);
      loopback_current_ok_ &= ok;

      if (!ok && loopback_all_ok_) {
        // Publish failures immediately
        loopback_all_ok_ = false;
        log("Loopback ERROR!");
        disableAll();
      }
    } else if (loopback_step_index_ == 50) {
      loopback_step_index_ = 0;
      loopback_current_out_index_ += 1;

      // If we've iterated through all loopbacks, save the results of this run and restart
      // from the first loopback again.
      if (loopback_current_out_index_ >= NUM_LOOPBACKS) {
        if (loopback_current_ok_ && !loopback_all_ok_) {
            log("Loopback is ok!");
        }
        loopback_all_ok_ = loopback_current_ok_;
        loopback_current_ok_ = true;
        loopback_current_out_index_ = 0;
      }
    }
    // TODO: handle loopback failures
#endif

    updateStateCache();
}

int8_t SplitflapTask::findFlapIndex(uint8_t character) {
    for (int8_t i = 0; i < NUM_FLAPS; i++) {
        if (character == flaps[i]) {
          return i;
        }
    }
    return -1;
}

void SplitflapTask::updateStateCache() {
    SplitflapState new_state;
    new_state.mode = sensor_test_ ? SplitflapMode::MODE_SENSOR_TEST : SplitflapMode::MODE_RUN;
    for (uint8_t i = 0; i < NUM_MODULES; i++) {
      new_state.modules[i].flap_index = modules[i]->GetCurrentFlapIndex();
      new_state.modules[i].state = modules[i]->state;
      new_state.modules[i].moving = modules[i]->current_accel_step > 0;
      new_state.modules[i].home_state = modules[i]->GetHomeState();
      new_state.modules[i].count_missed_home = modules[i]->count_missed_home;
      new_state.modules[i].count_unexpected_home = modules[i]->count_unexpected_home;
    }

#ifdef CHAINLINK
    new_state.loopbacks_ok = loopback_all_ok_;
#endif
    if (memcmp(&state_cache_, &new_state, sizeof(state_cache_))) {
        SemaphoreGuard lock(state_semaphore_);
        memcpy(&state_cache_, &new_state, sizeof(state_cache_));
    }
}

void SplitflapTask::log(const char* msg) {
    if (logger_ != nullptr) {
        logger_->log(msg);
    }
}

void SplitflapTask::showString(const char* str, uint8_t length, bool force_full_rotation, bool default_unspecified_home) {
    Command command = {};
    command.command_type = CommandType::MODULES;
    uint8_t num_to_update = default_unspecified_home ? NUM_MODULES : length;
    for (uint8_t i = 0; i < num_to_update && i < NUM_MODULES; i++) {
        int8_t index = i >= length ? 0 : findFlapIndex(str[i]);
        if (index != -1) {
            if (force_full_rotation || index != modules[i]->GetTargetFlapIndex()) {
                command.data.module_command[i] = QCMD_FLAP + index;
            }
        }
    }
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::resetAll() {
    Command command = {};
    command.command_type = CommandType::MODULES;
    for (uint8_t i = 0; i < NUM_MODULES; i++) {
        command.data.module_command[i] = QCMD_RESET_AND_HOME;
    }
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::disableAll() {
    Command command = {};
    command.command_type = CommandType::MODULES;
    for (uint8_t i = 0; i < NUM_MODULES; i++) {
        command.data.module_command[i] = QCMD_DISABLE;
    }
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::setLed(const uint8_t id, const bool on) {
    assert(led_mode_ == LedMode::MANUAL);

    Command command = {};
    command.command_type = CommandType::MODULES;
    command.data.module_command[id] = on ? QCMD_LED_ON : QCMD_LED_OFF;
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::setSensorTest(bool sensor_test) {
    Command command = {};
    command.command_type = sensor_test ? CommandType::SENSOR_TEST_SET : CommandType::SENSOR_TEST_CLEAR;
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

SplitflapState SplitflapTask::getState() {
    SemaphoreGuard lock(state_semaphore_);
    return state_cache_;
}

void SplitflapTask::increaseOffsetTenth(const uint8_t id) {
    Command command = {};
    command.command_type = CommandType::MODULES;
    command.data.module_command[id] = QCMD_INCR_OFFSET_TENTH;
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::increaseOffsetHalf(const uint8_t id) {
    Command command = {};
    command.command_type = CommandType::MODULES;
    command.data.module_command[id] = QCMD_INCR_OFFSET_HALF;
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::setOffset(const uint8_t id) {
    Command command = {};
    command.command_type = CommandType::MODULES;
    command.data.module_command[id] = QCMD_SET_OFFSET;
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::setConfiguration(Configuration* configuration) {
    SemaphoreGuard lock(configuration_semaphore_);
    configuration_ = configuration;
}

void SplitflapTask::setLogger(Logger* logger) {
    logger_ = logger;
}

void SplitflapTask::postRawCommand(Command command) {
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::saveAllOffsets() {
    Command command = {};
    command.command_type = CommandType::SAVE_ALL_OFFSETS;
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}

void SplitflapTask::restoreAllOffsets(uint16_t offsets[NUM_MODULES]) {
    Command command = {};
    command.command_type = CommandType::RESTORE_ALL_OFFSETS;
    for (uint8_t i = 0; i < NUM_MODULES; i++) {
        command.data.module_offsets[i] = offsets[i];
    }
    assert(xQueueSendToBack(queue_, &command, portMAX_DELAY) == pdTRUE);
}