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)
144 static inline void cpu_to_le16w(uint16_t *p, uint16_t v)
149 static inline void cpu_to_le32w(uint32_t *p, uint32_t v)
154 static inline uint16_t le16_to_cpup(const uint16_t *p)
156 return le16_to_cpu(*p);
159 static inline uint32_t le32_to_cpup(const uint32_t *p)
161 return le32_to_cpu(*p);
164 /* unaligned versions (optimized for frequent unaligned accesses)*/
166 #if defined(__i386__) || defined(__powerpc__)
168 #define cpu_to_le16wu(p, v) cpu_to_le16w(p, v)
169 #define cpu_to_le32wu(p, v) cpu_to_le32w(p, v)
170 #define le16_to_cpupu(p) le16_to_cpup(p)
171 #define le32_to_cpupu(p) le32_to_cpup(p)
175 static inline void cpu_to_le16wu(uint16_t *p, uint16_t v)
177 uint8_t *p1 = (uint8_t *)p;
183 static inline void cpu_to_le32wu(uint32_t *p, uint32_t v)
185 uint8_t *p1 = (uint8_t *)p;
193 static inline uint16_t le16_to_cpupu(const uint16_t *p)
195 const uint8_t *p1 = (const uint8_t *)p;
196 return p1[0] | (p1[1] << 8);
199 static inline uint32_t le32_to_cpupu(const uint32_t *p)
201 const uint8_t *p1 = (const uint8_t *)p;
202 return p1[0] | (p1[1] << 8) | (p1[2] << 16) | (p1[3] << 24);
208 uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
210 void hw_error(const char *fmt, ...);
212 int get_image_size(const char *filename);
213 int load_image(const char *filename, uint8_t *addr);
214 extern const char *bios_dir;
216 void pstrcpy(char *buf, int buf_size, const char *str);
217 char *pstrcat(char *buf, int buf_size, const char *s);
219 int serial_open_device(void);
221 extern int vm_running;
223 typedef void VMStopHandler(void *opaque, int reason);
225 int qemu_add_vm_stop_handler(VMStopHandler *cb, void *opaque);
226 void qemu_del_vm_stop_handler(VMStopHandler *cb, void *opaque);
229 void vm_stop(int reason);
231 typedef void QEMUResetHandler(void *opaque);
233 void qemu_register_reset(QEMUResetHandler *func, void *opaque);
234 void qemu_system_reset_request(void);
235 void qemu_system_shutdown_request(void);
237 extern int audio_enabled;
239 extern int bios_size;
241 extern int cirrus_vga_enabled;
242 extern int graphic_width;
243 extern int graphic_height;
244 extern int graphic_depth;
246 /* XXX: make it dynamic */
247 #if defined (TARGET_PPC)
248 #define BIOS_SIZE (512 * 1024)
250 #define BIOS_SIZE ((256 + 64) * 1024)
253 /* keyboard/mouse support */
255 #define MOUSE_EVENT_LBUTTON 0x01
256 #define MOUSE_EVENT_RBUTTON 0x02
257 #define MOUSE_EVENT_MBUTTON 0x04
259 typedef void QEMUPutKBDEvent(void *opaque, int keycode);
260 typedef void QEMUPutMouseEvent(void *opaque, int dx, int dy, int dz, int buttons_state);
262 void qemu_add_kbd_event_handler(QEMUPutKBDEvent *func, void *opaque);
263 void qemu_add_mouse_event_handler(QEMUPutMouseEvent *func, void *opaque);
265 void kbd_put_keycode(int keycode);
266 void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
268 /* async I/O support */
270 typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
271 typedef int IOCanRWHandler(void *opaque);
273 int qemu_add_fd_read_handler(int fd, IOCanRWHandler *fd_can_read,
274 IOReadHandler *fd_read, void *opaque);
275 void qemu_del_fd_read_handler(int fd);
277 /* network redirectors support */
281 typedef struct NetDriverState {
282 int index; /* index number in QEMU */
285 void (*send_packet)(struct NetDriverState *nd,
286 const uint8_t *buf, int size);
287 void (*add_read_packet)(struct NetDriverState *nd,
288 IOCanRWHandler *fd_can_read,
289 IOReadHandler *fd_read, void *opaque);
290 /* tun specific data */
292 /* slirp specific data */
296 extern NetDriverState nd_table[MAX_NICS];
298 void qemu_send_packet(NetDriverState *nd, const uint8_t *buf, int size);
299 void qemu_add_read_packet(NetDriverState *nd, IOCanRWHandler *fd_can_read,
300 IOReadHandler *fd_read, void *opaque);
304 typedef struct QEMUClock QEMUClock;
305 typedef struct QEMUTimer QEMUTimer;
306 typedef void QEMUTimerCB(void *opaque);
308 /* The real time clock should be used only for stuff which does not
309 change the virtual machine state, as it is run even if the virtual
310 machine is stopped. The real time clock has a frequency of 1000
312 extern QEMUClock *rt_clock;
314 /* Rge virtual clock is only run during the emulation. It is stopped
315 when the virtual machine is stopped. Virtual timers use a high
316 precision clock, usually cpu cycles (use ticks_per_sec). */
317 extern QEMUClock *vm_clock;
319 int64_t qemu_get_clock(QEMUClock *clock);
321 QEMUTimer *qemu_new_timer(QEMUClock *clock, QEMUTimerCB *cb, void *opaque);
322 void qemu_free_timer(QEMUTimer *ts);
323 void qemu_del_timer(QEMUTimer *ts);
324 void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time);
325 int qemu_timer_pending(QEMUTimer *ts);
327 extern int64_t ticks_per_sec;
328 extern int pit_min_timer_count;
330 void cpu_enable_ticks(void);
331 void cpu_disable_ticks(void);
335 typedef FILE QEMUFile;
337 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
338 void qemu_put_byte(QEMUFile *f, int v);
339 void qemu_put_be16(QEMUFile *f, unsigned int v);
340 void qemu_put_be32(QEMUFile *f, unsigned int v);
341 void qemu_put_be64(QEMUFile *f, uint64_t v);
342 int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
343 int qemu_get_byte(QEMUFile *f);
344 unsigned int qemu_get_be16(QEMUFile *f);
345 unsigned int qemu_get_be32(QEMUFile *f);
346 uint64_t qemu_get_be64(QEMUFile *f);
348 static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
350 qemu_put_be64(f, *pv);
353 static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
355 qemu_put_be32(f, *pv);
358 static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
360 qemu_put_be16(f, *pv);
363 static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
365 qemu_put_byte(f, *pv);
368 static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
370 *pv = qemu_get_be64(f);
373 static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
375 *pv = qemu_get_be32(f);
378 static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
380 *pv = qemu_get_be16(f);
383 static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
385 *pv = qemu_get_byte(f);
388 int64_t qemu_ftell(QEMUFile *f);
389 int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);
391 typedef void SaveStateHandler(QEMUFile *f, void *opaque);
392 typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
394 int qemu_loadvm(const char *filename);
395 int qemu_savevm(const char *filename);
396 int register_savevm(const char *idstr,
399 SaveStateHandler *save_state,
400 LoadStateHandler *load_state,
402 void qemu_get_timer(QEMUFile *f, QEMUTimer *ts);
403 void qemu_put_timer(QEMUFile *f, QEMUTimer *ts);
406 typedef struct BlockDriverState BlockDriverState;
408 BlockDriverState *bdrv_new(const char *device_name);
409 void bdrv_delete(BlockDriverState *bs);
410 int bdrv_open(BlockDriverState *bs, const char *filename, int snapshot);
411 void bdrv_close(BlockDriverState *bs);
412 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
413 uint8_t *buf, int nb_sectors);
414 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
415 const uint8_t *buf, int nb_sectors);
416 void bdrv_get_geometry(BlockDriverState *bs, int64_t *nb_sectors_ptr);
417 int bdrv_commit(BlockDriverState *bs);
418 void bdrv_set_boot_sector(BlockDriverState *bs, const uint8_t *data, int size);
420 #define BDRV_TYPE_HD 0
421 #define BDRV_TYPE_CDROM 1
422 #define BDRV_TYPE_FLOPPY 2
424 void bdrv_set_geometry_hint(BlockDriverState *bs,
425 int cyls, int heads, int secs);
426 void bdrv_set_type_hint(BlockDriverState *bs, int type);
427 void bdrv_get_geometry_hint(BlockDriverState *bs,
428 int *pcyls, int *pheads, int *psecs);
429 int bdrv_get_type_hint(BlockDriverState *bs);
430 int bdrv_is_removable(BlockDriverState *bs);
431 int bdrv_is_read_only(BlockDriverState *bs);
432 int bdrv_is_inserted(BlockDriverState *bs);
433 int bdrv_is_locked(BlockDriverState *bs);
434 void bdrv_set_locked(BlockDriverState *bs, int locked);
435 void bdrv_set_change_cb(BlockDriverState *bs,
436 void (*change_cb)(void *opaque), void *opaque);
438 void bdrv_info(void);
439 BlockDriverState *bdrv_find(const char *name);
443 extern target_phys_addr_t isa_mem_base;
445 typedef void (IOPortWriteFunc)(void *opaque, uint32_t address, uint32_t data);
446 typedef uint32_t (IOPortReadFunc)(void *opaque, uint32_t address);
448 int register_ioport_read(int start, int length, int size,
449 IOPortReadFunc *func, void *opaque);
450 int register_ioport_write(int start, int length, int size,
451 IOPortWriteFunc *func, void *opaque);
452 void isa_unassign_ioport(int start, int length);
456 extern int pci_enabled;
458 extern target_phys_addr_t pci_mem_base;
460 typedef struct PCIBus PCIBus;
461 typedef struct PCIDevice PCIDevice;
463 typedef void PCIConfigWriteFunc(PCIDevice *pci_dev,
464 uint32_t address, uint32_t data, int len);
465 typedef uint32_t PCIConfigReadFunc(PCIDevice *pci_dev,
466 uint32_t address, int len);
467 typedef void PCIMapIORegionFunc(PCIDevice *pci_dev, int region_num,
468 uint32_t addr, uint32_t size, int type);
470 #define PCI_ADDRESS_SPACE_MEM 0x00
471 #define PCI_ADDRESS_SPACE_IO 0x01
472 #define PCI_ADDRESS_SPACE_MEM_PREFETCH 0x08
474 typedef struct PCIIORegion {
475 uint32_t addr; /* current PCI mapping address. -1 means not mapped */
478 PCIMapIORegionFunc *map_func;
481 #define PCI_ROM_SLOT 6
482 #define PCI_NUM_REGIONS 7
484 /* PCI config space */
487 /* the following fields are read only */
491 PCIIORegion io_regions[PCI_NUM_REGIONS];
493 /* do not access the following fields */
494 PCIConfigReadFunc *config_read;
495 PCIConfigWriteFunc *config_write;
499 PCIDevice *pci_register_device(PCIBus *bus, const char *name,
500 int instance_size, int devfn,
501 PCIConfigReadFunc *config_read,
502 PCIConfigWriteFunc *config_write);
504 void pci_register_io_region(PCIDevice *pci_dev, int region_num,
505 uint32_t size, int type,
506 PCIMapIORegionFunc *map_func);
508 void pci_set_irq(PCIDevice *pci_dev, int irq_num, int level);
510 uint32_t pci_default_read_config(PCIDevice *d,
511 uint32_t address, int len);
512 void pci_default_write_config(PCIDevice *d,
513 uint32_t address, uint32_t val, int len);
515 extern struct PIIX3State *piix3_state;
517 PCIBus *i440fx_init(void);
518 void piix3_init(PCIBus *bus);
519 void pci_bios_init(void);
522 /* temporary: will be moved in platform specific file */
523 PCIBus *pci_prep_init(void);
525 void pci_pmac_set_openpic(PCIBus *bus, struct openpic_t *openpic);
526 PCIBus *pci_pmac_init(void);
529 typedef struct openpic_t openpic_t;
530 void openpic_set_irq (openpic_t *opp, int n_IRQ, int level);
531 openpic_t *openpic_init (PCIBus *bus, int *pmem_index, int nb_cpus);
535 #define VGA_RAM_SIZE (4096 * 1024)
537 typedef struct DisplayState {
541 void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
542 void (*dpy_resize)(struct DisplayState *s, int w, int h);
543 void (*dpy_refresh)(struct DisplayState *s);
546 static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
548 s->dpy_update(s, x, y, w, h);
551 static inline void dpy_resize(DisplayState *s, int w, int h)
553 s->dpy_resize(s, w, h);
556 int vga_initialize(PCIBus *bus, DisplayState *ds, uint8_t *vga_ram_base,
557 unsigned long vga_ram_offset, int vga_ram_size);
558 void vga_update_display(void);
559 void vga_invalidate_display(void);
560 void vga_screen_dump(const char *filename);
563 void pci_cirrus_vga_init(PCIBus *bus, DisplayState *ds, uint8_t *vga_ram_base,
564 unsigned long vga_ram_offset, int vga_ram_size);
565 void isa_cirrus_vga_init(DisplayState *ds, uint8_t *vga_ram_base,
566 unsigned long vga_ram_offset, int vga_ram_size);
569 void sdl_display_init(DisplayState *ds);
574 extern BlockDriverState *bs_table[MAX_DISKS];
576 void isa_ide_init(int iobase, int iobase2, int irq,
577 BlockDriverState *hd0, BlockDriverState *hd1);
578 void pci_ide_init(PCIBus *bus, BlockDriverState **hd_table);
579 void pci_piix3_ide_init(PCIBus *bus, BlockDriverState **hd_table);
580 int pmac_ide_init (BlockDriverState **hd_table,
581 openpic_t *openpic, int irq);
591 void AUD_open (int rfreq, int rnchannels, audfmt_e rfmt);
592 void AUD_reset (int rfreq, int rnchannels, audfmt_e rfmt);
593 int AUD_write (void *in_buf, int size);
595 void AUD_adjust_estimate (int _leftover);
596 int AUD_get_free (void);
597 int AUD_get_live (void);
598 int AUD_get_buffer_size (void);
599 void AUD_init (void);
602 typedef int (*DMA_transfer_handler) (void *opaque, target_ulong addr, int size);
603 int DMA_get_channel_mode (int nchan);
604 void DMA_hold_DREQ (int nchan);
605 void DMA_release_DREQ (int nchan);
606 void DMA_schedule(int nchan);
608 void DMA_init (int high_page_enable);
609 void DMA_register_channel (int nchan,
610 DMA_transfer_handler transfer_handler, void *opaque);
613 void SB16_run (void);
614 void SB16_init (void);
618 extern BlockDriverState *fd_table[MAX_FD];
620 typedef struct fdctrl_t fdctrl_t;
622 fdctrl_t *fdctrl_init (int irq_lvl, int dma_chann, int mem_mapped,
624 BlockDriverState **fds);
625 int fdctrl_get_drive_type(fdctrl_t *fdctrl, int drive_num);
629 void isa_ne2000_init(int base, int irq, NetDriverState *nd);
630 void pci_ne2000_init(PCIBus *bus, NetDriverState *nd);
638 typedef struct RTCState RTCState;
640 RTCState *rtc_init(int base, int irq);
641 void rtc_set_memory(RTCState *s, int addr, int val);
642 void rtc_set_date(RTCState *s, const struct tm *tm);
646 typedef struct SerialState SerialState;
648 extern SerialState *serial_console;
650 SerialState *serial_init(int base, int irq, int fd);
651 int serial_can_receive(SerialState *s);
652 void serial_receive_byte(SerialState *s, int ch);
653 void serial_receive_break(SerialState *s);
657 void pic_set_irq(int irq, int level);
659 uint32_t pic_intack_read(CPUState *env);
665 #define PIT_FREQ 1193182
667 typedef struct PITState PITState;
669 PITState *pit_init(int base, int irq);
670 void pit_set_gate(PITState *pit, int channel, int val);
671 int pit_get_gate(PITState *pit, int channel);
672 int pit_get_out(PITState *pit, int channel, int64_t current_time);
675 void pc_init(int ram_size, int vga_ram_size, int boot_device,
676 DisplayState *ds, const char **fd_filename, int snapshot,
677 const char *kernel_filename, const char *kernel_cmdline,
678 const char *initrd_filename);
681 void ppc_init (int ram_size, int vga_ram_size, int boot_device,
682 DisplayState *ds, const char **fd_filename, int snapshot,
683 const char *kernel_filename, const char *kernel_cmdline,
684 const char *initrd_filename);
685 void ppc_prep_init (int ram_size, int vga_ram_size, int boot_device,
686 DisplayState *ds, const char **fd_filename, int snapshot,
687 const char *kernel_filename, const char *kernel_cmdline,
688 const char *initrd_filename);
689 void ppc_chrp_init(int ram_size, int vga_ram_size, int boot_device,
690 DisplayState *ds, const char **fd_filename, int snapshot,
691 const char *kernel_filename, const char *kernel_cmdline,
692 const char *initrd_filename);
694 ppc_tb_t *cpu_ppc_tb_init (CPUState *env, uint32_t freq);
696 void PREP_debug_write (void *opaque, uint32_t addr, uint32_t val);
698 extern CPUWriteMemoryFunc *PPC_io_write[];
699 extern CPUReadMemoryFunc *PPC_io_read[];
700 extern int prep_enabled;
703 #include "hw/m48t59.h"
705 void NVRAM_set_byte (m48t59_t *nvram, uint32_t addr, uint8_t value);
706 uint8_t NVRAM_get_byte (m48t59_t *nvram, uint32_t addr);
707 void NVRAM_set_word (m48t59_t *nvram, uint32_t addr, uint16_t value);
708 uint16_t NVRAM_get_word (m48t59_t *nvram, uint32_t addr);
709 void NVRAM_set_lword (m48t59_t *nvram, uint32_t addr, uint32_t value);
710 uint32_t NVRAM_get_lword (m48t59_t *nvram, uint32_t addr);
711 void NVRAM_set_string (m48t59_t *nvram, uint32_t addr,
712 const unsigned char *str, uint32_t max);
713 int NVRAM_get_string (m48t59_t *nvram, uint8_t *dst, uint16_t addr, int max);
714 void NVRAM_set_crc (m48t59_t *nvram, uint32_t addr,
715 uint32_t start, uint32_t count);
716 int PPC_NVRAM_set_params (m48t59_t *nvram, uint16_t NVRAM_size,
717 const unsigned char *arch,
718 uint32_t RAM_size, int boot_device,
719 uint32_t kernel_image, uint32_t kernel_size,
721 uint32_t initrd_image, uint32_t initrd_size,
722 uint32_t NVRAM_image,
723 int width, int height, int depth);
727 #define MAX_ADB_DEVICES 16
729 #define ADB_MAX_OUT_LEN 16
731 typedef struct ADBDevice ADBDevice;
733 /* buf = NULL means polling */
734 typedef int ADBDeviceRequest(ADBDevice *d, uint8_t *buf_out,
735 const uint8_t *buf, int len);
736 typedef int ADBDeviceReset(ADBDevice *d);
739 struct ADBBusState *bus;
742 ADBDeviceRequest *devreq;
743 ADBDeviceReset *devreset;
747 typedef struct ADBBusState {
748 ADBDevice devices[MAX_ADB_DEVICES];
753 int adb_request(ADBBusState *s, uint8_t *buf_out,
754 const uint8_t *buf, int len);
755 int adb_poll(ADBBusState *s, uint8_t *buf_out);
757 ADBDevice *adb_register_device(ADBBusState *s, int devaddr,
758 ADBDeviceRequest *devreq,
759 ADBDeviceReset *devreset,
761 void adb_kbd_init(ADBBusState *bus);
762 void adb_mouse_init(ADBBusState *bus);
766 extern ADBBusState adb_bus;
767 int cuda_init(openpic_t *openpic, int irq);
770 void monitor_init(void);
771 void term_printf(const char *fmt, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
772 void term_flush(void);
773 void term_print_help(void);
777 #define DEFAULT_GDBSTUB_PORT 1234
779 int gdbserver_start(int port);