Description

This page describes the IdeController interface which provides services from an IDE controller.

Structures

typedef struct {
    unsigned char port;
    unsigned char data;
} IdeController_RequestPort;

typedef struct {
    unsigned int version;
    unsigned int interface;
    unsigned int drive;
    unsigned int timeout;
    int flags;
    unsigned int numIOs;
    unsigned char status;
    unsigned char error;
    IdeController_RequestPort IOs[1];
} IdeController_Request;

Where version is the structure version (version 1), interface the interface, drive the drive, timeout the amount of seconds to wait before time out the request, flags control the request and can be 0 or the sum of:

• IdeController_PROBE_MODE - It is a request made to a drive which may not exist
• IdeController_START_MULTISECTOR - It is the start of a multisector request
• IdeController_ONE_SECTOR - It is a request of one sector
• IdeController_CONT_MULTISECTOR - It is a continuation of a multisector request
• IdeController_END_MULTISECTOR - It is the end of a multisector request

status and error will contain the status and error byte in return.

numIOs it is the size o the IO array which contains the IO ports and the data to be write in these ports.

The IO ports present in IO will be write from IO[0] till IO[numIOs-1] in this order.

port must contain one of these values:

• IdeController_FEATURE_PORT - Feature port
• IdeController_SECTOR_COUNT_PORT - Sector count port
• IdeController_SECTOR_NUMBER_PORT - Number of sectors port
• IdeController_LOW_CYL_PORT - Cylinder number port (low part)
• IdeController_HIGH_CYL_PORT - Cylinder number port (high part)
• IdeController_DRIVE_PORT - Drive/head port. The data should only contain information about the head. The other bits will be set by the IdeController.
• IdeController_COMMAND_PORT - Command port

typedef struct {
    unsigned int version;
    unsigned int interface;
    unsigned int drive;
    int flags;
} IdeController_Setup;

Where version it is the structure version (version 1), interface the interface, drive the drive and flags must be 0 or the sum of:

• IdeController_SETUP_LBA - set LBA for the drive

These functions are exclusive for system modules.

0x00 - GetDrive

Syntax

int IdeController_GetDrive(unsigned int interface, unsigned int drive);

Properties

• System
• Phase 1

Description

This function gets drive from interface for exclusive use.

drive and interface start at zero.

To free drive use PutDrive.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_BUSY - The drive is already in use
• E_NO_SUCH_INTERFACE - The interface does not exist
• E_NO_SUCH_DRIVE - The drive does not exist

0x01 - LockInterface

Syntax

int IdeController_LockInterface(unsigned int interface);

Properties

• System
• Phase 1

Description

This function locks interface for exclusive use.

The calling thread will block until it gets exclusive use.

interface starts at zero.

Before an IDE interface can be used on any IdeController function it must be locked for exclusive use using LockInterface.

To unlock use UnlockInterface.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist
• E_INTERRUPTED - The operation was interrupted

0x02 - PutDrive

Syntax

int IdeController_PutDrive(unsigned int interface, unsigned int drive);

Properties

• System
• Phase 1

Description

This function frees drive from interface.

drive and interface start at zero.

If drive was not got nothing happens and the function returns success.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist
• E_NO_SUCH_DRIVE - The drive does not exist

0x03 - ReadData

Syntax

int IdeController_ReadData(unsigned int interface, void *buf, unsigned int size);

Properties

• System
• Phase 1

Description

This function reads size bytes from interface and puts them in buf.

interface starts at zero.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist

0x04 - SendRequest

Syntax

int IdeController_SendRequest(IdeController_Request *rq);

Properties

• System
• Phase 1

Description

This function processes the request rq.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist
• E_NO_SUCH_DRIVE - The drive does not exist
• E_TIMED_OUT - The request timed out
• E_INVALID_VERSION - Structure version not supported
• E_PROBE_FAILED - IdeController_PROBE_MODE was used and the probe failed
• E_IO_ERROR - Undefined IO error

0x05 - SetupDrive

Syntax

int IdeController_SetupDrive(const IdeController_Setup *set);

Properties

• System
• Phase 1

Description

This function sets up the drive acording to set.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist
• E_NO_SUCH_DRIVE - The drive does not exist
• E_INVALID_VERSION - Structure version not supported

0x06 - UnlockInterface

Syntax

int IdeController_UnlockInterface(unsigned int interface);

Properties

• System
• Phase 1

Description

This function unlocks interface.

interface starts at zero.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist

0x07 - WriteData

Syntax

int IdeController_WriteData(unsigned int interface, const void *buf, unsigned int size);

Properties

• System
• Phase 1

Description

This function writes size bytes from buf into interface.

interface starts at zero.

Return value

• E_OK - Success
• E_BUG - The interface specification was not met
• E_NO_SUCH_INTERFACE - The interface does not exist