utilities.h File Reference

#include <uacpi/types.h>
#include <uacpi/utilities.h>
#include <uacpi/internal/log.h>
#include <uacpi/internal/stdlib.h>

Include dependency graph for utilities.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	UACPI_PTR_TO_VIRT_ADDR(ptr)   ((uacpi_virt_addr)(ptr))
#define	UACPI_VIRT_ADDR_TO_PTR(vaddr)   ((void*)(vaddr))
#define	UACPI_PTR_ADD(ptr, value)   ((void*)(((uacpi_u8*)(ptr)) + value))
#define	UACPI_NANOSECONDS_PER_SEC   (1000ull * 1000ull * 1000ull)

Enumerations
enum	uacpi_base { UACPI_BASE_AUTO , UACPI_BASE_OCT = 8 , UACPI_BASE_DEC = 10 , UACPI_BASE_HEX = 16 }

Functions
static uacpi_phys_addr	uacpi_truncate_phys_addr_with_warn (uacpi_u64 large_addr)
void	uacpi_eisa_id_to_string (uacpi_u32, uacpi_char *out_string)
uacpi_status	uacpi_string_to_integer (const uacpi_char *str, uacpi_size max_chars, enum uacpi_base base, uacpi_u64 *out_value)
uacpi_bool	uacpi_is_valid_nameseg (uacpi_u8 *nameseg)
void	uacpi_free_dynamic_string (const uacpi_char *str)

Macro Definition Documentation

UACPI_NANOSECONDS_PER_SEC

#define UACPI_NANOSECONDS_PER_SEC   (1000ull * 1000ull * 1000ull)

Definition at line 45 of file utilities.h.

UACPI_PTR_ADD

#define UACPI_PTR_ADD	(		ptr,
			value
	)		((void*)(((uacpi_u8*)(ptr)) + value))

Definition at line 23 of file utilities.h.

UACPI_PTR_TO_VIRT_ADDR

#define UACPI_PTR_TO_VIRT_ADDR

(

ptr

)

((uacpi_virt_addr)(ptr))

Definition at line 20 of file utilities.h.

UACPI_VIRT_ADDR_TO_PTR

#define UACPI_VIRT_ADDR_TO_PTR

(

vaddr

)

((void*)(vaddr))

Definition at line 21 of file utilities.h.

Enumeration Type Documentation

uacpi_base

enum uacpi_base

Enumerator
UACPI_BASE_AUTO
UACPI_BASE_OCT
UACPI_BASE_DEC
UACPI_BASE_HEX

Definition at line 30 of file utilities.h.

                {
    UACPI_BASE_AUTO,
    UACPI_BASE_OCT = 8,
    UACPI_BASE_DEC = 10,
    UACPI_BASE_HEX = 16,
};

Function Documentation

uacpi_eisa_id_to_string()

void uacpi_eisa_id_to_string	(	uacpi_u32	id,
		uacpi_char *	out_string
	)

Definition at line 323 of file utilities.c.

{
    static uacpi_char hex_to_ascii[16] = {
        '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
        'A', 'B', 'C', 'D', 'E', 'F'
    };
 
    /*
     * For whatever reason bits are encoded upper to lower here, swap
     * them around so that we don't have to do ridiculous bit shifts
     * everywhere.
     */
    union {
        uacpi_u8 bytes[4];
        uacpi_u32 dword;
    } orig, swapped;
 
    orig.dword = id;
    swapped.bytes[0] = orig.bytes[3];
    swapped.bytes[1] = orig.bytes[2];
    swapped.bytes[2] = orig.bytes[1];
    swapped.bytes[3] = orig.bytes[0];
 
    /*
     * Bit 16 - 20: 3rd character (- 0x40) of mfg code
     * Bit 21 - 25: 2nd character (- 0x40) of mfg code
     * Bit 26 - 30: 1st character (- 0x40) of mfg code
     */
    out_string[0] = (uacpi_char)(0x40 + ((swapped.dword >> 26) & 0x1F));
    out_string[1] = (uacpi_char)(0x40 + ((swapped.dword >> 21) & 0x1F));
    out_string[2] = (uacpi_char)(0x40 + ((swapped.dword >> 16) & 0x1F));
 
    /*
     * Bit 0  - 3 : 4th hex digit of product number
     * Bit 4  - 7 : 3rd hex digit of product number
     * Bit 8  - 11: 2nd hex digit of product number
     * Bit 12 - 15: 1st hex digit of product number
     */
    out_string[3] = hex_to_ascii[(swapped.dword >> 12) & 0x0F];
    out_string[4] = hex_to_ascii[(swapped.dword >> 8 ) & 0x0F];
    out_string[5] = hex_to_ascii[(swapped.dword >> 4 ) & 0x0F];
    out_string[6] = hex_to_ascii[(swapped.dword >> 0 ) & 0x0F];
 
    out_string[7] = '\0';
}

