di0ib/tmk_keyboard_custom
Archived
1
0
Fork 0
Code Releases Activity

Add ps2_busywait.c and recfactor PS/2 protocol

Browse Source
This commit is contained in:
tmk 2013-11-25 17:43:26 +09:00
parent 06681b0ab9
commit 084bdb977e
4 changed files with 342 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
protocol.mk
View File

@ -8,7 +8,7 @@ ifdef PS2_MOUSE_ENABLE
endif endif
ifdef PS2_USE_BUSYWAIT ifdef PS2_USE_BUSYWAIT
SRC += protocol/ps2.c SRC += protocol/ps2_busywait.c
OPT_DEFS += -DPS2_USE_BUSYWAIT OPT_DEFS += -DPS2_USE_BUSYWAIT
endif endif

65
protocol/ps2.c
View File

@ -91,6 +91,9 @@ uint8_t ps2_error = PS2_ERR_NONE;
void ps2_host_init(void) void ps2_host_init(void)
{ {
// POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20)
_delay_ms(2500);
#ifdef PS2_USE_INT #ifdef PS2_USE_INT
PS2_INT_INIT(); PS2_INT_INIT();
PS2_INT_ON(); PS2_INT_ON();
@ -163,23 +166,11 @@ ERROR:
/* receive data when host want else inhibit communication */ /* receive data when host want else inhibit communication */
uint8_t ps2_host_recv_response(void) uint8_t ps2_host_recv_response(void)
{ {
// Command might take 20ms to response([3]p.21)
// TrackPoint might take 25ms ([5]2.7)
uint8_t data = 0; uint8_t data = 0;
uint8_t try = 200;
#ifdef PS2_USE_INT while (try-- && (data = ps2_host_recv())) ;
PS2_INT_OFF();
#endif
/* terminate a transmission if we have */
inhibit();
_delay_us(100);
/* release lines(idle state) */
idle();
/* wait start bit */
wait_clock_lo(25000); // command response may take 20 ms at most
data = recv_data();
inhibit();
return data; return data;
} }
#endif #endif
@ -187,7 +178,17 @@ uint8_t ps2_host_recv_response(void)
#ifndef PS2_USE_INT #ifndef PS2_USE_INT
uint8_t ps2_host_recv(void) uint8_t ps2_host_recv(void)
{ {
return ps2_host_recv_response(); uint8_t data = 0;
/* release lines(idle state) */
idle();
/* wait start bit */
wait_clock_lo(100); // TODO: this is enough?
data = recv_data();
inhibit();
return data;
} }
#else #else
/* ring buffer to store ps/2 key data */ /* ring buffer to store ps/2 key data */
@ -241,13 +242,6 @@ static inline void pbuf_clear(void)
/* get data received by interrupt */ /* get data received by interrupt */
uint8_t ps2_host_recv(void) uint8_t ps2_host_recv(void)
{ {
if (ps2_error) {
print("x");
phex(ps2_error);
ps2_host_send(0xFE); // request to resend
ps2_error = PS2_ERR_NONE;
}
idle();
return pbuf_dequeue(); return pbuf_dequeue();
} }
@ -450,3 +444,26 @@ static inline void inhibit(void)
clock_lo(); clock_lo();
data_hi(); data_hi();
} }
/* PS/2 Resources
*
* [1] The PS/2 Mouse/Keyboard Protocol
* http://www.computer-engineering.org/ps2protocol/
* Concise and thorough primer of PS/2 protocol.
*
* [2] Keyboard and Auxiliary Device Controller
* http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
* Signal Timing and Format
*
* [3] Keyboards(101- and 102-key)
* http://www.mcamafia.de/pdf/ibm_hitrc11.pdf
* Keyboard Layout, Scan Code Set, POR, and Commands.
*
* [4] PS/2 Reference Manuals
* http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
* Collection of IBM Personal System/2 documents.
*
* [5] TrackPoint Engineering Specifications for version 3E
* https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
*/

142
protocol/ps2.h
View File

