Devices/Input/DrvKeyboardQueue.cpp

	DrvKeyboardQueue.cpp revision 84fdcc72b1724a0e3cb516f7732241fe6768578c
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington/* $Id$ */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/** @file
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * VBox input devices: Keyboard queue driver
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/*
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * Copyright (C) 2006-2010 Oracle Corporation
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott *
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * This file is part of VirtualBox Open Source Edition (OSE), as
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * available from http://www.virtualbox.org. This file is free software;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * you can redistribute it and/or modify it under the terms of the GNU
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * General Public License (GPL) as published by the Free Software
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington * Foundation, in version 2 as it comes in the "COPYING" file of the
a4544a5a0e622ef69e38641f87ab1b5685e05911Phill Cunnington * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal/*******************************************************************************
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott*   Header Files                                                               *
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott*******************************************************************************/
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott#define LOG_GROUP LOG_GROUP_DRV_KBD_QUEUE
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott#include <VBox/pdmdrv.h>
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott#include <iprt/assert.h>
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott#include <iprt/uuid.h>
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott#include "Builtins.h"
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/*******************************************************************************
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott*   Structures and Typedefs                                                    *
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott*******************************************************************************/
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/**
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * Keyboard queue driver instance data.
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott *
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * @implements  PDMIKEYBOARDCONNECTOR
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * @implements  PDMIKEYBOARDPORT
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshotttypedef struct DRVKBDQUEUE
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott{
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** Pointer to the driver instance structure. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PPDMDRVINS                  pDrvIns;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** Pointer to the keyboard port interface of the driver/device above us. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PPDMIKEYBOARDPORT           pUpPort;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** Pointer to the keyboard port interface of the driver/device below us. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PPDMIKEYBOARDCONNECTOR      pDownConnector;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** Our keyboard connector interface. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDMIKEYBOARDCONNECTOR       IConnector;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** Our keyboard port interface. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDMIKEYBOARDPORT            IPort;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** The queue handle. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PPDMQUEUE                   pQueue;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** Discard input when this flag is set.
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott     * We only accept input when the VM is running. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    bool                        fInactive;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott} DRVKBDQUEUE, *PDRVKBDQUEUE;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/**
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * Keyboard queue item.
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshotttypedef struct DRVKBDQUEUEITEM
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott{
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** The core part owned by the queue manager. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDMQUEUEITEMCORE    Core;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    /** The keycode. */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    uint8_t             u8KeyCode;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott} DRVKBDQUEUEITEM, *PDRVKBDQUEUEITEM;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/* -=-=-=-=- IBase -=-=-=-=- */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/**
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott * @interface_method_impl{PDMIBASE,pfnQueryInterface}
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshottstatic DECLCALLBACK(void *)  drvKbdQueueQueryInterface(PPDMIBASE pInterface, const char *pszIID)
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott{
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PPDMDRVINS      pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDRVKBDQUEUE    pThis   = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDMIBASE_RETURN_INTERFACE(pszIID, PDMIKEYBOARDCONNECTOR, &pThis->IConnector);
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    PDMIBASE_RETURN_INTERFACE(pszIID, PDMIKEYBOARDPORT, &pThis->IPort);
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott    return NULL;
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott}
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/* -=-=-=-=- IKeyboardPort -=-=-=-=- */
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott/** Converts a pointer to DRVKBDQUEUE::IPort to a DRVKBDQUEUE pointer. */
1d407e39b7d8f68d9a2b1e178f35fab037d9835aRobert Wapshott#define IKEYBOARDPORT_2_DRVKBDQUEUE(pInterface) ( (PDRVKBDQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVKBDQUEUE, IPort)) )
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal/**
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal * Queues a keyboard event.
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal * Because of the event queueing the EMT context requirement is lifted.
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal *
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal * @returns VBox status code.
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal * @param   pInterface          Pointer to this interface structure.
8808bf6434d4dd628636c2ed08b8b0fe6baa5752Dipu Seminlal * @param   u8KeyCode           The keycode to queue.
1d407e39b7d8f68d9a2b1e178f35fab037d9835aRobert Wapshott * @thread  Any thread.
1d407e39b7d8f68d9a2b1e178f35fab037d9835aRobert Wapshott */
1d407e39b7d8f68d9a2b1e178f35fab037d9835aRobert Wapshottstatic DECLCALLBACK(int) drvKbdQueuePutEvent(PPDMIKEYBOARDPORT pInterface, uint8_t u8KeyCode)
72450cb9c2ca854c6d3479832c2738196c1d3282Robert Wapshott{
    PDRVKBDQUEUE pDrv = IKEYBOARDPORT_2_DRVKBDQUEUE(pInterface);
    if (pDrv->fInactive)
        return VINF_SUCCESS;

    PDRVKBDQUEUEITEM pItem = (PDRVKBDQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
    if (pItem)
    {
        pItem->u8KeyCode = u8KeyCode;
        PDMQueueInsert(pDrv->pQueue, &pItem->Core);
        return VINF_SUCCESS;
    }
    AssertMsgFailed(("drvKbdQueuePutEvent: Queue is full!!!!\n"));
    return VERR_PDM_NO_QUEUE_ITEMS;
}


/* -=-=-=-=- IConnector -=-=-=-=- */

#define PPDMIKEYBOARDCONNECTOR_2_DRVKBDQUEUE(pInterface) ( (PDRVKBDQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVKBDQUEUE, IConnector)) )


/**
 * Pass LED status changes from the guest thru to the frontent driver.
 *
 * @param   pInterface  Pointer to the keyboard connector interface structure.
 * @param   enmLeds     The new LED mask.
 */
static DECLCALLBACK(void) drvKbdPassThruLedsChange(PPDMIKEYBOARDCONNECTOR pInterface, PDMKEYBLEDS enmLeds)
{
    PDRVKBDQUEUE pDrv = PPDMIKEYBOARDCONNECTOR_2_DRVKBDQUEUE(pInterface);
    pDrv->pDownConnector->pfnLedStatusChange(pDrv->pDownConnector, enmLeds);
}

/**
 * Pass keyboard state changes from the guest thru to the frontent driver.
 *
 * @param   pInterface  Pointer to the keyboard connector interface structure.
 * @param   fActive     The new active/inactive state.
 */
static DECLCALLBACK(void) drvKbdPassThruSetActive(PPDMIKEYBOARDCONNECTOR pInterface, bool fActive)
{
    PDRVKBDQUEUE pDrv = PPDMIKEYBOARDCONNECTOR_2_DRVKBDQUEUE(pInterface);
    pDrv->pDownConnector->pfnSetActive(pDrv->pDownConnector, fActive);
}


/* -=-=-=-=- queue -=-=-=-=- */

/**
 * Queue callback for processing a queued item.
 *
 * @returns Success indicator.
 *          If false the item will not be removed and the flushing will stop.
 * @param   pDrvIns         The driver instance.
 * @param   pItemCore       Pointer to the queue item to process.
 */
static DECLCALLBACK(bool) drvKbdQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITEMCORE pItemCore)
{
    PDRVKBDQUEUE        pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    PDRVKBDQUEUEITEM    pItem = (PDRVKBDQUEUEITEM)pItemCore;
    int rc = pThis->pUpPort->pfnPutEvent(pThis->pUpPort, pItem->u8KeyCode);
    return RT_SUCCESS(rc);
}


