int PS2MConstruct(PPS2M pThis, PPDMDEVINS pDevIns, void *pParent, int iInstance)
{
int rc;
LogFlowFunc(("iInstance=%d\n", iInstance));
pThis->pParent = pParent;
/* Initialize the queues. */
pThis->evtQ.cSize = AUX_EVT_QUEUE_SIZE;
pThis->cmdQ.cSize = AUX_CMD_QUEUE_SIZE;
pThis->Mouse.IBase.pfnQueryInterface = ps2mQueryInterface;
pThis->Mouse.IPort.pfnPutEvent = ps2mPutEvent;
pThis->Mouse.IPort.pfnPutEventAbs = ps2mPutEventAbs;
pThis->Mouse.IPort.pfnPutEventMultiTouch = ps2mPutEventMT;
/*
* Initialize the critical section pointer(s).
*/
pThis->pCritSectR3 = pDevIns->pCritSectRoR3;
/*
* Create the input rate throttling timer. Does not use virtual time!
*/
PTMTIMER pTimer;
rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_REAL, ps2mThrottleTimer, pThis,
TMTIMER_FLAGS_NO_CRIT_SECT, "PS2M Throttle Timer", &pTimer);
if (RT_FAILURE(rc))
return rc;
pThis->pThrottleTimerR3 = pTimer;
pThis->pThrottleTimerR0 = TMTimerR0Ptr(pTimer);
pThis->pThrottleTimerRC = TMTimerRCPtr(pTimer);
/*
* Create the command delay timer.
*/
rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, ps2mDelayTimer, pThis,
TMTIMER_FLAGS_NO_CRIT_SECT, "PS2M Delay Timer", &pTimer);
if (RT_FAILURE(rc))
return rc;
pThis->pDelayTimerR3 = pTimer;
pThis->pDelayTimerR0 = TMTimerR0Ptr(pTimer);
pThis->pDelayTimerRC = TMTimerRCPtr(pTimer);
/*
* Register debugger info callbacks.
*/
PDMDevHlpDBGFInfoRegister(pDevIns, "ps2m", "Display PS/2 mouse state.", ps2mInfoState);
//@todo: Where should we do this?
ps2mSetDriverState(pThis, true);
pThis->u8State = 0;
pThis->enmMode = AUX_MODE_STD;
return rc;
}
/* Reset the pointing device. */
static void ps2mReset(PPS2M pThis)
{
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_BAT_OK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, 0);
pThis->enmMode = AUX_MODE_STD;
pThis->u8CurrCmd = 0;
/// @todo move to its proper home!
ps2mSetDriverState(pThis, true);
}
void PS2MFixupState(PPS2M pThis, uint8_t u8State, uint8_t u8Rate, uint8_t u8Proto)
{
LogFlowFunc(("Fixing up old PS2M state version\n"));
/* Load the basic auxiliary device state. */
pThis->u8State = u8State;
pThis->u8SampleRate = u8Rate ? u8Rate : 40; /* In case it wasn't saved right. */
pThis->enmProtocol = (PS2M_PROTO)u8Proto;
/* Recalculate the throttling delay. */
ps2mSetRate(pThis, pThis->u8SampleRate);
ps2mSetDriverState(pThis, !!(pThis->u8State & AUX_STATE_ENABLED));
}
/* The auxiliary device is specified to take up to about 500 milliseconds. We need
* to delay sending the result to the host for at least a tiny little while.
*/
static DECLCALLBACK(void) ps2mDelayTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
{
PPS2M pThis = (PS2M *)pvUser; NOREF(pDevIns);
LogFlowFunc(("Delay timer: cmd %02X\n", pThis->u8CurrCmd));
Assert(pThis->u8CurrCmd == ACMD_RESET);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_BAT_OK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, 0);
pThis->enmMode = AUX_MODE_STD;
pThis->u8CurrCmd = 0;
///@todo Might want a PS2MCompleteCommand() to push last response, clear command, and kick the KBC...
/* Give the KBC a kick. */
KBCUpdateInterrupts(pThis->pParent);
//@todo: move to its proper home!
ps2mSetDriverState(pThis, true);
}
int PS2MLoadState(PPS2M pThis, PSSMHANDLE pSSM, uint32_t uVersion)
{
uint8_t u8;
int rc;
NOREF(uVersion);
LogFlowFunc(("Loading PS2M state version %u\n", uVersion));
/* Load the basic auxiliary device state. */
SSMR3GetU8(pSSM, &pThis->u8State);
SSMR3GetU8(pSSM, &pThis->u8SampleRate);
SSMR3GetU8(pSSM, &pThis->u8Resolution);
SSMR3GetU8(pSSM, &pThis->u8CurrCmd);
SSMR3GetU8(pSSM, &u8);
pThis->enmMode = (PS2M_MODE)u8;
SSMR3GetU8(pSSM, &u8);
pThis->enmProtocol = (PS2M_PROTO)u8;
SSMR3GetU8(pSSM, &u8);
pThis->enmKnockState = (PS2M_KNOCK_STATE)u8;
/* Load the command and event queues. */
rc = ps2kLoadQueue(pSSM, (GeneriQ *)&pThis->cmdQ);
AssertRCReturn(rc, rc);
rc = ps2kLoadQueue(pSSM, (GeneriQ *)&pThis->evtQ);
AssertRCReturn(rc, rc);
/* Load the command delay timer, just in case. */
rc = TMR3TimerLoad(pThis->CTX_SUFF(pDelayTimer), pSSM);
AssertRCReturn(rc, rc);
/* Recalculate the throttling delay. */
ps2mSetRate(pThis, pThis->u8SampleRate);
//@todo: Is this the right place/logic?
ps2mSetDriverState(pThis, !!(pThis->u8State & AUX_STATE_ENABLED));
return rc;
}
/**
* Receive and process a byte sent by the keyboard controller.
*
* @param pThis The PS/2 auxiliary device instance data.
* @param cmd The command (or data) byte.
*/
int PS2MByteToAux(PPS2M pThis, uint8_t cmd)
{
uint8_t u8Val;
bool fHandled = true;
LogFlowFunc(("cmd=0x%02X, active cmd=0x%02X\n", cmd, pThis->u8CurrCmd));
//LogRel(("aux: cmd=0x%02X, active cmd=0x%02X\n", cmd, pThis->u8CurrCmd));
if (pThis->enmMode == AUX_MODE_RESET)
{
/* In reset mode, do not respond at all. */
return VINF_SUCCESS;
}
else if (pThis->enmMode == AUX_MODE_WRAP)
{
/* In wrap mode, bounce most data right back.*/
if (cmd == ACMD_RESET || cmd == ACMD_RESET_WRAP)
; /* Handle as regular commands. */
else
{
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, cmd);
return VINF_SUCCESS;
}
}
switch (cmd)
{
case ACMD_SET_SCALE_11:
pThis->u8State &= ~AUX_STATE_SCALING;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_SCALE_21:
pThis->u8State |= AUX_STATE_SCALING;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_REQ_STATUS:
/* Report current status, sample rate, and resolution. */
//@todo: buttons
u8Val = pThis->u8State;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, u8Val);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->u8Resolution);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->u8SampleRate);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_STREAM:
pThis->u8State &= ~AUX_STATE_REMOTE;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_RESET_WRAP:
pThis->enmMode = AUX_MODE_STD;
/* NB: Stream mode reporting remains disabled! */
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_WRAP:
pThis->enmMode = AUX_MODE_WRAP;
pThis->u8State &= ~AUX_STATE_ENABLED;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_REMOTE:
pThis->u8State |= AUX_STATE_REMOTE;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_READ_ID:
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->enmProtocol);
pThis->u8CurrCmd = 0;
break;
case ACMD_ENABLE:
pThis->u8State |= AUX_STATE_ENABLED;
//@todo: R3 only!
#ifdef IN_RING3
ps2mSetDriverState(pThis, true);
#endif
ps2kClearQueue((GeneriQ *)&pThis->evtQ);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_DFLT_DISABLE:
ps2mSetDefaults(pThis);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_DEFAULT:
ps2mSetDefaults(pThis);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_RESEND:
pThis->u8CurrCmd = 0;
break;
case ACMD_RESET:
ps2mSetDefaults(pThis);
///@todo reset more?
pThis->u8CurrCmd = cmd;
pThis->enmMode = AUX_MODE_RESET;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
/* Slightly delay reset completion; it might take hundreds of ms. */
TMTimerSetMillies(pThis->CTX_SUFF(pDelayTimer), 1);
break;
/* The following commands need a parameter. */
case ACMD_SET_RES:
case ACMD_SET_SAMP_RATE:
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = cmd;
break;
default:
/* Sending a command instead of a parameter starts the new command. */
switch (pThis->u8CurrCmd)
{
case ACMD_SET_RES:
//@todo reject unsupported resolutions
pThis->u8Resolution = cmd;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_SAMP_RATE:
//@todo reject unsupported rates
ps2mSetRate(pThis, cmd);
ps2mRateProtocolKnock(pThis, cmd);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
default:
fHandled = false;
}
/* Fall through only to handle unrecognized commands. */
if (fHandled)
break;
case ACMD_INVALID_1:
case ACMD_INVALID_2:
case ACMD_INVALID_3:
case ACMD_INVALID_4:
case ACMD_INVALID_5:
case ACMD_INVALID_6:
case ACMD_INVALID_7:
case ACMD_INVALID_8:
case ACMD_INVALID_9:
case ACMD_INVALID_10:
Log(("Unsupported command 0x%02X!\n", cmd));
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_RESEND);
pThis->u8CurrCmd = 0;
break;
}
LogFlowFunc(("Active cmd now 0x%02X; updating interrupts\n", pThis->u8CurrCmd));
// KBCUpdateInterrupts(pThis->pParent);
return VINF_SUCCESS;
}
/**
* Receive and process a byte sent by the keyboard controller.
*
* @param pThis The PS/2 auxiliary device instance data.
* @param cmd The command (or data) byte.
*/
int PS2MByteToAux(PPS2M pThis, uint8_t cmd)
{
uint8_t u8Val;
bool fHandled = true;
LogFlowFunc(("cmd=0x%02X, active cmd=0x%02X\n", cmd, pThis->u8CurrCmd));
//LogRel(("aux: cmd=0x%02X, active cmd=0x%02X\n", cmd, pThis->u8CurrCmd));
if (pThis->enmMode == AUX_MODE_RESET)
/* In reset mode, do not respond at all. */
return VINF_SUCCESS;
/* If there's anything left in the command response queue, trash it. */
ps2kClearQueue((GeneriQ *)&pThis->cmdQ);
if (pThis->enmMode == AUX_MODE_WRAP)
{
/* In wrap mode, bounce most data right back.*/
if (cmd == ACMD_RESET || cmd == ACMD_RESET_WRAP)
; /* Handle as regular commands. */
else
{
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, cmd);
return VINF_SUCCESS;
}
}
#ifndef IN_RING3
/* Reset, Enable, and Set Default commands must be run in R3. */
if (cmd == ACMD_RESET || cmd == ACMD_ENABLE || cmd == ACMD_SET_DEFAULT)
return VINF_IOM_R3_IOPORT_WRITE;
#endif
switch (cmd)
{
case ACMD_SET_SCALE_11:
pThis->u8State &= ~AUX_STATE_SCALING;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_SCALE_21:
pThis->u8State |= AUX_STATE_SCALING;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_REQ_STATUS:
/* Report current status, sample rate, and resolution. */
u8Val = (pThis->u8State & AUX_STATE_EXTERNAL) | (pThis->fCurrB & PS2M_STD_BTN_MASK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, u8Val);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->u8Resolution);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->u8SampleRate);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_STREAM:
pThis->u8State &= ~AUX_STATE_REMOTE;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_READ_REMOTE:
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
ps2mReportAccumulatedEvents(pThis, (GeneriQ *)&pThis->cmdQ, false);
pThis->u8CurrCmd = 0;
break;
case ACMD_RESET_WRAP:
pThis->enmMode = AUX_MODE_STD;
/* NB: Stream mode reporting remains disabled! */
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_WRAP:
pThis->enmMode = AUX_MODE_WRAP;
pThis->u8State &= ~AUX_STATE_ENABLED;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_REMOTE:
pThis->u8State |= AUX_STATE_REMOTE;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_READ_ID:
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, pThis->enmProtocol);
pThis->u8CurrCmd = 0;
break;
case ACMD_ENABLE:
pThis->u8State |= AUX_STATE_ENABLED;
#ifdef IN_RING3
ps2mSetDriverState(pThis, true);
#else
AssertLogRelMsgFailed(("Invalid ACMD_ENABLE outside R3!\n"));
#endif
ps2kClearQueue((GeneriQ *)&pThis->evtQ);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_DISABLE:
pThis->u8State &= ~AUX_STATE_ENABLED;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_SET_DEFAULT:
ps2mSetDefaults(pThis);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
break;
case ACMD_RESEND:
pThis->u8CurrCmd = 0;
break;
case ACMD_RESET:
ps2mSetDefaults(pThis);
/// @todo reset more?
pThis->u8CurrCmd = cmd;
pThis->enmMode = AUX_MODE_RESET;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
if (pThis->fDelayReset)
/* Slightly delay reset completion; it might take hundreds of ms. */
TMTimerSetMillies(pThis->CTX_SUFF(pDelayTimer), 1);
else
#ifdef IN_RING3
ps2mReset(pThis);
#else
AssertLogRelMsgFailed(("Invalid ACMD_RESET outside R3!\n"));
#endif
break;
/* The following commands need a parameter. */
case ACMD_SET_RES:
case ACMD_SET_SAMP_RATE:
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = cmd;
break;
default:
/* Sending a command instead of a parameter starts the new command. */
switch (pThis->u8CurrCmd)
{
case ACMD_SET_RES:
if (cmd < 4) /* Valid resolutions are 0-3. */
{
pThis->u8Resolution = cmd;
pThis->u8State &= ~AUX_STATE_RES_ERR;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
}
else
{
/* Bad resolution. Reply with Resend or Error. */
if (pThis->u8State & AUX_STATE_RES_ERR)
{
pThis->u8State &= ~AUX_STATE_RES_ERR;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ERROR);
pThis->u8CurrCmd = 0;
}
else
{
pThis->u8State |= AUX_STATE_RES_ERR;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_RESEND);
/* NB: Current command remains unchanged. */
}
}
break;
case ACMD_SET_SAMP_RATE:
if (ps2mIsRateSupported(cmd))
{
pThis->u8State &= ~AUX_STATE_RATE_ERR;
ps2mSetRate(pThis, cmd);
ps2mRateProtocolKnock(pThis, cmd);
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ACK);
pThis->u8CurrCmd = 0;
}
else
{
/* Bad rate. Reply with Resend or Error. */
if (pThis->u8State & AUX_STATE_RATE_ERR)
{
pThis->u8State &= ~AUX_STATE_RATE_ERR;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_ERROR);
pThis->u8CurrCmd = 0;
}
else
{
pThis->u8State |= AUX_STATE_RATE_ERR;
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_RESEND);
/* NB: Current command remains unchanged. */
}
}
break;
default:
fHandled = false;
}
/* Fall through only to handle unrecognized commands. */
if (fHandled)
break;
case ACMD_INVALID_1:
case ACMD_INVALID_2:
case ACMD_INVALID_3:
case ACMD_INVALID_4:
case ACMD_INVALID_5:
case ACMD_INVALID_6:
case ACMD_INVALID_7:
case ACMD_INVALID_8:
case ACMD_INVALID_9:
case ACMD_INVALID_10:
Log(("Unsupported command 0x%02X!\n", cmd));
ps2kInsertQueue((GeneriQ *)&pThis->cmdQ, ARSP_RESEND);
pThis->u8CurrCmd = 0;
break;
}
LogFlowFunc(("Active cmd now 0x%02X; updating interrupts\n", pThis->u8CurrCmd));
// KBCUpdateInterrupts(pThis->pParent);
return VINF_SUCCESS;
}
