Pmod PS2 Reference Manual
The Digilent Pmod PS/2 (Revision C) is a module that allows users to attach a PS/2 compatible keyboard or mouse to their system board.
Download This Reference Manual
- Standard PS/2 port
- Jumper to allow for an external power source
- 6-pin Pmod connector with GPIO interface
The Pmod PS/2 module is a standard PS/2 connector that by nature of the PS/2 supports N-KEY rollover. This is a feature that guarantees that every movement and key press will be received and addressed. Naturally, whether or not the key press will actually perform a function is dependent on the software, but the system board will still receive all of the inputs.
Interfacing with the Pmod
The Pmod PS/2 communicates with the host board via the GPIO protocol. Both the keyboard and mouse will use a data and a clock line to communicate their information to the system board. Specific details on how this is done are available in their respective sections below.
Pin Description Table
|Header J2 (Pmod)||Header J1 (PS2)||JP1|
|1||Data||Data Communication Line||1||Data||Data Communication Line||VB-VCC||PS2 connector receives positive power supply from host board|
|2||Data-||Data Communication Line (generally unused)||2||Data-||Data Communication Line (generally unused)||VE-VCC||PS2 connector receives positive power supply from external power source|
|3||Clock||Serial Clock||3||GND||Power Supply Ground||JP2|
|4||Clock-||Serial Clock (generally unused)||4||VCC||Positive Power Supply||Pin||Signal||Description|
|5||GND||Power Supply Ground||5||Clock||Serial Clock||1||VE*||Positive External Power Supply Input*|
|6||VB||Positive Power Supply from Host Board||6||Clock-||Serial Clock (generally unused)||2||GND*||Power Supply Ground*|
Keyboard and Mouse Interface
The keyboard and mouse both use identical signal timings. Both use 11-bit words that include a start, stop, and odd parity bit, but the data packets are organized differently, and the keyboard interface allows bi-directional data transfers (so the host device can illuminate state LEDs on the keyboard). Bus timings are shown below. The clock and data signals are only driven when data transfers occur, and otherwise they are held in the “idle” state at logic ‘1’. The timings define signal requirements for mouse-to-host communications and bi-directional keyboard communications.
|Tsu||Data-to-clock setup time||5us||25us|
|Thld||Clock-to-data hold time||5us||25us|
The keyboard uses open-collector drivers so that either the keyboard or an attached host device can drive the two-wire bus (if the host device will not send data to the keyboard, then the host can use simple input-only ports).
PS/2-style keyboards use scan codes to communicate key-press data (nearly all keyboards in use today are PS/2 style). Each key has a single, unique scan code that is sent whenever the corresponding key is pressed. If the key is pressed and held, the scan code will be sent repeatedly once every 100ms or so. When a key is released, an “F0” key-up code is sent, followed by the scan code of the released key. If a key can be “shifted” to produce a new character (like a capital letter), then a shift character is sent in addition to the original scan code, and the host device must determine which character to use. Some keys, called extended keys, send an “E0” ahead of the scan code (and they may send more than one scan code). When an extended key is released, an “E0 F0” key-up code is sent, followed by the scan code. Scan codes for most keys are shown in the keyboard diagram below.
A host device can also send data to the keyboard. Below is a short list of some oft-used commands.
|ED||Set Num Lock, Caps Lock, and Scroll Lock LEDs. After receiving an “ED”, the keyboard returns an “FA”, then the host sends a byte to set LED status. Bit 0 sets Scroll Lock, bit 1 sets Num Lock; and Bit 2 sets Caps lock. Bits 3 to 7 are ignored.|
|EE||Echo. Upon receiving an echo command, the keyboard replies with “EE”.|
|F3||Set scan code repeat rate. The keyboard acknowledges receipt of an “F3” by returning an “FA”, after which the host sends a second byte|
|FE||Resend. Upon recieving FE, the keyboard re-sends the last scan code sent.|
|FF||Reset. Resets the keyboard.|
The keyboard sends data to the host only when both the data and clock lines are high (or idle). Since the host is the “bus master”, the keyboard checks to see whether the host is sending data before driving the bus. To facilitate this, the clock line can be used as a “clear to send” signal. If the host pulls the clock line low, the keyboard will not send any data until the clock is released.
The keyboard sends data to the host in 11-bit words that contain a ‘0’ start bit, followed by 8-bits of scan code (LSB first), followed by an odd parity bit and terminated with a ‘1’ stop bit. The keyboard generates 11 clock transitions (at around 20 - 30KHz) when the data is sent, and data is valid on the falling edge of the clock.
The mouse outputs a clock and data signal when it is moved, otherwise these signals remain at logic ‘1’. Each time the mouse is moved, three 11-bit words are sent from the mouse to the host device. Each of the 11-bit words contains a ‘0’ start bit, followed by 8 bits of data (LSB first), followed by an odd parity bit, and terminated with a ‘1’ stop bit. Thus, each data transmission contains 33 bits, where bits 0, 11, and 22 are ‘0’ start bits, and bits 11, 21, and 33 are ‘1’ stop bits. The three 8-bit data fields contain movement data as shown below. Data is valid at the falling edge of the clock, and the clock period is 20 to 30KHz.
The mouse assumes a relative coordinate system wherein moving the mouse to the right generates a positive number in the X field, and moving to the left generates a negative number. Likewise, moving the mouse up generates a positive number in the Y field, and moving down represents a negative number (the XS and YS bits in the status byte are the sign bits – a ‘1’ indicates a negative number). The magnitude of the X and Y numbers represent the rate of mouse movement – the larger the number, the faster the mouse is moving (the XV and YV bits in the status byte are movement overflow indicators – a ‘1’ means overflow has occurred). If the mouse moves continuously, the 33-bit transmissions are repeated every 50ms or so. The L and R fields in the status byte indicate Left and Right button presses (a ‘1’ indicates the button is being pressed).
The pins on the pin header are spaced 100 mil apart. The PCB is 1 inch long on the sides parallel to the pins on the pin header and 0.8 inches long on the sides perpendicular to the pin header.
The schematics of the Pmod PS/2 are available here. Before applying external power to the keyboard or mouse, check to see what the voltage rating of the component is, typically 3.3V or 5V, in order to ensure that the component is not damaged.
Example code demonstrating how to get information from the Pmod PS/2 can be found here.
If you have any questions or comments about the Pmod PS/2, feel free to post them under the appropriate section (“Add-on Boards”) of the Digilent Forum.