logo

qmk_firmware

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

dev.md (5063B)

    

  1. # Southpaw Extended 65%
  3. Development docs covering the following:
  4. - Kimera core
  5. - RGB
  6. - Backlight
  8. ## Kimera core
  9. ![Kimera core](https://gd2.alicdn.com/imgextra/i4/159916802/TB2qsIgdrJkpuFjy1zcXXa5FFXa_!!159916802.jpg)
  11. What little available info that was available for the qmk port
  12. - atmega32u4 16Mhz
  13. - board seems to have a 6Mhz crystal 
  14. - 2x PCA9555 I2C IO expander
  16. Links:
  17. - [Schematic, BOM, Gerbers](/kairyu/kimera/blob/master/kimera_core)
  18. - [Original firmware](https://github.com/kairyu/tmk_keyboard_custom/tree/master/keyboard/kimera)
  20. ```c
  21. /*
  22. Kimera_core_v1.0 Components
  24.              U1 (atmega32u4)
  25.            ,----------------.
  26.       TX --| TX0(PD3)   RAW |--
  27.       RX --| RX1(PD2)   GND |--
  28.          --| GND      RESET |-- RST
  29.          --| GND        VCC |--
  30.      SDA --| 2(PD1) (PF4)A3 |--
  31.      SCL --| 3(PD0) (PF5)A2 |--
  32.    (INT) --| 4(PD4) (PF6)A1 |--
  33.          --| 5(PC6) (PF7)A0 |--
  34.          --| 6(PD7) (PB1)15 |-- SCK
  35.     LED2 --| 7(PE6) (PB3)14 |-- MISO
  36.     LED1 --| 8(PB4) (PB2)16 |-- MOSI
  37.     LED3 --| 9(PB5) (PB6)10 |-- LED4
  38.           `----------------'
  40.          IC1 (PCA9555)                  IC2 (PCA9555)
  41.          ,----------.                   ,----------.
  42.    SDA --| SDA  P00 |-- P1        SDA --| SDA  P00 |-- P17
  43.    SCL --| SCL  P01 |-- P2        SCL --| SCL  P01 |-- P18
  44.    INT --| INT  P02 |-- P3        INT --| INT  P02 |-- P19
  45.          |      P03 |-- P4              |      P03 |-- P20
  46.    GND --| A0   P04 |-- P5        VCC --| A0   P04 |-- P21
  47.    SJ1 --| A1   P05 |-- P6        SJ1 --| A1   P05 |-- P22
  48.    SJ2 --| A2   P06 |-- P7        SJ2 --| A2   P06 |-- P23
  49.          |      P07 |-- P8              |      P07 |-- P24
  50.          |          |                   |          |
  51.          |      P10 |-- P9              |      P10 |-- P25
  52.          |      P11 |-- P10             |      P11 |-- P26
  53.          |      P12 |-- P11             |      P12 |-- P27
  54.          |      P13 |-- P12             |      P13 |-- P28
  55.          |      P14 |-- P13             |      P14 |-- P29
  56.          |      P15 |-- P14             |      P15 |-- P30
  57.          |      P16 |-- P15             |      P16 |-- P31
  58.          |      P17 |-- P16             |      P17 |-- P32
  59.          `----------'                   `----------'
  60. */
  62. ```
  64. ### Bootloader
  65. Default bootloader is `atmel-dfu`.
  66. Reboot to bootloader via magnetic switch next to icsp header.
  67. Flash using regular dfu methods.
  69. ### Southpaw Extended 65 pin mappings
  70. Taken from [kimera-config.json](https://github.com/kairyu/tkg/blob/master/keyboard/config/kimera-config.json)
  72. 	"row_mapping": [ 2, 3, 4, 5, 6 ],
  73. 	"col_mapping": [ 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 ],
  75. # RGB
  76. - PIN C7
  77. - Number of RGB LED 7
  79. # Backlight
  80. - PIN B5
  82. # Capslock
  83. - PIN B6
  85. # Numlock
  86. - PIN C6
  88. ## Assumptions
  89. ### Pin/Port mappings
  90. - All cols are on the same IC
  91. - All rows are on the same IC and port
  92. - Pins mapped sequentially
  93. - Each port only does row or column not a mixture of both
  94.   - No need to have complex port config
  95.   - 
  97. | ROW index | Kimera Pin | PCA9555           |
  98. | ----------|------------|-------------------|
  99. | 0         | 2          | IC1 Port 0  pin 1 |
  100. | 1         | 3          | IC1 Port 0  pin 2 |
  101. | 2         | 4          | IC1 Port 0  pin 3 |
  102. | 3         | 5          | IC1 Port 0  pin 4 |
  103. | 4         | 6          | IC1 Port 0  pin 5 |
  105. - Safe enough to assume `row_index == pin`
  108. | COL index | Kimera Pin | PCA9555           |
  109. | ----------|------------|-------------------|
  110. | 0         | 13         | IC1 Port 1  pin 4 |
  111. | 1         | 14         | IC1 Port 1  pin 5 |
  112. | 2         | 15         | IC1 Port 1  pin 6 |
  113. | 3         | 16         | IC1 Port 1  pin 7 |
  114. | 4         | 17         | IC2 Port 0  pin 0 |
  115. | 5         | 18         | IC2 Port 0  pin 1 |
  116. | 6         | 19         | IC2 Port 0  pin 2 |
  117. | 7         | 20         | IC2 Port 0  pin 3 |
  118. | 8         | 21         | IC2 Port 0  pin 4 |
  119. | 9         | 22         | IC2 Port 0  pin 5 |
  120. | 10        | 23         | IC2 Port 0  pin 6 |
  121. | 11        | 24         | IC2 Port 0  pin 7 |
  122. | 12        | 25         | IC2 Port 1  pin 0 |
  123. | 13        | 26         | IC2 Port 1  pin 1 |
  124. | 14        | 27         | IC2 Port 1  pin 2 |
  125. | 15        | 28         | IC2 Port 1  pin 3 |
  126. | 16        | 29         | IC2 Port 1  pin 4 |
  127. | 17        | 30         | IC2 Port 1  pin 5 |
  128. | 18        | 31         | IC2 Port 1  pin 6 |
  130. - Need to read both ICs and corresponding port to compile the correct column data
  131. - All pins are mapped sequentially
  132. - maps to the usual practice of reading matrix columns
  133. - Needs uint32_t to read 19 columns of data
  135. ## Notes
  136. [pca9555 datasheet](https://www.ti.com/lit/ds/symlink/pca9555.pdf)
  138. - Other Kimera based boards with non sequential pin mappings, pins mapped across ICs, or mixed row/col configs will need more complicated `pin -> i2c_addr,port,pin` logic as well as rather more complex pin functions.
  140. ## Return to stock firmware
  141. To return back to stock TMK firmware, use [programming guide provided by Reconsiderit](https://geekhack.org/index.php?topic=92344.msg2625784#msg2625784)