Merge pull request #136 from ejaquay/config-acia-base

Config acia base

Author: BGPierce

acia/ReadMe.txt

@@ -11,43 +11,84 @@ Issues
 ------
 1) Baud rates are not very accurate.
 2) No hardware flow control other than RxF and TxE signals
-
-Todo
-----
-> Means to unload DLL when Vcc exits / crashes
-> Proper detection of serial port "modem" events when reading:
-  Break, ring, CTS, DSR, RX and DX changes, etc.
-> Implement DCD DSR flow control.
+3) DLL does not exit if Vcc crashes. (Issue with all Vcc Dll's)
+4) No detection of serial port "modem" events when reading:
+   Break, ring, CTS, DSR, RX and DX changes, etc.
 
 Would be nice
 -------------
 1) Support for second sc6551 device
 
-Acia Quick tutorial
--------------------
-
-To use acia.dll insert it in the cartridge slot or a MPI slot. This
-will cause "Acia Config" to be added to the Cartridge menu. Clicking
-on it allows selection of the acia communication modes: Console,
-File read, File write, TCPIP (client), and COMx (PC serial port). The
-Name and Port fields are used to set parameters for the modes.  A
-text mode check box when checked causes acia.dll to do CR <-> CRLF
-translations when in file modes.
-
-The sc6551 emulation is controlled by four port addresses, 0xFF68
-thru 0xFF6B.  The CPU controls the sc6551 by writing to these
-addresses and gets status and data from the sc6551 by reading them.
-A sc6551 datasheet will explain these in detail - what follows is
+Acia Quick Start 
+----------------
+To use acia.dll insert it in the cartridge slot or a MPI slot.
+This will cause "Acia Config" to be added to the Cartridge menu.
+Clicking on this menu item allows selection of one of the acia 
+modes: Console, File read, File write, TCPIP (client), and COMx.
+The Name and Port fields are used to set parameters for modes
+that require them.  The text mode check box when checked causes
+acia.dll to do CR <-> CRLF translations when using the file 
+read and write modes. The default mode is CONSOLE. 
+
+For a quick test leave the ACIA config mode set to console
+and enter and run the following basic program.  (You can cut
+and paste using Vcc Edit -> Paste Basic Code)
+
+10 POKE &HFF6A,1
+20 IF (PEEK(&HFF69) AND 8)=0 THEN 20
+30 PRINT CHR$(PEEK(&HFF68));
+40 GOTO20
+
+The Vcc console should come up. The console is a CMD type window 
+that is connected to the ACIA. Anything typed in the console 
+will be read and printed by the basic program.  To close the
+console POKE &FF6A,0 or press F5 from the Vcc window.
+
+The following program does the opposite, characters typed in the 
+Vcc window are written to the console and CR writes CRLF:
+
+10 POKE &HFF6A,1
+20 K$=INKEY$: IF K$="" THEN 20
+30 C=ASC(K$)
+40 IF (PEEK(&HFF69) AND 16)=0 THEN 40
+50 POKE &HFF68,C
+60 IF C<>13 THEN 20
+70 C=10: GOTO 40
+
+Console mode is most useful when using Os9 which is described later.
+
+Radio Shack Deluxe RS232 program Pak
+-------------------------------------
+ 
+If the file "rs232.rom" is in the Vcc execution directory it will
+be automatically loaded when acia.dll is selected but not started.
+To start it do "EXEC &HE010" from RSDOS command prompt. The rom
+is a copy of the 4K rom from the Radio Shack Deluxe RS232 program
+Pack.  If a different ROM is used it must be 4096 bytes long. Note
+that if acia.dll is in a MPI slot but not selected it can still be
+used but the pack rom will not be accessible.  To exec the rom
+type EXEC&HE010 at the basic prompt. Note that the pak currently
+has trouble with the "goto basic" function on Vcc which limits its
+usefulness. Suggestions for a solution would be appreciated.
+
+SC6551 Operation
+----------------
+
+The sc6551 emulation is controlled one of two blocks of port addresses,
+0xFF68-0xFF6B or 0xFF68-0xFF6F, the block used is selected by a Acia
+config dialog Radio button. The CPU controls the sc6551 by writing
+to these addresses and gets status and data from the sc6551 by reading
+them. A sc6551 datasheet will explain these in detail - what follows is
 a brief explaination of the most important bits to acia.dll.
 