/* -=-=-=-=- driver interface -=-=-=-=- */

/**
 * Power On notification.
 *
 * @returns VBox status.
 * @param   pDrvIns     The drive instance data.
 */
static DECLCALLBACK(void) drvKbdQueuePowerOn(PPDMDRVINS pDrvIns)
{
    PDRVKBDQUEUE    pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    pThis->fInactive = false;
}


/**
 * Reset notification.
 *
 * @returns VBox status.
 * @param   pDrvIns     The drive instance data.
 */
static DECLCALLBACK(void)  drvKbdQueueReset(PPDMDRVINS pDrvIns)
{
    //PDRVKBDQUEUE        pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    /** @todo purge the queue on reset. */
}


/**
 * Suspend notification.
 *
 * @returns VBox status.
 * @param   pDrvIns     The drive instance data.
 */
static DECLCALLBACK(void)  drvKbdQueueSuspend(PPDMDRVINS pDrvIns)
{
    PDRVKBDQUEUE        pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    pThis->fInactive = true;
}


/**
 * Resume notification.
 *
 * @returns VBox status.
 * @param   pDrvIns     The drive instance data.
 */
static DECLCALLBACK(void)  drvKbdQueueResume(PPDMDRVINS pDrvIns)
{
    PDRVKBDQUEUE        pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    pThis->fInactive = false;
}


/**
 * Power Off notification.
 *
 * @param   pDrvIns     The drive instance data.
 */
static DECLCALLBACK(void) drvKbdQueuePowerOff(PPDMDRVINS pDrvIns)
{
    PDRVKBDQUEUE        pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    pThis->fInactive = true;
}


/**
 * Construct a keyboard driver instance.
 *
 * @copydoc FNPDMDRVCONSTRUCT
 */
