pl050.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_PL050_H
#define _ULTIBO_PL050_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/keyboard.h"
#include "ultibo/mouse.h"
#include "ultibo/ps2.h"

#define PL050_KEYBOARD_DESCRIPTION  "ARM PrimeCell PL050 PS2 Keyboard" 
#define PL050_MOUSE_DESCRIPTION "ARM PrimeCell PL050 PS2 Mouse" 
 
#define PL050_KEYBOARD_SCANCODE_COUNT   256 
#define PL050_MOUSE_PACKET_COUNT    256 
 
#define PL050_KEYBOARD_CLOCK_RATE   8000000 
#define PL050_MOUSE_CLOCK_RATE  8000000 
 
#define PL050_KEYBOARD_SHIFTSTATE_MASK  KEYBOARD_LEFT_CTRL | KEYBOARD_LEFT_SHIFT | KEYBOARD_LEFT_ALT | KEYBOARD_RIGHT_CTRL | KEYBOARD_RIGHT_SHIFT | KEYBOARD_RIGHT_ALT

#define PL050_CR_TYPE   (1 << 5) 
#define PL050_CR_RXINTREN   (1 << 4) 
#define PL050_CR_TXINTREN   (1 << 3) 
#define PL050_CR_EN (1 << 2) 
#define PL050_CR_FDL    (1 << 1) 
#define PL050_CR_FCL    (1 << 0) 

#define PL050_STAT_TXEMPTY  (1 << 6) 
#define PL050_STAT_TXBUSY   (1 << 5) 
#define PL050_STAT_RXFULL   (1 << 4) 
#define PL050_STAT_RXBUSY   (1 << 3) 
#define PL050_STAT_RXPARITY (1 << 2) 
#define PL050_STAT_IC   (1 << 1) 
#define PL050_STAT_ID   (1 << 0) 

#define PL050_IIR_TXINTR    (1 << 1) 
#define PL050_IIR_RXINTR    (1 << 0) 

typedef struct _PL050_KMI_REGISTERS PL050_KMI_REGISTERS;
struct _PL050_KMI_REGISTERS
{
    uint32_t cr; 
    uint32_t stat; 
    uint32_t data; 
    uint32_t clkdiv; 
    uint32_t iir; 
};
 
 
typedef struct _PL050_KEYBOARD PL050_KEYBOARD;
 
typedef struct _PL050_KEYBOARD_SCANCODE PL050_KEYBOARD_SCANCODE;
struct _PL050_KEYBOARD_SCANCODE
{
    PL050_KEYBOARD *keyboard;
    uint32_t count;
    int32_t index;
    PS2_KEYBOARD_SCANCODE scancode;
};
 
 
struct _PL050_KEYBOARD
{
    // Keyboard Properties
    KEYBOARD_DEVICE keyboard;
    // PL050 Properties
    uint32_t irq;
    PL050_KMI_REGISTERS *registers; 
    uint8_t scancodeset; 
    PL050_KEYBOARD_SCANCODE scancodedata[PL050_KEYBOARD_SCANCODE_COUNT]; 
    uint32_t scancodestart; 
    uint32_t scancodecount; 
    uint16_t lastcode; 
    uint32_t shiftstate; 
    // Statistics Properties
    uint32_t discardcount; 
    uint32_t interruptcount; 
};
 
 
typedef struct _PL050_MOUSE PL050_MOUSE;
 
typedef struct _PL050_MOUSE_PACKET PL050_MOUSE_PACKET;
struct _PL050_MOUSE_PACKET
{
    PL050_MOUSE *mouse;
    uint32_t count;
    PL050_MOUSE_PACKET packet;
};
 
 
struct _PL050_MOUSE
{
    // Mouse Properties
    MOUSE_DEVICE mouse;
    // PL050 Properties
    uint32_t irq;
    PL050_KMI_REGISTERS *registers; 
    PL050_MOUSE_PACKET packetdata[PL050_MOUSE_PACKET_COUNT]; 
    uint32_t packetstart; 
    uint32_t packetcount; 
    // Statistics Properties
    uint32_t discardcount; 
    uint32_t interruptcount; 
};


KEYBOARD_DEVICE * STDCALL pl050_keyboard_create(size_t address, char *name, uint32_t irq, uint32_t clockrate);

uint32_t STDCALL pl050_keyboard_destroy(KEYBOARD_DEVICE *keyboard);

MOUSE_DEVICE * STDCALL pl050_mouse_create(size_t address, char *name, uint32_t irq, uint32_t clockrate);

uint32_t STDCALL pl050_mouse_destroy(MOUSE_DEVICE *mouse);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_PL050_H