@ -1,5 +1,5 @@
/* /*
Copyright 2010,2011 Jun WAKO <wakojun@gmail.com> Copyright 2010,2011,2012,2013 Jun WAKO <wakojun@gmail.com>
This software is licensed with a Modified BSD License. This software is licensed with a Modified BSD License.
All of this is supposed to be Free Software, Open Source, DFSG-free, All of this is supposed to be Free Software, Open Source, DFSG-free,
@ -37,12 +37,60 @@ POSSIBILITY OF SUCH DAMAGE.
#ifndef PS2_H #ifndef PS2_H
#define PS2_H #define PS2_H
#include <stdbool.h>
#include <util/delay.h>
#include <avr/io.h>
/* /*
* Primitive PS/2 Library for AVR * Primitive PS/2 Library for AVR
*
* PS/2 Resources
* --------------
* [1] The PS/2 Mouse/Keyboard Protocol
* http://www.computer-engineering.org/ps2protocol/
* Concise and thorough primer of PS/2 protocol.
*
* [2] Keyboard and Auxiliary Device Controller
* http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
* Signal Timing and Format
*
* [3] Keyboards(101- and 102-key)
* http://www.mcamafia.de/pdf/ibm_hitrc11.pdf
* Keyboard Layout, Scan Code Set, POR, and Commands.
*
* [4] PS/2 Reference Manuals
* http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
* Collection of IBM Personal System/2 documents.
*
* [5] TrackPoint Engineering Specifications for version 3E
* https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
*/ */
#define PS2_ACK 0xFA
#define PS2_RESEND 0xFE
#define PS2_SET_LED 0xED
#define PS2_ERR_NONE 0
#define PS2_ERR_STARTBIT1 1
#define PS2_ERR_STARTBIT2 2
#define PS2_ERR_STARTBIT3 3
#define PS2_ERR_PARITY 0x10
#define PS2_LED_SCROLL_LOCK 0
#define PS2_LED_NUM_LOCK 1
#define PS2_LED_CAPS_LOCK 2
/* port settings for clock and data line */ extern uint8_t ps2_error;
void ps2_host_init(void);
uint8_t ps2_host_send(uint8_t data);
uint8_t ps2_host_recv_response(void);
uint8_t ps2_host_recv(void);
void ps2_host_set_led(uint8_t usb_led);
/* Check port settings for clock and data line */
#if !(defined(PS2_CLOCK_PORT) && \ #if !(defined(PS2_CLOCK_PORT) && \
defined(PS2_CLOCK_PIN) && \ defined(PS2_CLOCK_PIN) && \
defined(PS2_CLOCK_DDR) && \ defined(PS2_CLOCK_DDR) && \
@ -57,27 +105,79 @@ POSSIBILITY OF SUCH DAMAGE.
# error "PS/2 data port setting is required in config.h" # error "PS/2 data port setting is required in config.h"
#endif #endif
#define PS2_ACK 0xFA /*--------------------------------------------------------------------
#define PS2_RESEND 0xFE * static functions
#define PS2_SET_LED 0xED *------------------------------------------------------------------*/
static inline void clock_lo(void)
{
PS2_CLOCK_PORT &= ~(1<<PS2_CLOCK_BIT);
PS2_CLOCK_DDR |= (1<<PS2_CLOCK_BIT);
}
static inline void clock_hi(void)
{
/* input with pull up */
PS2_CLOCK_DDR &= ~(1<<PS2_CLOCK_BIT);
PS2_CLOCK_PORT |= (1<<PS2_CLOCK_BIT);
}
static inline bool clock_in(void)
{
PS2_CLOCK_DDR &= ~(1<<PS2_CLOCK_BIT);
PS2_CLOCK_PORT |= (1<<PS2_CLOCK_BIT);
_delay_us(1);
return PS2_CLOCK_PIN&(1<<PS2_CLOCK_BIT);
}
static inline void data_lo(void)
{
PS2_DATA_PORT &= ~(1<<PS2_DATA_BIT);
PS2_DATA_DDR |= (1<<PS2_DATA_BIT);
}
static inline void data_hi(void)
{
/* input with pull up */
PS2_DATA_DDR &= ~(1<<PS2_DATA_BIT);
PS2_DATA_PORT |= (1<<PS2_DATA_BIT);
}
static inline bool data_in(void)
{
PS2_DATA_DDR &= ~(1<<PS2_DATA_BIT);
PS2_DATA_PORT |= (1<<PS2_DATA_BIT);
_delay_us(1);
return PS2_DATA_PIN&(1<<PS2_DATA_BIT);
}
#define PS2_ERR_NONE 0 static inline uint16_t wait_clock_lo(uint16_t us)
#define PS2_ERR_PARITY 0x10 {
while (clock_in() && us) { asm(""); _delay_us(1); us--; }
return us;
}
static inline uint16_t wait_clock_hi(uint16_t us)
{
while (!clock_in() && us) { asm(""); _delay_us(1); us--; }
return us;
}
static inline uint16_t wait_data_lo(uint16_t us)
{
while (data_in() && us) { asm(""); _delay_us(1); us--; }
return us;
}
static inline uint16_t wait_data_hi(uint16_t us)
{
while (!data_in() && us) { asm(""); _delay_us(1); us--; }
return us;
}
#define PS2_LED_SCROLL_LOCK 0 /* idle state that device can send */
#define PS2_LED_NUM_LOCK 1 static inline void idle(void)
#define PS2_LED_CAPS_LOCK 2 {
clock_hi();
data_hi();
}
/* inhibit device to send */
extern uint8_t ps2_error; static inline void inhibit(void)
{
/* host role */ clock_lo();
void ps2_host_init(void); data_hi();
uint8_t ps2_host_send(uint8_t data); }
uint8_t ps2_host_recv_response(void);
uint8_t ps2_host_recv(void);
void ps2_host_set_led(uint8_t usb_led);
/* device role */
#endif #endif

