Begin work on PABotBase2 drivers.

Author: Mysticial

SerialPrograms/Source/Controllers/ControllerConnection.h

@@ -15,7 +15,7 @@ namespace PokemonAutomation{
 
 
 
-class ControllerConnection{
+class ControllerConnection : public CancellableScope{
 public:
     struct StatusListener{
 //        virtual void pre_connection_not_ready(ControllerConnection& connection){}
@@ -32,13 +32,16 @@ class ControllerConnection{
     void remove_status_listener(StatusListener& listener);
 
 
-public:
+protected:
     ControllerConnection()
         : m_current_controller(ControllerType::None)
         , m_ready(false)
     {}
+public:
     virtual ~ControllerConnection() = default;
 
+
+public:
     ControllerType current_controller() const{
         return m_current_controller.load(std::memory_order_acquire);
     }

…PABotBase/SerialPABotBase_StatusThread.h …rce/Controllers/ControllerStatusThread.hSerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_StatusThread.h renamed to SerialPrograms/Source/Controllers/ControllerStatusThread.h SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_StatusThread.h renamed to SerialPrograms/Source/Controllers/ControllerStatusThread.h

@@ -1,26 +1,28 @@
-/*  SerialPABotBase: Status Thread Helper
+/*  Controllers: Status Thread Helper
  *
  *  From: https://github.com/PokemonAutomation/
  *
  *  This is a helper class to reuse the code for the status updater thread.
  *
  */
 
-#ifndef PokemonAutomation_SerialPABotBase_StatusThread_H
-#define PokemonAutomation_SerialPABotBase_StatusThread_H
+#ifndef PokemonAutomation_Controllers_StatusThread_H
+#define PokemonAutomation_Controllers_StatusThread_H
 
+#include "Common/Cpp/Exceptions.h"
 #include "Common/Cpp/PrettyPrint.h"
 #include "Common/Cpp/Concurrency/Mutex.h"
 #include "Common/Cpp/Concurrency/ConditionVariable.h"
+#include "Common/Cpp/Concurrency/AsyncTask.h"
+#include "Common/Cpp/Concurrency/ThreadPool.h"
 #include "CommonFramework/Tools/GlobalThreadPools.h"
-#include "SerialPABotBase_Connection.h"
+#include "Controllers/ControllerConnection.h"
 
 //#include <iostream>
 //using std::cout;
 //using std::endl;
 
 namespace PokemonAutomation{
-namespace SerialPABotBase{
 
 
 
@@ -36,7 +38,7 @@ struct ControllerStatusThreadCallback{
 class ControllerStatusThread{
 public:
     ControllerStatusThread(
-        SerialPABotBase_Connection& connection,
+        ControllerConnection& connection,
         ControllerStatusThreadCallback& callback
     )
         : m_connection(connection)
@@ -56,12 +58,9 @@ class ControllerStatusThread{
         m_scope.cancel(nullptr);
         {
             std::unique_lock<Mutex> lg(m_sleep_lock);
-            BotBaseController* botbase = m_connection.botbase();
-            if (botbase){
-                botbase->on_cancellable_cancel();
-            }
-            m_cv.notify_all();
+            m_connection.cancel();
         }
+        m_cv.notify_all();
         m_status_thread.wait_and_ignore_exceptions();
     }
 
@@ -121,11 +120,7 @@ class ControllerStatusThread{
                 last_ack.store(current_time(), std::memory_order_relaxed);
             }catch (OperationCancelledException&){
                 break;
-            }catch (InvalidConnectionStateException& e){
-                error = e.message();
-            }catch (SerialProtocolException& e){
-                error = e.message();
-            }catch (ConnectionException& e){
+            }catch (Exception& e){
                 error = e.message();
             }catch (...){
                 error = "Unknown error.";
@@ -157,7 +152,7 @@ class ControllerStatusThread{
     }
 
 private:
-    SerialPABotBase::SerialPABotBase_Connection& m_connection;
+    ControllerConnection& m_connection;
     ControllerStatusThreadCallback& m_callback;
     CancellableHolder<CancellableScope> m_scope;
     std::atomic<bool> m_stopping;
@@ -172,6 +167,5 @@ class ControllerStatusThread{
 
 
 
-}
 }
 #endif

SerialPrograms/Source/Controllers/PABotBase2/PABotBase2_Connection.h

@@ -0,0 +1,34 @@
+/*  PABotBase2 Connection
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_Controllers_PABotBase2_Connection_H
+#define PokemonAutomation_Controllers_PABotBase2_Connection_H
+
+#include <memory>
+#include "Common/Cpp/CancellableScope.h"
+#include "Controllers/ControllerConnection.h"
+#include "PABotBase2_DeviceHandle.h"
+
+namespace PokemonAutomation{
+namespace PABotBase2{
+
+
+class Connection : public ControllerConnection{
+public:
+    PABotBase2::DeviceHandle& device(){
+        return *m_device;
+    }
+
+
+protected:
+    std::unique_ptr<PABotBase2::DeviceHandle> m_device;
+};
+
+
+
+}
+}
+#endif

SerialPrograms/Source/Controllers/PABotBase2/SerialPABotBase2_Connection.h

@@ -7,23 +7,19 @@
 #ifndef PokemonAutomation_Controllers_SerialPABotBase2_Connection_H
 #define PokemonAutomation_Controllers_SerialPABotBase2_Connection_H
 
-#include "Common/Cpp/CancellableScope.h"
 #include "Common/Cpp/Concurrency/AsyncTask.h"
 #include "Common/Cpp/SerialConnection/SerialConnection.h"
 #include "Common/PABotBase2/ReliableConnectionLayer/PABotBase2CC_ReliableStreamConnection.h"
+#include "Controllers/PABotBase2/PABotBase2_Connection.h"
 #include "Controllers/SerialPABotBase/Connection/MessageLogger.h"
-#include "Controllers/ControllerConnection.h"
 #include "PABotBase2_DeviceHandle.h"
 
 namespace PokemonAutomation{
 namespace SerialPABotBase{
 
 
 
-class SerialPABotBase2_Connection final
-    : public ControllerConnection
-    , private CancellableScope
-{
+class SerialPABotBase2_Connection final : public PABotBase2::Connection{
 public:
     SerialPABotBase2_Connection(
         Logger& logger,

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.cpp

@@ -144,6 +144,15 @@ ControllerType SerialPABotBase_Connection::refresh_controller_type(){
     return current_controller;
 }
 
+bool SerialPABotBase_Connection::cancel(std::exception_ptr exception) noexcept{
+    if (ControllerConnection::cancel(std::move(exception))){
+        return true;
+    }
+    if (m_botbase){
+        m_botbase->on_cancellable_cancel();
+    }
+    return false;
+}
 
 void SerialPABotBase_Connection::add_message_printers(){
     //  Errors

SerialPrograms/Source/Controllers/SerialPABotBase/SerialPABotBase_Connection.h

@@ -23,7 +23,7 @@ namespace PokemonAutomation{
 namespace SerialPABotBase{
 
 
-class SerialPABotBase_Connection : public ControllerConnection{
+class SerialPABotBase_Connection final : public ControllerConnection{
 public:
     SerialPABotBase_Connection(
         Logger& logger,
@@ -50,6 +50,8 @@ class SerialPABotBase_Connection : public ControllerConnection{
 
     ControllerType refresh_controller_type();
 
+    virtual bool cancel(std::exception_ptr exception = nullptr) noexcept override;
+
 
 private:
     void add_message_printers();

SerialPrograms/Source/Controllers/StandardHid/StandardHid_Keyboard_SerialPABotBase.cpp

@@ -60,7 +60,7 @@ SerialPABotBase_Keyboard::SerialPABotBase_Keyboard(
         throw SerialProtocolException(logger, PA_CURRENT_FUNCTION, "Failed to set controller type.");
     }
 
-    m_status_thread.reset(new SerialPABotBase::ControllerStatusThread(
+    m_status_thread.reset(new ControllerStatusThread(
         connection, *this
     ));
 }

SerialPrograms/Source/Controllers/StandardHid/StandardHid_Keyboard_SerialPABotBase.h

@@ -7,8 +7,8 @@
 #ifndef PokemonAutomation_StandardHid_Keyboard_SerialPABotBase_H
 #define PokemonAutomation_StandardHid_Keyboard_SerialPABotBase_H
 
+#include "Controllers/ControllerStatusThread.h"
 #include "Controllers/SerialPABotBase/SerialPABotBase_Connection.h"
-#include "Controllers/SerialPABotBase/SerialPABotBase_StatusThread.h"
 #include "StandardHid_Keyboard.h"
 #include "StandardHid_KeyboardWithScheduler.h"
 
@@ -20,7 +20,7 @@ namespace StandardHid{
 class SerialPABotBase_Keyboard final :
     public Keyboard,
     public KeyboardControllerWithScheduler,
-    private SerialPABotBase::ControllerStatusThreadCallback
+    private ControllerStatusThreadCallback
 {
 public:
     using ContextType = KeyboardContext;
@@ -135,7 +135,7 @@ class SerialPABotBase_Keyboard final :
 
     std::map<uint64_t, KeyboardKey> m_last_state;
 
-    std::unique_ptr<SerialPABotBase::ControllerStatusThread> m_status_thread;
+    std::unique_ptr<ControllerStatusThread> m_status_thread;
 };
 
 

SerialPrograms/Source/NintendoSwitch/Controllers/PABotBase2/NintendoSwitch_PABotBase2_Controller.cpp

@@ -0,0 +1,72 @@
+/*  PABotBase2: Controller
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#include "Common/Cpp/Exceptions.h"
+#include "NintendoSwitch_PABotBase2_Controller.h"
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+
+
+void PABotBase2_Controller::stop_with_error(std::string error_message) noexcept{
+    try{
+        WriteSpinLock lg(m_error_lock);
+        m_error_string = error_message;
+    }catch (...){}
+    m_connection.cancel();
+    m_connection.set_status_line1(std::move(error_message), COLOR_RED);
+}
+
+
+std::string PABotBase2_Controller::error_string() const{
+    ReadSpinLock lg(m_error_lock);
+    return m_error_string;
+}
+
+void PABotBase2_Controller::cancel_all_commands(){
+    std::lock_guard<Mutex> lg(m_state_lock);
+    if (!is_ready()){
+        throw InvalidConnectionStateException(error_string());
+    }
+    m_connection.device().command_queue().send_cancel();
+    m_scheduler.clear_on_next();
+}
+void PABotBase2_Controller::replace_on_next_command(){
+    std::lock_guard<Mutex> lg(m_state_lock);
+    if (!is_ready()){
+        throw InvalidConnectionStateException(error_string());
+    }
+    m_connection.device().command_queue().send_replace_on_next();
+    m_scheduler.clear_on_next();
+}
+
+
+void PABotBase2_Controller::wait_for_all(Cancellable* cancellable){
+    SuperscalarScheduler::Schedule schedule;
+    std::lock_guard<Mutex> lg0(m_issue_lock);
+    {
+        std::lock_guard<Mutex> lg1(m_state_lock);
+
+        ThrottleScope scope(m_logging_throttler);
+        if (scope){
+            m_logger.log("wait_for_all()", COLOR_DARKGREEN);
+        }
+
+        if (!is_ready()){
+            throw InvalidConnectionStateException(error_string());
+        }
+
+        m_scheduler.issue_wait_for_all(schedule);
+    }
+    execute_schedule(cancellable, schedule);
+    m_connection.device().command_queue().wait_for_all();
+}
+
+
+
+
+}
+}

SerialPrograms/Source/NintendoSwitch/Controllers/PABotBase2/NintendoSwitch_PABotBase2_Controller.h

@@ -0,0 +1,56 @@
+/*  PABotBase2: Controller
+ *
+ *  From: https://github.com/PokemonAutomation/
+ *
+ */
+
+#ifndef PokemonAutomation_NintendoSwitch_PABotBase2_Controller_H
+#define PokemonAutomation_NintendoSwitch_PABotBase2_Controller_H
+
+#include "Controllers/PABotBase2/PABotBase2_Connection.h"
+#include "NintendoSwitch/Controllers/NintendoSwitch_ControllerWithScheduler.h"
+
+namespace PokemonAutomation{
+namespace NintendoSwitch{
+
+
+
+class PABotBase2_Controller : public ControllerWithScheduler{
+public:
+    PABotBase2_Controller(
+        Logger& logger,
+        PABotBase2::Connection& connection
+    )
+        : ControllerWithScheduler(logger)
+        , m_connection(connection)
+    {}
+
+    void stop_with_error(std::string error_message) noexcept;
+
+    bool is_ready() const{
+        return m_connection.is_ready();
+    }
+    std::string error_string() const;
+
+
+public:
+    void cancel_all_commands();
+    void replace_on_next_command();
+
+    void wait_for_all(Cancellable* cancellable);
+
+
+protected:
+    //  These are set on construction and never changed again. So it is safe to
+    //  access these asynchronously.
+    PABotBase2::Connection& m_connection;
+
+    mutable SpinLock m_error_lock;
+    std::string m_error_string;
+};
+
+
+
+}
+}
+#endif