Update ps2avrgb template to use standard matrix/i2c code (#4957)
* Update ps2avrgb template to use standard matrix/i2c code * Default to an 8x11 matrix in the ps2avrgb template
This commit is contained in:
		
							parent
							
								
									dad66cad40
								
							
						
					
					
						commit
						4c1760883e
					
				
					 7 changed files with 100 additions and 271 deletions
				
			
		| 
						 | 
				
			
			@ -15,6 +15,12 @@
 | 
			
		|||
 */
 | 
			
		||||
#include "%KEYBOARD%.h"
 | 
			
		||||
 | 
			
		||||
// Optional override functions below.
 | 
			
		||||
// You can leave any or all of these undefined.
 | 
			
		||||
// These are only required if you want to perform custom actions.
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 | 
			
		||||
void matrix_init_kb(void) {
 | 
			
		||||
  // put your keyboard start-up code here
 | 
			
		||||
  // runs once when the firmware starts up
 | 
			
		||||
| 
						 | 
				
			
			@ -41,3 +47,5 @@ void led_set_kb(uint8_t usb_led) {
 | 
			
		|||
 | 
			
		||||
  led_set_user(usb_led);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
*/
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -21,17 +21,20 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		|||
 | 
			
		||||
#define VENDOR_ID       0x20A0
 | 
			
		||||
#define PRODUCT_ID      0x422D
 | 
			
		||||
#define DEVICE_VER      0x0001
 | 
			
		||||
#define MANUFACTURER    You
 | 
			
		||||
#define PRODUCT         %KEYBOARD%
 | 
			
		||||
#define DESCRIPTION     A custom keyboard
 | 
			
		||||
 | 
			
		||||
#define RGBLED_NUM 16
 | 
			
		||||
 | 
			
		||||
#define MATRIX_ROWS 2
 | 
			
		||||
#define MATRIX_COLS 3
 | 
			
		||||
#define MATRIX_ROWS 8
 | 
			
		||||
#define MATRIX_COLS 11
 | 
			
		||||
 | 
			
		||||
#define MATRIX_ROW_PINS { D0, D5 }
 | 
			
		||||
#define MATRIX_COL_PINS { F1, F0, B0 }
 | 
			
		||||
#define UNUSED_PINS
 | 
			
		||||
#define MATRIX_ROW_PINS { B0, B1, B2, B3, B4, B5, B6, B7 }
 | 
			
		||||
#define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5 }
 | 
			
		||||
// #define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5, C4, C3, C2, C1, C0, D7 }
 | 
			
		||||
#define UNUSED_PINS     {}
 | 
			
		||||
 | 
			
		||||
#define DIODE_DIRECTION COL2ROW
 | 
			
		||||
#define DEBOUNCING_DELAY 5
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,106 +0,0 @@
 | 
			
		|||
/*
 | 
			
		||||
Copyright 2016 Luiz Ribeiro <luizribeiro@gmail.com>
 | 
			
		||||
 | 
			
		||||
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/>.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
// Please do not modify this file
 | 
			
		||||
 | 
			
		||||
#include <avr/io.h>
 | 
			
		||||
#include <util/twi.h>
 | 
			
		||||
 | 
			
		||||
#include "i2c.h"
 | 
			
		||||
 | 
			
		||||
void i2c_set_bitrate(uint16_t bitrate_khz) {
 | 
			
		||||
    uint8_t bitrate_div = ((F_CPU / 1000l) / bitrate_khz);
 | 
			
		||||
    if (bitrate_div >= 16) {
 | 
			
		||||
        bitrate_div = (bitrate_div - 16) / 2;
 | 
			
		||||
    }
 | 
			
		||||
    TWBR = bitrate_div;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void i2c_init(void) {
 | 
			
		||||
    // set pull-up resistors on I2C bus pins
 | 
			
		||||
    PORTC |= 0b11;
 | 
			
		||||
 | 
			
		||||
    i2c_set_bitrate(400);
 | 
			
		||||
 | 
			
		||||
    // enable TWI (two-wire interface)
 | 
			
		||||
    TWCR |= (1 << TWEN);
 | 
			
		||||
 | 
			
		||||
    // enable TWI interrupt and slave address ACK
 | 
			
		||||
    TWCR |= (1 << TWIE);
 | 
			
		||||
    TWCR |= (1 << TWEA);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t i2c_start(uint8_t address) {
 | 
			
		||||
    // reset TWI control register
 | 
			
		||||
    TWCR = 0;
 | 
			
		||||
 | 
			
		||||
    // begin transmission and wait for it to end
 | 
			
		||||
    TWCR = (1<<TWINT) | (1<<TWSTA) | (1<<TWEN);
 | 
			
		||||
    while (!(TWCR & (1<<TWINT)));
 | 
			
		||||
 | 
			
		||||
    // check if the start condition was successfully transmitted
 | 
			
		||||
    if ((TWSR & 0xF8) != TW_START) {
 | 
			
		||||
        return 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // transmit address and wait
 | 
			
		||||
    TWDR = address;
 | 
			
		||||
    TWCR = (1<<TWINT) | (1<<TWEN);
 | 
			
		||||
    while (!(TWCR & (1<<TWINT)));
 | 
			
		||||
 | 
			
		||||
    // check if the device has acknowledged the READ / WRITE mode
 | 
			
		||||
    uint8_t twst = TW_STATUS & 0xF8;
 | 
			
		||||
    if ((twst != TW_MT_SLA_ACK) && (twst != TW_MR_SLA_ACK)) {
 | 
			
		||||
        return 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void i2c_stop(void) {
 | 
			
		||||
    TWCR = (1<<TWINT) | (1<<TWEN) | (1<<TWSTO);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t i2c_write(uint8_t data) {
 | 
			
		||||
    TWDR = data;
 | 
			
		||||
 | 
			
		||||
    // transmit data and wait
 | 
			
		||||
    TWCR = (1<<TWINT) | (1<<TWEN);
 | 
			
		||||
    while (!(TWCR & (1<<TWINT)));
 | 
			
		||||
 | 
			
		||||
    if ((TWSR & 0xF8) != TW_MT_DATA_ACK) {
 | 
			
		||||
        return 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t i2c_send(uint8_t address, uint8_t *data, uint16_t length) {
 | 
			
		||||
    if (i2c_start(address)) {
 | 
			
		||||
        return 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    for (uint16_t i = 0; i < length; i++) {
 | 
			
		||||
        if (i2c_write(data[i])) {
 | 
			
		||||
            return 1;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    i2c_stop();
 | 
			
		||||
 | 
			
		||||
    return 0;
 | 
			
		||||
}
 | 
			
		||||
| 
						 | 
				
			
			@ -1,27 +0,0 @@
 | 
			
		|||
/*
 | 
			
		||||
Copyright 2016 Luiz Ribeiro <luizribeiro@gmail.com>
 | 
			
		||||
 | 
			
		||||
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/>.
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
// Please do not modify this file
 | 
			
		||||
 | 
			
		||||
#ifndef __I2C_H__
 | 
			
		||||
#define __I2C_H__
 | 
			
		||||
 | 
			
		||||
void i2c_init(void);
 | 
			
		||||
void i2c_set_bitrate(uint16_t bitrate_khz);
 | 
			
		||||
uint8_t i2c_send(uint8_t address, uint8_t *data, uint16_t length);
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
| 
						 | 
				
			
			@ -1,112 +0,0 @@
 | 
			
		|||
/*
 | 
			
		||||
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com>
 | 
			
		||||
 | 
			
		||||
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 <avr/io.h>
 | 
			
		||||
#include <util/delay.h>
 | 
			
		||||
 | 
			
		||||
#include "matrix.h"
 | 
			
		||||
 | 
			
		||||
#ifndef DEBOUNCE
 | 
			
		||||
#   define DEBOUNCE	5
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
static uint8_t debouncing = DEBOUNCE;
 | 
			
		||||
 | 
			
		||||
static matrix_row_t matrix[MATRIX_ROWS];
 | 
			
		||||
static matrix_row_t matrix_debouncing[MATRIX_ROWS];
 | 
			
		||||
 | 
			
		||||
void matrix_set_row_status(uint8_t row);
 | 
			
		||||
uint8_t bit_reverse(uint8_t x);
 | 
			
		||||
 | 
			
		||||
void matrix_init(void) {
 | 
			
		||||
    // all outputs for rows high
 | 
			
		||||
    DDRB = 0xFF;
 | 
			
		||||
    PORTB = 0xFF;
 | 
			
		||||
    // all inputs for columns
 | 
			
		||||
    DDRA = 0x00;
 | 
			
		||||
    DDRC &= ~(0x111111<<2);
 | 
			
		||||
    DDRD &= ~(1<<PIND7);
 | 
			
		||||
    // all columns are pulled-up
 | 
			
		||||
    PORTA = 0xFF;
 | 
			
		||||
    PORTC |= (0b111111<<2);
 | 
			
		||||
    PORTD |= (1<<PIND7);
 | 
			
		||||
 | 
			
		||||
    // initialize matrix state: all keys off
 | 
			
		||||
    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 | 
			
		||||
        matrix[row] = 0x00;
 | 
			
		||||
        matrix_debouncing[row] = 0x00;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    matrix_init_quantum();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t matrix_scan(void) {
 | 
			
		||||
    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 | 
			
		||||
        matrix_set_row_status(row);
 | 
			
		||||
        _delay_us(5);
 | 
			
		||||
 | 
			
		||||
        matrix_row_t cols = (
 | 
			
		||||
            // cols 0..7, PORTA 0 -> 7
 | 
			
		||||
            (~PINA) & 0xFF
 | 
			
		||||
        ) | (
 | 
			
		||||
            // cols 8..13, PORTC 7 -> 0
 | 
			
		||||
            bit_reverse((~PINC) & 0xFF) << 8
 | 
			
		||||
        ) | (
 | 
			
		||||
            // col 14, PORTD 7
 | 
			
		||||
            ((~PIND) & (1 << PIND7)) << 7
 | 
			
		||||
        );
 | 
			
		||||
 | 
			
		||||
        if (matrix_debouncing[row] != cols) {
 | 
			
		||||
            matrix_debouncing[row] = cols;
 | 
			
		||||
            debouncing = DEBOUNCE;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (debouncing) {
 | 
			
		||||
        if (--debouncing) {
 | 
			
		||||
            _delay_ms(1);
 | 
			
		||||
        } else {
 | 
			
		||||
            for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 | 
			
		||||
                matrix[i] = matrix_debouncing[i];
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    matrix_scan_quantum();
 | 
			
		||||
 | 
			
		||||
    return 1;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// declarations
 | 
			
		||||
void matrix_set_row_status(uint8_t row) {
 | 
			
		||||
    DDRB = (1 << row);
 | 
			
		||||
    PORTB = ~(1 << row);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
uint8_t bit_reverse(uint8_t x) {
 | 
			
		||||
    x = ((x >> 1) & 0x55) | ((x << 1) & 0xaa);
 | 
			
		||||
    x = ((x >> 2) & 0x33) | ((x << 2) & 0xcc);
 | 
			
		||||
    x = ((x >> 4) & 0x0f) | ((x << 4) & 0xf0);
 | 
			
		||||
    return x;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
inline matrix_row_t matrix_get_row(uint8_t row) {
 | 
			
		||||
    return matrix[row];
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void matrix_print(void) {
 | 
			
		||||
}
 | 
			
		||||
| 
						 | 
				
			
			@ -42,9 +42,7 @@ RGBLIGHT_CUSTOM_DRIVER = yes
 | 
			
		|||
 | 
			
		||||
OPT_DEFS = -DDEBUG_LEVEL=0
 | 
			
		||||
 | 
			
		||||
# custom matrix setup
 | 
			
		||||
CUSTOM_MATRIX = yes
 | 
			
		||||
SRC = matrix.c i2c.c
 | 
			
		||||
SRC += i2c_master.c
 | 
			
		||||
 | 
			
		||||
# programming options
 | 
			
		||||
PROGRAM_CMD = ./util/atmega32a_program.py $(TARGET).hex
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -13,13 +13,78 @@
 | 
			
		|||
 * 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 "%KEYBOARD%.h"
 | 
			
		||||
 | 
			
		||||
#include <avr/pgmspace.h>
 | 
			
		||||
#include "action_layer.h"
 | 
			
		||||
#include "i2c.h"
 | 
			
		||||
#include "quantum.h"
 | 
			
		||||
#ifdef RGBLIGHT_ENABLE
 | 
			
		||||
 | 
			
		||||
__attribute__ ((weak))
 | 
			
		||||
void matrix_scan_user(void) {
 | 
			
		||||
#include <string.h>
 | 
			
		||||
#include "i2c_master.h"
 | 
			
		||||
#include "rgblight.h"
 | 
			
		||||
 | 
			
		||||
extern rgblight_config_t rgblight_config;
 | 
			
		||||
 | 
			
		||||
void matrix_init_kb(void) {
 | 
			
		||||
  i2c_init();
 | 
			
		||||
  // call user level keymaps, if any
 | 
			
		||||
  matrix_init_user();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// custom RGB driver
 | 
			
		||||
void rgblight_set(void) {
 | 
			
		||||
  if (!rgblight_config.enable) {
 | 
			
		||||
    memset(led, 0, 3 * RGBLED_NUM);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  i2c_transmit(0xb0, (uint8_t*)led, 3 * RGBLED_NUM, 100);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool rgb_init = false;
 | 
			
		||||
 | 
			
		||||
void matrix_scan_kb(void) {
 | 
			
		||||
  // if LEDs were previously on before poweroff, turn them back on
 | 
			
		||||
  if (rgb_init == false && rgblight_config.enable) {
 | 
			
		||||
    i2c_transmit(0xb0, (uint8_t*)led, 3 * RGBLED_NUM, 100);
 | 
			
		||||
    rgb_init = true;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  rgblight_task();
 | 
			
		||||
  matrix_scan_user();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
// Optional override functions below.
 | 
			
		||||
// You can leave any or all of these undefined.
 | 
			
		||||
// These are only required if you want to perform custom actions.
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 | 
			
		||||
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) {
 | 
			
		||||
  // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
 | 
			
		||||
 | 
			
		||||
  led_set_user(usb_led);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
*/
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue