pdmcommon.h revision a9d49c8f2b28a72e6a4db86eee91e4569290157b
/** @file
* PDM - Pluggable Device Manager, Common Definitions & Types. (VMM)
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___VBox_pdmcommon_h
#define ___VBox_pdmcommon_h
#include <VBox/types.h>
/** @defgroup grp_pdm_common Common Definitions & Types
* @ingroup grp_pdm
*
* Not all the types here are "common", they are here to work around header
* ordering issues.
*
* @{
*/
/** PDM Attach/Detach Callback Flags.
* Used by PDMDeviceAttach, PDMDeviceDetach, PDMDriverAttach, PDMDriverDetach,
* FNPDMDEVATTACH, FNPDMDEVDETACH, FNPDMDRVATTACH, FNPDMDRVDETACH and
* FNPDMDRVCONSTRUCT.
@{ */
/** The attach/detach command is not a hotplug event. */
#define PDM_TACH_FLAGS_NOT_HOT_PLUG RT_BIT_32(0)
/** Indicates that no attach or detach callbacks should be made.
* This is mostly for internal use. */
#define PDM_TACH_FLAGS_NO_CALLBACKS RT_BIT_32(1)
/* @} */
/**
* Is asynchronous handling of suspend or power off notification completed?
*
* This is called to check whether the USB device has quiesced. Don't deadlock.
* Avoid blocking. Do NOT wait for anything.
*
* @returns true if done, false if more work to be done.
*
* @param pUsbIns The USB device instance.
*
* @thread EMT(0)
*/
typedef DECLCALLBACK(bool) FNPDMUSBASYNCNOTIFY(PPDMUSBINS pUsbIns);
/** Pointer to a FNPDMUSBASYNCNOTIFY. */
typedef FNPDMUSBASYNCNOTIFY *PFNPDMUSBASYNCNOTIFY;
/**
* Is asynchronous handling of suspend or power off notification completed?
*
* This is called to check whether the device has quiesced. Don't deadlock.
* Avoid blocking. Do NOT wait for anything.
*
* @returns true if done, false if more work to be done.
*
* @param pDevIns The device instance.
*
* @thread EMT(0)
*/
typedef DECLCALLBACK(bool) FNPDMDEVASYNCNOTIFY(PPDMDEVINS pDevIns);
/** Pointer to a FNPDMDEVASYNCNOTIFY. */
typedef FNPDMDEVASYNCNOTIFY *PFNPDMDEVASYNCNOTIFY;
/**
* Is asynchronous handling of suspend or power off notification completed?
*
* This is called to check whether the driver has quiesced. Don't deadlock.
* Avoid blocking. Do NOT wait for anything.
*
* @returns true if done, false if more work to be done.
*
* @param pDrvIns The driver instance.
*
* @thread EMT(0)
*/
typedef DECLCALLBACK(bool) FNPDMDRVASYNCNOTIFY(PPDMDRVINS pDrvIns);
/** Pointer to a FNPDMDRVASYNCNOTIFY. */
typedef FNPDMDRVASYNCNOTIFY *PFNPDMDRVASYNCNOTIFY;
/** @} */
#endif