Merge branch 'user_led_configuration' into infinity60
Conflicts: keyboards/infinity60/keymaps/jpetermans/keymap.cexample_keyboards
jpetermans
8 years ago
commit
e6c9b07e1c
@ -1,385 +0,0 @@
|
||||
flabbergast's TMK/ChibiOS port
|
||||
==============================
|
||||
2015/10/16
|
||||
|
||||
|
||||
Build
|
||||
-----
|
||||
$ git clone -b chibios https://github.com/flabbergast/tmk_keyboard.git
|
||||
|
||||
$ cd tmk_keyboard
|
||||
$ git submodule add -f -b kinetis https://github.com/flabbergast/ChibiOS.git tmk_core/tool/chibios/chibios
|
||||
or
|
||||
$ cd tmk_keyboard/tmk_core/tool/chibios
|
||||
$ git clone -b kinetis https://github.com/flabbergast/ChibiOS.git tmk_core/tool/chibios/chibios
|
||||
|
||||
$ cd tmk_keyboard/keyboard/infinity_chibios
|
||||
$ make
|
||||
|
||||
|
||||
|
||||
|
||||
Chibios Configuration
|
||||
---------------------
|
||||
halconf.h: for HAL configuration
|
||||
placed in project directory
|
||||
read in chibios/os/hal/hal.mk
|
||||
included in chibios/os/hal/include/hal.h
|
||||
mcuconf.h: for MCU configuration
|
||||
placed in project directory
|
||||
included in halconf.h
|
||||
|
||||
|
||||
Chibios Term
|
||||
------------
|
||||
PAL = Port Abstraction Layer
|
||||
palWritePad
|
||||
palReadPad
|
||||
palSetPad
|
||||
chibios/os/hal/include/pal.h
|
||||
|
||||
LLD = Low Level Driver
|
||||
|
||||
|
||||
Makefile
|
||||
--------
|
||||
# <chibios>/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)
|
||||
MCU_FAMILY = KINETIS
|
||||
MCU_SERIES = KL2x
|
||||
|
||||
# - it should exist either in <chibios>/os/common/ports/ARMCMx/compilers/GCC/ld/
|
||||
# or <this_dir>/ld/
|
||||
MCU_LDSCRIPT = MKL26Z64
|
||||
|
||||
# - it should exist in <chibios>/os/common/ports/ARMCMx/compilers/GCC/mk/
|
||||
MCU_STARTUP = kl2x
|
||||
|
||||
# Board: it should exist either in <chibios>/os/hal/boards/
|
||||
# or <this_dir>/boards
|
||||
BOARD = PJRC_TEENSY_LC
|
||||
|
||||
MCU = cortex-m0
|
||||
|
||||
# ARM version, CORTEX-M0/M1 are 6, CORTEX-M3/M4/M7 are 7
|
||||
ARMV = 6
|
||||
|
||||
|
||||
halconf.h
|
||||
---------
|
||||
|
||||
|
||||
mcuconf.h
|
||||
---------
|
||||
|
||||
|
||||
chconf.h
|
||||
--------
|
||||
|
||||
|
||||
ld script
|
||||
---------
|
||||
--- ../../tmk_core/tool/chibios/chibios/os/common/ports/ARMCMx/compilers/GCC/ld/MKL26Z64.ld 2015-10-15 09:08:58.732904304 +0900
|
||||
+++ ld/MKL26Z64.ld 2015-10-15 08:48:06.430215496 +0900
|
||||
@@ -27,7 +27,8 @@
|
||||
{
|
||||
flash0 : org = 0x00000000, len = 0xc0
|
||||
flashcfg : org = 0x00000400, len = 0x10
|
||||
- flash : org = 0x00000410, len = 64k - 0x410
|
||||
+ flash : org = 0x00000410, len = 62k - 0x410
|
||||
+ eeprom_emu : org = 0x0000F800, len = 2k
|
||||
ram : org = 0x1FFFF800, len = 8k
|
||||
}
|
||||
|
||||
@@ -35,6 +36,10 @@
|
||||
__ram_size__ = LENGTH(ram);
|
||||
__ram_end__ = __ram_start__ + __ram_size__;
|
||||
|
||||
+__eeprom_workarea_start__ = ORIGIN(eeprom_emu);
|
||||
+__eeprom_workarea_size__ = LENGTH(eeprom_emu);
|
||||
+__eeprom_workarea_end__ = __eeprom_workarea_start__ + __eeprom_workarea_size__;
|
||||
+
|
||||
SECTIONS
|
||||
{
|
||||
. = 0;
|
||||
|
||||
|
||||
|
||||
Configuration/Startup for Infinity 60%
|
||||
--------------------------------------
|
||||
Configuration:
|
||||
|
||||
|
||||
Clock:
|
||||
Inifinity
|
||||
FEI(FLL Engaged Internal) mode with core clock:48MHz, bus clock:48MHz, flash clock:24MHz
|
||||
Clock dividor:
|
||||
SIM_CLKDIV1[OUTDIV1] = 0 divide-by-1 for core clock
|
||||
SIM_CLKDIV1[OUTDIV2] = 0 divide-by-1 for bus clock
|
||||
SIM_CLKDIV1[OUTDIV4] = 1 divide-by-2 for flash clock
|
||||
Internal reference clock:
|
||||
MCG_C1[IREFS] = 1 Internal Reference Select for clock source for FLL
|
||||
MCG_C1[IRCLKEN] = 1 Internal Reference Clock Enable
|
||||
FLL multipilication:
|
||||
MCG_C4[DMX32] = 1
|
||||
MCG_C4[DRST_DRS] = 01 FLL factor 1464 * 32.768kHz = 48MHz
|
||||
|
||||
chibios/os/hal/ports/KINETIS/K20x/hal_lld.c
|
||||
k20x_clock_init(): called in __early_init() defined in board.c
|
||||
disable watchdog and configure clock
|
||||
|
||||
configurable macros:
|
||||
KINETIS_NO_INIT: whether init or not
|
||||
KINETIS_MCG_MODE: clock mode
|
||||
KINETIS_MCG_MODE_FEI
|
||||
KINETIS_MCG_MODE_PEE
|
||||
hal/ports/KINETIS/K20x/hal_lld.h
|
||||
|
||||
|
||||
chibios/os/hal/boards/FREESCALE_FREEDOM_K20D50M/board.h
|
||||
PALConfig pal_default_config
|
||||
boardInit()
|
||||
__early_init()
|
||||
macro definitions for board infos, freq and mcu type
|
||||
|
||||
chibios/os/hal/boards/FREESCALE_FREEDOM_K20D50M/board.c
|
||||
|
||||
USB
|
||||
|
||||
|
||||
Startup
|
||||
-------
|
||||
common/ports/ARMCMx/GCC/crt0_v[67]m.s
|
||||
Reset_Handler: startup code
|
||||
common/ports/ARMCMx/GCC/crt1.c
|
||||
__core_init(): weak
|
||||
__early_init(): weak
|
||||
__late_init(): weak
|
||||
__default_exit(): weak
|
||||
called from Reset_Handler of crt0
|
||||
common/ports/ARMCMx/GCC/vector.c
|
||||
common/ports/ARMCMx/GCC/ld/*.ld
|
||||
|
||||
chibios/os/common/ports/ARMCMx/compilers/GCC/
|
||||
├── crt0_v6m.s
|
||||
├── crt0_v7m.s
|
||||
├── crt1.c
|
||||
├── ld
|
||||
│ ├── MK20DX128BLDR3.ld
|
||||
│ ├── MK20DX128BLDR4.ld
|
||||
│ ├── MK20DX128.ld
|
||||
│ ├── MK20DX256.ld
|
||||
│ ├── MKL25Z128.ld
|
||||
│ ├── MKL26Z128.ld
|
||||
│ ├── MKL26Z64.ld
|
||||
│ └── STM32L476xG.ld
|
||||
├── mk
|
||||
│ ├── startup_k20x5.mk
|
||||
│ ├── startup_k20x7.mk
|
||||
│ ├── startup_k20x.mk
|
||||
│ ├── startup_kl2x.mk
|
||||
│ └── startup_stm32l4xx.mk
|
||||
├── rules.ld
|
||||
├── rules.mk
|
||||
└── vectors.c
|
||||
|
||||
chibios/os/hal/
|
||||
├── boards
|
||||
│ ├── FREESCALE_FREEDOM_K20D50M
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ └── board.mk
|
||||
│ ├── MCHCK_K20
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ └── board.mk
|
||||
│ ├── PJRC_TEENSY_3
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ └── board.mk
|
||||
│ ├── PJRC_TEENSY_3_1
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ └── board.mk
|
||||
│ ├── PJRC_TEENSY_LC
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ └── board.mk
|
||||
│ ├── readme.txt
|
||||
│ ├── simulator
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ └── board.mk
|
||||
│ ├── ST_NUCLEO_F030R8
|
||||
│ │ ├── board.c
|
||||
│ │ ├── board.h
|
||||
│ │ ├── board.mk
|
||||
│ │ └── cfg
|
||||
│ │ └── board.chcfg
|
||||
├── hal.mk
|
||||
├── include
|
||||
│ ├── adc.h
|
||||
│ ├── can.h
|
||||
│ ├── dac.h
|
||||
│ ├── ext.h
|
||||
│ ├── gpt.h
|
||||
│ ├── hal_channels.h
|
||||
│ ├── hal_files.h
|
||||
│ ├── hal.h
|
||||
│ ├── hal_ioblock.h
|
||||
│ ├── hal_mmcsd.h
|
||||
│ ├── hal_queues.h
|
||||
│ ├── hal_streams.h
|
||||
│ ├── i2c.h
|
||||
│ ├── i2s.h
|
||||
│ ├── icu.h
|
||||
│ ├── mac.h
|
||||
│ ├── mii.h
|
||||
│ ├── mmc_spi.h
|
||||
│ ├── pal.h
|
||||
│ ├── pwm.h
|
||||
│ ├── rtc.h
|
||||
│ ├── sdc.h
|
||||
│ ├── serial.h
|
||||
│ ├── serial_usb.h
|
||||
│ ├── spi.h
|
||||
│ ├── st.h
|
||||
│ ├── uart.h
|
||||
│ └── usb.h
|
||||
├── lib
|
||||
│ └── streams
|
||||
│ ├── chprintf.c
|
||||
│ ├── chprintf.h
|
||||
│ ├── memstreams.c
|
||||
│ ├── memstreams.h
|
||||
│ ├── nullstreams.c
|
||||
│ └── nullstreams.h
|
||||
├── osal
|
||||
│ ├── nil
|
||||
│ │ ├── osal.c
|
||||
│ │ ├── osal.h
|
||||
│ │ └── osal.mk
|
||||
│ ├── os-less
|
||||
│ │ └── ARMCMx
|
||||
│ │ ├── osal.c
|
||||
│ │ ├── osal.h
|
||||
│ │ └── osal.mk
|
||||
│ └── rt
|
||||
│ ├── osal.c
|
||||
│ ├── osal.h
|
||||
│ └── osal.mk
|
||||
├── ports
|
||||
│ ├── AVR
|
||||
│ ├── common
|
||||
│ │ └── ARMCMx
|
||||
│ │ ├── mpu.h
|
||||
│ │ ├── nvic.c
|
||||
│ │ └── nvic.h
|
||||
│ ├── KINETIS
|
||||
│ │ ├── K20x
|
||||
│ │ │ ├── hal_lld.c
|
||||
│ │ │ ├── hal_lld.h
|
||||
│ │ │ ├── kinetis_registry.h
|
||||
│ │ │ ├── platform.dox
|
||||
│ │ │ ├── platform.mk
|
||||
│ │ │ ├── pwm_lld.c
|
||||
│ │ │ ├── pwm_lld.h
|
||||
│ │ │ ├── spi_lld.c
|
||||
│ │ │ └── spi_lld.h
|
||||
│ │ ├── KL2x
|
||||
│ │ │ ├── hal_lld.c
|
||||
│ │ │ ├── hal_lld.h
|
||||
│ │ │ ├── kinetis_registry.h
|
||||
│ │ │ ├── platform.mk
|
||||
│ │ │ ├── pwm_lld.c
|
||||
│ │ │ └── pwm_lld.h
|
||||
│ │ ├── LLD
|
||||
│ │ │ ├── adc_lld.c
|
||||
│ │ │ ├── adc_lld.h
|
||||
│ │ │ ├── ext_lld.c
|
||||
│ │ │ ├── ext_lld.h
|
||||
│ │ │ ├── gpt_lld.c
|
||||
│ │ │ ├── gpt_lld.h
|
||||
│ │ │ ├── i2c_lld.c
|
||||
│ │ │ ├── i2c_lld.h
|
||||
│ │ │ ├── pal_lld.c
|
||||
│ │ │ ├── pal_lld.h
|
||||
│ │ │ ├── serial_lld.c
|
||||
│ │ │ ├── serial_lld.h
|
||||
│ │ │ ├── st_lld.c
|
||||
│ │ │ ├── st_lld.h
|
||||
│ │ │ ├── usb_lld.c
|
||||
│ │ │ └── usb_lld.h
|
||||
│ │ └── README.md
|
||||
│ ├── LPC
|
||||
│ ├── simulator
|
||||
│ └── STM32
|
||||
├── src
|
||||
│ ├── adc.c
|
||||
│ ├── can.c
|
||||
│ ├── dac.c
|
||||
│ ├── ext.c
|
||||
│ ├── gpt.c
|
||||
│ ├── hal.c
|
||||
│ ├── hal_mmcsd.c
|
||||
│ ├── hal_queues.c
|
||||
│ ├── i2c.c
|
||||
│ ├── i2s.c
|
||||
│ ├── icu.c
|
||||
│ ├── mac.c
|
||||
│ ├── mmc_spi.c
|
||||
│ ├── pal.c
|
||||
│ ├── pwm.c
|
||||
│ ├── rtc.c
|
||||
│ ├── sdc.c
|
||||
│ ├── serial.c
|
||||
│ ├── serial_usb.c
|
||||
│ ├── spi.c
|
||||
│ ├── st.c
|
||||
│ ├── uart.c
|
||||
│ └── usb.c
|
||||
└── templates
|
||||
├── adc_lld.c
|
||||
├── adc_lld.h
|
||||
├── can_lld.c
|
||||
├── can_lld.h
|
||||
├── dac_lld.c
|
||||
├── dac_lld.h
|
||||
├── ext_lld.c
|
||||
├── ext_lld.h
|
||||
├── gpt_lld.c
|
||||
├── gpt_lld.h
|
||||
├── halconf.h
|
||||
├── hal_lld.c
|
||||
├── hal_lld.h
|
||||
├── i2c_lld.c
|
||||
├── i2c_lld.h
|
||||
├── i2s_lld.c
|
||||
├── i2s_lld.h
|
||||
├── icu_lld.c
|
||||
├── icu_lld.h
|
||||
├── mac_lld.c
|
||||
├── mac_lld.h
|
||||
├── mcuconf.h
|
||||
├── osal
|
||||
│ ├── osal.c
|
||||
│ ├── osal.h
|
||||
│ └── osal.mk
|
||||
├── pal_lld.c
|
||||
├── pal_lld.h
|
||||
├── platform.mk
|
||||
├── pwm_lld.c
|
||||
├── pwm_lld.h
|
||||
├── rtc_lld.c
|
||||
├── rtc_lld.h
|
||||
├── sdc_lld.c
|
||||
├── sdc_lld.h
|
||||
├── serial_lld.c
|
||||
├── serial_lld.h
|
||||
├── spi_lld.c
|
||||
├── spi_lld.h
|
||||
├── st_lld.c
|
||||
├── st_lld.h
|
||||
├── uart_lld.c
|
||||
├── uart_lld.h
|
||||
├── usb_lld.c
|
||||
└── usb_lld.h
|
||||
@ -0,0 +1,87 @@
|
||||
Backlight for Infinity60
|
||||
========================
|
||||
|
||||
## Led Controller Specs
|
||||
|
||||
The Infinity60 (revision 1.1a) pcb uses the IS31FL3731C matrix LED driver from ISSI [(datasheet)](http://www.issi.com/WW/pdf/31FL3731C.pdf). The IS31 has the ability to control two led matrices (A & B), each matrix controlling 9 pins, each pin controlling 8 leds. The Infinity only utilizes matrix A.
|
||||
|
||||
Infinity60 LED Map:
|
||||
digits mean "row" and "col", i.e. 45 means pin 4, column 5 in the IS31 datasheet
|
||||
```c
|
||||
11 12 13 14 15 16 17 18 21 22 23 24 25 26 27*
|
||||
28 31 32 33 34 35 36 37 38 41 42 43 44 45
|
||||
46 47 48 51 52 53 54 55 56 57 58 61 62
|
||||
63 64 65 66 67 68 71 72 73 74 75 76 77*
|
||||
78 81 82 83 84 85 86 87
|
||||
```
|
||||
*Unused in Alphabet Layout
|
||||
|
||||
The IS31 includes 8 led pages (or frames) 0-7 than can be displayed, and each page consists of 144 bytes.
|
||||
- **bytes 0 - 17** - LED control (on/off).
|
||||
* 18 pins which alternate between A and B matrices (A1, B1, A2, B2, ..).
|
||||
* Each byte controls the 8 leds on that pin with bits (8 to 1).
|
||||
- **bytes 8 - 35** - Blink control.
|
||||
* Same as LED control above, but sets blink on/off.
|
||||
- **bytes 36 - 143** - PWM control.
|
||||
* One byte per LED, sets PWM from 0 to 255.
|
||||
* Same as above, the register alternates, every 8 *bytes* (not bits) between the A & B matrices.
|
||||
|
||||
## Led Controller Code
|
||||
In the Infinity60 project folder, led_controller.c sets up ability to write led layers at startup or control leds on demand as part of fn_actions. By default led_controller.c assumes page 0 will be used for full on/off. The remaining 7 pages (1-7) are free for preset led maps or single led actions at init or on demand. Communication with the IS31 is primarily done through the led_mailbox using chMBPost described further below under "Sending messages in Keymap.c". This code is based on work matt3o and flabbergast did for tmk firmware on the [whitefox](https://github.com/tmk/whitefox).
|
||||
|
||||
One function is available to directly set leds without the mailbox:
|
||||
```
|
||||
write_led_page(page#, array of leds by address, # of addresses in array)
|
||||
```
|
||||
This function saves a full page to the controller using a supplied array of led locations such as:
|
||||
```c
|
||||
uint8_t led_numpad[16] = {
|
||||
18,21,22,23,
|
||||
37,38,41,42,
|
||||
55,56,57,58,
|
||||
72,73,74,75
|
||||
}
|
||||
write_led_page(5, led_numpad, 16);
|
||||
```
|
||||
|
||||
Remaining led control is done through the led mailbox using these message types:
|
||||
- **SET_FULL_ROW** (3 bytes) - message type, 8-bit mask, and row#. Sets all leds on one pin per the bit mask.
|
||||
- **OFF_LED, ON_LED, TOGGLE_LED** (3 bytes) - message type, led address, and page#. Off/on/toggle specific led.
|
||||
- **BLINK_OFF_LED, BLINK_ON_LED, BLINK_OFF_LED** (3 bytes) - message type, led address, and page#. Set blink Off/on/toggle for specific led.
|
||||
- **TOGGLE_ALL** (1 byte) - Turn on/off full backlight.
|
||||
- **TOGGLE_BACKLIGHT** (2 bytes) - message type, on/off. Sets backlight completely off, no leds will display.
|
||||
- **DISPLAY_PAGE** (2 bytes) - message type, page to display. Switch to specific pre-set page.
|
||||
- **RESET_PAGE** (2 bytes) - message type, page to reset. Reset/erase specific page.
|
||||
- **TOGGLE_NUM_LOCK** (2 bytes) - message type, on/off (NUM_LOCK_LED_ADDRESS). Toggle numlock on/off. Usually run with the `set_leds` function to check state of numlock or capslock. If all leds are on (e.i. TOGGLE_ALL) then this sets numlock to blink instead (this is still a little buggy if toggling on/off quickly).
|
||||
- **TOGGLE_CAPS_LOCK** (2 bytes) - message type, on/off (CAPS_LOCK_LED_ADDRESS). Same as numlock.
|
||||
- **STEP_BRIGHTNESS** (2 bytes) - message type, and step up (1) or step down (0). Increase or decrease led brightness.
|
||||
|
||||
## Sending messages in Keymap.c
|
||||
Sending an action to the led mailbox is done using chMBPost:
|
||||
```
|
||||
chMBPost(&led_mailbox, message, timeout);
|
||||
```
|
||||
- &led_mailbox - pointer to led mailbox
|
||||
- message - up to 4 bytes but most messages use only 2. First byte (LSB) is the message type, the remaining three bytes are the message to process.
|
||||
- timeout is TIME_IMMEDIATE
|
||||
|
||||
An example:
|
||||
```c
|
||||
//set the message to be sent. First byte (LSB) is the led address, and second is the message type
|
||||
msg=(42 << 8) | ON_LED;
|
||||
|
||||
//send msg to the led mailbox
|
||||
chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
|
||||
```
|
||||
|
||||
Another:
|
||||
```c
|
||||
msg=(46 << 8) | BLINK_TOGGLE_LED;
|
||||
chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
|
||||
```
|
||||
|
||||
Finally, SET_FULL_ROW requires an extra byte with row information in the message so sending this message looks like:
|
||||
```c
|
||||
msg=(row<<16) | (led_pin_byte << 8) | SET_FULL_ROW;
|
||||
chMBPost(&led_mailbox, msg, TIME_IMMEDIATE);
|
||||
```
|
||||
Loading…
Reference in New Issue