qmk-firmware/keyboards/helix/rev2/keymaps/froggy
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
helixfont.h Support ios to default keymap (#3118) 2018-06-04 08:14:35 -07:00
keymap.c Helix: Refactor and Configurator support (#3238) 2018-06-27 07:37:27 -07:00
readme.md Support ios to default keymap (#3118) 2018-06-04 08:14:35 -07:00
rules.mk Keyboard: fixed build break (size overflow) HelixPico with Backlight or Underglow (#3546) 2018-08-02 14:16:17 -07:00

Froggy -one hand Helix-

Imgur

Features

It is a one-handed keyboard with reference to Frogpad. Layout Designed by タクマ (@humid).

Layout

Base

,-----------------------------------------.
|  C+z |   ;  |   [  |   (  |   <  |   {  |
|------+------+------+------+------+------|
| KANA |   P  |   K  |   R  |   A  |   F  |
|------+------+------+------+------+------|
|  BS  |   D  |   T  |   H  |   E  |   O  |
|------+------+------+------+------+------+------.
| Shift|   Y  |   S  |   N  |   I  |   U  | Space|
|------+------+------+------+------+------+------|
| Ctrl |  Alt |  win |  Sym |  Num |  OPT |  Ent |
`------------------------------------------------'

Opt

,-----------------------------------------.
|  Esc |   :  |   ]  |   )  |   >  |   }  |
|------+------+------+------+------+------|
| EISU |   J  |   M  |   B  |   '  |  Tab |
|------+------+------+------+------+------|
|   .  |   V  |   C  |   L  |   Z  |   Q  |
|------+------+------+------+------+------+------.
|      |   X  |   G  |   W  |   -  |  Del |  Esc |
|------+------+------+------+------+------+------|
|      |      |      |   ,  | DTOP |      |      |
`------------------------------------------------'

Num

,-----------------------------------------.
|      |      | Func | home |  End |      |
|------+------+------+------+------+------|
|      |   *  |   7  |   8  |   9  |   -  |
|------+------+------+------+------+------|
|   .  |   /  |   4  |   5  |   6  |   +  |
|------+------+------+------+------+------+------.
|  LN  |   0  |   1  |   2  |   3  |C+S+F1|      |
|------+------+------+------+------+------+------|
|      |      |      |   ,  |      |      |      |
`------------------------------------------------'

Sym

,-----------------------------------------.
|  Ins |  GRV |      |  PU  |  PD  |   ^  |
|------+------+------+------+------+------|
|      |   \  |   #  |   =  |   ?  |   %  |
|------+------+------+------+------+------|
|      |   $  |  upA |   @  |   !  |   |  |
|------+------+------+------+------+------+------.
|  CL  |  <-  |  dwA |  ->  |   _  |   &  |      |
|------+------+------+------+------+------+------|
|      |      |  PS  |      |   ~  |      |      |
 `-----------------------------------------------'

Func

,-----------------------------------------.
|RGBRST|  Hue |      |  RST |  Mac |  Win |
|------+------+------+------+------+------|
| RGB1 | VAL+ |  F7  |  F8  |  F9  |      |
|------+------+------+------+------+------|
| RGB2 | VAL- |  F4  |  F5  |  F6  |  F12 |
|------+------+------+------+------+------+------.
| RGB3 |  F10 |  F1  |  F2  |  F3  |  F11 |      |
|------+------+------+------+------+------+------|
|RGBOFF|      |      |      |      |      |      |
`------------------------------------------------'