ata.c File Reference

ATA block device. More...

#include <stddef.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <byteswap.h>
#include <gpxe/blockdev.h>
#include <gpxe/process.h>
#include <gpxe/ata.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
static struct ata_device *	block_to_ata (struct block_device *blockdev)
static int	ata_command (struct ata_device *ata, struct ata_command *command)
	Issue ATA command.
static int	ata_read (struct block_device *blockdev, uint64_t block, unsigned long count, userptr_t buffer)
	Read block from ATA device.
static int	ata_write (struct block_device *blockdev, uint64_t block, unsigned long count, userptr_t buffer)
	Write block to ATA device.
static int	ata_identify (struct block_device *blockdev)
	Identify ATA device.
int	init_atadev (struct ata_device *ata)
	Initialise ATA device.
Variables
static struct block_device_operations	ata_operations

---

Detailed Description

ATA block device.

Definition in file ata.c.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static struct ata_device* block_to_ata

(

struct block_device *

blockdev

)

[static, read]

Definition at line 37 of file ata.c.

References container_of.

Referenced by ata_identify(), ata_read(), and ata_write().

                                               {
        return container_of ( blockdev, struct ata_device, blockdev );
}

static int ata_command	(	struct ata_device *	ata,
		struct ata_command *	command
	)			[inline, static]

Issue ATA command.

Parameters:

	ata	ATA device
	command	ATA command

Return values:

rc

Return status code

Definition at line 49 of file ata.c.

References DBG, EINPROGRESS, step(), and strerror().

Referenced by ata_read(), and ata_write().

                                                                    {
        int rc;

        DBG ( "ATA cmd %02x dev %02x LBA%s %llx count %04x\n",
              command->cb.cmd_stat, command->cb.device,
              ( command->cb.lba48 ? "48" : "" ),
              ( unsigned long long ) command->cb.lba.native,
              command->cb.count.native );

        /* Flag command as in-progress */
        command->rc = -EINPROGRESS;

        /* Issue ATA command */
        if ( ( rc = ata->command ( ata, command ) ) != 0 ) {
                /* Something went wrong with the issuing mechanism */
                DBG ( "ATA could not issue command: %s\n", strerror ( rc ) );
                return rc;
        }

        /* Wait for command to complete */
        while ( command->rc == -EINPROGRESS )
                step();
        if ( ( rc = command->rc ) != 0 ) {
                /* Something went wrong with the command execution */
                DBG ( "ATA command failed: %s\n", strerror ( rc ) );
                return rc;
        }

        return 0;
}

static int ata_read	(	struct block_device *	blockdev,
		uint64_t	block,
		unsigned long	count,
		userptr_t	buffer
	)			[static]

Read block from ATA device.

Parameters:

	blockdev	Block device
	block	LBA block number
	count	Block count
	buffer	Data buffer

Return values:

rc

Return status code

Definition at line 89 of file ata.c.

References ATA_CMD_READ, ATA_CMD_READ_EXT, ata_command(), ATA_DEV_LBA, ATA_DEV_OBSOLETE, block_to_ata(), ata_lba::bytes, ata_command::cb, ata_cb::cmd_stat, ata_cb::count, ata_command::data_in, ata_device::device, ata_cb::device, ata_cb::lba, ata_device::lba48, ata_cb::lba48, ata_lba::low_prev, memset(), ata_fifo::native, and ata_lba::native.

                                                              {
        struct ata_device *ata = block_to_ata ( blockdev );
        struct ata_command command;

        memset ( &command, 0, sizeof ( command ) );
        command.cb.lba.native = block;
        command.cb.count.native = count;
        command.cb.device = ( ata->device | ATA_DEV_OBSOLETE | ATA_DEV_LBA );
        command.cb.lba48 = ata->lba48;
        if ( ! ata->lba48 )
                command.cb.device |= command.cb.lba.bytes.low_prev;
        command.cb.cmd_stat = ( ata->lba48 ? ATA_CMD_READ_EXT : ATA_CMD_READ );
        command.data_in = buffer;
        return ata_command ( ata, &command );
}

static int ata_write	(	struct block_device *	blockdev,
		uint64_t	block,
		unsigned long	count,
		userptr_t	buffer
	)			[static]

Write block to ATA device.

Parameters:

	blockdev	Block device
	block	LBA block number
	count	Block count
	buffer	Data buffer

