]> git.proxmox.com Git - mirror_qemu.git/blame - vl.h
update
[mirror_qemu.git] / vl.h
CommitLineData
fc01f7e7
FB
1/*
2 * QEMU System Emulator header
3 *
4 * Copyright (c) 2003 Fabrice Bellard
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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
22 * THE SOFTWARE.
23 */
24#ifndef VL_H
25#define VL_H
26
67b915a5
FB
27/* we put basic includes here to avoid repeating them in device drivers */
28#include <stdlib.h>
29#include <stdio.h>
30#include <stdarg.h>
31#include <string.h>
32#include <inttypes.h>
8a7ddc38 33#include <time.h>
67b915a5
FB
34#include <ctype.h>
35#include <errno.h>
36#include <unistd.h>
37#include <fcntl.h>
38
39#ifndef O_LARGEFILE
40#define O_LARGEFILE 0
41#endif
40c3bac3
FB
42#ifndef O_BINARY
43#define O_BINARY 0
44#endif
67b915a5
FB
45
46#ifdef _WIN32
bfbc9133 47#define lseek64 _lseeki64
67b915a5 48#endif
8a7ddc38 49
16f62432
FB
50#include "cpu.h"
51
67b915a5
FB
52#ifndef glue
53#define xglue(x, y) x ## y
54#define glue(x, y) xglue(x, y)
55#define stringify(s) tostring(s)
56#define tostring(s) #s
57#endif
58
59#if defined(WORDS_BIGENDIAN)
60static inline uint32_t be32_to_cpu(uint32_t v)
61{
62 return v;
63}
64
65static inline uint16_t be16_to_cpu(uint16_t v)
66{
67 return v;
68}
69
70static inline uint32_t le32_to_cpu(uint32_t v)
71{
72 return bswap32(v);
73}
74
75static inline uint16_t le16_to_cpu(uint16_t v)
76{
77 return bswap16(v);
78}
79
80#else
81static inline uint32_t be32_to_cpu(uint32_t v)
82{
83 return bswap32(v);
84}
85
86static inline uint16_t be16_to_cpu(uint16_t v)
87{
88 return bswap16(v);
89}
90
91static inline uint32_t le32_to_cpu(uint32_t v)
92{
93 return v;
94}
95
96static inline uint16_t le16_to_cpu(uint16_t v)
97{
98 return v;
99}
100#endif
101
102
33e3963e 103/* vl.c */
313aa567
FB
104extern int reset_requested;
105
c4b1fcc0
FB
106typedef void (IOPortWriteFunc)(void *opaque, uint32_t address, uint32_t data);
107typedef uint32_t (IOPortReadFunc)(void *opaque, uint32_t address);
313aa567 108
c4b1fcc0
FB
109int register_ioport_read(int start, int length, int size,
110 IOPortReadFunc *func, void *opaque);
111int register_ioport_write(int start, int length, int size,
112 IOPortWriteFunc *func, void *opaque);
80cabfad 113uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c);
313aa567 114
80cabfad
FB
115void hw_error(const char *fmt, ...);
116
117int load_image(const char *filename, uint8_t *addr);
118extern const char *bios_dir;
119
120void pstrcpy(char *buf, int buf_size, const char *str);
121char *pstrcat(char *buf, int buf_size, const char *s);
33e3963e 122
c4b1fcc0
FB
123int serial_open_device(void);
124
8a7ddc38
FB
125extern int vm_running;
126
127typedef void VMStopHandler(void *opaque, int reason);
128
129int qemu_add_vm_stop_handler(VMStopHandler *cb, void *opaque);
130void qemu_del_vm_stop_handler(VMStopHandler *cb, void *opaque);
131
132void vm_start(void);
133void vm_stop(int reason);
134
c20709aa
FB
135/* async I/O support */
136
137typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
138typedef int IOCanRWHandler(void *opaque);
139
140int qemu_add_fd_read_handler(int fd, IOCanRWHandler *fd_can_read,
141 IOReadHandler *fd_read, void *opaque);
142void qemu_del_fd_read_handler(int fd);
143
c4b1fcc0
FB
144/* network redirectors support */
145
146#define MAX_NICS 8
147
148typedef struct NetDriverState {
c20709aa 149 int index; /* index number in QEMU */
c4b1fcc0
FB
150 uint8_t macaddr[6];
151 char ifname[16];
c20709aa
FB
152 void (*send_packet)(struct NetDriverState *nd,
153 const uint8_t *buf, int size);
154 void (*add_read_packet)(struct NetDriverState *nd,
155 IOCanRWHandler *fd_can_read,
156 IOReadHandler *fd_read, void *opaque);
157 /* tun specific data */
158 int fd;
159 /* slirp specific data */
c4b1fcc0
FB
160} NetDriverState;
161
162extern int nb_nics;
163extern NetDriverState nd_table[MAX_NICS];
164
c20709aa
FB
165void qemu_send_packet(NetDriverState *nd, const uint8_t *buf, int size);
166void qemu_add_read_packet(NetDriverState *nd, IOCanRWHandler *fd_can_read,
167 IOReadHandler *fd_read, void *opaque);
8a7ddc38
FB
168
169/* timers */
170
171typedef struct QEMUClock QEMUClock;
172typedef struct QEMUTimer QEMUTimer;
173typedef void QEMUTimerCB(void *opaque);
174
175/* The real time clock should be used only for stuff which does not
176 change the virtual machine state, as it is run even if the virtual
177 machine is stopped. The real time clock has a frequency or 1000
178 Hz. */
179extern QEMUClock *rt_clock;
180
181/* Rge virtual clock is only run during the emulation. It is stopped
182 when the virtual machine is stopped. Virtual timers use a high
183 precision clock, usually cpu cycles (use ticks_per_sec). */
184extern QEMUClock *vm_clock;
185
186int64_t qemu_get_clock(QEMUClock *clock);
187
188QEMUTimer *qemu_new_timer(QEMUClock *clock, QEMUTimerCB *cb, void *opaque);
189void qemu_free_timer(QEMUTimer *ts);
190void qemu_del_timer(QEMUTimer *ts);
191void qemu_mod_timer(QEMUTimer *ts, int64_t expire_time);
192int qemu_timer_pending(QEMUTimer *ts);
193
194extern int64_t ticks_per_sec;
195extern int pit_min_timer_count;
196
197void cpu_enable_ticks(void);
198void cpu_disable_ticks(void);
199
200/* VM Load/Save */
201
202typedef FILE QEMUFile;
203
204void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, int size);
205void qemu_put_byte(QEMUFile *f, int v);
206void qemu_put_be16(QEMUFile *f, unsigned int v);
207void qemu_put_be32(QEMUFile *f, unsigned int v);
208void qemu_put_be64(QEMUFile *f, uint64_t v);
209int qemu_get_buffer(QEMUFile *f, uint8_t *buf, int size);
210int qemu_get_byte(QEMUFile *f);
211unsigned int qemu_get_be16(QEMUFile *f);
212unsigned int qemu_get_be32(QEMUFile *f);
213uint64_t qemu_get_be64(QEMUFile *f);
214
215static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv)
216{
217 qemu_put_be64(f, *pv);
218}
219
220static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv)
221{
222 qemu_put_be32(f, *pv);
223}
224
225static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv)
226{
227 qemu_put_be16(f, *pv);
228}
229
230static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv)
231{
232 qemu_put_byte(f, *pv);
233}
234
235static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv)
236{
237 *pv = qemu_get_be64(f);
238}
239
240static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv)
241{
242 *pv = qemu_get_be32(f);
243}
244
245static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv)
246{
247 *pv = qemu_get_be16(f);
248}
249
250static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv)
251{
252 *pv = qemu_get_byte(f);
253}
254
255int64_t qemu_ftell(QEMUFile *f);
256int64_t qemu_fseek(QEMUFile *f, int64_t pos, int whence);
257
258typedef void SaveStateHandler(QEMUFile *f, void *opaque);
259typedef int LoadStateHandler(QEMUFile *f, void *opaque, int version_id);
260
261int qemu_loadvm(const char *filename);
262int qemu_savevm(const char *filename);
263int register_savevm(const char *idstr,
264 int instance_id,
265 int version_id,
266 SaveStateHandler *save_state,
267 LoadStateHandler *load_state,
268 void *opaque);
269void qemu_get_timer(QEMUFile *f, QEMUTimer *ts);
270void qemu_put_timer(QEMUFile *f, QEMUTimer *ts);
c4b1fcc0 271
fc01f7e7
FB
272/* block.c */
273typedef struct BlockDriverState BlockDriverState;
274
c4b1fcc0
FB
275BlockDriverState *bdrv_new(const char *device_name);
276void bdrv_delete(BlockDriverState *bs);
277int bdrv_open(BlockDriverState *bs, const char *filename, int snapshot);
fc01f7e7
FB
278void bdrv_close(BlockDriverState *bs);
279int bdrv_read(BlockDriverState *bs, int64_t sector_num,
280 uint8_t *buf, int nb_sectors);
281int bdrv_write(BlockDriverState *bs, int64_t sector_num,
282 const uint8_t *buf, int nb_sectors);
283void bdrv_get_geometry(BlockDriverState *bs, int64_t *nb_sectors_ptr);
33e3963e 284int bdrv_commit(BlockDriverState *bs);
77fef8c1 285void bdrv_set_boot_sector(BlockDriverState *bs, const uint8_t *data, int size);
33e3963e 286
c4b1fcc0
FB
287#define BDRV_TYPE_HD 0
288#define BDRV_TYPE_CDROM 1
289#define BDRV_TYPE_FLOPPY 2
290
291void bdrv_set_geometry_hint(BlockDriverState *bs,
292 int cyls, int heads, int secs);
293void bdrv_set_type_hint(BlockDriverState *bs, int type);
294void bdrv_get_geometry_hint(BlockDriverState *bs,
295 int *pcyls, int *pheads, int *psecs);
296int bdrv_get_type_hint(BlockDriverState *bs);
297int bdrv_is_removable(BlockDriverState *bs);
298int bdrv_is_read_only(BlockDriverState *bs);
299int bdrv_is_inserted(BlockDriverState *bs);
300int bdrv_is_locked(BlockDriverState *bs);
301void bdrv_set_locked(BlockDriverState *bs, int locked);
302void bdrv_set_change_cb(BlockDriverState *bs,
303 void (*change_cb)(void *opaque), void *opaque);
304
305void bdrv_info(void);
306BlockDriverState *bdrv_find(const char *name);
307
313aa567
FB
308/* vga.c */
309
4fa0f5d2 310#define VGA_RAM_SIZE (4096 * 1024)
313aa567
FB
311
312typedef struct DisplayState {
313 uint8_t *data;
314 int linesize;
315 int depth;
316 void (*dpy_update)(struct DisplayState *s, int x, int y, int w, int h);
317 void (*dpy_resize)(struct DisplayState *s, int w, int h);
318 void (*dpy_refresh)(struct DisplayState *s);
319} DisplayState;
320
321static inline void dpy_update(DisplayState *s, int x, int y, int w, int h)
322{
323 s->dpy_update(s, x, y, w, h);
324}
325
326static inline void dpy_resize(DisplayState *s, int w, int h)
327{
328 s->dpy_resize(s, w, h);
329}
330
7138fcfb
FB
331int vga_initialize(DisplayState *ds, uint8_t *vga_ram_base,
332 unsigned long vga_ram_offset, int vga_ram_size);
313aa567 333void vga_update_display(void);
59a983b9 334void vga_screen_dump(const char *filename);
313aa567
FB
335
336/* sdl.c */
337void sdl_display_init(DisplayState *ds);
338
5391d806
FB
339/* ide.c */
340#define MAX_DISKS 4
341
342extern BlockDriverState *bs_table[MAX_DISKS];
343
c4b1fcc0
FB
344void ide_init(int iobase, int iobase2, int irq,
345 BlockDriverState *hd0, BlockDriverState *hd1);
5391d806 346
27503323
FB
347/* oss.c */
348typedef enum {
349 AUD_FMT_U8,
350 AUD_FMT_S8,
351 AUD_FMT_U16,
352 AUD_FMT_S16
353} audfmt_e;
354
355void AUD_open (int rfreq, int rnchannels, audfmt_e rfmt);
356void AUD_reset (int rfreq, int rnchannels, audfmt_e rfmt);
357int AUD_write (void *in_buf, int size);
358void AUD_run (void);
359void AUD_adjust_estimate (int _leftover);
360int AUD_get_free (void);
361int AUD_get_live (void);
362int AUD_get_buffer_size (void);
363void AUD_init (void);
364
365/* dma.c */
16f62432 366typedef int (*DMA_transfer_handler) (void *opaque, target_ulong addr, int size);
27503323
FB
367int DMA_get_channel_mode (int nchan);
368void DMA_hold_DREQ (int nchan);
369void DMA_release_DREQ (int nchan);
16f62432 370void DMA_schedule(int nchan);
27503323
FB
371void DMA_run (void);
372void DMA_init (void);
373void DMA_register_channel (int nchan,
16f62432 374 DMA_transfer_handler transfer_handler, void *opaque);
27503323
FB
375
376/* sb16.c */
377void SB16_run (void);
378void SB16_init (void);
379
7138fcfb
FB
380/* fdc.c */
381#define MAX_FD 2
382extern BlockDriverState *fd_table[MAX_FD];
383
baca51fa
FB
384typedef struct fdctrl_t fdctrl_t;
385
386fdctrl_t *fdctrl_init (int irq_lvl, int dma_chann, int mem_mapped,
387 uint32_t io_base,
388 BlockDriverState **fds);
389int fdctrl_get_drive_type(fdctrl_t *fdctrl, int drive_num);
7138fcfb 390
80cabfad
FB
391/* ne2000.c */
392
c4b1fcc0 393void ne2000_init(int base, int irq, NetDriverState *nd);
80cabfad
FB
394
395/* pckbd.c */
396
397void kbd_put_keycode(int keycode);
398
399#define MOUSE_EVENT_LBUTTON 0x01
400#define MOUSE_EVENT_RBUTTON 0x02
401#define MOUSE_EVENT_MBUTTON 0x04
402void kbd_mouse_event(int dx, int dy, int dz, int buttons_state);
403
404void kbd_init(void);
405
406/* mc146818rtc.c */
407
8a7ddc38 408typedef struct RTCState RTCState;
80cabfad 409
8a7ddc38
FB
410RTCState *rtc_init(int base, int irq);
411void rtc_set_memory(RTCState *s, int addr, int val);
412void rtc_set_date(RTCState *s, const struct tm *tm);
80cabfad
FB
413
414/* serial.c */
415
c4b1fcc0
FB
416typedef struct SerialState SerialState;
417
418extern SerialState *serial_console;
419
420SerialState *serial_init(int base, int irq, int fd);
421int serial_can_receive(SerialState *s);
422void serial_receive_byte(SerialState *s, int ch);
423void serial_receive_break(SerialState *s);
80cabfad
FB
424
425/* i8259.c */
426
427void pic_set_irq(int irq, int level);
428void pic_init(void);
c5df018e 429uint32_t pic_intack_read(CPUState *env);
c20709aa 430void pic_info(void);
80cabfad
FB
431
432/* i8254.c */
433
434#define PIT_FREQ 1193182
435
436typedef struct PITChannelState {
437 int count; /* can be 65536 */
438 uint16_t latched_count;
439 uint8_t rw_state;
440 uint8_t mode;
441 uint8_t bcd; /* not supported */
442 uint8_t gate; /* timer start */
443 int64_t count_load_time;
8a7ddc38
FB
444 /* irq handling */
445 int64_t next_transition_time;
446 QEMUTimer *irq_timer;
447 int irq;
80cabfad
FB
448} PITChannelState;
449
450extern PITChannelState pit_channels[3];
451
8a7ddc38 452void pit_init(int base, int irq);
80cabfad 453void pit_set_gate(PITChannelState *s, int val);
8a7ddc38 454int pit_get_out(PITChannelState *s, int64_t current_time);
80cabfad
FB
455int pit_get_out_edges(PITChannelState *s);
456
457/* pc.c */
458void pc_init(int ram_size, int vga_ram_size, int boot_device,
459 DisplayState *ds, const char **fd_filename, int snapshot,
460 const char *kernel_filename, const char *kernel_cmdline,
461 const char *initrd_filename);
462
c4b1fcc0
FB
463/* monitor.c */
464void monitor_init(void);
40c3bac3 465void term_printf(const char *fmt, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
c4b1fcc0
FB
466void term_flush(void);
467void term_print_help(void);
468
8a7ddc38
FB
469/* gdbstub.c */
470
471#define DEFAULT_GDBSTUB_PORT 1234
472
473int gdbserver_start(int port);
474
fc01f7e7 475#endif /* VL_H */