Replace fnUART* classes and switch to IOChannel abstraction (FujiNetWIFI#1038)

New abstraction supports any streaming I/O type (serial, network, USB)
with a single consistent API.

Author: FozzTexx

fujinet_pc.cmake

@@ -270,10 +270,7 @@ if(FUJINET_TARGET STREQUAL "ATARI")
     list(APPEND SOURCES
 
     lib/bus/sio/sio.h lib/bus/sio/sio.cpp
-    lib/bus/sio/siocom/sioport.h lib/bus/sio/siocom/sioport.cpp
-    lib/bus/sio/siocom/serialsio.h lib/bus/sio/siocom/serialsio.cpp
-    lib/bus/sio/siocom/netsio.h lib/bus/sio/siocom/netsio.cpp
-    lib/bus/sio/siocom/fnSioCom.h lib/bus/sio/siocom/fnSioCom.cpp
+    lib/bus/sio/NetSIO.h lib/bus/sio/NetSIO.cpp
     lib/media/atari/diskType.h lib/media/atari/diskType.cpp
     lib/media/atari/diskTypeAtr.h lib/media/atari/diskTypeAtr.cpp
     lib/media/atari/diskTypeAtx.h lib/media/atari/diskTypeAtx.cpp

include/debug.h

@@ -23,7 +23,7 @@
 #ifdef DEBUG
 #ifdef ESP_PLATFORM
     // Use FujiNet debug serial output
-    #include "../lib/hardware/UARTChannel.h"
+    #include "../lib/hardware/ESP32UARTChannel.h"
     #define Serial fnDebugConsole
 #ifdef PINMAP_RS232_S3
     #define Debug_print(...) printf( __VA_ARGS__ )

lib/bus/adamnet/adamnet.cpp

@@ -332,7 +332,9 @@ void systemBus::setup()
     gpio_isr_handler_add((gpio_num_t)PIN_ADAMNET_RESET, adamnet_reset_isr_handler, (void *)PIN_CARD_DETECT_FIX);
 
     // Set up UART
-    _port.begin(ADAMNET_BAUDRATE);
+    _port.begin(ChannelConfig()
+                .baud(ADAMNET_BAUDRATE)
+                );
 }
 
 void systemBus::shutdown()

lib/bus/adamnet/adamnet.h

@@ -5,7 +5,7 @@
  * AdamNet Routines
  */
 
-#include "fnUART.h"
+#include "UARTChannel.h"
 #include <freertos/FreeRTOS.h>
 #include <freertos/queue.h>
 
@@ -247,7 +247,7 @@ class systemBus
     adamFuji *_fujiDev = nullptr;
     adamPrinter *_printerDev = nullptr;
 
-    UARTManager _port = UARTManager(FN_UART_BUS);
+    UARTChannel _port;
 
     void _adamnet_process_cmd();
     void _adamnet_process_queue();
@@ -285,12 +285,12 @@ class systemBus
 
     // Everybody thinks "oh I know how a serial port works, I'll just
     // access it directly and bypass the bus!" ಠ_ಠ
-    size_t read(void *buffer, size_t length) { return _port.readBytes(buffer, length); }
+    size_t read(void *buffer, size_t length) { return _port.read(buffer, length); }
     size_t read() { return _port.read(); }
     size_t write(const void *buffer, size_t length) { return _port.write(buffer, length); }
     size_t write(int n) { return _port.write(n); }
     size_t available() { return _port.available(); }
-    void flush() { _port.flush(); }
+    void flush() { _port.flushOutput(); }
     size_t print(int n, int base = 10) { return _port.print(n, base); }
     size_t print(const char *str) { return _port.print(str); }
     size_t print(const std::string &str) { return _port.print(str); }

lib/bus/drivewire/BeckerSocket.cpp

@@ -43,7 +43,6 @@ BeckerSocket::BeckerSocket() :
     _host(""),
     _ip(IPADDR_NONE),
     _port(BECKER_DEFAULT_PORT),
-    _baud(DW_DEFAULT_BAUD),     // not used by Becker
     _listening(true),
     _fd(-1),
     _listen_fd(-1),
@@ -62,7 +61,6 @@ void BeckerSocket::begin(std::string host, int baud)
         end();
 
     _host = host;
-    _baud = baud;
     read_timeout_ms = 500;
 
     // listen or connect
@@ -94,7 +92,7 @@ void BeckerSocket::end()
 /* Clears input buffer and flushes out transmit buffer waiting at most
    waiting MAX_FLUSH_WAIT_TICKS until all sends are completed
 */
-void BeckerSocket::flush()
+void BeckerSocket::flushOutput()
 {
     // only in connected state
     if (_state != BeckerConnected)
@@ -671,8 +669,10 @@ size_t BeckerSocket::dataOut(const void *buffer, size_t size)
     return result;
 }
 
-//
-// Becker state handlers
-//
+void BeckerSocket::setHost(std::string host, int port)
+{
+    _host = host;
+    _port = port;
+}
 
 #endif // BUILD_COCO

lib/bus/drivewire/BeckerSocket.h

@@ -23,8 +23,6 @@ class BeckerSocket : public IOChannel
     in_addr_t _ip;
     uint16_t _port;
 
-    uint32_t _baud;     // not used by Becker
-
     // is waiting for connection (listening) or connecting to?
     bool _listening;
 
@@ -74,15 +72,9 @@ class BeckerSocket : public IOChannel
     void begin(std::string host, int baud);
     void end() override;
 
-    void setBaudrate(uint32_t baud) override { _baud = baud; }
-    uint32_t getBaudrate() override { return _baud; }
-
-    bool getDTR() { return false; }
-    void setDSR(bool state) { return; }
-    bool getRTS() { return false; }
-    void setCTS(bool state) { return; }
+    void flushOutput() override;
 
-    void flush() override;
+    void setHost(std::string host, int port);
 };
 
 #endif // BECKERSOCKET_H

