xref: /qemu/include/hw/loader-fit.h (revision d64db833d6e3cbe9ea5f36342480f920f3675cea)
1  /*
2   * Flattened Image Tree loader.
3   *
4   * Copyright (c) 2016 Imagination Technologies
5   *
6   * This library is free software; you can redistribute it and/or
7   * modify it under the terms of the GNU Lesser General Public
8   * License as published by the Free Software Foundation; either
9   * version 2.1 of the License, or (at your option) any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  #ifndef HW_LOADER_FIT_H
21  #define HW_LOADER_FIT_H
22  
23  #include "exec/hwaddr.h"
24  
25  struct fit_loader_match {
26      const char *compatible;
27      const void *data;
28  };
29  
30  struct fit_loader {
31      const struct fit_loader_match *matches;
32      hwaddr (*addr_to_phys)(void *opaque, uint64_t addr);
33      void *(*fdt_filter)(void *opaque, const void *fdt,
34                          const void *match_data, hwaddr *load_addr);
35      const void *(*kernel_filter)(void *opaque, const void *kernel,
36                                   hwaddr *load_addr, hwaddr *entry_addr);
37  };
38  
39  /**
40   * load_fit: load a FIT format image
41   * @ldr: structure defining board specific properties and hooks
42   * @filename: image to load
43   * @pfdt: pointer to update with address of FDT blob
44   * @opaque: opaque value passed back to the hook functions in @ldr
45   * Returns: 0 on success, or a negative errno on failure
46   *
47   * @pfdt is used to tell the caller about the FDT blob. On return, it
48   * has been set to point to the FDT blob, and it is now the caller's
49   * responsibility to free that memory with g_free(). Usually the caller
50   * will want to pass in &machine->fdt here, to record the FDT blob for
51   * the dumpdtb option and QMP/HMP commands.
52   */
53  int load_fit(const struct fit_loader *ldr, const char *filename, void **pfdt,
54               void *opaque);
55  
56  #endif /* HW_LOADER_FIT_H */
57