static DECLCALLBACK(int) drvKbdQueueConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
{
    PDRVKBDQUEUE pDrv = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
    LogFlow(("drvKbdQueueConstruct: iInstance=%d\n", pDrvIns->iInstance));
    PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);

    /*
     * Validate configuration.
     */
    if (!CFGMR3AreValuesValid(pCfg, "QueueSize\0Interval\0"))
        return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;

    /*
     * Init basic data members and interfaces.
     */
    pDrv->fInactive                         = true;
    /* IBase. */
    pDrvIns->IBase.pfnQueryInterface        = drvKbdQueueQueryInterface;
    /* IKeyboardConnector. */
    pDrv->IConnector.pfnLedStatusChange     = drvKbdPassThruLedsChange;
    pDrv->IConnector.pfnSetActive           = drvKbdPassThruSetActive;
    /* IKeyboardPort. */
    pDrv->IPort.pfnPutEvent                 = drvKbdQueuePutEvent;

    /*
     * Get the IKeyboardPort interface of the above driver/device.
     */
    pDrv->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIKEYBOARDPORT);
    if (!pDrv->pUpPort)
    {
        AssertMsgFailed(("Configuration error: No keyboard port interface above!\n"));
        return VERR_PDM_MISSING_INTERFACE_ABOVE;
    }

    /*
     * Attach driver below and query it's connector interface.
     */
    PPDMIBASE pDownBase;
    int rc = PDMDrvHlpAttach(pDrvIns, fFlags, &pDownBase);
    if (RT_FAILURE(rc))
    {
        AssertMsgFailed(("Failed to attach driver below us! rc=%Rra\n", rc));
        return rc;
    }
    pDrv->pDownConnector = PDMIBASE_QUERY_INTERFACE(pDownBase, PDMIKEYBOARDCONNECTOR);
    if (!pDrv->pDownConnector)
    {
        AssertMsgFailed(("Configuration error: No keyboard connector interface below!\n"));
        return VERR_PDM_MISSING_INTERFACE_BELOW;
    }

    /*
     * Create the queue.
     */
    uint32_t cMilliesInterval = 0;
    rc = CFGMR3QueryU32(pCfg, "Interval", &cMilliesInterval);
    if (rc == VERR_CFGM_VALUE_NOT_FOUND)
        cMilliesInterval = 0;
    else if (RT_FAILURE(rc))
    {
        AssertMsgFailed(("Configuration error: 32-bit \"Interval\" -> rc=%Rrc\n", rc));
        return rc;
    }

    uint32_t cItems = 0;
    rc = CFGMR3QueryU32(pCfg, "QueueSize", &cItems);
    if (rc == VERR_CFGM_VALUE_NOT_FOUND)
        cItems = 128;
    else if (RT_FAILURE(rc))
    {
        AssertMsgFailed(("Configuration error: 32-bit \"QueueSize\" -> rc=%Rrc\n", rc));
        return rc;
    }

    rc = PDMDrvHlpQueueCreate(pDrvIns, sizeof(DRVKBDQUEUEITEM), cItems, cMilliesInterval, drvKbdQueueConsumer, "Keyboard", &pDrv->pQueue);
    if (RT_FAILURE(rc))
    {
        AssertMsgFailed(("Failed to create driver: cItems=%d cMilliesInterval=%d rc=%Rrc\n", cItems, cMilliesInterval, rc));
        return rc;
    }

    return VINF_SUCCESS;
}


/**
 * Keyboard queue driver registration record.
 */
const PDMDRVREG g_DrvKeyboardQueue =
{
    /* u32Version */
    PDM_DRVREG_VERSION,
    /* szName */
    "KeyboardQueue",
    /* szRCMod */
    "",
    /* szR0Mod */
    "",
    /* pszDescription */
    "Keyboard queue driver to plug in between the key source and the device to do queueing and inter-thread transport.",
    /* fFlags */
    PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
    /* fClass. */
    PDM_DRVREG_CLASS_KEYBOARD,
    /* cMaxInstances */
    ~0,
    /* cbInstance */
    sizeof(DRVKBDQUEUE),
    /* pfnConstruct */
    drvKbdQueueConstruct,
    /* pfnRelocate */
    NULL,
    /* pfnDestruct */
    NULL,
    /* pfnIOCtl */
    NULL,
    /* pfnPowerOn */
    drvKbdQueuePowerOn,
    /* pfnReset */
    drvKbdQueueReset,
    /* pfnSuspend */
    drvKbdQueueSuspend,
    /* pfnResume */
    drvKbdQueueResume,
    /* pfnAttach */
    NULL,
    /* pfnDetach */
    NULL,
    /* pfnPowerOff */
    drvKbdQueuePowerOff,
    /* pfnSoftReset */
    NULL,
    /* u32EndVersion */
    PDM_DRVREG_VERSION
};