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 * @pre_plug: pre plug callback called at start of device.realize(true) 49 * @plug: plug callback called at end of device.realize(true). 50 * @post_pug: post plug callback called after device is successfully plugged. 51 * @unplug_request: unplug request callback. 52 * Used as a means to initiate device unplug for devices that 53 * require asynchronous unplug handling. 54 * @unplug: unplug callback. 55 * Used for device removal with devices that implement 56 * asynchronous and synchronous (surprise) removal. 57 */ 58 typedef struct HotplugHandlerClass { 59 /* <private> */ 60 InterfaceClass parent; 61 62 /* <public> */ 63 hotplug_fn pre_plug; 64 hotplug_fn plug; 65 hotplug_fn post_plug; 66 hotplug_fn unplug_request; 67 hotplug_fn unplug; 68 } HotplugHandlerClass; 69 70 /** 71 * hotplug_handler_plug: 72 * 73 * Call #HotplugHandlerClass.plug callback of @plug_handler. 74 */ 75 void hotplug_handler_plug(HotplugHandler *plug_handler, 76 DeviceState *plugged_dev, 77 Error **errp); 78 79 /** 80 * hotplug_handler_pre_plug: 81 * 82 * Call #HotplugHandlerClass.pre_plug callback of @plug_handler. 83 */ 84 void hotplug_handler_pre_plug(HotplugHandler *plug_handler, 85 DeviceState *plugged_dev, 86 Error **errp); 87 88 /** 89 * hotplug_handler_post_plug: 90 * 91 * Call #HotplugHandlerClass.post_plug callback of @plug_handler. 92 */ 93 void hotplug_handler_post_plug(HotplugHandler *plug_handler, 94 DeviceState *plugged_dev, 95 Error **errp); 96 97 /** 98 * hotplug_handler_unplug_request: 99 * 100 * Calls #HotplugHandlerClass.unplug_request callback of @plug_handler. 101 */ 102 void hotplug_handler_unplug_request(HotplugHandler *plug_handler, 103 DeviceState *plugged_dev, 104 Error **errp); 105 /** 106 * hotplug_handler_unplug: 107 * 108 * Calls #HotplugHandlerClass.unplug callback of @plug_handler. 109 */ 110 void hotplug_handler_unplug(HotplugHandler *plug_handler, 111 DeviceState *plugged_dev, 112 Error **errp); 113 #endif 114