keychron_qmk_firmware/keyboards/tw40/tw40.h

/* Copyright 2020 KnoblesseOblige
 *
 * 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"

#define kxx KC_NO

/* 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.
 */
#define LAYOUT_all( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32, k33, k34, k35, k36,           k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, k33, k34, k35, k36, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_3_split_space_standard_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31, k32, k33, k34,      k36,           k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, k32, k33, k34, kxx, k36, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_3_split_space_standard_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31, k32, k33, k34,      k36,           k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, k32, k33, k34, kxx, k36, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_3_split_space_split_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32, k33, k34,      k36,           k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, k33, k34, kxx, k36, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_3_split_space_split_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32, k33, k34,      k36,           k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, k33, k34, kxx, k36, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_4_split_space_standard_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31, k32, k33, k34, k35, k36,           k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, k32, k33, k34, k35, k36, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_4_split_space_standard_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31, k32, k33, k34, k35, k36,           k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, k32, k33, k34, k35, k36, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_4_split_space_split_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32, k33, k34, k35, k36,           k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, k33, k34, k35, k36, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_4_split_space_split_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32, k33, k34, k35, k36,           k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, k33, k34, k35, k36, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_625_standard_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31, k32,      k34,                     k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, k32, kxx, k34, kxx, kxx, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_625_standard_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31, k32,      k34,                     k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, k32, kxx, k34, kxx, kxx, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_625_split_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32,      k34,                     k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, kxx, k34, kxx, kxx, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_625_split_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31, k32,      k34,                     k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, k32, kxx, k34, kxx, kxx, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_700_standard_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31,           k34,                     k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, kxx, kxx, k34, kxx, kxx, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_700_standard_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c,      \
    k30, k31,           k34,                     k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, kxx }, \
  { k30, k31, kxx, kxx, k34, kxx, kxx, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}

#define LAYOUT_700_split_rshift_4x_125( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31,           k34,                     k39,      k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, kxx, kxx, k34, kxx, kxx, kxx, kxx, k39, kxx, k3b, k3c, k3d }  \
}

#define LAYOUT_700_split_rshift_5x_100( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29,      k2b, k2c, k2d, \
    k30, k31,           k34,                     k39, k3a, k3b, k3c, k3d \
) { \
  { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
  { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, kxx }, \
  { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, kxx, k2b, k2c, k2d }, \
  { k30, k31, kxx, kxx, k34, kxx, kxx, kxx, kxx, k39, k3a, k3b, k3c, k3d }  \
}