blob: 7298c2ccc40374c3e3539420a1be717d664369f7 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Kumar Gala4ed65522008-02-27 21:51:47 -06002#ifndef _LINUX_LMB_H
3#define _LINUX_LMB_H
4#ifdef __KERNEL__
5
6#include <asm/types.h>
Simon Goldschmidt9cc23232019-01-26 22:13:04 +01007#include <asm/u-boot.h>
8
Kumar Gala4ed65522008-02-27 21:51:47 -06009/*
10 * Logical memory blocks.
11 *
12 * Copyright (C) 2001 Peter Bergner, IBM Corp.
Kumar Gala4ed65522008-02-27 21:51:47 -060013 */
14
Patrick Delaunay6d665022021-03-10 10:16:31 +010015/**
Patrick Delaunay59c0ea52021-05-07 14:50:29 +020016 * 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/**
Patrick Delaunay6d665022021-03-10 10:16:31 +010026 * struct lmb_property - Description of one region.
27 *
Heinrich Schuchardt4ad4c2d2021-11-14 08:43:07 +010028 * @base: Base address of the region.
29 * @size: Size of the region
30 * @flags: memory region attributes
Patrick Delaunay6d665022021-03-10 10:16:31 +010031 */
Kumar Gala4ed65522008-02-27 21:51:47 -060032struct lmb_property {
Becky Bruce391fd932008-06-09 20:37:18 -050033 phys_addr_t base;
34 phys_size_t size;
Patrick Delaunay59c0ea52021-05-07 14:50:29 +020035 enum lmb_flags flags;
Kumar Gala4ed65522008-02-27 21:51:47 -060036};
37
Patrick Delaunay6d665022021-03-10 10:16:31 +010038/**
39 * struct lmb_region - Description of a set of region.
40 *
41 * @cnt: Number of regions.
42 * @max: Size of the region array, max value of cnt.
43 * @region: Array of the region properties
44 */
Kumar Gala4ed65522008-02-27 21:51:47 -060045struct lmb_region {
46 unsigned long cnt;
Patrick Delaunay00fd8da2021-03-10 10:16:27 +010047 unsigned long max;
Patrick Delaunay6d665022021-03-10 10:16:31 +010048#if IS_ENABLED(CONFIG_LMB_USE_MAX_REGIONS)
Patrick Delaunaycb1e6192021-03-10 10:16:29 +010049 struct lmb_property region[CONFIG_LMB_MAX_REGIONS];
Patrick Delaunay6d665022021-03-10 10:16:31 +010050#else
51 struct lmb_property *region;
52#endif
Kumar Gala4ed65522008-02-27 21:51:47 -060053};
54
Patrick Delaunay6d665022021-03-10 10:16:31 +010055/**
56 * struct lmb - Logical memory block handle.
57 *
58 * Clients provide storage for Logical memory block (lmb) handles.
59 * The content of the structure is managed by the lmb library.
60 * A lmb struct is initialized by lmb_init() functions.
61 * The lmb struct is passed to all other lmb APIs.
62 *
63 * @memory: Description of memory regions.
64 * @reserved: Description of reserved regions.
65 * @memory_regions: Array of the memory regions (statically allocated)
66 * @reserved_regions: Array of the reserved regions (statically allocated)
67 */
Kumar Gala4ed65522008-02-27 21:51:47 -060068struct lmb {
69 struct lmb_region memory;
70 struct lmb_region reserved;
Patrice Chotard5e2548c2022-08-02 10:21:35 +020071#ifdef CONFIG_LMB_MEMORY_REGIONS
Patrick Delaunay6d665022021-03-10 10:16:31 +010072 struct lmb_property memory_regions[CONFIG_LMB_MEMORY_REGIONS];
73 struct lmb_property reserved_regions[CONFIG_LMB_RESERVED_REGIONS];
74#endif
Kumar Gala4ed65522008-02-27 21:51:47 -060075};
76
Heinrich Schuchardt951a8c42021-11-14 08:52:48 +010077void lmb_init(struct lmb *lmb);
78void lmb_init_and_reserve(struct lmb *lmb, struct bd_info *bd, void *fdt_blob);
79void lmb_init_and_reserve_range(struct lmb *lmb, phys_addr_t base,
80 phys_size_t size, void *fdt_blob);
81long lmb_add(struct lmb *lmb, phys_addr_t base, phys_size_t size);
82long lmb_reserve(struct lmb *lmb, phys_addr_t base, phys_size_t size);
Patrick Delaunay59c0ea52021-05-07 14:50:29 +020083/**
84 * lmb_reserve_flags - Reserve one region with a specific flags bitfield.
85 *
Heinrich Schuchardt4ad4c2d2021-11-14 08:43:07 +010086 * @lmb: the logical memory block struct
87 * @base: base address of the memory region
88 * @size: size of the memory region
89 * @flags: flags for the memory region
90 * Return: 0 if OK, > 0 for coalesced region or a negative error code.
Patrick Delaunay59c0ea52021-05-07 14:50:29 +020091 */
92long lmb_reserve_flags(struct lmb *lmb, phys_addr_t base,
93 phys_size_t size, enum lmb_flags flags);
Heinrich Schuchardt951a8c42021-11-14 08:52:48 +010094phys_addr_t lmb_alloc(struct lmb *lmb, phys_size_t size, ulong align);
95phys_addr_t lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align,
96 phys_addr_t max_addr);
97phys_addr_t __lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align,
98 phys_addr_t max_addr);
99phys_addr_t lmb_alloc_addr(struct lmb *lmb, phys_addr_t base, phys_size_t size);
100phys_size_t lmb_get_free_size(struct lmb *lmb, phys_addr_t addr);
101int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr);
Patrick Delaunaye359a4a2021-05-07 14:50:30 +0200102/**
103 * lmb_is_reserved_flags - test if tha address is in reserved region with a bitfield flag
104 *
Heinrich Schuchardt4ad4c2d2021-11-14 08:43:07 +0100105 * @lmb: the logical memory block struct
106 * @addr: address to be tested
107 * @flags: flags bitfied to be tested
108 * Return: if not reserved or reserved without the requested flag else 1
Patrick Delaunaye359a4a2021-05-07 14:50:30 +0200109 */
110int lmb_is_reserved_flags(struct lmb *lmb, phys_addr_t addr, int flags);
Heinrich Schuchardt951a8c42021-11-14 08:52:48 +0100111long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size);
Kumar Gala4ed65522008-02-27 21:51:47 -0600112
Heinrich Schuchardt951a8c42021-11-14 08:52:48 +0100113void lmb_dump_all(struct lmb *lmb);
114void lmb_dump_all_force(struct lmb *lmb);
Kumar Gala4ed65522008-02-27 21:51:47 -0600115
Mike Frysingera16028d2009-11-03 11:35:59 -0500116void board_lmb_reserve(struct lmb *lmb);
117void arch_lmb_reserve(struct lmb *lmb);
Marek Vasut12746982021-09-10 22:47:09 +0200118void arch_lmb_reserve_generic(struct lmb *lmb, ulong sp, ulong end, ulong align);
Mike Frysingera16028d2009-11-03 11:35:59 -0500119
Kumar Gala4ed65522008-02-27 21:51:47 -0600120#endif /* __KERNEL__ */
121
122#endif /* _LINUX_LMB_H */