ps2.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	PS2_DATA_PORT   0x60
#define	PS2_CONTROL_PORT   0x64
#define	PS2_STAT_OUT_BUF_FULL   (1 << 0)
#define	PS2_STAT_SYSTEM   (1 << 2)
#define	PS2_STAT_COMMAND   (1 << 3)
#define	PS2_STAT_KBD_ENABLE   (1 << 4)
#define	PS2_STAT_AUX_OUT_BUF_FULL   (1 << 5)
#define	PS2_STAT_GEN_TIMEOUT   (1 << 6)
#define	PS2_STAT_PARITY_ERROR   (1 << 7)
#define	PS2_CONFIG_KBD_INT   (1 << 0)
#define	PS2_CONFIG_AUX_INT   (1 << 1)
#define	PS2_CONFIG_SYSTEM   (1 << 2)
#define	PS2_CONFIG_NO_KEYLOCK   (1 << 3)
#define	PS2_CONFIG_KBD_DISABLE   (1 << 4)
#define	PS2_CONFIG_AUX_DISABLE   (1 << 5)
#define	PS2_OUT_CPU_NO_RESET   (1 << 0)
#define	PS2_OUT_A20_SET   (1 << 1)
#define	PS2_OUT_AUX_DATA   (1 << 2)
#define	PS2_OUT_IRQ01   (1 << 4)
#define	PS2_OUT_IRQ12   (1 << 5)
#define	PS2_OUT_KBD_DATA   (1 << 7)

Typedefs
typedef VOID(WINAPI *	PS2_DEVICE_CMDPROC) (LPVOID Param, BYTE Command)

Functions
VOID	PS2SetDeviceCmdProc (BYTE PS2Port, LPVOID Param, PS2_DEVICE_CMDPROC DeviceCommand)
BOOLEAN	PS2QueuePush (BYTE PS2Port, BYTE Data)
BOOLEAN	PS2PortQueueRead (BYTE PS2Port)
BOOLEAN	PS2Initialize (VOID)
VOID	PS2Cleanup (VOID)

Macro Definition Documentation

PS2_CONFIG_AUX_DISABLE

#define PS2_CONFIG_AUX_DISABLE   (1 << 5)

Definition at line 35 of file ps2.h.

PS2_CONFIG_AUX_INT

#define PS2_CONFIG_AUX_INT   (1 << 1)

Definition at line 31 of file ps2.h.

PS2_CONFIG_KBD_DISABLE

#define PS2_CONFIG_KBD_DISABLE   (1 << 4)

Definition at line 34 of file ps2.h.

PS2_CONFIG_KBD_INT

#define PS2_CONFIG_KBD_INT   (1 << 0)

Definition at line 30 of file ps2.h.

PS2_CONFIG_NO_KEYLOCK

#define PS2_CONFIG_NO_KEYLOCK   (1 << 3)

Definition at line 33 of file ps2.h.

PS2_CONFIG_SYSTEM

#define PS2_CONFIG_SYSTEM   (1 << 2)

Definition at line 32 of file ps2.h.

PS2_CONTROL_PORT

#define PS2_CONTROL_PORT   0x64

Definition at line 17 of file ps2.h.

PS2_DATA_PORT

#define PS2_DATA_PORT   0x60

Definition at line 16 of file ps2.h.

PS2_OUT_A20_SET

#define PS2_OUT_A20_SET   (1 << 1)

Definition at line 40 of file ps2.h.

PS2_OUT_AUX_DATA

#define PS2_OUT_AUX_DATA   (1 << 2)

Definition at line 41 of file ps2.h.

PS2_OUT_CPU_NO_RESET

#define PS2_OUT_CPU_NO_RESET   (1 << 0)

Definition at line 39 of file ps2.h.

PS2_OUT_IRQ01

#define PS2_OUT_IRQ01   (1 << 4)

Definition at line 43 of file ps2.h.

PS2_OUT_IRQ12

#define PS2_OUT_IRQ12   (1 << 5)

Definition at line 44 of file ps2.h.

PS2_OUT_KBD_DATA

#define PS2_OUT_KBD_DATA   (1 << 7)

Definition at line 46 of file ps2.h.

PS2_STAT_AUX_OUT_BUF_FULL

#define PS2_STAT_AUX_OUT_BUF_FULL   (1 << 5)

Definition at line 25 of file ps2.h.

PS2_STAT_COMMAND

#define PS2_STAT_COMMAND   (1 << 3)

Definition at line 23 of file ps2.h.

PS2_STAT_GEN_TIMEOUT

#define PS2_STAT_GEN_TIMEOUT   (1 << 6)

Definition at line 26 of file ps2.h.

PS2_STAT_KBD_ENABLE

#define PS2_STAT_KBD_ENABLE   (1 << 4)

Definition at line 24 of file ps2.h.

PS2_STAT_OUT_BUF_FULL

#define PS2_STAT_OUT_BUF_FULL   (1 << 0)

Definition at line 20 of file ps2.h.

PS2_STAT_PARITY_ERROR

#define PS2_STAT_PARITY_ERROR   (1 << 7)

Definition at line 27 of file ps2.h.

PS2_STAT_SYSTEM

#define PS2_STAT_SYSTEM   (1 << 2)

Definition at line 22 of file ps2.h.

Typedef Documentation

PS2_DEVICE_CMDPROC

typedef VOID(WINAPI * PS2_DEVICE_CMDPROC) (LPVOID Param, BYTE Command)

Definition at line 48 of file ps2.h.

Function Documentation

PS2Cleanup()

VOID PS2Cleanup

(

VOID

)

Definition at line 546 of file ps2.c.

