// SPDX-License-Identifier: GPL-2.0-only /* * linux/drivers/firmware/memmap.c * Copyright (C) 2008 SUSE LINUX Products GmbH * by Bernhard Walle <[email protected]> */ #include <linux/string.h> #include <linux/firmware-map.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/types.h> #include <linux/memblock.h> #include <linux/slab.h> #include <linux/mm.h> /* * Data types ------------------------------------------------------------------ */ /* * Firmware map entry. Because firmware memory maps are flat and not * hierarchical, it's ok to organise them in a linked list. No parent * information is necessary as for the resource tree. */ struct firmware_map_entry { … }; /* * Forward declarations -------------------------------------------------------- */ static ssize_t memmap_attr_show(struct kobject *kobj, struct attribute *attr, char *buf); static ssize_t start_show(struct firmware_map_entry *entry, char *buf); static ssize_t end_show(struct firmware_map_entry *entry, char *buf); static ssize_t type_show(struct firmware_map_entry *entry, char *buf); static struct firmware_map_entry * __meminit firmware_map_find_entry(u64 start, u64 end, const char *type); /* * Static data ----------------------------------------------------------------- */ struct memmap_attribute { … }; static struct memmap_attribute memmap_start_attr = …; static struct memmap_attribute memmap_end_attr = …; static struct memmap_attribute memmap_type_attr = …; /* * These are default attributes that are added for every memmap entry. */ static struct attribute *def_attrs[] = …; ATTRIBUTE_GROUPS(…); static const struct sysfs_ops memmap_attr_ops = …; /* Firmware memory map entries. */ static LIST_HEAD(map_entries); static DEFINE_SPINLOCK(map_entries_lock); /* * For memory hotplug, there is no way to free memory map entries allocated * by boot mem after the system is up. So when we hot-remove memory whose * map entry is allocated by bootmem, we need to remember the storage and * reuse it when the memory is hot-added again. */ static LIST_HEAD(map_entries_bootmem); static DEFINE_SPINLOCK(map_entries_bootmem_lock); static inline struct firmware_map_entry * to_memmap_entry(struct kobject *kobj) { … } static void __meminit release_firmware_map_entry(struct kobject *kobj) { … } static struct kobj_type __refdata memmap_ktype = …; /* * Registration functions ------------------------------------------------------ */ /** * firmware_map_add_entry() - Does the real work to add a firmware memmap entry. * @start: Start of the memory range. * @end: End of the memory range (exclusive). * @type: Type of the memory range. * @entry: Pre-allocated (either kmalloc() or bootmem allocator), uninitialised * entry. * * Common implementation of firmware_map_add() and firmware_map_add_early() * which expects a pre-allocated struct firmware_map_entry. * * Return: 0 always */ static int firmware_map_add_entry(u64 start, u64 end, const char *type, struct firmware_map_entry *entry) { … } /** * firmware_map_remove_entry() - Does the real work to remove a firmware * memmap entry. * @entry: removed entry. * * The caller must hold map_entries_lock, and release it properly. */ static inline void firmware_map_remove_entry(struct firmware_map_entry *entry) { … } /* * Add memmap entry on sysfs */ static int add_sysfs_fw_map_entry(struct firmware_map_entry *entry) { … } /* * Remove memmap entry on sysfs */ static inline void remove_sysfs_fw_map_entry(struct firmware_map_entry *entry) { … } /** * firmware_map_find_entry_in_list() - Search memmap entry in a given list. * @start: Start of the memory range. * @end: End of the memory range (exclusive). * @type: Type of the memory range. * @list: In which to find the entry. * * This function is to find the memmap entey of a given memory range in a * given list. The caller must hold map_entries_lock, and must not release * the lock until the processing of the returned entry has completed. * * Return: Pointer to the entry to be found on success, or NULL on failure. */ static struct firmware_map_entry * __meminit firmware_map_find_entry_in_list(u64 start, u64 end, const char *type, struct list_head *list) { … } /** * firmware_map_find_entry() - Search memmap entry in map_entries. * @start: Start of the memory range. * @end: End of the memory range (exclusive). * @type: Type of the memory range. * * This function is to find the memmap entey of a given memory range. * The caller must hold map_entries_lock, and must not release the lock * until the processing of the returned entry has completed. * * Return: Pointer to the entry to be found on success, or NULL on failure. */ static struct firmware_map_entry * __meminit firmware_map_find_entry(u64 start, u64 end, const char *type) { … } /** * firmware_map_find_entry_bootmem() - Search memmap entry in map_entries_bootmem. * @start: Start of the memory range. * @end: End of the memory range (exclusive). * @type: Type of the memory range. * * This function is similar to firmware_map_find_entry except that it find the * given entry in map_entries_bootmem. * * Return: Pointer to the entry to be found on success, or NULL on failure. */ static struct firmware_map_entry * __meminit firmware_map_find_entry_bootmem(u64 start, u64 end, const char *type) { … } /** * firmware_map_add_hotplug() - Adds a firmware mapping entry when we do * memory hotplug. * @start: Start of the memory range. * @end: End of the memory range (exclusive) * @type: Type of the memory range. * * Adds a firmware mapping entry. This function is for memory hotplug, it is * similar to function firmware_map_add_early(). The only difference is that * it will create the syfs entry dynamically. * * Return: 0 on success, or -ENOMEM if no memory could be allocated. */ int __meminit firmware_map_add_hotplug(u64 start, u64 end, const char *type) { … } /** * firmware_map_add_early() - Adds a firmware mapping entry. * @start: Start of the memory range. * @end: End of the memory range. * @type: Type of the memory range. * * Adds a firmware mapping entry. This function uses the bootmem allocator * for memory allocation. * * That function must be called before late_initcall. * * Return: 0 on success, or -ENOMEM if no memory could be allocated. */ int __init firmware_map_add_early(u64 start, u64 end, const char *type) { … } /** * firmware_map_remove() - remove a firmware mapping entry * @start: Start of the memory range. * @end: End of the memory range. * @type: Type of the memory range. * * removes a firmware mapping entry. * * Return: 0 on success, or -EINVAL if no entry. */ int __meminit firmware_map_remove(u64 start, u64 end, const char *type) { … } /* * Sysfs functions ------------------------------------------------------------- */ static ssize_t start_show(struct firmware_map_entry *entry, char *buf) { … } static ssize_t end_show(struct firmware_map_entry *entry, char *buf) { … } static ssize_t type_show(struct firmware_map_entry *entry, char *buf) { … } static inline struct memmap_attribute *to_memmap_attr(struct attribute *attr) { … } static ssize_t memmap_attr_show(struct kobject *kobj, struct attribute *attr, char *buf) { … } /* * Initialises stuff and adds the entries in the map_entries list to * sysfs. Important is that firmware_map_add() and firmware_map_add_early() * must be called before late_initcall. That's just because that function * is called as late_initcall() function, which means that if you call * firmware_map_add() or firmware_map_add_early() afterwards, the entries * are not added to sysfs. */ static int __init firmware_memmap_init(void) { … } late_initcall(firmware_memmap_init);