[Keyboard] add rhymestone by marksard (#9708)

* Keyboard: add treeadstone48

* rename layout defines

* Use of pragma once

* move common include code

* fixed info.json

* change keymap layout from kc to normal

* fix alpha revision keymap

* fixed info.json

* remove USE_Link_Time_Optimization

* Add keyboard the Rhymestone

* fixed by PR review

* fixed by review

* Update keyboards/rhymestone/readme.md

fixed

* Fixed possible changes to oled_write_P

* Change the name of the layout definition

* Update keyboards/rhymestone/info.json

* Update keyboards/rhymestone/keymaps/default/keymap.c

* Update keyboards/rhymestone/keymaps/default/keymap.c

* Update keyboards/rhymestone/keymaps/default/keymap.c

* Update keyboards/rhymestone/keymaps/default/keymap.c

* Update keyboards/rhymestone/keymaps/switch_tester/keymap.c

* Update keyboards/rhymestone/keymaps/switch_tester/keymap.c

* Update keyboards/rhymestone/rev1/rev1.h

* add empty rules.mk in rev1

* Update from other review

* Update keyboards/rhymestone/rules.mk

* fixed other review

* move rhymestone to marksard directory

* move rhymestone to marksard directory (Commit the necessary modifications)

* remove

4 files changed, 349 insertions, 0 deletions

diff --git a/keyboards/marksard/rhymestone/rev1/config.h b/keyboards/marksard/rhymestone/rev1/config.h
new file mode 100644
index 0000000000..9a1bf0a1d8
--- /dev/null
+++ b/keyboards/marksard/rhymestone/rev1/config.h
@@ -0,0 +1,152 @@
+/*
+Copyright 2020 marksard
+
+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/>.
+*/
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0xDFA1
+#define DEVICE_VER      0x0020
+#define MANUFACTURER    marksard
+#define PRODUCT         Rhymestone
+
+/* key matrix size */
+#define MATRIX_ROWS 8
+#define MATRIX_COLS 5
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+#define MATRIX_ROW_PINS { F4, F5, F6, F7 }
+#define MATRIX_COL_PINS { D4, C6, D7, E6, B4 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D2  // or D1, D2, D3, E6
+
+// #define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+// #define BACKLIGHT_LEVELS 3
+
+#define RGB_DI_PIN D3
+
+#ifdef RGBLIGHT_ENABLE
+// #ifdef RGB_DI_PIN
+  #define RGBLED_NUM 40
+  #define RGBLED_SPLIT {20, 20}
+  #define RGBLIGHT_HUE_STEP 8
+  #define RGBLIGHT_SAT_STEP 8
+  #define RGBLIGHT_VAL_STEP 8
+  #define RGBLIGHT_LIMIT_VAL 150 /* The maximum brightness level */
+  #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*== all animations enable ==*/
+//   #define RGBLIGHT_ANIMATIONS
+/*== or choose animations ==*/
+//   #define RGBLIGHT_EFFECT_BREATHING
+  #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+  #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//   #define RGBLIGHT_EFFECT_SNAKE
+  #define RGBLIGHT_EFFECT_KNIGHT
+//   #define RGBLIGHT_EFFECT_CHRISTMAS
+  #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//   #define RGBLIGHT_EFFECT_RGB_TEST
+//   #define RGBLIGHT_EFFECT_ALTERNATING
+/*== customize breathing effect ==*/
+  /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+  #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
+  /*==== use exp() and sin() ====*/
+  #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
+  #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
+#endif
+
+#ifdef RGB_MATRIX_ENABLE
+  #define RGBLED_NUM 40    // Number of LEDs
+  #define DRIVER_LED_TOTAL RGBLED_NUM
+  #define RGB_MATRIX_KEYPRESSES  // reacts to keypresses
+  // #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
+  // #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
+  #define RGB_DISABLE_WHEN_USB_SUSPENDED true  // turn off effects when suspended
+  // #define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
+  // #define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
+  #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150  // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255
+  #define RGB_MATRIX_HUE_STEP 8
+  #define RGB_MATRIX_SAT_STEP 8
+  #define RGB_MATRIX_VAL_STEP 8
+  #define RGB_MATRIX_SPD_STEP 10
+
+//   #define DISABLE_RGB_MATRIX_ALPHAS_MODS
+//   #define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+//   #define DISABLE_RGB_MATRIX_BREATHING
+//   #define DISABLE_RGB_MATRIX_BAND_SAT
+//   #define DISABLE_RGB_MATRIX_BAND_VAL
+//   #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+//   #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+//   #define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+//   #define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+//   #define DISABLE_RGB_MATRIX_CYCLE_ALL
+//   #define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+//   #define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
+//   #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN
+//   #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+//   #define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+//   #define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL
+//   #define DISABLE_RGB_MATRIX_CYCLE_SPIRAL
+//   #define DISABLE_RGB_MATRIX_DUAL_BEACON
+//   #define DISABLE_RGB_MATRIX_RAINBOW_BEACON
+//   #define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+//   #define DISABLE_RGB_MATRIX_RAINDROPS
+//   #define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+
+  #define RGB_MATRIX_FRAMEBUFFER_EFFECTS
+//   #define DISABLE_RGB_MATRIX_TYPING_HEATMAP
+//   #define DISABLE_RGB_MATRIX_DIGITAL_RAIN
+
+//   #define RGB_MATRIX_KEYPRESSES  // reacts to keypresses
+
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+//   #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+
+//   #define DISABLE_RGB_MATRIX_SPLASH
+//   #define DISABLE_RGB_MATRIX_MULTISPLASH
+//   #define DISABLE_RGB_MATRIX_SOLID_SPLASH
+//   #define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
+
+  #define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_TYPING_HEATMAP
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
diff --git a/keyboards/marksard/rhymestone/rev1/rev1.c b/keyboards/marksard/rhymestone/rev1/rev1.c
new file mode 100644
index 0000000000..a4dadd55cb
--- /dev/null
+++ b/keyboards/marksard/rhymestone/rev1/rev1.c
@@ -0,0 +1,108 @@
+/* Copyright 2020 marksard
+ *
+ * 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/>.
+ */
+
+#include "rev1.h"
+
+// Optional override functions below.
+// You can leave any or all of these undefined.
+// These are only required if you want to perform custom actions.
+
+#ifdef RGB_MATRIX_ENABLE
+led_config_t g_led_config = { {
+    {  10,  11,  12,  13,   0 },
+    {   9,  18,  19,  14,   1 },
+    {   8,  17,  16,  15,   2 },
+    {   7,   6,   5,   4,   3 },
+    {  30,  31,  32,  33,  20 },
+    {  29,  38,  39,  34,  21 },
+    {  28,  37,  36,  35,  22 },
+    {  27,  26,  25,  24,  23 }
+}, {
+    { 100,   0 }, { 100,  21 }, { 100,  43 }, { 100,  64 },
+    {  75,  64 }, {  50,  64 }, {  25,  64 }, {   0,  64 },
+    {   0,  43 }, {   0,  21 }, {   0,   0 },
+    {  25,   0 }, {  50,   0 }, {  75,   0 },
+    {  75,  21 }, {  75,  43 },
+    {  50,  43 }, {  25,  43 },
+    {  25,  21 }, {  50,  21 },
+    { 125,   0 }, { 125,  21 }, { 125,  43 }, { 125,  64 },
+    { 150,  64 }, { 175,  64 }, { 200,  64 }, { 225,  64 },
+    { 225,  43 }, { 225,  21 }, { 225,   0 },
+    { 200,   0 }, { 175,   0 }, { 150,   0 },
+    { 150,  21 }, { 150,  43 },
+    { 175,  43 }, { 200,  43 },
+    { 200,  21 }, { 150,  21 }
+}, {
+    4, 4, 4, 1,
+    1, 1, 1, 1,
+    4, 4, 4, 4,
+    4, 4, 4, 4,
+    4, 4, 4, 4,
+    4, 4, 4, 1,
+    1, 1, 1, 1,
+    4, 4, 4, 4,
+    4, 4, 4, 4,
+    4, 4, 4, 4
+} };
+#endif
+
+__attribute__((weak))
+void matrix_init_user(void) {}
+
+void matrix_init_kb(void) {
+
+#ifdef RGB_MATRIX_ENABLE
+    // if (!is_keyboard_master()) {
+    //     g_led_config = (led_config_t){ {
+    //         {  30,  31,  32,  33,  20 },
+    //         {  29,  38,  39,  34,  21 },
+    //         {  28,  37,  36,  35,  22 },
+    //         {  27,  26,  25,  24,  23 },
+    //         {  10,  11,  12,  13,   0 },
+    //         {   9,  18,  19,  14,   1 },
+    //         {   8,  17,  16,  15,   2 },
+    //         {   7,   6,   5,   4,   3 }
+    //     }, {
+    //         { 125,   0 }, { 125,  21 }, { 125,  43 }, { 125,  64 },
+    //         { 150,  64 }, { 175,  64 }, { 200,  64 }, { 225,  64 },
+    //         { 225,  43 }, { 225,  21 }, { 225,   0 },
+    //         { 200,   0 }, { 175,   0 }, { 150,   0 },
+    //         { 150,  21 }, { 150,  43 },
+    //         { 175,  43 }, { 200,  43 },
+    //         { 200,  21 }, { 150,  21 },
+    //         { 100,   0 }, { 100,  21 }, { 100,  43 }, { 100,  64 },
+    //         {  75,  64 }, {  50,  64 }, {  25,  64 }, {   0,  64 },
+    //         {   0,  43 }, {   0,  21 }, {   0,   0 },
+    //         {  25,   0 }, {  50,   0 }, {  75,   0 },
+    //         {  75,  21 }, {  75,  43 },
+    //         {  50,  43 }, {  25,  43 },
+    //         {  25,  21 }, {  50,  21 }
+    //     }, {
+    //         4, 4, 4, 1,
+    //         1, 1, 1, 1,
+    //         4, 4, 4, 4,
+    //         4, 4, 4, 4,
+    //         4, 4, 4, 4,
+    //         4, 4, 4, 1,
+    //         1, 1, 1, 1,
+    //         4, 4, 4, 4,
+    //         4, 4, 4, 4,
+    //         4, 4, 4, 4
+    //     } };
+    // }
+#endif
+    matrix_init_user();
+}
diff --git a/keyboards/marksard/rhymestone/rev1/rev1.h b/keyboards/marksard/rhymestone/rev1/rev1.h
new file mode 100644
index 0000000000..855e288df3
--- /dev/null
+++ b/keyboards/marksard/rhymestone/rev1/rev1.h
@@ -0,0 +1,89 @@
+/* Copyright 2020 marksard
+ *
+ * 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/>.
+ */
+
+#pragma once
+
+#include "quantum.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+
+#ifndef FLIP_HALF
+// Standard Keymap
+// (TRRS jack on the left half is to the right, TRRS jack on the right half is to the left)
+#define LAYOUT_ortho_4x10( \
+  L00, L01, L02, L03, L04, R00, R01, R02, R03, R04, \
+  L10, L11, L12, L13, L14, R10, R11, R12, R13, R14, \
+  L20, L21, L22, L23, L24, R20, R21, R22, R23, R24, \
+  L30, L31, L32, L33, L34, R30, R31, R32, R33, R34  \
+  ) \
+  { \
+    { L00, L01, L02, L03, L04 }, \
+    { L10, L11, L12, L13, L14 }, \
+    { L20, L21, L22, L23, L24 }, \
+    { L30, L31, L32, L33, L34 }, \
+    { R04, R03, R02, R01, R00 }, \
+    { R14, R13, R12, R11, R10 }, \
+    { R24, R23, R22, R21, R20 }, \
+    { R34, R33, R32, R31, R30 }, \
+  }
+#else
+// Keymap with right side flipped
+// (TRRS jack on both halves are to the right)
+#define LAYOUT_ortho_4x10( \
+  L00, L01, L02, L03, L04, R00, R01, R02, R03, R04, \
+  L10, L11, L12, L13, L14, R10, R11, R12, R13, R14, \
+  L20, L21, L22, L23, L24, R20, R21, R22, R23, R24, \
+  L30, L31, L32, L33, L34, R30, R31, R32, R33, R34  \
+  ) \
+  { \
+    { L04, L03, L02, L01, L00 }, \
+    { L14, L13, L12, L11, L10 }, \
+    { L24, L23, L22, L21, L20 }, \
+    { L34, L33, L32, L31, L30 }, \
+    { R04, R03, R02, R01, R00 }, \
+    { R14, R13, R12, R11, R10 }, \
+    { R24, R23, R22, R21, R20 }, \
+    { R34, R33, R32, R31, R30 }, \
+  }
+#endif
+
+#ifdef USE_HASHTWENTY // The HashTwenty is Alpha version of The Rhymestone
+#undef LAYOUT_ortho_4x10
+// HashTwenty layout
+#define LAYOUT_ortho_4x10( \
+  L00, L01, L02, L03, L04, R00, R01, R02, R03, R04, \
+  L10, L11, L12, L13, L14, R10, R11, R12, R13, R14, \
+  L20, L21, L22, L23, L24, R20, R21, R22, R23, R24, \
+  L30, L31, L32, L33, L34, R30, R31, R32, R33, R34  \
+  ) \
+  { \
+    { L04, L03, L02, L01, L00 }, \
+    { L14, L13, L12, L11, L10 }, \
+    { L24, L23, L22, L21, L20 }, \
+    { L34, L33, L32, L31, L30 }, \
+    { R00, R01, R02, R03, R04 }, \
+    { R10, R11, R12, R13, R14 }, \
+    { R20, R21, R22, R23, R24 }, \
+    { R30, R31, R32, R33, R34 }, \
+  }
+#endif
diff --git a/keyboards/marksard/rhymestone/rev1/rules.mk b/keyboards/marksard/rhymestone/rev1/rules.mk
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/keyboards/marksard/rhymestone/rev1/rules.mk