1 /* Declarations for use by hardware emulation. */ 2 #ifndef QEMU_HW_H 3 #define QEMU_HW_H 4 5 #include "qemu-common.h" 6 7 #if defined(TARGET_PHYS_ADDR_BITS) && !defined(NEED_CPU_H) 8 #include "targphys.h" 9 #include "poison.h" 10 #include "cpu-common.h" 11 #endif 12 13 #include "irq.h" 14 15 /* VM Load/Save */ 16 17 /* This function writes a chunk of data to a file at the given position. 18 * The pos argument can be ignored if the file is only being used for 19 * streaming. The handler should try to write all of the data it can. 20 */ 21 typedef int (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf, 22 int64_t pos, int size); 23 24 /* Read a chunk of data from a file at the given position. The pos argument 25 * can be ignored if the file is only be used for streaming. The number of 26 * bytes actually read should be returned. 27 */ 28 typedef int (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf, 29 int64_t pos, int size); 30 31 /* Close a file and return an error code */ 32 typedef int (QEMUFileCloseFunc)(void *opaque); 33 34 /* Called to determine if the file has exceeded it's bandwidth allocation. The 35 * bandwidth capping is a soft limit, not a hard limit. 36 */ 37 typedef int (QEMUFileRateLimit)(void *opaque); 38 39 QEMUFile *qemu_fopen_ops(void *opaque, QEMUFilePutBufferFunc *put_buffer, 40 QEMUFileGetBufferFunc *get_buffer, 41 QEMUFileCloseFunc *close, 42 QEMUFileRateLimit *rate_limit); 43 QEMUFile *qemu_fopen(const char *filename, const char *mode); 44 QEMUFile *qemu_fopen_socket(int fd); 45 QEMUFile *qemu_popen(FILE *popen_file, const char *mode); 46 QEMUFile *qemu_popen_cmd(const char *command, const char *mode); 47 void qemu_fflush(QEMUFile *f); 48 int qemu_fclose(QEMUFile *f); 49 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size); 50 void qemu_put_byte(QEMUFile *f, int v); 51 52 static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v) 53 { 54 qemu_put_byte(f, (int)v); 55 } 56 57 #define qemu_put_sbyte qemu_put_byte 58 59 void qemu_put_be16(QEMUFile *f, unsigned int v); 60 void qemu_put_be32(QEMUFile *f, unsigned int v); 61 void qemu_put_be64(QEMUFile *f, uint64_t v); 62 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size); 63 int qemu_get_byte(QEMUFile *f); 64 65 static inline unsigned int qemu_get_ubyte(QEMUFile *f) 66 { 67 return (unsigned int)qemu_get_byte(f); 68 } 69 70 #define qemu_get_sbyte qemu_get_byte 71 72 unsigned int qemu_get_be16(QEMUFile *f); 73 unsigned int qemu_get_be32(QEMUFile *f); 74 uint64_t qemu_get_be64(QEMUFile *f); 75 int qemu_file_rate_limit(QEMUFile *f); 76 int qemu_file_has_error(QEMUFile *f); 77 void qemu_file_set_error(QEMUFile *f); 78 79 /* Try to send any outstanding data. This function is useful when output is 80 * halted due to rate limiting or EAGAIN errors occur as it can be used to 81 * resume output. */ 82 void qemu_file_put_notify(QEMUFile *f); 83 84 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv) 85 { 86 qemu_put_be64(f, *pv); 87 } 88 89 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv) 90 { 91 qemu_put_be32(f, *pv); 92 } 93 94 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv) 95 { 96 qemu_put_be16(f, *pv); 97 } 98 99 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv) 100 { 101 qemu_put_byte(f, *pv); 102 } 103 104 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv) 105 { 106 *pv = qemu_get_be64(f); 107 } 108 109 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv) 110 { 111 *pv = qemu_get_be32(f); 112 } 113 114 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv) 115 { 116 *pv = qemu_get_be16(f); 117 } 118 119 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv) 120 { 121 *pv = qemu_get_byte(f); 122 } 123 124 // Signed versions for type safety 125 static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, int size) 126 { 127 qemu_put_buffer(f, (const uint8_t *)buf, size); 128 } 129 130 static inline void qemu_put_sbe16(QEMUFile *f, int v) 131 { 132 qemu_put_be16(f, (unsigned int)v); 133 } 134 135 static inline void qemu_put_sbe32(QEMUFile *f, int v) 136 { 137 qemu_put_be32(f, (unsigned int)v); 138 } 139 140 static inline void qemu_put_sbe64(QEMUFile *f, int64_t v) 141 { 142 qemu_put_be64(f, (uint64_t)v); 143 } 144 145 static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size) 146 { 147 return qemu_get_buffer(f, (uint8_t *)buf, size); 148 } 149 150 static inline int qemu_get_sbe16(QEMUFile *f) 151 { 152 return (int)qemu_get_be16(f); 153 } 154 155 static inline int qemu_get_sbe32(QEMUFile *f) 156 { 157 return (int)qemu_get_be32(f); 158 } 159 160 static inline int64_t qemu_get_sbe64(QEMUFile *f) 161 { 162 return (int64_t)qemu_get_be64(f); 163 } 164 165 static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv) 166 { 167 qemu_put_8s(f, (const uint8_t *)pv); 168 } 169 170 static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv) 171 { 172 qemu_put_be16s(f, (const uint16_t *)pv); 173 } 174 175 static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv) 176 { 177 qemu_put_be32s(f, (const uint32_t *)pv); 178 } 179 180 static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv) 181 { 182 qemu_put_be64s(f, (const uint64_t *)pv); 183 } 184 185 static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv) 186 { 187 qemu_get_8s(f, (uint8_t *)pv); 188 } 189 190 static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv) 191 { 192 qemu_get_be16s(f, (uint16_t *)pv); 193 } 194 195 static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv) 196 { 197 qemu_get_be32s(f, (uint32_t *)pv); 198 } 199 200 static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv) 201 { 202 qemu_get_be64s(f, (uint64_t *)pv); 203 } 204 205 #ifdef NEED_CPU_H 206 #if TARGET_LONG_BITS == 64 207 #define qemu_put_betl qemu_put_be64 208 #define qemu_get_betl qemu_get_be64 209 #define qemu_put_betls qemu_put_be64s 210 #define qemu_get_betls qemu_get_be64s 211 #define qemu_put_sbetl qemu_put_sbe64 212 #define qemu_get_sbetl qemu_get_sbe64 213 #define qemu_put_sbetls qemu_put_sbe64s 214 #define qemu_get_sbetls qemu_get_sbe64s 215 #else 216 #define qemu_put_betl qemu_put_be32 217 #define qemu_get_betl qemu_get_be32 218 #define qemu_put_betls qemu_put_be32s 219 #define qemu_get_betls qemu_get_be32s 220 #define qemu_put_sbetl qemu_put_sbe32 221 #define qemu_get_sbetl qemu_get_sbe32 222 #define qemu_put_sbetls qemu_put_sbe32s 223 #define qemu_get_sbetls qemu_get_sbe32s 224 #endif 225 #endif 226 227 int64_t qemu_ftell(QEMUFile *f); 228 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence); 229 230 typedef void SaveStateHandler(QEMUFile *f, void *opaque); 231 typedef int SaveLiveStateHandler(QEMUFile *f, int stage, void *opaque); 232 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id); 233 234 int register_savevm(const char *idstr, 235 int instance_id, 236 int version_id, 237 SaveStateHandler *save_state, 238 LoadStateHandler *load_state, 239 void *opaque); 240 241 int register_savevm_live(const char *idstr, 242 int instance_id, 243 int version_id, 244 SaveLiveStateHandler *save_live_state, 245 SaveStateHandler *save_state, 246 LoadStateHandler *load_state, 247 void *opaque); 248 249 void unregister_savevm(const char *idstr, void *opaque); 250 251 typedef void QEMUResetHandler(void *opaque); 252 253 void qemu_register_reset(QEMUResetHandler *func, void *opaque); 254 255 /* handler to set the boot_device for a specific type of QEMUMachine */ 256 /* return 0 if success */ 257 typedef int QEMUBootSetHandler(void *opaque, const char *boot_device); 258 void qemu_register_boot_set(QEMUBootSetHandler *func, void *opaque); 259 260 /* These should really be in isa.h, but are here to make pc.h happy. */ 261 typedef void (IOPortWriteFunc)(void *opaque, uint32_t address, uint32_t data); 262 typedef uint32_t (IOPortReadFunc)(void *opaque, uint32_t address); 263 264 #endif 265