~ruther/qmk_firmware

b262f20ad48be429848467074edcf62536d4d3e5 — MechMerlin 6 years ago a8e3462
[Keyboard] Refactor HB85 to get rid of custom i2c code (#5570)

* remove dependency on custom i2c code

* missed a pragma once

* fix readme install instructions

* config.h cleanup

* make the bootmagic key not the same bmc reset key

* disable bootmagic functionality as it doesn't seem to work on atmega32a bmc boards
7 files changed, 10 insertions(+), 151 deletions(-)

M keyboards/gray_studio/hb85/config.h
M keyboards/gray_studio/hb85/hb85.c
D keyboards/gray_studio/hb85/i2c.c
D keyboards/gray_studio/hb85/i2c.h
M keyboards/gray_studio/hb85/readme.md
M keyboards/gray_studio/hb85/rules.mk
M keyboards/gray_studio/hb85/usbconfig.h
M keyboards/gray_studio/hb85/config.h => keyboards/gray_studio/hb85/config.h +0 -5
@@ 19,8 19,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.

#define VENDOR_ID       0x20A0
#define PRODUCT_ID      0x422F
// TODO: share these strings with usbconfig.h
// Edit usbconfig.h to change these.
#define MANUFACTURER    Gray Studio
#define PRODUCT         HB85



@@ 34,6 32,3 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.

#define RGBLED_NUM 5
#define RGBLIGHT_ANIMATIONS

#define NO_UART 1
#define BOOTLOADHID_BOOTLOADER 1

M keyboards/gray_studio/hb85/hb85.c => keyboards/gray_studio/hb85/hb85.c +3 -3
@@ 1,5 1,5 @@
/*
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com>, 
Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com>,
          2019 fcoury <felipe.coury@gmail.com>

This program is free software: you can redistribute it and/or modify


@@ 20,7 20,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.

#include "rgblight.h"

#include "i2c.h"
#include "i2c_master.h"
#include "quantum.h"

#ifdef RGBLIGHT_ENABLE


@@ 36,7 36,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


D keyboards/gray_studio/hb85/i2c.c => keyboards/gray_studio/hb85/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;
}

D keyboards/gray_studio/hb85/i2c.h => keyboards/gray_studio/hb85/i2c.h +0 -27
@@ 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

M keyboards/gray_studio/hb85/readme.md => keyboards/gray_studio/hb85/readme.md +4 -4
@@ 16,7 16,7 @@ Flashing

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

**Reset Key:** To put the HB85 into reset, hold F3 (`K00`) while plugging in. 
**Reset Key:** Hold down the key located at `K00`, commonly programmed as F3 while plugging in the keyboard.

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


@@ 36,13 36,13 @@ 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. 

**Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work.

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

M keyboards/gray_studio/hb85/rules.mk => keyboards/gray_studio/hb85/rules.mk +2 -2
@@ 31,7 31,7 @@ F_CPU = 12000000
BOOTLOADER = bootloadHID

# build options
BOOTMAGIC_ENABLE = lite
BOOTMAGIC_ENABLE = no
MOUSEKEY_ENABLE = no
EXTRAKEY_ENABLE = yes
CONSOLE_ENABLE = yes


@@ 42,7 42,7 @@ RGBLIGHT_CUSTOM_DRIVER = yes

OPT_DEFS = -DDEBUG_LEVEL=0

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

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

M keyboards/gray_studio/hb85/usbconfig.h => keyboards/gray_studio/hb85/usbconfig.h +1 -4
@@ 8,8 8,7 @@
 * This Revision: $Id: usbconfig-prototype.h 785 2010-05-30 17:57:07Z cs $
 */

#ifndef __usbconfig_h_included__
#define __usbconfig_h_included__
#pragma once

#include "config.h"



@@ 392,5 391,3 @@ section at the end of this file).
/* #define USB_INTR_PENDING        EIFR */
#define USB_INTR_PENDING_BIT    INTF1
#define USB_INTR_VECTOR         INT1_vect

#endif /* __usbconfig_h_included__ */