Core - XEOS: API Reference [ XS-Labs ]

XEOS_Info_GetKernelBSSSectionEndAddress Top

Gets the end address of the .bss kernel section

uintptr_t XEOS_Info_GetKernelBSSSectionEndAddress( void );

Return value

The end address of the .bss kernel kernel

XEOS_Info_GetKernelBSSSectionStartAddress Top

Gets the start address of the .bss kernel section

uintptr_t XEOS_Info_GetKernelBSSSectionStartAddress( void );

Return value

The start address of the .bss kernel kernel

XEOS_Info_GetKernelDataSectionEndAddress Top

Gets the end address of the .data kernel section

uintptr_t XEOS_Info_GetKernelDataSectionEndAddress( void );

Return value

The end address of the .data kernel kernel

XEOS_Info_GetKernelDataSectionStartAddress Top

Gets the start address of the .data kernel section

uintptr_t XEOS_Info_GetKernelDataSectionStartAddress( void );

Return value

The start address of the .data kernel kernel

XEOS_Info_GetKernelEndAddress Top

Gets the end address of the kernel

uintptr_t XEOS_Info_GetKernelEndAddress( void );

Return value

The end address of the kernel

XEOS_Info_GetKernelRODataSectionEndAddress Top

Gets the end address of the .rodata kernel section

uintptr_t XEOS_Info_GetKernelRODataSectionEndAddress( void );

Return value

The end address of the .rodata kernel kernel

XEOS_Info_GetKernelRODataSectionStartAddress Top

Gets the start address of the .rodata kernel section

uintptr_t XEOS_Info_GetKernelRODataSectionStartAddress( void );

Return value

The start address of the .rodata kernel kernel

XEOS_Info_GetKernelStartAddress Top

Gets the start address of the kernel

uintptr_t XEOS_Info_GetKernelStartAddress( void );

Return value

The start address of the kernel

XEOS_Info_GetKernelTextSectionEndAddress Top

Gets the end address of the .text kernel section

uintptr_t XEOS_Info_GetKernelTextSectionEndAddress( void );

Return value

The end address of the .text kernel kernel

XEOS_Info_GetKernelTextSectionStartAddress Top

Gets the start address of the .text kernel section

uintptr_t XEOS_Info_GetKernelTextSectionStartAddress( void );

Return value

The start address of the .text kernel kernel

XEOS_Info_GetMemory Top

Gets the memory info object

XEOS_Info_MemoryRef XEOS_Info_GetMemory( XEOS_InfoRef info );

Parameters

• info
  The info object

Return value

The memory info object

XEOS_Info_MemoryEntryGetAddress Top

Gets the type of a memory entry info entry

XEOS_Info_MemoryEntryType XEOS_Info_MemoryEntryGetType( XEOS_Info_MemoryEntryRef entry );

Parameters

• entry
  The memory entry info object

Return value

The type of the memory entry info object

XEOS_Info_MemoryEntryGetAddress(XEOS_Info_MemoryEntryRef) Top

Gets the start address of a memory entry info entry

uint64_t XEOS_Info_MemoryEntryGetAddress( XEOS_Info_MemoryEntryRef entry );

Parameters

• entry
  The memory entry info object

Return value

The start address of the memory entry info object

XEOS_Info_MemoryEntryGetAddress(XEOS_Info_MemoryEntryRef) Top

Gets the length (in bytes) of a memory entry info entry

uint64_t XEOS_Info_MemoryEntryGetLength( XEOS_Info_MemoryEntryRef entry );

Parameters

• entry
  The memory entry info object

Return value

The length (in bytes) of the memory entry info entry

XEOS_Info_MemoryEntryGetLength Top

Gets the length (in bytes) of a memory entry info entry

uint64_t XEOS_Info_MemoryEntryGetLength( XEOS_Info_MemoryEntryRef entry );

Parameters

• entry
  The memory entry info object

Return value

The length (in bytes) of the memory entry info entry

XEOS_Info_MemoryEntryGetType Top

Gets the type of a memory entry info entry

XEOS_Info_MemoryEntryType XEOS_Info_MemoryEntryGetType( XEOS_Info_MemoryEntryRef entry );

Parameters

• entry
  The memory entry info object

Return value

The type of the memory entry info object

XEOS_Info_MemoryGetEntryAtIndex Top

Gets a specific memory entry info object

XEOS_Info_MemoryEntryRef XEOS_Info_MemoryGetEntryAtIndex( XEOS_Info_MemoryRef memory, unsigned int index );

Parameters

• memory
  The memory info object
• index
  The index of the memory info object

Return value

The memory entry info object

XEOS_Info_MemoryGetNumberOfEntries Top

Gets the number of memory info entries

unsigned int XEOS_Info_MemoryGetNumberOfEntries( XEOS_Info_MemoryRef memory );

Parameters

• memory
  The memory info object

Return value

The number of memory info entries

XEOS_Info_MemoryGetTotalBytes Top

Gets the number of memory bytes available on the system

uint64_t XEOS_Info_MemoryGetTotalBytes( XEOS_Info_MemoryRef memory );

Parameters

• memory
  The memory info object

Return value

The number of memory bytes available on the system

XEOS_Info_MemoryEntryRef Top

Opaque type for a memory entry info object

typedef struct __XEOS_Info_MemoryEntry * XEOS_Info_MemoryEntryRef;

XEOS_Info_MemoryEntryType Top

Type of a memory entry

typedef enum { XEOS_Info_MemoryEntryTypeUnknown = 0x00, XEOS_Info_MemoryEntryTypeUsable = 0x01, XEOS_Info_MemoryEntryTypeReserved = 0x02, XEOS_Info_MemoryEntryTypeACPIReclaimable = 0x03, XEOS_Info_MemoryEntryTypeACPINVS = 0x04, XEOS_Info_MemoryEntryTypeBad = 0x05 } XEOS_Info_MemoryEntryType;

Constants

• XEOS_Info_MemoryEntryTypeUnknown
  Unknown entry type
• XEOS_Info_MemoryEntryTypeUsable
  Usable (free) memory region
• XEOS_Info_MemoryEntryTypeReserved
  Reserved (unusable) memory region
• XEOS_Info_MemoryEntryTypeACPIReclaimable
  ACPI reclaimable memory region
• XEOS_Info_MemoryEntryTypeACPINVS
  ACPI NVS memory regions
• XEOS_Info_MemoryEntryTypeBad
  Bad memory region

XEOS_Info_MemoryRef Top

Opaque type for the memory info object

typedef struct __XEOS_Info_Memory * XEOS_Info_MemoryRef;

XEOS_InfoRef Top

Opaque type for the info object (passed by the bootloader)

typedef struct __XEOS_Info * XEOS_InfoRef;

__XEOS_INFO_H__ Top

#define __XEOS_INFO_H__