179
protocol/ps2_busywait.c Normal file
View File

@ -0,0 +1,179 @@
/*
Copyright 2010,2011,2012,2013 Jun WAKO <wakojun@gmail.com>
This software is licensed with a Modified BSD License.
All of this is supposed to be Free Software, Open Source, DFSG-free,
GPL-compatible, and OK to use in both free and proprietary applications.
Additions and corrections to this file are welcome.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of the copyright holders nor the names of
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#include <stdbool.h>
#include <util/delay.h>
#include "ps2.h"
#include "debug.h"
/*
* PS/2 protocol busywait version
*/
#define WAIT(stat, us, err) do { \
if (!wait_##stat(us)) { \
ps2_error = err; \
goto ERROR; \
} \
} while (0)
uint8_t ps2_error = PS2_ERR_NONE;
void ps2_host_init(void)
{
// POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20)
_delay_ms(2500);
inhibit();
}
uint8_t ps2_host_send(uint8_t data)
{
uint8_t res = 0;
bool parity = true;
ps2_error = PS2_ERR_NONE;
/* terminate a transmission if we have */
inhibit();
_delay_us(200); // at least 100us
/* start bit [1] */
data_lo();
clock_hi();
WAIT(clock_lo, 20000, 10); // may take 15ms at most until device starts clocking
/* data [2-9] */
for (uint8_t i = 0; i < 8; i++) {
_delay_us(15);
if (data&(1<<i)) {
parity = !parity;
data_hi();
} else {
data_lo();
}
WAIT(clock_hi, 50, 2);
WAIT(clock_lo, 50, 3);
}
/* parity [10] */
_delay_us(15);
if (parity) { data_hi(); } else { data_lo(); }
WAIT(clock_hi, 50, 4);
WAIT(clock_lo, 50, 5);
/* stop bit [11] */
_delay_us(15);
data_hi();
/* ack [12] */
WAIT(data_lo, 50, 6);
WAIT(clock_lo, 50, 7);
/* wait for idle state */
WAIT(clock_hi, 50, 8);
WAIT(data_hi, 50, 9);
res = ps2_host_recv_response();
ERROR:
inhibit();
return res;
}
/* receive data when host want else inhibit communication */
uint8_t ps2_host_recv_response(void)
{
// TODO:
// Command might take 20ms to response([3]p.21)
// TrackPoint might take 25ms ([5]2.7)
uint8_t data = 0;
uint8_t try = 200;
while (try-- && (data = ps2_host_recv())) ;
return data;
}
/* send LED state to keyboard */
void ps2_host_set_led(uint8_t led)
{
ps2_host_send(0xED);
ps2_host_send(led);
}
/* called after start bit comes */
uint8_t ps2_host_recv(void)
{
uint8_t data = 0;
bool parity = true;
ps2_error = PS2_ERR_NONE;
/* release lines(idle state) */
idle();
/* start bit [1] */
WAIT(clock_lo, 100, 1); // TODO: this is enough?
WAIT(data_lo, 1, 2);
WAIT(clock_hi, 50, 3);
/* data [2-9] */
for (uint8_t i = 0; i < 8; i++) {
WAIT(clock_lo, 50, 4);
if (data_in()) {
parity = !parity;
data |= (1<<i);
}
WAIT(clock_hi, 50, 5);
}
/* parity [10] */
WAIT(clock_lo, 50, 6);
if (data_in() != parity) {
ps2_error = PS2_ERR_PARITY;
goto ERROR;
}
WAIT(clock_hi, 50, 7);
/* stop bit [11] */
WAIT(clock_lo, 50, 8);
WAIT(data_hi, 1, 9);
WAIT(clock_hi, 50, 10);
inhibit();
return data;
ERROR:
if (ps2_error > PS2_ERR_STARTBIT3) {
printf("x%02X\n", ps2_error);
}
inhibit();
return 0;
}