keyboard/fc980c/README.md

   1 FC980C Alt controller
   2 =====================
   3 2017/07/11
   4
   5 This keyboard is very similar to FC660C hardware.
   6
   7 FC660C Alt Controller: https://geekhack.org/index.php?topic=88439.0
   8
   9
  10 Firmware
  11 --------
  12 Just `make` to build firmware. And consult with wiki for further information.
  13
  14 https://github.com/tmk/tmk_keyboard/wiki
  15
  16
  17 Pinouts
  18 -------
  19 ATMega32u4 pin configuration is temporary for test with FC660C Alt controller.
  20
  21     |Switch  |Controller |
  22     |  board |     board |Description                           |Function   |ATmega32u4
  23     |--------|-----------|--------------------------------------|-----------|------------
  24     | 1      |20         | FG                                   |FG         |GND
  25     | 2      |19         | GND                                  |GND        |GND
  26     | 3      |18         | GND                                  |GND        |GND
  27     | 4      |17         | 3.3V                                 |V33        |3.3V/5V
  28     | 5      |16         | 5V                                   |Vcc        |5V
  29     | 6      |15         |*Z6-TP1684-4-HYS(o)                   |KEY_HYS    |PC7
  30     | 7      |14         |*Z6-TP1684-2-KEY(i)                   |KEY_STATE  |PC6
  31     | 8      |13         |*Z7-AD5258-5-SCL(I2C)                 |I2C_CCL    |PD0(TWI)
  32     | 9      |12         |*Z7-AD5258-4-SDA(I2C)                 |I2C_SDA    |PD1(TWI)
  33     |10      |11         |*Z5/4-LV4051A-6-~EN(Lo:Z5 Hi:Z4)      |COL_bit3   |PB4    PB3
  34     |11      |10         |+Z3-LV07A-5 (LV4051A-9-C)             |COL_bit2   |PB3    PB2
  35     |12      | 9         |+Z3-LV07A-1 (LV4051A-10-B)            |COL_bit1   |PB2    PB1
  36     |13      | 8         |+Z3-LV07A-3 (LV4051A-11-A)            |COL_bit0   |PB1    PB0
  37     |14      | 7         |+Z1-LVC138A-3-C                       |ROW_bit2   |PB0    PD6
  38     |15      | 6         |+Z1-LVC138A-2-B                       |ROW_bit1   |PD6    PD5
  39     |16      | 5         |+Z1-LVC138A-1-A                       |ROW_bit0   |PD5    PD4
  40     |17      | 4         |+Z1-LVC138A-4-~G2A  Z6-TP1684-5-~EN   |KEY_ENABLE |PD4    PD7
  41     |18      | 3         |+Q4-MOSFET-G-NumLock_LED(Hi:On)       |LED_NUML   |PD7    PB4
  42     |19      | 2         |+Q3-MOSFET-G-CapsLock_LED(Hi:On)      |LED_CAPS   |PB5
  43     |20      | 1         |+Q2-MOSFET-G-ScrollLock_LED(Hi:On)    |LED_SCRL   |PB6
  44
  45 ```
  46 * 5V intferface
  47 + 3.3V interface
  48 ```
  49
  50 - Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg
  51 - Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg
  52
  53
  54 Key Matrix
  55 ----------
  56
  57     |    |0   |1   |2   |3   |4   |5   |6   |7   |8   |9   |A   |B   |C   |D   |E   |F   |
  58     |----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
  59     |   0|Left|RCtl|RAlt|    |Down|P.  |Righ|P0  |X   |LGui|`   |V   |    |Esc |M   |Spc |
  60     |   1|Fn  |.   |    |    |P1  |PEnt|P2  |P3  |Z   |LAlt|RCtl|C   |K   |    |N   |B   |
  61     |   2|'   |/   |,   |    |P4  |P+  |P5  |P6  |D   |A   |LSft|F   |J   |F1  |H   |G   |
  62     |   3|RSft|;   |L   |]   |Up  |    |    |    |S   |Q   |Caps|R   |I   |F3  |U   |T   |
  63     |   4|    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |    |
  64     |   5|=   |-   |0   |\   |NLck|BSpc|P/  |P*  |3   |2   |    |4   |9   |F2  |7   |6   |
  65     |   6|[   |P   |O   |Ent |P7  |P-  |P8  |P9  |W   |1   |Tab |E   |8   |F4  |Y   |5   |
  66     |   7|F11 |F10 |F9  |F12 |Del |PgDn|Ins |PgUp|    |    |    |    |F8  |F5  |F7  |F6  |
  67
  68
  69 Logic analyzer pics:
  70 - http://i.imgur.com/9XoNTev.png
  71 - https://i.imgur.com/5FCP1Ay.png
  72
  73 This code emuluates what original cotnroller does for matrix scan.
  74 - https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c
  75
  76
  77 ### Row designation
  78 LV138A(Z1) selects a row line and gives strobe by enabling with ~G2A(18).
  79
  80     |Row |A/16|B/15|C/14|
  81     |----|----|----|----|
  82     |0   |0   |0   |0   |
  83     |1   |1   |0   |0   |
  84     |2   |0   |1   |0   |
  85     |3   |1   |1   |0   |
  86     |4   |0   |0   |1   |
  87     |5   |1   |0   |1   |
  88     |6   |0   |1   |1   |
  89     |7   |1   |1   |1   |
  90
  91
  92 ### Column designation
  93 LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
  94
  95     |Col |A/13|B/12|C/11|Z4/5-EN/10|
  96     |----|----|----|----|----------|
  97     |0   |0   |0   |0   |0         |
  98     |1   |1   |0   |0   |0         |
  99     |2   |0   |1   |0   |0         |
 100     |3   |1   |1   |0   |0         |
 101     |4   |0   |0   |1   |0         |
 102     |5   |1   |0   |1   |0         |
 103     |6   |0   |1   |1   |0         |
 104     |7   |1   |1   |1   |0         |
 105     |8   |0   |0   |0   |1         |
 106     |9   |1   |0   |0   |1         |
 107     |A   |0   |1   |0   |1         |
 108     |B   |1   |1   |0   |1         |
 109     |C   |0   |0   |1   |1         |
 110     |D   |1   |0   |1   |1         |
 111     |E   |0   |1   |1   |1         |
 112     |F   |1   |1   |1   |1         |
 113
 114
 115 Datasheets
 116 ----------
 117 - Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
 118 - LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
 119 - LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
 120 - LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
 121 - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
 122
 123
 124 3.3V power supply
 125 -----------------
 126 LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says:
 127
 128 > Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
 129
 130 Digipot AD5258
 131 --------------
 132 Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though.
 133
 134 Lower value of RDAC register causes shallower actuation point.
 135
 136 Resources
 137 ---------
 138 - Pics: http://imgur.com/a/HhyIq