-0xFF68 is the data register. A write to the address will transmit
+0xFF68 (0xFF6C) is the data register. A write to the address will transmit
 a byte of data and a read will receive a byte of data.
 
-0xFF69 is the status byte.  The CPU reads this port to determine
+0xFF69 (0xFF6D) is the status byte.  The CPU reads this port to determine
 the status of the sc6551.  Bits 0, 1, and 2 of the status byte are
-unused error indicators.  Bit 3 indicates that a data byte is ready
-to read. Bit 4 indicates that the sc6551 is ready to transmit a byte.
-Bits 5 and 6 are modem and data set ready bits, and Bit 7 indicates the
+error indicators.  Bit 3 indicates that a data byte is ready to read. 
+Bit 4 indicates that the sc6551 is ready to transmit a byte. Bits 
+5 and 6 are modem and data set ready bits, and Bit 7 indicates the
 sc6551 has asserted and IRQ.  Acia.dll does not set the error bits and
 bits 5 and 6 are always clear to indicate mode and data ready states.
 
@@ -57,16 +98,16 @@ writing to the data register, and when it wants to recieve data it must
 first check that bit 3 (RxF) is set before reading the data register.
 
 Acia.dll will assert an IRQ and set status bit 7 when data becomes ready
-to read if Bit 1 of the command register (0xFF6A) is clear. The coco can
+to read if Bit 1 of the command register (0xFF6A (0xFF6E)) is clear. The coco can
 use the interrupt to reduce input polling.
 
-0xFF6A is the command register.  Bit 0 of the command register is the
+0xFF6A (0xFF6E) is the command register.  Bit 0 of the command register is the
 DTR bit.  This bit enables or disables the sc6551.  If this bit is set
 by the coco CPU then communications are active (open) and if it is
 cleared communications are inactive (closed).  Other command register
 bits set IRQ behavior and parity. Refer to data sheet for details.
 
-0xFF6B is the control register. Bits 0-3 of the control register set
+0xFF6B (0xFF6F) is the control register. Bits 0-3 of the control register set
 the baud rate according to the following table.  Datasheet rates that
 are not supported by acia.dll have replaced by the next higher value.
 Acia.dll uses screen sync signal to time the input speeds.  These
@@ -83,7 +124,7 @@ the rates are invalid.
         6     300     14    9600
         7     600     15   19200
 
-Bits 5 and 6 of 0xFF6B set the data length and Bit 7 sets the number
+Bits 5 and 6 of 0xFF6B (0xFF6F) set the data length and Bit 7 sets the number
 of stop bits. B5-6: 00=8 01=7 10=6 11=5 len.  B7 0=1, 1=2 stops.
 
 Basic programs can enable acia by poking 1 to &HFF6A and disable it by
@@ -122,11 +163,13 @@ RS232.ROM
 
 If the file "rs232.rom" is in the Vcc execution directory it will
 be automatically loaded when acia.dll is selected but not started.
+(make sure Autostart Cart in Misc Config dialog is unchecked)
 To start it do "EXEC &HE010" from RSDOS command prompt. The rom
 is a copy of the 4K rom from the Radio Shack Deluxe RS232 program
-Pack.  If a different ROM is used it must be 4096 bytes long. Note
-that if acia.dll is in a MPI slot but not selected it can still be
-used but the pack rom will not be accessible.
+Pack. The RS232 rom is only usefull if FF68 (RS-232 Pak) is selected
+in the config dialog.  If a different ROM is used it must be 4096
+bytes long. Note that if acia.dll is in a MPI slot but not selected
+it can still be used but the pack rom will not be accessible.
 
 Communications Modes
 --------------------
@@ -154,6 +197,7 @@ Console mode can be useful when using (Nitr)Os9 and the t2 device
 and associated sc6551 driver. t2 and sc6551 must both be loaded at
 boot (in the boot track) to work properly. The t2 device can also
 be used for testing purposes, which is why it was originally created.