{
    DestroyHardwareTimer(IrqTimer);

    CloseHandle(Ports[1].QueueMutex);
    CloseHandle(Ports[0].QueueMutex);
}

Referenced by EmulatorCleanup().

PS2Initialize()

BOOLEAN PS2Initialize

(

VOID

)

Definition at line 520 of file ps2.c.

{
    /* Initialize the PS/2 ports */
    Ports[0].IsEnabled  = FALSE;
    Ports[0].QueueEmpty = TRUE;
    Ports[0].QueueStart = 0;
    Ports[0].QueueEnd   = 0;
    Ports[0].QueueMutex = CreateMutex(NULL, FALSE, NULL);

    Ports[1].IsEnabled  = FALSE;
    Ports[1].QueueEmpty = TRUE;
    Ports[1].QueueStart = 0;
    Ports[1].QueueEnd   = 0;
    Ports[1].QueueMutex = CreateMutex(NULL, FALSE, NULL);

    /* Register the I/O Ports */
    RegisterIoPort(PS2_CONTROL_PORT, PS2ReadControl, PS2WriteControl);
    RegisterIoPort(PS2_DATA_PORT   , PS2ReadData   , PS2WriteData   );

    IrqTimer = CreateHardwareTimer(HARDWARE_TIMER_ONESHOT,
                                   HZ_TO_NS(100),
                                   GeneratePS2Irq);

    return TRUE;
}

Referenced by EmulatorInitialize().

PS2PortQueueRead()

BOOLEAN PS2PortQueueRead

(

BYTE

PS2Port

)

Definition at line 415 of file ps2.c.

{
    BOOLEAN Result = FALSE;
    PPS2_PORT Port;

    // NOTE: The first PS/2 port (keyboard) has priority over the second one (mouse).

    Port = &Ports[PS2Port];

    if (!Port->IsEnabled) return FALSE;

    /* Make sure the queue is not empty (fast check) */
    if (Port->QueueEmpty)
    {
        /* Only the keyboard should have its last data latched */
        // FIXME: Alternatively this can be done in PS2ReadData when
        // we read PS2_DATA_PORT. What is the best solution??
        if (PS2Port == 0)
        {
            OutputBuffer = Port->Queue[(Port->QueueStart - 1) % BUFFER_SIZE];
            StatusRegister &= ~PS2_STAT_AUX_OUT_BUF_FULL; // Clear flag: keyboard data
        }

        return FALSE;
    }

    WaitForSingleObject(Port->QueueMutex, INFINITE);

    /*
     * Recheck whether the queue is not empty (it may
     * have changed after having grabbed the mutex).
     */
    if (Port->QueueEmpty) goto Done;

    /* Get the data */
    OutputBuffer = Port->Queue[Port->QueueStart];

    // StatusRegister &= ~(PS2_STAT_AUX_OUT_BUF_FULL | PS2_STAT_OUT_BUF_FULL);

    /* Always set the "Output buffer full" flag */
    StatusRegister |= PS2_STAT_OUT_BUF_FULL;

    /* Set the "Auxiliary output buffer full" flag according to where the data came from */
    if (PS2Port == 0)
        StatusRegister &= ~PS2_STAT_AUX_OUT_BUF_FULL; // Clear flag: keyboard data
    else // if (PS2Port == 1)
        StatusRegister |=  PS2_STAT_AUX_OUT_BUF_FULL; //   Set flag: mouse data

    /* Remove the value from the queue */
    Port->QueueStart++;
    Port->QueueStart %= BUFFER_SIZE;

    /* Check if the queue is now empty */
    if (Port->QueueStart == Port->QueueEnd)
        Port->QueueEmpty = TRUE;

    Result = TRUE;

Done:
    ReleaseMutex(Port->QueueMutex);
    return Result;
}

Referenced by DisableMouseInt(), DosMouseIrq(), EnableMouseInt(), GeneratePS2Irq(), ReadMouseData(), and SendMouseCommand().

PS2QueuePush()

BOOLEAN PS2QueuePush	(	BYTE	PS2Port,
		BYTE	Data
	)

Definition at line 486 of file ps2.c.

{
    BOOLEAN Result = FALSE;
    PPS2_PORT Port;

    ASSERT(PS2Port < PS2_PORTS);
    Port = &Ports[PS2Port];

    if (!Port->IsEnabled) return FALSE;

    WaitForSingleObject(Port->QueueMutex, INFINITE);

    /* Check if the queue is full */
    if (!Port->QueueEmpty && (Port->QueueStart == Port->QueueEnd))
        goto Done;

    /* Insert the value in the queue */
    Port->Queue[Port->QueueEnd] = Data;
    Port->QueueEnd++;
    Port->QueueEnd %= BUFFER_SIZE;

    /* The queue is not empty anymore */
    Port->QueueEmpty = FALSE;

    /* Schedule the IRQ */
    EnableHardwareTimer(IrqTimer);

    Result = TRUE;

Done:
    ReleaseMutex(Port->QueueMutex);
    return Result;
}

Referenced by KeyboardCommand(), KeyboardEventHandler(), MouseCommand(), MouseDispatchPacket(), and PS2WriteData().

PS2SetDeviceCmdProc()

VOID PS2SetDeviceCmdProc	(	BYTE	PS2Port,
		LPVOID	Param,
		PS2_DEVICE_CMDPROC	DeviceCommand
	)

Definition at line 478 of file ps2.c.

{
    ASSERT(PS2Port < PS2_PORTS);
    Ports[PS2Port].Param         = Param;
    Ports[PS2Port].DeviceCommand = DeviceCommand;
}

Referenced by KeyboardInit(), and MouseInit().