acpi.c File Reference

ACPI support functions. More...

#include <string.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/uaccess.h>
#include <ipxe/iomap.h>
#include <ipxe/acpi.h>
#include <ipxe/interface.h>

Go to the source code of this file.

Macros
#define	colour   FADT_SIGNATURE
	Colour for debug messages. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
	typeof (acpi_finder=acpi_find)
	ACPI table finder. More...
void	acpi_fix_checksum (struct acpi_header *acpi)
	Fix up ACPI table checksum. More...
const struct acpi_header *	acpi_table (uint32_t signature, unsigned int index)
	Locate ACPI table. More...
const struct acpi_header *	acpi_find_via_rsdt (uint32_t signature, unsigned int index)
	Locate ACPI table via RSDT. More...
static int	acpi_zsdt (const struct acpi_header *zsdt, uint32_t signature, void *data, int(*extract)(const struct acpi_header *zsdt, size_t len, size_t offset, void *data))
	Extract value from DSDT/SSDT. More...
int	acpi_extract (uint32_t signature, void *data, int(*extract)(const struct acpi_header *zsdt, size_t len, size_t offset, void *data))
	Extract value from DSDT/SSDT. More...
void *	acpi_ioremap (struct acpi_address *address, size_t len)
	Map an ACPI generic address. More...
void	acpi_add (struct acpi_descriptor *desc)
	Add ACPI descriptor. More...
void	acpi_del (struct acpi_descriptor *desc)
	Remove ACPI descriptor. More...
struct acpi_descriptor *	acpi_describe (struct interface *intf)
	Get object's ACPI descriptor. More...
int	acpi_install (int(*install)(struct acpi_header *acpi))
	Install ACPI tables. More...

Detailed Description

ACPI support functions.

Definition in file acpi.c.

Macro Definition Documentation

colour

#define colour   FADT_SIGNATURE

Colour for debug messages.

Definition at line 42 of file acpi.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

typeof()

typeof

(

acpi_finder =

acpi_find

)

ACPI table finder.

May be overridden at link time to inject tables for testing.Compute ACPI table checksum

Parameters

acpi	Any ACPI table header

Return values

checksum

0 if checksum is good

Definition at line 48 of file acpi.c.

                                                                {
        const uint8_t *byte = ( ( const void * ) acpi );
        size_t len = le32_to_cpu ( acpi->length );
        uint8_t sum = 0;

        /* Compute checksum */
        while ( len-- )
                sum += *(byte++);

        return sum;
}

References acpi, le32_to_cpu, and len.

Referenced by aes_entry_column(), ar9002_hw_proc_txdesc(), ar9003_hw_proc_txdesc(), arbel_create_recv_wq(), arbel_fill_mlx_send_wqe(), arbel_fill_rc_send_wqe(), arbel_fill_ud_send_wqe(), asn1_built(), asn1_enter_bits(), dhcpv6_iaaddr(), dhcpv6_rx(), dns_question(), dns_resolv(), dns_xfer_deliver(), draw_setting_row(), ecam_find(), efi_ifr_string(), efi_nullify_pxe(), efi_nullify_snp(), efi_path_uri(), efi_pxe_ip_filter(), efi_pxe_ip_sockaddr(), efisig_asn1(), exanic_transmit(), fc_fill_sockaddr(), fcoe_deliver(), fcoe_fip_rx_els_response(), gve_describe(), hash_df(), hermon_fill_eth_send_wqe(), hermon_fill_mlx_send_wqe(), hermon_fill_rc_send_wqe(), hermon_fill_ud_send_wqe(), hv_wait_for_message(), ib_sbft_install(), ibft_install(), int13_extended_rw(), int13_get_extended_parameters(), int13_load_eltorito(), interrupt_dump(), ipv6conf_rx_router_advertisement(), jme_poll(), list_test_exec(), md4_final(), md5_final(), meme820(), natsemi_create_ring(), ncm_in_complete(), ncm_out_transmit(), ndp_rx_neighbour(), ndp_rx_neighbour_advertisement_ll_target(), ndp_rx_neighbour_solicitation_ll_source(), ndp_rx_router_advertisement(), ndp_rx_router_advertisement_ll_source(), ntlm_response(), peerblk_parse_block(), peerblk_parse_useless(), peerblk_retrieval_open(), peerdist_info_v1_block(), pxebs_list(), select_setting_row(), sha1_final(), sha256_final(), sha512_final(), spcr_console(), tls_client_hello(), tls_send_certificate(), tls_send_client_key_exchange_dhe(), usb_describe(), and usb_get_mtu().

acpi_fix_checksum()

void acpi_fix_checksum

(

struct acpi_header *

acpi

)

Fix up ACPI table checksum.

Parameters

acpi	ACPI table header

Definition at line 80 of file acpi.c.

                                                    {

        /* Update checksum */
        acpi->checksum -= acpi_checksum ( acpi );
}

References acpi.

Referenced by efi_block_install(), and int13_install().

acpi_table()

const struct acpi_header* acpi_table	(	uint32_t	signature,
		unsigned int	index
	)

Locate ACPI table.

