keyboards/ergodox_ez/ergodox_ez.h

   1 #ifndef ERGODOX_EZ_H
   2 #define ERGODOX_EZ_H
   3
   4 #include "quantum.h"
   5 #include <stdint.h>
   6 #include <stdbool.h>
   7 #include "i2c_master.h"
   8 #include <util/delay.h>
   9
  10 #define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
  11 #define CPU_16MHz       0x00
  12
  13 // I2C aliases and register addresses (see "mcp23018.md")
  14 #define I2C_ADDR        0b0100000
  15 #define I2C_ADDR_WRITE  ( (I2C_ADDR<<1) | I2C_WRITE )
  16 #define I2C_ADDR_READ   ( (I2C_ADDR<<1) | I2C_READ  )
  17 #define IODIRA          0x00            // i/o direction register
  18 #define IODIRB          0x01
  19 #define GPPUA           0x0C            // GPIO pull-up resistor register
  20 #define GPPUB           0x0D
  21 #define GPIOA           0x12            // general purpose i/o port register (write modifies OLAT)
  22 #define GPIOB           0x13
  23 #define OLATA           0x14            // output latch register
  24 #define OLATB           0x15
  25
  26 extern i2c_status_t mcp23018_status;
  27
  28 void init_ergodox(void);
  29 void ergodox_blink_all_leds(void);
  30 uint8_t init_mcp23018(void);
  31 uint8_t ergodox_left_leds_update(void);
  32
  33 #ifndef LED_BRIGHTNESS_LO
  34 #define LED_BRIGHTNESS_LO       15
  35 #endif
  36 #ifndef LED_BRIGHTNESS_LO
  37 #define LED_BRIGHTNESS_HI       255
  38 #endif
  39
  40
  41 inline void ergodox_board_led_on(void)      { DDRD |=  (1<<6); PORTD |=  (1<<6); }
  42 inline void ergodox_right_led_1_on(void)    { DDRB |=  (1<<5); PORTB |=  (1<<5); }
  43 inline void ergodox_right_led_2_on(void)    { DDRB |=  (1<<6); PORTB |=  (1<<6); }
  44 inline void ergodox_right_led_3_on(void)    { DDRB |=  (1<<7); PORTB |=  (1<<7); }
  45 inline void ergodox_right_led_on(uint8_t led) { DDRB |= (1<<(led+4)); PORTB |= (1<<(led+4)); }
  46
  47 inline void ergodox_board_led_off(void)     { DDRD &= ~(1<<6); PORTD &= ~(1<<6); }
  48 inline void ergodox_right_led_1_off(void)   { DDRB &= ~(1<<5); PORTB &= ~(1<<5); }
  49 inline void ergodox_right_led_2_off(void)   { DDRB &= ~(1<<6); PORTB &= ~(1<<6); }
  50 inline void ergodox_right_led_3_off(void)   { DDRB &= ~(1<<7); PORTB &= ~(1<<7); }
  51 inline void ergodox_right_led_off(uint8_t led) { DDRB &= ~(1<<(led+4)); PORTB &= ~(1<<(led+4)); }
  52
  53 #ifdef LEFT_LEDS
  54 bool ergodox_left_led_1;
  55 bool ergodox_left_led_2;
  56 bool ergodox_left_led_3;
  57
  58 inline void ergodox_left_led_1_on(void)    { ergodox_left_led_1 = 1; }
  59 inline void ergodox_left_led_2_on(void)    { ergodox_left_led_2 = 1; }
  60 inline void ergodox_left_led_3_on(void)    { ergodox_left_led_3 = 1; }
  61
  62 inline void ergodox_left_led_1_off(void)    { ergodox_left_led_1 = 0; }
  63 inline void ergodox_left_led_2_off(void)    { ergodox_left_led_2 = 0; }
  64 inline void ergodox_left_led_3_off(void)    { ergodox_left_led_3 = 0; }
  65 #endif // LEFT_LEDS
  66
  67 inline void ergodox_led_all_on(void)
  68 {
  69     ergodox_board_led_on();
  70     ergodox_right_led_1_on();
  71     ergodox_right_led_2_on();
  72     ergodox_right_led_3_on();
  73 #ifdef LEFT_LEDS
  74     ergodox_left_led_1_on();
  75     ergodox_left_led_2_on();
  76     ergodox_left_led_3_on();
  77 #endif // LEFT_LEDS
  78 }
  79
  80 inline void ergodox_led_all_off(void)
  81 {
  82     ergodox_board_led_off();
  83     ergodox_right_led_1_off();
  84     ergodox_right_led_2_off();
  85     ergodox_right_led_3_off();
  86 #ifdef LEFT_LEDS
  87     ergodox_left_led_1_off();
  88     ergodox_left_led_2_off();
  89     ergodox_left_led_3_off();
  90 #endif // LEFT_LEDS
  91 }
  92
  93 inline void ergodox_right_led_1_set(uint8_t n)    { OCR1A = n; }
  94 inline void ergodox_right_led_2_set(uint8_t n)    { OCR1B = n; }
  95 inline void ergodox_right_led_3_set(uint8_t n)    { OCR1C = n; }
  96 inline void ergodox_right_led_set(uint8_t led, uint8_t n)  {
  97     (led == 1) ? (OCR1A = n) :
  98     (led == 2) ? (OCR1B = n) :
  99                  (OCR1C = n);
 100 }
 101
 102 inline void ergodox_led_all_set(uint8_t n)
 103 {
 104     ergodox_right_led_1_set(n);
 105     ergodox_right_led_2_set(n);
 106     ergodox_right_led_3_set(n);
 107 }
 108
 109 #define KEYMAP(                                                 \
 110                                                                 \
 111     /* left hand, spatial positions */                          \
 112     k00,k01,k02,k03,k04,k05,k06,                                \
 113     k10,k11,k12,k13,k14,k15,k16,                                \
 114     k20,k21,k22,k23,k24,k25,                                    \
 115     k30,k31,k32,k33,k34,k35,k36,                                \
 116     k40,k41,k42,k43,k44,                                        \
 117                             k55,k56,                            \
 118                                 k54,                            \
 119                         k53,k52,k51,                            \
 120                                                                 \
 121     /* right hand, spatial positions */                         \
 122         k07,k08,k09,k0A,k0B,k0C,k0D,                            \
 123         k17,k18,k19,k1A,k1B,k1C,k1D,                            \
 124             k28,k29,k2A,k2B,k2C,k2D,                            \
 125         k37,k38,k39,k3A,k3B,k3C,k3D,                            \
 126                 k49,k4A,k4B,k4C,k4D,                            \
 127     k57,k58,                                                    \
 128     k59,                                                        \
 129     k5C,k5B,k5A )                                               \
 130                                                                 \
 131    /* matrix positions */                                       \
 132    {                                                            \
 133     { k00, k10, k20, k30, k40, KC_NO },   \
 134     { k01, k11, k21, k31, k41, k51 },   \
 135     { k02, k12, k22, k32, k42, k52 },   \
 136     { k03, k13, k23, k33, k43, k53 },   \
 137     { k04, k14, k24, k34, k44, k54 },   \
 138     { k05, k15, k25, k35, KC_NO, k55 },   \
 139     { k06, k16, KC_NO, k36, KC_NO, k56 },   \
 140                                                                  \
 141     { k07, k17, KC_NO, k37,KC_NO, k57 },   \
 142     { k08, k18, k28, k38,KC_NO, k58 },   \
 143     { k09, k19, k29, k39, k49, k59 },   \
 144     { k0A, k1A, k2A, k3A, k4A, k5A },   \
 145     { k0B, k1B, k2B, k3B, k4B, k5B },   \
 146     { k0C, k1C, k2C, k3C, k4C, k5C },   \
 147     { k0D, k1D, k2D, k3D, k4D, KC_NO }    \
 148    }
 149
 150 #define KEYMAP_80(                                              \
 151                                                                 \
 152     /* left hand, spatial positions */                          \
 153     k00,k01,k02,k03,k04,k05,k06,                                \
 154     k10,k11,k12,k13,k14,k15,k16,                                \
 155     k20,k21,k22,k23,k24,k25,                                    \
 156     k30,k31,k32,k33,k34,k35,k36,                                \
 157     k40,k41,k42,k43,k44,                                        \
 158                             k55,k56,                            \
 159                         k45,k46,k54,                            \
 160                         k53,k52,k51,                            \
 161                                                                 \
 162     /* right hand, spatial positions */                         \
 163         k07,k08,k09,k0A,k0B,k0C,k0D,                            \
 164         k17,k18,k19,k1A,k1B,k1C,k1D,                            \
 165             k28,k29,k2A,k2B,k2C,k2D,                            \
 166         k37,k38,k39,k3A,k3B,k3C,k3D,                            \
 167                 k49,k4A,k4B,k4C,k4D,                            \
 168     k57,k58,                                                    \
 169     k59,k47,k48,                                                \
 170     k5C,k5B,k5A )                                               \
 171                                                                 \
 172    /* matrix positions */                                       \
 173    {                                                            \
 174     { k00, k10, k20, k30, k40, KC_NO },   \
 175     { k01, k11, k21, k31, k41, k51 },   \
 176     { k02, k12, k22, k32, k42, k52 },   \
 177     { k03, k13, k23, k33, k43, k53 },   \
 178     { k04, k14, k24, k34, k44, k54 },   \
 179     { k05, k15, k25, k35, k45, k55 },   \
 180     { k06, k16, KC_NO, k36, k46, k56 },   \
 181                                                                  \
 182     { k07, k17, KC_NO, k37, k47, k57 },   \
 183     { k08, k18, k28, k38, k48, k58 },   \
 184     { k09, k19, k29, k39, k49, k59 },   \
 185     { k0A, k1A, k2A, k3A, k4A, k5A },   \
 186     { k0B, k1B, k2B, k3B, k4B, k5B },   \
 187     { k0C, k1C, k2C, k3C, k4C, k5C },   \
 188     { k0D, k1D, k2D, k3D, k4D, KC_NO }    \
 189    }
 190
 191 #define KEYMAP_PRETTY(                                                                                        \
 192     /* left hand, spatial positions */     /* right hand, spatial positions */                         \
 193     L00,L01,L02,L03,L04,L05,L06,               R00,R01,R02,R03,R04,R05,R06,                            \
 194     L10,L11,L12,L13,L14,L15,L16,               R10,R11,R12,R13,R14,R15,R16,                            \
 195     L20,L21,L22,L23,L24,L25,                       R21,R22,R23,R24,R25,R26,                            \
 196     L30,L31,L32,L33,L34,L35,L36,               R30,R31,R32,R33,R34,R35,R36,                            \
 197     L40,L41,L42,L43,L44,                               R42,R43,R44,R45,R46,                            \
 198                             L55,L56,       R50,R51,                                                    \
 199                                 L54,       R52,                                                        \
 200                         L53,L52,L51,       R55,R54,R53 )                                               \
 201                                           \
 202    /* matrix positions */                 \
 203     {                                     \
 204     { L00, L10, L20, L30, L40, KC_NO },   \
 205     { L01, L11, L21, L31, L41, L51 },     \
 206     { L02, L12, L22, L32, L42, L52 },     \
 207     { L03, L13, L23, L33, L43, L53 },     \
 208     { L04, L14, L24, L34, L44, L54 },     \
 209     { L05, L15, L25, L35, KC_NO, L55 },   \
 210     { L06, L16, KC_NO, L36, KC_NO, L56 }, \
 211                                           \
 212     { R00, R10, KC_NO, R30,KC_NO, R50 },  \
 213     { R01, R11, R21, R31,KC_NO, R51 },    \
 214     { R02, R12, R22, R32, R42, R52 },     \
 215     { R03, R13, R23, R33, R43, R53 },     \
 216     { R04, R14, R24, R34, R44, R54 },     \
 217     { R05, R15, R25, R35, R45, R55 },     \
 218     { R06, R16, R26, R36, R46, KC_NO }    \
 219     }
 220
 221 #define KEYMAP_PRETTY_80(                                                                              \
 222     /* left hand, spatial positions */     /* right hand, spatial positions */                         \
 223     L00,L01,L02,L03,L04,L05,L06,               R00,R01,R02,R03,R04,R05,R06,                            \
 224     L10,L11,L12,L13,L14,L15,L16,               R10,R11,R12,R13,R14,R15,R16,                            \
 225     L20,L21,L22,L23,L24,L25,                       R21,R22,R23,R24,R25,R26,                            \
 226     L30,L31,L32,L33,L34,L35,L36,               R30,R31,R32,R33,R34,R35,R36,                            \
 227     L40,L41,L42,L43,L44,                               R42,R43,R44,R45,R46,                            \
 228                             L55,L56,       R50,R51,                                                    \
 229                         L45,L46,L54,       R52,R40,R41,                                                \
 230                         L53,L52,L51,       R55,R54,R53 )                                               \
 231                                           \
 232       /* matrix positions */              \
 233     {                                     \
 234     { L00, L10, L20, L30, L40, KC_NO },   \
 235     { L01, L11, L21, L31, L41, L51 },     \
 236     { L02, L12, L22, L32, L42, L52 },     \
 237     { L03, L13, L23, L33, L43, L53 },     \
 238     { L04, L14, L24, L34, L44, L54 },     \
 239     { L05, L15, L25, L35, L45, L55 },     \
 240     { L06, L16, KC_NO, L36, L46, L56 },   \
 241                                           \
 242     { R00, R10, KC_NO, R30, R40, R50 },   \
 243     { R01, R11, R21, R31, R41, R51 },     \
 244     { R02, R12, R22, R32, R42, R52 },     \
 245     { R03, R13, R23, R33, R43, R53 },     \
 246     { R04, R14, R24, R34, R44, R54 },     \
 247     { R05, R15, R25, R35, R45, R55 },     \
 248     { R06, R16, R26, R36, R46, KC_NO }    \
 249     }
 250
 251 #define LAYOUT_ergodox KEYMAP
 252 #define LAYOUT_ergodox_pretty KEYMAP_PRETTY
 253 #define LAYOUT_ergodox_80 KEYMAP_80
 254 #define LAYOUT_ergodox_pretty_80 KEYMAP_PRETTY_80
 255
 256 #endif