Logical memory blocks

enumlmb_map_op: memory map operation

Constants

LMB_MAP_OP_RESERVE: reserve memory
LMB_MAP_OP_FREE: free memory
LMB_MAP_OP_ADD: add memory

structlmb_region: Description of one region

Definition

struct lmb_region {
 phys_addr_t base;
 phys_size_t size;
 u32 flags;
};

Members

base: Base address of the region
size: Size of the region
flags: Memory region attributes

structlmb: The LMB structure

Definition

struct lmb {
 struct alist available_mem;
 struct alist used_mem;
 bool test;
};

Members

available_mem: List of memory available to LMB
used_mem: List of used/reserved memory regions
test: Is structure being used for LMB tests

intlmb_init(void): Initialise the LMB module.

Parameters

void: no arguments

Return

0 on success, negative error code on failure.

Description

Initialise the LMB lists needed for keeping the memory map. There are two lists, in form of allocated list data structure. One for the available memory, and one for the used memory. Initialise the two lists as part of board init. Add memory to the available memory list and reserve common areas by adding them to the used memory list.

voidlmb_add_memory(void): Add memory range for LMB allocations.

Parameters

void: no arguments

Description

Add the entire available memory range to the pool of memory that can be used by the LMB module for allocations.

longlmb_reserve(phys_addr_tbase, phys_size_tsize, u32flags): Reserve one region with a specific flags bitfield

Parameters

phys_addr_t base: Base address of the memory region
phys_size_t size: Size of the memory region
u32 flags: Flags for the memory region

Return

0 - Added successfully, or it’s already added (only if LMB_NONE)
-EEXIST - The region is already added, and flags != LMB_NONE
-1 - Failure

phys_addr_tlmb_alloc_base(phys_size_tsize, ulongalign, phys_addr_tmax_addr, uintflags): Allocate specified memory region with specified attributes

Parameters

phys_size_t size: Size of the region requested
ulong align: Alignment of the memory region requested
phys_addr_t max_addr: Maximum address of the requested region
uint flags: Memory region attributes to be set

Description

Allocate a region of memory with the attributes specified through the parameter. The max_addr parameter is used to specify the maximum address below which the requested region should be allocated.

Return

Base address on success, 0 on error.

intlmb_alloc_addr(phys_addr_tbase, phys_size_tsize, u32flags): Allocate specified memory address with specified attributes

Parameters

phys_addr_t base: Base Address requested
phys_size_t size: Size of the region requested
u32 flags: Memory region attributes to be set

Description

Allocate a region of memory with the attributes specified through the parameter. The base parameter is used to specify the base address of the requested region.

Return

0 on success -1 on error

intlmb_is_reserved_flags(phys_addr_taddr, intflags): Test if address is in reserved region with flag bits set

Parameters

phys_addr_t addr: Address to be tested
int flags: Bitmap with bits to be tested

Description

The function checks if a reserved region comprising addr exists which has all flag bits set which are set in flags.

Return

1 if matching reservation exists, 0 otherwise.

longlmb_free_flags(phys_addr_tbase, phys_size_tsize, uintflags): Free up a region of memory

Parameters

phys_addr_t base: Base Address of region to be freed
phys_size_t size: Size of the region to be freed
uint flags: Memory region attributes

Return

0 on success, negative error code on failure.

intio_lmb_setup(structlmb *io_lmb): Initialize LMB struct

Parameters

struct lmb *io_lmb: IO LMB to initialize

Return

0 on success, negative error code on failure.

voidio_lmb_teardown(structlmb *io_lmb): Tear LMB struct down

Parameters

struct lmb *io_lmb: IO LMB to teardown

longio_lmb_add(structlmb *io_lmb, phys_addr_tbase, phys_size_tsize): Add an IOVA range for allocations

Parameters

struct lmb *io_lmb: LMB to add the space to
phys_addr_t base: Base Address of region to add
phys_size_t size: Size of the region to add

Description

Add the IOVA space [base, base + size] to be managed by io_lmb.

Return

0 on success, negative error code on failure.

phys_addr_tio_lmb_alloc(structlmb *io_lmb, phys_size_tsize, ulongalign): Allocate specified IO memory address with specified alignment

Parameters

struct lmb *io_lmb: LMB to alloc from
phys_size_t size: Size of the region requested
ulong align: Required address and size alignment

Description

Allocate a region of IO memory. The base parameter is used to specify the base address of the requested region.

Return

Base IO address on success, 0 on error.

longio_lmb_free(structlmb *io_lmb, phys_addr_tbase, phys_size_tsize): Free up a region of IOVA space

Parameters

struct lmb *io_lmb: LMB to return the IO address space to
phys_addr_t base: Base Address of region to be freed
phys_size_t size: Size of the region to be freed

Return

0 on success, negative error code on failure.