-
Notifications
You must be signed in to change notification settings - Fork 11
/
ps2serial.ino
425 lines (361 loc) · 10.3 KB
/
ps2serial.ino
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
/* PS2SERIAL - PS/2 to Serial mouse converter firmware
* 2018 Meido-Tek Productions (Lameguy64)
* Version 1.2
*
* This sketch is for a PS/2 to Serial mouse converter circuit that would allow the use of
* a modern PS/2 laser mouse on a vintage PC that does not support PS/2. Essentially a very
* reliable and cost effective alternative to getting an original serial mouse.
*
* This sketch requires the PS2Mouse library by Kristopher on Github:
* https://github.com/kristopher/PS2-Mouse-Arduino
*
* The schematic for the converter should be included along with this file.
*
* Usage Instructions:
* - Upload this sketch to your converter's Arduino.
* - If PS/2 mouse is wired correctly, the L13 light should flash 4 times on start-up.
* - After the blink sequence, the converter should be detected by your vintage PC as a
* 3-button Logitech mouse.
* - L13 light will blink every time the mouse driver tries to initialize the mouse (by
* toggling RTS) to indicate that the converter is working properly and the mouse driver
* should recognize it as a 3-button Logitech mouse.
*
* Fixes in 1.2:
* - Made code changes to allow sketch to be compiled for Arduinos with single hardware
* UARTs (such as Arduino Nanos, I didn't know about that beforehand).
* - Switched to Microsoft 3-button mouse protocol which solves laggy mouse issue when
* middle button is held down. Logitech protocol can be re-enabled by commenting out a
* line though.
*
* Fixes in 1.1:
* - Fixed mouse button handling issues that made certain mouse operations (such as
* double-click) not work correctly.
*
* Known bugs/issues so far:
* - There might be some slight input lag with the mouse movement. Might be because the
* Arduino is not fast enough (tested on a Leonardo with a ATmega 32u4).
* - Mouse input becomes choppy while holding down the middle button due to
* the added delay of sending 4 byte packets for the 3rd button status instead of 3
* byte packets.
*
* As always, feel free to improve upon this chode and issue a pull request to merge with
* the main repository.
*/
#include <PS2Mouse.h>
/* Pin settings, feel free to change to what you find most convenient to use.
*
* Serial data will always be transmitted in Pin 2 (Tx) of the Arduino but you must
* connect it through a 74LS00 to invert the logic levels so the PC serial can
* understand it. No MAX-232 required as 5v is enough to drive most serial interfaces.
*/
#define PS2_MOUSE_CLOCK 2 /* Must connect to Pin 5 (clock) of PS/2 mouse */
#define PS2_MOUSE_DATA 4 /* Must connect to Pin 1 (data) of PS/2 mouse */
#define RTS_PROBE 7 /* Must connect to Pin 7 (RTS) of PC serial port */
/* (NOTE: must go through a 5v regulator and */
/* 200ohm resistor first or you'll blow the pin) */
/* Uncomment to use Logitech serial mouse protocol. Not exactly recommended as holding
* down the middle button will cause choppy mouse movement while the Microsoft protocol
* does not but the option is still here to those who want to use Logitech protocol.
*/
#define USE_MS_PROTOCOL
/* Uncomment to use Serial1 class instead of Serial for Arduinos with dual
* hardware UARTS. If commented, Serial class is used to send mouse data for Arduinos
* with a single UART.
*/
//#define USE_SERIAL1
/* Uncomment to enable debug messages over USB serial (serial monitor must be active).
* Debug messages are sent using the Serial class. Don't uncomment for Arduinos with a
* single hardware UART.
*/
//#define DEBUG
/* Status variables for keeping track of button/probe states */
bool left_status = false;
bool right_status = false;
bool middle_status = false;
bool rts_status = false;
int x_status = 0;
int y_status = 0;
/* Class from PS2Mouse for reading PS/2 mouse data */
PS2Mouse mouse( PS2_MOUSE_CLOCK, PS2_MOUSE_DATA, STREAM );
/* Serial mouse packet encoding routine */
/* Encodes a 3 byte mouse packet that complies with Microsoft Mouse/Logitech protocol */
void encodePacket(int x, int y, bool lb, bool rb, unsigned char* output)
{
/* Cap values just in case to avoid overflow errors */
if ( x > 127 )
{
x = 127;
}
else if ( x < -127 )
{
x = -127;
}
if ( y > 127 )
{
y = 127;
}
else if ( y < -127 )
{
y = -127;
}
char cx = x;
char cy = y;
/* Packet 0 */
output[0] = ((cx>>6)&0x3) | /* last 2 bits of X */
(((cy>>6)&0x3)<<2) | /* Last 2 bits of Y */
(rb<<4)|(lb<<5)|0x40; /* Mouse buttons and start packet bit */
output[1] = cx&0x3f; /* Packet 1 ( first 6 bits of X ) */
output[2] = cy&0x3f; /* Packet 2 ( first 6 bits of Y ) */
}
void setup()
{
/* Set pin for RTS probe as input */
pinMode( RTS_PROBE, INPUT );
/* For blinking L13 LED */
pinMode( 13, OUTPUT );
digitalWrite( 13, LOW );
#ifdef DEBUG
/* Init serial for debug messages */
Serial.begin( 115200 );
while( !Serial )
{
/* Wait for USB serial to be ready (monitor active) */
}
Serial.print( "Init mouse\n" );
#endif
/* Initialize PS/2 mouse */
mouse.initialize();
mouse.set_sample_rate( 200 );
mouse.set_scaling_1_1();
/* Initialize serial for mouse data */
#ifdef USE_SERIAL1
Serial1.begin( 1200, SERIAL_7N1 );
#else
Serial.begin( 1200, SERIAL_7N1 );
#endif
#ifdef DEBUG
Serial.print("Program start!\n");
#endif
/* Flash LED to indicate adapter is ready */
delay( 500 );
for ( int i=0; i<4; i++ )
{
digitalWrite( 13, HIGH );
delay( 200 );
digitalWrite( 13, LOW );
delay( 200 );
}
}
void loop()
{
short event = false;
short event_mb = false;
short left_changed = false;
short right_changed = false;
short middle_changed = false;
int data[2];
unsigned char packet[4];
int p_count = 3;
/* Read mouse data 4 times as PS/2 is too fast for serial */
for(int i=0; i<4; i++)
{
mouse.report( data );
x_status += data[1];
y_status += -data[2];
/* Check mouse events */
if ( !left_changed )
{
if ( data[0] & 0x1 ) /* Left mouse button */
{
if ( !left_status )
{
event = true;
left_status = true;
left_changed = true;
}
}
else
{
if ( left_status )
{
event = true;
left_status = false;
left_changed = true;
}
}
}
if ( !right_changed )
{
if ( data[0] & 0x2 ) /* Right mouse button */
{
if ( !right_status )
{
event = true;
right_status = true;
right_changed = true;
}
}
else
{
if ( right_status )
{
event = true;
right_status = false;
right_changed = true;
}
}
}
if ( !middle_changed )
{
if ( data[0] & 0x4 ) /* Middle mouse button */
{
if (!middle_status)
{
#ifndef USE_MS_PROTOCOL
event = true;
event_mb = true;
#endif
middle_status = true;
middle_changed = true;
}
/* To compensate for the additional delay from sending 4 byte packets instead of 3 */
#ifndef USE_MS_PROTOCOL
mouse.report( data );
mouse.report( data );
#endif
}
else
{
if ( middle_status )
{
#ifndef USE_MS_PROTOCOL
event = true;
event_mb = true;
#endif
middle_status = false;
middle_changed = true;
}
}
}
}
/* Divide velocity values to smoothen the movement */
int x_status_d = x_status / 2;
int y_status_d = y_status / 2;
/* Reset X Y counters when divided result is non-zero */
if ( x_status_d != 0 )
{
x_status = 0;
event = true;
}
if ( y_status_d != 0 )
{
y_status = 0;
event = true;
}
/* Send mouse events if there's any */
if ( event )
{
#ifdef DEBUG
Serial.print( "LB:" );
Serial.print( left_status );
Serial.print( " RB:" );
Serial.print( right_status );
Serial.print( " MB:" );
Serial.print( middle_status );
Serial.print( " X:" );
Serial.print( x_status );
Serial.print( " Y:" );
Serial.print( y_status );
Serial.println();
#endif
/* Encode the packet */
encodePacket( x_status_d, y_status_d,
left_status, right_status, packet );
/* Send extra byte for the middle mouse button status */
#ifndef USE_MS_PROTOCOL
if ( middle_status )
{
/* Keep sending 4th byte as long as middle button is down */
#ifdef DEBUG
Serial.print("MB is down.\n");
#endif
packet[3] = 0x20;
p_count = 4;
}
else
{
/* 4th byte is sent once when middle button is lifted */
if ( event_mb )
{
#ifdef DEBUG
Serial.print("MB had been lifted.\n");
#endif
packet[3] = 0x0;
p_count = 4;
}
}
#endif
/* Send packet */
#ifdef USE_SERIAL1
Serial1.write( packet, p_count );
#else
Serial.write( packet, p_count );
#endif
}
#ifdef USE_MS_PROTOCOL
// Send blank packet for middle mouse status
if ( middle_changed )
{
packet[0] = 0x40;
packet[1] = 0x00;
packet[2] = 0x00;
p_count = 3;
#ifdef USE_SERIAL1
Serial1.write( packet, p_count );
#else
Serial.write( packet, p_count );
#endif
}
#endif
/* Send init bytes when RTS has been toggled */
if ( digitalRead( RTS_PROBE ) )
{
if ( !rts_status )
{
#ifdef DEBUG
Serial.print("Send init byte!\n");
#endif
delay(14);
#ifdef USE_SERIAL1
Serial1.write( 'M' );
#else
Serial.write( 'M' );
#endif
delay(63);
#ifndef USE_MS_PROTOCOL
#ifdef USE_SERIAL1
Serial1.write( '3' );
#else
Serial.write( '3' );
#endif
/*#else
#ifdef USE_SERIAL1
Serial1.write( '3' );
#else
Serial.write( '3' );
#endif*/
#endif
left_status = false;
right_status = false;
middle_status = false;
rts_status = true;
digitalWrite( 13, HIGH );
delay( 500 );
digitalWrite( 13, LOW );
}
}
else
{
rts_status = false;
}
}