From b65282f69f8a46c3543b3e83b0f275534501d8f8 Mon Sep 17 00:00:00 2001 From: skullydazed Date: Tue, 4 Apr 2017 22:23:01 -0700 Subject: [PATCH] Updated Custom Quantum Functions (markdown) --- Custom-Quantum-Functions.md | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/Custom-Quantum-Functions.md b/Custom-Quantum-Functions.md index f3a3183efc..bdacd31d3c 100644 --- a/Custom-Quantum-Functions.md +++ b/Custom-Quantum-Functions.md @@ -12,13 +12,38 @@ Each of the functions described below can be defined with a `_kb()` suffix or an When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `*_user()` before executing anything else- otherwise the keymap level function will never be called. -## `void matrix_init_kb(void)` and `void matrix_init_user(void)` +## Matrix Initialization Code -This function gets called when the matrix is initiated, and can contain start-up code for your keyboard/keymap. +* Keyboard/Revision: `void matrix_init_kb(void)` +* Keymap: `void matrix_init_user(void)` -You should use this function to initialize any custom hardware you may have, such as speakers, LED drivers, or other features which need to be setup after the keyboard powers on. +This function gets called when the matrix is initiated. You should use this function to initialize any custom hardware you may have, such as speakers, LED drivers, or other features which need to be setup after the keyboard powers on. -## `void matrix_scan_kb(void)` and `void matrix_scan_user(void)` +#### Example + +``` +void matrix_init_kb(void) { + // put your keyboard start-up code here + // runs once when the firmware starts up + matrix_init_user(); + + // JTAG disable for PORT F. write JTD bit twice within four cycles. + MCUCR |= (1<