From 28939d40c856aed0b56fe5a4d1d68a906099d745 Mon Sep 17 00:00:00 2001
From: Amlal El Mahrouss <amlalelmahrouss@icloud.com>
Date: Fri, 2 Feb 2024 09:07:33 +0100
Subject: NewBoot: Add documentation to ATA driver.

Signed-off-by: Amlal El Mahrouss <amlalelmahrouss@icloud.com>
---
 Private/NewBoot/BootKit/BootKit.hxx             |  2 +-
 Private/NewBoot/Source/HEL/AMD64/ATA.cxx        | 10 ++++++++++
 Private/NewBoot/Source/HEL/AMD64/Entrypoint.cxx |  1 -
 3 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/Private/NewBoot/BootKit/BootKit.hxx b/Private/NewBoot/BootKit/BootKit.hxx
index 2b57ec56..90ef5156 100644
--- a/Private/NewBoot/BootKit/BootKit.hxx
+++ b/Private/NewBoot/BootKit/BootKit.hxx
@@ -132,4 +132,4 @@ inline UInt32 In32(UInt16 port) {
   return value;
 }
 
-#endif  // __EFI_x86_64__
\ No newline at end of file
+#endif  // __EFI_x86_64__
diff --git a/Private/NewBoot/Source/HEL/AMD64/ATA.cxx b/Private/NewBoot/Source/HEL/AMD64/ATA.cxx
index 80dffa02..4f1b3171 100644
--- a/Private/NewBoot/Source/HEL/AMD64/ATA.cxx
+++ b/Private/NewBoot/Source/HEL/AMD64/ATA.cxx
@@ -179,6 +179,11 @@ BATADevice::BATADevice() noexcept {
   }
 }
 
+/**
+    @brief Read Buf from disk
+    @param Sz Sector size
+    @param Buf buffer
+*/
 BATADevice& BATADevice::Read(CharacterType* Buf, const SizeT& Sz) {
   if (!ATAIsDetected()) return *this;
 
@@ -196,6 +201,11 @@ BATADevice& BATADevice::Read(CharacterType* Buf, const SizeT& Sz) {
   return *this;
 }
 
+/**
+    @brief Write Buf into disk
+    @param Sz Sector size
+    @param Buf buffer
+*/
 BATADevice& BATADevice::Write(CharacterType* Buf, const SizeT& Sz) {
   if (!ATAIsDetected()) return *this;
 
diff --git a/Private/NewBoot/Source/HEL/AMD64/Entrypoint.cxx b/Private/NewBoot/Source/HEL/AMD64/Entrypoint.cxx
index 841a1f40..69f235c4 100644
--- a/Private/NewBoot/Source/HEL/AMD64/Entrypoint.cxx
+++ b/Private/NewBoot/Source/HEL/AMD64/Entrypoint.cxx
@@ -9,7 +9,6 @@
 
 #define __BOOTLOADER__ 1
 
-#include <BootKit/Arch/ATA.hxx>
 #include <BootKit/BootKit.hxx>
 #include <EFIKit/Api.hxx>
 
-- 
cgit v1.2.3