ATA.h

Go to the documentation of this file.

/* -------------------------------------------
 
  Copyright (C) 2024-2025, Amlal El Mahrouss, all rights reserved.
 
  File: Defines.h
  Purpose: ATA header.
 
  Revision History:
 
  03/02/24: Added file (amlel)
 
------------------------------------------- */
 
#pragma once
 
#include <CompilerKit/CompilerKit.h>
#include <NeKit/Defines.h>

#define ATA_SR_BSY 0x80
#define ATA_SR_DRDY 0x40
#define ATA_SR_DF 0x20
#define ATA_SR_DSC 0x10
#define ATA_SR_DRQ 0x08
#define ATA_SR_CORR 0x04
#define ATA_SR_IDX 0x02
#define ATA_SR_ERR 0x01

#define ATA_ER_BBK 0x80
#define ATA_ER_UNC 0x40
#define ATA_ER_MC 0x20
#define ATA_ER_IDNF 0x10
#define ATA_ER_MCR 0x08
#define ATA_ER_ABRT 0x04
#define ATA_ER_TK0NF 0x02
#define ATA_ER_AMNF 0x01
 
#define ATA_CMD_READ_PIO 0x20
#define ATA_CMD_READ_PIO_EXT 0x24
#define ATA_CMD_READ_DMA 0xC8
#define ATA_CMD_READ_DMA_EXT 0x25
#define ATA_CMD_WRITE_PIO 0x30
#define ATA_CMD_WRITE_PIO_EXT 0x34
#define ATA_CMD_WRITE_DMA 0xCA
#define ATA_CMD_WRITE_DMA_EXT 0x35
#define ATA_CMD_CACHE_FLUSH 0xE7
#define ATA_CMD_CACHE_FLUSH_EXT 0xEA
#define ATA_CMD_PACKET 0xA0
#define ATA_CMD_IDENTIFY_PACKET 0xA1
#define ATA_CMD_IDENTIFY 0xEC

#define ATA_IDENT_DEVICE_TYPE 0
#define ATA_IDENT_CYLINDERS 2
#define ATA_IDENT_HEADS 6
#define ATA_IDENT_SECTORS 12
#define ATA_IDENT_SERIAL 20
#define ATA_IDENT_MODEL 54
#define ATA_IDENT_CAPABILITIES 98
#define ATA_IDENT_FIELDVALID 106
#define ATA_IDENT_MAX_LBA 120
#define ATA_IDENT_COMMANDSETS 164
#define ATA_IDENT_MAX_LBA_EXT 200
 
#define ATA_REG_SET_FEATURES 0xEF
 
#define ATA_MASTER 0x00
#define ATA_SLAVE 0x01

#define ATA_REG_DATA 0x00
#define ATA_REG_ERROR 0x01
#define ATA_REG_FEATURES 0x01
#define ATA_REG_SEC_COUNT0 0x02
#define ATA_REG_LBA0 0x03
#define ATA_REG_LBA1 0x04
#define ATA_REG_LBA2 0x05
#define ATA_REG_HDDEVSEL 0x06
#define ATA_REG_COMMAND 0x07
#define ATA_REG_STATUS 0x07
#define ATA_REG_SEC_COUNT1 0x08
#define ATA_REG_LBA3 0x09
#define ATA_REG_LBA4 0x0A
#define ATA_REG_LBA5 0x0B
#define ATA_REG_CONTROL 0x0C
#define ATA_REG_ALT_STATUS 0x0C
#define ATA_REG_DEV_ADDRESS 0x0D
 
#define ATA_REG_NEIN 0x01
 
#define ATA_PRIMARY_IO 0x1F0
#define ATA_SECONDARY_IO 0x170
#define ATA_PRIMARY_DCR_AS 0x3F6
#define ATA_SECONDARY_DCR_AS 0x376

#define ATA_PRIMARY_IRQ 14
#define ATA_SECONDARY_IRQ 15

#define ATA_PRIMARY 0x00
#define ATA_SECONDARY 0x01
 
#define ATA_CYL_LOW 3
#define ATA_CYL_MID 4
#define ATA_CYL_HIGH 5

#define ATA_READ 0x00
#define ATA_WRITE 0x013
 
#define ATA_PRIMARY_SEL 0xA0
#define ATA_SECONDARY_SEL 0xB0

#define ATA_ADDRESS1(x) (x + 3)
#define ATA_ADDRESS2(x) (x + 4)
#define ATA_ADDRESS3(x) (x + 5)

#define ATA_COMMAND(x) (x + 7)
 
#define kATASectorSize (512U)
 
enum {
  kATADevicePATA,
  kATADeviceSATA,
  kATADevicePATA_PI,
  kATADeviceSATA_PI,
  kATADeviceCount,
};
 
#if defined(__ATA_PIO__) || defined(__ATA_DMA__)
 
Kernel::Boolean drv_std_init(Kernel::UInt16 in_bus, Kernel::UInt8 drive, Kernel::UInt16& out_bus,
                             Kernel::UInt8& out_master);
 
Kernel::Boolean drv_std_detected(Kernel::Void);
 
Kernel::Void drv_std_select(Kernel::UInt16 bus);
 
Kernel::Boolean drv_std_wait_io(Kernel::UInt16 io);
 
Kernel::Void drv_std_read(Kernel::UInt64 lba, Kernel::UInt16 io, Kernel::UInt8 is_master,
                          Kernel::Char* buf, Kernel::SizeT sec_sz, Kernel::SizeT buf_sz);
 
Kernel::Void drv_std_write(Kernel::UInt64 lba, Kernel::UInt16 io, Kernel::UInt8 is_master,
                           Kernel::Char* buf, Kernel::SizeT sec_sz, Kernel::SizeT buf_sz);

Kernel::SizeT drv_std_get_sector_count();

Kernel::SizeT drv_std_get_size();
 
#endif  // ifdef __NEOSKRNL__