AcpiHelperLib.h File Reference

Macros
#define	IS_UPPER_CHAR(x)   ((x >= 'A') && (x <= 'Z'))
#define	IS_DIGIT(x)   ((x >= '0') && (x <= '9'))
#define	IS_UPPER_HEX(x)   (((x >= 'A') && (x <= 'F')) || IS_DIGIT (x))

Functions
UINT8 EFIAPI	AsciiFromHex (IN UINT8 Hex)
UINT8 EFIAPI	HexFromAscii (IN CHAR8 Char)
BOOLEAN	IsValidPnpId (IN CONST CHAR8 *Hid)
BOOLEAN	IsValidAcpiId (IN CONST CHAR8 *Hid)
EFI_STATUS EFIAPI	AmlGetEisaIdFromString (IN CONST CHAR8 *EisaIdStr, OUT UINT32 *EisaIdInt)

Detailed Description

Copyright (c) 2017 - 2021, Arm Limited. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define IS_DIGIT

(

x

)

((x >= '0') && (x <= '9'))

Is a character a decimal digit

#define IS_UPPER_CHAR

(

x

)

((x >= 'A') && (x <= 'Z'))

Is a character upper case

#define IS_UPPER_HEX

(

x

)

(((x >= 'A') && (x <= 'F')) || IS_DIGIT (x))

Is a character an upper case hexadecimal digit

Function Documentation

EFI_STATUS EFIAPI AmlGetEisaIdFromString	(	IN CONST CHAR8 *	EisaIdStr,
		OUT UINT32 *	EisaIdInt
	)

Convert a EisaId string to its compressed UINT32 equivalent.

Cf. ACPI 6.4 specification, s19.3.4 "ASL Macros": "Eisaid"

Parameters

[in]	EisaIdStr	Input EisaId string.
[out]	EisaIdInt	Output EisaId UINT32 (compressed).

Return values

EFI_SUCCESS	The function completed successfully.
EFI_INVALID_PARAMETER	Invalid parameter.

UINT8 EFIAPI AsciiFromHex

(

IN UINT8

Hex

)

Convert a hex number to its ASCII code.

Parameters

[in]

Hex

Hex number to convert. Must be 0 <= x < 16.

Returns

The ASCII code corresponding to x. -1 if error.

UINT8 EFIAPI HexFromAscii

(

IN CHAR8

Char

)

Convert an ASCII char representing an hexadecimal number to its integer value.

Parameters

[in]

Char

Char to convert. Must be between '0'-'9' or 'A'-'F' or 'a'-'f'.

Returns

The corresponding integer (between 0-16). -1 if error.

BOOLEAN IsValidAcpiId

(

IN CONST CHAR8 *

Hid

)

Check if a HID is a valid ACPI ID.

Parameters

[in]

Hid

The Hid to validate.

Return values

TRUE	The Hid is a valid ACPI ID.
FALSE	The Hid is not a valid ACPI ID.

BOOLEAN IsValidPnpId

(

IN CONST CHAR8 *

Hid

)

Check if a HID is a valid PNP ID.

Parameters

[in]

Hid

The Hid to validate.

Return values

TRUE	The Hid is a valid PNP ID.
FALSE	The Hid is not a valid PNP ID.