diff options
Diffstat (limited to 'src/include/memrange.h')
| -rw-r--r-- | src/include/memrange.h | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/src/include/memrange.h b/src/include/memrange.h new file mode 100644 index 0000000000..23dae6a30a --- /dev/null +++ b/src/include/memrange.h @@ -0,0 +1,107 @@ +/* + * This file is part of the coreboot project. + * + * Copyright (C) 2013 Google, Inc. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; version 2 of the License. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ +#ifndef MEMRANGE_H_ +#define MEMRANGE_H_ + +#include <device/resource.h> + +/* A memranges structure consists of a list of range_entry(s). The structure + * is exposed so that a memranges can be used on the stack if needed. */ +struct memranges { + struct range_entry *entries; +}; + +/* Each region within a memranges structure is represented by a + * range_entry structure. Use the associated range_entry_(base|end|size|tag) + * functions to interrogate its properties. i.e. don't rely on one's own + * interpretation of the fields. */ +struct range_entry { + resource_t begin; + resource_t end; + unsigned long tag; + struct range_entry *next; +}; + +/* Return inclusive base address of memory range. */ +static inline resource_t range_entry_base(const struct range_entry *r) +{ + return r->begin; +} + +/* Return exclusive end address of memory range. */ +static inline resource_t range_entry_end(const struct range_entry *r) +{ + return r->end + 1; +} + +/* Return size of of memory range. */ +static inline resource_t range_entry_size(const struct range_entry *r) +{ + return r->end - r->begin + 1; +} + +static inline unsigned long range_entry_tag(const struct range_entry *r) +{ + return r->tag; +} + +/* Iterate over each entry in a memranges structure. Ranges cannot + * be deleted while processing each entry as the list cannot be safely + * traversed after such an operation. + * r - range_entry pointer. + * ranges - memranges pointer */ +#define memranges_each_entry(r, ranges) \ + for (r = (ranges)->entries; r != NULL; r = r->next) + +/* Initialize and fill a memranges structure according to the + * mask and match type for all memory resources. Tag each entry with the + * specified type. */ +void memranges_init(struct memranges *ranges, + unsigned long mask, unsigned long match, + unsigned long tag); + +/* Remove and free all entries within the memranges structure. */ +void memranges_teardown(struct memranges *ranges); + +/* Add memory resources that match with the corresponding mask and match. + * Each entry will be tagged with the provided tag. e.g. To populate + * all cacheable memory resources in the range: + * memranges_add_resources(range, IORESOURCE_CACHEABLE, + * IORESROUCE_CACHEABLE, my_cacheable_tag); */ +void memranges_add_resources(struct memranges *ranges, + unsigned long mask, unsigned long match, + unsigned long tag); + +/* Fill all address ranges up to limit (exclusive) not covered by an entry by + * inserting new entries with the provided tag. */ +void memranges_fill_holes_up_to(struct memranges *ranges, + resource_t limit, unsigned long tag); + +/* Create a hole in the range by deleting/modifying entries that overlap with + * the region specified by base and size. */ +void memranges_create_hole(struct memranges *ranges, + resource_t base, resource_t size); + +/* Insert a resource to the given memranges. All existing ranges + * covered by range specified by base and size will be removed before a + * new one is added. */ +void memranges_insert(struct memranges *ranges, + resource_t base, resource_t size, unsigned long tag); + +#endif /* MEMRANGE_H_ */ |