[Keyboard] Cleanup helix rules options (#6952)
* add temporary test shell-spript
* Use LINK_TIME_OPTIMIZATION_ENABLE instead of Link_Time_Optimization
No change in build result.
* Helix config.h use '#pragma once'
No change in build result.
* Helix helix.h,rev?/rev?.h,pico/pico.h use '#pragma once'
No change in build result.
* Use drivers/avr/pro_micro.h instead of keyboards/helix/pro_micro.h
No change in build result.
* remove keyboards/helix/{rev2|pico}/serial_config.h
No change in build result.
* 'HELIX_ROWS' macro is now referenced only in rev1/config.h and rev2/config.h.
No change in build result.
* The contents of helix/rules.mk were distributed to subdirectories.
This is a preparation to create a new subdirectory for helix code using split_common.
No change in build result.
remove 'USE_I2C = yes', 'SUBPROJECT_rev1 = no' from keyboards/helix/rules.mk.
follow code move from keyboards/helix/rules.mk to keyboards/helix/{rev1,rev2,pico}/rules.mk.
----
 SRC += i2c.c
 SRC += serial.c
 SRC += ssd1306.c
 CUSTOM_MATRIX = yes
---
* helix/{i2c.[ch], serial.[ch], ssd1306.[ch]} move into helix/local_drivers/
No change in build result.
* Simplified 'helix/pico/keymap/*/rules.mk' using KEYBOARD_LOCAL_FEATURES_MK.
No change in build result.
 * add keyboards/helix/pico/local_features.mk
 * add 'KEYBOARD_LOCAL_FEATURES_MK := $(dir $(lastword $(MAKEFILE_LIST)))local_features.mk' into keyboards/helix/pico/rules.mk
 * remove HELIX_CUSTOMISE_MSG from keyboards/helix/pico/keymaps/*/rules.mk
 * remove HELIX= process from keyboards/helix/pico/keymaps/*/rules.mk
 * remove convert code(helix to standaerd) from keyboards/helix/pico/keymaps/*/rules.mk
 * add 'include $(strip $(KEYBOARD_LOCAL_FEATURES_MK))' into keyboards/helix/pico/keymaps/*/rules.mk
* Simplified 'helix/rev2/keymap/*/rules.mk' using KEYBOARD_LOCAL_FEATURES_MK.
No change in build result.
* add keyboards/helix/rev2/local_features.mk
* add 'KEYBOARD_LOCAL_FEATURES_MK := $(dir $(lastword $(MAKEFILE_LIST)))local_features.mk' into keyboards/helix/rev2/rules.mk
* remove HELIX_CUSTOMISE_MSG from keyboards/helix/rev2/keymaps/*/rules.mk
* remove HELIX= process from keyboards/helix/rev2/keymaps/*/rules.mk
* remove convert code(helix to standaerd) from keyboards/helix/rev2/keymaps/*/rules.mk
* add 'include $(strip $(KEYBOARD_LOCAL_FEATURES_MK))' into keyboards/helix/rev2/keymaps/*/rules.mk
* Added helix keyboard build NEW method.
No change in build result.
 ## Helix build
 $ make helix:default            ## no oled, no backlight, no underglow
 $ make helix/rev2/back:default  ## no oled, with backlight, no underglow
 $ make helix/rev2/under:default ## no oled, no backlight, with underglow
 $ make helix/rev2/oled:default  ## with oled, no backlight, not underglow
 $ make helix/rev2/oled/back:default  ## with oled, with backlight, no underglow
 $ make helix/rev2/back/oled:default  ## with oled, with backlight, no underglow
 $ make helix/rev2/oled/under:default ## with oled, no backlight, with underglow
 $ make helix/rev2/under/oled:default ## with oled, no backlight, with underglow
 ## Helix pico build
 $ make helix/pico:default       ## no oled, no backlight, no underglow
 $ make helix/pico/back:default  ## no oled, with backlight, no underglow
 $ make helix/pico/under:default ## no oled, no backlight, with underglow
 $ make helix/pico/oled:default  ## with oled, no backlight, not underglow
* add temporary test shell-spript
* test end remove test script. Revert "add temporary test shell-spript"
This reverts commit 5dac20cd0f8b4bc192edb2313652c1635f829657.
* test end remove test script. Revert "add temporary test shell-spript"
This reverts commit ec49f63b2dc0f2b3fe8c1c36ffa615cee2f7e3ed.
* Extended the 'HELIX=' option. add keyword 'verbose', 'no_ani'.
No change in build result.
* update keyboards/helix/{rev2,pico}/keymaps/default/readme.md
* rename KEYBOARD_TOP_DIR to HELIX_TOP_DIR in rules.mk
* update keyboards/helix/{rev2,pico}/keymaps/default/readme_jp.md
* rm keyboards/helix/pico/oled/rules.mk
* update helix's readmes. All the ':avrdude' was replaced with ':flash'.
* remove F_CPU, ARCH, F_USB, INTERRUPT_CONTROL_ENDPOINT from helix/rules.mk
No change in build result.
			
			
This commit is contained in:
		
							parent
							
								
									81f36ab74d
								
							
						
					
					
						commit
						881f27b461
					
				
					 54 changed files with 638 additions and 1766 deletions
				
			
		
							
								
								
									
										162
									
								
								keyboards/helix/local_drivers/i2c.c
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										162
									
								
								keyboards/helix/local_drivers/i2c.c
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,162 @@
 | 
			
		|||
#include <util/twi.h>
 | 
			
		||||
#include <avr/io.h>
 | 
			
		||||
#include <stdlib.h>
 | 
			
		||||
#include <avr/interrupt.h>
 | 
			
		||||
#include <util/twi.h>
 | 
			
		||||
#include <stdbool.h>
 | 
			
		||||
#include "i2c.h"
 | 
			
		||||
 | 
			
		||||
#ifdef USE_I2C
 | 
			
		||||
 | 
			
		||||
// Limits the amount of we wait for any one i2c transaction.
 | 
			
		||||
// Since were running SCL line 100kHz (=> 10μs/bit), and each transactions is
 | 
			
		||||
// 9 bits, a single transaction will take around 90μs to complete.
 | 
			
		||||
//
 | 
			
		||||
// (F_CPU/SCL_CLOCK)  =>  # of μC cycles to transfer a bit
 | 
			
		||||
// poll loop takes at least 8 clock cycles to execute
 | 
			
		||||
#define I2C_LOOP_TIMEOUT (9+1)*(F_CPU/SCL_CLOCK)/8
 | 
			
		||||
 | 
			
		||||
#define BUFFER_POS_INC() (slave_buffer_pos = (slave_buffer_pos+1)%SLAVE_BUFFER_SIZE)
 | 
			
		||||
 | 
			
		||||
volatile uint8_t i2c_slave_buffer[SLAVE_BUFFER_SIZE];
 | 
			
		||||
 | 
			
		||||
static volatile uint8_t slave_buffer_pos;
 | 
			
		||||
static volatile bool slave_has_register_set = false;
 | 
			
		||||
 | 
			
		||||
// Wait for an i2c operation to finish
 | 
			
		||||
inline static
 | 
			
		||||
void i2c_delay(void) {
 | 
			
		||||
  uint16_t lim = 0;
 | 
			
		||||
  while(!(TWCR & (1<<TWINT)) && lim < I2C_LOOP_TIMEOUT)
 | 
			
		||||
    lim++;
 | 
			
		||||
 | 
			
		||||
  // easier way, but will wait slightly longer
 | 
			
		||||
  // _delay_us(100);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Setup twi to run at 100kHz or 400kHz (see ./i2c.h SCL_CLOCK)
 | 
			
		||||
void i2c_master_init(void) {
 | 
			
		||||
  // no prescaler
 | 
			
		||||
  TWSR = 0;
 | 
			
		||||
  // Set TWI clock frequency to SCL_CLOCK. Need TWBR>10.
 | 
			
		||||
  // Check datasheets for more info.
 | 
			
		||||
  TWBR = ((F_CPU/SCL_CLOCK)-16)/2;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Start a transaction with the given i2c slave address. The direction of the
 | 
			
		||||
// transfer is set with I2C_READ and I2C_WRITE.
 | 
			
		||||
// returns: 0 => success
 | 
			
		||||
//          1 => error
 | 
			
		||||
uint8_t i2c_master_start(uint8_t address) {
 | 
			
		||||
  TWCR = (1<<TWINT) | (1<<TWEN) | (1<<TWSTA);
 | 
			
		||||
 | 
			
		||||
  i2c_delay();
 | 
			
		||||
 | 
			
		||||
  // check that we started successfully
 | 
			
		||||
  if ( (TW_STATUS != TW_START) && (TW_STATUS != TW_REP_START))
 | 
			
		||||
    return 1;
 | 
			
		||||
 | 
			
		||||
  TWDR = address;
 | 
			
		||||
  TWCR = (1<<TWINT) | (1<<TWEN);
 | 
			
		||||
 | 
			
		||||
  i2c_delay();
 | 
			
		||||
 | 
			
		||||
  if ( (TW_STATUS != TW_MT_SLA_ACK) && (TW_STATUS != TW_MR_SLA_ACK) )
 | 
			
		||||
    return 1; // slave did not acknowledge
 | 
			
		||||
  else
 | 
			
		||||
    return 0; // success
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
// Finish the i2c transaction.
 | 
			
		||||
void i2c_master_stop(void) {
 | 
			
		||||
  TWCR = (1<<TWINT) | (1<<TWEN) | (1<<TWSTO);
 | 
			
		||||
 | 
			
		||||
  uint16_t lim = 0;
 | 
			
		||||
  while(!(TWCR & (1<<TWSTO)) && lim < I2C_LOOP_TIMEOUT)
 | 
			
		||||
    lim++;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Write one byte to the i2c slave.
 | 
			
		||||
// returns 0 => slave ACK
 | 
			
		||||
//         1 => slave NACK
 | 
			
		||||
uint8_t i2c_master_write(uint8_t data) {
 | 
			
		||||
  TWDR = data;
 | 
			
		||||
  TWCR = (1<<TWINT) | (1<<TWEN);
 | 
			
		||||
 | 
			
		||||
  i2c_delay();
 | 
			
		||||
 | 
			
		||||
  // check if the slave acknowledged us
 | 
			
		||||
  return (TW_STATUS == TW_MT_DATA_ACK) ? 0 : 1;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Read one byte from the i2c slave. If ack=1 the slave is acknowledged,
 | 
			
		||||
// if ack=0 the acknowledge bit is not set.
 | 
			
		||||
// returns: byte read from i2c device
 | 
			
		||||
uint8_t i2c_master_read(int ack) {
 | 
			
		||||
  TWCR = (1<<TWINT) | (1<<TWEN) | (ack<<TWEA);
 | 
			
		||||
 | 
			
		||||
  i2c_delay();
 | 
			
		||||
  return TWDR;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void i2c_reset_state(void) {
 | 
			
		||||
  TWCR = 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void i2c_slave_init(uint8_t address) {
 | 
			
		||||
  TWAR = address << 0; // slave i2c address
 | 
			
		||||
  // TWEN  - twi enable
 | 
			
		||||
  // TWEA  - enable address acknowledgement
 | 
			
		||||
  // TWINT - twi interrupt flag
 | 
			
		||||
  // TWIE  - enable the twi interrupt
 | 
			
		||||
  TWCR = (1<<TWIE) | (1<<TWEA) | (1<<TWINT) | (1<<TWEN);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
ISR(TWI_vect);
 | 
			
		||||
 | 
			
		||||
ISR(TWI_vect) {
 | 
			
		||||
  uint8_t ack = 1;
 | 
			
		||||
  switch(TW_STATUS) {
 | 
			
		||||
    case TW_SR_SLA_ACK:
 | 
			
		||||
      // this device has been addressed as a slave receiver
 | 
			
		||||
      slave_has_register_set = false;
 | 
			
		||||
      break;
 | 
			
		||||
 | 
			
		||||
    case TW_SR_DATA_ACK:
 | 
			
		||||
      // this device has received data as a slave receiver
 | 
			
		||||
      // The first byte that we receive in this transaction sets the location
 | 
			
		||||
      // of the read/write location of the slaves memory that it exposes over
 | 
			
		||||
      // i2c.  After that, bytes will be written at slave_buffer_pos, incrementing
 | 
			
		||||
      // slave_buffer_pos after each write.
 | 
			
		||||
      if(!slave_has_register_set) {
 | 
			
		||||
        slave_buffer_pos = TWDR;
 | 
			
		||||
        // don't acknowledge the master if this memory loctaion is out of bounds
 | 
			
		||||
        if ( slave_buffer_pos >= SLAVE_BUFFER_SIZE ) {
 | 
			
		||||
          ack = 0;
 | 
			
		||||
          slave_buffer_pos = 0;
 | 
			
		||||
        }
 | 
			
		||||
        slave_has_register_set = true;
 | 
			
		||||
      } else {
 | 
			
		||||
        i2c_slave_buffer[slave_buffer_pos] = TWDR;
 | 
			
		||||
        BUFFER_POS_INC();
 | 
			
		||||
      }
 | 
			
		||||
      break;
 | 
			
		||||
 | 
			
		||||
    case TW_ST_SLA_ACK:
 | 
			
		||||
    case TW_ST_DATA_ACK:
 | 
			
		||||
      // master has addressed this device as a slave transmitter and is
 | 
			
		||||
      // requesting data.
 | 
			
		||||
      TWDR = i2c_slave_buffer[slave_buffer_pos];
 | 
			
		||||
      BUFFER_POS_INC();
 | 
			
		||||
      break;
 | 
			
		||||
 | 
			
		||||
    case TW_BUS_ERROR: // something went wrong, reset twi state
 | 
			
		||||
      TWCR = 0;
 | 
			
		||||
    default:
 | 
			
		||||
      break;
 | 
			
		||||
  }
 | 
			
		||||
  // Reset everything, so we are ready for the next TWI interrupt
 | 
			
		||||
  TWCR |= (1<<TWIE) | (1<<TWINT) | (ack<<TWEA) | (1<<TWEN);
 | 
			
		||||
}
 | 
			
		||||
#endif
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue