]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/hhkb/hhkb_avr.h
converter/usb_usb Refactor and Configurator support (#4345)
[qmk_firmware.git] / keyboards / hhkb / hhkb_avr.h
1 #ifndef HHKB_AVR_H
2 #define HHKB_AVR_H
3
4 #include <stdint.h>
5 #include <stdbool.h>
6 #include <avr/io.h>
7 #include <avr/interrupt.h>
8 #include <util/delay.h>
9
10
11 // Timer resolution check
12 #if (1000000/TIMER_RAW_FREQ > 20)
13 #   error "Timer resolution(>20us) is not enough for HHKB matrix scan tweak on V-USB."
14 #endif
15
16
17 /*
18  * HHKB Matrix I/O
19  *
20  * row:     HC4051[A,B,C]  selects scan row0-7
21  * row-ext: [En0,En1] row extention for JP
22  * col:     LS145[A,B,C,D] selects scan col0-7 and enable(D)
23  * key:     on: 0/off: 1
24  * prev:    hysteresis control: assert(1) when previous key state is on
25  */
26
27
28 #if defined(__AVR_ATmega32U4__)
29 /*
30  * For TMK HHKB alt controller(ATMega32U4)
31  *
32  * row:     PB0-2
33  * col:     PB3-5,6
34  * key:     PD7(pull-uped)
35  * prev:    PB7
36  * power:   PD4(L:off/H:on)
37  * row-ext: PC6,7 for HHKB JP(active low)
38  */
39 static inline void KEY_ENABLE(void) { (PORTB &= ~(1<<6)); }
40 static inline void KEY_UNABLE(void) { (PORTB |=  (1<<6)); }
41 static inline bool KEY_STATE(void) { return (PIND & (1<<7)); }
42 static inline void KEY_PREV_ON(void) { (PORTB |=  (1<<7)); }
43 static inline void KEY_PREV_OFF(void) { (PORTB &= ~(1<<7)); }
44 #ifdef HHKB_POWER_SAVING
45 static inline void KEY_POWER_ON(void) {
46     DDRB = 0xFF; PORTB = 0x40;          // change pins output
47     DDRD |= (1<<4); PORTD |= (1<<4);    // MOS FET switch on
48     /* Without this wait you will miss or get false key events. */
49     _delay_ms(5);                       // wait for powering up
50 }
51 static inline void KEY_POWER_OFF(void) {
52     /* input with pull-up consumes less than without it when pin is open. */
53     DDRB = 0x00; PORTB = 0xFF;          // change pins input with pull-up
54     DDRD |= (1<<4); PORTD &= ~(1<<4);   // MOS FET switch off
55 }
56 static inline bool KEY_POWER_STATE(void) { return PORTD & (1<<4); }
57 #else
58 static inline void KEY_POWER_ON(void) {}
59 static inline void KEY_POWER_OFF(void) {}
60 static inline bool KEY_POWER_STATE(void) { return true; }
61 #endif
62 static inline void KEY_INIT(void)
63 {
64     /* row,col,prev: output */
65     DDRB  = 0xFF;
66     PORTB = 0x40;   // unable
67     /* key: input with pull-up */
68     DDRD  &= ~0x80;
69     PORTD |=  0x80;
70 #ifdef HHKB_JP
71     /* row extention for HHKB JP */
72     DDRC  |= (1<<6|1<<7);
73     PORTC |= (1<<6|1<<7);
74 #endif
75     KEY_UNABLE();
76     KEY_PREV_OFF();
77
78     KEY_POWER_OFF();
79 }
80 static inline void KEY_SELECT(uint8_t ROW, uint8_t COL)
81 {
82     PORTB = (PORTB & 0xC0) | (((COL) & 0x07)<<3) | ((ROW) & 0x07);
83 #ifdef HHKB_JP
84     if ((ROW) & 0x08) PORTC = (PORTC & ~(1<<6|1<<7)) | (1<<6);
85     else              PORTC = (PORTC & ~(1<<6|1<<7)) | (1<<7);
86 #endif
87 }
88
89
90 #elif defined(__AVR_AT90USB1286__)
91 /*
92  * For Teensy++(AT90USB1286)
93  *
94  *                          HHKB pro    HHKB pro2
95  * row:     PB0-2           (6-8)       (5-7)
96  * col:     PB3-5,6         (9-12)      (8-11)
97  * key:     PE6(pull-uped)  (4)         (3)
98  * prev:    PE7             (5)         (4)
99  *
100  * TODO: convert into 'staitc inline' function
101  */
102 #define KEY_INIT()              do {    \
103     DDRB |= 0x7F;                       \
104     DDRE |=  (1<<7);                    \
105     DDRE &= ~(1<<6);                    \
106     PORTE |= (1<<6);                    \
107 } while (0)
108 #define KEY_SELECT(ROW, COL)    (PORTB = (PORTB & 0xC0) |       \
109                                          (((COL) & 0x07)<<3) |  \
110                                          ((ROW) & 0x07))
111 #define KEY_ENABLE()            (PORTB &= ~(1<<6))
112 #define KEY_UNABLE()            (PORTB |=  (1<<6))
113 #define KEY_STATE()             (PINE & (1<<6))
114 #define KEY_PREV_ON()           (PORTE |=  (1<<7))
115 #define KEY_PREV_OFF()          (PORTE &= ~(1<<7))
116 #define KEY_POWER_ON()
117 #define KEY_POWER_OFF()
118 #define KEY_POWER_STATE()       true
119
120
121 #else
122 #   error "define code for matrix scan"
123 #endif
124
125
126 #if 0
127 // For ATMega328P with V-USB
128 //
129 // #elif defined(__AVR_ATmega328P__)
130 // Ports for V-USB
131 // key:     PB0(pull-uped)
132 // prev:    PB1
133 // row:     PB2-4
134 // col:     PC0-2,3
135 // power:   PB5(Low:on/Hi-z:off)
136 #define KEY_INIT()              do {    \
137     DDRB  |= 0x3E;                      \
138     DDRB  &= ~(1<<0);                   \
139     PORTB |= 1<<0;                      \
140     DDRC  |= 0x0F;                      \
141     KEY_UNABLE();                       \
142     KEY_PREV_OFF();                     \
143 } while (0)
144 #define KEY_SELECT(ROW, COL)    do {    \
145     PORTB = (PORTB & 0xE3) | ((ROW) & 0x07)<<2; \
146     PORTC = (PORTC & 0xF8) | ((COL) & 0x07);    \
147 } while (0)
148 #define KEY_ENABLE()            (PORTC &= ~(1<<3))
149 #define KEY_UNABLE()            (PORTC |=  (1<<3))
150 #define KEY_STATE()             (PINB & (1<<0))
151 #define KEY_PREV_ON()           (PORTB |=  (1<<1))
152 #define KEY_PREV_OFF()          (PORTB &= ~(1<<1))
153 // Power supply switching
154 #define KEY_POWER_ON()          do {    \
155     KEY_INIT();                         \
156     PORTB &= ~(1<<5);                   \
157     _delay_ms(1);                       \
158 } while (0)
159 #define KEY_POWER_OFF()         do {    \
160     DDRB  &= ~0x3F;                     \
161     PORTB &= ~0x3F;                     \
162     DDRC  &= ~0x0F;                     \
163     PORTC &= ~0x0F;                     \
164 } while (0)
165 #endif
166
167 #endif