+Note that the stock t2 driver assumes the Acia Address is FF68.
 
 Caution: There can only be one console associated with Vcc. Conflicts
 will occur is the console is used for other purposes, such as for
@@ -169,10 +213,10 @@ quit=05 bse=08 bell=07 type=80 baud=06 xon=11 xoff=13
 Some of these settings are not honored by the sc6551 driver.
 Xon, Xoff, and baud xmode settings seem to have no effect.
 
-The basic idea is to match standard text window settings. Acia.dll
-will translate OS9 text screen control codes to the proper console
-functions.  Colors default to white on black.  Only colors 0-7 are
-supported.
+The console uses standard OS9 text window settings. Acia.dll
+will translate many OS9 text screen control codes to do the 
+proper console functions.  Colors default to white on black.
+Only colors 0-7 are supported.
 
 To launch a shell simply do: shell i=/t2 and the console
 will come up. Typing "ex" in the console window causes the
@@ -210,6 +254,7 @@ I did a brief check of uemacs. It seems to work okay except I find
 the lack of support of arrow keys annoying and I am too used to
 vi's use of hjkl for cursor position to adapt to emacs.
 
+
 File Read and File Write Modes
 ------------------------------
 
@@ -245,7 +290,7 @@ output in a os9 file and copy that to /t2, for example:
 When using other programs to read or write files it is important
 to note that setting DTR opens the file and clearing DTR closes
 it. The NitrOS9 driver takes care of this but many terminal
-programs do not. DTR is controlled by bit 0 in 0xFF6A.
+programs do not. DTR is controlled by bit 0 in 0xFF6A (0xFF6E).
 
 TCPIP Mode
 ----------
@@ -254,7 +299,7 @@ TCPIP mode causes acia to do a client connection to a tcpip server.
 After selecting TCPIP radio button on the Acia config dialog the
 server hostname or IP address should be entered in the Name field
 (default is localhost) and the server port in the Port field.  Setting
-bit 0 in 0xFF6A opens the connection and clearing it closes it.
+bit 0 in 0xFF6A (0xFF6E) opens the connection and clearing it closes it.
 
 Testing tcpip mode was done using netcat on Linux as a server.
 On Linux ' nc -l -p 48000'   48000 is the port number I am using.
@@ -279,6 +324,5 @@ in windows along with putty.  com0com is used to 'wire' two psuedo
 port COM20 and COM21 together. I used acia.dll to connect to COM20
 and PuTTy to connect to COM21.  This allowed me to simulate connecting
 with a terminal.  Also tested with a USRobotics faxmodem via a Radio
-Shack USB to serial adapter and the legacy USBSER driver, which was a
-PIA to setup in Windows 10.
+Shack USB to serial adapter and the legacy USBSER driver.
 

acia/acia.c

@@ -48,7 +48,7 @@ static char IniSect[MAX_LOADSTRING]; // Ini file section
 // Some strings for config dialog
 char *IOModeTxt[] = {"RW","R","W"};
 char *ComTypeTxt[] = {"CONS","FILE","TCP","COM"};
-  
+
 static unsigned char Rom[8191];
 static void (*PakSetCart)(unsigned char)=NULL;
 unsigned char LoadExtRom(char *);
@@ -214,6 +214,8 @@ void LoadConfig(void)
                                      COM_CONSOLE,IniFile);
     AciaComMode=GetPrivateProfileInt("Acia","AciaComMode",
                                      COM_MODE_DUPLEX,IniFile);
