Devices/Input/DrvKeyboardQueue.cpp

	DrvKeyboardQueue.cpp revision da957c069c2a3c582fe265ff88170ce4c42b499d
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/** @file
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * VBox input devices:
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Keyboard queue driver
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Copyright (C) 2006-2007 innotek GmbH
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * available from http://www.virtualbox.org. This file is free software;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * you can redistribute it and/or modify it under the terms of the GNU
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * General Public License as published by the Free Software Foundation,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * If you received this file as part of a commercial VirtualBox
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * distribution, then only the terms of your commercial VirtualBox
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * license agreement apply instead of the previous paragraph.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*******************************************************************************
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync*   Header Files                                                               *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync*******************************************************************************/
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define LOG_GROUP LOG_GROUP_DRV_KBD_QUEUE
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <VBox/pdmdrv.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/assert.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include "Builtins.h"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*******************************************************************************
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync*   Structures and Typedefs                                                    *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync*******************************************************************************/
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Keyboard queue driver instance data.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct DRVKBDQUEUE
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** Pointer to the driver instance structure. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PPDMDRVINS                  pDrvIns;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** Pointer to the keyboard port interface of the driver/device above us. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PPDMIKEYBOARDPORT           pUpPort;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** Pointer to the keyboard port interface of the driver/device below us. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PPDMIKEYBOARDCONNECTOR      pDownConnector;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** Our keyboard connector interface. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDMIKEYBOARDCONNECTOR       Connector;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** Our keyboard port interface. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDMIKEYBOARDPORT            Port;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** The queue handle. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PPDMQUEUE                   pQueue;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** Discard input when this flag is set.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync     * We only accept input when the VM is running. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    bool                        fInactive;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync} DRVKBDQUEUE, *PDRVKBDQUEUE;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Keyboard queue item.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsynctypedef struct DRVKBDQUEUEITEM
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** The core part owned by the queue manager. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDMQUEUEITEMCORE    Core;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** The keycode. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    uint8_t             u8KeyCode;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync} DRVKBDQUEUEITEM, *PDRVKBDQUEUEITEM;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* -=-=-=-=- IBase -=-=-=-=- */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Queries an interface to the driver.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns Pointer to interface.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns NULL if the interface was not supported by the driver.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pInterface          Pointer to this interface structure.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   enmInterface        The requested interface identification.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void *)  drvKbdQueueQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE pDrv = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    switch (enmInterface)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        case PDMINTERFACE_BASE:
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync            return &pDrvIns->IBase;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        case PDMINTERFACE_KEYBOARD_PORT:
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync            return &pDrv->Port;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        case PDMINTERFACE_KEYBOARD_CONNECTOR:
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync            return &pDrv->Connector;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        default:
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync            return NULL;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    }
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* -=-=-=-=- IKeyboardPort -=-=-=-=- */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/** Converts a pointer to DRVKBDQUEUE::Port to a DRVKBDQUEUE pointer. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define IKEYBOARDPORT_2_DRVKBDQUEUE(pInterface) ( (PDRVKBDQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVKBDQUEUE, Port)) )
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Queues a keyboard event.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Because of the event queueing the EMT context requirement is lifted.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns VBox status code.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pInterface          Pointer to this interface structure.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   u8KeyCode           The keycode to queue.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @thread  Any thread.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(int) drvKbdQueuePutEvent(PPDMIKEYBOARDPORT pInterface, uint8_t u8KeyCode)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE pDrv = IKEYBOARDPORT_2_DRVKBDQUEUE(pInterface);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    if (pDrv->fInactive)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        return VINF_SUCCESS;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUEITEM pItem = (PDRVKBDQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    if (pItem)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        pItem->u8KeyCode = u8KeyCode;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        PDMQueueInsert(pDrv->pQueue, &pItem->Core);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync        return VINF_SUCCESS;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    }
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    AssertMsgFailed(("drvKbdQueuePutEvent: Queue is full!!!!\n"));
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    return VERR_PDM_NO_QUEUE_ITEMS;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* -=-=-=-=- Connector -=-=-=-=- */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#define PPDMIKEYBOARDCONNECTOR_2_DRVKBDQUEUE(pInterface) ( (PDRVKBDQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVKBDQUEUE, Connector)) )
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Pass LED status changes from the guest thru to the frontent driver.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pInterface  Pointer to the keyboard connector interface structure.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   enmLeds     The new LED mask.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void) drvKbdPassThruLedsChange(PPDMIKEYBOARDCONNECTOR pInterface, PDMKEYBLEDS enmLeds)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE pDrv = PPDMIKEYBOARDCONNECTOR_2_DRVKBDQUEUE(pInterface);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    pDrv->pDownConnector->pfnLedStatusChange(pDrv->pDownConnector, enmLeds);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* -=-=-=-=- queue -=-=-=-=- */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Queue callback for processing a queued item.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns Success indicator.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *          If false the item will not be removed and the flushing will stop.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pDrvIns         The driver instance.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pItemCore       Pointer to the queue item to process.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(bool) drvKbdQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITEMCORE pItemCore)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE        pData = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUEITEM    pItem = (PDRVKBDQUEUEITEM)pItemCore;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    int rc = pData->pUpPort->pfnPutEvent(pData->pUpPort, pItem->u8KeyCode);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    return VBOX_SUCCESS(rc);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* -=-=-=-=- driver interface -=-=-=-=- */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Power On notification.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns VBox status.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pDrvIns     The drive instance data.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void) drvKbdQueuePowerOn(PPDMDRVINS pDrvIns)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE    pData = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    pData->fInactive = false;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Reset notification.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns VBox status.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pDrvIns     The drive instance data.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void)  drvKbdQueueReset(PPDMDRVINS pDrvIns)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    //PDRVKBDQUEUE        pData = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    /** @todo purge the queue on reset. */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Suspend notification.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns VBox status.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pDrvIns     The drive instance data.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void)  drvKbdQueueSuspend(PPDMDRVINS pDrvIns)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE        pData = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    pData->fInactive = true;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Resume notification.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @returns VBox status.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pDrvIns     The drive instance data.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void)  drvKbdQueueResume(PPDMDRVINS pDrvIns)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE        pData = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    pData->fInactive = false;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/**
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Power Off notification.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * @param   pDrvIns     The drive instance data.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncstatic DECLCALLBACK(void) drvKbdQueuePowerOff(PPDMDRVINS pDrvIns)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    PDRVKBDQUEUE        pData = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync    pData->fInactive = true;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync

