~ruther/qmk_firmware

b8f7834051f601d028b8182077322c1b45d7c112 — Drashna Jaelre 6 years ago 18a9f79 + 1b9f82c
Refactor E6V2 BMC PCB to get rid of custom i2c code in favor of QMK i2c_master (#5572)

* remove custom i2c code in favor of QMK i2c_master

* clean up config file

* fix pyusb install instructions

* fix naming in usbconfig.h

* disable bootmagic as it does not work for bmc boards
7 files changed, 10 insertions(+), 148 deletions(-)

M keyboards/exclusive/e6v2/bmc/bmc.c
M keyboards/exclusive/e6v2/bmc/config.h
D keyboards/exclusive/e6v2/bmc/i2c.c
D keyboards/exclusive/e6v2/bmc/i2c.h
M keyboards/exclusive/e6v2/bmc/readme.md
M keyboards/exclusive/e6v2/bmc/rules.mk
M keyboards/exclusive/e6v2/bmc/usbconfig.h
M keyboards/exclusive/e6v2/bmc/bmc.c => keyboards/exclusive/e6v2/bmc/bmc.c +2 -2
@@ 15,7 15,7 @@
 */
#include "bmc.h"
#include "rgblight.h"
#include "i2c.h"
#include "i2c_master.h"

void matrix_init_kb(void) {
	// put your keyboard start-up code here


@@ 57,7 57,7 @@ void rgblight_set(void) {
    }

    i2c_init();
    i2c_send(0xb0, (uint8_t*)led, 3 * RGBLED_NUM);
    i2c_transmit(0xb0, (uint8_t*)led, 3 * RGBLED_NUM, 100);
}
#endif


M keyboards/exclusive/e6v2/bmc/config.h => keyboards/exclusive/e6v2/bmc/config.h +0 -8
@@ 45,13 45,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
#define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, C2, C3, C4, C5, D7 }
#define DIODE_DIRECTION COL2ROW


#define RGBLED_NUM 6
#define RGBLIGHT_ANIMATIONS

#define NO_UART 1
#define BOOTLOADHID_BOOTLOADER 1

// Set bootmagic lite key to the key commonly programmed as Esc. 
#define BOOTMAGIC_LITE_ROW 5
#define BOOTMAGIC_LITE_COLUMN 0
\ No newline at end of file

D keyboards/exclusive/e6v2/bmc/i2c.c => keyboards/exclusive/e6v2/bmc/i2c.c +0 -106
@@ 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;
}
\ No newline at end of file

D keyboards/exclusive/e6v2/bmc/i2c.h => keyboards/exclusive/e6v2/bmc/i2c.h +0 -24
@@ 1,24 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 

#pragma once

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);
\ No newline at end of file

M keyboards/exclusive/e6v2/bmc/readme.md => keyboards/exclusive/e6v2/bmc/readme.md +3 -3
@@ 14,7 14,7 @@ Flashing

ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 

**Reset Key:**  Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. You may also hold down the key located at `K50`, commonly programmed as the escape key. 
**Reset Key:**  Hold down the key located at `K00`, commonly programmed as left control while plugging in the keyboard. 

Windows: 
1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).


@@ 34,9 34,9 @@ macOS:
    ```
3. Install the following packages:
    ```
    brew install python
    brew install python3
    pip3 install pyusb
    brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb

4. Place your keyboard into reset. 
5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 

M keyboards/exclusive/e6v2/bmc/rules.mk => keyboards/exclusive/e6v2/bmc/rules.mk +2 -2
@@ 66,7 66,7 @@ BOOTLOADER = bootloadHID
# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration(+1000)
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
CONSOLE_ENABLE = yes        # Console for debug(+400)


@@ 85,6 85,6 @@ AUDIO_ENABLE = no           # Audio output on port C6
FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
HD44780_ENABLE = no 		# Enable support for HD44780 based LCDs (+400)

SRC += i2c.c
SRC += i2c_master.c

PROGRAM_CMD = ./util/atmega32a_program.py $(TARGET).hex

M keyboards/exclusive/e6v2/bmc/usbconfig.h => keyboards/exclusive/e6v2/bmc/usbconfig.h +3 -3
@@ 240,8 240,8 @@ section at the end of this file).
#define USB_CFG_DEVICE_VERSION  0x00, 0x02
/* Version number of the device: Minor number first, then major number.
 */
#define USB_CFG_VENDOR_NAME     'G', 'r', 'a', 'y', ' ', 'S', 't', 'u', 'd', 'i', 'o'
#define USB_CFG_VENDOR_NAME_LEN 11
#define USB_CFG_VENDOR_NAME     'E', 'x', 'c', 'l', 'u', 's', 'i', 'v', 'e'
#define USB_CFG_VENDOR_NAME_LEN 9
/* These two values define the vendor name returned by the USB device. The name
 * must be given as a list of characters under single quotes. The characters
 * are interpreted as Unicode (UTF-16) entities.


@@ 250,7 250,7 @@ section at the end of this file).
 * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for
 * details.
 */
#define USB_CFG_DEVICE_NAME     'H', 'B', '8', '5'
#define USB_CFG_DEVICE_NAME     'E', '6', 'V', '2'
#define USB_CFG_DEVICE_NAME_LEN 4
/* Same as above for the device name. If you don't want a device name, undefine
 * the macros. See the file USB-IDs-for-free.txt before you assign a name if