blockdev.h File Reference

Block devices. More...

#include <stdint.h>
#include <ipxe/interface.h>

Go to the source code of this file.

Data Structures
struct	block_device_capacity
	Block device capacity. More...

Macros
#define	block_read_TYPE(object_type)
#define	block_write_TYPE(object_type)
#define	block_read_capacity_TYPE(object_type)   typeof ( int ( object_type, struct interface *data ) )
#define	block_capacity_TYPE(object_type)

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	block_read (struct interface *control, struct interface *data, uint64_t lba, unsigned int count, void *buffer, size_t len)
	Read from block device. More...
int	block_write (struct interface *control, struct interface *data, uint64_t lba, unsigned int count, void *buffer, size_t len)
	Write to block device. More...
int	block_read_capacity (struct interface *control, struct interface *data)
	Read block device capacity. More...
void	block_capacity (struct interface *intf, struct block_device_capacity *capacity)
	Report block device capacity. More...

Detailed Description

Block devices.

Definition in file blockdev.h.

Macro Definition Documentation

block_read_TYPE

#define block_read_TYPE

(

object_type

)

Value:

typeof ( int ( object_type, struct interface *data,             \
                       uint64_t lba, unsigned int count,                \
                       void *buffer, size_t len ) )

Definition at line 30 of file blockdev.h.

block_write_TYPE

#define block_write_TYPE

(

object_type

)

Value:

typeof ( int ( object_type, struct interface *data,             \
                       uint64_t lba, unsigned int count,                \
                       void *buffer, size_t len ) )

Definition at line 38 of file blockdev.h.

block_read_capacity_TYPE

#define block_read_capacity_TYPE

(

object_type

)

typeof ( int ( object_type, struct interface *data ) )

Definition at line 45 of file blockdev.h.

block_capacity_TYPE

#define block_capacity_TYPE

(

object_type

)

Value:

typeof ( void ( object_type,                                    \
                        struct block_device_capacity *capacity ) )

Definition at line 50 of file blockdev.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

block_read()

int block_read	(	struct interface *	control,
		struct interface *	data,
		uint64_t	lba,
		unsigned int	count,
		void *	buffer,
		size_t	len
	)

Read from block device.

Parameters

control	Control interface
data	Data interface
lba	Starting logical block address
count	Number of logical blocks
buffer	Data buffer
len	Length of data buffer

Return values

rc	Return status code

Definition at line 48 of file blockdev.c.

                              {
        struct interface *dest;
        block_read_TYPE ( void * ) *op =
                intf_get_dest_op ( control, block_read, &dest );
        void *object = intf_object ( dest );
        int rc;

        if ( op ) {
                rc = op ( object, data, lba, count, buffer, len );
        } else {
                /* Default is to fail to issue the command */
                rc = -EOPNOTSUPP;
        }

        intf_put ( dest );
        return rc;
}

References block_read(), block_read_TYPE, buffer, control, count, data, dest, EOPNOTSUPP, intf_get_dest_op, intf_object(), intf_put(), lba, len, op, and rc.

Referenced by block_read(), and sandev_read().

block_write()

int block_write	(	struct interface *	control,
		struct interface *	data,
		uint64_t	lba,
		unsigned int	count,
		void *	buffer,
		size_t	len
	)

Write to block device.

Parameters

control	Control interface
data	Data interface
lba	Starting logical block address
count	Number of logical blocks
buffer	Data buffer
len	Length of data buffer

Return values

rc	Return status code

Definition at line 79 of file blockdev.c.

                               {
        struct interface *dest;
        block_write_TYPE ( void * ) *op =
                intf_get_dest_op ( control, block_write, &dest );
        void *object = intf_object ( dest );
        int rc;

        if ( op ) {
                rc = op ( object, data, lba, count, buffer, len );
        } else {
                /* Default is to fail to issue the command */
                rc = -EOPNOTSUPP;
        }

        intf_put ( dest );
        return rc;
}

References block_write(), block_write_TYPE, buffer, control, count, data, dest, EOPNOTSUPP, intf_get_dest_op, intf_object(), intf_put(), lba, len, op, and rc.

Referenced by block_write(), and sandev_write().

block_read_capacity()

int block_read_capacity	(	struct interface *	control,
		struct interface *	data
	)

Read block device capacity.

Parameters

control	Control interface
data	Data interface

Return values

rc	Return status code

Definition at line 106 of file blockdev.c.

                                                                              {
        struct interface *dest;
        block_read_capacity_TYPE ( void * ) *op =
                intf_get_dest_op ( control, block_read_capacity, &dest );
        void *object = intf_object ( dest );
        int rc;

        if ( op ) {
                rc = op ( object, data );
        } else {
                /* Default is to fail to issue the command */
                rc = -EOPNOTSUPP;
        }

        intf_put ( dest );
        return rc;
}

References block_read_capacity(), block_read_capacity_TYPE, control, data, dest, EOPNOTSUPP, intf_get_dest_op, intf_object(), intf_put(), op, and rc.

Referenced by block_read_capacity(), and sandev_command_read_capacity().

block_capacity()

void block_capacity	(	struct interface *	intf,
		struct block_device_capacity *	capacity
	)

Report block device capacity.

Parameters

intf	Interface
capacity	Block device capacity

Definition at line 130 of file blockdev.c.

                                                               {
        struct interface *dest;
        block_capacity_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, block_capacity, &dest );
        void *object = intf_object ( dest );

        if ( op ) {
                op ( object, capacity );
        } else {
                /* Default is to do nothing */
        }

        intf_put ( dest );
}

References block_capacity(), block_capacity_TYPE, dest, interface::intf, intf_get_dest_op, intf_object(), intf_put(), and op.

Referenced by atacmd_identify_done(), blktrans_close(), block_capacity(), and scsicmd_read_capacity_done().