lib/bus/drivewire/drivewire.cpp

@@ -158,11 +158,11 @@ void systemBus::op_readex()
         {
             size_t bytesrd;
             Debug_printf("op_readex: open successful %s\r\n", szNamedMount);
-            
+
             memset(blk_buffer,0,MEDIA_BLOCK_SIZE);
             bytesrd = fread(blk_buffer,1,MEDIA_BLOCK_SIZE,pNamedObjFp);
             if (bytesrd!=MEDIA_BLOCK_SIZE || feof(pNamedObjFp))
-            {   
+            {
                 Debug_printf("op_readex: closed named object %s\r\n",szNamedMount);
                 fclose(pNamedObjFp);
                 pNamedObjFp = NULL;
@@ -173,12 +173,12 @@ void systemBus::op_readex()
         else
         {
             Debug_printf("op_readex: open failed %s\r\n", szNamedMount);
-            fnDwCom.write(0xF4);
+            _port->write(0xF4);
             return;
         }
     }
     else
-    {        
+    {
         if (true==bDragon && drive_num>=5) drive_num = drive_num-5;
     Debug_printf("OP_READ: DRIVE %3u - SECTOR %8lu\n", drive_num, lsn);
 
@@ -211,16 +211,16 @@ void systemBus::op_readex()
                 blk_size = MEDIA_BLOCK_SIZE;
                 use_media_buffer = false;
             }
-    
+
             if (bDragon)
             {
                 Debug_printf("dragon read\n");
                 if (d->read(lsn, sector_data))
                 {
                     Debug_printf("Read error\n");
-                    fnDwCom.write(0xF4);
-                    fnDwCom.flush();
-                    fnDwCom.flush_input();
+                    _port->write(0xF4);
+                    _port->flushOutput();
+                    _port->discardInput();
                     return;
                 }
             }
@@ -662,44 +662,25 @@ void systemBus::service()
         _port->setDSR(!hasUpdate);
     }
 
-    if (fnDwCom.available())
+    if (_port->available())
         _drivewire_process_cmd();
 
     // dload.dload_process();
 }
 
-// Setup DRIVEWIRE bus
-void systemBus::setup()
-{
 #ifdef ESP_PLATFORM
-    // Create a queue to handle parallel event from ISR
-    drivewire_evt_queue = xQueueCreate(10, sizeof(uint32_t));
-    bDragon = false;
-
-    // Start task
-    // xTaskCreate(drivewire_intr_task, "drivewire_intr_task", 2048, NULL, 10, NULL);
-    // xTaskCreatePinnedToCore(drivewire_intr_task, "drivewire_intr_task", 4096, this, 10, NULL, 0);
-
-#ifdef CONFIG_IDF_TARGET_ESP32S3
-// Configure UART to RP2040
-#ifdef FORCE_UART_BAUD
-        Debug_printv("FORCE_UART_BAUD set to %u", FORCE_UART_BAUD);
-        _drivewireBaud = FORCE_UART_BAUD;
-#else /* !FORCE_UART_BAUD */
-        _drivewireBaud = 115200;
-#endif /* FORCE_UART_BAUD */
-
-#else /* !CONFIG_IDF_TARGET_ESP32S3 */
-        // Setup interrupt for cassette motor pin
-        gpio_config_t io_conf = {
-                .pin_bit_mask = (1ULL << PIN_CASS_MOTOR), // bit mask of the pins that you want to set
+void systemBus::configureGPIO()
+{
+    // Setup interrupt for cassette motor pin
+    gpio_config_t io_conf = {
+        .pin_bit_mask = (1ULL << PIN_CASS_MOTOR), // bit mask of the pins that you want to set
         .mode = GPIO_MODE_INPUT,                  // set as input mode
         .pull_up_en = GPIO_PULLUP_DISABLE,        // disable pull-up mode
         .pull_down_en = GPIO_PULLDOWN_ENABLE,     // enable pull-down mode
         .intr_type = GPIO_INTR_POSEDGE            // interrupt on positive edge
-        };
+    };
 
-        _cassetteDev = new drivewireCassette();
+    _cassetteDev = new drivewireCassette();
 
     // configure GPIO with the given settings
     gpio_config(&io_conf);
@@ -718,46 +699,78 @@ void systemBus::setup()
     fnSystem.set_pin_mode(PIN_EPROM_A14, gpio_mode_t::GPIO_MODE_INPUT, SystemManager::pull_updown_t::PULL_NONE);
     fnSystem.set_pin_mode(PIN_EPROM_A15, gpio_mode_t::GPIO_MODE_INPUT, SystemManager::pull_updown_t::PULL_NONE);
 
-#ifdef FORCE_UART_BAUD
-        Debug_printv("FORCE_UART_BAUD set to %u",FORCE_UART_BAUD);
-        _drivewireBaud = FORCE_UART_BAUD;
-#else /* !FORCE_UART_BAUD */
-    if (fnSystem.digital_read(PIN_EPROM_A14) == DIGI_LOW && fnSystem.digital_read(PIN_EPROM_A15) == DIGI_LOW)
+    return;
+}
+
+int systemBus::readBaudSwitch()
+{
+    if (fnSystem.digital_read(PIN_EPROM_A14) == DIGI_LOW
+        && fnSystem.digital_read(PIN_EPROM_A15) == DIGI_LOW)
     {
-        _drivewireBaud = 38400; //Coco1 ROM Image
         Debug_printv("A14 Low, A15 Low, 38400 baud");
+        return 38400; //Coco1 ROM Image
     }
-    else if (fnSystem.digital_read(PIN_EPROM_A14) == DIGI_HIGH && fnSystem.digital_read(PIN_EPROM_A15) == DIGI_LOW)
+
+    if (fnSystem.digital_read(PIN_EPROM_A14) == DIGI_HIGH
+             && fnSystem.digital_read(PIN_EPROM_A15) == DIGI_LOW)
     {
-        _drivewireBaud = 57600; //Coco2 ROM Image
         Debug_printv("A14 High, A15 Low, 57600 baud");
+        return 57600; //Coco2 ROM Image
     }
-    else if  (fnSystem.digital_read(PIN_EPROM_A14) == DIGI_LOW && fnSystem.digital_read(PIN_EPROM_A15) == DIGI_HIGH)
+
+    if  (fnSystem.digital_read(PIN_EPROM_A14) == DIGI_LOW
+              && fnSystem.digital_read(PIN_EPROM_A15) == DIGI_HIGH)
     {
-        _drivewireBaud = 115200; //Coco3 ROM Image
         Debug_printv("A14 Low, A15 High, 115200 baud");
+        return 115200; //Coco3 ROM Image
     }
-    else
-    {
-        _drivewireBaud = 57600; // Dragon
-        bDragon = true;
-        Debug_printv("A14 and A15 High, (DRAGON) 57600 baud");
-    }
 
-#endif /* FORCE_UART_BAUD */
+    Debug_printv("A14 and A15 High, defaulting to 57600 baud");
+    return 57600; //Default or no switch
+}
+#endif /* ESP_PLATFORM */
+
+// Setup DRIVEWIRE bus
+void systemBus::setup()
+{
+#ifdef ESP_PLATFORM
+    // Create a queue to handle parallel event from ISR
+    drivewire_evt_queue = xQueueCreate(10, sizeof(uint32_t));
+    bDragon = false;
+
+#ifdef CONFIG_IDF_TARGET_ESP32S3
+    // Configure UART to RP2040
+  #ifdef FORCE_UART_BAUD
+    Debug_printv("FORCE_UART_BAUD set to %u", FORCE_UART_BAUD);
+    _drivewireBaud = FORCE_UART_BAUD;
+  #else /* !FORCE_UART_BAUD */
+    _drivewireBaud = 115200;
+  #endif /* FORCE_UART_BAUD */
+
+#else /* ! CONFIG_IDF_TARGET_ESP32S3 */
+    configureGPIO();
+  #ifdef FORCE_UART_BAUD
+    Debug_printv("FORCE_UART_BAUD set to %u",FORCE_UART_BAUD);
+    _drivewireBaud = FORCE_UART_BAUD;
+  #else /* !FORCE_UART_BAUD */
+    _drivewireBaud = readBaudSwitch();
+  #endif /* FORCE_UART_BAUD */
 #endif /* CONFIG_IDF_TARGET_ESP32S3 */
 #else /* !ESP_PLATFORM */
     // FujiNet-PC specific
     _drivewireBaud = Config.get_serial_baud();
 #endif /* !ESP_PLATFORM */
+
     if (Config.get_boip_enabled())
     {
         _becker.begin(Config.get_boip_host(), _drivewireBaud);
         _port = &_becker;
     }
     else
     {
-        _serial.begin(ChannelConfig().baud(_drivewireBaud).deviceID(DW_UART_DEVICE)
+        _serial.begin(ChannelConfig()
+                      .baud(_drivewireBaud)
+                      .deviceID(DW_UART_DEVICE)
                       .readTimeout(500)
 #ifdef ESP_PLATFORM
                       .inverted(DW_UART_DEVICE == UART_NUM_2)
@@ -768,10 +781,8 @@ void systemBus::setup()
 
     _port->discardInput();
     Debug_printv("DRIVEWIRE MODE");
-    szNamedMount[0]=(uint8_t)0;
-    pNamedObjFp = NULL;
 
-// jeff hack to see if the S3 is getting serial data
+    // jeff hack to see if the S3 is getting serial data
     // Debug_println("now receiving data...");
     // uint8_t b[] = {' '};
     // while(1)
@@ -782,7 +793,7 @@ void systemBus::setup()
     //         Debug_printf("%c\n",b[0]);
     //     }
     // }
-// end jeff hack
+    // end jeff hack
 
 }