From 4abb0823f9ff1da889b544f90dd8abbbe41774ca Mon Sep 17 00:00:00 2001 From: AnErrupTion Date: Sun, 24 Mar 2024 00:08:00 +0100 Subject: [PATCH] Mosa.DeviceDriver: XML comment refactoring Signed-off-by: AnErrupTion --- Demos/Run-BareMetal.Starter.x86.sh | 0 Demos/Run-BareMetal.TestWorld.x86.sh | 0 Source/Mosa.DeviceDriver/ACPI/ACPIDriver.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/ACPISDTHeader.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/FADT.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/GenericAddressStructure.cs | 4 ++++ Source/Mosa.DeviceDriver/ACPI/IOAPICEntry.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/LongLocalAPICEntry.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/MADT.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/MADTEntry.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/ProcessorLocalAPICEntry.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor20.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/RSDT.cs | 3 +++ Source/Mosa.DeviceDriver/ACPI/XSDT.cs | 3 +++ Source/Mosa.DeviceDriver/ISA/IDEController.cs | 2 +- Source/Mosa.DeviceDriver/ISA/ISABus.cs | 2 +- Source/Mosa.DeviceDriver/ISA/PCIController.cs | 3 ++- Source/Mosa.DeviceDriver/ISA/StandardKeyboard.cs | 4 ++-- Source/Mosa.DeviceDriver/ISA/StandardMouse.cs | 3 +++ Source/Mosa.DeviceDriver/PCI/Intel/Intel440FX.cs | 1 + .../PCI/Intel/Intel4SeriesChipsetDRAMController.cs | 3 --- .../Intel4SeriesChipsetIntegratedGraphicsController.cs | 3 --- .../Intel4SeriesChipsetIntegratedGraphicsController2E13.cs | 3 --- .../PCI/Intel/Intel4SeriesChipsetPCIExpressRootPort.cs | 3 --- Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX3.cs | 1 + Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX4.cs | 1 + Source/Mosa.DeviceDriver/PCI/Intel/PCIIDEInterface.cs | 1 + .../PCI/Intel/QuarkSoC/IntelGPIOController.cs | 2 -- Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelHSUART.cs | 2 -- Source/Mosa.DeviceDriver/PCI/VMware/VMwareSVGA2.cs | 2 +- Source/Mosa.DeviceDriver/PCI/VirtIO/Devices/VirtIOGPU.cs | 4 ++++ Source/Mosa.DeviceDriver/ScanCodeMap/HU.cs | 2 +- Source/Mosa.DeviceDriver/ScanCodeMap/US.cs | 2 +- Source/Mosa.DeviceDriver/Setup.cs | 6 ++++++ Source/Mosa.DeviceSystem/Fonts/ISimpleFont.cs | 4 ++-- Source/Mosa.DeviceSystem/Graphics/FrameBuffer32.cs | 4 ++-- Source/Mosa.DeviceSystem/HardwareAbstraction/HAL.cs | 4 ++-- Source/Mosa.DeviceSystem/Misc/ConstrainedPointer.cs | 2 +- Source/Mosa.DeviceSystem/Misc/DataBlock.cs | 4 ++-- Source/Mosa.DeviceSystem/Mouse/IMouseDevice.cs | 2 +- Source/Mosa.DeviceSystem/TextDevice/TextScreen.cs | 2 +- 42 files changed, 77 insertions(+), 35 deletions(-) mode change 100644 => 100755 Demos/Run-BareMetal.Starter.x86.sh mode change 100644 => 100755 Demos/Run-BareMetal.TestWorld.x86.sh diff --git a/Demos/Run-BareMetal.Starter.x86.sh b/Demos/Run-BareMetal.Starter.x86.sh old mode 100644 new mode 100755 diff --git a/Demos/Run-BareMetal.TestWorld.x86.sh b/Demos/Run-BareMetal.TestWorld.x86.sh old mode 100644 new mode 100755 diff --git a/Source/Mosa.DeviceDriver/ACPI/ACPIDriver.cs b/Source/Mosa.DeviceDriver/ACPI/ACPIDriver.cs index 89ac69d9e7..00ecee80d4 100644 --- a/Source/Mosa.DeviceDriver/ACPI/ACPIDriver.cs +++ b/Source/Mosa.DeviceDriver/ACPI/ACPIDriver.cs @@ -11,6 +11,9 @@ namespace Mosa.DeviceDriver.ACPI; //https://wiki.osdev.org/ACPI //https://wiki.osdev.org/MADT +/// +/// A basic implementation of ACPI. It implements the interface. +/// public class ACPIDriver : BaseDeviceDriver, IACPI { private FADT fadt; diff --git a/Source/Mosa.DeviceDriver/ACPI/ACPISDTHeader.cs b/Source/Mosa.DeviceDriver/ACPI/ACPISDTHeader.cs index ce6d296470..6a13220864 100644 --- a/Source/Mosa.DeviceDriver/ACPI/ACPISDTHeader.cs +++ b/Source/Mosa.DeviceDriver/ACPI/ACPISDTHeader.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// A standard ACPI header, which is the base of all other headers (like the for example). +/// public readonly struct ACPISDTHeader { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/FADT.cs b/Source/Mosa.DeviceDriver/ACPI/FADT.cs index 7276aa4010..5b86e1098d 100644 --- a/Source/Mosa.DeviceDriver/ACPI/FADT.cs +++ b/Source/Mosa.DeviceDriver/ACPI/FADT.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The Fixed ACPI Description Table. +/// public readonly struct FADT { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/GenericAddressStructure.cs b/Source/Mosa.DeviceDriver/ACPI/GenericAddressStructure.cs index 9316478270..c9849bea92 100644 --- a/Source/Mosa.DeviceDriver/ACPI/GenericAddressStructure.cs +++ b/Source/Mosa.DeviceDriver/ACPI/GenericAddressStructure.cs @@ -4,6 +4,10 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The ACPI Generic Address Structure. It describes in which address space a register is located (e.g. MMIO, Port IO, PCI configuration +/// space, etc...) +/// public readonly struct GenericAddressStructure { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/IOAPICEntry.cs b/Source/Mosa.DeviceDriver/ACPI/IOAPICEntry.cs index d9cd545327..2ccfee0008 100644 --- a/Source/Mosa.DeviceDriver/ACPI/IOAPICEntry.cs +++ b/Source/Mosa.DeviceDriver/ACPI/IOAPICEntry.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// Describes an I/O APIC entry in the ACPI MADT. +/// public readonly struct IOAPICEntry { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/LongLocalAPICEntry.cs b/Source/Mosa.DeviceDriver/ACPI/LongLocalAPICEntry.cs index da237b6bcc..3f5c8875bb 100644 --- a/Source/Mosa.DeviceDriver/ACPI/LongLocalAPICEntry.cs +++ b/Source/Mosa.DeviceDriver/ACPI/LongLocalAPICEntry.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// Describes a long local APIC entry in the ACPI MADT. +/// public readonly struct LongLocalAPICEntry { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/MADT.cs b/Source/Mosa.DeviceDriver/ACPI/MADT.cs index 1c44ef63bc..36283ebf57 100644 --- a/Source/Mosa.DeviceDriver/ACPI/MADT.cs +++ b/Source/Mosa.DeviceDriver/ACPI/MADT.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The ACPI Multiple APIC Description Table. +/// public readonly struct MADT { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/MADTEntry.cs b/Source/Mosa.DeviceDriver/ACPI/MADTEntry.cs index 407e4c0cb7..6e3211275e 100644 --- a/Source/Mosa.DeviceDriver/ACPI/MADTEntry.cs +++ b/Source/Mosa.DeviceDriver/ACPI/MADTEntry.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// A generic entry in the ACPI MADT, which is the base of all other entries (like the for example). +/// public readonly struct MADTEntry { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/ProcessorLocalAPICEntry.cs b/Source/Mosa.DeviceDriver/ACPI/ProcessorLocalAPICEntry.cs index c87e76efb8..ea510cbad3 100644 --- a/Source/Mosa.DeviceDriver/ACPI/ProcessorLocalAPICEntry.cs +++ b/Source/Mosa.DeviceDriver/ACPI/ProcessorLocalAPICEntry.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// Describes a processor local APIC entry in the ACPI MADT. +/// public readonly struct ProcessorLocalAPICEntry { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor.cs b/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor.cs index 27a1ec77b0..7022d4d1e2 100644 --- a/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor.cs +++ b/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The ACPI Root System Description Pointer. +/// public readonly struct RSDPDescriptor { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor20.cs b/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor20.cs index 69ab5b6b2d..4d3fb2c4c7 100644 --- a/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor20.cs +++ b/Source/Mosa.DeviceDriver/ACPI/RSDPDescriptor20.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The ACPI Root System Description Pointer v2 (also known as the eXtended System Description Pointer, or XSDP). +/// public readonly struct RSDPDescriptor20 { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/RSDT.cs b/Source/Mosa.DeviceDriver/ACPI/RSDT.cs index a44e097357..cd87c3bd11 100644 --- a/Source/Mosa.DeviceDriver/ACPI/RSDT.cs +++ b/Source/Mosa.DeviceDriver/ACPI/RSDT.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The ACPI Root System Description Table. +/// public readonly struct RSDT { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ACPI/XSDT.cs b/Source/Mosa.DeviceDriver/ACPI/XSDT.cs index e9ba12f8ef..cb40ca7c53 100644 --- a/Source/Mosa.DeviceDriver/ACPI/XSDT.cs +++ b/Source/Mosa.DeviceDriver/ACPI/XSDT.cs @@ -4,6 +4,9 @@ namespace Mosa.DeviceDriver.ACPI; +/// +/// The ACPI eXtended System Description Table. +/// public readonly struct XSDT { public readonly Pointer Pointer; diff --git a/Source/Mosa.DeviceDriver/ISA/IDEController.cs b/Source/Mosa.DeviceDriver/ISA/IDEController.cs index c3f36450ce..cfabb7b778 100644 --- a/Source/Mosa.DeviceDriver/ISA/IDEController.cs +++ b/Source/Mosa.DeviceDriver/ISA/IDEController.cs @@ -11,7 +11,7 @@ namespace Mosa.DeviceDriver.ISA; // http://mirrors.josefsipek.net/www.nondot.org/sabre/os/files/Disk/IDE-tech.html /// -/// IDE Controller +/// Implements an IDE controller in ATA PIO mode. It also implements the interface. /// //[ISADeviceDriver(AutoLoad = true, BasePort = 0x1F0, PortRange = 8, Platforms = PlatformArchitecture.X86AndX64)] //[ISADeviceDriver(AutoLoad = false, BasePort = 0x170, PortRange = 8, ForceOption = "ide2", Platforms = PlatformArchitecture.X86AndX64)] diff --git a/Source/Mosa.DeviceDriver/ISA/ISABus.cs b/Source/Mosa.DeviceDriver/ISA/ISABus.cs index 9bc2f0b76b..6f5b097e44 100644 --- a/Source/Mosa.DeviceDriver/ISA/ISABus.cs +++ b/Source/Mosa.DeviceDriver/ISA/ISABus.cs @@ -9,7 +9,7 @@ namespace Mosa.DeviceDriver.ISA; /// -/// ISA Bus Driver +/// A device driver whose sole purpose is to initialize all ISA devices in the system. /// public class ISABus : BaseDeviceDriver { diff --git a/Source/Mosa.DeviceDriver/ISA/PCIController.cs b/Source/Mosa.DeviceDriver/ISA/PCIController.cs index 766923ca49..a19767f4a3 100644 --- a/Source/Mosa.DeviceDriver/ISA/PCIController.cs +++ b/Source/Mosa.DeviceDriver/ISA/PCIController.cs @@ -7,7 +7,8 @@ namespace Mosa.DeviceDriver.ISA; /// -/// PCI Controller +/// A device driver which queries the PCI controller in the system. It implements both the and the +/// interfaces. /// //[ISADeviceDriver(AutoLoad = true, BasePort = 0x0CF8, PortRange = 8, Platforms = PlatformArchitecture.X86AndX64)] public sealed class PCIController : BaseDeviceDriver, IPCIControllerLegacy, IPCIController diff --git a/Source/Mosa.DeviceDriver/ISA/StandardKeyboard.cs b/Source/Mosa.DeviceDriver/ISA/StandardKeyboard.cs index def20839e7..32b3d3a3ea 100644 --- a/Source/Mosa.DeviceDriver/ISA/StandardKeyboard.cs +++ b/Source/Mosa.DeviceDriver/ISA/StandardKeyboard.cs @@ -7,8 +7,8 @@ namespace Mosa.DeviceDriver.ISA; /// -/// A standard PS/2 keyboard. It implements the IKeyboardDevice interface, and uses a FIFO (First In First Out) buffer to store -/// the raw scancodes, which can be retrieved using the GetScanCode() function. +/// A standard PS/2 keyboard. It implements the interface, and uses a FIFO (First In First Out) buffer to +/// store the raw scancodes, which can be retrieved using the GetScanCode() method. /// //[ISADeviceDriver(AutoLoad = true, BasePort = 0x60, PortRange = 1, AltBasePort = 0x64, AltPortRange = 1, IRQ = 1, Platforms = PlatformArchitecture.X86AndX64)] public class StandardKeyboard : BaseDeviceDriver, IKeyboardDevice diff --git a/Source/Mosa.DeviceDriver/ISA/StandardMouse.cs b/Source/Mosa.DeviceDriver/ISA/StandardMouse.cs index c3648dc8a8..ecc95ea8b7 100644 --- a/Source/Mosa.DeviceDriver/ISA/StandardMouse.cs +++ b/Source/Mosa.DeviceDriver/ISA/StandardMouse.cs @@ -11,6 +11,9 @@ namespace Mosa.DeviceDriver.ISA; //https://forum.osdev.org/viewtopic.php?t=10247 //https://wiki.osdev.org/Mouse_Input +/// +/// A standard PS/2 mouse. It implements the interface. +/// public class StandardMouse : BaseDeviceDriver, IMouseDevice { private enum WaitType diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/Intel440FX.cs b/Source/Mosa.DeviceDriver/PCI/Intel/Intel440FX.cs index d83875da60..bd99360438 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/Intel440FX.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/Intel440FX.cs @@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel; //http://download.intel.com/design/chipsets/specupdt/29765406.pdf /// +/// A generic Intel chipset, implemented by QEMU (also known as i440FX). It uses the southbridge. /// //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x1237, Platforms = PlatformArchitecture.X86AndX64)] public class Intel440FX : BaseDeviceDriver diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetDRAMController.cs b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetDRAMController.cs index 95ee8a3f29..fe0e7bd2cb 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetDRAMController.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetDRAMController.cs @@ -4,9 +4,6 @@ namespace Mosa.DeviceDriver.PCI.Intel; -/// -/// Intel -/// public class Intel4SeriesChipsetDRAMController : BaseDeviceDriver { public override void Initialize() => Device.Name = "Intel4SeriesChipsetDRAMController"; diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController.cs b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController.cs index b1a3cf8a5c..1cfae56c2a 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController.cs @@ -4,9 +4,6 @@ namespace Mosa.DeviceDriver.PCI.Intel; -/// -/// Intel -/// public class Intel4SeriesChipsetIntegratedGraphicsController : BaseDeviceDriver { public override void Initialize() => Device.Name = "Intel4SeriesChipsetIntegratedGraphicsController"; diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController2E13.cs b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController2E13.cs index 7b1af8eceb..f85274e3d4 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController2E13.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetIntegratedGraphicsController2E13.cs @@ -4,9 +4,6 @@ namespace Mosa.DeviceDriver.PCI.Intel; -/// -/// Intel -/// public class Intel4SeriesChipsetIntegratedGraphicsController2E13 : BaseDeviceDriver { public override void Initialize() => Device.Name = "Intel4SeriesChipsetIntegratedGraphicsController2E13"; diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetPCIExpressRootPort.cs b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetPCIExpressRootPort.cs index 787c5e9743..78769760e0 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetPCIExpressRootPort.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/Intel4SeriesChipsetPCIExpressRootPort.cs @@ -4,9 +4,6 @@ namespace Mosa.DeviceDriver.PCI.Intel; -/// -/// Intel -/// public class Intel4SeriesChipsetPCIExpressRootPort : BaseDeviceDriver { public override void Initialize() => Device.Name = "Intel4SeriesChipsetPCIExpressRootPort"; diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX3.cs b/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX3.cs index a69e6d82b9..1db367e080 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX3.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX3.cs @@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel; //http://download.intel.com/design/intarch/datashts/29055002.pdf /// +/// The southbridge of the generic Intel chipset . /// //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x7000, Platforms = PlatformArchitecture.X86AndX64)] public class IntelPIIX3 : BaseDeviceDriver diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX4.cs b/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX4.cs index bf112cf5f8..29b9a543e2 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX4.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/IntelPIIX4.cs @@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel; //http://www.intel.com/assets/pdf/datasheet/290562.pdf /// +/// A newer version of the southbridge, supporting most notably ACPI. /// //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x7113, Platforms = PlatformArchitecture.X86AndX64)] public class IntelPIIX4 : BaseDeviceDriver diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/PCIIDEInterface.cs b/Source/Mosa.DeviceDriver/PCI/Intel/PCIIDEInterface.cs index 401b0a47c4..fa903eeb0d 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/PCIIDEInterface.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/PCIIDEInterface.cs @@ -8,6 +8,7 @@ namespace Mosa.DeviceDriver.PCI.Intel; //http://www.intel.com/assets/pdf/datasheet/290562.pdf /// +/// The IDE controller for the southbridge, interfacing via PCI. /// //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x7010, Platforms = PlatformArchitecture.X86AndX64)] //Base Class Code: 01h=Mass storage device. diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelGPIOController.cs b/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelGPIOController.cs index 20524fa636..d8e82a272a 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelGPIOController.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelGPIOController.cs @@ -6,8 +6,6 @@ namespace Mosa.DeviceDriver.PCI.Intel.QuarkSoC; //http://download.intel.com/support/processors/quark/sb/quarkdatasheetrev02.pdf -/// -/// //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x0934, ClassCode = 0X0C, SubClassCode = 0x80, ProgIF = 0x00, RevisionID = 0x10, Platforms = PlatformArchitecture.X86AndX64)] public class IntelGPIOController : BaseDeviceDriver { diff --git a/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelHSUART.cs b/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelHSUART.cs index 01bdeb0634..4a38301682 100644 --- a/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelHSUART.cs +++ b/Source/Mosa.DeviceDriver/PCI/Intel/QuarkSoC/IntelHSUART.cs @@ -6,8 +6,6 @@ namespace Mosa.DeviceDriver.PCI.Intel.QuarkSoC; //http://download.intel.com/support/processors/quark/sb/quarkdatasheetrev02.pdf -/// -/// //[PCIDeviceDriver(VendorID = 0x8086, DeviceID = 0x0936, ClassCode = 0X07, SubClassCode = 0x80, ProgIF = 0x02, RevisionID = 0x10, Platforms = PlatformArchitecture.X86AndX64)] public class IntelHSUART : BaseDeviceDriver { diff --git a/Source/Mosa.DeviceDriver/PCI/VMware/VMwareSVGA2.cs b/Source/Mosa.DeviceDriver/PCI/VMware/VMwareSVGA2.cs index ef80ebcd9d..6e7132e76e 100644 --- a/Source/Mosa.DeviceDriver/PCI/VMware/VMwareSVGA2.cs +++ b/Source/Mosa.DeviceDriver/PCI/VMware/VMwareSVGA2.cs @@ -26,7 +26,7 @@ namespace Mosa.DeviceDriver.PCI.VMware; //https://github.com/prepare/vmware-svga /// -/// VMware SVGA II Device Driver +/// A basic implementation of the VMware SVGA-II device. It also implements the interface. /// //[PCIDeviceDriver(VendorID = 0x15AD, DeviceID = 0x0405, Platforms = PlatformArchitecture.X86AndX64)] public class VMwareSVGA2 : BaseDeviceDriver, IGraphicsDevice diff --git a/Source/Mosa.DeviceDriver/PCI/VirtIO/Devices/VirtIOGPU.cs b/Source/Mosa.DeviceDriver/PCI/VirtIO/Devices/VirtIOGPU.cs index c41c8c572a..e622d027eb 100644 --- a/Source/Mosa.DeviceDriver/PCI/VirtIO/Devices/VirtIOGPU.cs +++ b/Source/Mosa.DeviceDriver/PCI/VirtIO/Devices/VirtIOGPU.cs @@ -9,6 +9,10 @@ namespace Mosa.DeviceDriver.PCI.VirtIO.Devices; +/// +/// A bare bones (framebuffer-only) implementation of the VirtIO GPU device. It also implements the +/// interface. +/// public class VirtIOGPU : BaseDeviceDriver, IGraphicsDevice { private static class Features diff --git a/Source/Mosa.DeviceDriver/ScanCodeMap/HU.cs b/Source/Mosa.DeviceDriver/ScanCodeMap/HU.cs index d7978ba5be..4c20389cb0 100644 --- a/Source/Mosa.DeviceDriver/ScanCodeMap/HU.cs +++ b/Source/Mosa.DeviceDriver/ScanCodeMap/HU.cs @@ -5,7 +5,7 @@ namespace Mosa.DeviceDriver.ScanCodeMap; /// -/// Implements the HU Keyboard map. +/// Implements a Hungarian QWERTZ scan code map. /// public class HU : IScanCodeMap { diff --git a/Source/Mosa.DeviceDriver/ScanCodeMap/US.cs b/Source/Mosa.DeviceDriver/ScanCodeMap/US.cs index 3d060348ba..05b3e6e7d2 100644 --- a/Source/Mosa.DeviceDriver/ScanCodeMap/US.cs +++ b/Source/Mosa.DeviceDriver/ScanCodeMap/US.cs @@ -5,7 +5,7 @@ namespace Mosa.DeviceDriver.ScanCodeMap; /// -/// Implements the US Keyboard map (scan code set 2) +/// Implements a QWERTY scan code map. (https://wiki.osdev.org/PS/2_Keyboard#Scan_Code_Set_1) /// public class US : IScanCodeMap { diff --git a/Source/Mosa.DeviceDriver/Setup.cs b/Source/Mosa.DeviceDriver/Setup.cs index e4381d3488..966a909081 100644 --- a/Source/Mosa.DeviceDriver/Setup.cs +++ b/Source/Mosa.DeviceDriver/Setup.cs @@ -9,6 +9,12 @@ namespace Mosa.DeviceDriver; +/// +/// Includes a method to get all device drivers that should be initialized by a kernel. Note that this is only a helper method and a +/// kernel may not use it, and may choose to load specific drivers instead. In a future release however, this method will be removed +/// in favor of having an attribute associated to each device driver class, effectively telling which device drivers are registered for +/// initialization. +/// public static class Setup { public static List GetDeviceDriverRegistryEntries() => new List diff --git a/Source/Mosa.DeviceSystem/Fonts/ISimpleFont.cs b/Source/Mosa.DeviceSystem/Fonts/ISimpleFont.cs index 977fbda0b6..d6c6755c9f 100644 --- a/Source/Mosa.DeviceSystem/Fonts/ISimpleFont.cs +++ b/Source/Mosa.DeviceSystem/Fonts/ISimpleFont.cs @@ -7,9 +7,9 @@ namespace Mosa.DeviceSystem.Fonts; /// /// An interface used for implementing simple fonts. Those can be fixed, like , or dynamic, like the /// format. It provides access to the name of the font, its fixed width/height/size (if any), -/// and the charset it supports. It then allows drawing characters using the DrawChar() and DrawString() functions. +/// and the charset it supports. It then allows drawing characters using the DrawChar() and DrawString() methods. /// To reliably calculate the total width of a character or string, or the height of a character, respectively use the -/// CalculateWidth() and CalculateHeight() functions. +/// CalculateWidth() and CalculateHeight() methods. /// public interface ISimpleFont { diff --git a/Source/Mosa.DeviceSystem/Graphics/FrameBuffer32.cs b/Source/Mosa.DeviceSystem/Graphics/FrameBuffer32.cs index f83ce5201f..c3e126ac42 100644 --- a/Source/Mosa.DeviceSystem/Graphics/FrameBuffer32.cs +++ b/Source/Mosa.DeviceSystem/Graphics/FrameBuffer32.cs @@ -9,8 +9,8 @@ namespace Mosa.DeviceSystem.Graphics; /// -/// A 32 bpp versatile frame buffer that works with physical and virtual outputs. Given two X and Y coordinates, the lambda function -/// GetOffset provides the correct offset within the buffer. This frame buffer implements software-accelerated drawing functions. +/// A 32 bpp versatile frame buffer that works with physical and virtual outputs. Given two X and Y coordinates, the lambda method +/// GetOffset provides the correct offset within the buffer. This frame buffer implements software-accelerated drawing methods. /// For hardware-accelerated ones, check the graphics device driver you're using. /// public sealed class FrameBuffer32 diff --git a/Source/Mosa.DeviceSystem/HardwareAbstraction/HAL.cs b/Source/Mosa.DeviceSystem/HardwareAbstraction/HAL.cs index bb2f906345..7e6286ceaf 100644 --- a/Source/Mosa.DeviceSystem/HardwareAbstraction/HAL.cs +++ b/Source/Mosa.DeviceSystem/HardwareAbstraction/HAL.cs @@ -9,7 +9,7 @@ namespace Mosa.DeviceSystem.HardwareAbstraction; /// /// A static class used throughout the code base to call the hardware abstraction layer. It internally sets an instance of a /// class, and effectively does nothing more than that, except from providing a -/// delegate function to handle interrupts coming from anywhere. +/// delegate method to handle interrupts coming from anywhere. /// public static class HAL { @@ -22,7 +22,7 @@ public static class HAL public static void Set(BaseHardwareAbstraction abstraction) => hardwareAbstraction = abstraction; - public static void SetInterruptHandler(HandleInterrupt function) => handleInterrupt = function; + public static void SetInterruptHandler(HandleInterrupt method) => handleInterrupt = method; public static void ProcessInterrupt(byte irq) => handleInterrupt?.Invoke(irq); diff --git a/Source/Mosa.DeviceSystem/Misc/ConstrainedPointer.cs b/Source/Mosa.DeviceSystem/Misc/ConstrainedPointer.cs index e31278f85d..85ce9e23fa 100644 --- a/Source/Mosa.DeviceSystem/Misc/ConstrainedPointer.cs +++ b/Source/Mosa.DeviceSystem/Misc/ConstrainedPointer.cs @@ -7,7 +7,7 @@ namespace Mosa.DeviceSystem.Misc; /// -/// Provides access to a sized region in memory, using a . It also provides functions for directly reading and +/// Provides access to a sized region in memory, using a . It also provides methods for directly reading and /// writing 24-bit integers. /// public readonly struct ConstrainedPointer diff --git a/Source/Mosa.DeviceSystem/Misc/DataBlock.cs b/Source/Mosa.DeviceSystem/Misc/DataBlock.cs index 36ea8bbbde..36fd20f208 100644 --- a/Source/Mosa.DeviceSystem/Misc/DataBlock.cs +++ b/Source/Mosa.DeviceSystem/Misc/DataBlock.cs @@ -5,8 +5,8 @@ namespace Mosa.DeviceSystem.Misc; /// -/// Provides functions for reading and writing specific sized types of data (e.g. various sized integers or byte arrays). It also -/// provides functions for writing those types in a reserved endianness. +/// Provides methods for reading and writing specific sized types of data (e.g. various sized integers or byte arrays). It also +/// provides methods for writing those types in a reserved endianness. /// public class DataBlock { diff --git a/Source/Mosa.DeviceSystem/Mouse/IMouseDevice.cs b/Source/Mosa.DeviceSystem/Mouse/IMouseDevice.cs index 58094f78c5..0c22e445ff 100644 --- a/Source/Mosa.DeviceSystem/Mouse/IMouseDevice.cs +++ b/Source/Mosa.DeviceSystem/Mouse/IMouseDevice.cs @@ -5,7 +5,7 @@ namespace Mosa.DeviceSystem.Mouse; /// /// An interface used for interacting directly with a mouse device. It provides access to the device's raw X and Y coordinates, /// as well as its current state. It is important to provide the screen resolution to the mouse using the SetScreenResolution() -/// function first before using the driver. +/// method first before using the driver. /// public interface IMouseDevice { diff --git a/Source/Mosa.DeviceSystem/TextDevice/TextScreen.cs b/Source/Mosa.DeviceSystem/TextDevice/TextScreen.cs index ad206bfa05..30e5e8753d 100644 --- a/Source/Mosa.DeviceSystem/TextDevice/TextScreen.cs +++ b/Source/Mosa.DeviceSystem/TextDevice/TextScreen.cs @@ -8,7 +8,7 @@ namespace Mosa.DeviceSystem.TextDevice; /// /// A class used for interacting with a text screen (like a TTY), using an and an . /// It can do pretty much everything except reading specific characters at a given cursor position (however, it can sequentially read -/// a line using the ReadLine() function). +/// a line using the ReadLine() method). /// public class TextScreen {