// Copyright (c) FIRST and other WPILib contributors. // Open Source Software; you can modify and/or share it under the terms of // the WPILib BSD license file in the root directory of this project. #include "wpi/hal/DriverStation.h" #ifdef __APPLE__ #include #endif #include #include #include #include #include #include #include "HALInitializer.h" #include "mockdata/DriverStationDataInternal.h" #include "wpi/hal/DriverStationTypes.h" #include "wpi/hal/Errors.h" #include "wpi/hal/cpp/fpga_clock.h" #include "wpi/hal/simulation/MockHooks.h" #include "wpi/util/EventVector.hpp" #include "wpi/util/mutex.hpp" #include "wpi/util/string.h" static wpi::util::mutex msgMutex; static std::atomic sendErrorHandler{nullptr}; static std::atomic sendConsoleLineHandler{ nullptr}; using namespace wpi::hal; static constexpr int kJoystickPorts = 6; namespace { struct JoystickDataCache { JoystickDataCache() { std::memset(this, 0, sizeof(*this)); } void Update(); HAL_JoystickAxes axes[kJoystickPorts]; HAL_JoystickPOVs povs[kJoystickPorts]; HAL_JoystickButtons buttons[kJoystickPorts]; HAL_JoystickTouchpads touchpads[kJoystickPorts]; HAL_AllianceStationID allianceStation; double matchTime; HAL_ControlWord controlWord; HAL_GameData gameData; }; static_assert(std::is_standard_layout_v); // static_assert(std::is_trivial_v); static std::atomic_bool gShutdown{false}; struct FRCDriverStation { ~FRCDriverStation() { gShutdown = true; } wpi::util::EventVector newDataEvents; wpi::util::mutex cacheMutex; wpi::util::mutex tcpCacheMutex; }; } // namespace void JoystickDataCache::Update() { for (int i = 0; i < kJoystickPorts; i++) { SimDriverStationData->GetJoystickAxes(i, &axes[i]); SimDriverStationData->GetJoystickPOVs(i, &povs[i]); SimDriverStationData->GetJoystickButtons(i, &buttons[i]); SimDriverStationData->GetJoystickTouchpads(i, &touchpads[i]); } allianceStation = SimDriverStationData->allianceStationId; matchTime = SimDriverStationData->matchTime; controlWord = HAL_MakeControlWord( SimDriverStationData->opMode, SimDriverStationData->robotMode, SimDriverStationData->enabled, SimDriverStationData->eStop, SimDriverStationData->fmsAttached, SimDriverStationData->dsAttached); SimDriverStationData->GetGameData(&gameData); } #define CHECK_JOYSTICK_NUMBER(stickNum) \ if ((stickNum) < 0 || (stickNum) >= HAL_kMaxJoysticks) \ return PARAMETER_OUT_OF_RANGE static HAL_ControlWord newestControlWord; static JoystickDataCache caches[3]; static JoystickDataCache* currentRead = &caches[0]; static JoystickDataCache* currentReadLocal = &caches[0]; static std::atomic currentCache{nullptr}; static JoystickDataCache* lastGiven = &caches[1]; static JoystickDataCache* cacheToUpdate = &caches[2]; namespace { struct TcpCache { TcpCache() { std::memset(this, 0, sizeof(*this)); } void Update(); void CloneTo(TcpCache* other) { std::memcpy(other, this, sizeof(*this)); } HAL_MatchInfo matchInfo; HAL_JoystickDescriptor descriptors[HAL_kMaxJoysticks]; }; static_assert(std::is_standard_layout_v); } // namespace static TcpCache tcpCache; static TcpCache tcpCurrent; void TcpCache::Update() { SimDriverStationData->GetMatchInfo(&matchInfo); for (int i = 0; i < HAL_kMaxJoysticks; i++) { SimDriverStationData->GetJoystickDescriptor(i, &descriptors[i]); } } static ::FRCDriverStation* driverStation; namespace wpi::hal::init { void InitializeDriverStation() { static FRCDriverStation ds; driverStation = &ds; } } // namespace wpi::hal::init namespace wpi::hal { static void DefaultPrintErrorImpl(const char* line, size_t size) { std::fwrite(line, size, 1, stderr); } } // namespace wpi::hal static std::atomic gPrintErrorImpl{ wpi::hal::DefaultPrintErrorImpl}; extern "C" { void HALSIM_SetSendError(HALSIM_SendErrorHandler handler) { sendErrorHandler.store(handler); } void HALSIM_SetSendConsoleLine(HALSIM_SendConsoleLineHandler handler) { sendConsoleLineHandler.store(handler); } int32_t HAL_SendError(HAL_Bool isError, int32_t errorCode, HAL_Bool isLVCode, const char* details, const char* location, const char* callStack, HAL_Bool printMsg) { auto errorHandler = sendErrorHandler.load(); if (errorHandler) { return errorHandler(isError, errorCode, isLVCode, details, location, callStack, printMsg); } // Avoid flooding console by keeping track of previous 5 error // messages and only printing again if they're longer than 1 second old. static constexpr int KEEP_MSGS = 5; std::scoped_lock lock(msgMutex); static std::string prevMsg[KEEP_MSGS]; static fpga_clock::time_point prevMsgTime[KEEP_MSGS]; static bool initialized = false; if (!initialized) { for (int i = 0; i < KEEP_MSGS; i++) { prevMsgTime[i] = fpga_clock::now() - std::chrono::seconds(2); } initialized = true; } auto curTime = fpga_clock::now(); int i; for (i = 0; i < KEEP_MSGS; ++i) { if (prevMsg[i] == details) { break; } } int retval = 0; if (i == KEEP_MSGS || (curTime - prevMsgTime[i]) >= std::chrono::seconds(1)) { printMsg = true; if (printMsg) { fmt::memory_buffer buf; if (location && location[0] != '\0') { fmt::format_to(fmt::appender{buf}, "{} at {}: ", isError ? "Error" : "Warning", location); } fmt::format_to(fmt::appender{buf}, "{}\n", details); if (callStack && callStack[0] != '\0') { fmt::format_to(fmt::appender{buf}, "{}\n", callStack); } auto printError = gPrintErrorImpl.load(); printError(buf.data(), buf.size()); } if (i == KEEP_MSGS) { // replace the oldest one i = 0; auto first = prevMsgTime[0]; for (int j = 1; j < KEEP_MSGS; ++j) { if (prevMsgTime[j] < first) { first = prevMsgTime[j]; i = j; } } prevMsg[i] = details; } prevMsgTime[i] = curTime; } return retval; } void HAL_SetPrintErrorImpl(void (*func)(const char* line, size_t size)) { gPrintErrorImpl.store(func ? func : wpi::hal::DefaultPrintErrorImpl); } int32_t HAL_SendConsoleLine(const char* line) { auto handler = sendConsoleLineHandler.load(); if (handler) { return handler(line); } std::puts(line); std::fflush(stdout); return 0; } int32_t HAL_GetControlWord(HAL_ControlWord* controlWord) { if (gShutdown) { controlWord->value = 0; return INCOMPATIBLE_STATE; } std::scoped_lock lock{driverStation->cacheMutex}; *controlWord = newestControlWord; return 0; } int32_t HAL_GetUncachedControlWord(HAL_ControlWord* controlWord) { if (gShutdown) { controlWord->value = 0; return INCOMPATIBLE_STATE; } bool dsAttached = SimDriverStationData->dsAttached; if (dsAttached) { *controlWord = HAL_MakeControlWord( SimDriverStationData->opMode, SimDriverStationData->robotMode, SimDriverStationData->enabled, SimDriverStationData->eStop, SimDriverStationData->fmsAttached, SimDriverStationData->dsAttached); } else { controlWord->value = 0; } return 0; } int32_t HAL_SetOpModeOptions(const struct HAL_OpModeOption* options, int32_t count) { if (gShutdown) { return 0; } if (count < 0 || count > 1000 || (count != 0 && !options)) { return PARAMETER_OUT_OF_RANGE; } SimDriverStationData->SetOpModeOptions({options, options + count}); return 0; } HAL_AllianceStationID HAL_GetAllianceStation(int32_t* status) { if (gShutdown) { return HAL_AllianceStationID_kUnknown; } std::scoped_lock lock{driverStation->cacheMutex}; return currentRead->allianceStation; } int32_t HAL_GetJoystickAxes(int32_t joystickNum, HAL_JoystickAxes* axes) { if (gShutdown) { return INCOMPATIBLE_STATE; } CHECK_JOYSTICK_NUMBER(joystickNum); std::scoped_lock lock{driverStation->cacheMutex}; *axes = currentRead->axes[joystickNum]; return 0; } int32_t HAL_GetJoystickPOVs(int32_t joystickNum, HAL_JoystickPOVs* povs) { if (gShutdown) { return INCOMPATIBLE_STATE; } CHECK_JOYSTICK_NUMBER(joystickNum); std::scoped_lock lock{driverStation->cacheMutex}; *povs = currentRead->povs[joystickNum]; return 0; } int32_t HAL_GetJoystickButtons(int32_t joystickNum, HAL_JoystickButtons* buttons) { if (gShutdown) { return INCOMPATIBLE_STATE; } CHECK_JOYSTICK_NUMBER(joystickNum); std::scoped_lock lock{driverStation->cacheMutex}; *buttons = currentRead->buttons[joystickNum]; return 0; } int32_t HAL_GetJoystickTouchpads(int32_t joystickNum, HAL_JoystickTouchpads* touchpads) { if (gShutdown) { return INCOMPATIBLE_STATE; } CHECK_JOYSTICK_NUMBER(joystickNum); std::scoped_lock lock{driverStation->cacheMutex}; *touchpads = currentRead->touchpads[joystickNum]; return 0; } void HAL_GetAllJoystickData(int32_t joystickNum, HAL_JoystickAxes* axes, HAL_JoystickPOVs* povs, HAL_JoystickButtons* buttons, HAL_JoystickTouchpads* touchpads) { if (gShutdown) { return; } std::scoped_lock lock{driverStation->cacheMutex}; *axes = currentRead->axes[joystickNum]; *povs = currentRead->povs[joystickNum]; *buttons = currentRead->buttons[joystickNum]; *touchpads = currentRead->touchpads[joystickNum]; } int32_t HAL_GetJoystickDescriptor(int32_t joystickNum, HAL_JoystickDescriptor* desc) { CHECK_JOYSTICK_NUMBER(joystickNum); std::scoped_lock lock{driverStation->tcpCacheMutex}; *desc = tcpCurrent.descriptors[joystickNum]; return 0; } HAL_Bool HAL_GetJoystickIsGamepad(int32_t joystickNum) { HAL_JoystickDescriptor joystickDesc; if (HAL_GetJoystickDescriptor(joystickNum, &joystickDesc) < 0) { return 0; } else { return joystickDesc.isGamepad; } } int32_t HAL_GetJoystickGamepadType(int32_t joystickNum) { HAL_JoystickDescriptor joystickDesc; if (HAL_GetJoystickDescriptor(joystickNum, &joystickDesc) < 0) { return -1; } else { return joystickDesc.gamepadType; } } int32_t HAL_GetGameData(HAL_GameData* gameData) { if (gShutdown) { return INCOMPATIBLE_STATE; } std::scoped_lock lock{driverStation->cacheMutex}; *gameData = currentRead->gameData; return 0; } int32_t HAL_GetJoystickSupportedOutputs(int32_t joystickNum) { HAL_JoystickDescriptor joystickDesc; if (HAL_GetJoystickDescriptor(joystickNum, &joystickDesc) < 0) { return -1; } else { return joystickDesc.supportedOutputs; } } void HAL_GetJoystickName(struct WPI_String* name, int32_t joystickNum) { HAL_JoystickDescriptor joystickDesc; const char* cName = joystickDesc.name; if (HAL_GetJoystickDescriptor(joystickNum, &joystickDesc) < 0) { cName = ""; } auto len = std::strlen(cName); auto write = WPI_AllocateString(name, len); std::memcpy(write, cName, len); } int32_t HAL_SetJoystickRumble(int32_t joystickNum, int32_t leftRumble, int32_t rightRumble, int32_t leftTriggerRumble, int32_t rightTriggerRumble) { SimDriverStationData->SetJoystickRumbles(joystickNum, leftRumble, rightRumble, leftTriggerRumble, rightTriggerRumble); return 0; } int32_t HAL_SetJoystickLeds(int32_t joystickNum, int32_t leds) { SimDriverStationData->SetJoystickLeds(joystickNum, leds); return 0; } double HAL_GetMatchTime(int32_t* status) { if (gShutdown) { return 0; } std::scoped_lock lock{driverStation->cacheMutex}; return currentRead->matchTime; } int32_t HAL_GetMatchInfo(HAL_MatchInfo* info) { std::scoped_lock lock{driverStation->tcpCacheMutex}; *info = tcpCurrent.matchInfo; return 0; } void HAL_ObserveUserProgramStarting(void) { HALSIM_SetProgramStarted(true); } void HAL_ObserveUserProgram(HAL_ControlWord word) { HALSIM_SetProgramState(word); } HAL_Bool HAL_RefreshDSData(void) { if (gShutdown) { return false; } bool dsAttached = SimDriverStationData->dsAttached; JoystickDataCache* prev; { std::scoped_lock lock{driverStation->cacheMutex}; prev = currentCache.exchange(nullptr); if (prev != nullptr) { currentRead = prev; } // If newest state shows we have a DS attached, just use the // control word out of the cache, As it will be the one in sync // with the data. If no data has been updated, at this point, // and a DS wasn't attached previously, this will still return // a zeroed out control word, with is the correct state for // no new data. if (!dsAttached) { // If the DS is not attached, we need to zero out the control word. // This is because HAL_RefreshDSData is called asynchronously from // the DS data. The dsAttached variable comes directly from netcomm // and could be updated before the caches are. If that happens, // we would end up returning the previous cached control word, // which is out of sync with the current control word and could // break invariants such as which alliance station is in used. // Also, when the DS has never been connected the rest of the fields // in control word are garbage, so we also need to zero out in that // case too currentRead->controlWord.value = 0; } newestControlWord = currentRead->controlWord; } { tcpCache.Update(); std::scoped_lock tcpLock(driverStation->tcpCacheMutex); tcpCache.CloneTo(&tcpCurrent); } return prev != nullptr; } void HAL_ProvideNewDataEventHandle(WPI_EventHandle handle) { if (gShutdown) { return; } wpi::hal::init::CheckInit(); driverStation->newDataEvents.Add(handle); } void HAL_RemoveNewDataEventHandle(WPI_EventHandle handle) { if (gShutdown) { return; } driverStation->newDataEvents.Remove(handle); } HAL_Bool HAL_GetOutputsEnabled(void) { if (gShutdown) { return false; } std::scoped_lock lock{driverStation->cacheMutex}; return HAL_ControlWord_IsEnabled(newestControlWord) && HAL_ControlWord_IsDSAttached(newestControlWord); } } // extern "C" namespace wpi::hal { void NewDriverStationData() { if (gShutdown) { return; } SimDriverStationData->dsAttached = true; cacheToUpdate->Update(); JoystickDataCache* given = cacheToUpdate; JoystickDataCache* prev = currentCache.exchange(cacheToUpdate); if (prev == nullptr) { cacheToUpdate = currentReadLocal; currentReadLocal = lastGiven; } else { // Current read local does not update cacheToUpdate = prev; } lastGiven = given; driverStation->newDataEvents.Wakeup(); SimDriverStationData->CallNewDataCallbacks(); } void InitializeDriverStation() { SimDriverStationData->ResetData(); } } // namespace wpi::hal