ide rework again

- `VirtualBox-Wrapper.ps1` now takes 'up' or 'down' as opposed to a machine name. This allows start/stop of a virtualmachine.
- `VirtualBox-Wrapper.ps1` now relies on a gitignored `localenv.json` to work.
- `VirtualBox-Wrapper.ps1` can also optionally monitor the log file generated from the serial adapter in VirtualBox.
- `readme.md` updated to provide instructions on how to populate the `localenv.json` file.
- `tasks.json` updated to have a "Clean" task to --remove-orphans, the Build task depends on this.
- `tasks.json` updated to have a "Close VirtualBox" task, this runs the `virtualbox-wrapper.ps1` in 'down' mode. The Build task depends on this.
- `launch.json` updated to run the `VirtualBox-Wrapper.ps1` with the "-Command up" argument, instead of machine name.
- .gitignore updated to ignore any instances of `localenv.json`.

# Conflicts:
#	.gitignore

.gitignore

@@ -10,3 +10,4 @@
 /*.sh~
 /*.img
 src/include/asuro.pas
+localenv.json

.vscode/launch.json

@@ -6,7 +6,7 @@
             "type": "PowerShell",
             "preLaunchTask": "Build",
             "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
-            "args": ["-MachineName", "7d395c96-891c-4139-b77d-9b6b144b0b93"],
+            "args": ["-Command", "up"],
             "cwd": "${workspaceFolder}",
         }
     ]

.vscode/tasks.json

@@ -9,14 +9,18 @@
             "command": "docker-compose",
             "args": [
                 "run",
-                "builder"
+                "builder",
             ],
             "type": "shell",
             "problemMatcher": [],
             "group": {
                 "kind": "build",
                 "isDefault": true
-            }
+            },
+            "dependsOn": [
+                "Close VirtualBox",
+                "Clean"
+            ]
         },
         {
             "label": "Build (Builder)",
@@ -26,6 +30,24 @@
                 "builder"
             ],
             "type": "shell"
+        },
+        {
+            "label": "Clean",
+            "command": "docker-compose",
+            "args": [
+                "down",
+                "--remove-orphans"
+            ],
+            "type": "shell"
+        },
+        {
+            "label": "Close VirtualBox",
+            "command": "./virtualbox-wrapper.ps1",
+            "args": [
+                "-Command", 
+                "down"
+            ],
+            "type": "shell"
         }
     ]
 }

docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3.9"
 services:
   builder:
     build: .

readme.md

@@ -50,23 +50,26 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     ```xml
     <Machine uuid="{7d395c96-891c-4139-b77d-9b6b144b0b93}" name="Asuro" OSType="Linux" snapshotFolder="Snapshots" lastStateChange="2021-06-20T20:33:07Z">
     ```
-    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` and replace the uuid found in `.vscode\launch.json` under `args`, so that it looks something like this:
+    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` & create a `localenv.json` file in the project root with the following content:
     ```json
     {
-        "configurations": [
+        "VirtualBox":{
-            {
+            "MachineName":"<YOUR_UUID_OR_MACHINE_NAME>"
-                "name":"Run",
+        }
-                "request": "launch",
-                "type": "PowerShell",
-                "preLaunchTask": "Build",
-                "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
-                "args": ["-MachineName", "7d395c96-891c-4139-b77d-9b6b144b0b93"],
-                "cwd": "${workspaceFolder}",
-            }
-        ]
     }
     ```
     This will allow VSCode to automatically launch VirtualBox once Asuro has been compiled.
+    
+    You can also enable the serial adapter "COM1" in mode "Raw File", give it a path, and provide this path in the `localenv.json` as follows:
+    ```json
+    {
+        "VirtualBox" : {
+            "MachineName": "<YOUR_UUID_OR_MACHINE_NAME>",
+            "LogLocation": "Fully\\Qualified\\Path\\To\\Your\\Log\\File"
+        }
+    }
+    ```
+    This will allow you to see the console output from Asuro in your host terminal.
 13. Open your project folder in VSCode, use CTRL+SHIFT+B to build & F5 to build + run in VBox.
 14. Congratulations! You can now play with Asuro!
 

src/driver/storage/drivemanager.pas

@@ -271,7 +271,7 @@ begin
     PStorage_device(elm)^.volumes := LL_New(sizeof(TStorage_Volume));
     
     //TODO register with volume manager
-    volumemanager.check_for_volumes(PStorage_Device(elm));
+    //volumemanager.check_for_volumes(PStorage_Device(elm));
 end;
 
 { Get the drive list }
@@ -290,7 +290,8 @@ begin
 
     //return string of controller type
     case controllerType of
-        ControllerIDE : controller_type_2_string:= 'IDE';
+        ControllerATA : controller_type_2_string:= 'ATA';
+        ControllerATAPI : controller_type_2_string:= 'ATAPI';
         ControllerUSB :  controller_type_2_string:= 'USB';
         ControllerAHCI : controller_type_2_string:= 'ACHI (SATA)';
         ControllerNET : controller_type_2_string:= 'Net';

src/driver/storage/idetypes.pas

@@ -0,0 +1,140 @@
+//  Copyright 2021 Aaron Hance
+//
+//  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.
+
+{ 
+	Driver->Storage->IDE->idetypes - IDE device types and constants.
+	
+	@author(Aaron Hance <[email protected]>)
+}
+unit idetypes;
+
+interface
+
+const
+
+    ATA_SR_BUSY = $80; //BUSY
+    ATA_SR_DRDY = $40; //DRIVE READY
+    ATA_SR_DF   = $20; //DRIVE WRITE FAULT
+    ATA_SR_DSC  = $10; //DRIVE SEEK COMPLETE
+    ATA_SR_DRQ  = $08; //DATA REQUEST READY
+    ATA_SR_CORR = $04; //CORRECTED DATA
+    ATA_SR_IDX  = $02; //INLEX
+    ATA_SR_ERR  = $01; //ERROR
+
+    ATA_ER_BBK   = $80; //BAD SECTOR
+    ATA_ER_UNC   = $40; //UNCORRECTABLE DATA
+    ATA_ER_MC    = $20; //NO MEDIA
+    ATA_ER_IDNF  = $10; //ID MARK NOT FOUND
+    ATA_ER_MCR   = $08; //NO MEDIA
+    ATA_ER_ABRT  = $04; //COMMAND ABORTED
+    ATA_ER_TK0NF = $02; //TRACK 0 NOT FOUND
+    ATA_ER_AMNF  = $01; //NO ADDRESS MARK
+
+    ATA_CMD_READ_PIO        = $20; 
+    ATA_CMD_READ_PIO_EXT    = $24; 
+    ATA_CMD_READ_DMA        = $C8; 
+    ATA_CMD_READ_DMA_EXT    = $25; 
+    ATA_CMD_WRITE_PIO       = $30; 
+    ATA_CMD_WRITE_PIO_EXT   = $34; 
+    ATA_CMD_WRITE_DMA       = $CA; 
+    ATA_CMD_WRITE_DMA_EXT   = $35; 
+    ATA_CMD_CACHE_FLUSH     = $E7; 
+    ATA_CMD_CACHE_FLUSH_EXT = $EA; 
+    ATA_CMD_PACKET          = $A0; 
+    ATA_CMD_IDENTIFY_PACKET = $A1; 
+    ATA_CMD_IDENTIFY        = $EC; 
+
+    ATAPI_CMD_READ  = $A8;
+    ATAPI_CMD_EJECT = $1B;
+
+    ATA_IDENT_DEVICETYPE   = $0;    
+    ATA_IDENT_CYLINDERS    = $2;    
+    ATA_IDENT_HEADS        = $6;    
+    ATA_IDENT_SECOTRS      = $12;    
+    ATA_IDENT_SERIAL       = $20;    
+    ATA_IDENT_MODEL        = $54;    
+    ATA_IDENT_CAPABILITIES = $98;    
+    ATA_IDENT_FIELDVALID   = $106;   
+    ATA_IDENT_MAX_LBA      = $120;   
+    ATA_IDENT_COMMANDSETS  = $164;       
+    ATA_IDENT_MAX_LBA_EXT  = $200;
+
+    ATA_REG_DATA       = $00;
+    ATA_REG_ERROR      = $01;
+    ATA_REG_FEATURES   = $01;
+    ATA_REG_SECCOUNT  = $02;
+    ATA_REG_LBA0       = $03;
+    ATA_REG_LBA1       = $04;
+    ATA_REG_LBA2       = $05;
+    ATA_REG_HDDEVSEL   = $06;
+    ATA_REG_COMMAND    = $07;
+    ATA_REG_STATUS     = $07;
+    ATA_REG_SECCOUNT1  = $08;
+    ATA_REG_LBA3       = $09;
+    ATA_REG_LBA4       = $0A;
+    ATA_REG_LBA5       = $0B;
+    ATA_REG_CONTROL    = $0C;
+    ATA_REG_ALTSTATUS  = $0C;
+    ATA_REG_DEVADDRESS = $0D; 
+
+    ATA_DEVICE_MASTER = $A0;
+    ATA_DEVICE_SLAVE = $B0;
+
+    ATA_PRIMARY_BASE = $1F0;
+    ATA_PRIMARY_BASE1 = $3F6;
+    ATA_SECONDARY_BASE = $170; //todo check this
+    ATA_SECONDARY_BASE1 = $376; //todo check this
+
+    ATA_INTERRUPT_PRIMARY = $3F6;
+    ATA_INTERRUPT_SECONDARY = $376;
+
+type
+    TPortMode = (P_READ, P_WRITE);
+
+    TIdentResponse = array[0..255] of uint16;
+    PIdentResponse = ^TIdentResponse;
+
+    TIDE_Channel_Registers = record
+        base    : uint16;
+        ctrl    : uint16;
+        bmide   : uint16;
+        noInter : uint8
+    end;
+
+    TIDE_Status = bitpacked record 
+        Busy  : Boolean;
+        Ready : Boolean;
+        Fault : Boolean;
+        Seek  : Boolean;
+        DRQ   : Boolean;
+        CORR  : Boolean;
+        IDDEX : Boolean;
+        ERROR : Boolean;
+    end;
+    PIDE_Status = ^TIDE_Status;
+
+    TIDE_Device = record
+        exists       : boolean;
+        isPrimary    : boolean;
+        isMaster     : boolean;
+        isATAPI      : boolean;
+        status       : TIDE_Status;
+        base         : uint16;
+        info         : PIdentResponse;
+    end;
+
+
+implementation
+  
+end.

src/driver/storage/storagemanagement.pas

@@ -82,7 +82,8 @@ implementation
 function controller_type_2_string(controllerType : TControllerType) : pchar; 
 begin
     case controllerType of
-        ControllerIDE : controller_type_2_string:= 'IDE';
+        ControllerATA : controller_type_2_string:= 'ATA';
+        ControllerATAPI : controller_type_2_string:= 'ATAPI';
         ControllerUSB :  controller_type_2_string:= 'USB';
         ControllerAHCI : controller_type_2_string:= 'ACHI (SATA)';
         ControllerNET : controller_type_2_string:= 'Net';

src/driver/storage/storagetypes.pas

@@ -26,7 +26,7 @@ uses
 
 type
 
-    TControllerType = (ControllerIDE, ControllerUSB, ControllerAHCI, 
+    TControllerType = (ControllerATA, ControllerATAPI, ControllerUSB, ControllerAHCI, 
         ControllerNET, ControllerRAM, rsvctr1, rsvctr2, rsvctr3);
 
     PStorage_device = ^TStorage_Device;

virtualbox-wrapper.ps1

@@ -1,16 +1,58 @@
-param (
+<# 
-  $MachineName
+You need a local git-ignored localenv.json file with the following content:
-)
+{
-
+  "virtualbox": {
-VBoxManage.exe startvm $MachineName
+    "MachineName": "your-machine-name or guid"
-
-$running=$true
-while($running) {
-  Start-Sleep -Seconds 1
-  $status=(VBoxManage.exe list runningvms)
-  if($status) {
-    $running=$status.contains($MachineName)
-  } else {
-    $running=$false
   }
 }
+#>
+
+param (
+  [Parameter(Mandatory=$true)]
+  [ValidateSet('up', 'down')]
+  [String]$Command
+)
+
+$Config = Get-Content .\localenv.json | ConvertFrom-Json
+$MachineName = $Config.virtualbox.MachineName
+$LogLocation = $Config.virtualbox.LogLocation
+$LogOutputEnabled = $LogLocation -ne $null
+
+if ($Command -eq 'up') {
+
+  if($LogOutputEnabled) {
+    Clear-Content $LogLocation
+  }
+
+  $MonitorJob = Start-Job -ArgumentList $MachineName -ScriptBlock {
+    param($MachineName)
+    Write-Output "Starting $MachineName"
+    VBoxManage.exe startvm $MachineName
+    $running=$true
+    while($running) {
+      $status=(VBoxManage.exe list runningvms)
+      if($status) {
+        $running=$status.contains($MachineName)
+      } else {
+        $running=$false
+      }
+    }
+  }
+  
+  if($LogOutputEnabled) {
+    $LogJob = Start-Job -ArgumentList $LogLocation -ScriptBlock {
+      param($LogLocation)
+      Get-Content -Path $LogLocation -Wait
+    }
+  }
+
+  while($MonitorJob.State -eq 'Running') {
+    if($LogOutputEnabled) {
+      Receive-Job $LogJob
+    }
+    Receive-Job $MonitorJob
+  }
+} elseif ($Command -eq 'down') {
+  Write-Output "Stopping $MachineName"
+  VBoxManage.exe controlvm $MachineName poweroff
+}