Refactor cospad to current standards and enable support for backlight keycodes (...

[qmk_firmware.git] / keyboards / cospad / cospad.h

diff --git a/keyboards/cospad/cospad.h b/keyboards/cospad/cospad.h
index cbcbdaf9642242924605c8896f10b7e7cbfc7ed1..ad3ca0d6bc334bf71a8de78fa2609f6f1c4edc5d 100644 (file)
--- a/keyboards/cospad/cospad.h
+++ b/keyboards/cospad/cospad.h
@@ -1,10 +1,32 @@
-#ifndef COSPAD_H
-#define COSPAD_H
+
+/* Copyright 2019
+ *
+ * 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 ___ KC_NO
 
-// readability
-#define XXX KC_NO
+/* This 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.
+ */
 
 /* COSPAD ortho matrix layout
    * ,-------------------.
@@ -21,7 +43,54 @@
    * | 50 | 51 | 52 | 53 |
    * `-------------------'
  */
+#define LAYOUT_ortho_6x4( \
+       k00, k01, k02, k03, \
+       k10, k11, k12, k13, \
+       k20, k21, k22, k23, \
+       k30, k31, k32, k33, \
+       k40, k41, k42, k43, \
+       k50, k51, k52, k53  \
+) \
+{ \
+       {k00, k01, k02, k03}, \
+       {k10, k11, k12, k13}, \
+       {k20, k21, k22, k23}, \
+       {k30, k31, k32, k33}, \
+       {k40, k41, k42, k43}, \
+       {k50, k51, k52, k53}  \
+}
 
+/* COSPAD gamepad matrix layout
+   * ,-------------------.
+   * | 00 | 01 | 02 | 03 |
+   * |----|----|----|----|
+   * | 10 | 11 | 12 | 13 |
+   * |----|----|----|----|
+   * | 20 | 21 | 22 |    |
+   * |----|----|----| 23 |
+   * | 30 | 31 | 32 |    |
+   * |----|----|----|----|
+   * | 40 | 41 | 42 | 43 |
+   * |----|----|----|----|
+   * | 50 | 51 | 52 | 53 |
+   * `-------------------'
+ */
+#define LAYOUT_gamepad_6x4( \
+       k00, k01, k02, k03, \
+       k10, k11, k12, k13, \
+       k20, k21, k22,      \
+       k30, k31, k32, k23, \
+       k40, k41, k42, k43, \
+       k50, k51, k52, k53  \
+) \
+{ \
+       {k00, k01, k02, k03},   \
+       {k10, k11, k12, k13},   \
+       {k20, k21, k22, k23},   \
+       {k30, k31, k32, ___}, \
+       {k40, k41, k42, k43},   \
+       {k50, k51, k52, k53}    \
+}
 
 /* COSPAD numpad matrix layout
    * ,-------------------.
@@ -38,40 +107,24 @@
    * |    50   | 52 |    |
    * `-------------------'
  */
-// The first section contains all of the arguments
-// The second converts the arguments into a two-dimensional array
-#define KEYMAP( \
-       k00, k01, k02, k03, \
-       k10, k11, k12, k13, \
-       k20, k21, k22, k23, \
-       k30, k31, k32, k33, \
-       k40, k41, k42, k43, \
-       k50, k51, k52, k53 \
+#define LAYOUT_numpad_6x4( \
+       k00, k01, k02, k03,  \
+       k10, k11, k12, k13,  \
+       k20, k21, k22,       \
+       k30, k31, k32, k23,  \
+       k40, k41, k42,       \
+       k50,      k52, k43   \
 ) \
 { \
-       {k00, k01, k02, k03}, \
-       {k10, k11, k12, k13}, \
-       {k20, k21, k22, k23}, \
-       {k30, k31, k32, k33}, \
-       {k40, k41, k42, k43}, \
-       {k50, k51, k52, k53} \
+       {k00, k01, k02, k03},   \
+       {k10, k11, k12, k13},   \
+       {k20, k21, k22, k23},   \
+       {k30, k31, k32, ___}, \
+       {k40, k41, k42, k43},   \
+       {k50, ___, k52, ___}  \
 }
-void matrix_init_user(void);
-void matrix_scan_user(void);
-/*
-inline void cospad_bl_led_on(void)     { DDRF |= (1<<7); PORTF &= ~(1<<7); }
-inline void cospad_bl_led_off(void)    { DDRF &= ~(1<<7); PORTF &= ~(1<<7); }
-*/
 
-inline void cospad_bl_led_on(void)     { PORTF &= ~(1<<7); }
-inline void cospad_bl_led_off(void)    { PORTF |= (1<<7); }
-
-inline void cospad_bl_led_togg(void) {
-   uint8_t bl_mask = PORTF&(1<<7);
-   if (bl_mask) {
-      PORTF &= ~(1<<7);
-   } else {
-      PORTF |= (1<<7);
-   }
-}
-#endif
+// Add backwards compatibility for existing keymaps
+#define cospad_bl_led_on   backlight_enable
+#define cospad_bl_led_off  backlight_disable
+#define cospad_bl_led_togg backlight_toggle