Referenced by uacpi_eval_cid(), and uacpi_eval_hid().

uacpi_free_dynamic_string()

void uacpi_free_dynamic_string

(

const uacpi_char *

str

)

Definition at line 1135 of file utilities.c.

{
    if (str == UACPI_NULL)
        return;
 
    uacpi_free((void*)str, uacpi_strlen(str) + 1);
}

Referenced by handle_notify(), trace_invalid_return_type(), trace_method_abort(), trace_named_object_lookup_or_creation_failure(), trace_region_io(), uacpi_deinitialize_interfaces(), uacpi_dispatch_opregion_io(), uacpi_eval_dstate_method_template(), uacpi_free_absolute_path(), uacpi_trace_region_error(), and uacpi_uninstall_interface().

uacpi_is_valid_nameseg()

uacpi_bool uacpi_is_valid_nameseg

(

uacpi_u8 *

nameseg

)

Definition at line 315 of file utilities.c.

{
    return is_valid_name_byte(nameseg[0]) &&
           is_valid_name_byte(nameseg[1]) &&
           is_valid_name_byte(nameseg[2]) &&
           is_valid_name_byte(nameseg[3]);
}

Referenced by parse_nameseg().

uacpi_string_to_integer()

uacpi_status uacpi_string_to_integer	(	const uacpi_char *	str,
		uacpi_size	max_chars,
		enum uacpi_base	base,
		uacpi_u64 *	out_value
	)

Definition at line 233 of file utilities.c.

{
    uacpi_status ret = UACPI_STATUS_INVALID_ARGUMENT;
    uacpi_bool negative = UACPI_FALSE;
    uacpi_u64 next, value = 0;
    uacpi_char c = '\0';
 
    while (consume_if(&str, &max_chars, CHAR_TYPE_SPACE));
 
    if (consume_if_equals(&str, &max_chars, '-'))
        negative = UACPI_TRUE;
    else
        consume_if_equals(&str, &max_chars, '+');
 
    if (base == UACPI_BASE_AUTO) {
        base = UACPI_BASE_DEC;
 
        if (consume_if_equals(&str, &max_chars, '0')) {
            base = UACPI_BASE_OCT;
            if (consume_if_equals(&str, &max_chars, 'x'))
                base = UACPI_BASE_HEX;
        }
    }
 
    while (consume_one(&str, &max_chars, &c)) {
        switch (ascii_map[(uacpi_u8)c] & (CHAR_TYPE_DIGIT | CHAR_TYPE_ALHEX)) {
        case CHAR_TYPE_DIGIT | CHAR_TYPE_HEX_DIGIT:
            next = c - '0';
            if (base == UACPI_BASE_OCT && next > 7)
                goto out;
            break;
        case CHAR_TYPE_LOWER | CHAR_TYPE_HEX_DIGIT:
        case CHAR_TYPE_UPPER | CHAR_TYPE_HEX_DIGIT:
            if (base != UACPI_BASE_HEX)
                goto out;
            next = 10 + (to_lower(c) - 'a');
            break;
        default:
            goto out;
        }
 
        next = (value * base) + next;
        if ((next / base) != value) {
            value = 0xFFFFFFFFFFFFFFFF;
            goto out;
        }
 
        value = next;
    }
 
out:
    if (negative)
        value = -((uacpi_i64)value);
 
    *out_value = value;
    if (max_chars == 0 || c == '\0')
        ret = UACPI_STATUS_OK;
 
    return ret;
}

Referenced by do_match_gpe_methods(), object_to_integer(), and parse_number().

uacpi_truncate_phys_addr_with_warn()

static uacpi_phys_addr uacpi_truncate_phys_addr_with_warn ( uacpi_u64  large_addr )

inlinestatic

Definition at line 8 of file utilities.h.

{
    if (sizeof(uacpi_phys_addr) < 8 && large_addr > 0xFFFFFFFF) {
        uacpi_warn(
            "truncating a physical address 0x%"UACPI_PRIX64
            " outside of address space\n", UACPI_FMT64(large_addr)
        );
    }
 
    return (uacpi_phys_addr)large_addr;
}

Referenced by initialize_from_rsdp(), and initialize_from_rxsdt().