+    AciaBasePort=GetPrivateProfileInt("Acia","AciaBasePort",
+                                     BASE_PORT_RS232,IniFile);
     AciaTcpPort=GetPrivateProfileInt("Acia","AciaTcpPort",48000,IniFile);
     AciaTextMode=GetPrivateProfileInt("Acia","AciaTextMode",0,IniFile);
     GetPrivateProfileString("Acia","AciaComPort","COM3",
@@ -252,6 +254,8 @@ void LoadConfig(void)
 void SaveConfig(void)
 {
     char txt[16];
+    sprintf(txt,"%d",AciaBasePort);
+    WritePrivateProfileString("Acia","AciaBasePort",txt,IniFile);
     sprintf(txt,"%d",AciaComType);
     WritePrivateProfileString("Acia","AciaComType",txt,IniFile);
     sprintf(txt,"%d",AciaComMode);
@@ -300,6 +304,23 @@ LRESULT CALLBACK ConfigDlg(HWND hDlg,UINT msg,WPARAM wParam,LPARAM lParam)
 
         SetWindowPos(hDlg, HWND_TOP, 10, 10, 0, 0, SWP_NOSIZE);
 
+        // Set Button as per Base Port
+        switch (AciaBasePort) {
+        case BASE_PORT_RS232:
+			CheckDlgButton(hDlg,IDC_T_RS232,BST_CHECKED);
+            CheckDlgButton(hDlg,IDC_T_MODEM,BST_UNCHECKED);
+            break;
+        case BASE_PORT_MODEM:
+			CheckDlgButton(hDlg,IDC_T_RS232,BST_UNCHECKED);
+            CheckDlgButton(hDlg,IDC_T_MODEM,BST_CHECKED);
+            break;
+        default:
+			CheckDlgButton(hDlg,IDC_T_RS232,BST_CHECKED);
+            CheckDlgButton(hDlg,IDC_T_MODEM,BST_UNCHECKED);
+            AciaBasePort = BASE_PORT_RS232;
+            break;
+        }
+
         // Set Radio Button as per com type
         switch (AciaComType) {
 
@@ -359,9 +380,21 @@ LRESULT CALLBACK ConfigDlg(HWND hDlg,UINT msg,WPARAM wParam,LPARAM lParam)
 
     case WM_COMMAND:
 
-        // Close sc6551 before changing com type
+
         button = LOWORD(wParam);
         switch (button) {
+
+        // Close sc6551 before changing base port or com type
+        case IDC_T_RS232:
+            sc6551_close();
+            AciaBasePort = BASE_PORT_RS232;
+            break;
+
+        case IDC_T_MODEM:
+            sc6551_close();
+            AciaBasePort = BASE_PORT_MODEM;
+            break;
+
         case IDC_T_CONS:
             EnableWindow(GetDlgItem(hDlg,IDC_PORT),FALSE);
             EnableWindow(GetDlgItem(hDlg,IDC_NAME),FALSE);

acia/acia.h

@@ -39,6 +39,10 @@
 // Text mode EOF character
 #define EOFCHR 0x1B
 
+// Base Ports
+#define BASE_PORT_RS232 0x68
+#define BASE_PORT_MODEM 0x6C
+
 // Communications type and mode enumerations
 enum com_type {
     COM_CONSOLE,
@@ -59,6 +63,7 @@ HANDLE hStopInput;
 HANDLE hStopOutput;
 
 // Config globals
+int  AciaBasePort;             // Base port for sc6651 (0x68 or 0x6C)
 int  AciaComType;              // Console,file,tcpip,wincom
 int  AciaComMode;              // Duplex,read,write
 int  AciaTextMode;             // CR and EOF translations 0=none 1=text

acia/acia.rc

@@ -25,18 +25,18 @@ LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US
 // TEXTINCLUDE
 //
 
-1 TEXTINCLUDE 
+1 TEXTINCLUDE
 BEGIN
     "resource.\0"
 END
 
-2 TEXTINCLUDE 
+2 TEXTINCLUDE
 BEGIN
     "#include ""afxres.h""\r\n"
     "\0"
 END
 
-3 TEXTINCLUDE 
+3 TEXTINCLUDE
 BEGIN
     "\r\n"
     "\0"
@@ -50,27 +50,40 @@ END
 // Dialog
 //
 
-IDD_PROPPAGE DIALOGEX 0, 0, 170, 170
+IDD_PROPPAGE DIALOGEX 0, 0, 202, 185
 STYLE DS_SETFONT | DS_MODALFRAME | WS_POPUP | WS_CAPTION
 CAPTION "Acia Interface"
 FONT 8, "MS Sans Serif", 0, 0, 0x0
 BEGIN
-    CONTROL  "CONSOLE",   IDC_T_CONS,  "Button",BS_AUTORADIOBUTTON,16,16,55,12
-    CONTROL  "FILE READ", IDC_T_FILE_R,"Button",BS_AUTORADIOBUTTON,16,30,55,12
-    CONTROL  "FILE WRITE",IDC_T_FILE_W,"Button",BS_AUTORADIOBUTTON,16,44,55,12
-    CONTROL  "TCPIP",     IDC_T_TCP,   "Button",BS_AUTORADIOBUTTON,15,58,55,12
-    CONTROL  "COMx",      IDC_T_COM,   "Button",BS_AUTORADIOBUTTON,16,72,55,12
-
-    LTEXT    "Name:", IDC_STATIC,14,90,20,11
-    EDITTEXT IDC_NAME,40,88,110,12,ES_AUTOHSCROLL | ES_LEFT
-    LTEXT    "Port:",IDC_STATIC,14,104, 20,11
-    EDITTEXT IDC_PORT,40,102, 36,12,ES_AUTOHSCROLL | ES_NUMBER
-
-    CONTROL    "Text Mode",IDC_TXTMODE,"Button",BS_AUTOCHECKBOX,18,118,50,12
-
-    DEFPUSHBUTTON  "Ok",    IDOK,     14,140,45,19
-    PUSHBUTTON     "APPLY", IDAPPLY,  62,140,45,19
-    PUSHBUTTON     "Cancel",IDCANCEL,110,140,45,19
+    GROUPBOX "Type",IDC_STATIC,8,8,90,84,BS_CENTER
+    CONTROL  "CONSOLE",   IDC_T_CONS,  "Button",BS_AUTORADIOBUTTON|WS_GROUP,
+        16,18,75,12
+    CONTROL  "FILE READ", IDC_T_FILE_R,"Button",BS_AUTORADIOBUTTON,
+        16,31,75,12
+    CONTROL  "FILE WRITE",IDC_T_FILE_W,"Button",BS_AUTORADIOBUTTON,
+        16,46,75,12
+    CONTROL  "TCPIP",     IDC_T_TCP,   "Button",BS_AUTORADIOBUTTON,
+        16,60,75,12
+    CONTROL  "COMx",      IDC_T_COM,   "Button",BS_AUTORADIOBUTTON,
+        16,74,75,12
+
+    GROUPBOX "Acia Address",IDC_STATIC,104,18,90,51,BS_CENTER
+    CONTROL  "FF68 (RS-232 Pak)",IDC_T_RS232,"Button",BS_AUTORADIOBUTTON|WS_GROUP,
+        108,31,75,12
+    CONTROL  "FF6C (Modem Pak)", IDC_T_MODEM,"Button",BS_AUTORADIOBUTTON,
+        108,46,75,12
+
+    LTEXT    "Name:", IDC_STATIC,14,102, 20, 11
+    EDITTEXT IDC_NAME,           40,100, 120,12,ES_AUTOHSCROLL|ES_LEFT
+    LTEXT    "Port:",IDC_STATIC, 14,120, 20, 11
+    EDITTEXT IDC_PORT,           40,118, 20, 12,ES_AUTOHSCROLL|ES_NUMBER
+
+    CONTROL  "Text Mode",IDC_TXTMODE,"Button",BS_AUTOCHECKBOX,
+        18,136,50,12
+
+    DEFPUSHBUTTON  "Ok",    IDOK,     23,155,45,20
+    PUSHBUTTON     "APPLY", IDAPPLY,  75,155,45,20
+    PUSHBUTTON     "Cancel",IDCANCEL,128,155,45,20
 END
 
 /////////////////////////////////////////////////////////////////////////////

acia/resource.h

@@ -18,6 +18,9 @@
 #define IDC_T_TCP                       1023
 #define IDC_T_COM                       1024
 
+#define IDC_T_RS232                     1030
+#define IDC_T_MODEM                     1031
+
 // Next default values for new objects
 //
 #ifdef APSTUDIO_INVOKED