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