efi_io.h File Reference

gPXE I/O API for EFI More...

Go to the source code of this file.

Defines
#define	IOAPI_PREFIX_efi   __efi_
Functions
	FILE_LICENCE (GPL2_OR_LATER)
unsigned long long	efi_ioread (volatile void *io_addr, size_t size)
	Read from device.
void	efi_iowrite (unsigned long long data, volatile void *io_addr, size_t size)
	Write to device.
void	efi_ioreads (volatile void *io_addr, void *data, size_t size, unsigned int count)
	String read from device.
void	efi_iowrites (volatile void *io_addr, const void *data, size_t size, unsigned int count)
	String write to device.
static __always_inline unsigned long	IOAPI_INLINE (efi, phys_to_bus)(unsigned long phys_addr)
static __always_inline unsigned long	IOAPI_INLINE (efi, bus_to_phys)(unsigned long bus_addr)
static __always_inline void *	IOAPI_INLINE (efi, ioremap)(unsigned long bus_addr

---

Detailed Description

gPXE I/O API for EFI

EFI runs with flat physical addressing, so the various mappings between virtual addresses, I/O addresses and bus addresses are all no-ops. I/O is handled using the EFI_CPU_IO_PROTOCOL.

Definition in file efi_io.h.

---

Define Documentation

#define IOAPI_PREFIX_efi   __efi_

Definition at line 18 of file efi_io.h.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

unsigned long long efi_ioread	(	volatile void *	io_addr,
		size_t	size
	)

Read from device.

Parameters:

	io_addr	I/O address
	size	Size of value

Return values:

data

Value read

Definition at line 80 of file efi_io.c.

References DBG, efi_strerror(), efi_width(), _EFI_CPU_IO_PROTOCOL::Io, IS_PORT_ADDRESS, _EFI_CPU_IO_PROTOCOL::Mem, and EFI_CPU_IO_PROTOCOL_ACCESS::Read.

                                                                      {
        EFI_CPU_IO_PROTOCOL_IO_MEM read;
        unsigned long long data = 0;
        EFI_STATUS efirc;

        read = ( IS_PORT_ADDRESS ( io_addr ) ?
                 cpu_io->Io.Read : cpu_io->Mem.Read );

        if ( ( efirc = read ( cpu_io, efi_width ( size ),
                              ( intptr_t ) io_addr, 1,
                              ( void * ) &data ) ) != 0 ) {
                DBG ( "EFI I/O read at %p failed: %s\n",
                      io_addr, efi_strerror ( efirc ) );
                return -1ULL;
        }

        return data;
}

void efi_iowrite	(	unsigned long long	data,
		volatile void *	io_addr,
		size_t	size
	)

Write to device.

Parameters:

	data	Value to write
	io_addr	I/O address
	size	Size of value

Definition at line 106 of file efi_io.c.

References DBG, efi_strerror(), efi_width(), _EFI_CPU_IO_PROTOCOL::Io, IS_PORT_ADDRESS, _EFI_CPU_IO_PROTOCOL::Mem, and EFI_CPU_IO_PROTOCOL_ACCESS::Write.

                                 {
        EFI_CPU_IO_PROTOCOL_IO_MEM write;
        EFI_STATUS efirc;

        write = ( IS_PORT_ADDRESS ( io_addr ) ?
                  cpu_io->Io.Write : cpu_io->Mem.Write );

        if ( ( efirc = write ( cpu_io, efi_width ( size ),
                               ( intptr_t ) io_addr, 1,
                               ( void * ) &data ) ) != 0 ) {
                DBG ( "EFI I/O write at %p failed: %s\n",
                      io_addr, efi_strerror ( efirc ) );
        }
}

void efi_ioreads	(	volatile void *	io_addr,
		void *	data,
		size_t	size,
		unsigned int	count
	)

String read from device.

Parameters:

	io_addr	I/O address
	data	Data buffer
	size	Size of values
	count	Number of values to read

Definition at line 130 of file efi_io.c.

References DBG, efi_strerror(), efi_width(), _EFI_CPU_IO_PROTOCOL::Io, IS_PORT_ADDRESS, _EFI_CPU_IO_PROTOCOL::Mem, and EFI_CPU_IO_PROTOCOL_ACCESS::Read.

                                                     {
        EFI_CPU_IO_PROTOCOL_IO_MEM read;
        EFI_STATUS efirc;

        read = ( IS_PORT_ADDRESS ( io_addr ) ?
                 cpu_io->Io.Read : cpu_io->Mem.Read );

        if ( ( efirc = read ( cpu_io, efi_width ( size ),
                              ( intptr_t ) io_addr, count,
                              ( void * ) data ) ) != 0 ) {
                DBG ( "EFI I/O string read at %p failed: %s\n",
                      io_addr, efi_strerror ( efirc ) );
        }
}

void efi_iowrites	(	volatile void *	io_addr,
		const void *	data,
		size_t	size,
		unsigned int	count
	)

String write to device.

Parameters:

	io_addr	I/O address
	data	Data buffer
	size	Size of values
	count	Number of values to write

Definition at line 154 of file efi_io.c.

References DBG, efi_strerror(), efi_width(), _EFI_CPU_IO_PROTOCOL::Io, IS_PORT_ADDRESS, _EFI_CPU_IO_PROTOCOL::Mem, and EFI_CPU_IO_PROTOCOL_ACCESS::Write.

                                                      {
        EFI_CPU_IO_PROTOCOL_IO_MEM write;
        EFI_STATUS efirc;

        write = ( IS_PORT_ADDRESS ( io_addr ) ?
                 cpu_io->Io.Write : cpu_io->Mem.Write );

        if ( ( efirc = write ( cpu_io, efi_width ( size ),
                               ( intptr_t ) io_addr, count,
                               ( void * ) data ) ) != 0 ) {
                DBG ( "EFI I/O write at %p failed: %s\n",
                      io_addr, efi_strerror ( efirc ) );
        }
}

static __always_inline unsigned long IOAPI_INLINE	(	efi	,
		phys_to_bus
	)			[inline, static]

Definition at line 38 of file efi_io.h.

                                                              {
        return phys_addr;
}

static __always_inline unsigned long IOAPI_INLINE	(	efi	,
		bus_to_phys
	)			[inline, static]

Definition at line 43 of file efi_io.h.

                                                             {
        return bus_addr;
}

static __always_inline void* IOAPI_INLINE	(	efi	,
		ioremap
	)			[inline, static]