hwidep.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_IDE_REGISTERS
struct	_ATA_TASKFILE
struct	_ATA_DEVICE_REQUEST
struct	_HW_DEVICE_UNIT

Macros
#define	TAG_ATA_DEVICE   'dATA'
#define	ATA_STATUS_SUCCESS   0
#define	ATA_STATUS_PENDING   1
#define	ATA_STATUS_ERROR   2
#define	ATA_STATUS_RESET   3
#define	ATA_STATUS_RETRY   4
#define	CHANNEL_MAX_DEVICES   2
#define	DEV_SLAVE(DeviceNumber)   (DeviceNumber)
#define	ATA_IO_WAIT()   StallExecutionProcessor(1)
#define	ATA_MAX_LBA_28   0x0FFFFFFFULL
#define	ATA_MAX_LBA_48   (1ULL << 48)
#define	IDE_FEATURE_PIO   0x00
#define	IDE_DC_ALWAYS   0x08
#define	IDE_DRIVE_SELECT   0xA0
#define	ATAPI_INT_REASON_COD   0x01
#define	ATAPI_INT_REASON_IO   0x02
#define	ATAPI_INT_REASON_MASK   (ATAPI_INT_REASON_IO | ATAPI_INT_REASON_COD)
#define	ATAPI_INT_REASON_STATUS_NEC   0x00
#define	ATAPI_INT_REASON_STATUS   (ATAPI_INT_REASON_IO | ATAPI_INT_REASON_COD)
#define	ATAPI_INT_REASON_AWAIT_CDB   (IDE_STATUS_DRQ | ATAPI_INT_REASON_COD)
#define	ATAPI_INT_REASON_DATA_IN   (ATAPI_INT_REASON_IO | IDE_STATUS_DRQ)
#define	MAXIMUM_CDROM_SIZE   804
#define	ATA_TIME_BUSY_SELECT   2000
	20 ms
#define	ATA_TIME_BUSY_POLL   500000
	5 s
#define	ATA_TIME_BUSY_ENUM   100
	1 ms
#define	ATA_TIME_BUSY_RESET   1000000
	10 s
#define	ATA_TIME_RESET_SELECT   200000
	2 s
#define	ATA_TIME_DRQ_CLEAR   100
	200 us
#define	ATA_TIME_PHASE_CHANGE   100
	1 ms
#define	ATA_WRITE(Port, Value)    WRITE_PORT_UCHAR((PUCHAR)(ULONG_PTR)(Port), (Value))
#define	ATA_WRITE_BLOCK_16(Port, Buffer, Count)    WRITE_PORT_BUFFER_USHORT((PUSHORT)(ULONG_PTR)(Port), (PUSHORT)(Buffer), (Count))
#define	ATA_WRITE_BLOCK_32(Port, Buffer, Count)    WRITE_PORT_BUFFER_ULONG((PULONG)(ULONG_PTR)(Port), (PULONG)(Buffer), (Count))
#define	ATA_READ(Port)    READ_PORT_UCHAR((PUCHAR)(ULONG_PTR)(Port))
#define	ATA_READ_BLOCK_16(Port, Buffer, Count)    READ_PORT_BUFFER_USHORT((PUSHORT)(ULONG_PTR)(Port), (PUSHORT)(Buffer), (Count))
#define	ATA_READ_BLOCK_32(Port, Buffer, Count)    READ_PORT_BUFFER_ULONG((PULONG)(ULONG_PTR)(Port), (PULONG)(Buffer), (Count))
#define	REQUEST_FLAG_LBA48   0x00000001
#define	REQUEST_FLAG_READ_WRITE_MULTIPLE   0x00000002
#define	REQUEST_FLAG_PACKET_COMMAND   0x00000004
#define	REQUEST_FLAG_SET_DEVICE_REGISTER   0x00000008
#define	REQUEST_FLAG_AWAIT_CDB   0x00000010
#define	REQUEST_FLAG_READ_COMMAND   0x00000020
#define	REQUEST_FLAG_IDENTIFY_COMMAND   0x00000040