Return values:

rc

Return status code

Definition at line 115 of file ata.c.

References ATA_CMD_WRITE, ATA_CMD_WRITE_EXT, ata_command(), ATA_DEV_LBA, ATA_DEV_OBSOLETE, block_to_ata(), ata_lba::bytes, ata_command::cb, ata_cb::cmd_stat, ata_cb::count, ata_command::data_out, ata_device::device, ata_cb::device, ata_cb::lba, ata_device::lba48, ata_cb::lba48, ata_lba::low_prev, memset(), ata_fifo::native, and ata_lba::native.

                                                               {
        struct ata_device *ata = block_to_ata ( blockdev );
        struct ata_command command;
        
        memset ( &command, 0, sizeof ( command ) );
        command.cb.lba.native = block;
        command.cb.count.native = count;
        command.cb.device = ( ata->device | ATA_DEV_OBSOLETE | ATA_DEV_LBA );
        command.cb.lba48 = ata->lba48;
        if ( ! ata->lba48 )
                command.cb.device |= command.cb.lba.bytes.low_prev;
        command.cb.cmd_stat = ( ata->lba48 ?
                                ATA_CMD_WRITE_EXT : ATA_CMD_WRITE );
        command.data_out = buffer;
        return ata_command ( ata, &command );
}

static int ata_identify

(

struct block_device *

blockdev

)

[static]

Identify ATA device.

Parameters:

blockdev

Block device

Return values:

rc

Return status code

Definition at line 139 of file ata.c.

References ATA_CMD_IDENTIFY, ATA_DEV_LBA, ATA_DEV_OBSOLETE, ATA_SECTOR_SIZE, ATA_SUPPORTS_LBA48, block_device::blksize, block_to_ata(), block_device::blocks, ata_command::cb, ata_cb::cmd_stat, ata_cb::count, cpu_to_le16, ata_command::data_in, ata_device::device, ata_cb::device, ata_device::lba48, ata_identity::lba48_sectors, ata_identity::lba_sectors, le32_to_cpu, le64_to_cpu, linker_assert, memset(), ata_fifo::native, ata_identity::supports_lba48, and virt_to_user().

Referenced by init_atadev().

                                                          {
        struct ata_device *ata = block_to_ata ( blockdev );
        struct ata_command command;
        struct ata_identity identity;
        int rc;

        /* Issue IDENTIFY */
        memset ( &command, 0, sizeof ( command ) );
        command.cb.count.native = 1;
        command.cb.device = ( ata->device | ATA_DEV_OBSOLETE | ATA_DEV_LBA );
        command.cb.cmd_stat = ATA_CMD_IDENTIFY;
        command.data_in = virt_to_user ( &identity );
        linker_assert ( sizeof ( identity ) == ATA_SECTOR_SIZE,
                        __ata_identity_bad_size__ );
        if ( ( rc = ata_command ( ata, &command ) ) != 0 )
                return rc;

        /* Fill in block device parameters */
        blockdev->blksize = ATA_SECTOR_SIZE;
        if ( identity.supports_lba48 & cpu_to_le16 ( ATA_SUPPORTS_LBA48 ) ) {
                ata->lba48 = 1;
                blockdev->blocks = le64_to_cpu ( identity.lba48_sectors );
        } else {
                blockdev->blocks = le32_to_cpu ( identity.lba_sectors );
        }
        return 0;
}

int init_atadev

(

struct ata_device *

ata

)

Initialise ATA device.

Parameters:

ata

ATA device

Return values:

rc

Return status code

Initialises an ATA device. The ata_device::command field and the ATA_FL_SLAVE portion of the ata_device::flags field must already be filled in. This function will configure ata_device::blockdev, including issuing an IDENTIFY DEVICE call to determine the block size and total device size.

Fill in read and write methods, and get device capacity

Definition at line 184 of file ata.c.

References ata_identify(), ata_device::blockdev, and block_device::op.

Referenced by aoeboot().

                                           {
        /** Fill in read and write methods, and get device capacity */
        ata->blockdev.op = &ata_operations;
        return ata_identify ( &ata->blockdev );
}

---

Variable Documentation

struct block_device_operations ata_operations [static]

Initial value:

 {
        .read   = ata_read,
        .write  = ata_write
}

Definition at line 167 of file ata.c.