xref: /openbmc/qemu/include/hw/nvram/fw_cfg.h (revision 14b61600)
1 #ifndef FW_CFG_H
2 #define FW_CFG_H
3 
4 #ifndef NO_QEMU_PROTOS
5 #include <stdint.h>
6 #include <stddef.h>
7 
8 #include "exec/hwaddr.h"
9 #include "qemu/typedefs.h"
10 #endif
11 
12 #define FW_CFG_SIGNATURE        0x00
13 #define FW_CFG_ID               0x01
14 #define FW_CFG_UUID             0x02
15 #define FW_CFG_RAM_SIZE         0x03
16 #define FW_CFG_NOGRAPHIC        0x04
17 #define FW_CFG_NB_CPUS          0x05
18 #define FW_CFG_MACHINE_ID       0x06
19 #define FW_CFG_KERNEL_ADDR      0x07
20 #define FW_CFG_KERNEL_SIZE      0x08
21 #define FW_CFG_KERNEL_CMDLINE   0x09
22 #define FW_CFG_INITRD_ADDR      0x0a
23 #define FW_CFG_INITRD_SIZE      0x0b
24 #define FW_CFG_BOOT_DEVICE      0x0c
25 #define FW_CFG_NUMA             0x0d
26 #define FW_CFG_BOOT_MENU        0x0e
27 #define FW_CFG_MAX_CPUS         0x0f
28 #define FW_CFG_KERNEL_ENTRY     0x10
29 #define FW_CFG_KERNEL_DATA      0x11
30 #define FW_CFG_INITRD_DATA      0x12
31 #define FW_CFG_CMDLINE_ADDR     0x13
32 #define FW_CFG_CMDLINE_SIZE     0x14
33 #define FW_CFG_CMDLINE_DATA     0x15
34 #define FW_CFG_SETUP_ADDR       0x16
35 #define FW_CFG_SETUP_SIZE       0x17
36 #define FW_CFG_SETUP_DATA       0x18
37 #define FW_CFG_FILE_DIR         0x19
38 
39 #define FW_CFG_FILE_FIRST       0x20
40 #define FW_CFG_FILE_SLOTS       0x10
41 #define FW_CFG_MAX_ENTRY        (FW_CFG_FILE_FIRST+FW_CFG_FILE_SLOTS)
42 
43 #define FW_CFG_WRITE_CHANNEL    0x4000
44 #define FW_CFG_ARCH_LOCAL       0x8000
45 #define FW_CFG_ENTRY_MASK       ~(FW_CFG_WRITE_CHANNEL | FW_CFG_ARCH_LOCAL)
46 
47 #define FW_CFG_INVALID          0xffff
48 
49 #define FW_CFG_MAX_FILE_PATH    56
50 
51 #ifndef NO_QEMU_PROTOS
52 typedef struct FWCfgFile {
53     uint32_t  size;        /* file size */
54     uint16_t  select;      /* write this to 0x510 to read it */
55     uint16_t  reserved;
56     char      name[FW_CFG_MAX_FILE_PATH];
57 } FWCfgFile;
58 
59 typedef struct FWCfgFiles {
60     uint32_t  count;
61     FWCfgFile f[];
62 } FWCfgFiles;
63 
64 /* Control as first field allows for different structures selected by this
65  * field, which might be useful in the future
66  */
67 typedef struct FWCfgDmaAccess {
68     uint32_t control;
69     uint32_t length;
70     uint64_t address;
71 } QEMU_PACKED FWCfgDmaAccess;
72 
73 typedef void (*FWCfgCallback)(void *opaque, uint8_t *data);
74 typedef void (*FWCfgReadCallback)(void *opaque, uint32_t offset);
75 
76 void fw_cfg_add_bytes(FWCfgState *s, uint16_t key, void *data, size_t len);
77 void fw_cfg_add_string(FWCfgState *s, uint16_t key, const char *value);
78 void fw_cfg_add_i16(FWCfgState *s, uint16_t key, uint16_t value);
79 void fw_cfg_modify_i16(FWCfgState *s, uint16_t key, uint16_t value);
80 void fw_cfg_add_i32(FWCfgState *s, uint16_t key, uint32_t value);
81 void fw_cfg_add_i64(FWCfgState *s, uint16_t key, uint64_t value);
82 void fw_cfg_add_file(FWCfgState *s, const char *filename, void *data,
83                      size_t len);
84 void fw_cfg_add_file_callback(FWCfgState *s, const char *filename,
85                               FWCfgReadCallback callback, void *callback_opaque,
86                               void *data, size_t len);
87 void *fw_cfg_modify_file(FWCfgState *s, const char *filename, void *data,
88                          size_t len);
89 FWCfgState *fw_cfg_init_io_dma(uint32_t iobase, uint32_t dma_iobase,
90                                 AddressSpace *dma_as);
91 FWCfgState *fw_cfg_init_io(uint32_t iobase);
92 FWCfgState *fw_cfg_init_mem(hwaddr ctl_addr, hwaddr data_addr);
93 FWCfgState *fw_cfg_init_mem_wide(hwaddr ctl_addr,
94                                  hwaddr data_addr, uint32_t data_width,
95                                  hwaddr dma_addr, AddressSpace *dma_as);
96 
97 FWCfgState *fw_cfg_find(void);
98 
99 #endif /* NO_QEMU_PROTOS */
100 
101 #endif
102