]> git.proxmox.com Git - qemu.git/blob - include/hw/nvram/fw_cfg.h
fw_cfg: interface to trigger callback on read
[qemu.git] / include / hw / nvram / fw_cfg.h
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 #ifndef NO_QEMU_PROTOS
50 typedef struct FWCfgFile {
51 uint32_t size; /* file size */
52 uint16_t select; /* write this to 0x510 to read it */
53 uint16_t reserved;
54 char name[56];
55 } FWCfgFile;
56
57 typedef struct FWCfgFiles {
58 uint32_t count;
59 FWCfgFile f[];
60 } FWCfgFiles;
61
62 typedef void (*FWCfgCallback)(void *opaque, uint8_t *data);
63 typedef void (*FWCfgReadCallback)(void *opaque, uint32_t offset);
64
65 void fw_cfg_add_bytes(FWCfgState *s, uint16_t key, void *data, size_t len);
66 void fw_cfg_add_string(FWCfgState *s, uint16_t key, const char *value);
67 void fw_cfg_add_i16(FWCfgState *s, uint16_t key, uint16_t value);
68 void fw_cfg_add_i32(FWCfgState *s, uint16_t key, uint32_t value);
69 void fw_cfg_add_i64(FWCfgState *s, uint16_t key, uint64_t value);
70 void fw_cfg_add_callback(FWCfgState *s, uint16_t key, FWCfgCallback callback,
71 void *callback_opaque, void *data, size_t len);
72 void fw_cfg_add_file(FWCfgState *s, const char *filename, void *data,
73 size_t len);
74 void fw_cfg_add_file_callback(FWCfgState *s, const char *filename,
75 FWCfgReadCallback callback, void *callback_opaque,
76 void *data, size_t len);
77 FWCfgState *fw_cfg_init(uint32_t ctl_port, uint32_t data_port,
78 hwaddr crl_addr, hwaddr data_addr);
79
80 FWCfgState *fw_cfg_find(void);
81
82 #endif /* NO_QEMU_PROTOS */
83
84 #endif