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     clock_hi();
 113     WAIT(clock_lo, 10000, 1);   // 10ms [5]p.50
 114
 115     /* Data bit[2-9] */
 116     for (uint8_t i = 0; i < 8; i++) {
 117         wait_us(15);
 118         if (data&(1<<i)) {
 119             parity = !parity;
 120             data_hi();
 121         } else {
 122             data_lo();
 123         }
 124         WAIT(clock_hi, 50, 2);
 125         WAIT(clock_lo, 50, 3);
 126     }
 127
 128     /* Parity bit */
 129     wait_us(15);
 130     if (parity) { data_hi(); } else { data_lo(); }
 131     WAIT(clock_hi, 50, 4);
 132     WAIT(clock_lo, 50, 5);
 133
 134     /* Stop bit */
 135     wait_us(15);
 136     data_hi();
 137
 138     /* Ack */
 139     WAIT(data_lo, 50, 6);
 140     WAIT(clock_lo, 50, 7);
 141
 142     /* wait for idle state */
 143     WAIT(clock_hi, 50, 8);
 144     WAIT(data_hi, 50, 9);
 145
 146     // clear buffer to get response correctly
 147     recv_data = 0xFFFF;
 148     ibmpc_host_isr_clear();
 149
 150     idle();
 151     IBMPC_INT_ON();
 152     return ibmpc_host_recv_response();
 153 ERROR:
 154     ibmpc_error |= IBMPC_ERR_SEND;
 155     idle();
 156     IBMPC_INT_ON();
 157     return -1;
 158 }
 159
 160 /*
 161  * Receive data from keyboard
 162  */
 163 int16_t ibmpc_host_recv(void)
 164 {
 165     uint16_t data = 0;
 166     uint8_t ret = 0xFF;
 167
 168     ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
 169         data = recv_data;
 170
 171         // remove data from buffer:
 172         // FFFF(empty)      -> FFFF
 173         // FFss(one data)   -> FFFF
 174         // sstt(two data)   -> FFtt
 175         // eeFF(errror)     -> FFFF
 176         recv_data = data | (((data&0xFF00) == 0xFF00) ? 0x00FF : 0xFF00);
 177     }
 178
 179     if ((data&0x00FF) == 0x00FF) {
 180         // error: eeFF
 181         switch (data>>8) {
 182             case IBMPC_ERR_FF:
 183                 // 0xFF(Overrun/Error) from keyboard
 184                 dprintf("!FF! ");
 185                 ret = 0xFF;
 186                 break;
 187             case IBMPC_ERR_FULL:
 188                 // buffer full
 189                 dprintf("!FULL! ");
 190                 ret = 0xFF;
 191                 break;
 192             case 0xFF:
 193                 // empty: FFFF
 194                 return -1;
 195             default:
 196                 // other errors
 197                 dprintf("e%02X ", data>>8);
 198                 return -1;
 199         }
 200     } else {
 201         if ((data | 0x00FF) != 0xFFFF) {
 202             // two data: sstt
 203             dprintf("b:%04X ", data);
 204             ret = (data>>8);
 205         } else {
 206             // one data: FFss
 207             ret = (data&0x00FF);
 208         }
 209     }
 210
 211     dprintf("r%02X ", ret);
 212     return ret;
 213 }
 214
 215 int16_t ibmpc_host_recv_response(void)
 216 {
 217     // Command may take 25ms/20ms at most([5]p.46, [3]p.21)
 218     uint8_t retry = 25;
 219     int16_t data = -1;
 220     while (retry-- && (data = ibmpc_host_recv()) == -1) {
 221         wait_ms(1);
 222     }
 223     return data;
 224 }
 225
 226 void ibmpc_host_isr_clear(void)
 227 {
 228     isr_state = 0x8000;
 229     recv_data = 0xFFFF;
 230 }
 231
 232 // NOTE: With this ISR data line can be read within 2us after clock falling edge.
 233 // To read data line early as possible:
 234 // write naked ISR with asembly code to read the line and call C func to do other job?
 235 ISR(IBMPC_INT_VECT)
 236 {
 237     uint8_t dbit;
 238     dbit = IBMPC_DATA_PIN&(1<<IBMPC_DATA_BIT);
 239
 240     // Timeout check
 241     uint8_t t;
 242     // use only the least byte of millisecond timer
 243     asm("lds %0, %1" : "=r" (t) : "p" (&timer_count));
 244     //t = (uint8_t)timer_count;    // compiler uses four registers instead of one
 245     if (isr_state == 0x8000) {
 246         timer_start = t;
 247     } else {
 248         // should not take more than 1ms
 249         if (timer_start != t && (uint8_t)(timer_start + 1) != t) {
 250             ibmpc_isr_debug = isr_state;
 251             ibmpc_error = IBMPC_ERR_TIMEOUT;
 252             goto ERROR;
 253
 254             // timeout error recovery - start receiving new data
 255             // it seems to work somehow but may not under unstable situation
 256             //timer_start = t;
 257             //isr_state = 0x8000;
 258         }
 259     }
 260
 261     isr_state = isr_state>>1;
 262     if (dbit) isr_state |= 0x8000;
 263
 264     // isr_state: state of receiving data from keyboard
 265     //
 266     // This should be initialized with 0x8000 before receiving data and
 267     // the MSB '*1' works as marker to discrimitate between protocols.
 268     // It stores sampled bit at MSB after right shift on each clock falling edge.
 269     //
 270     // XT protocol has two variants of signaling; XT_IBM and XT_Clone.
 271     // XT_IBM uses two start bits 0 and 1 while XT_Clone uses just start bit 1.
 272     // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol
 273     //
 274     //      15 14 13 12   11 10  9  8    7  6  5  4    3  2  1  0
 275     //      -----------------------------------------------------
 276     //      *1  0  0  0    0  0  0  0 |  0  0  0  0    0  0  0  0     Initial state(0x8000)
 277     //
 278     //       x  x  x  x    x  x  x  x |  0  0  0  0    0  0  0  0     midway(0-7 bits received)
 279     //       x  x  x  x    x  x  x  x | *1  0  0  0    0  0  0  0     midway(8 bits received)
 280     //      b6 b5 b4 b3   b2 b1 b0  1 |  0 *1  0  0    0  0  0  0     XT_IBM-midway ^1
 281     //      b7 b6 b5 b4   b3 b2 b1 b0 |  0 *1  0  0    0  0  0  0     AT-midway ^1
 282     //      b7 b6 b5 b4   b3 b2 b1 b0 |  1 *1  0  0    0  0  0  0     XT_Clone-done ^3
 283     //      b6 b5 b4 b3   b2 b1 b0  1 |  1 *1  0  0    0  0  0  0     XT_IBM-error ^3
 284     //      pr b7 b6 b5   b4 b3 b2 b1 |  0  0 *1  0    0  0  0  0     AT-midway[b0=0]
 285     //      b7 b6 b5 b4   b3 b2 b1 b0 |  1  0 *1  0    0  0  0  0     XT_IBM-done ^2
 286     //      pr b7 b6 b5   b4 b3 b2 b1 |  1  0 *1  0    0  0  0  0     AT-midway[b0=1] ^2
 287     //      b7 b6 b5 b4   b3 b2 b1 b0 |  1  1 *1  0    0  0  0  0     XT_IBM-error-done
 288     //       x  x  x  x    x  x  x  x |  x  1  1  0    0  0  0  0     illegal
 289     //      st pr b7 b6   b5 b4 b3 b2 | b1 b0  0 *1    0  0  0  0     AT-done
 290     //       x  x  x  x    x  x  x  x |  x  x  1 *1    0  0  0  0     illegal
 291     //                                all other states than above     illegal
 292     //
 293     // ^1: AT and XT_IBM takes same state.
 294     // ^2: AT and XT_IBM takes same state in case that AT b0 is 1,
 295     // we have to check AT stop bit to discriminate between the two protocol.
 296     switch (isr_state & 0xFF) {
 297         case 0b00000000:
 298         case 0b10000000:
 299         case 0b01000000:    // ^1
 300         case 0b00100000:
 301             // midway
 302             goto NEXT;
 303             break;
 304         case 0b11000000:    // ^3
 305             {
 306                 uint8_t us = 100;
 307                 // wait for rising and falling edge of b7 of XT_IBM
 308                 while (!(IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)) && us) { wait_us(1); us--; }
 309                 while (  IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)  && us) { wait_us(1); us--; }
 310
 311                 if (us) {
 312                     // XT_IBM-error: read start(0) as 1
 313                     goto NEXT;
 314                 } else {
 315                     // XT_Clone-done
 316                     isr_state = isr_state>>8;
 317                     ibmpc_protocol = IBMPC_PROTOCOL_XT_CLONE;
 318                     goto DONE;
 319                 }
 320             }
 321             break;
 322         case 0b11100000:
 323             // XT_IBM-error-done
 324             ibmpc_isr_debug = isr_state;
 325             isr_state = isr_state>>8;
 326             ibmpc_protocol = IBMPC_PROTOCOL_XT_ERROR;
 327             goto DONE;
 328             break;
 329         case 0b10100000:    // ^2
 330             {
 331                 uint8_t us = 100;
 332                 // wait for rising and falling edge of AT stop bit to discriminate between XT and AT
 333                 while (!(IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)) && us) { wait_us(1); us--; }
 334                 while (  IBMPC_CLOCK_PIN&(1<<IBMPC_CLOCK_BIT)  && us) { wait_us(1); us--; }
 335
 336                 if (us) {
 337                     // found stop bit: AT-midway - process the stop bit in next ISR
 338                     goto NEXT;
 339                 } else {
 340                     // no stop bit: XT_IBM-done
 341                     isr_state = isr_state>>8;
 342                     ibmpc_protocol = IBMPC_PROTOCOL_XT_IBM;
 343                     goto DONE;
 344                 }
 345              }
 346             break;
 347         case 0b00010000:
 348         case 0b10010000:
 349         case 0b01010000:
 350         case 0b11010000:
 351             // AT-done
 352             // DO NOT check stop bit. Zenith Z-150(AT) asserts stop bit as low for no reason.
 353             // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#zenith-z-150-beige
 354             // TODO: parity check?
 355             isr_state = isr_state>>6;
 356             ibmpc_protocol = IBMPC_PROTOCOL_AT;
 357             goto DONE;
 358             break;
 359         case 0b01100000:
 360         case 0b00110000:
 361         case 0b10110000:
 362         case 0b01110000:
 363         case 0b11110000:
 364         default:            // xxxx_oooo(any 1 in low nibble)
 365             // Illegal
 366             ibmpc_isr_debug = isr_state;
 367             ibmpc_error = IBMPC_ERR_ILLEGAL;
 368             goto ERROR;
 369             break;
 370     }
 371
 372 ERROR:
 373     // error: eeFF
 374     recv_data = (ibmpc_error<<8) | 0x00FF;
 375     goto CLEAR;
 376 DONE:
 377     if ((isr_state & 0x00FF) == 0x00FF) {
 378         // receive error code 0xFF
 379         ibmpc_error = IBMPC_ERR_FF;
 380         goto ERROR;
 381     }
 382     if ((recv_data & 0xFF00) != 0xFF00) {
 383         // buffer full
 384         ibmpc_error = IBMPC_ERR_FULL;
 385         goto ERROR;
 386     }
 387     // store data
 388     recv_data = recv_data<<8;
 389     recv_data |= isr_state & 0xFF;
 390 CLEAR:
 391     // clear for next data
 392     isr_state = 0x8000;
 393 NEXT:
 394     return;
 395 }
 396
 397 /* send LED state to keyboard */
 398 void ibmpc_host_set_led(uint8_t led)
 399 {
 400     if (0xFA == ibmpc_host_send(0xED)) {
 401         ibmpc_host_send(led);
 402     }
 403 }