Typedefs
typedef ULONG_PTR	IDE_REG
typedef enum _ATA_DEVICE_CLASS	ATA_DEVICE_CLASS
typedef enum _ATA_DEVICE_CLASS *	PATA_DEVICE_CLASS
typedef struct _IDE_REGISTERS	IDE_REGISTERS
typedef struct _IDE_REGISTERS *	PIDE_REGISTERS
typedef struct _ATA_TASKFILE	ATA_TASKFILE
typedef struct _ATA_TASKFILE *	PATA_TASKFILE
typedef struct _ATA_DEVICE_REQUEST	ATA_DEVICE_REQUEST
typedef struct _ATA_DEVICE_REQUEST *	PATA_DEVICE_REQUEST
typedef struct _HW_DEVICE_UNIT	HW_DEVICE_UNIT
typedef struct _HW_DEVICE_UNIT *	PHW_DEVICE_UNIT

Enumerations
enum	_ATA_DEVICE_CLASS { DEV_ATA , DEV_ATAPI , DEV_NONE }

Functions
FORCEINLINE BOOLEAN	AtaDevIsIdentifyDataValid (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE UCHAR	AtaDevCdbSizeInWords (_In_ PIDENTIFY_PACKET_DATA IdentifyPacketData)
FORCEINLINE BOOLEAN	AtaDevHasLbaTranslation (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE ULONG	AtaDevUserAddressableSectors28Bit (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE ULONG64	AtaDevUserAddressableSectors48Bit (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE BOOLEAN	AtaDevHas48BitAddressFeature (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE BOOLEAN	AtaDevIsCurrentGeometryValid (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE VOID	AtaDevDefaultChsTranslation (_In_ PIDENTIFY_DEVICE_DATA IdentifyData, _Out_ PUSHORT Cylinders, _Out_ PUSHORT Heads, _Out_ PUSHORT SectorsPerTrack)
FORCEINLINE VOID	AtaDevCurrentChsTranslation (_In_ PIDENTIFY_DEVICE_DATA IdentifyData, _Out_ PUSHORT Cylinders, _Out_ PUSHORT Heads, _Out_ PUSHORT SectorsPerTrack)
FORCEINLINE UCHAR	AtaDevCurrentSectorsPerDrq (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE UCHAR	AtaDevMaximumSectorsPerDrq (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE ULONG	AtaDevBytesPerLogicalSector (_In_ PIDENTIFY_DEVICE_DATA IdentifyData)
FORCEINLINE BOOLEAN	AtaCommandUseLba48 (_In_ ULONG64 SectorNumber, _In_ ULONG SectorCount)

Macro Definition Documentation

ATA_IO_WAIT

#define ATA_IO_WAIT

(

)

StallExecutionProcessor(1)

Definition at line 37 of file hwidep.h.

ATA_MAX_LBA_28

#define ATA_MAX_LBA_28   0x0FFFFFFFULL

Definition at line 47 of file hwidep.h.

ATA_MAX_LBA_48

#define ATA_MAX_LBA_48   (1ULL << 48)

Definition at line 48 of file hwidep.h.

ATA_READ

#define ATA_READ

(

Port

)

READ_PORT_UCHAR((PUCHAR)(ULONG_PTR)(Port))

Definition at line 84 of file hwidep.h.

ATA_READ_BLOCK_16

#define ATA_READ_BLOCK_16	(		Port,
			Buffer,
			Count
	)		READ_PORT_BUFFER_USHORT((PUSHORT)(ULONG_PTR)(Port), (PUSHORT)(Buffer), (Count))

Definition at line 87 of file hwidep.h.

ATA_READ_BLOCK_32

#define ATA_READ_BLOCK_32	(		Port,
			Buffer,
			Count
	)		READ_PORT_BUFFER_ULONG((PULONG)(ULONG_PTR)(Port), (PULONG)(Buffer), (Count))

Definition at line 90 of file hwidep.h.

ATA_STATUS_ERROR

#define ATA_STATUS_ERROR   2

Definition at line 14 of file hwidep.h.

ATA_STATUS_PENDING

#define ATA_STATUS_PENDING   1

Definition at line 13 of file hwidep.h.

ATA_STATUS_RESET

#define ATA_STATUS_RESET   3

Definition at line 15 of file hwidep.h.

ATA_STATUS_RETRY

#define ATA_STATUS_RETRY   4

Definition at line 16 of file hwidep.h.

ATA_STATUS_SUCCESS

#define ATA_STATUS_SUCCESS   0

Definition at line 12 of file hwidep.h.

ATA_TIME_BUSY_ENUM

#define ATA_TIME_BUSY_ENUM   100

1 ms

Definition at line 69 of file hwidep.h.

ATA_TIME_BUSY_POLL

#define ATA_TIME_BUSY_POLL   500000

5 s

Definition at line 68 of file hwidep.h.

ATA_TIME_BUSY_RESET

#define ATA_TIME_BUSY_RESET   1000000

10 s

Definition at line 70 of file hwidep.h.

ATA_TIME_BUSY_SELECT

#define ATA_TIME_BUSY_SELECT   2000

20 ms

Definition at line 67 of file hwidep.h.

ATA_TIME_DRQ_CLEAR

#define ATA_TIME_DRQ_CLEAR   100

200 us

Definition at line 72 of file hwidep.h.

ATA_TIME_PHASE_CHANGE

#define ATA_TIME_PHASE_CHANGE   100

1 ms

Definition at line 73 of file hwidep.h.

ATA_TIME_RESET_SELECT

#define ATA_TIME_RESET_SELECT   200000

2 s

Definition at line 71 of file hwidep.h.

ATA_WRITE

#define ATA_WRITE	(		Port,
			Value
	)		WRITE_PORT_UCHAR((PUCHAR)(ULONG_PTR)(Port), (Value))

Definition at line 75 of file hwidep.h.

ATA_WRITE_BLOCK_16

#define ATA_WRITE_BLOCK_16	(		Port,
			Buffer,
			Count
	)		WRITE_PORT_BUFFER_USHORT((PUSHORT)(ULONG_PTR)(Port), (PUSHORT)(Buffer), (Count))

Definition at line 78 of file hwidep.h.

ATA_WRITE_BLOCK_32

#define ATA_WRITE_BLOCK_32	(		Port,
			Buffer,
			Count
	)		WRITE_PORT_BUFFER_ULONG((PULONG)(ULONG_PTR)(Port), (PULONG)(Buffer), (Count))

Definition at line 81 of file hwidep.h.

ATAPI_INT_REASON_AWAIT_CDB

#define ATAPI_INT_REASON_AWAIT_CDB   (IDE_STATUS_DRQ | ATAPI_INT_REASON_COD)

Definition at line 62 of file hwidep.h.

ATAPI_INT_REASON_COD

#define ATAPI_INT_REASON_COD   0x01

Definition at line 56 of file hwidep.h.

ATAPI_INT_REASON_DATA_IN

#define ATAPI_INT_REASON_DATA_IN   (ATAPI_INT_REASON_IO | IDE_STATUS_DRQ)

Definition at line 63 of file hwidep.h.

ATAPI_INT_REASON_IO

#define ATAPI_INT_REASON_IO   0x02

Definition at line 57 of file hwidep.h.

ATAPI_INT_REASON_MASK

#define ATAPI_INT_REASON_MASK   (ATAPI_INT_REASON_IO | ATAPI_INT_REASON_COD)

Definition at line 58 of file hwidep.h.

ATAPI_INT_REASON_STATUS

#define ATAPI_INT_REASON_STATUS   (ATAPI_INT_REASON_IO | ATAPI_INT_REASON_COD)

Definition at line 61 of file hwidep.h.

ATAPI_INT_REASON_STATUS_NEC

#define ATAPI_INT_REASON_STATUS_NEC   0x00

Definition at line 60 of file hwidep.h.

CHANNEL_MAX_DEVICES

#define CHANNEL_MAX_DEVICES   2

Definition at line 24 of file hwidep.h.

DEV_SLAVE

#define DEV_SLAVE

(

DeviceNumber

)

(DeviceNumber)

Definition at line 25 of file hwidep.h.

IDE_DC_ALWAYS

#define IDE_DC_ALWAYS   0x08

Definition at line 52 of file hwidep.h.

IDE_DRIVE_SELECT

#define IDE_DRIVE_SELECT   0xA0

Definition at line 54 of file hwidep.h.

IDE_FEATURE_PIO

#define IDE_FEATURE_PIO   0x00

Definition at line 50 of file hwidep.h.

MAXIMUM_CDROM_SIZE

#define MAXIMUM_CDROM_SIZE   804

Definition at line 65 of file hwidep.h.

REQUEST_FLAG_AWAIT_CDB

#define REQUEST_FLAG_AWAIT_CDB   0x00000010

Definition at line 166 of file hwidep.h.

REQUEST_FLAG_IDENTIFY_COMMAND

#define REQUEST_FLAG_IDENTIFY_COMMAND   0x00000040

Definition at line 168 of file hwidep.h.

REQUEST_FLAG_LBA48

#define REQUEST_FLAG_LBA48   0x00000001

Definition at line 162 of file hwidep.h.

REQUEST_FLAG_PACKET_COMMAND

#define REQUEST_FLAG_PACKET_COMMAND   0x00000004

Definition at line 164 of file hwidep.h.

REQUEST_FLAG_READ_COMMAND

#define REQUEST_FLAG_READ_COMMAND   0x00000020

Definition at line 167 of file hwidep.h.

REQUEST_FLAG_READ_WRITE_MULTIPLE

#define REQUEST_FLAG_READ_WRITE_MULTIPLE   0x00000002

Definition at line 163 of file hwidep.h.

REQUEST_FLAG_SET_DEVICE_REGISTER

#define REQUEST_FLAG_SET_DEVICE_REGISTER   0x00000008

Definition at line 165 of file hwidep.h.

TAG_ATA_DEVICE

#define TAG_ATA_DEVICE   'dATA'

Definition at line 10 of file hwidep.h.

Typedef Documentation

ATA_DEVICE_CLASS

typedef enum _ATA_DEVICE_CLASS ATA_DEVICE_CLASS

ATA_DEVICE_REQUEST

typedef struct _ATA_DEVICE_REQUEST ATA_DEVICE_REQUEST

ATA_TASKFILE

typedef struct _ATA_TASKFILE ATA_TASKFILE

HW_DEVICE_UNIT

typedef struct _HW_DEVICE_UNIT HW_DEVICE_UNIT

IDE_REG

typedef ULONG_PTR IDE_REG

Definition at line 44 of file hwidep.h.

IDE_REGISTERS

typedef struct _IDE_REGISTERS IDE_REGISTERS

PATA_DEVICE_CLASS

typedef enum _ATA_DEVICE_CLASS * PATA_DEVICE_CLASS

PATA_DEVICE_REQUEST

typedef struct _ATA_DEVICE_REQUEST * PATA_DEVICE_REQUEST

PATA_TASKFILE

typedef struct _ATA_TASKFILE * PATA_TASKFILE

PHW_DEVICE_UNIT

typedef struct _HW_DEVICE_UNIT * PHW_DEVICE_UNIT

PIDE_REGISTERS

typedef struct _IDE_REGISTERS * PIDE_REGISTERS

Enumeration Type Documentation

_ATA_DEVICE_CLASS

enum _ATA_DEVICE_CLASS

Enumerator
DEV_ATA
DEV_ATAPI
DEV_NONE

Definition at line 93 of file hwidep.h.

{
    DEV_ATA,
    DEV_ATAPI,
    DEV_NONE,
} ATA_DEVICE_CLASS, *PATA_DEVICE_CLASS;

Function Documentation

AtaCommandUseLba48()

FORCEINLINE BOOLEAN AtaCommandUseLba48	(	_In_ ULONG64	SectorNumber,
		_In_ ULONG	SectorCount
	)

Definition at line 381 of file hwidep.h.

{
    /* Use the 48-bit command when reasonable */
    return (((SectorNumber + SectorCount) >= ATA_MAX_LBA_28) || (SectorCount > 0x100));
}

Referenced by AtapBuildReadTaskFile().

AtaDevBytesPerLogicalSector()

FORCEINLINE ULONG AtaDevBytesPerLogicalSector

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 357 of file hwidep.h.

{
    ULONG WordCount;
 
    /* Word 106: 15 = 0, 14 = 1, 12 = 1 */
    if (IdentifyData->PhysicalLogicalSectorSize.Reserved1 == 1 &&
        IdentifyData->PhysicalLogicalSectorSize.LogicalSectorLongerThan256Words)
    {
        /* Words 116-117 */
        WordCount = IdentifyData->WordsPerLogicalSector[0];
        WordCount |= (ULONG)IdentifyData->WordsPerLogicalSector[1] << 16;
    }
    else
    {
        /* 256 words = 512 bytes */
        WordCount = 256;
    }
 
    return WordCount * sizeof(USHORT);
}

Referenced by AtapAtaInitDevice().

AtaDevCdbSizeInWords()

FORCEINLINE UCHAR AtaDevCdbSizeInWords

(

_In_ PIDENTIFY_PACKET_DATA

IdentifyPacketData

)

Definition at line 221 of file hwidep.h.

{
    /* Bits 0:2 of word 0 */
    return (IdentifyPacketData->GeneralConfiguration.PacketType != 0) ? 8 : 6;
}

Referenced by AtapAtapiInitDevice().

AtaDevCurrentChsTranslation()

FORCEINLINE VOID AtaDevCurrentChsTranslation	(	_In_ PIDENTIFY_DEVICE_DATA	IdentifyData,
		_Out_ PUSHORT	Cylinders,
		_Out_ PUSHORT	Heads,
		_Out_ PUSHORT	SectorsPerTrack
	)

Definition at line 303 of file hwidep.h.

{
    /* Word 54 */
    *Cylinders = IdentifyData->NumberOfCurrentCylinders;
 
    /* Word 55 */
    *Heads = IdentifyData->NumberOfCurrentHeads;
 
    /* Word 55 */
    *SectorsPerTrack = IdentifyData->CurrentSectorsPerTrack;
}

Referenced by AtapAtaInitDevice().

AtaDevCurrentSectorsPerDrq()

FORCEINLINE UCHAR AtaDevCurrentSectorsPerDrq

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 321 of file hwidep.h.

{
    UCHAR MultiSectorCurrent;
 
    /* Bit 8 of word 59 */
    if (!(IdentifyData->MultiSectorSettingValid))
        return 0;
 
    /* The word 59 should be a power of 2 */
    MultiSectorCurrent = IdentifyData->CurrentMultiSectorSetting;
 
    if ((MultiSectorCurrent > 0) && ((MultiSectorCurrent & (MultiSectorCurrent - 1)) == 0))
        return MultiSectorCurrent;
 
    return 0;
}

Referenced by AtapAtaSetMultipleMode().

AtaDevDefaultChsTranslation()

FORCEINLINE VOID AtaDevDefaultChsTranslation	(	_In_ PIDENTIFY_DEVICE_DATA	IdentifyData,
		_Out_ PUSHORT	Cylinders,
		_Out_ PUSHORT	Heads,
		_Out_ PUSHORT	SectorsPerTrack
	)

Definition at line 285 of file hwidep.h.

{
    /* Word 1 */
    *Cylinders = IdentifyData->NumCylinders;
 
    /* Word 3 */
    *Heads = IdentifyData->NumHeads;
 
    /* Word 6 */
    *SectorsPerTrack = IdentifyData->NumSectorsPerTrack;
}

Referenced by AtapAtaInitDevice().

AtaDevHas48BitAddressFeature()

FORCEINLINE BOOLEAN AtaDevHas48BitAddressFeature

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 257 of file hwidep.h.

{
    /* Word 83: 15 = 0, 14 = 1 */
   if (IdentifyData->CommandSetSupport.WordValid83 == 1)
   {
        /* Bit 10 of word 83 */
        return IdentifyData->CommandSetSupport.BigLba;
   }
 
   return FALSE;
}

Referenced by AtapAtaInitDevice().

AtaDevHasLbaTranslation()

FORCEINLINE BOOLEAN AtaDevHasLbaTranslation

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 230 of file hwidep.h.

{
    /* Bit 9 of word 49 */
    return IdentifyData->Capabilities.LbaSupported;
}

Referenced by AtapAtaInitDevice().

AtaDevIsCurrentGeometryValid()

FORCEINLINE BOOLEAN AtaDevIsCurrentGeometryValid

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 272 of file hwidep.h.

{
    return ((IdentifyData->TranslationFieldsValid & 1) &&
            (IdentifyData->NumberOfCurrentCylinders != 0) &&
            (IdentifyData->NumberOfCurrentCylinders <= 63) &&
            (IdentifyData->NumberOfCurrentHeads != 0) &&
            (IdentifyData->NumberOfCurrentHeads <= 16) &&
            (IdentifyData->CurrentSectorsPerTrack != 0));
}

Referenced by AtapAtaInitDevice().

AtaDevIsIdentifyDataValid()

FORCEINLINE BOOLEAN AtaDevIsIdentifyDataValid

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 196 of file hwidep.h.

{
    ULONG i;
    UCHAR Crc;
 
    /* Bits 0:8 of word 255 */
    if (IdentifyData->Signature != 0xA5)
    {
        /* The integrity word is missing, assume the data provided by the device is valid */
        return TRUE;
    }
 
    /* Verify the checksum */
    Crc = 0;
    for (i = 0; i < sizeof(*IdentifyData); ++i)
    {
        Crc += ((PUCHAR)IdentifyData)[i];
    }
 
    return (Crc == 0);
}

Referenced by AtapAnalyzeIdentifyData().

AtaDevMaximumSectorsPerDrq()

FORCEINLINE UCHAR AtaDevMaximumSectorsPerDrq

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 341 of file hwidep.h.

{
    UCHAR MultiSectorMax;
 
    /* The word 47 should be a power of 2 */
    MultiSectorMax = IdentifyData->MaximumBlockTransfer;
 
    if ((MultiSectorMax > 0) && ((MultiSectorMax & (MultiSectorMax - 1)) == 0))
        return MultiSectorMax;
 
    return 0;
}

Referenced by AtapAtaSetMultipleMode().

AtaDevUserAddressableSectors28Bit()

FORCEINLINE ULONG AtaDevUserAddressableSectors28Bit

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 239 of file hwidep.h.

{
    /* Words 60-61 */
    return IdentifyData->UserAddressableSectors;
}

Referenced by AtapAtaInitDevice().

AtaDevUserAddressableSectors48Bit()

FORCEINLINE ULONG64 AtaDevUserAddressableSectors48Bit

(

_In_ PIDENTIFY_DEVICE_DATA

IdentifyData

)

Definition at line 248 of file hwidep.h.

{
    /* Words 100-103 */
    return ((ULONG64)IdentifyData->Max48BitLBA[1] << 32) | IdentifyData->Max48BitLBA[0];
}

Referenced by AtapAtaInitDevice().