blocktrans.h File Reference

Block device translator. More...

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

Go to the source code of this file.

Data Structures
struct	block_translator
	A block device translator. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	block_translate (struct interface *block, void *buffer, size_t size)
	Insert block device translator. More...

Detailed Description

Block device translator.

Definition in file blocktrans.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

block_translate()

int block_translate	(	struct interface *	block,
		void *	buffer,
		size_t	size
	)

Insert block device translator.

Parameters

block	Block device interface
buffer	Data buffer (or NULL)
size	Length of data buffer, or block size

Return values

rc	Return status code

Definition at line 140 of file blocktrans.c.

                                                                           {
        struct block_translator *blktrans;
        int rc;

        /* Allocate and initialise structure */
        blktrans = zalloc ( sizeof ( *blktrans ) );
        if ( ! blktrans ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        ref_init ( &blktrans->refcnt, NULL );
        intf_init ( &blktrans->block, &blktrans_block_desc, &blktrans->refcnt );
        intf_init ( &blktrans->xfer, &blktrans_xfer_desc, &blktrans->refcnt );
        if ( buffer ) {
                xferbuf_fixed_init ( &blktrans->xferbuf, buffer, size );
        } else {
                xferbuf_void_init ( &blktrans->xferbuf );
                blktrans->blksize = size;
        }

        /* Attach to interfaces, mortalise self, and return */
        intf_insert ( block, &blktrans->block, &blktrans->xfer );
        ref_put ( &blktrans->refcnt );

        DBGC2 ( blktrans, "BLKTRANS %p created", blktrans );
        if ( buffer ) {
                DBGC2 ( blktrans, " for %#lx+%#zx",
                        virt_to_phys ( buffer ), size );
        }
        DBGC2 ( blktrans, "\n" );
        return 0;

        ref_put ( &blktrans->refcnt );
 err_alloc:
        return rc;
}

References block_translator::blksize, blktrans_block_desc, blktrans_xfer_desc, block, block_translator::block, buffer, DBGC2, ENOMEM, intf_init(), intf_insert(), NULL, rc, ref_init, ref_put, block_translator::refcnt, size, block_translator::xfer, block_translator::xferbuf, xferbuf_fixed_init(), xferbuf_void_init(), and zalloc().

Referenced by http_block_read(), and http_block_read_capacity().