ProcessorBind.h File Reference

Macros
#define	MDE_CPU_EBC
#define	MAX_BIT   ((UINTN)((1ULL << (sizeof (INTN) * 8 - 1))))
#define	MAX_2_BITS   ((UINTN)(3ULL << (sizeof (INTN) * 8 - 2)))
#define	MAX_ADDRESS   ((UINTN)(~0ULL >> (64 - sizeof (INTN) * 8)))
#define	MAX_ALLOC_ADDRESS   MAX_ADDRESS
#define	MAX_UINTN   ((UINTN)(~0ULL >> (64 - sizeof (INTN) * 8)))
#define	MAX_INTN   ((INTN)(~0ULL >> (65 - sizeof (INTN) * 8)))
#define	MIN_INTN   (((INTN)-MAX_INTN) - 1)
#define	CPU_STACK_ALIGNMENT   sizeof(UINTN)
#define	DEFAULT_PAGE_ALLOCATION_GRANULARITY   (0x1000)
#define	RUNTIME_PAGE_ALLOCATION_GRANULARITY   (0x1000)
#define	EFIAPI
#define	FUNCTION_ENTRY_POINT(FunctionPointer)   (VOID *)(UINTN)(FunctionPointer)
#define	__USER_LABEL_PREFIX__

Typedefs
typedef signed char	INT8
typedef unsigned char	BOOLEAN
typedef unsigned char	UINT8
typedef char	CHAR8
typedef short	INT16
typedef unsigned short	UINT16
typedef unsigned short	CHAR16
typedef int	INT32
typedef unsigned int	UINT32
typedef __int64	INT64
typedef unsigned __int64	UINT64
typedef long	INTN
typedef unsigned long	UINTN

Detailed Description

Processor or compiler specific defines and types for EBC.

We currently only have one EBC compiler so there may be some Intel compiler specific functions in this file.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Macro Definition Documentation

#define __USER_LABEL_PREFIX__

#define CPU_STACK_ALIGNMENT   sizeof(UINTN)

The stack alignment required for EBC

#define DEFAULT_PAGE_ALLOCATION_GRANULARITY   (0x1000)

Page allocation granularity for EBC

#define EFIAPI

Modifier to ensure that all protocol member functions and EFI intrinsics use the correct C calling convention. All protocol member functions and EFI intrinsics are required to modify their member functions with EFIAPI.

#define FUNCTION_ENTRY_POINT

(

FunctionPointer

)

(VOID *)(UINTN)(FunctionPointer)

Return the pointer to the first instruction of a function given a function pointer. On EBC architectures, these two pointer values are the same, so the implementation of this macro is very simple.

Parameters

FunctionPointer

A pointer to a function.

Returns

The pointer to the first instruction of a function given a function pointer.

#define MAX_2_BITS   ((UINTN)(3ULL << (sizeof (INTN) * 8 - 2)))

A value of native width with the two highest bits set. Scalable macro to set the most 2 significant bits in a natural number.

#define MAX_ADDRESS   ((UINTN)(~0ULL >> (64 - sizeof (INTN) * 8)))

Maximum legal EBC address

#define MAX_ALLOC_ADDRESS   MAX_ADDRESS

Maximum usable address at boot time (48 bits using 4 KB pages)

#define MAX_BIT   ((UINTN)((1ULL << (sizeof (INTN) * 8 - 1))))

A value of native width with the highest bit set. Scalable macro to set the most significant bit in a natural number.

#define MAX_INTN   ((INTN)(~0ULL >> (65 - sizeof (INTN) * 8)))

#define MAX_UINTN   ((UINTN)(~0ULL >> (64 - sizeof (INTN) * 8)))

Maximum legal EBC INTN and UINTN values.

#define MDE_CPU_EBC

Define the processor type so other code can make processor based choices

#define MIN_INTN   (((INTN)-MAX_INTN) - 1)

Minimum legal EBC INTN value.

#define RUNTIME_PAGE_ALLOCATION_GRANULARITY   (0x1000)

Typedef Documentation

typedef unsigned char BOOLEAN

Logical Boolean. 1-byte value containing 0 for FALSE or a 1 for TRUE. Other values are undefined.

typedef unsigned short CHAR16

2-byte Character. Unless otherwise specified all strings are stored in the UTF-16 encoding format as defined by Unicode 2.1 and ISO/IEC 10646 standards.

typedef char CHAR8

1-byte Character.

typedef short INT16

2-byte signed value.

typedef int INT32

4-byte signed value.

typedef __int64 INT64

8-byte signed value.

typedef signed char INT8

1-byte signed value

typedef long INTN

Signed value of native width. (4 bytes on supported 32-bit processor instructions, 8 bytes on supported 64-bit processor instructions) "long" type scales to the processor native size with EBC compiler

typedef unsigned short UINT16

2-byte unsigned value.

typedef unsigned int UINT32

4-byte unsigned value.

typedef unsigned __int64 UINT64

8-byte unsigned value.

typedef unsigned char UINT8

1-byte unsigned value.

typedef unsigned long UINTN

The unsigned value of native width. (4 bytes on supported 32-bit processor instructions; 8 bytes on supported 64-bit processor instructions) "long" type scales to the processor native size with the EBC compiler.