Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fc660c port #2060

Merged
merged 2 commits into from
Nov 26, 2017
Merged

Fc660c port #2060

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2201c43
Port Hasu's FC660C controller to QMK
BalzGuenat Nov 23, 2017
ed1c820
fix column mask
BalzGuenat Nov 24, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Port Hasu's FC660C controller to QMK
  • Loading branch information
@BalzGuenat
BalzGuenat committed Nov 23, 2017
commit 2201c436d97fbfd12e8da9b4e16f23fdc3cd5d13
156 changes: 156 additions & 0 deletions keyboards/fc660c/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
FC660C Alt Controller
=================

This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c

------------

- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
- Hardware Supported: Hasu's Alt Controller (see below)
- Hardware Availability: https://geekhack.org/index.php?topic=90317.0

Make example for this keyboard (after setting up your build environment):

make fc660c:default

See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.

To flash the firmware, press the reset button on the controller and run:

sudo make fc660c:default:dfu

--------

Thread on Geekhack: https://geekhack.org/index.php?topic=88439.0

Also: https://geekhack.org/index.php?topic=88720.0

Pinouts
-------

|Switch |Controller |
| board | board |Description |Schematic |ATmega32u4
|--------|-----------|--------------------------------------|-----------|------------
| 1 |20 | FG |FG |GND
| 2 |19 | GND |GND |GND
| 3 |18 | GND |GND |GND
| 4 |17 | 3.3V |V33 |3.3V/5V
| 5 |16 | 5V |Vcc |5V
| 6 |15 |*Z6-TP1684-4-HYS(o) |FBSTB |PC7
| 7 |14 |*Z6-TP1684-2-KEY(i) |OUT |PC6
| 8 |13 |*Z2-AD5258-5-SCL(I2C) |SCL |PD0(TWI)
| 9 |12 |*Z2-AD5258-4-SDA(I2C) |SDA |PD1(TWI)
|10 |11 |*Z4-LV4051A-6-~EN(Col 0-7) |INH_1 |PB4
|11 |10 |*Z5-LV4051A-6-~EN(Col 8-F) |INH_2 |PB3
|12 | 9 |+Z7-LV07A-5 (LV4051A-9-C) |SEL_C |PB2
|13 | 8 |+Z7-LV07A-1 (LV4051A-10-B) |SEL_B |PB1
|14 | 7 |+Z7-LV07A-3 (LV4051A-11-A) |SEL_A |PB0
|15 | 6 |+Z3-LVC138A-3-C |COL4 |PD6
|16 | 5 |+Z3-LVC138A-2-B |COL3 |PD5
|17 | 4 |+Z3-LVC138A-1-A |COL2 |PD4
|18 | 3 |+Z3-LVC138A-4-~G2A Z6-TP1684-5-~EN |COL1 |PD7
|19 | 2 |+Z7-LV07A-11-~InsertLED |LED1 |PB5
|20 | 1 |+Z7-LV07A-13-~CapsLED |LED2 |PB6

```
* 5V intferface
+ 3.3V interface
```

- Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg
- Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg


Key Matrix
----------
Row5-7 have no key, you can omit scaning on those lines. Topre original controller scans those rows for some reason.

| |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F |
|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
| 0|Q |W |E |Tab |R |U |T |Y |O |P |[ |I |] | |\ |Del |
| 1|1 |2 |3 |Esc |4 |7 |5 |6 |9 |0 |- |8 |= | |BSpc|Ins |
| 2| |LWin|LAlt|LCtl| | | |Spc |RAlt| |RCtl| |Fn |Down|Left|Rght|
| 3| |Z |X |LSft|C |N |V |B |, |. |/ |M |RSft|Up | | |
| 4|A |S |D |Caps|F |J |G |H |L |; |' |K | | |Entr| |
| 5| | | | | | | | | | | | | | | | |
| 6| | | | | | | | | | | | | | | | |
| 7| | | | | | | | | | | | | | | | |

Logic analyzer pics:
- http://i.imgur.com/9XoNTev.png
- https://i.imgur.com/5FCP1Ay.png

This code emuluates what original cotnroller does for matrix scan.
- https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c


### Row designation
LV138A(Z3) selects a row line and gives strobe by enabling with ~G2A(18).

|Row |A/17|B/16|C/15|
|----|----|----|----|
|0 |0 |0 |0 |
|1 |1 |0 |0 |
|2 |0 |1 |0 |
|3 |1 |1 |0 |
|4 |0 |0 |1 |
|5 |1 |0 |1 |
|6 |0 |1 |1 |
|7 |1 |1 |1 |


### Column designation
LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.

|Col |A/14|B/13|C/12|Z4-EN/10|Z5-EN/11|
|----|----|----|----|--------|--------|
|0 |0 |0 |0 |0 |1 |
|1 |1 |0 |0 |0 |1 |
|2 |0 |1 |0 |0 |1 |
|3 |1 |1 |0 |0 |1 |
|4 |0 |0 |1 |0 |1 |
|5 |1 |0 |1 |0 |1 |
|6 |0 |1 |1 |0 |1 |
|7 |1 |1 |1 |0 |1 |
|8 |0 |0 |0 |1 |0 |
|9 |1 |0 |0 |1 |0 |
|A |0 |1 |0 |1 |0 |
|B |1 |1 |0 |1 |0 |
|C |0 |0 |1 |1 |0 |
|D |1 |0 |1 |1 |0 |
|E |0 |1 |1 |1 |0 |
|F |1 |1 |1 |1 |0 |


