From 491f19514fe986954e702e14023a2d9b1b54e066 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Wed, 8 Jan 2025 09:26:13 +0100 Subject: ADD: Format user name according to type of user in k*User macros. ADD: Refactor Power mgmt API in SCI. ADD: Rework documentation of AHCI. Signed-off-by: Amlal El Mahrouss --- dev/Mod/AHCI/AHCI.h | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) (limited to 'dev/Mod') diff --git a/dev/Mod/AHCI/AHCI.h b/dev/Mod/AHCI/AHCI.h index f7211267..1e3324cf 100644 --- a/dev/Mod/AHCI/AHCI.h +++ b/dev/Mod/AHCI/AHCI.h @@ -13,10 +13,13 @@ #pragma once +#if defined(__AHCI__) + #include #include -/// @note Forward declarations of structs. +/// @file AHCI.h +/// @brief AHCI support. #define kAHCISectorSize (512) @@ -328,8 +331,6 @@ typedef struct HbaCmdTbl final struct HbaPrdtEntry PrdtEntries[1]; // Physical region descriptor table entries, 0 ~ 65535 } HbaCmdTbl; -#if defined(__AHCI__) - /// @brief Initializes an AHCI disk. /// @param PortsImplemented the amount of port that have been detected. /// @return @@ -337,26 +338,26 @@ Kernel::Boolean drv_std_init(Kernel::UInt16& PortsImplemented); Kernel::Boolean drv_std_detected(Kernel::Void); -/// @brief Read from disk. -/// @param Lba -/// @param Buf -/// @param SectorSz -/// @param Size +/// @brief Read from AHCI disk. +/// @param lba +/// @param buf +/// @param sector_sz +/// @param buf_sz /// @return Kernel::Void drv_std_read(Kernel::UInt64 lba, Kernel::Char* buf, Kernel::SizeT sector_sz, Kernel::SizeT buf_sz); -/// @brief Write to disk. -/// @param Lba -/// @param Buf -/// @param SectorSz -/// @param Size +/// @brief Write to AHCI disk. +/// @param lba +/// @param buf +/// @param sector_sz +/// @param buf_sz /// @return Kernel::Void drv_std_write(Kernel::UInt64 lba, Kernel::Char* buf, Kernel::SizeT sector_sz, Kernel::SizeT buf_sz); -/// @brief get sector count. +/// @brief Gets the sector count from AHCI disk. Kernel::SizeT drv_get_sector_count(); -/// @brief get device size. +/// @brief Gets the AHCI disk size. Kernel::SizeT drv_get_size(); #endif // ifdef __AHCI__ -- cgit v1.2.3