Parameters

signature	Requested table signature
index	Requested index of table with this signature

Return values

table

Table, or NULL if not found

Definition at line 93 of file acpi.c.

                                                             {

        return ( *acpi_finder ) ( signature, index );
}

References acpi_finder, index, and signature.

Referenced by acpi_extract(), acpi_poweroff(), acpi_settings_fetch(), acpi_timer_probe(), ecam_find(), and spcr_console().

acpi_find_via_rsdt()

const struct acpi_header* acpi_find_via_rsdt	(	uint32_t	signature,
		unsigned int	index
	)

Locate ACPI table via RSDT.

Parameters

signature	Requested table signature
index	Requested index of table with this signature

Return values

table

Table, or NULL if not found

Definition at line 106 of file acpi.c.

                                                                     {
        const struct acpi_rsdt *rsdt;
        const struct acpi_header *table;
        size_t len;
        unsigned int count;
        unsigned int i;

        /* Locate RSDT */
        rsdt = acpi_find_rsdt();
        if ( ! rsdt ) {
                DBG ( "RSDT not found\n" );
                return NULL;
        }

        /* Read RSDT header */
        if ( rsdt->acpi.signature != cpu_to_le32 ( RSDT_SIGNATURE ) ) {
                DBGC ( colour, "RSDT %#08lx has invalid signature:\n",
                       virt_to_phys ( rsdt ) );
                DBGC_HDA ( colour, virt_to_phys ( rsdt ), &rsdt->acpi,
                           sizeof ( rsdt->acpi ) );
                return NULL;
        }
        len = le32_to_cpu ( rsdt->acpi.length );
        if ( len < sizeof ( rsdt->acpi ) ) {
                DBGC ( colour, "RSDT %#08lx has invalid length:\n",
                       virt_to_phys ( rsdt ) );
                DBGC_HDA ( colour, virt_to_phys ( rsdt ), &rsdt->acpi,
                           sizeof ( rsdt->acpi ) );
                return NULL;
        }

        /* Calculate number of entries */
        count = ( ( len - sizeof ( rsdt->acpi ) ) /
                  sizeof ( rsdt->entry[0] ) );

        /* Search through entries */
        for ( i = 0 ; i < count ; i++ ) {

                /* Read table header */
                table = phys_to_virt ( rsdt->entry[i] );

                /* Check table signature */
                if ( table->signature != cpu_to_le32 ( signature ) )
                        continue;

                /* Check index */
                if ( index-- )
                        continue;

                /* Check table integrity */
                if ( acpi_checksum ( table ) != 0 ) {
                        DBGC ( colour, "RSDT %#08lx found %s with bad "
                               "checksum at %#08lx\n", virt_to_phys ( rsdt ),
                               acpi_name ( signature ),
                               virt_to_phys ( table ) );
                        break;
                }

                DBGC ( colour, "RSDT %#08lx found %s at %#08lx\n",
                       virt_to_phys ( rsdt ), acpi_name ( signature ),
                       virt_to_phys ( table ) );
                return table;
        }

        DBGC ( colour, "RSDT %#08lx could not find %s\n",
               virt_to_phys ( rsdt ), acpi_name ( signature ) );
        return NULL;
}

References acpi_rsdt::acpi, acpi_find_rsdt(), acpi_name(), colour, count, cpu_to_le32, DBG, DBGC, DBGC_HDA, acpi_rsdt::entry, index, le32_to_cpu, len, acpi_header::length, NULL, RSDT_SIGNATURE, signature, and acpi_header::signature.

Referenced by acpi_find().

acpi_zsdt()

static int acpi_zsdt ( const struct acpi_header *  zsdt, uint32_t  signature, void *  data, int(*)(const struct acpi_header *zsdt, size_t len, size_t offset, void *data)  extract  )

static

Extract value from DSDT/SSDT.

Parameters

zsdt	DSDT or SSDT
signature	Signature (e.g. "_S5_")
data	Data buffer
extract	Extraction method

Return values

rc	Return status code

Definition at line 185 of file acpi.c.

                                                          {
        uint32_t buf;
        size_t offset;
        size_t len;
        int rc;

        /* Read table header */
        len = le32_to_cpu ( zsdt->length );

        /* Locate signature */
        for ( offset = sizeof ( *zsdt ) ;
              ( ( offset + sizeof ( buf ) /* signature */ ) < len ) ;
              offset++ ) {

                /* Check signature */
                memcpy ( &buf, ( ( ( const void * ) zsdt ) + offset ),
                         sizeof ( buf ) );
                if ( buf != cpu_to_le32 ( signature ) )
                        continue;
                DBGC ( zsdt, "DSDT/SSDT %#08lx found %s at offset %#zx\n",
                       virt_to_phys ( zsdt ), acpi_name ( signature ),
                       offset );

                /* Attempt to extract data */
                if ( ( rc = extract ( zsdt, len, offset, data ) ) == 0 )
                        return 0;
        }

        return -ENOENT;
}

References acpi_name(), cpu_to_le32, data, DBGC, ENOENT, le32_to_cpu, len, acpi_header::length, memcpy(), offset, rc, and signature.

