apic: move target-dependent definitions to cpu.h
[qemu.git] / include / hw / hotplug.h
1 /*
2 * Hotplug handler interface.
3 *
4 * Copyright (c) 2014 Red Hat Inc.
5 *
6 * Authors:
7 * Igor Mammedov <imammedo@redhat.com>,
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
11 */
12 #ifndef HOTPLUG_H
13 #define HOTPLUG_H
14
15 #include "qom/object.h"
16
17 #define TYPE_HOTPLUG_HANDLER "hotplug-handler"
18
19 #define HOTPLUG_HANDLER_CLASS(klass) \
20 OBJECT_CLASS_CHECK(HotplugHandlerClass, (klass), TYPE_HOTPLUG_HANDLER)
21 #define HOTPLUG_HANDLER_GET_CLASS(obj) \
22 OBJECT_GET_CLASS(HotplugHandlerClass, (obj), TYPE_HOTPLUG_HANDLER)
23 #define HOTPLUG_HANDLER(obj) \
24 INTERFACE_CHECK(HotplugHandler, (obj), TYPE_HOTPLUG_HANDLER)
25
26
27 typedef struct HotplugHandler {
28 /* <private> */
29 Object Parent;
30 } HotplugHandler;
31
32 /**
33 * hotplug_fn:
34 * @plug_handler: a device performing plug/uplug action
35 * @plugged_dev: a device that has been (un)plugged
36 * @errp: returns an error if this function fails
37 */
38 typedef void (*hotplug_fn)(HotplugHandler *plug_handler,
39 DeviceState *plugged_dev, Error **errp);
40
41 /**
42 * HotplugDeviceClass:
43 *
44 * Interface to be implemented by a device performing
45 * hardware (un)plug functions.
46 *
47 * @parent: Opaque parent interface.
48 * @plug: plug callback.
49 * @unplug_request: unplug request callback.
50 * Used as a means to initiate device unplug for devices that
51 * require asynchronous unplug handling.
52 * @unplug: unplug callback.
53 * Used for device removal with devices that implement
54 * asynchronous and synchronous (surprise) removal.
55 */
56 typedef struct HotplugHandlerClass {
57 /* <private> */
58 InterfaceClass parent;
59
60 /* <public> */
61 hotplug_fn plug;
62 hotplug_fn unplug_request;
63 hotplug_fn unplug;
64 } HotplugHandlerClass;
65
66 /**
67 * hotplug_handler_plug:
68 *
69 * Call #HotplugHandlerClass.plug callback of @plug_handler.
70 */
71 void hotplug_handler_plug(HotplugHandler *plug_handler,
72 DeviceState *plugged_dev,
73 Error **errp);
74
75 /**
76 * hotplug_handler_unplug_request:
77 *
78 * Calls #HotplugHandlerClass.unplug_request callback of @plug_handler.
79 */
80 void hotplug_handler_unplug_request(HotplugHandler *plug_handler,
81 DeviceState *plugged_dev,
82 Error **errp);
83 /**
84 * hotplug_handler_unplug:
85 *
86 * Calls #HotplugHandlerClass.unplug callback of @plug_handler.
87 */
88 void hotplug_handler_unplug(HotplugHandler *plug_handler,
89 DeviceState *plugged_dev,
90 Error **errp);
91 #endif