logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

matrix.c (11358B)

    

  1. /*
  3. Copyright 2013 Oleg Kostyuk <cub.uanic@gmail.com>
  5. This program is free software: you can redistribute it and/or modify
  6. it under the terms of the GNU General Public License as published by
  7. the Free Software Foundation, either version 2 of the License, or
  8. (at your option) any later version.
  10. This program is distributed in the hope that it will be useful,
  11. but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. GNU General Public License for more details.
  15. You should have received a copy of the GNU General Public License
  16. along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17. */
  19. #include "matrix.h"
  20. #include "wait.h"
  21. #include "debug.h"
  22. #include "util.h"
  23. #include "debounce.h"
  24. #include "gergo.h"
  26. #ifdef BALLER
  27. #include <avr/interrupt.h>
  28. #include "pointing_device.h"
  29. #endif
  31. #ifndef DEBOUNCE
  32. #   define DEBOUNCE	5
  33. #endif
  35. // MCP Pin Defs
  36. #define RROW1 (1u<<3)
  37. #define RROW2 (1u<<2)
  38. #define RROW3 (1u<<1)
  39. #define RROW4 (1u<<0)
  40. #define COL0 (1u<<0)
  41. #define COL1 (1u<<1)
  42. #define COL2 (1u<<2)
  43. #define COL3 (1u<<3)
  44. #define COL4 (1u<<4)
  45. #define COL5 (1u<<5)
  46. #define COL6 (1u<<6)
  48. // ATmega pin defs
  49. #define ROW1  (1u<<6)
  50. #define ROW2  (1u<<5)
  51. #define ROW3  (1u<<4)
  52. #define ROW4  (1u<<1)
  53. #define COL7 (1u<<0)
  54. #define COL8 (1u<<1)
  55. #define COL9 (1u<<2)
  56. #define COL10 (1u<<3)
  57. #define COL11 (1u<<2)
  58. #define COL12 (1u<<3)
  59. #define COL13 (1u<<6)
  61. //Trackball pin defs
  62. #define TRKUP (1u<<4)
  63. #define TRKDN (1u<<5)
  64. #define TRKLT (1u<<6)
  65. #define TRKRT (1u<<7)
  66. #define TRKBTN (1u<<6)
  69. // Multiple for mouse moves
  70. #ifndef TRKSTEP
  71. #define TRKSTEP 20
  72. #endif
  74. // multiple for mouse scroll
  75. #ifndef SCROLLSTEP
  76. #define SCROLLSTEP 5
  77. #endif
  79. // bit masks
  80. #define BMASK     (COL7 | COL8 | COL9 | COL10)
  81. #define CMASK     (COL13)
  82. #define DMASK     (COL11 | COL12)
  83. #define FMASK     (ROW1 | ROW2 | ROW3 | ROW4)
  84. #define RROWMASK  (RROW1 | RROW2 | RROW3 | RROW4)
  85. #define MCPMASK   (COL0 | COL1 | COL2 | COL3 | COL4 | COL5 | COL6)
  86. #define TRKMASK   (TRKUP | TRKDN | TRKRT | TRKLT)
  88. // Trackball interrupts accumulate over here. Processed on scan
  89. // Stores prev state of mouse, high bits store direction
  90. uint8_t trkState    = 0;
  91. uint8_t trkBtnState = 0;
  93. volatile uint8_t tbUpCnt  = 0;
  94. volatile uint8_t tbDnCnt  = 0;
  95. volatile uint8_t tbLtCnt  = 0;
  96. volatile uint8_t tbRtCnt  = 0;
  98. /* matrix state(1:on, 0:off) */
  99. static matrix_row_t matrix[MATRIX_ROWS];
  100. /*
  101.  * matrix state(1:on, 0:off)
  102.  * contains the raw values without debounce filtering of the last read cycle.
  103.  */
  104. static matrix_row_t raw_matrix[MATRIX_ROWS];
  106. // Debouncing: store for each key the number of scans until it's eligible to
  107. // change.  When scanning the matrix, ignore any changes in keys that have
  108. // already changed in the last DEBOUNCE scans.
  110. static matrix_row_t read_cols(uint8_t row);
  111. static void         init_cols(void);
  112. static void         unselect_rows(void);
  113. static void         select_row(uint8_t row);
  114. static void enableInterrupts(void);
  116. static uint8_t mcp23018_reset_loop;
  117. // static uint16_t mcp23018_reset_loop;
  119. __attribute__ ((weak)) void matrix_init_user(void) {}
  121. __attribute__ ((weak)) void matrix_scan_user(void) {}
  123. __attribute__ ((weak))
  124. void matrix_init_kb(void) {
  125.   matrix_init_user();
  126. }
  128. __attribute__ ((weak))
  129. void matrix_scan_kb(void) {
  130.   matrix_scan_user();
  131. }
  133. inline uint8_t matrix_rows(void) { return MATRIX_ROWS; }
  135. inline uint8_t matrix_cols(void) { return MATRIX_COLS; }
  138. void matrix_init(void) {
  139.     // initialize row and col
  140.     mcp23018_status = init_mcp23018();
  141.     unselect_rows();
  142.     init_cols();
  144.   // initialize matrix state: all keys off
  145.   for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
  146.     matrix[i]     = 0;
  147.     raw_matrix[i] = 0;
  148.   }
  150.     debounce_init(MATRIX_ROWS);
  151.     matrix_init_kb();
  152. }
  154. void matrix_power_up(void) {
  155.     mcp23018_status = init_mcp23018();
  157.     unselect_rows();
  158.     init_cols();
  160.     // initialize matrix state: all keys off
  161.     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
  162.         matrix[i] = 0;
  163.     }
  164. }
  166. // Reads and stores a row, returning
  167. // whether a change occurred.
  168. static inline bool store_raw_matrix_row(uint8_t index) {
  169.   matrix_row_t temp = read_cols(index);
  170.   if (raw_matrix[index] != temp) {
  171.     raw_matrix[index] = temp;
  172.     return true;
  173.   }
  174.   return false;
  175. }
  179. uint8_t matrix_scan(void) {
  180.     // TODO: Find what is trashing interrupts
  181.     enableInterrupts();
  183.     // First we handle the mouse inputs
  184. #ifdef BALLER
  185.     uint8_t pBtn   = PINE & TRKBTN;
  187.     #ifdef DEBUG_BALLER
  188.     // Compare to previous, mod report
  189.     if (tbUpCnt + tbDnCnt + tbLtCnt + tbRtCnt != 0)
  190.         xprintf("U: %d D: %d L: %d R: %d B: %d\n", tbUpCnt, tbDnCnt, tbLtCnt, tbRtCnt, (trkBtnState >> 6));
  191.     #endif
  193.     // Modify the report
  194.     report_mouse_t pRprt = pointing_device_get_report();
  196.     // Scroll by default, move on layer
  197.     if (layer_state == 0) {
  198. 		  pRprt.h += tbLtCnt * SCROLLSTEP; tbLtCnt = 0;
  199. 		  pRprt.h -= tbRtCnt * SCROLLSTEP; tbRtCnt = 0;
  200. 		  pRprt.v -= tbUpCnt * SCROLLSTEP; tbUpCnt = 0;
  201. 		  pRprt.v += tbDnCnt * SCROLLSTEP; tbDnCnt = 0;
  202.     } else {
  203. 		  pRprt.x -= tbLtCnt * TRKSTEP * (layer_state - 1); tbLtCnt = 0;
  204. 		  pRprt.x += tbRtCnt * TRKSTEP * (layer_state - 1); tbRtCnt = 0;
  205. 		  pRprt.y -= tbUpCnt * TRKSTEP * (layer_state - 1); tbUpCnt = 0;
  206. 		  pRprt.y += tbDnCnt * TRKSTEP * (layer_state - 1); tbDnCnt = 0;
  207.     }
  209. #ifdef DEBUG_BALLER
  210.     if (pRprt.x != 0 || pRprt.y != 0)
  211.         xprintf("X: %d Y: %d\n", pRprt.x, pRprt.y);
  212. #endif
  214.     if ((pBtn != trkBtnState) && ((pBtn >> 6) == 0))  pRprt.buttons |= MOUSE_BTN1;
  215.     if ((pBtn != trkBtnState) && ((pBtn >> 6) == 1))  pRprt.buttons &= ~MOUSE_BTN1;
  217.     // Save state, push update
  218.     if (pRprt.x != 0 || pRprt.y != 0 || pRprt.h != 0 || pRprt.v != 0 || (trkBtnState != pBtn))
  219.         pointing_device_set_report(pRprt);
  221.     trkBtnState = pBtn;
  222. #endif
  224.     // Then the keyboard
  225.     if (mcp23018_status) {  // if there was an error
  226.         if (++mcp23018_reset_loop == 0) {
  227.             // if (++mcp23018_reset_loop >= 1300) {
  228.             // since mcp23018_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans
  229.             // this will be approx bit more frequent than once per second
  230.             print("trying to reset mcp23018\n");
  231.             mcp23018_status = init_mcp23018();
  232.             if (mcp23018_status) {
  233.                 print("left side not responding\n");
  234.             } else {
  235.                 print("left side attached\n");
  236.             }
  237.         }
  238.     }
  240.     bool changed = false;
  241.     for (uint8_t i = 0; i < MATRIX_ROWS_PER_SIDE; i++) {
  242.         // select rows from left and right hands
  243.         uint8_t left_index = i;
  244.         uint8_t right_index = i + MATRIX_ROWS_PER_SIDE;
  245.         select_row(left_index);
  246.         select_row(right_index);
  248.         // we don't need a 30us delay anymore, because selecting a
  249.         // left-hand row requires more than 30us for i2c.
  251.         changed |= store_raw_matrix_row(left_index);
  252.         changed |= store_raw_matrix_row(right_index);
  254.         unselect_rows();
  255.     }
  257.     debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
  258.     matrix_scan_kb();
  260.     enableInterrupts();
  262. #ifdef DEBUG_MATRIX
  263.     for (uint8_t c = 0; c < MATRIX_COLS; c++)
  264. 		for (uint8_t r = 0; r < MATRIX_ROWS; r++)
  265. 		  if (matrix_is_on(r, c)) xprintf("r:%d c:%d \n", r, c);
  266. #endif
  268.     return 1;
  269. }
  271. inline bool matrix_is_on(uint8_t row, uint8_t col) { return (matrix[row] & ((matrix_row_t)1 << col)); }
  273. inline matrix_row_t matrix_get_row(uint8_t row) { return matrix[row]; }
  275. void matrix_print(void) {
  276.     print("\nr/c 0123456789ABCDEF\n");
  277.     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
  278.         print_hex8(row); print(": ");
  279.         print_bin_reverse16(matrix_get_row(row));
  280.         print("\n");
  281.     }
  282. }
  284. // Remember this means ROWS
  285. static void  init_cols(void) {
  286.     // init on mcp23018
  287.     // not needed, already done as part of init_mcp23018()
  289.     // Input with pull-up(DDR:0, PORT:1)
  290.     DDRF  &= ~FMASK;
  291.     PORTF |=  FMASK;
  292. }
  294. static matrix_row_t read_cols(uint8_t row) {
  295.     if (row < 7) {
  296.         if (mcp23018_status) { // if there was an error
  297.             return 0;
  298.         } else {
  299.             uint8_t data = 0;
  300.             mcp23018_status = i2c_read_register(I2C_ADDR, GPIOB, &data, 1, I2C_TIMEOUT);
  302. #ifdef DEBUG_MATRIX
  303.             if (~data != 0x00) xprintf("I2C: %d\n", ~data);
  304. #endif
  305.             return ~data;
  306.         }
  307.     } else {
  308.          /* read from teensy
  309. 	        * bitmask is 0b0111001, but we want the lower four
  310. 	        * we'll return 1s for the top two, but that's harmless.
  311. 	        */
  312.         // So I need to confuckulate all this
  313.         //return ~(((PIND & DMASK) >> 1  | ((PINC & CMASK) >> 6) | (PIN)));
  314.         //return ~((PINF & 0x03) | ((PINF & 0xF0) >> 2));
  315.         return ~(
  316.            (((PINF & ROW4) >> 1)
  317.           | ((PINF & (ROW1 | ROW2 | ROW3)) >> 3))
  318.         & 0xF);
  319.     }
  320. }
  322. // Row pin configuration
  323. static void unselect_rows(void)
  324. {
  325.     // no need to unselect on mcp23018, because the select step sets all
  326.     // the other row bits high, and it's not changing to a different
  327.     // direction
  328.     // Hi-Z(DDR:0, PORT:0) to unselect
  329.     DDRB  &= ~(BMASK | TRKMASK);
  330.     PORTB &= ~(BMASK);
  331.     DDRC  &= ~CMASK;
  332.     PORTC &= ~CMASK;
  333.     DDRD  &= ~DMASK;
  334.     PORTD &= ~DMASK;
  336. 	// Fix trashing of DDRB for TB
  337.     PORTB |= TRKMASK;
  338. }
  340. static void select_row(uint8_t row)
  341. {
  342.     if (row < 7) {
  343.         // select on mcp23018
  344.         if (mcp23018_status) { // do nothing on error
  345.         } else { // set active row low  : 0 // set other rows hi-Z : 1
  346.             uint8_t data = 0xFF & ~(1<<row);
  347.             mcp23018_status = i2c_write_register(I2C_ADDR, GPIOA, &data, 1, I2C_TIMEOUT);
  348.         }
  349.     } else {
  350.         // Output low(DDR:1, PORT:0) to select
  351.         switch (row) {
  352.             case 7:
  353.                 DDRB  |= COL7;
  354.                 PORTB &= ~COL7;
  355.                 break;
  356.             case 8:
  357.                 DDRB  |= COL8;
  358.                 PORTB &= ~COL8;
  359.                 break;
  360.             case 9:
  361.                 DDRB  |= COL9;
  362.                 PORTB &= ~COL9;
  363.                 break;
  364.             case 10:
  365.                 DDRB  |= COL10;
  366.                 PORTB &= ~COL10;
  367.                 break;
  368.             case 11:
  369.                 DDRD  |= COL11;
  370.                 PORTD &= ~COL11;
  371.                 break;
  372.             case 12:
  373.                 DDRD  |= COL12;
  374.                 PORTD &= ~COL12;
  375.                 break;
  376.             case 13:
  377.                 DDRC  |= COL13;
  378.                 PORTC &= ~COL13;
  379.                 break;
  380.         }
  381.     }
  382. }
  385. // Trackball Interrupts
  386. static void enableInterrupts(void) {
  387.     #ifdef BALLER
  388.       // Set interrupt mask
  389.       // Set port defs
  390.       DDRB &= ~TRKMASK;
  391.       PORTB |= TRKMASK;
  392.       DDRE &= ~TRKBTN;
  393.       PORTE |= TRKBTN;
  395.       // Interrupt shenanigans
  396.       //EIMSK |= (1 << PCIE0);
  397.       PCMSK0 |= TRKMASK;
  398.       PCICR |= (1 << PCIE0);
  399.       sei();
  400.     #endif
  402.     return;
  403. }
  404. #ifdef BALLER
  405. ISR (PCINT0_vect) {
  406.   // Don't get fancy, we're in a interrupt here
  407.   // PCINT reports a interrupt for a change on the bus
  408.   // We hand the button at scantime for debounce
  409.   volatile uint8_t pState = PINB & TRKMASK;
  410.   if ((pState & TRKUP) != (trkState & TRKUP)) tbUpCnt++;
  411.   if ((pState & TRKDN) != (trkState & TRKDN)) tbDnCnt++;
  412.   if ((pState & TRKLT) != (trkState & TRKLT)) tbLtCnt++;
  413.   if ((pState & TRKRT) != (trkState & TRKRT)) tbRtCnt++;
  414.   trkState = pState;
  416. }
  417. #endif