Referenced by acpi_extract().

acpi_extract()

int acpi_extract	(	uint32_t	signature,
		void *	data,
		int(*)(const struct acpi_header *zsdt, size_t len, size_t offset, void *data)	extract
	)

Extract value from DSDT/SSDT.

Parameters

signature	Signature (e.g. "_S5_")
data	Data buffer
extract	Extraction method

Return values

rc	Return status code

Definition at line 228 of file acpi.c.

                                                      {
        const struct acpi_fadt *fadt;
        const struct acpi_header *dsdt;
        const struct acpi_header *ssdt;
        unsigned int i;
        int rc;

        /* Try DSDT first */
        fadt = container_of ( acpi_table ( FADT_SIGNATURE, 0 ),
                              struct acpi_fadt, acpi );
        if ( fadt ) {
                dsdt = phys_to_virt ( fadt->dsdt );
                if ( ( rc = acpi_zsdt ( dsdt, signature, data,
                                        extract ) ) == 0 )
                        return 0;
        }

        /* Try all SSDTs */
        for ( i = 0 ; ; i++ ) {
                ssdt = acpi_table ( SSDT_SIGNATURE, i );
                if ( ! ssdt )
                        break;
                if ( ( rc = acpi_zsdt ( ssdt, signature, data,
                                        extract ) ) == 0 )
                        return 0;
        }

        DBGC ( colour, "ACPI could not find \"%s\"\n",
               acpi_name ( signature ) );
        return -ENOENT;
}

References acpi, acpi_name(), acpi_table(), acpi_zsdt(), colour, container_of, data, DBGC, acpi_fadt::dsdt, ENOENT, FADT_SIGNATURE, rc, signature, and SSDT_SIGNATURE.

Referenced by acpi_mac(), and acpi_poweroff().

acpi_ioremap()

void* acpi_ioremap	(	struct acpi_address *	address,
		size_t	len
	)

Map an ACPI generic address.

Parameters

address	Generic address
len	Length of region

Return values

io_addr

I/O address, or NULL on error

Definition at line 270 of file acpi.c.

                                                                 {
        physaddr_t base = le64_to_cpu ( address->address );

        switch ( address->type ) {
        case ACPI_ADDRESS_TYPE_MEM:
                return ioremap ( base, len );
        case ACPI_ADDRESS_TYPE_IO:
                return ( ( void * ) base );
        default:
                return NULL;
        }
}

References ACPI_ADDRESS_TYPE_IO, ACPI_ADDRESS_TYPE_MEM, address, base, ioremap(), le64_to_cpu, len, and NULL.

Referenced by spcr_16550().

acpi_add()

void acpi_add

(

struct acpi_descriptor *

desc

)

Add ACPI descriptor.

Parameters

desc	ACPI descriptor

Definition at line 295 of file acpi.c.

                                               {

        /* Add to list of descriptors */
        ref_get ( desc->refcnt );
        list_add_tail ( &desc->list, &desc->model->descs );
}

References desc, list_add_tail, and ref_get.

Referenced by sanpath_open().

acpi_del()

void acpi_del

(

struct acpi_descriptor *

desc

)

Remove ACPI descriptor.

Parameters

desc	ACPI descriptor

Definition at line 307 of file acpi.c.

                                               {

        /* Remove from list of descriptors */
        list_check_contains_entry ( desc, &desc->model->descs, list );
        list_del ( &desc->list );
        ref_put ( desc->refcnt );
}

References desc, list_check_contains_entry, list_del, and ref_put.

Referenced by sandev_undescribe(), and sanpath_open().

acpi_describe()

struct acpi_descriptor* acpi_describe

(

struct interface *

intf

)

Get object's ACPI descriptor.

Parameters

intf

Interface

Return values

desc	ACPI descriptor, or NULL

Definition at line 321 of file acpi.c.

                                                                  {
        struct interface *dest;
        acpi_describe_TYPE ( void * ) *op =
                intf_get_dest_op ( intf, acpi_describe, &dest );
        void *object = intf_object ( dest );
        struct acpi_descriptor *desc;

        if ( op ) {
                desc = op ( object );
        } else {
                desc = NULL;
        }

        intf_put ( dest );
        return desc;
}

References acpi_describe(), acpi_describe_TYPE, desc, dest, interface::intf, intf_get_dest_op, intf_object(), intf_put(), NULL, and op.

Referenced by acpi_describe(), and sanpath_open().

acpi_install()

int acpi_install

(

int(*)(struct acpi_header *acpi)

install

)

Install ACPI tables.

Parameters

install

Table installation method

Return values

rc	Return status code

Definition at line 344 of file acpi.c.

                                                                   {
        struct acpi_model *model;
        int rc;

        for_each_table_entry ( model, ACPI_MODELS ) {
                if ( ( rc = model->install ( install ) ) != 0 )
                        return rc;
        }

        return 0;
}

References ACPI_MODELS, for_each_table_entry, acpi_model::install, and rc.

Referenced by dummy_san_describe(), efi_block_describe(), and int13_describe().