FCC documents
-------------
https://fccid.io/RPKFC660C

- schematic: https://fccid.io/pdf.php?id=1888185
- part list: https://fccid.io/pdf.php?id=1888184


Datasheets
----------
- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf


3.3V power supply
-----------------
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:

> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.

Digipot AD5258
--------------
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.

Lower value of RDAC register causes shallower actuation point.

Resources
---------
- Pics: https://imgur.com/a/UTR8Z
80 changes: 80 additions & 0 deletions keyboards/fc660c/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
/*
Copyright 2017 Balz Guenat

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CONFIG_H
#define CONFIG_H

#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID 0xFEED
#define PRODUCT_ID 0x660C
#define DEVICE_VER 0x0100
#define MANUFACTURER QMK
#define PRODUCT Leopold FC660C with QMK
#define DESCRIPTION Leopold FC660C with Hasu alternative controller using QMK

/* key matrix size */
#define MATRIX_ROWS 8
#define MATRIX_COLS 16

#define DIODE_DIRECTION CUSTOM_MATRIX

/* define if matrix has ghost */
//#define MATRIX_HAS_GHOST

/* number of backlight levels */
// #define BACKLIGHT_LEVELS 1

/* mapping backlight LEDs to correct Pin */
// #define BACKLIGHT_PIN B7

/* Set 0 if debouncing isn't needed */
#define DEBOUNCING_DELAY 0
#define TAPPING_TERM 175

/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
// #define LOCKING_SUPPORT_ENABLE
/* Locking resynchronize hack */
// #define LOCKING_RESYNC_ENABLE

/* key combination for command */
#define IS_COMMAND() ( \
keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
)



/*
* Feature disable options
* These options are also useful to firmware size reduction.
*/

/* disable debug print */
//#define NO_DEBUG

/* disable print */
//#define NO_PRINT

/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT
//#define NO_ACTION_MACRO
//#define NO_ACTION_FUNCTION

#endif
48 changes: 48 additions & 0 deletions keyboards/fc660c/fc660c.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
Copyright 2017 Balz Guenat

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "fc660c.h"

void matrix_init_kb(void) {
// put your keyboard start-up code here
// runs once when the firmware starts up

matrix_init_user();
}

void matrix_scan_kb(void) {
// put your looping keyboard code here
// runs every cycle (a lot)

matrix_scan_user();
}

bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
// put your per-action keyboard code here
// runs for every action, just before processing by the firmware

return process_record_user(keycode, record);
}

void led_set_kb(uint8_t usb_led) {
if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
PORTB &= ~(1<<6);
} else {
PORTB |= (1<<6);
}

led_set_user(usb_led);
}
57 changes: 57 additions & 0 deletions keyboards/fc660c/fc660c.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
Copyright 2017 Balz Guenat

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef FC660C_H
#define FC660C_H

#include "quantum.h"


#define KEYMAP( \
K13, K10, K11, K12, K14, K16, K17, K15, K1B, K18, K19, K1A, K1C, K1E, K1F, \
K03, K00, K01, K02, K04, K06, K07, K05, K0B, K08, K09, K0A, K0C, K0E, K0F, \
K43, K40, K41, K42, K44, K46, K47, K45, K4B, K48, K49, K4A, K4E, \
K33, K31, K32, K34, K36, K37, K35, K3B, K38, K39, K3A, K3C, K3D, \
K23, K21, K22, K27, K28, K2A, K2C, K2E, K2D, K2F \
) { \
{ K00, K01, K02, K03, K04, K05, K06, K07, \
K08, K09, K0A, K0B, K0C, KC_NO, K0E, K0F }, \
{ K10, K11, K12, K13, K14, K15, K16, K17, \
K18, K19, K1A, K1B, K1C, KC_NO, K1E, K1F }, \
{ KC_NO, K21, K22, K23, KC_NO, KC_NO, KC_NO, K27, \
K28, KC_NO, K2A, KC_NO, K2C, K2D, K2E, K2F }, \
{ KC_NO, K31, K32, K33, K34, K35, K36, K37, \
K38, K39, K3A, K3B, K3C, K3D, KC_NO, KC_NO }, \
{ K40, K41, K42, K43, K44, K45, K46, K47, \
K48, K49, K4A, K4B, KC_NO, KC_NO, K4E, KC_NO }, \
{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO } \
}
/*
KEYMAP(
_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, _______,
_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, _______,
_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, _______,
_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______, _______,
_______,_______,_______, _______, _______,_______,_______, _______,_______,_______
)
*/

#endif
5 changes: 5 additions & 0 deletions keyboards/fc660c/keymaps/default/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# The default keymap for the FC660C

Emulates original keymap.

![](https://i.imgur.com/fg89nez.jpg)
24 changes: 24 additions & 0 deletions keyboards/fc660c/keymaps/default/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* Copyright 2017 Balz Guenat
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CONFIG_USER_H
#define CONFIG_USER_H

#include "config_common.h"

// place overrides here

#endif
Loading