ergodox_ez.h 11 KB

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