blob: e0b92075e274e58488d0265c431a581285b4f0a7 [file] [log] [blame]
Simon Glass3c10dc92019-12-06 21:41:34 -07001/* SPDX-License-Identifier: Intel */
2/*
3 * Access to binman information at runtime
4 *
5 * Copyright 2019 Google LLC
6 * Written by Simon Glass <sjg@chromium.org>
7 */
8
9#ifndef _BINMAN_H_
10#define _BINMAN_H_
11
Simon Glass8f9877d2020-07-07 21:32:04 -060012#include <dm/ofnode.h>
13
Simon Glass3c10dc92019-12-06 21:41:34 -070014/**
15 *struct binman_entry - information about a binman entry
16 *
17 * @image_pos: Position of entry in the image
18 * @size: Size of entry
19 */
20struct binman_entry {
21 u32 image_pos;
22 u32 size;
23};
24
25/**
Simon Glass8f9877d2020-07-07 21:32:04 -060026 * binman_entry_map() - Look up the address of an entry in memory
27 *
28 * @parent: Parent binman node
29 * @name: Name of entry
30 * @bufp: Returns a pointer to the entry
31 * @sizep: Returns the size of the entry
32 * @return 0 on success, -EPERM if the ROM offset is not set, -ENOENT if the
33 * entry cannot be found, other error code other error
34 */
35int binman_entry_map(ofnode parent, const char *name, void **bufp, int *sizep);
36
37/**
Simon Glassdb6fb7d2020-07-07 21:32:02 -060038 * binman_set_rom_offset() - Set the ROM memory-map offset
39 *
40 * @rom_offset: Offset from an image_pos to the memory-mapped address. This
41 * tells binman that ROM image_pos x can be addressed at rom_offset + x
42 */
43void binman_set_rom_offset(int rom_offset);
44
45/**
Simon Glass3c10dc92019-12-06 21:41:34 -070046 * binman_entry_find() - Find a binman symbol
47 *
48 * This searches the binman information in the device tree for a symbol of the
49 * given name
50 *
51 * @name: Path to entry to examine (e.g. "/read-only/u-boot")
52 * @entry: Returns information about the entry
53 * @return 0 if OK, -ENOENT if the path is not found, other -ve value if the
54 * binman information is invalid (missing image-pos or size)
55 */
56int binman_entry_find(const char *name, struct binman_entry *entry);
57
58/**
Simon Glass8f9877d2020-07-07 21:32:04 -060059 * binman_section_find_node() - Find a binman node
60 *
61 * @name: Name of node to look for
62 * @return Node that was found, ofnode_null() if not found
63 */
64ofnode binman_section_find_node(const char *name);
65
66/**
Simon Glass3c10dc92019-12-06 21:41:34 -070067 * binman_init() - Set up the binman symbol information
68 *
69 * This locates the binary symbol information in the device tree ready for use
70 *
71 * @return 0 if OK, -ENOMEM if out of memory, -EINVAL if there is no binman node
72 */
73int binman_init(void);
74
75#endif