tmk_core/protocol/xt_interrupt.c

   1 /*
   2 Copyright 2010,2011,2012,2013 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  * PS/2 protocol Pin interrupt version
  40  */
  41
  42 #include <stdbool.h>
  43 #include <avr/interrupt.h>
  44 #include <util/delay.h>
  45 #include "pbuff.h"
  46 #include "xt.h"
  47 #include "xt_io.h"
  48 #include "wait.h"
  49 #include "print.h"
  50
  51 void xt_host_init(void)
  52 {
  53     XT_INT_INIT();
  54     XT_INT_OFF();
  55
  56     /* hard reset */
  57 #ifdef XT_RESET
  58     XT_RESET();
  59 #endif
  60
  61     /* soft reset: pull clock line down for 20ms */
  62     XT_DATA_LO();
  63     XT_CLOCK_LO();
  64     _delay_ms(20);
  65
  66     /* input mode with pullup */
  67     XT_CLOCK_IN();
  68     XT_DATA_IN();
  69
  70     XT_INT_ON();
  71 }
  72
  73 /* get data received by interrupt */
  74 uint8_t xt_host_recv(void)
  75 {
  76     if (pbuf_has_data()) {
  77         return pbuf_dequeue();
  78     } else {
  79         return 0;
  80     }
  81 }
  82
  83 ISR(XT_INT_VECT)
  84 {
  85     /*
  86      * XT signal format consits of 10 or 9 clocks and sends start bits and 8-bit data,
  87      * which should be read on falling edge of clock.
  88      *
  89      *  start(0), start(1), bit0, bit1, bit2, bit3, bit4, bit5, bit6, bit7
  90      *
  91      * Original IBM XT keyboard sends start(0) bit while some of clones don't.
  92      * Start(0) bit is read as low on data line while start(1) as high.
  93      *
  94      * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol
  95      */
  96     static enum {
  97         START, BIT0, BIT1, BIT2, BIT3, BIT4, BIT5, BIT6, BIT7, END
  98     } state = START;
  99     static uint8_t data = 0;
 100
 101     uint8_t dbit = XT_DATA_READ();
 102
 103     // This is needed if using PCINT which can be called on both falling and rising edge
 104     //if (clock_in()) return;
 105
 106     switch (state) {
 107         case START:
 108             // ignore start(0) bit
 109             if (!dbit) return;
 110             break;
 111         case BIT0 ... BIT7:
 112             data >>= 1;
 113             if (dbit)
 114                 data |= 0x80;
 115             break;
 116     }
 117     if (++state == END) {
 118         pbuf_enqueue(data);
 119         state = START;
 120         data = 0;
 121     }
 122     return;
 123 }