keyboards/handwired/datahand/datahand.h

   1 /* Copyright 2017-2019 Nikolaus Wittenstein <nikolaus.wittenstein@gmail.com>
   2  *
   3  * Permission to use, copy, modify, and/or distribute this software for any
   4  * purpose with or without fee is hereby granted, provided that the above
   5  * copyright notice and this permission notice appear in all copies.
   6  *
   7  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
   8  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   9  * FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
  10  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  11  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  12  * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  13  * PERFORMANCE OF THIS SOFTWARE.
  14  */
  15
  16 #pragma once
  17
  18 #include "quantum.h"
  19
  20 /* This a shortcut to help you visually see your layout.
  21  * The first section contains all of the arguements; the second converts the arguments into a two-dimensional array.
  22  */
  23
  24 /* Each code is three letters
  25  * l or r - left or right hand
  26  * p, r, m, i, t - pinky, ring finger, middle finger, index finger, thumb
  27  * fingers: n, s, e, w, c - north, south, east, west, and center (manual calls this "well" but we already have "west")
  28  * thumb:   p, n, c, l, u, k - pad, nail, center, lock (harder center), up, knuckle
  29  */
  30 #define LAYOUT( \
  31      lpn,             lrn,             lmn,             lin,                rin,             rmn,             rrn,             rpn,      \
  32 lpw, lpc, lpe,   lrw, lrc, lre,   lmw, lmc, lme,   liw, lic, lie,      riw, ric, rie,   rmw, rmc, rme,   rrw, rrc, rre,   rpw, rpc, rpe, \
  33      lps,             lrs,             lms,             lis,                ris,             rms,             rrs,             rps,      \
  34                                                        ltp,    ltn,  rtn,    rtp, \
  35                                                            ltc,          rtc, \
  36                                                            ltl,          rtl, \
  37                                                        ltu,    ltk,  rtk,    rtu) \
  38 { \
  39   {riw, rin, lpw, lpn},\
  40   {ric, rie, lpc, lpe},\
  41   {ris, rms, lps, lrs},\
  42   {rmw, rmn, lrw, lrn},\
  43   {rmc, rme, lrc, lre},\
  44   {rrw, rrn, lmw, lmn},\
  45   {rrc, rre, lmc, lme},\
  46   {rrs, rps, lms, lis},\
  47   {rpw, rpn, liw, lin},\
  48   {rpc, rpe, lic, lie},\
  49   {rtk, rtn, ltk, ltn},\
  50   {rtc, rtl, ltc, ltl},\
  51   {rtp, rtu, ltp, ltu},\
  52 }
  53
  54 /* Mode LEDs are active-low on Port B on the Teensy. */
  55 #define LED_MODE_PORT PORTB
  56 #define LED_TENKEY    (1<<3)
  57 #define LED_FN        (1<<4)
  58 #define LED_NORMAL    (1<<5)
  59 #define LED_NAS       (1<<6)
  60
  61 /* Lock LEDs are active-low on Port F on the Teensy. */
  62 #define LED_LOCK_PORT   PORTF
  63 #define LED_CAPS_LOCK   (1<<4)
  64 #define LED_MOUSE_LOCK  (1<<5)
  65 #define LED_NUM_LOCK    (1<<6)
  66 #define LED_SCROLL_LOCK (1<<7)
  67
  68
  69 /* Appendix:
  70  * Table based on https://geekhack.org/index.php?topic=12212.msg2059319#msg2059319
  71  * Some pin assignments (e.g. for PS/2 I/O) have been fixed.
  72  *
  73  * Teensy    Datahand     8051   pin     pin      8051    Datahand             Teensy
  74  * ------    --------     ----   ---     ---      ----    --------             ------
  75  * GND       Mtrx send A  P1.0     1      40      VCC     VCC                  VCC
  76  * PB7       Mtrx send B  P1.1     2      39      P0.0    LED RH NAS           PB6
  77  * PD0       Mtrx send C  P1.2     3      38      P0.1    LED RH NORM          PB5
  78  * PD1       Mtrx send D  P1.3     4      37      P0.2    LED RH FCTN          PB4
  79  * PD2       RH rcv 0     P1.4     5      36      P0.3    LED RH 10K           PB3
  80  * PD3       RH rcv 1     P1.5     6      35      P0.4    LED RH unused        PB2
  81  * PD4       LH rcv 0     P1.6     7      34      P0.5    LED RH unused        PE1
  82  * PD5       LH rcv 1     P1.7     8      33      P0.6    LED RH unused        PE0
  83  * PD6       Reset button RST      9      32      P0.7    ?                    PE7
  84  * PD7       ?            P3.0    10      31      VPP     -                    PE6
  85  * PE0       ?            P3.1    11      30      ALE     -                    GND
  86  * PE1       kbd data     P3.2    12      29      PSEN    -                    AREF
  87  * PC0       ?            P3.3    13      28      P2.7    ?                    PF0
  88  * PC1       kbd clk      P3.4    14      27      P2.6    ?                    PF1
  89  * PC2       ?            P3.5    15      26      P2.5    ?                    PF2
  90  * PC3       RAM          P3.6    16      25      P2.4    ?                    PF3
  91  * PC4       RAM          P3.7    17      24      P2.3    LED D15 LH (CAPLK)   PF4
  92  * PC5       XTAL2        XTAL2   18      23      P2.2    LED D13 LH (MSELK)   PF5
  93  * PC6       XTAL1        XTAL1   19      22      P2.1    LED D6  LH (NUMLK)   PF6
  94  * PC7       GND          GND     20      21      P2.0    LED D14 LH (SCRLK)   PF7
  95  *
  96  * JP3 Pinout
  97  * 2 - keyboard data
  98  * 3 - keyboard clock
  99  *
 100  * In order to get the Teensy to work, we need to move pin 1 to a different pin. This is
 101  * because on the Teensy pin 1 is ground, but we need to write to pin 1 in order to read
 102  * the keyboard matrix. An ideal pin to move it to is VPP (pin 31), because this pin tells
 103  * the 8051 whether it should read from external or internal memory. The Teensy doesn't
 104  * care about that.
 105  *
 106  * The easiest way to reassign the pin is to use standoffs. You can check out this thread:
 107  * https://geekhack.org/index.php?topic=12212.msg235382#msg235382 for a picture of what
 108  * this looks like. Note that in the picture the pin has been reassigned to pin 12. We
 109  * don't want to do that because we're going to use that pin to send data over PS/2.
 110  *
 111  * We could if we wanted also reassign the PS/2 pins to Teensy hardware UART pins, but
 112  * that's more work. Instead we'll just bit-bang PS/2 because it's an old, slow protocol
 113  * (and because there's already a bit-banged PS/2 host implementation in QMK - we just
 114  * need to add the device side).
 115  *
 116  * So overall, we want the following inputs and outputs:
 117  * Outputs:
 118  *   Matrix:
 119  *     PB7
 120  *     PD0
 121  *     PD1
 122  *     PE6 (moved from pin1, GND)
 123  *   LEDs:
 124  *     PB3-6
 125  *     PF4-7
 126  * Inputs:
 127  *   Matrix:
 128  *     PD2-5
 129  * I/Os (start up as inputs):
 130  *   PS/2:
 131  *     PC1
 132  *     PE1
 133  */