Helix serial improvement

[mtei]

Improved serial.c.

• 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

[mtei]

serial.c の改良して、スキャンサイクル毎の master/slave 通信を少なくできる 新API を追加しました。
旧API を使うか、新API を使うかは、serial_config.h でコントロールします。

残念ながら、新API を使うとファームウエアサイズが 340バイトほど大きくなってしまいます。
現状、

• helix/rev1, helix/pico は旧API
• helix/rev2 は新API

を使うようになっています。
限界をオーバーしてしまったキーマップでは、config.h を少し変更することで
通信の最適化をやめて、旧APIをつかうことで、300バイトほど節約できるようにしてあります。
各config.h にコメントとして対処法を書いておきました。

また、qmk に直接出した2つの PullRequest qmk#3546 と qmk#3582 でファームサイズの削減がさらに可能になります。

qmk#3546 では、Link_Time_Optimization というMakefile変数を rules.mk に追加して、これを yes にすることで、ファームサイズを小さくすることができます。
ただし、幾つかの qmk 機能が使えなくなるようです。qmk のレビューアーに指摘されました。
keyboards/helix/config.h の Link_Time_Optimization を判定しているところを参照してください。

qmk#3582 では、rgblight.c のアニメーションエフェクトを選択的にコンパイルすることができるようになります。
これで、不要なエフェクトを削るとファームサイズを小さくすることができます。

[mtei]

ないんさんがチェックして OK で、qmk に PR 出すときは、ぜひ上の長〜い description をコピペしてくださいませ。

[MakotoKurauchi]

ありがとうございます！