]> git.donarmstrong.com Git - tmk_firmware.git/blob - keyboard/hhkb_rn42/hhkb_avr.h
Matrix power saving
[tmk_firmware.git] / keyboard / hhkb_rn42 / 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 #else
57 static inline void KEY_POWER_ON(void) {}
58 static inline void KEY_POWER_OFF(void) {}
59 #endif
60 static inline void KEY_INIT(void)
61 {
62     /* row,col,prev: output */
63     DDRB  = 0xFF;
64     PORTB = 0x40;   // unable
65     /* key: input with pull-up */
66     DDRD  &= ~0x80;
67     PORTD |=  0x80;
68 #ifdef HHKB_JP
69     /* row extention for HHKB JP */
70     DDRC  |= (1<<6|1<<7);
71     PORTC |= (1<<6|1<<7);
72 #endif
73     KEY_UNABLE();
74     KEY_PREV_OFF();
75
76     KEY_POWER_ON();
77 }
78 static inline void KEY_SELECT(uint8_t ROW, uint8_t COL)
79 {
80     PORTB = (PORTB & 0xC0) | (((COL) & 0x07)<<3) | ((ROW) & 0x07);
81 #ifdef HHKB_JP
82     if ((ROW) & 0x08) PORTC = (PORTC & ~(1<<6|1<<7)) | (1<<6);
83     else              PORTC = (PORTC & ~(1<<6|1<<7)) | (1<<7);
84 #endif
85 }
86
87
88 #elif defined(__AVR_AT90USB1286__)
89 /*
90  * For Teensy++(AT90USB1286)
91  *
92  *                          HHKB pro    HHKB pro2
93  * row:     PB0-2           (6-8)       (5-7)
94  * col:     PB3-5,6         (9-12)      (8-11)
95  * key:     PE6(pull-uped)  (4)         (3)
96  * prev:    PE7             (5)         (4)
97  *
98  * TODO: convert into 'staitc inline' function
99  */
100 #define KEY_INIT()              do {    \
101     DDRB |= 0x7F;                       \
102     DDRE |=  (1<<7);                    \
103     DDRE &= ~(1<<6);                    \
104     PORTE |= (1<<6);                    \
105 } while (0)
106 #define KEY_SELECT(ROW, COL)    (PORTB = (PORTB & 0xC0) |       \
107                                          (((COL) & 0x07)<<3) |  \
108                                          ((ROW) & 0x07))
109 #define KEY_ENABLE()            (PORTB &= ~(1<<6))
110 #define KEY_UNABLE()            (PORTB |=  (1<<6))
111 #define KEY_STATE()             (PINE & (1<<6))
112 #define KEY_PREV_ON()           (PORTE |=  (1<<7))
113 #define KEY_PREV_OFF()          (PORTE &= ~(1<<7))
114 #define KEY_POWER_ON()
115 #define KEY_POWER_OFF()
116
117
118 #else
119 #   error "define code for matrix scan"
120 #endif
121
122
123 #if 0
124 // For ATMega328P with V-USB
125 //
126 // #elif defined(__AVR_ATmega328P__)
127 // Ports for V-USB
128 // key:     PB0(pull-uped)
129 // prev:    PB1
130 // row:     PB2-4
131 // col:     PC0-2,3
132 // power:   PB5(Low:on/Hi-z:off)
133 #define KEY_INIT()              do {    \
134     DDRB  |= 0x3E;                      \
135     DDRB  &= ~(1<<0);                   \
136     PORTB |= 1<<0;                      \
137     DDRC  |= 0x0F;                      \
138     KEY_UNABLE();                       \
139     KEY_PREV_OFF();                     \
140 } while (0)
141 #define KEY_SELECT(ROW, COL)    do {    \
142     PORTB = (PORTB & 0xE3) | ((ROW) & 0x07)<<2; \
143     PORTC = (PORTC & 0xF8) | ((COL) & 0x07);    \
144 } while (0)
145 #define KEY_ENABLE()            (PORTC &= ~(1<<3))
146 #define KEY_UNABLE()            (PORTC |=  (1<<3))
147 #define KEY_STATE()             (PINB & (1<<0))
148 #define KEY_PREV_ON()           (PORTB |=  (1<<1))
149 #define KEY_PREV_OFF()          (PORTB &= ~(1<<1))
150 // Power supply switching
151 #define KEY_POWER_ON()          do {    \
152     KEY_INIT();                         \
153     PORTB &= ~(1<<5);                   \
154     _delay_ms(1);                       \
155 } while (0)
156 #define KEY_POWER_OFF()         do {    \
157     DDRB  &= ~0x3F;                     \
158     PORTB &= ~0x3F;                     \
159     DDRC  &= ~0x0F;                     \
160     PORTC &= ~0x0F;                     \
161 } while (0)
162 #endif
163
164 #endif