Devices/Samples/VBoxSampleDevice.cpp

d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync/* $Id$ */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync/** @file
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * VBox Sample Device.
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync/*
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * Copyright (C) 2009-2010 Oracle Corporation
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync *
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * available from http://www.virtualbox.org. This file is free software;
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * you can redistribute it and/or modify it under the terms of the GNU
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * General Public License (GPL) as published by the Free Software
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync/*******************************************************************************
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync*   Header Files                                                               *
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync*******************************************************************************/
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync#define LOG_GROUP LOG_GROUP_MISC
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync#include <VBox/vmm/pdmdev.h>
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync#include <VBox/version.h>
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync#include <VBox/err.h>
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync#include <VBox/log.h>
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync#include <iprt/assert.h>
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync/*******************************************************************************
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync*   Structures and Typedefs                                                    *
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync*******************************************************************************/
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync/**
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync * Device Instance Data.
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsynctypedef struct VBOXSAMPLEDEVICE
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync{
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    uint32_t    Whatever;
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync} VBOXSAMPLEDEVICE;
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsynctypedef VBOXSAMPLEDEVICE *PVBOXSAMPLEDEVICE;
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
a7aa94e0115a73841f34ebbfa00f63fa1904e51fvboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    FNPDMDEVCONSTRUCT  pfnConstruct;
a7aa94e0115a73841f34ebbfa00f63fa1904e51fvboxsync    /** Destruct instance - optional. */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    FNPDMDEVDESTRUCT   pfnDestruct;
6fffd38c4ef918b4aaa702d0768422e0be119ba7vboxsync
6fffd38c4ef918b4aaa702d0768422e0be119ba7vboxsyncstatic DECLCALLBACK(int) devSampleDestruct(PPDMDEVINS pDevIns)
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync{
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    /*
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync     * Check the versions here as well since the destructor is *always* called.
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync     */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    AssertMsgReturn(pDevIns->u32Version            == PDM_DEVINS_VERSION, ("%#x, expected %#x\n", pDevIns->u32Version,            PDM_DEVINS_VERSION), VERR_VERSION_MISMATCH);
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    AssertMsgReturn(pDevIns->pHlpR3->u32Version == PDM_DEVHLPR3_VERSION, ("%#x, expected %#x\n", pDevIns->pHlpR3->u32Version, PDM_DEVHLPR3_VERSION), VERR_VERSION_MISMATCH);
0e5731ab59b4ecead38375f26eeea698f00b19fdvboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    return VINF_SUCCESS;
a7aa94e0115a73841f34ebbfa00f63fa1904e51fvboxsync}
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsyncstatic DECLCALLBACK(int) devSampleConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
6fffd38c4ef918b4aaa702d0768422e0be119ba7vboxsync{
0e5731ab59b4ecead38375f26eeea698f00b19fdvboxsync    /*
0e5731ab59b4ecead38375f26eeea698f00b19fdvboxsync     * Check that the device instance and device helper structures are compatible.
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync     */
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    AssertLogRelMsgReturn(pDevIns->u32Version            == PDM_DEVINS_VERSION, ("%#x, expected %#x\n", pDevIns->u32Version,            PDM_DEVINS_VERSION), VERR_VERSION_MISMATCH);
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    AssertLogRelMsgReturn(pDevIns->pHlpR3->u32Version == PDM_DEVHLPR3_VERSION, ("%#x, expected %#x\n", pDevIns->pHlpR3->u32Version, PDM_DEVHLPR3_VERSION), VERR_VERSION_MISMATCH);
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    /*
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync     * Initialize the instance data so that the destructure won't mess up.
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync     */
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync    PVBOXSAMPLEDEVICE pThis = PDMINS_2_DATA(pDevIns, PVBOXSAMPLEDEVICE);
d606b96aa8a4be8f7d2da410f982889804c27b92vboxsync    pThis->Whatever = 0;

    /*
     * Validate and read the configuration.
     */
    if (!CFGMR3AreValuesValid(pCfg,
                              "Whatever1\0"
                              "Whatever2\0"))
        return VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES;


    return VINF_SUCCESS;
}


/**
 * The device registration structure.
 */
static const PDMDEVREG g_DeviceSample =
{
    /* u32Version */
    PDM_DEVREG_VERSION,
    /* szName */
    "sample",
    /* szRCMod */
    "",
    /* szR0Mod */
    "",
    /* pszDescription */
    "VBox Sample Device.",
    /* fFlags */
    PDM_DEVREG_FLAGS_DEFAULT_BITS,
    /* fClass */
    PDM_DEVREG_CLASS_MISC,
    /* cMaxInstances */
    1,
    /* cbInstance */
    sizeof(VBOXSAMPLEDEVICE),
    /* pfnConstruct */
    devSampleConstruct,
    /* pfnDestruct */
    devSampleDestruct,
    /* pfnRelocate */
    NULL,
    /* pfnMemSetup */
    NULL,
    /* pfnPowerOn */
    NULL,
    /* pfnReset */
    NULL,
    /* pfnSuspend */
    NULL,
    /* pfnResume */
    NULL,
    /* pfnAttach */
    NULL,
    /* pfnDetach */
    NULL,
    /* pfnQueryInterface */
    NULL,
    /* pfnInitComplete */
    NULL,
    /* pfnPowerOff */
    NULL,
    /* pfnSoftReset */
    NULL,
    /* u32VersionEnd */
    PDM_DEVREG_VERSION
};


/**
 * Register builtin devices.
 *
 * @returns VBox status code.
 * @param   pCallbacks      Pointer to the callback table.
 * @param   u32Version      VBox version number.
 */
extern "C" DECLEXPORT(int) VBoxDevicesRegister(PPDMDEVREGCB pCallbacks, uint32_t u32Version)
{
    LogFlow(("VBoxSampleDevice::VBoxDevicesRegister: u32Version=%#x pCallbacks->u32Version=%#x\n", u32Version, pCallbacks->u32Version));

    AssertLogRelMsgReturn(pCallbacks->u32Version == PDM_DEVREG_CB_VERSION,
                          ("%#x, expected %#x\n", pCallbacks->u32Version, PDM_DEVREG_CB_VERSION),
                          VERR_VERSION_MISMATCH);

    return pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
}