keyboards/handwired/co60/rev7/rev7.h

   1 /* Copyright 2019 Jack Humbert <jmdaly@gmail.com>
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #pragma once
  17
  18 #include "quantum.h"
  19
  20 // This a shortcut to help you visually see your layout.
  21 // The following is a layout that uses all available switch positions.
  22 // The first section contains all of the arguments
  23 // The second converts the arguments into a two-dimensional array
  24 #define LAYOUT_all( \
  25     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, \
  26     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
  27     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, K213, K214, \
  28     K300, K301, K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313, K314, \
  29     K400, K401, K402,       K404,       K406,       K408,       K410, K411, K412, K413, K414 \
  30 ) \
  31 { \
  32     { K000, K001,   K002, K003,  K004, K005,  K006, K007,  K008, K009,  K010, K011, K012,  K013, K014 }, \
  33     { K100, KC_NO,  K102, K103,  K104, K105,  K106, K107,  K108, K109,  K110, K111, K112,  K113, K114 }, \
  34     { K200, KC_NO,  K202, K203,  K204, K205,  K206, K207,  K208, K209,  K210, K211, K212,  K213, K214 }, \
  35     { K300, K301,   K302, K303,  K304, K305,  K306, K307,  K308, K309,  K310, K311, KC_NO, K313, K314 }, \
  36     { K400, K401,   K402, KC_NO, K404, KC_NO, K406, KC_NO, K408, KC_NO, K410, K411, K412,  K413, K414 }, \
  37 }
  38
  39 #define LAYOUT_60_ansi( \
  40     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012,       K014, \
  41     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
  42     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, \
  43     K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313,       \
  44     K400, K401, K402,                   K406,                   K410, K411,       K413, K414 \
  45 ) \
  46 { \
  47     { K000, K001,  K002, K003,  K004,  K005,  K006, K007,  K008, K009,   K010, K011, K012,  KC_NO,  K014 }, \
  48     { K100, KC_NO, K102, K103,  K104,  K105,  K106, K107,  K108, K109,   K110, K111, K112,  K113,   K114 }, \
  49     { K200, KC_NO, K202, K203,  K204,  K205,  K206, K207,  K208, K209,   K210, K211, K212,  KC_NO,  K214 }, \
  50     { K300, KC_NO, K302, K303,  K304,  K305,  K306, K307,  K308, K309,   K310, K311, KC_NO, K313,   KC_NO }, \
  51     { K400, K401,  K402, KC_NO, KC_NO, KC_NO, K406, KC_NO, KC_NO, KC_NO, K410, K411, KC_NO, K413,   K414 }, \
  52 }
  53
  54 #define LAYOUT_60_ansi_split_bs_rshift( \
  55     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, \
  56     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
  57     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, \
  58     K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313, K314, \
  59     K400, K401, K402,                   K406,                   K410, K411,       K413, K414 \
  60 ) \
  61 { \
  62     { K000, K001,  K002, K003,  K004,  K005,  K006, K007,  K008, K009,   K010, K011, K012,  K013,   K014 }, \
  63     { K100, KC_NO, K102, K103,  K104,  K105,  K106, K107,  K108, K109,   K110, K111, K112,  K113,   K114 }, \
  64     { K200, KC_NO, K202, K203,  K204,  K205,  K206, K207,  K208, K209,   K210, K211, K212,  KC_NO,  K214 }, \
  65     { K300, KC_NO, K302, K303,  K304,  K305,  K306, K307,  K308, K309,   K310, K311, KC_NO, K313,   K314 }, \
  66     { K400, K401,  K402, KC_NO, KC_NO, KC_NO, K406, KC_NO, KC_NO, KC_NO, K410, K411, KC_NO, K413,   K414 }, \
  67 }
  68
  69 #define LAYOUT_60_iso( \
  70     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012,       K014, \
  71     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112,       K113, \
  72     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, K213, K214, \
  73     K300, K301, K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313,       \
  74     K400, K401, K402,                   K406,                   K410, K411,       K413, K414 \
  75 ) \
  76 { \
  77     { K000, K001,  K002, K003,  K004,  K005,  K006, K007,  K008,  K009,  K010, K011, K012,  KC_NO, K014 }, \
  78     { K100, KC_NO, K102, K103,  K104,  K105,  K106, K107,  K108,  K109,  K110, K111, K112,  K113,  KC_NO }, \
  79     { K200, KC_NO, K202, K203,  K204,  K205,  K206, K207,  K208,  K209,  K210, K211, K212,  K213,  K214 }, \
  80     { K300, K301,  K302, K303,  K304,  K305,  K306, K307,  K308,  K309,  K310, K311, KC_NO, K313,  KC_NO }, \
  81     { K400, K401,  K402, KC_NO, KC_NO, KC_NO, K406, KC_NO, KC_NO, KC_NO, K410, K411, KC_NO, K413,  K414 }, \
  82 }
  83
  84 #define LAYOUT_60_hhkb( \
  85     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, \
  86     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
  87     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, \
  88     K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313, K314, \
  89           K401, K402,                   K406,                         K411,       K413      \
  90 ) \
  91 { \
  92     { K000,  K001,   K002, K003,  K004,  K005,  K006, K007,  K008,  K009,  K010, K011, K012,  K013,  K014 }, \
  93     { K100,  KC_NO,  K102, K103,  K104,  K105,  K106, K107,  K108,  K109,  K110, K111, K112,  K113,  K114 }, \
  94     { K200,  KC_NO,  K202, K203,  K204,  K205,  K206, K207,  K208,  K209,  K210, K211, K212,  KC_NO, K214 }, \
  95     { K300,  KC_NO,  K302, K303,  K304,  K305,  K306, K307,  K308,  K309,  K310, K311, KC_NO, K313,  K314 }, \
  96     { KC_NO, K401,   K402, KC_NO, KC_NO, KC_NO, K406, KC_NO, KC_NO, KC_NO, KC_NO, K411, KC_NO, K413, KC_NO }, \
  97 }
  98
  99 #define LAYOUT_60_hhkb_split_space( \
 100     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, \
 101     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
 102     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, \
 103     K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313, K314, \
 104           K401, K402,       K404,       K406,       K408,             K411,       K413      \
 105 ) \
 106 { \
 107     { K000,  K001,   K002, K003,  K004, K005,  K006, K007,  K008, K009,  K010, K011, K012,  K013,  K014 }, \
 108     { K100,  KC_NO,  K102, K103,  K104, K105,  K106, K107,  K108, K109,  K110, K111, K112,  K113,  K114 }, \
 109     { K200,  KC_NO,  K202, K203,  K204, K205,  K206, K207,  K208, K209,  K210, K211, K212,  KC_NO, K214 }, \
 110     { K300,  KC_NO,  K302, K303,  K304, K305,  K306, K307,  K308, K309,  K310, K311, KC_NO, K313,  K314 }, \
 111     { KC_NO, K401,   K402, KC_NO, K404, KC_NO, K406, KC_NO, K408, KC_NO, KC_NO, K411, KC_NO, K413, KC_NO }, \
 112 }
 113
 114 #define LAYOUT_60_hhkb_split_625u_space( \
 115     K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, \
 116     K100,       K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
 117     K200,       K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212,       K214, \
 118     K300,       K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313, K314, \
 119           K401, K402,       K404,       K406,       K408,       K410, K411,       K413      \
 120 ) \
 121 { \
 122     { K000,  K001,   K002, K003,  K004, K005,  K006, K007,  K008, K009,  K010, K011, K012,  K013,  K014 }, \
 123     { K100,  KC_NO,  K102, K103,  K104, K105,  K106, K107,  K108, K109,  K110, K111, K112,  K113,  K114 }, \
 124     { K200,  KC_NO,  K202, K203,  K204, K205,  K206, K207,  K208, K209,  K210, K211, K212,  KC_NO, K214 }, \
 125     { K300,  KC_NO,  K302, K303,  K304, K305,  K306, K307,  K308, K309,  K310, K311, KC_NO, K313,  K314 }, \
 126     { KC_NO, K401,   K402, KC_NO, K404, KC_NO, K406, KC_NO, K408, KC_NO, K410, K411, KC_NO, K413, KC_NO }, \
 127 }
 128
 129 // Backlighting
 130 typedef union {
 131     uint8_t raw;
 132     struct {
 133         bool    enable :1;
 134         bool    breathing : 1;
 135         uint8_t level  :6;
 136     };
 137 } backlight_levels_config_t;
 138
 139 extern backlight_levels_config_t kb_backlight_config;
 140 extern bool kb_backlight_breathing;
 141
 142 void backlight_init_ports(void);
 143 void backlight_set(uint8_t level);
 144 bool is_breathing(void);
 145 void breathing_enable(void);
 146 void breathing_disable(void);