[Keyboard] Pistachio (#10003)

* Add keyboard Pistachio

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

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

* Update keyboards/pistachio/config.h

* Fix Build error.

* Apply suggestions from code review

keyboards/pistachio/config.h

@@ -0,0 +1,80 @@
+/*
+Copyright 2020 rate
+
+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   0xD0C2
+#define DEVICE_VER   0x0001
+#define MANUFACTURER rate
+#define PRODUCT      pistachio
+
+/* key matrix size */
+#define MATRIX_ROWS 12
+#define MATRIX_COLS 9
+
+/*
+ * 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 { D4, C6, D7, E6, B4, B5 }
+#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2, B6, D3}
+#define UNUSED_PINS
+
+#define USE_I2C
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN D2
+#define RGBLIGHT_SPLIT
+#define RGBLED_SPLIT { 1, 1 }
+#define RGBLED_NUM 2
+#define RGBLIGHT_LAYERS
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 17
+
+#if defined(RGBLIGHT_ENABLE) && !defined(IOS_DEVICE_ENABLE)
+  #define USB_MAX_POWER_CONSUMPTION 400
+#else
+  #define USB_MAX_POWER_CONSUMPTION 100
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* nKey Rollover */
+#define FORCE_NKRO
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION

keyboards/pistachio/info.json

@@ -0,0 +1,103 @@
+{
+    "keyboard_name": "Pistachio", 
+    "url": "", 
+    "maintainer": "rate", 
+    "width": 19.25, 
+    "height": 6.75, 
+    "layouts": {
+        "LAYOUT": {
+            "layout": [{"label":"ESC", "x":1.25, "y":0.25},
+            {"label":"F1", "x":2.75, "y":0.25}, 
+            {"label":"F2", "x":3.75, "y":0.25}, 
+            {"label":"F3", "x":4.75, "y":0.25}, 
+            {"label":"F4", "x":5.75, "y":0.25}, 
+            {"label":"DEL", "x":7.25, "y":0.25}, 
+            {"label":"F5", "x":9.5, "y":0.25}, 
+            {"label":"F6", "x":10.5, "y":0.25}, 
+            {"label":"F7", "x":11.5, "y":0.25}, 
+            {"label":"F8", "x":12.5, "y":0.25}, 
+            {"label":"F9", "x":14, "y":0.25}, 
+            {"label":"F10", "x":15, "y":0.25}, 
+            {"label":"F11", "x":16, "y":0.25}, 
+            {"label":"F12", "x":17, "y":0.25}, 
+            {"label":"\u25b6\u25b6|", "x":0, "y":1.75}, 
+            {"label":"E/J", "x":1.25, "y":1.75}, 
+            {"label":"!", "x":2.25, "y":1.75}, 
+            {"label":"\"", "x":3.25, "y":1.75}, 
+            {"label":"#", "x":4.25, "y":1.75}, 
+            {"label":"$", "x":5.25, "y":1.75}, 
+            {"label":"%", "x":6.25, "y":1.75}, 
+            {"label":"&", "x":7.25, "y":1.75}, 
+            {"label":"'", "x":10, "y":1.75}, 
+            {"label":"(", "x":11, "y":1.75}, 
+            {"label":")", "x":12, "y":1.75}, 
+            {"label":"", "x":13, "y":1.75}, 
+            {"label":"=", "x":14, "y":1.75}, 
+            {"label":"~", "x":15, "y":1.75}, 
+            {"label":"\\", "x":16, "y":1.75}, 
+            {"label":"\u2190", "x":17, "y":1.75}, 
+            {"label":"Delete", "x":18.25, "y":1.75}, 
+            {"label":"\u25b6||", "x":0, "y":2.75}, 
+            {"label":"Tab", "x":1.25, "y":2.75, "w":1.5}, 
+            {"label":"Q", "x":2.75, "y":2.75}, 
+            {"label":"W", "x":3.75, "y":2.75}, 
+            {"label":"E", "x":4.75, "y":2.75}, 
+            {"label":"R", "x":5.75, "y":2.75}, 
+            {"label":"T", "x":6.75, "y":2.75}, 
+            {"label":"Y", "x":9.5, "y":2.75}, 
+            {"label":"U", "x":10.5, "y":2.75}, 
+            {"label":"I", "x":11.5, "y":2.75}, 
+            {"label":"O", "x":12.5, "y":2.75}, 
+            {"label":"P", "x":13.5, "y":2.75}, 
+            {"label":"`", "x":14.5, "y":2.75}, 
+            {"label":"{", "x":15.5, "y":2.75}, 
+            {"label":"Home", "x":18.25, "y":2.75}, 
+            {"label":"\ud83d\udd07", "x":0, "y":3.75}, 
+            {"label":"CapsLock", "x":1.25, "y":3.75, "w":1.75}, 
+            {"label":"A", "x":3, "y":3.75}, 
+            {"label":"S", "x":4, "y":3.75}, 
+            {"label":"D", "x":5, "y":3.75}, 
+            {"label":"F", "x":6, "y":3.75}, 
+            {"label":"G", "x":7, "y":3.75}, 
+            {"label":"H", "x":9.75, "y":3.75}, 
+            {"label":"J", "x":10.75, "y":3.75}, 
+            {"label":"K", "x":11.75, "y":3.75}, 
+            {"label":"L", "x":12.75, "y":3.75}, 
+            {"label":"+", "x":13.75, "y":3.75}, 
+            {"label":"*", "x":14.75, "y":3.75}, 
+            {"label":"}", "x":15.75, "y":3.75}, 
+            {"label":"Enter", "x":16.75, "y":2.75, "w":1.25, "h":2}, 
+            {"label":"End", "x":18.25, "y":3.75}, 
+            {"label":"VolUP", "x":0, "y":4.75}, 
+            {"label":"Shift", "x":1.25, "y":4.75, "w":2.25}, 
+            {"label":"Z", "x":3.5, "y":4.75}, 
+            {"label":"X", "x":4.5, "y":4.75}, 
+            {"label":"C", "x":5.5, "y":4.75}, 
+            {"label":"V", "x":6.5, "y":4.75}, 
+            {"label":"B", "x":7.5, "y":4.75}, 
+            {"label":"N", "x":10.25, "y":4.75}, 
+            {"label":"M", "x":11.25, "y":4.75}, 
+            {"label":"<", "x":12.25, "y":4.75}, 
+            {"label":">", "x":13.25, "y":4.75}, 
+            {"label":"?", "x":14.25, "y":4.75}, 
+            {"label":"_", "x":15.25, "y":4.75}, 
+            {"label":"Shift", "x":16.25, "y":4.75, "w":1.75}, 
+            {"label":"Page", "x":18.25, "y":4.75}, 
+            {"label":"VolDW", "x":0, "y":5.75}, 
+            {"label":"Ctrl", "x":1.25, "y":5.75, "w":1.25}, 
+            {"label":"Win", "x":2.5, "y":5.75}, 
+            {"label":"Alt", "x":3.5, "y":5.75, "w":1.25}, 
+            {"label":"Enter", "x":4.75, "y":5.75}, 
+            {"label":"\u7121\u5909\u63db", "x":5.75, "y":5.75}, 
+            {"x":6.75, "y":5.75, "w":1.25}, 
+            {"x":10.5, "y":5.75, "w":1.25}, 
+            {"label":"\u5909\u63db", "x":11.75, "y":5.75}, 
+            {"label":"\u5de6\u30af\u30ea\u30c3\u30af", "x":12.75, "y":5.75}, 
+            {"label":"Insert", "x":13.75, "y":5.75}, 
+            {"label":"Alt", "x":14.75, "y":5.75}, 
+            {"label":"Menu", "x":15.75, "y":5.75}, 
+            {"label":"Ctrl", "x":16.75, "y":5.75, "w":1.25}, 
+            {"label":"Page", "x":18.25, "y":5.75}]
+        }
+    }
+}

keyboards/pistachio/keymaps/default/keymap.c

@@ -0,0 +1,67 @@
+/* Copyright 2020 rate
+ *
+ * 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 QMK_KEYBOARD_H
+#include "keymap_jp.h"
+
+extern rgblight_config_t rgblight_config;
+
+enum layer_names {
+    _QWERTY = 0,
+    _FN
+};
+
+enum custom_keycodes {
+  RGB_RST = SAFE_RANGE
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_QWERTY] = LAYOUT(
+               KC_ESC,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_DEL,                 KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,
+     KC_MNXT,  KC_ZKHK, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,          KC_7,    KC_8,    KC_9,    KC_0,    JP_MINS, JP_CIRC, JP_YEN,  KC_BSPC,  KC_DEL,
+     KC_MPLY,  KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                   KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    JP_AT,   JP_LBRC,           KC_HOME,
+     KC_MUTE,  KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,                   KC_H,    KC_J,    KC_K,    KC_L,    JP_SCLN, JP_COLN, JP_RBRC, KC_ENT,   KC_END,
+     KC_VOLU,  KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,                   KC_N,    KC_M,    JP_COMM, JP_DOT,  JP_SLSH, JP_BSLS,          KC_RSFT,  KC_PGUP,
+     KC_VOLD,  KC_LCTL, KC_LGUI, KC_LALT, KC_ENT,  KC_MHEN, LT(_FN,KC_SPC),         LT(_FN,KC_SPC),   KC_HENK, KC_BTN1, KC_INS,  KC_RALT, KC_APP,  KC_RCTL,  KC_PGDN
+    ),
+    [_FN] = LAYOUT(
+               _______, _______, _______, _______, _______, _______,                _______, _______, _______, _______, _______, _______, _______, _______,
+     RGB_VAI,  _______, _______, _______, _______, _______, _______, _______,       _______, _______, _______, _______, _______, _______, _______, _______,  _______,
+     RGB_VAD,  _______, _______, _______, _______, KC_UP,   _______,                KC_HOME, KC_PGUP, KC_END,  _______, _______, _______, _______,           _______,
+     _______,  _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______,                KC_LEFT, KC_UP,   KC_DOWN, KC_RGHT, _______, _______, _______, _______,  _______,
+     RGB_HUI,  _______, _______, _______, _______, _______, _______,                KC_PGDN, _______, _______, _______, _______, _______,          _______,  RGB_SAI,
+     RGB_HUD,  _______, _______, _______, _______, _______, _______,                _______,          _______, _______, _______, _______, _______, _______,  RGB_SAD
+    )
+};
+
+
+int RGB_current_mode;
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  bool result = false;
+  switch (keycode) {
+      case RGB_RST:
+          if (record->event.pressed) {
+            eeconfig_update_rgblight_default();
+            rgblight_enable();
+            RGB_current_mode = rgblight_config.mode;
+          }
+        break;
+    default:
+      result = true;
+      break;
+  }
+
+  return result;
+}

keyboards/pistachio/pistachio.c

@@ -0,0 +1,18 @@
+/* Copyright 2020 rate
+ *
+ * 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 "pistachio.h"
+

keyboards/pistachio/pistachio.h

@@ -0,0 +1,57 @@
+/* Copyright 2020 rate
+ *
+ * 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"
+
+/*
+ * ,-------------------------------------------------     ---------------------------------------------------------.
+ * |      | L00 |  | L01 | L02 | L03 | L04 |  | L05 |     | R00 | R01 | R02 | R03 |  | R04 | R05 | R06 | R07 |     |
+ * |-------------------------------------- ----------     ---------------------------------------------------------+
+ * | L10 || L11 | L12 | L13 | L14 | L15 | L16 | L17 |       | R10 | R11 | R12 | R13 | R14 | R15 | R16 | R17 || R18 |
+ * |-------------------------------------------------     ---------------------------------------------------------+
+ * | L20 || L21   | L22 | L23 | L24 | L25 | L26 |         | R20 | R21 | R22 | R23 | R24 | R25 | R26 | R27   || R28 |
+ * |---------------------------------------------         -------------------------------------------        ------+
+ * | L30 || L31    | L32 | L33 | L34 | L35 | L36 |          | R30 | R31 | R32 | R33 | R34 | R35 | R36 |     || R37 |
+ * |----------------------------------------------          -------------------------------------------------------+
+ * | L40 || L41     | L42 | L43 | L44 | L45 | L46 |           | R40 | R41 | R42 | R43 | R44 | R45 | R46     || R47 |
+ * |-----------------------------------------------           -----------------------------------------------------+
+ * | L50 || L51  | L52  | L53  | L54 | L55 | L56  |             | R50  | R51 | R52 | R53 | R54 | R55 | R56  || R57 |
+ * |-----------------------------------------------             ----------------------------------------------------
+ */
+#define LAYOUT( \
+    L00, L01, L02, L03, L04, L05,           R00, R01, R02, R03, R04, R05, R06, R07,  \
+    L10, L11, L12, L13, L14, L15, L16, L17, R10, R11, R12, R13, R14, R15, R16, R17, R18, \
+    L20, L21, L22, L23, L24, L25, L26,      R20, R21, R22, R23, R24, R25, R26,      R28, \
+    L30, L31, L32, L33, L34, L35, L36,      R30, R31, R32, R33, R34, R35, R36, R27, R37, \
+    L40, L41, L42, L43, L44, L45, L46,      R40, R41, R42, R43, R44, R45,      R46, R47, \
+    L50, L51, L52, L53, L54, L55, L56,      R50,      R51, R52, R53, R54, R55, R56, R57 \
+  ) \
+  { \
+    { L00,   L01,   L02,   L03,   L04,   L05,   KC_NO,  KC_NO,  KC_NO }, \
+    { L10,   L11,   L12,   L13,   L14,   L15,   L16,    L17,    KC_NO }, \
+    { L20,   L21,   L22,   L23,   L24,   L25,   L26,    KC_NO,  KC_NO }, \
+    { L30,   L31,   L32,   L33,   L34,   L35,   L36,    KC_NO,  KC_NO }, \
+    { L40,   L41,   L42,   L43,   L44,   L45,   L46,    KC_NO,  KC_NO }, \
+    { L50,   L51,   L52,   L53,   L54,   L55,   L56,    KC_NO,  KC_NO }, \
+    { R00,   R01,   R02,   R03,   R04,   R05,   R06,    R07,    KC_NO }, \
+    { R10,   R11,   R12,   R13,   R14,   R15,   R16,    R17,    R18   }, \
+    { R20,   R21,   R22,   R23,   R24,   R25,   R26,    R27,    R28   }, \
+    { R30,   R31,   R32,   R33,   R34,   R35,   R36,    R37,    KC_NO }, \
+    { R40,   R41,   R42,   R43,   R44,   R45,   R46,    R47,    KC_NO }, \
+    { R50,   R51,   R52,   R53,   R54,   R55,   R56,    R57,    KC_NO }  \
+  }

keyboards/pistachio/readme.md

@@ -0,0 +1,21 @@
+# pistachio
+
+![pistachio](https://ratelog.net/wp-content/uploads/2020/08/Pistachio4-scaled.jpg)
+
+This is a 92-key split keyboard with JIS layout and spare keys.
+
+* Keyboard Maintainer: [rate](https://github.com/7-rate)
+* Hardware Supported: pistachio PCB, Pro Micro
+* Hardware Availability: [PCB & Case Data](https://github.com/7-rate/Pistachio), [Booth Shop](https://rates.booth.pm/items/2237334)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make pistachio:default
+
+Flashing example for this keyboard:
+
+    make pistachio:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+[Build guide](https://ratelog.net/pistachio-build-guide/)

keyboards/pistachio/rules.mk

@@ -0,0 +1,23 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes       # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = no         # Console for debug
+COMMAND_ENABLE = yes        # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output
+SPLIT_KEYBOARD = yes        # Enable split keyboard