varl/qmk_firmware
1
0
Fork 0
forked from forks/qmk_firmware
Code Pull requests Activity
qmk_firmware/keyboards/helix/rev2/keymaps/five_rows
History
MakotoKurauchi feb5e4aaeb Keyboard: Helix serial improvements (#3608) 
* add change_reciver2sender()/change_sender2reciver()

This is a change to improve readability.

* txled, rxled off in matrix_init()

* add serial_send_packet() / serial_recive_packet()

This is a change to reduce object size.

* add serial_low() at ISR() top

* add __attribute__((always_inline)) to some functions

* modify serial_send_packet()/serial_recive_packet()

A little, object size reduction.
A little, speedup.

* add debug code to helix/serial.c

* Adjust sampling timing of serial signal being received

* add split_scomm.c/split_scomm.h and change serial.c/serial.h

serial.c was divided into 2 layers, split_scom.c and serial.c.
The upper layer split_scomm.c is called from matrix.c.
The lower layer serial.c accesses the hardware.

* add split_scomm.c/split_scomm.h into helix/rev1

* reduce object size helix/rev2/matrix.c

* remove checksum check, add parity check

* force occur parity error for test

* parity test ok. remove test code

* change some comment & add skip code when buffer_size == 0

* serial.c: multiple types of transaction support

Add 4 bits transaction-type field at packet top.
Select Transaction Descriptor Table entry by transaction-type.

* helix serial master-slave transaction optimize

Using multi-type transaction feature of serial.c, communication contents between master slaves were optimized.

* add debug code for retry

* add comment into each config.h

* fix ISR status drop

* add a debug macro 'debug_retry_chg()'

* reduce led_test size

* remove debug code from helix/serial.c and etc.

* helix:five_rows change TAPPING_TERM value 140

* Improved compatibility with let's split of serial.c. Finish helix/serial.c improvement.

- The difference with the original let's split's serial.c
  - It's high-speed about 4 times.
  - Stable bi-directional data transfer. (Helix need master to slave transfer)
  - serial.h was divided 2 files, serial_config.h and sereial.h
  - With multiple types of transaction support, communication contents can be optimized. (NEW flexible API)

- USE OLD Simple APIs (compatible with let's split serial.c)
  - files :
    - serial_config.h -- hardware configuration (need include by config.h)
    - serial.c/serial.h -- serial communication

- USE NEW flexible APIs. (Support multi-type transaction function.)
  serial.c was divided into 2 layers, split_scom.c and serial.c.
  The upper layer split_scomm.c is called from matrix.c.
  The lower layer serial.c accesses the hardware.
  - files
    - split_scomm.c -- communication buffer is defined in here. call by matrix.c.
    - split_scomm.h -- buffer size is defined in here. include by matrix.c, split_util.c
    - serial_config.h -- hardware configuration (need include by config.h)
      To use the NEW API, specify #define SERIAL_USE_MULTI_TRANSACTION
    - serial.c/serial.h -- serial communication lower layer

- NEW APIs for serial.c / serial.h (The lower layer)
  // Soft Serial Transaction Descriptor
  typedef struct _SSTD_t  {
      uint8_t *status;
      uint8_t initiator2target_buffer_size;
      uint8_t *initiator2target_buffer;
      uint8_t target2initiator_buffer_size;
      uint8_t *target2initiator_buffer;
  } SSTD_t;

  // initiator is transaction start side
  void soft_serial_initiator_init(SSTD_t *sstd_table);
  // target is interrupt accept side
  void soft_serial_target_init(SSTD_t *sstd_table);
  int soft_serial_transaction(int sstd_index);
  int soft_serial_get_and_clean_target_status(int sstd_index);

- NEW APIs for split_scomm.c / split_scomm.h (The upper layer)
   move from old serial.c the following buffer and functions
     serial_slave_buffer[]
     serial_master_buffer[]
     void serial_master_init(void)
     void serial_slave_init(void)
     int serial_update_buffers(void)
   define SERIAL_xxxxx_BUFFER_LENGTH move from serial_config.h to split_scomm.h
2018-08-10 08:22:09 -07:00
..
config.h Keyboard: Helix serial improvements (#3608) 2018-08-10 08:22:09 -07:00
keymap.c Helix: Refactor and Configurator support (#3238) 2018-06-27 07:37:27 -07:00
README.md update Helix keymap 'five_rows' (#2635) 2018-04-15 09:54:56 -07:00
README_jp.md update Helix keymap 'five_rows' (#2635) 2018-04-15 09:54:56 -07:00
rules.mk Keyboard: fixed build break (size overflow) HelixPico with Backlight or Underglow (#3546) 2018-08-02 14:16:17 -07:00

README.md

Keymap for 5 rows Helix keyboard

This keymap is only for 5 rows Helix keyboard.

Layout

fig1

Layer

Priority Number Name Discription
high 9 Adjust keyboard local functions (violet)
8 KFunction TenkeyPad function keys (bule)
7 Extra char some charactors (red)
6 Function function keys (blue)
2 Keypad TenkeyPad
2 Dvorak Dvorak
1 Colemak Colemak
low 0 Qwerty QWERTY (base)

Adjust Layer

Adjust Layer has keyboard local function keys.

  • LED control.
  • Mac/Win mode change.
  • Qwerty/Colemak/Dvorak/TenkeyPad change.

fig2

Mac mode and Win mode

Mac mode swap Alt/Win(GUI) key.

mode key code
Mac mode Adjust + g(Qwerty) AG_NORM
Adjust + h(Qwerty)
Win mode Adjust + t(Qwerty) AG_SWAP
Adjust + y(Qwerty)

LED control

command key code
on/off Adjust + e(Qwerty) RGB_TOG
Adjust + i(Qwerty)
change mode Adjust + d(Qwerty) RGB_SMOD
Adjust + k(Qwerty)
HUE + Adjust + Left Control RGB_HUI
Adjust + Right Control
HUE - Adjust + Left Shift RGB_HUD
Adjust + Right Shift
SAT + Adjust + ;(Qwerty) RGB_SAI
Adjust + a(Qwerty)
SAT - Adjust + z(Qwerty) RGB_SAD
Adjust + /(Qwerty)
Bright + Adjust + s(Qwerty) RGB_VAI
Adjust + l(Qwerty)
Bright - Adjust + x(Qwerty) RGB_VAD
Adjust + >(Qwerty)
reset Adjust + w RGBRST

Qwerty, Colemak, Dvorak, TenkeyPad selection

char layout key
Qwerty Adjust + 5
Adjust + 6
Calemak Adjust + 4
Adjust + 7
Dvorak Adjust + 3
Adjust + 8
Keypad Adjust + 2
Adjust + 9

TenkeyPad layout

fig3

Note

fig4