error: Fix examples in error.h's big comment
[qemu/ar7.git] / include / sysemu / accel.h
blobe08b8ab8fa32aeaa85d7197c340ce3eeaec45a93
1 /* QEMU accelerator interfaces
3 * Copyright (c) 2014 Red Hat Inc
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 * THE SOFTWARE.
23 #ifndef HW_ACCEL_H
24 #define HW_ACCEL_H
26 #include "qom/object.h"
27 #include "exec/hwaddr.h"
29 typedef struct AccelState {
30 /*< private >*/
31 Object parent_obj;
32 } AccelState;
34 typedef struct AccelClass {
35 /*< private >*/
36 ObjectClass parent_class;
37 /*< public >*/
39 const char *name;
40 #ifndef CONFIG_USER_ONLY
41 int (*init_machine)(MachineState *ms);
42 void (*setup_post)(MachineState *ms, AccelState *accel);
43 bool (*has_memory)(MachineState *ms, AddressSpace *as,
44 hwaddr start_addr, hwaddr size);
45 #endif
46 bool *allowed;
48 * Array of global properties that would be applied when specific
49 * accelerator is chosen. It works like MachineClass.compat_props
50 * but it's for accelerators not machines. Accelerator-provided
51 * global properties may be overridden by machine-type
52 * compat_props or user-provided global properties.
54 GPtrArray *compat_props;
55 } AccelClass;
57 #define TYPE_ACCEL "accel"
59 #define ACCEL_CLASS_SUFFIX "-" TYPE_ACCEL
60 #define ACCEL_CLASS_NAME(a) (a ACCEL_CLASS_SUFFIX)
62 #define ACCEL_CLASS(klass) \
63 OBJECT_CLASS_CHECK(AccelClass, (klass), TYPE_ACCEL)
64 #define ACCEL(obj) \
65 OBJECT_CHECK(AccelState, (obj), TYPE_ACCEL)
66 #define ACCEL_GET_CLASS(obj) \
67 OBJECT_GET_CLASS(AccelClass, (obj), TYPE_ACCEL)
69 AccelClass *accel_find(const char *opt_name);
70 int accel_init_machine(AccelState *accel, MachineState *ms);
72 /* Called just before os_setup_post (ie just before drop OS privs) */
73 void accel_setup_post(MachineState *ms);
75 AccelState *current_accel(void);
77 #endif