1/* SPDX-License-Identifier: GPL-2.0+ */
2#ifndef _LINUX_LMB_H
3#define _LINUX_LMB_H
4#ifdef __KERNEL__
5
6#include <asm/types.h>
7#include <asm/u-boot.h>
8
9/*
10 * Logical memory blocks.
11 *
12 * Copyright (C) 2001 Peter Bergner, IBM Corp.
13 */
14
15/**
16 * enum lmb_flags - definition of memory region attributes
17 * @LMB_NONE: no special request
18 * @LMB_NOMAP: don't add to mmu configuration
19 */
20enum lmb_flags {
21	LMB_NONE		= 0x0,
22	LMB_NOMAP		= 0x4,
23};
24
25/**
26 * struct lmb_property - Description of one region.
27 *
28 * @base:	Base address of the region.
29 * @size:	Size of the region
30 * @flags:	memory region attributes
31 */
32struct lmb_property {
33	phys_addr_t base;
34	phys_size_t size;
35	enum lmb_flags flags;
36};
37
38/*
39 * For regions size management, see LMB configuration in KConfig
40 * all the #if test are done with CONFIG_LMB_USE_MAX_REGIONS (boolean)
41 *
42 * case 1. CONFIG_LMB_USE_MAX_REGIONS is defined (legacy mode)
43 *         => CONFIG_LMB_MAX_REGIONS is used to configure the region size,
44 *         directly in the array lmb_region.region[], with the same
45 *         configuration for memory and reserved regions.
46 *
47 * case 2. CONFIG_LMB_USE_MAX_REGIONS is not defined, the size of each
48 *         region is configurated *independently* with
49 *         => CONFIG_LMB_MEMORY_REGIONS: struct lmb.memory_regions
50 *         => CONFIG_LMB_RESERVED_REGIONS: struct lmb.reserved_regions
51 *         lmb_region.region is only a pointer to the correct buffer,
52 *         initialized in lmb_init(). This configuration is useful to manage
53 *         more reserved memory regions with CONFIG_LMB_RESERVED_REGIONS.
54 */
55
56/**
57 * struct lmb_region - Description of a set of region.
58 *
59 * @cnt: Number of regions.
60 * @max: Size of the region array, max value of cnt.
61 * @region: Array of the region properties
62 */
63struct lmb_region {
64	unsigned long cnt;
65	unsigned long max;
66#if IS_ENABLED(CONFIG_LMB_USE_MAX_REGIONS)
67	struct lmb_property region[CONFIG_LMB_MAX_REGIONS];
68#else
69	struct lmb_property *region;
70#endif
71};
72
73/**
74 * struct lmb - Logical memory block handle.
75 *
76 * Clients provide storage for Logical memory block (lmb) handles.
77 * The content of the structure is managed by the lmb library.
78 * A lmb struct is  initialized by lmb_init() functions.
79 * The lmb struct is passed to all other lmb APIs.
80 *
81 * @memory: Description of memory regions.
82 * @reserved: Description of reserved regions.
83 * @memory_regions: Array of the memory regions (statically allocated)
84 * @reserved_regions: Array of the reserved regions (statically allocated)
85 */
86struct lmb {
87	struct lmb_region memory;
88	struct lmb_region reserved;
89#if !IS_ENABLED(CONFIG_LMB_USE_MAX_REGIONS)
90	struct lmb_property memory_regions[CONFIG_LMB_MEMORY_REGIONS];
91	struct lmb_property reserved_regions[CONFIG_LMB_RESERVED_REGIONS];
92#endif
93};
94
95void lmb_init(struct lmb *lmb);
96void lmb_init_and_reserve(struct lmb *lmb, struct bd_info *bd, void *fdt_blob);
97void lmb_init_and_reserve_range(struct lmb *lmb, phys_addr_t base,
98				phys_size_t size, void *fdt_blob);
99long lmb_add(struct lmb *lmb, phys_addr_t base, phys_size_t size);
100long lmb_reserve(struct lmb *lmb, phys_addr_t base, phys_size_t size);
101/**
102 * lmb_reserve_flags - Reserve one region with a specific flags bitfield.
103 *
104 * @lmb:	the logical memory block struct
105 * @base:	base address of the memory region
106 * @size:	size of the memory region
107 * @flags:	flags for the memory region
108 * Return:	0 if OK, > 0 for coalesced region or a negative error code.
109 */
110long lmb_reserve_flags(struct lmb *lmb, phys_addr_t base,
111		       phys_size_t size, enum lmb_flags flags);
112phys_addr_t lmb_alloc(struct lmb *lmb, phys_size_t size, ulong align);
113phys_addr_t lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align,
114			   phys_addr_t max_addr);
115phys_addr_t __lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align,
116			     phys_addr_t max_addr);
117phys_addr_t lmb_alloc_addr(struct lmb *lmb, phys_addr_t base, phys_size_t size);
118phys_size_t lmb_get_free_size(struct lmb *lmb, phys_addr_t addr);
119
120/**
121 * lmb_is_reserved() - test if address is in reserved region
122 *
123 * The function checks if a reserved region comprising @addr exists.
124 *
125 * @lmb:	the logical memory block struct
126 * @addr:	address to be tested
127 * Return:	1 if reservation exists, 0 otherwise
128 */
129int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr);
130
131/**
132 * lmb_is_reserved_flags() - test if address is in reserved region with flag bits set
133 *
134 * The function checks if a reserved region comprising @addr exists which has
135 * all flag bits set which are set in @flags.
136 *
137 * @lmb:	the logical memory block struct
138 * @addr:	address to be tested
139 * @flags:	bitmap with bits to be tested
140 * Return:	1 if matching reservation exists, 0 otherwise
141 */
142int lmb_is_reserved_flags(struct lmb *lmb, phys_addr_t addr, int flags);
143
144long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size);
145
146void lmb_dump_all(struct lmb *lmb);
147void lmb_dump_all_force(struct lmb *lmb);
148
149void board_lmb_reserve(struct lmb *lmb);
150void arch_lmb_reserve(struct lmb *lmb);
151void arch_lmb_reserve_generic(struct lmb *lmb, ulong sp, ulong end, ulong align);
152
153#endif /* __KERNEL__ */
154
155#endif /* _LINUX_LMB_H */
156