summaryrefslogtreecommitdiffhomepage
path: root/dev/modules/MBCI
diff options
context:
space:
mode:
authorAmlal EL Mahrouss <amlalelmahrouss@icloud.com>2024-10-03 05:32:46 +0200
committerAmlal EL Mahrouss <amlalelmahrouss@icloud.com>2024-10-03 05:32:46 +0200
commit36b8e46de0e92aff31664470bb3587a91517ab99 (patch)
tree780ce906e9273ebbee00a96230557e0b7e9ac9d9 /dev/modules/MBCI
parent3e30ee1749d19f5188560f9a5cdab922180c71ca (diff)
IMP: Fixes improvements and new APIs and implementations.
- Add more threading API calls. - Moved /dev/zka/modules/ to /dev/modules/. - Add APM API inside /dev/modules. - Add SInt{x} types inside Defines.hxx. - Fix formatting inside PRM. Signed-off-by: Amlal EL Mahrouss <amlalelmahrouss@icloud.com>
Diffstat (limited to 'dev/modules/MBCI')
-rw-r--r--dev/modules/MBCI/Interface.hxx10
-rw-r--r--dev/modules/MBCI/MBCI.hxx99
2 files changed, 109 insertions, 0 deletions
diff --git a/dev/modules/MBCI/Interface.hxx b/dev/modules/MBCI/Interface.hxx
new file mode 100644
index 00000000..e895b3f2
--- /dev/null
+++ b/dev/modules/MBCI/Interface.hxx
@@ -0,0 +1,10 @@
+/* -------------------------------------------
+
+ Copyright ZKA Technologies.
+
+------------------------------------------- */
+
+#pragma once
+
+#include <NewKit/Defines.hxx>
+#include <modules/MBCI/MBCI.hxx>
diff --git a/dev/modules/MBCI/MBCI.hxx b/dev/modules/MBCI/MBCI.hxx
new file mode 100644
index 00000000..cc525a77
--- /dev/null
+++ b/dev/modules/MBCI/MBCI.hxx
@@ -0,0 +1,99 @@
+/* -------------------------------------------
+
+ Copyright ZKA Technologies.
+
+------------------------------------------- */
+
+#ifndef _INC_MODULE_MBCI_HXX_
+#define _INC_MODULE_MBCI_HXX_
+
+#include <NewKit/Defines.hxx>
+#include <modules/ACPI/ACPI.hxx>
+
+/**
+- VCC (IN) (OUT for MCU)
+- CLK (IN) (OUT for MCU)
+- ACK (BI) (Contains an Acknowledge Packet Frame)
+- D0- (IN) (Starts with the Host Interface Packet Frame)
+- D1- (IN) (Starts with the Host Interface Packet Frame)
+- D0+ (OUT) (Starts with the Host Interface Packet Frame)
+- D1+ (OUT) (Starts with the Host Interface Packet Frame)
+- GND (IN) (OUT for MCU)
+ */
+
+#define cMBCIZeroSz (8)
+#define cMBCIMagic "MBCI "
+
+namespace Kernel
+{
+ struct IMBCIHost;
+ struct IMBCIHostPacketFrame;
+
+ /// @brief MBCI Packet frame header
+ struct PACKED IMBCIHostPacketFrame final
+ {
+ UInt32 Magic;
+ UInt32 HostId;
+ UInt32 Flags;
+ UInt32 VendorId;
+ UInt32 DeviceId;
+ UInt32 DeviceSpeed;
+ Bool Acknowledge;
+ Char Zero[cMBCIZeroSz];
+ };
+
+ enum
+ {
+ eMBCISpeedDeviceInvalid,
+ eMBCILowSpeedDevice,
+ eMBCIHighSpeedDevice,
+ eMBCISpeedDeviceCount,
+ };
+
+ /// @brief MBCI Host Interface header.
+ struct PACKED IMBCIHost final
+ {
+ UInt32 Magic;
+ UInt32 HostId;
+ UInt16 VendorId;
+ UInt16 DeviceId;
+ UInt8 MemoryType;
+ UInt16 HostType;
+ UInt16 HostFlags;
+ UInt8 Error;
+ UInt8 Status;
+ UInt8 InterruptEnable;
+ UInt64 BaseAddressRegister;
+ UInt64 BaseAddressRegisterSize;
+ Char Zero[cMBCIZeroSz];
+ };
+
+ /// @brief MBCI host flags.
+ enum MBCIHostFlags
+ {
+ eMBCIHostFlagsSupportsNothing, // Invalid MBCI device.
+ eMBCIHostFlagsSupportsAPM, // Advanced Power Management.
+ eMBCIHostFlagsSupportsDaisyChain, // Is daisy chained.
+ eMBCIHostFlagsSupportsHWInterrupts, // Has HW interrupts.
+ eMBCIHostFlagsSupportsDMA, // Has DMA.
+ eMBCIHostFlagsExtended = __UINT16_MAX__, // Extended flags table.
+ };
+
+ enum MBCIHostKind
+ {
+ eMBCIHostKindHardDisk,
+ eMBCIHostKindOpticalDisk,
+ eMBCIHostKindKeyboardLow,
+ eMBCIHostKindMouseLow,
+ eMBCIHostKindMouseHigh,
+ eMBCIHostKindKeyboardHigh,
+ eMBCIHostKindNetworkInterface,
+ eMBCIHostKindDaisyChain,
+ eMBCIHostKindStartExtended = __UINT16_MAX__, // Extended vendor table.
+ };
+
+ /// @brief An AuthKey is a context used to decrpy data from an MBCI packet.
+ typedef UInt64 MBCIAuthyKeyType;
+} // namespace Kernel
+
+#endif // ifndef _INC_MODULE_MBCI_HXX_