2 * QEMU System Emulator header
4 * Copyright (c) 2003 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 /* we put basic includes here to avoid repeating them in device drivers */
48 #define lseek64 _lseeki64
54 #define xglue(x, y) x ## y
55 #define glue(x, y) xglue(x, y)
56 #define stringify(s) tostring(s)
57 #define tostring(s) #s
60 #if defined(WORDS_BIGENDIAN)
61 static inline uint32_t be32_to_cpu(uint32_t v)
66 static inline uint16_t be16_to_cpu(uint16_t v)
71 static inline uint32_t cpu_to_be32(uint32_t v)
76 static inline uint16_t cpu_to_be16(uint16_t v)
81 static inline uint32_t le32_to_cpu(uint32_t v)
86 static inline uint16_t le16_to_cpu(uint16_t v)
91 static inline uint32_t cpu_to_le32(uint32_t v)
96 static inline uint16_t cpu_to_le16(uint16_t v)
103 static inline uint32_t be32_to_cpu(uint32_t v)
108 static inline uint16_t be16_to_cpu(uint16_t v)
113 static inline uint32_t cpu_to_be32(uint32_t v)
118 static inline uint16_t cpu_to_be16(uint16_t v)
123 static inline uint32_t le32_to_cpu(uint32_t v)
128 static inline uint16_t le16_to_cpu(uint16_t v)
133 static inline uint32_t cpu_to_le32(uint32_t v)
138 static inline uint16_t cpu_to_le16(uint16_t v)
146 extern int reset_requested;
148 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
150 void hw_error(const char *fmt, ...);
152 int load_image(const char *filename, uint8_t *addr);
153 extern const char *bios_dir;
155 void pstrcpy(char *buf, int buf_size, const char *str);
156 char *pstrcat(char *buf, int buf_size, const char *s);
158 int serial_open_device(void);
160 extern int vm_running;
162 typedef void VMStopHandler(void *opaque, int reason);
164 int qemu_add_vm_stop_handler(VMStopHandler *cb, void *opaque);
165 void qemu_del_vm_stop_handler(VMStopHandler *cb, void *opaque);
168 void vm_stop(int reason);
170 extern int audio_enabled;
172 /* async I/O support */
174 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
175 typedef int IOCanRWHandler(void *opaque);
177 int qemu_add_fd_read_handler(int fd, IOCanRWHandler *fd_can_read,
178 IOReadHandler *fd_read, void *opaque);
179 void qemu_del_fd_read_handler(int fd);
181 /* network redirectors support */
185 typedef struct NetDriverState {
186 int index; /* index number in QEMU */
189 void (*send_packet)(struct NetDriverState *nd,
190 const uint8_t *buf, int size);
191 void (*add_read_packet)(struct NetDriverState *nd,
192 IOCanRWHandler *fd_can_read,
193 IOReadHandler *fd_read, void *opaque);
194 /* tun specific data */
196 /* slirp specific data */
200 extern NetDriverState nd_table[MAX_NICS];
202 void qemu_send_packet(NetDriverState *nd, const uint8_t *buf, int size);
203 void qemu_add_read_packet(NetDriverState *nd, IOCanRWHandler *fd_can_read,
204 IOReadHandler *fd_read, void *opaque);
208 typedef struct QEMUClock QEMUClock;
209 typedef struct QEMUTimer QEMUTimer;
210 typedef void QEMUTimerCB(void *opaque);
212 /* The real time clock should be used only for stuff which does not
213 change the virtual machine state, as it is run even if the virtual
214 machine is stopped. The real time clock has a frequency of 1000
216 extern QEMUClock *rt_clock;
218 /* Rge virtual clock is only run during the emulation. It is stopped
219 when the virtual machine is stopped. Virtual timers use a high
220 precision clock, usually cpu cycles (use ticks_per_sec). */
221 extern QEMUClock *vm_clock;
223 int64_t qemu_get_clock(QEMUClock *clock);
225 QEMUTimer *qemu_new_timer(QEMUClock *clock, QEMUTimerCB *cb, void *opaque);
226 void qemu_free_timer(QEMUTimer *ts);
227 void qemu_del_timer(QEMUTimer *ts);
228 void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time);
229 int qemu_timer_pending(QEMUTimer *ts);
231 extern int64_t ticks_per_sec;
232 extern int pit_min_timer_count;
234 void cpu_enable_ticks(void);
235 void cpu_disable_ticks(void);
239 typedef FILE QEMUFile;
241 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
242 void qemu_put_byte(QEMUFile *f, int v);
243 void qemu_put_be16(QEMUFile *f, unsigned int v);
244 void qemu_put_be32(QEMUFile *f, unsigned int v);
245 void qemu_put_be64(QEMUFile *f, uint64_t v);
246 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
247 int qemu_get_byte(QEMUFile *f);
248 unsigned int qemu_get_be16(QEMUFile *f);
249 unsigned int qemu_get_be32(QEMUFile *f);
250 uint64_t qemu_get_be64(QEMUFile *f);
252 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
254 qemu_put_be64(f, *pv);
257 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
259 qemu_put_be32(f, *pv);
262 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
264 qemu_put_be16(f, *pv);
267 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
269 qemu_put_byte(f, *pv);
272 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
274 *pv = qemu_get_be64(f);
277 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
279 *pv = qemu_get_be32(f);
282 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
284 *pv = qemu_get_be16(f);
287 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
289 *pv = qemu_get_byte(f);
292 int64_t qemu_ftell(QEMUFile *f);
293 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);
295 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
296 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
298 int qemu_loadvm(const char *filename);
299 int qemu_savevm(const char *filename);
300 int register_savevm(const char *idstr,
303 SaveStateHandler *save_state,
304 LoadStateHandler *load_state,
306 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts);
307 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts);
310 typedef struct BlockDriverState BlockDriverState;
312 BlockDriverState *bdrv_new(const char *device_name);
313 void bdrv_delete(BlockDriverState *bs);
314 int bdrv_open(BlockDriverState *bs, const char *filename, int snapshot);
315 void bdrv_close(BlockDriverState *bs);
316 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
317 uint8_t *buf, int nb_sectors);
318 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
319 const uint8_t *buf, int nb_sectors);
320 void bdrv_get_geometry(BlockDriverState *bs, int64_t *nb_sectors_ptr);
321 int bdrv_commit(BlockDriverState *bs);
322 void bdrv_set_boot_sector(BlockDriverState *bs, const uint8_t *data, int size);
324 #define BDRV_TYPE_HD 0
325 #define BDRV_TYPE_CDROM 1
326 #define BDRV_TYPE_FLOPPY 2
328 void bdrv_set_geometry_hint(BlockDriverState *bs,
329 int cyls, int heads, int secs);
330 void bdrv_set_type_hint(BlockDriverState *bs, int type);
331 void bdrv_get_geometry_hint(BlockDriverState *bs,
332 int *pcyls, int *pheads, int *psecs);
333 int bdrv_get_type_hint(BlockDriverState *bs);
334 int bdrv_is_removable(BlockDriverState *bs);
335 int bdrv_is_read_only(BlockDriverState *bs);
336 int bdrv_is_inserted(BlockDriverState *bs);
337 int bdrv_is_locked(BlockDriverState *bs);
338 void bdrv_set_locked(BlockDriverState *bs, int locked);
339 void bdrv_set_change_cb(BlockDriverState *bs,
340 void (*change_cb)(void *opaque), void *opaque);
342 void bdrv_info(void);
343 BlockDriverState *bdrv_find(const char *name);
347 extern target_phys_addr_t isa_mem_base;
349 typedef void (IOPortWriteFunc)(void *opaque, uint32_t address, uint32_t data);
350 typedef uint32_t (IOPortReadFunc)(void *opaque, uint32_t address);
352 int register_ioport_read(int start, int length, int size,
353 IOPortReadFunc *func, void *opaque);
354 int register_ioport_write(int start, int length, int size,
355 IOPortWriteFunc *func, void *opaque);
356 void isa_unassign_ioport(int start, int length);
360 extern int pci_enabled;
362 extern target_phys_addr_t pci_mem_base;
364 typedef struct PCIDevice PCIDevice;
366 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
367 uint32_t address, uint32_t data, int len);
368 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
369 uint32_t address, int len);
370 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
371 uint32_t addr, uint32_t size, int type);
373 #define PCI_ADDRESS_SPACE_MEM 0x00
374 #define PCI_ADDRESS_SPACE_IO 0x01
375 #define PCI_ADDRESS_SPACE_MEM_PREFETCH 0x08
377 typedef struct PCIIORegion {
378 uint32_t addr; /* current PCI mapping address. -1 means not mapped */
381 PCIMapIORegionFunc *map_func;
385 /* PCI config space */
388 /* the following fields are read only */
392 PCIIORegion io_regions[6];
394 /* do not access the following fields */
395 PCIConfigReadFunc *config_read;
396 PCIConfigWriteFunc *config_write;
400 PCIDevice *pci_register_device(const char *name, int instance_size,
401 int bus_num, int devfn,
402 PCIConfigReadFunc *config_read,
403 PCIConfigWriteFunc *config_write);
405 void pci_register_io_region(PCIDevice *pci_dev, int region_num,
406 uint32_t size, int type,
407 PCIMapIORegionFunc *map_func);
409 void pci_set_irq(PCIDevice *pci_dev, int irq_num, int level);
411 uint32_t pci_default_read_config(PCIDevice *d,
412 uint32_t address, int len);
413 void pci_default_write_config(PCIDevice *d,
414 uint32_t address, uint32_t val, int len);
416 extern struct PIIX3State *piix3_state;
418 void i440fx_init(void);
419 void piix3_init(void);
420 void pci_bios_init(void);
425 #define VGA_RAM_SIZE (4096 * 1024)
427 typedef struct DisplayState {
431 void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
432 void (*dpy_resize)(struct DisplayState *s, int w, int h);
433 void (*dpy_refresh)(struct DisplayState *s);
436 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
438 s->dpy_update(s, x, y, w, h);
441 static inline void dpy_resize(DisplayState *s, int w, int h)
443 s->dpy_resize(s, w, h);
446 int vga_initialize(DisplayState *ds, uint8_t *vga_ram_base,
447 unsigned long vga_ram_offset, int vga_ram_size,
449 void vga_update_display(void);
450 void vga_screen_dump(const char *filename);
453 void sdl_display_init(DisplayState *ds);
458 extern BlockDriverState *bs_table[MAX_DISKS];
460 void isa_ide_init(int iobase, int iobase2, int irq,
461 BlockDriverState *hd0, BlockDriverState *hd1);
462 void pci_ide_init(BlockDriverState **hd_table);
463 void pci_piix3_ide_init(BlockDriverState **hd_table);
473 void AUD_open (int rfreq, int rnchannels, audfmt_e rfmt);
474 void AUD_reset (int rfreq, int rnchannels, audfmt_e rfmt);
475 int AUD_write (void *in_buf, int size);
477 void AUD_adjust_estimate (int _leftover);
478 int AUD_get_free (void);
479 int AUD_get_live (void);
480 int AUD_get_buffer_size (void);
481 void AUD_init (void);
484 typedef int (*DMA_transfer_handler) (void *opaque, target_ulong addr, int size);
485 int DMA_get_channel_mode (int nchan);
486 void DMA_hold_DREQ (int nchan);
487 void DMA_release_DREQ (int nchan);
488 void DMA_schedule(int nchan);
490 void DMA_init (void);
491 void DMA_register_channel (int nchan,
492 DMA_transfer_handler transfer_handler, void *opaque);
495 void SB16_run (void);
496 void SB16_init (void);
500 extern BlockDriverState *fd_table[MAX_FD];
502 typedef struct fdctrl_t fdctrl_t;
504 fdctrl_t *fdctrl_init (int irq_lvl, int dma_chann, int mem_mapped,
506 BlockDriverState **fds);
507 int fdctrl_get_drive_type(fdctrl_t *fdctrl, int drive_num);
511 void isa_ne2000_init(int base, int irq, NetDriverState *nd);
512 void pci_ne2000_init(NetDriverState *nd);
516 void kbd_put_keycode(int keycode);
518 #define MOUSE_EVENT_LBUTTON 0x01
519 #define MOUSE_EVENT_RBUTTON 0x02
520 #define MOUSE_EVENT_MBUTTON 0x04
521 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
527 typedef struct RTCState RTCState;
529 RTCState *rtc_init(int base, int irq);
530 void rtc_set_memory(RTCState *s, int addr, int val);
531 void rtc_set_date(RTCState *s, const struct tm *tm);
535 typedef struct SerialState SerialState;
537 extern SerialState *serial_console;
539 SerialState *serial_init(int base, int irq, int fd);
540 int serial_can_receive(SerialState *s);
541 void serial_receive_byte(SerialState *s, int ch);
542 void serial_receive_break(SerialState *s);
546 void pic_set_irq(int irq, int level);
548 uint32_t pic_intack_read(CPUState *env);
554 #define PIT_FREQ 1193182
556 typedef struct PITState PITState;
558 PITState *pit_init(int base, int irq);
559 void pit_set_gate(PITState *pit, int channel, int val);
560 int pit_get_gate(PITState *pit, int channel);
561 int pit_get_out(PITState *pit, int channel, int64_t current_time);
564 void pc_init(int ram_size, int vga_ram_size, int boot_device,
565 DisplayState *ds, const char **fd_filename, int snapshot,
566 const char *kernel_filename, const char *kernel_cmdline,
567 const char *initrd_filename);
570 void ppc_init (int ram_size, int vga_ram_size, int boot_device,
571 DisplayState *ds, const char **fd_filename, int snapshot,
572 const char *kernel_filename, const char *kernel_cmdline,
573 const char *initrd_filename);
576 void monitor_init(void);
577 void term_printf(const char *fmt, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
578 void term_flush(void);
579 void term_print_help(void);
583 #define DEFAULT_GDBSTUB_PORT 1234
585 int gdbserver_start(int port);