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