/**
 * Construct a keyboard driver instance.
 *
 * @returns VBox status.
 * @param   pDrvIns     The driver instance data.
 *                      If the registration structure is needed, pDrvIns->pDrvReg points to it.
 * @param   pCfgHandle  Configuration node handle for the driver. Use this to obtain the configuration
 *                      of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
 *                      iInstance it's expected to be used a bit in this function.
 */
static DECLCALLBACK(int) drvKbdQueueConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
{
    PDRVKBDQUEUE pDrv = PDMINS2DATA(pDrvIns, PDRVKBDQUEUE);
    LogFlow(("drvKbdQueueConstruct: iInstance=%d\n", pDrvIns->iInstance));

    /*
     * Validate configuration.
     */
    if (!CFGMR3AreValuesValid(pCfgHandle, "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->Connector.pfnLedStatusChange      = drvKbdPassThruLedsChange;
    /* IKeyboardPort. */
    pDrv->Port.pfnPutEvent                  = drvKbdQueuePutEvent;

    /*
     * Get the IKeyboardPort interface of the above driver/device.
     */
    pDrv->pUpPort = (PPDMIKEYBOARDPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_KEYBOARD_PORT);
    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 = pDrvIns->pDrvHlp->pfnAttach(pDrvIns, &pDownBase);
    if (VBOX_FAILURE(rc))
    {
        AssertMsgFailed(("Failed to attach driver below us! rc=%Vra\n", rc));
        return rc;
    }
    pDrv->pDownConnector = (PPDMIKEYBOARDCONNECTOR)pDownBase->pfnQueryInterface(pDownBase, PDMINTERFACE_KEYBOARD_CONNECTOR);
    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(pCfgHandle, "Interval", &cMilliesInterval);
    if (rc == VERR_CFGM_VALUE_NOT_FOUND)
        cMilliesInterval = 0;
    else if (VBOX_FAILURE(rc))
    {
        AssertMsgFailed(("Configuration error: 32-bit \"Interval\" -> rc=%Vrc\n", rc));
        return rc;
    }

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

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

    return VINF_SUCCESS;
}


/**
 * Keyboard queue driver registration record.
 */
const PDMDRVREG g_DrvKeyboardQueue =
{
    /* u32Version */
    PDM_DRVREG_VERSION,
    /* szDriverName */
    "KeyboardQueue",
    /* 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,
    /* pfnDestruct */
    NULL,
    /* pfnIOCtl */
    NULL,
    /* pfnPowerOn */
    drvKbdQueuePowerOn,
    /* pfnReset */
    drvKbdQueueReset,
    /* pfnSuspend */
    drvKbdQueueSuspend,
    /* pfnResume */
    drvKbdQueueResume,
    /* pfnDetach */
    NULL,
    /** pfnPowerOff */
    drvKbdQueuePowerOff
};