tmk_core/protocol/ibmpc.c

   1 /*
   2 Copyright 2010,2011,2012,2013,2019 Jun WAKO <wakojun@gmail.com>
   3
   4 This software is licensed with a Modified BSD License.
   5 All of this is supposed to be Free Software, Open Source, DFSG-free,
   6 GPL-compatible, and OK to use in both free and proprietary applications.
   7 Additions and corrections to this file are welcome.
   8
   9
  10 Redistribution and use in source and binary forms, with or without
  11 modification, are permitted provided that the following conditions are met:
  12
  13 * Redistributions of source code must retain the above copyright
  14   notice, this list of conditions and the following disclaimer.
  15
  16 * Redistributions in binary form must reproduce the above copyright
  17   notice, this list of conditions and the following disclaimer in
  18   the documentation and/or other materials provided with the
  19   distribution.
  20
  21 * Neither the name of the copyright holders nor the names of
  22   contributors may be used to endorse or promote products derived
  23   from this software without specific prior written permission.
  24
  25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  29 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 POSSIBILITY OF SUCH DAMAGE.
  36 */
  37
  38 /*
  39  * IBM PC keyboard protocol
  40  */
  41
  42 #include <stdbool.h>
  43 #include <avr/interrupt.h>
  44 #include <util/atomic.h>
  45 #include "ibmpc.h"
  46 #include "debug.h"
  47 #include "timer.h"
  48 #include "wait.h"
  49
  50
  51 #define WAIT(stat, us, err) do { \
  52     if (!wait_##stat(us)) { \
  53         ibmpc_error = err; \
  54         goto ERROR; \
  55     } \
  56 } while (0)
  57
  58
  59 volatile uint16_t ibmpc_isr_debug = 0;
  60 volatile uint8_t ibmpc_protocol = IBMPC_PROTOCOL_NO;
  61 volatile uint8_t ibmpc_error = IBMPC_ERR_NONE;
  62
  63 /* 2-byte buffer for data received from keyboard
  64  * buffer states:
  65  *      FFFF: empty
  66  *      FFss: one data
  67  *      sstt: two data
  68  *      eeFF: error
  69  * where ss, tt and ee are 0x00-0xFE. 0xFF means empty or no data in buffer.
  70  */
  71 static volatile uint16_t recv_data = 0xFFFF;
  72 /* internal state of receiving data */
  73 static volatile uint16_t isr_state = 0x8000;
  74 static uint8_t timer_start = 0;
  75
  76 void ibmpc_host_init(void)
  77 {
  78     // initialize reset pin to HiZ
  79     IBMPC_RST_HIZ();
  80     inhibit();
  81     IBMPC_INT_INIT();
  82     IBMPC_INT_OFF();
  83 }
  84
  85 void ibmpc_host_enable(void)
  86 {
  87     IBMPC_INT_ON();
  88     idle();
  89 }
  90
  91 void ibmpc_host_disable(void)
  92 {
  93     IBMPC_INT_OFF();
  94     inhibit();
  95 }
  96
  97 int16_t ibmpc_host_send(uint8_t data)
  98 {
  99     bool parity = true;
 100     ibmpc_error = IBMPC_ERR_NONE;
 101
 102     dprintf("w%02X ", data);
 103
 104     IBMPC_INT_OFF();
 105
 106     /* terminate a transmission if we have */
 107     inhibit();
 108     wait_us(100); // 100us [4]p.13, [5]p.50
 109
 110     /* 'Request to Send' and Start bit */
 111     data_lo();
 112     wait_us(100);
 113     clock_hi();
 114     WAIT(clock_lo, 10000, 1);   // 10ms [5]p.50
 115
 116     /* Data bit[2-9] */
 117     for (uint8_t i = 0; i < 8; i++) {
 118         wait_us(15);
 119         if (data&(1<<i)) {
 120             parity = !parity;
 121             data_hi();
 122         } else {
 123             data_lo();
 124         }
 125         WAIT(clock_hi, 50, 2);
 126         WAIT(clock_lo, 50, 3);
 127     }
 128
 129     /* Parity bit */
 130     wait_us(15);
 131     if (parity) { data_hi(); } else { data_lo(); }
 132     WAIT(clock_hi, 50, 4);
 133     WAIT(clock_lo, 50, 5);
 134
 135     /* Stop bit */
 136     wait_us(15);
 137     data_hi();
 138
 139     /* Ack */
 140     WAIT(data_lo, 50, 6);
 141     WAIT(clock_lo, 50, 7);
 142
 143     /* wait for idle state */
 144     WAIT(clock_hi, 50, 8);
 145     WAIT(data_hi, 50, 9);
 146
 147     // clear buffer to get response correctly
 148     recv_data = 0xFFFF;
 149     ibmpc_host_isr_clear();
 150
 151     idle();
 152     IBMPC_INT_ON();
 153     return ibmpc_host_recv_response();
 154 ERROR:
 155     ibmpc_error |= IBMPC_ERR_SEND;
 156     idle();
 157     IBMPC_INT_ON();
 158     return -1;
 159 }
 160
 161 /*
 162  * Receive data from keyboard
 163  */
 164 int16_t ibmpc_host_recv(void)
 165 {
 166     uint16_t data = 0;
 167     uint8_t ret = 0xFF;
 168
 169     ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
 170         data = recv_data;
 171
 172         // remove data from buffer:
 173         // FFFF(empty)      -> FFFF
 174         // FFss(one data)   -> FFFF
 175         // sstt(two data)   -> FFtt
 176         // eeFF(errror)     -> FFFF
 177         recv_data = data | (((data&0xFF00) == 0xFF00) ? 0x00FF : 0xFF00);
 178     }
 179
 180     if ((data&0x00FF) == 0x00FF) {
 181         // error: eeFF
 182         switch (data>>8) {
 183             case IBMPC_ERR_FF:
 184                 // 0xFF(Overrun/Error) from keyboard
 185                 dprintf("!FF! ");
 186                 ret = 0xFF;
 187                 break;
 188             case IBMPC_ERR_FULL:
 189                 // buffer full
 190                 dprintf("!FULL! ");
 191                 ret = 0xFF;
 192                 break;
 193             case 0xFF:
 194                 // empty: FFFF
 195                 return -1;
 196             default:
 197                 // other errors
 198                 dprintf("e%02X ", data>>8);
 199                 return -1;
 200         }
 201     } else {
 202         if ((data | 0x00FF) != 0xFFFF) {
 203             // two data: sstt
 204             dprintf("b:%04X ", data);
 205             ret = (data>>8);
 206         } else {
 207             // one data: FFss
 208             ret = (data&0x00FF);
 209         }
 210     }
 211
 212     //dprintf("i%04X ", ibmpc_isr_debug); ibmpc_isr_debug = 0;
 213     dprintf("r%02X ", ret);
 214     return ret;
 215 }
 216
 217 int16_t ibmpc_host_recv_response(void)
 218 {
 219     // Command may take 25ms/20ms at most([5]p.46, [3]p.21)
 220     uint8_t retry = 25;
 221     int16_t data = -1;
 222     while (retry-- && (data = ibmpc_host_recv()) == -1) {
 223         wait_ms(1);
 224     }
 225     return data;
 226 }
 227
 228 void ibmpc_host_isr_clear(void)
 229 {
 230     ibmpc_isr_debug = 0;
 231     ibmpc_protocol = 0;
 232     ibmpc_error = 0;
 233     isr_state = 0x8000;
 234     recv_data = 0xFFFF;
 235 }
 236
 237 #define LO8(w)  (*((uint8_t *)&(w)))
 238 #define HI8(w)  (*(((uint8_t *)&(w))+1))
 239 // NOTE: With this ISR data line can be read within 2us after clock falling edge.
 240 // To read data line early as possible:
 241 // write naked ISR with asembly code to read the line and call C func to do other job?
 242 ISR(IBMPC_INT_VECT)
 243 {
 244     uint8_t dbit;
 245     dbit = IBMPC_DATA_PIN&(1<<IBMPC_DATA_BIT);
 246
 247     // Timeout check
 248     uint8_t t;
 249     // use only the least byte of millisecond timer
 250     asm("lds %0, %1" : "=r" (t) : "p" (&timer_count));
 251     //t = (uint8_t)timer_count;    // compiler uses four registers instead of one
 252     if (isr_state == 0x8000) {
 253         timer_start = t;
 254     } else {
 255         // should not take more than 1ms
 256         if (timer_start != t && (uint8_t)(timer_start + 1) != t) {
 257             ibmpc_isr_debug = isr_state;
 258             ibmpc_error = IBMPC_ERR_TIMEOUT;
 259             goto ERROR;
 260
 261             // timeout error recovery - start receiving new data
 262             // it seems to work somehow but may not under unstable situation
 263             //timer_start = t;
 264             //isr_state = 0x8000;
 265         }
 266     }
 267
 268     isr_state = isr_state>>1;
 269     if (dbit) isr_state |= 0x8000;
 270
 271     // isr_state: state of receiving data from keyboard
 272     //
 273     // This should be initialized with 0x8000 before receiving data and
 274     // the MSB '*1' works as marker to discrimitate between protocols.
 275     // It stores sampled bit at MSB after right shift on each clock falling edge.
 276     //
 277     // XT protocol has two variants of signaling; XT_IBM and XT_Clone.
 278     // XT_IBM uses two start bits 0 and 1 while XT_Clone uses just start bit 1.
 279     // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol
 280     //
 281     //      15 14 13 12   11 10  9  8    7  6  5  4    3  2  1  0
 282     //      -----------------------------------------------------
 283     //      *1  0  0  0    0  0  0  0 |  0  0  0  0    0  0  0  0     Initial state(0x8000)
 284     //
 285     //       x  x  x  x    x  x  x  x |  0  0  0  0    0  0  0  0     midway(0-7 bits received)
 286     //       x  x  x  x    x  x  x  x | *1  0  0  0    0  0  0  0     midway(8 bits received)
 287     //      b6 b5 b4 b3   b2 b1 b0  1 |  0 *1  0  0    0  0  0  0     XT_IBM-midway ^1
 288     //      b7 b6 b5 b4   b3 b2 b1 b0 |  0 *1  0  0    0  0  0  0     AT-midway ^1
 289     //      b7 b6 b5 b4   b3 b2 b1 b0 |  1 *1  0  0    0  0  0  0     XT_Clone-done ^3
 290     //      b6 b5 b4 b3   b2 b1 b0  1 |  1 *1  0  0    0  0  0  0     XT_IBM-error ^3
 291     //      pr b7 b6 b5   b4 b3 b2 b1 |  0  0 *1  0    0  0  0  0     AT-midway[b0=0]
 292     //      b7 b6 b5 b4   b3 b2 b1 b0 |  1  0 *1  0    0  0  0  0     XT_IBM-done ^2
 293     //      pr b7 b6 b5   b4 b3 b2 b1 |  1  0 *1  0    0  0  0  0     AT-midway[b0=1] ^2
 294     //      b7 b6 b5 b4   b3 b2 b1 b0 |  1  1 *1  0    0  0  0  0     XT_IBM-error-done
 295     //       x  x  x  x    x  x  x  x |  x  1  1  0    0  0  0  0     illegal
 296     //      st pr b7 b6   b5 b4 b3 b2 | b1 b0  0 *1    0  0  0  0     AT-done
 297     //       x  x  x  x    x  x  x  x |  x  x  1 *1    0  0  0  0     illegal
 298     //                                all other states than above     illegal
 299     //
 300     // ^1: AT and XT_IBM takes same state.
 301     // ^2: AT and XT_IBM takes same state in case that AT b0 is 1,
 302     // we have to check AT stop bit to discriminate between the two protocol.
 303     switch (isr_state & 0xFF) {
 304         case 0b00000000:
 305         case 0b10000000:
 306         case 0b01000000:    // ^1
 307         case 0b00100000:
 308             // midway
 309             goto NEXT;
 310             break;
 311         case 0b11000000:    // ^3
 312             {
 313                 uint8_t us = 100;
 314                 // wait for rising and falling edge of b7 of XT_IBM
 315                 while (!(IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)) && us) { wait_us(1); us--; }
 316                 while (  IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)  && us) { wait_us(1); us--; }
 317
 318                 if (us) {
 319                     // XT_IBM-error: read start(0) as 1
 320                     goto NEXT;
 321                 } else {
 322                     // XT_Clone-done
 323                     ibmpc_isr_debug = isr_state;
 324                     isr_state = isr_state>>8;
 325                     ibmpc_protocol = IBMPC_PROTOCOL_XT_CLONE;
 326                     goto DONE;
 327                 }
 328             }
 329             break;
 330         case 0b11100000:
 331             // XT_IBM-error-done
 332             ibmpc_isr_debug = isr_state;
 333             isr_state = isr_state>>8;
 334             ibmpc_protocol = IBMPC_PROTOCOL_XT_ERROR;
 335             goto DONE;
 336             break;
 337         case 0b10100000:    // ^2
 338             {
 339                 uint8_t us = 100;
 340                 // wait for rising and falling edge of AT stop bit to discriminate between XT and AT
 341                 while (!(IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)) && us) { wait_us(1); us--; }
 342                 while (  IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)  && us) { wait_us(1); us--; }
 343
 344                 if (us) {
 345                     // found stop bit: AT-midway - process the stop bit in next ISR
 346                     goto NEXT;
 347                 } else {
 348                     // no stop bit: XT_IBM-done
 349                     ibmpc_isr_debug = isr_state;
 350                     isr_state = isr_state>>8;
 351                     ibmpc_protocol = IBMPC_PROTOCOL_XT_IBM;
 352                     goto DONE;
 353                 }
 354              }
 355             break;
 356         case 0b00010000:
 357         case 0b10010000:
 358         case 0b01010000:
 359         case 0b11010000:
 360             // AT-done
 361             // DO NOT check stop bit. Zenith Z-150(AT) asserts stop bit as low for no reason.
 362             // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#zenith-z-150-beige
 363             // TODO: parity check?
 364             ibmpc_isr_debug = isr_state;
 365             isr_state = isr_state>>6;
 366             ibmpc_protocol = IBMPC_PROTOCOL_AT;
 367             goto DONE;
 368             break;
 369         case 0b01100000:
 370         case 0b00110000:
 371         case 0b10110000:
 372         case 0b01110000:
 373         case 0b11110000:
 374         default:            // xxxx_oooo(any 1 in low nibble)
 375             // Illegal
 376             ibmpc_isr_debug = isr_state;
 377             ibmpc_error = IBMPC_ERR_ILLEGAL;
 378             goto ERROR;
 379             break;
 380     }
 381
 382 ERROR:
 383     // error: eeFF
 384     recv_data = (ibmpc_error<<8) | 0x00FF;
 385     goto CLEAR;
 386 DONE:
 387     if ((isr_state & 0x00FF) == 0x00FF) {
 388         // receive error code 0xFF
 389         ibmpc_error = IBMPC_ERR_FF;
 390         goto ERROR;
 391     }
 392     if (HI8(recv_data) != 0xFF && LO8(recv_data) != 0xFF) {
 393         // buffer full
 394         ibmpc_error = IBMPC_ERR_FULL;
 395         goto ERROR;
 396     }
 397     // store data
 398     recv_data = recv_data<<8;
 399     recv_data |= isr_state & 0xFF;
 400 CLEAR:
 401     // clear for next data
 402     isr_state = 0x8000;
 403 NEXT:
 404     return;
 405 }
 406
 407 /* send LED state to keyboard */
 408 void ibmpc_host_set_led(uint8_t led)
 409 {
 410     if (0xFA == ibmpc_host_send(0xED)) {
 411         ibmpc_host_send(led);
 412     }
 413 }