aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2020-02-07 13:59:18 +0000
committerGitHub <noreply@github.com>2020-02-07 13:59:18 +0000
commit774cbbf879eaec2149413917cb970054e4c1bf59 (patch)
tree9d99536f7c8a0d1f53b15a940bbafad30a475db6
parentc93093569ecd6024c43e9b0d2e8881e0f768c940 (diff)
parent75d4ff7d51160690558cf4bee1bae057f847b706 (diff)
downloadqmk_firmware-774cbbf879eaec2149413917cb970054e4c1bf59.tar.gz
qmk_firmware-774cbbf879eaec2149413917cb970054e4c1bf59.zip
Refactor ergo42 to use split_common (#7925)
* Initial refactor of ergo42 to split common * Prevent fallthrough for DIODE_DIRECTION
Diffstat
-rw-r--r--keyboards/ergo42/config.h5
-rw-r--r--keyboards/ergo42/ergo42.h6
-rw-r--r--keyboards/ergo42/i2c.c162
-rw-r--r--keyboards/ergo42/i2c.h49
-rw-r--r--keyboards/ergo42/matrix.c459
-rw-r--r--keyboards/ergo42/readme.md10
-rw-r--r--keyboards/ergo42/rev1/config.h12
-rw-r--r--keyboards/ergo42/rev1/rev1.c21
-rw-r--r--keyboards/ergo42/rev1/rev1.h13
-rw-r--r--keyboards/ergo42/rules.mk30
-rw-r--r--keyboards/ergo42/serial.c228
-rw-r--r--keyboards/ergo42/serial.h26
-rw-r--r--keyboards/ergo42/split_util.c86
-rw-r--r--keyboards/ergo42/split_util.h20
14 files changed, 25 insertions, 1102 deletions
diff --git a/keyboards/ergo42/config.h b/keyboards/ergo42/config.h
index c910d8f24..cfb6bf4ff 100644
--- a/keyboards/ergo42/config.h
+++ b/keyboards/ergo42/config.h
@@ -16,9 +16,6 @@ You should have received a copy of the GNU General Public License
16along with this program. If not, see <http://www.gnu.org/licenses/>. 16along with this program. If not, see <http://www.gnu.org/licenses/>.
17*/ 17*/
18 18
19#ifndef CONFIG_H 19#pragma once
20#define CONFIG_H
21 20
22#include "config_common.h" 21#include "config_common.h"
23
24#endif
diff --git a/keyboards/ergo42/ergo42.h b/keyboards/ergo42/ergo42.h
index faa8170ef..ced1709d3 100644
--- a/keyboards/ergo42/ergo42.h
+++ b/keyboards/ergo42/ergo42.h
@@ -1,5 +1,4 @@
1#ifndef ERGO42_H 1#pragma once
2#define ERGO42_H
3 2
4#include "quantum.h" 3#include "quantum.h"
5 4
@@ -7,7 +6,6 @@
7 #include "rev1.h" 6 #include "rev1.h"
8#endif 7#endif
9 8
10
11// Used to create a keymap using only KC_ prefixed keys 9// Used to create a keymap using only KC_ prefixed keys
12#define LAYOUT_kc_ortho_4x14( \ 10#define LAYOUT_kc_ortho_4x14( \
13 L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, \ 11 L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, \
@@ -23,5 +21,3 @@
23 ) 21 )
24 22
25#define LAYOUT_kc LAYOUT_kc_ortho_4x14 23#define LAYOUT_kc LAYOUT_kc_ortho_4x14
26
27#endif
diff --git a/keyboards/ergo42/i2c.c b/keyboards/ergo42/i2c.c
deleted file mode 100644
index 084c890c4..000000000
--- a/keyboards/ergo42/i2c.c
+++ /dev/null
@@ -1,162 +0,0 @@
1#include <util/twi.h>
2#include <avr/io.h>
3#include <stdlib.h>
4#include <avr/interrupt.h>
5#include <util/twi.h>
6#include <stdbool.h>
7#include "i2c.h"
8
9#ifdef USE_I2C
10
11// Limits the amount of we wait for any one i2c transaction.
12// Since were running SCL line 100kHz (=> 10μs/bit), and each transactions is
13// 9 bits, a single transaction will take around 90μs to complete.
14//
15// (F_CPU/SCL_CLOCK) => # of μC cycles to transfer a bit
16// poll loop takes at least 8 clock cycles to execute
17#define I2C_LOOP_TIMEOUT (9+1)*(F_CPU/SCL_CLOCK)/8
18
19#define BUFFER_POS_INC() (slave_buffer_pos = (slave_buffer_pos+1)%SLAVE_BUFFER_SIZE)
20
21volatile uint8_t i2c_slave_buffer[SLAVE_BUFFER_SIZE];
22
23static volatile uint8_t slave_buffer_pos;
24static volatile bool slave_has_register_set = false;
25
26// Wait for an i2c operation to finish
27inline static
28void i2c_delay(void) {
29 uint16_t lim = 0;
30 while(!(TWCR & (1<<TWINT)) && lim < I2C_LOOP_TIMEOUT)
31 lim++;
32
33 // easier way, but will wait slightly longer
34 // _delay_us(100);
35}
36
37// Setup twi to run at 100kHz
38void i2c_master_init(void) {
39 // no prescaler
40 TWSR = 0;
41 // Set TWI clock frequency to SCL_CLOCK. Need TWBR>10.
42 // Check datasheets for more info.
43 TWBR = ((F_CPU/SCL_CLOCK)-16)/2;
44}
45
46// Start a transaction with the given i2c slave address. The direction of the
47// transfer is set with I2C_READ and I2C_WRITE.
48// returns: 0 => success
49// 1 => error
50uint8_t i2c_master_start(uint8_t address) {
51 TWCR = (1<<TWINT) | (1<<TWEN) | (1<<TWSTA);
52
53 i2c_delay();
54
55 // check that we started successfully
56 if ( (TW_STATUS != TW_START) && (TW_STATUS != TW_REP_START))
57 return 1;
58
59 TWDR = address;
60 TWCR = (1<<TWINT) | (1<<TWEN);
61
62 i2c_delay();
63
64 if ( (TW_STATUS != TW_MT_SLA_ACK) && (TW_STATUS != TW_MR_SLA_ACK) )
65 return 1; // slave did not acknowledge
66 else
67 return 0; // success
68}
69
70
71// Finish the i2c transaction.
72void i2c_master_stop(void) {
73 TWCR = (1<<TWINT) | (1<<TWEN) | (1<<TWSTO);
74
75 uint16_t lim = 0;
76 while(!(TWCR & (1<<TWSTO)) && lim < I2C_LOOP_TIMEOUT)
77 lim++;
78}
79
80// Write one byte to the i2c slave.
81// returns 0 => slave ACK
82// 1 => slave NACK
83uint8_t i2c_master_write(uint8_t data) {
84 TWDR = data;
85 TWCR = (1<<TWINT) | (1<<TWEN);
86
87 i2c_delay();
88
89 // check if the slave acknowledged us
90 return (TW_STATUS == TW_MT_DATA_ACK) ? 0 : 1;
91}
92
93// Read one byte from the i2c slave. If ack=1 the slave is acknowledged,
94// if ack=0 the acknowledge bit is not set.
95// returns: byte read from i2c device
96uint8_t i2c_master_read(int ack) {
97 TWCR = (1<<TWINT) | (1<<TWEN) | (ack<<TWEA);
98
99 i2c_delay();
100 return TWDR;
101}
102
103void i2c_reset_state(void) {
104 TWCR = 0;
105}
106
107void i2c_slave_init(uint8_t address) {
108 TWAR = address << 0; // slave i2c address
109 // TWEN - twi enable
110 // TWEA - enable address acknowledgement
111 // TWINT - twi interrupt flag
112 // TWIE - enable the twi interrupt
113 TWCR = (1<<TWIE) | (1<<TWEA) | (1<<TWINT) | (1<<TWEN);
114}
115
116ISR(TWI_vect);
117
118ISR(TWI_vect) {
119 uint8_t ack = 1;
120 switch(TW_STATUS) {
121 case TW_SR_SLA_ACK:
122 // this device has been addressed as a slave receiver
123 slave_has_register_set = false;
124 break;
125
126 case TW_SR_DATA_ACK:
127 // this device has received data as a slave receiver
128 // The first byte that we receive in this transaction sets the location
129 // of the read/write location of the slaves memory that it exposes over
130 // i2c. After that, bytes will be written at slave_buffer_pos, incrementing
131 // slave_buffer_pos after each write.
132 if(!slave_has_register_set) {
133 slave_buffer_pos = TWDR;
134 // don't acknowledge the master if this memory loctaion is out of bounds
135 if ( slave_buffer_pos >= SLAVE_BUFFER_SIZE ) {
136 ack = 0;
137 slave_buffer_pos = 0;
138 }
139 slave_has_register_set = true;
140 } else {
141 i2c_slave_buffer[slave_buffer_pos] = TWDR;
142 BUFFER_POS_INC();
143 }
144 break;
145
146 case TW_ST_SLA_ACK:
147 case TW_ST_DATA_ACK:
148 // master has addressed this device as a slave transmitter and is
149 // requesting data.
150 TWDR = i2c_slave_buffer[slave_buffer_pos];
151 BUFFER_POS_INC();
152 break;
153
154 case TW_BUS_ERROR: // something went wrong, reset twi state
155 TWCR = 0;
156 default:
157 break;
158 }
159 // Reset everything, so we are ready for the next TWI interrupt
160 TWCR |= (1<<TWIE) | (1<<TWINT) | (ack<<TWEA) | (1<<TWEN);
161}
162#endif
diff --git a/keyboards/ergo42/i2c.h b/keyboards/ergo42/i2c.h
deleted file mode 100644
index c15b6bc50..000000000
--- a/keyboards/ergo42/i2c.h
+++ /dev/null
@@ -1,49 +0,0 @@
1#ifndef I2C_H
2#define I2C_H
3
4#include <stdint.h>
5
6#ifndef F_CPU
7#define F_CPU 16000000UL
8#endif
9
10#define I2C_READ 1
11#define I2C_WRITE 0
12
13#define I2C_ACK 1
14#define I2C_NACK 0
15
16#define SLAVE_BUFFER_SIZE 0x10
17
18// i2c SCL clock frequency
19#define SCL_CLOCK 400000L
20
21extern volatile uint8_t i2c_slave_buffer[SLAVE_BUFFER_SIZE];
22
23void i2c_master_init(void);
24uint8_t i2c_master_start(uint8_t address);
25void i2c_master_stop(void);
26uint8_t i2c_master_write(uint8_t data);
27uint8_t i2c_master_read(int);
28void i2c_reset_state(void);
29void i2c_slave_init(uint8_t address);
30
31
32static inline unsigned char i2c_start_read(unsigned char addr) {
33 return i2c_master_start((addr << 1) | I2C_READ);
34}
35
36static inline unsigned char i2c_start_write(unsigned char addr) {
37 return i2c_master_start((addr << 1) | I2C_WRITE);
38}
39
40// from SSD1306 scrips
41extern unsigned char i2c_rep_start(unsigned char addr);
42extern void i2c_start_wait(unsigned char addr);
43extern unsigned char i2c_readAck(void);
44extern unsigned char i2c_readNak(void);
45extern unsigned char i2c_read(unsigned char ack);
46
47#define i2c_read(ack) (ack) ? i2c_readAck() : i2c_readNak();
48
49#endif
diff --git a/keyboards/ergo42/matrix.c b/keyboards/ergo42/matrix.c
deleted file mode 100644
index 328d16c77..000000000
--- a/keyboards/ergo42/matrix.c
+++ /dev/null
@@ -1,459 +0,0 @@
1/*
2Copyright 2012 Jun Wako <wakojun@gmail.com>
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18/*
19 * scan matrix
20 */
21#include <stdint.h>
22#include <stdbool.h>
23#include <avr/io.h>
24#include "wait.h"
25#include "print.h"
26#include "debug.h"
27#include "util.h"
28#include "matrix.h"
29#include "split_util.h"
30#include "pro_micro.h"
31#include "config.h"
32#include "timer.h"
33
34#ifdef USE_I2C
35# include "i2c.h"
36#else // USE_SERIAL
37# include "serial.h"
38#endif
39
40#ifndef DEBOUNCE
41# define DEBOUNCE 5
42#endif
43
44#if (DEBOUNCE > 0)
45 static uint16_t debouncing_time;
46 static bool debouncing = false;
47#endif
48
49#if (MATRIX_COLS <= 8)
50# define print_matrix_header() print("\nr/c 01234567\n")
51# define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
52# define matrix_bitpop(i) bitpop(matrix[i])
53# define ROW_SHIFTER ((uint8_t)1)
54#else
55# error "Currently only supports 8 COLS"
56#endif
57static matrix_row_t matrix_debouncing[MATRIX_ROWS];
58
59#define ERROR_DISCONNECT_COUNT 5
60
61#define ROWS_PER_HAND (MATRIX_ROWS/2)
62
63static uint8_t error_count = 0;
64
65static const uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
66static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
67
68/* matrix state(1:on, 0:off) */
69static matrix_row_t matrix[MATRIX_ROWS];
70static matrix_row_t matrix_debouncing[MATRIX_ROWS];
71
72#if (DIODE_DIRECTION == COL2ROW)
73 static void init_cols(void);
74 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
75 static void unselect_rows(void);
76 static void select_row(uint8_t row);
77 static void unselect_row(uint8_t row);
78#elif (DIODE_DIRECTION == ROW2COL)
79 static void init_rows(void);
80 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
81 static void unselect_cols(void);
82 static void unselect_col(uint8_t col);
83 static void select_col(uint8_t col);
84#endif
85
86__attribute__ ((weak))
87void matrix_init_kb(void) {
88 matrix_init_user();
89}
90
91__attribute__ ((weak))
92void matrix_scan_kb(void) {
93 matrix_scan_user();
94}
95
96__attribute__ ((weak))
97void matrix_init_user(void) {
98}
99
100__attribute__ ((weak))
101void matrix_scan_user(void) {
102}
103
104inline
105uint8_t matrix_rows(void)
106{
107 return MATRIX_ROWS;
108}
109
110inline
111uint8_t matrix_cols(void)
112{
113 return MATRIX_COLS;
114}
115
116void matrix_init(void)
117{
118 debug_enable = true;
119 debug_matrix = true;
120 debug_mouse = true;
121 // initialize row and col
122#if (DIODE_DIRECTION == COL2ROW)
123 unselect_rows();
124 init_cols();
125#elif (DIODE_DIRECTION == ROW2COL)
126 unselect_cols();
127 init_rows();
128#endif
129
130 TX_RX_LED_INIT;
131
132 // initialize matrix state: all keys off
133 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
134 matrix[i] = 0;
135 matrix_debouncing[i] = 0;
136 }
137
138 matrix_init_quantum();
139
140}
141
142uint8_t _matrix_scan(void)
143{
144 int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
145#if (DIODE_DIRECTION == COL2ROW)
146 // Set row, read cols
147 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
148# if (DEBOUNCE > 0)
149 bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
150
151 if (matrix_changed) {
152 debouncing = true;
153 debouncing_time = timer_read();
154 }
155
156# else
157 read_cols_on_row(matrix+offset, current_row);
158# endif
159
160 }
161
162#elif (DIODE_DIRECTION == ROW2COL)
163 // Set col, read rows
164 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
165# if (DEBOUNCE > 0)
166 bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
167 if (matrix_changed) {
168 debouncing = true;
169 debouncing_time = timer_read();
170 }
171# else
172 read_rows_on_col(matrix+offset, current_col);
173# endif
174
175 }
176#endif
177
178# if (DEBOUNCE > 0)
179 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCE)) {
180 for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
181 matrix[i+offset] = matrix_debouncing[i+offset];
182 }
183 debouncing = false;
184 }
185# endif
186
187 return 1;
188}
189
190#ifdef USE_I2C
191
192// Get rows from other half over i2c
193int i2c_transaction(void) {
194 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
195
196 int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
197 if (err) goto i2c_error;
198
199 // start of matrix stored at 0x00
200 err = i2c_master_write(0x00);
201 if (err) goto i2c_error;
202
203 // Start read
204 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
205 if (err) goto i2c_error;
206
207 if (!err) {
208 int i;
209 for (i = 0; i < ROWS_PER_HAND-1; ++i) {
210 matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
211 }
212 matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
213 i2c_master_stop();
214 } else {
215i2c_error: // the cable is disconnceted, or something else went wrong
216 i2c_reset_state();
217 return err;
218 }
219
220 return 0;
221}
222
223#else // USE_SERIAL
224
225int serial_transaction(void) {
226 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
227
228 if (serial_update_buffers()) {
229 return 1;
230 }
231
232 for (int i = 0; i < ROWS_PER_HAND; ++i) {
233 matrix[slaveOffset+i] = serial_slave_buffer[i];
234 }
235 return 0;
236}
237#endif
238
239uint8_t matrix_scan(void)
240{
241 uint8_t ret = _matrix_scan();
242
243#ifdef USE_I2C
244 if( i2c_transaction() ) {
245#else // USE_SERIAL
246 if( serial_transaction() ) {
247#endif
248 // turn on the indicator led when halves are disconnected
249 TXLED1;
250
251 error_count++;
252
253 if (error_count > ERROR_DISCONNECT_COUNT) {
254 // reset other half if disconnected
255 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
256 for (int i = 0; i < ROWS_PER_HAND; ++i) {
257 matrix[slaveOffset+i] = 0;
258 }
259 }
260 } else {
261 // turn off the indicator led on no error
262 TXLED0;
263 error_count = 0;
264 }
265 matrix_scan_quantum();
266 return ret;
267}
268
269void matrix_slave_scan(void) {
270 _matrix_scan();
271
272 int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
273
274#ifdef USE_I2C
275 for (int i = 0; i < ROWS_PER_HAND; ++i) {
276 i2c_slave_buffer[i] = matrix[offset+i];
277 }
278#else // USE_SERIAL
279 for (int i = 0; i < ROWS_PER_HAND; ++i) {
280 serial_slave_buffer[i] = matrix[offset+i];
281 }
282#endif
283}
284
285bool matrix_is_modified(void)
286{
287 if (debouncing) return false;
288 return true;
289}
290
291inline
292bool matrix_is_on(uint8_t row, uint8_t col)
293{
294 return (matrix[row] & ((matrix_row_t)1<<col));
295}
296
297inline
298matrix_row_t matrix_get_row(uint8_t row)
299{
300 return matrix[row];
301}
302
303void matrix_print(void)
304{
305 print("\nr/c 0123456789ABCDEF\n");
306 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
307 phex(row); print(": ");
308 pbin_reverse16(matrix_get_row(row));
309 print("\n");
310 }
311}
312
313uint8_t matrix_key_count(void)
314{
315 uint8_t count = 0;
316 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
317 count += bitpop16(matrix[i]);
318 }
319 return count;
320}
321
322#if (DIODE_DIRECTION == COL2ROW)
323
324static void init_cols(void)
325{
326 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
327 uint8_t pin = col_pins[x];
328 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
329 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
330 }
331}
332
333static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
334{
335 // Store last value of row prior to reading
336 matrix_row_t last_row_value = current_matrix[current_row];
337
338 // Clear data in matrix row
339 current_matrix[current_row] = 0;
340
341 // Select row and wait for row selecton to stabilize
342 select_row(current_row);
343 wait_us(30);
344
345 // For each col...
346 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
347
348 // Select the col pin to read (active low)
349 uint8_t pin = col_pins[col_index];
350 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
351
352 // Populate the matrix row with the state of the col pin
353 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
354 }
355
356 // Unselect row
357 unselect_row(current_row);
358
359 return (last_row_value != current_matrix[current_row]);
360}
361
362static void select_row(uint8_t row)
363{
364 uint8_t pin = row_pins[row];
365 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
366 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
367}
368
369static void unselect_row(uint8_t row)
370{
371 uint8_t pin = row_pins[row];
372 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
373 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
374}
375
376static void unselect_rows(void)
377{
378 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
379 uint8_t pin = row_pins[x];
380 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
381 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
382 }
383}
384
385#elif (DIODE_DIRECTION == ROW2COL)
386
387static void init_rows(void)
388{
389 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
390 uint8_t pin = row_pins[x];
391 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
392 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
393 }
394}
395
396static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
397{
398 bool matrix_changed = false;
399
400 // Select col and wait for col selecton to stabilize
401 select_col(current_col);
402 wait_us(30);
403
404 // For each row...
405 for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
406 {
407
408 // Store last value of row prior to reading
409 matrix_row_t last_row_value = current_matrix[row_index];
410
411 // Check row pin state
412 if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
413 {
414 // Pin LO, set col bit
415 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
416 }
417 else
418 {
419 // Pin HI, clear col bit
420 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
421 }
422
423 // Determine if the matrix changed state
424 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
425 {
426 matrix_changed = true;
427 }
428 }
429
430 // Unselect col
431 unselect_col(current_col);
432
433 return matrix_changed;
434}
435
436static void select_col(uint8_t col)
437{
438 uint8_t pin = col_pins[col];
439 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
440 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
441}
442
443static void unselect_col(uint8_t col)
444{
445 uint8_t pin = col_pins[col];
446 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
447 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
448}
449
450static void unselect_cols(void)
451{
452 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
453 uint8_t pin = col_pins[x];
454 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
455 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
456 }
457}
458
459#endif
diff --git a/keyboards/ergo42/readme.md b/keyboards/ergo42/readme.md
index 112e62b55..c43b47382 100644
--- a/keyboards/ergo42/readme.md
+++ b/keyboards/ergo42/readme.md
@@ -5,12 +5,12 @@
5__The Answer to the Ultimate Question of Life, the Universe, and at least Keyboards.__ 5__The Answer to the Ultimate Question of Life, the Universe, and at least Keyboards.__
6A split 7x4 ortholinear keyboard. [Hardware project repo](https://github.com/Biacco42/Ergo42) 6A split 7x4 ortholinear keyboard. [Hardware project repo](https://github.com/Biacco42/Ergo42)
7 7
8Keyboard Maintainer: [Biacco42](https://github.com/Biacco42) [@Biacco42](https://twitter.com/Biacco42) 8* Keyboard Maintainer: [Biacco42](https://github.com/Biacco42) [@Biacco42](https://twitter.com/Biacco42)
9Hardware Supported: Ergo42 PCB, Pro Micro ATmega32u4 9* Hardware Supported: Ergo42 PCB, Pro Micro ATmega32u4
10Hardware Availability: [Ergo42 PCB and case](https://github.com/Biacco42/Ergo42) 10* Hardware Availability: [Ergo42 PCB and case](https://github.com/Biacco42/Ergo42)
11 11
12Make example for this keyboard (after setting up your build environment): 12Make example for this keyboard (after setting up your build environment):
13 13
14 make ergo42/rev1:default:avrdude 14 make ergo42/rev1:default:flash
15 15
16See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. 16See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/ergo42/rev1/config.h b/keyboards/ergo42/rev1/config.h
index f8fae93cf..3850be968 100644
--- a/keyboards/ergo42/rev1/config.h
+++ b/keyboards/ergo42/rev1/config.h
@@ -17,8 +17,7 @@ You should have received a copy of the GNU General Public License
17along with this program. If not, see <http://www.gnu.org/licenses/>. 17along with this program. If not, see <http://www.gnu.org/licenses/>.
18*/ 18*/
19 19
20#ifndef REV1_CONFIG_H 20#pragma once
21#define REV1_CONFIG_H
22 21
23#include "config_common.h" 22#include "config_common.h"
24 23
@@ -40,8 +39,10 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
40#define MATRIX_COL_PINS { F5, F6, F7, B1, B3, B2, B6 } 39#define MATRIX_COL_PINS { F5, F6, F7, B1, B3, B2, B6 }
41// #define MATRIX_COL_PINS { B6, B2, B3, B1, F7, F6 } //uncomment this line and comment line above if you need to reverse left-to-right key order 40// #define MATRIX_COL_PINS { B6, B2, B3, B1, F7, F6 } //uncomment this line and comment line above if you need to reverse left-to-right key order
42 41
43/* define tapping term */ 42/* COL2ROW, ROW2COL*/
44#define TAPPING_TERM 100 43#define DIODE_DIRECTION COL2ROW
44
45#define SOFT_SERIAL_PIN D0
45 46
46/* define if matrix has ghost */ 47/* define if matrix has ghost */
47//#define MATRIX_HAS_GHOST 48//#define MATRIX_HAS_GHOST
@@ -59,7 +60,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
59 60
60/* ws2812 RGB LED */ 61/* ws2812 RGB LED */
61#define RGB_DI_PIN D3 62#define RGB_DI_PIN D3
62
63#define RGBLED_NUM 12 // Number of LEDs 63#define RGBLED_NUM 12 // Number of LEDs
64 64
65/* 65/*
@@ -79,5 +79,3 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
79//#define NO_ACTION_ONESHOT 79//#define NO_ACTION_ONESHOT
80//#define NO_ACTION_MACRO 80//#define NO_ACTION_MACRO
81//#define NO_ACTION_FUNCTION 81//#define NO_ACTION_FUNCTION
82
83#endif
diff --git a/keyboards/ergo42/rev1/rev1.c b/keyboards/ergo42/rev1/rev1.c
index f2e8abb1a..626a0893b 100644
--- a/keyboards/ergo42/rev1/rev1.c
+++ b/keyboards/ergo42/rev1/rev1.c
@@ -1,22 +1 @@
1#include "ergo42.h" #include "ergo42.h"
2
3#ifdef SSD1306OLED
4void led_set_kb(uint8_t usb_led) {
5 // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
6 led_set_user(usb_led);
7}
8#endif
9
10void matrix_init_kb(void) {
11
12 // // green led on
13 // DDRD |= (1<<5);
14 // PORTD &= ~(1<<5);
15
16 // // orange led on
17 // DDRB |= (1<<0);
18 // PORTB &= ~(1<<0);
19
20 matrix_init_user();
21};
22
diff --git a/keyboards/ergo42/rev1/rev1.h b/keyboards/ergo42/rev1/rev1.h
index 724ec3897..9a5aec4d2 100644
--- a/keyboards/ergo42/rev1/rev1.h
+++ b/keyboards/ergo42/rev1/rev1.h
@@ -1,18 +1,9 @@
1#ifndef REV1_H 1#pragma once
2#define REV1_H
3 2
4#include "ergo42.h" 3#include "ergo42.h"
5 4
6#include "quantum.h" 5#include "quantum.h"
7 6
8#ifdef USE_I2C
9#include <stddef.h>
10#ifdef __AVR__
11 #include <avr/io.h>
12 #include <avr/interrupt.h>
13#endif
14#endif
15
16#ifndef FLIP_HALF 7#ifndef FLIP_HALF
17// Standard Keymap 8// Standard Keymap
18// (TRRS jack on the left half is to the right, TRRS jack on the right half is to the left) 9// (TRRS jack on the left half is to the right, TRRS jack on the right half is to the left)
@@ -54,5 +45,3 @@
54#endif 45#endif
55 46
56#define LAYOUT LAYOUT_ortho_4x14 47#define LAYOUT LAYOUT_ortho_4x14
57
58#endif
diff --git a/keyboards/ergo42/rules.mk b/keyboards/ergo42/rules.mk
index 7374ef037..3f55da67a 100644
--- a/keyboards/ergo42/rules.mk
+++ b/keyboards/ergo42/rules.mk
@@ -12,32 +12,26 @@ MCU = atmega32u4
12BOOTLOADER = caterina 12BOOTLOADER = caterina
13 13
14# Build Options 14# Build Options
15# change to "no" to disable the options, or define them in the Makefile in 15# change yes to no to disable
16# the appropriate keymap folder that will get included automatically
17# 16#
18BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration 17BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
19MOUSEKEY_ENABLE = yes # Mouse keys 18MOUSEKEY_ENABLE = yes # Mouse keys
20EXTRAKEY_ENABLE = yes # Audio control and System control 19EXTRAKEY_ENABLE = yes # Audio control and System control
21CONSOLE_ENABLE = no # Console for debug 20CONSOLE_ENABLE = no # Console for debug
22COMMAND_ENABLE = yes # Commands for debug and configuration 21COMMAND_ENABLE = yes # Commands for debug and configuration
23NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
24BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
25MIDI_ENABLE = no # MIDI controls
26AUDIO_ENABLE = no # Audio output on port C6
27UNICODE_ENABLE = no # Unicode
28BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
29RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight.
30SUBPROJECT_rev1 = yes
31USE_I2C = yes
32# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE 22# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
33SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend 23SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
24# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
25NKRO_ENABLE = no # USB Nkey Rollover
26BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
27RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
28MIDI_ENABLE = no # MIDI support
29BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
30AUDIO_ENABLE = no # Audio output on port C6
31FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
32HD44780_ENABLE = no # Enable support for HD44780 based LCDs
34 33
35CUSTOM_MATRIX = yes 34SPLIT_KEYBOARD = yes
36SRC += matrix.c \
37 i2c.c \
38 split_util.c \
39 serial.c \
40 ssd1306.c
41 35
42LAYOUTS = ortho_4x14 36LAYOUTS = ortho_4x14
43 37
diff --git a/keyboards/ergo42/serial.c b/keyboards/ergo42/serial.c
deleted file mode 100644
index 74bcbb6bf..000000000
--- a/keyboards/ergo42/serial.c
+++ /dev/null
@@ -1,228 +0,0 @@
1/*
2 * WARNING: be careful changing this code, it is very timing dependent
3 */
4
5#ifndef F_CPU
6#define F_CPU 16000000
7#endif
8
9#include <avr/io.h>
10#include <avr/interrupt.h>
11#include <util/delay.h>
12#include <stdbool.h>
13#include "serial.h"
14
15#ifndef USE_I2C
16
17// Serial pulse period in microseconds. Its probably a bad idea to lower this
18// value.
19#define SERIAL_DELAY 24
20
21uint8_t volatile serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH] = {0};
22uint8_t volatile serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH] = {0};
23
24#define SLAVE_DATA_CORRUPT (1<<0)
25volatile uint8_t status = 0;
26
27inline static
28void serial_delay(void) {
29 _delay_us(SERIAL_DELAY);
30}
31
32inline static
33void serial_output(void) {
34 SERIAL_PIN_DDR |= SERIAL_PIN_MASK;
35}
36
37// make the serial pin an input with pull-up resistor
38inline static
39void serial_input(void) {
40 SERIAL_PIN_DDR &= ~SERIAL_PIN_MASK;
41 SERIAL_PIN_PORT |= SERIAL_PIN_MASK;
42}
43
44inline static
45uint8_t serial_read_pin(void) {
46 return !!(SERIAL_PIN_INPUT & SERIAL_PIN_MASK);
47}
48
49inline static
50void serial_low(void) {
51 SERIAL_PIN_PORT &= ~SERIAL_PIN_MASK;
52}
53
54inline static
55void serial_high(void) {
56 SERIAL_PIN_PORT |= SERIAL_PIN_MASK;
57}
58
59void serial_master_init(void) {
60 serial_output();
61 serial_high();
62}
63
64void serial_slave_init(void) {
65 serial_input();
66
67 // Enable INT0
68 EIMSK |= _BV(INT0);
69 // Trigger on falling edge of INT0
70 EICRA &= ~(_BV(ISC00) | _BV(ISC01));
71}
72
73// Used by the master to synchronize timing with the slave.
74static
75void sync_recv(void) {
76 serial_input();
77 // This shouldn't hang if the slave disconnects because the
78 // serial line will float to high if the slave does disconnect.
79 while (!serial_read_pin());
80 serial_delay();
81}
82
83// Used by the slave to send a synchronization signal to the master.
84static
85void sync_send(void) {
86 serial_output();
87
88 serial_low();
89 serial_delay();
90
91 serial_high();
92}
93
94// Reads a byte from the serial line
95static
96uint8_t serial_read_byte(void) {
97 uint8_t byte = 0;
98 serial_input();
99 for ( uint8_t i = 0; i < 8; ++i) {
100 byte = (byte << 1) | serial_read_pin();
101 serial_delay();
102 _delay_us(1);
103 }
104
105 return byte;
106}
107
108// Sends a byte with MSB ordering
109static
110void serial_write_byte(uint8_t data) {
111 uint8_t b = 8;
112 serial_output();
113 while( b-- ) {
114 if(data & (1 << b)) {
115 serial_high();
116 } else {
117 serial_low();
118 }
119 serial_delay();
120 }
121}
122
123// interrupt handle to be used by the slave device
124ISR(SERIAL_PIN_INTERRUPT) {
125 sync_send();
126
127 uint8_t checksum = 0;
128 for (int i = 0; i < SERIAL_SLAVE_BUFFER_LENGTH; ++i) {
129 serial_write_byte(serial_slave_buffer[i]);
130 sync_send();
131 checksum += serial_slave_buffer[i];
132 }
133 serial_write_byte(checksum);
134 sync_send();
135
136 // wait for the sync to finish sending
137 serial_delay();
138
139 // read the middle of pulses
140 _delay_us(SERIAL_DELAY/2);
141
142 uint8_t checksum_computed = 0;
143 for (int i = 0; i < SERIAL_MASTER_BUFFER_LENGTH; ++i) {
144 serial_master_buffer[i] = serial_read_byte();
145 sync_send();
146 checksum_computed += serial_master_buffer[i];
147 }
148 uint8_t checksum_received = serial_read_byte();
149 sync_send();
150
151 serial_input(); // end transaction
152
153 if ( checksum_computed != checksum_received ) {
154 status |= SLAVE_DATA_CORRUPT;
155 } else {
156 status &= ~SLAVE_DATA_CORRUPT;
157 }
158}
159
160inline
161bool serial_slave_DATA_CORRUPT(void) {
162 return status & SLAVE_DATA_CORRUPT;
163}
164
165// Copies the serial_slave_buffer to the master and sends the
166// serial_master_buffer to the slave.
167//
168// Returns:
169// 0 => no error
170// 1 => slave did not respond
171int serial_update_buffers(void) {
172 // this code is very time dependent, so we need to disable interrupts
173 cli();
174
175 // signal to the slave that we want to start a transaction
176 serial_output();
177 serial_low();
178 _delay_us(1);
179
180 // wait for the slaves response
181 serial_input();
182 serial_high();
183 _delay_us(SERIAL_DELAY);
184
185 // check if the slave is present
186 if (serial_read_pin()) {
187 // slave failed to pull the line low, assume not present
188 sei();
189 return 1;
190 }
191
192 // if the slave is present syncronize with it
193 sync_recv();
194
195 uint8_t checksum_computed = 0;
196 // receive data from the slave
197 for (int i = 0; i < SERIAL_SLAVE_BUFFER_LENGTH; ++i) {
198 serial_slave_buffer[i] = serial_read_byte();
199 sync_recv();
200 checksum_computed += serial_slave_buffer[i];
201 }
202 uint8_t checksum_received = serial_read_byte();
203 sync_recv();
204
205 if (checksum_computed != checksum_received) {
206 sei();
207 return 1;
208 }
209
210 uint8_t checksum = 0;
211 // send data to the slave
212 for (int i = 0; i < SERIAL_MASTER_BUFFER_LENGTH; ++i) {
213 serial_write_byte(serial_master_buffer[i]);
214 sync_recv();
215 checksum += serial_master_buffer[i];
216 }
217 serial_write_byte(checksum);
218 sync_recv();
219
220 // always, release the line when not in use
221 serial_output();
222 serial_high();
223
224 sei();
225 return 0;
226}
227
228#endif
diff --git a/keyboards/ergo42/serial.h b/keyboards/ergo42/serial.h
deleted file mode 100644
index 15fe4db7b..000000000
--- a/keyboards/ergo42/serial.h
+++ /dev/null
@@ -1,26 +0,0 @@
1#ifndef MY_SERIAL_H
2#define MY_SERIAL_H
3
4#include "config.h"
5#include <stdbool.h>
6
7/* TODO: some defines for interrupt setup */
8#define SERIAL_PIN_DDR DDRD
9#define SERIAL_PIN_PORT PORTD
10#define SERIAL_PIN_INPUT PIND
11#define SERIAL_PIN_MASK _BV(PD0)
12#define SERIAL_PIN_INTERRUPT INT0_vect
13
14#define SERIAL_SLAVE_BUFFER_LENGTH MATRIX_ROWS/2
15#define SERIAL_MASTER_BUFFER_LENGTH 1
16
17// Buffers for master - slave communication
18extern volatile uint8_t serial_slave_buffer[SERIAL_SLAVE_BUFFER_LENGTH];
19extern volatile uint8_t serial_master_buffer[SERIAL_MASTER_BUFFER_LENGTH];
20
21void serial_master_init(void);
22void serial_slave_init(void);
23int serial_update_buffers(void);
24bool serial_slave_data_corrupt(void);
25
26#endif
diff --git a/keyboards/ergo42/split_util.c b/keyboards/ergo42/split_util.c
deleted file mode 100644
index 346cbc908..000000000
--- a/keyboards/ergo42/split_util.c
+++ /dev/null
@@ -1,86 +0,0 @@
1#include <avr/io.h>
2#include <avr/wdt.h>
3#include <avr/power.h>
4#include <avr/interrupt.h>
5#include <util/delay.h>
6#include <avr/eeprom.h>
7#include "split_util.h"
8#include "matrix.h"
9#include "keyboard.h"
10#include "config.h"
11#include "timer.h"
12
13#ifdef USE_I2C
14# include "i2c.h"
15#else
16# include "serial.h"
17#endif
18
19volatile bool isLeftHand = true;
20
21static void setup_handedness(void) {
22 #ifdef EE_HANDS
23 isLeftHand = eeprom_read_byte(EECONFIG_HANDEDNESS);
24 #else
25 // I2C_MASTER_RIGHT is deprecated, use MASTER_RIGHT instead, since this works for both serial and i2c
26 #if defined(I2C_MASTER_RIGHT) || defined(MASTER_RIGHT)
27 isLeftHand = !has_usb();
28 #else
29 isLeftHand = has_usb();
30 #endif
31 #endif
32}
33
34static void keyboard_master_setup(void) {
35#ifdef USE_I2C
36 i2c_master_init();
37#ifdef SSD1306OLED
38 matrix_master_OLED_init ();
39#endif
40#else
41 serial_master_init();
42#endif
43}
44
45static void keyboard_slave_setup(void) {
46 timer_init();
47#ifdef USE_I2C
48 i2c_slave_init(SLAVE_I2C_ADDRESS);
49#else
50 serial_slave_init();
51#endif
52}
53
54bool has_usb(void) {
55 USBCON |= (1 << OTGPADE); //enables VBUS pad
56 _delay_us(5);
57 return (USBSTA & (1<<VBUS)); //checks state of VBUS
58}
59
60void split_keyboard_setup(void) {
61 setup_handedness();
62
63 if (has_usb()) {
64 keyboard_master_setup();
65 } else {
66 keyboard_slave_setup();
67 }
68 sei();
69}
70
71void keyboard_slave_loop(void) {
72 matrix_init();
73
74 while (1) {
75 matrix_slave_scan();
76 }
77}
78
79// this code runs before the usb and keyboard is initialized
80void matrix_setup(void) {
81 split_keyboard_setup();
82
83 if (!has_usb()) {
84 keyboard_slave_loop();
85 }
86}
diff --git a/keyboards/ergo42/split_util.h b/keyboards/ergo42/split_util.h
deleted file mode 100644
index 595a0659e..000000000
--- a/keyboards/ergo42/split_util.h
+++ /dev/null
@@ -1,20 +0,0 @@
1#ifndef SPLIT_KEYBOARD_UTIL_H
2#define SPLIT_KEYBOARD_UTIL_H
3
4#include <stdbool.h>
5#include "eeconfig.h"
6
7#define SLAVE_I2C_ADDRESS 0x32
8
9extern volatile bool isLeftHand;
10
11// slave version of matix scan, defined in matrix.c
12void matrix_slave_scan(void);
13
14void split_keyboard_setup(void);
15bool has_usb(void);
16void keyboard_slave_loop(void);
17
18void matrix_master_OLED_init (void);
19
20#endif
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-14 13:19:16 +0000