@@ -0,0 +1,73 @@ | |||
#!/usr/bin/env bash | |||
# This is a build script template | |||
# These build scripts are just a convenience for configuring your keyboard (less daunting than CMake) | |||
# Jacob Alexander 2015-2016 | |||
################# | |||
# Configuration # | |||
################# | |||
# Feel free to change the variables in this section to configure your keyboard | |||
BuildPath="i75" | |||
## KLL Configuration ## | |||
# Generally shouldn't be changed, this will affect every layer | |||
BaseMap="scancode_map" | |||
# This is the default layer of the keyboard | |||
# NOTE: To combine kll files into a single layout, separate them by spaces | |||
# e.g. DefaultMap="mylayout mylayoutmod" | |||
DefaultMap="md1Overlay stdFuncMap" | |||
# This is where you set the additional layers | |||
# NOTE: Indexing starts at 1 | |||
# NOTE: Each new layer is another array entry | |||
# e.g. PartialMaps[1]="layer1 layer1mod" | |||
# PartialMaps[2]="layer2" | |||
# PartialMaps[3]="layer3" | |||
PartialMaps[1]="hhkbpro2" | |||
PartialMaps[2]="colemak" | |||
########################## | |||
# Advanced Configuration # | |||
########################## | |||
# Don't change the variables in this section unless you know what you're doing | |||
# These are useful for completely custom keyboards | |||
# NOTE: Changing any of these variables will require a force build to compile correctly | |||
# Keyboard Module Configuration | |||
ScanModule="i75" | |||
MacroModule="PartialMap" | |||
OutputModule="pjrcUSB" | |||
DebugModule="full" | |||
# Microcontroller | |||
Chip="mk20dx256" | |||
# Compiler Selection | |||
Compiler="gcc" | |||
######################## | |||
# Bash Library Include # | |||
######################## | |||
# Shouldn't need to touch this section | |||
# Check if the library can be found | |||
if [ ! -f cmake.bash ]; then | |||
echo "ERROR: Cannot find 'cmake.bash'" | |||
exit 1 | |||
fi | |||
# Load the library | |||
source cmake.bash | |||
@@ -0,0 +1,55 @@ | |||
/* Copyright (C) 2014-2015 by Jacob Alexander | |||
* | |||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||
* of this software and associated documentation files (the "Software"), to deal | |||
* in the Software without restriction, including without limitation the rights | |||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
* copies of the Software, and to permit persons to whom the Software is | |||
* furnished to do so, subject to the following conditions: | |||
* | |||
* The above copyright notice and this permission notice shall be included in | |||
* all copies or substantial portions of the Software. | |||
* | |||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |||
* THE SOFTWARE. | |||
*/ | |||
#pragma once | |||
// ----- Includes ----- | |||
// Project Includes | |||
#include <matrix_setup.h> | |||
// ----- Matrix Definition ----- | |||
// Freescale ARM MK20's support GPIO PTA, PTB, PTC, PTD and PTE 0..31 | |||
// Not all chips have access to all of these pins (most don't have 160 pins :P) | |||
// | |||
// NOTE: | |||
// Before using a pin, make sure it supports being a GPIO *and* doesn't have a default pull-up/pull-down | |||
// Checking this is completely on the ownness of the user | |||
// MD1 | |||
// | |||
// Columns (Strobe) | |||
// PTB0..3,16,17 | |||
// PTC4,5 | |||
// PTD0 | |||
// | |||
// Rows (Sense) | |||
// PTD1..7 | |||
// Define Rows (Sense) and Columns (Strobes) | |||
GPIO_Pin Matrix_cols[] = { gpio(C,3), gpio(C,4), gpio(C,0), gpio(B,0), gpio(B,3), gpio(B,2), gpio(D,5), gpio(D,6), gpio(C,1) }; | |||
GPIO_Pin Matrix_rows[] = { gpio(D,3), gpio(D,2), gpio(D,4), gpio(D,7), gpio(A,13), gpio(A,12), gpio(D,0), gpio(B,17), gpio(B,16) }; | |||
// Define type of scan matrix | |||
Config Matrix_type = Config_Pulldown; | |||
@@ -0,0 +1,88 @@ | |||
Pin Usage | |||
========= | |||
mk20dx128vlf5 | |||
---- | |||
|Keys| | |||
---- | |||
* Strobe (Columns) | |||
PTB0 | |||
PTB1 | |||
PTB2 | |||
PTB3 | |||
PTB16 | |||
PTB17 | |||
PTC4 | |||
PTC5 | |||
PTD0 | |||
* Sense (Rows) | |||
PTD1 | |||
PTD2 | |||
PTD3 | |||
PTD4 | |||
PTD5 | |||
PTD6 | |||
PTD7 | |||
----- | |||
|Debug| | |||
----- | |||
* SWD | |||
PTA0 (Pull-down) | |||
PTA3 (Pull-up) | |||
* LEDs | |||
PTA19 (LED only for PCB, not McHCK) (XTAL) | |||
* UARTs | |||
PTA1 - RX0 | |||
PTA2 - TX0 | |||
* Tag Connect | |||
1 - Vdd +5 | |||
2 - PTA3 / SWD_IO | |||
3 - Vss / Gnd | |||
4 - PTA0 / SWD_CLK | |||
5 - +5V | |||
6 - PTA2 / TRACE_SWO | |||
7 - N/C | |||
8 - PTA1 / JTAG_TDI | |||
9 - N/C | |||
10 - Reset_b | |||
------ | |||
|Unused| | |||
------ | |||
* GPIO | |||
PTA1 (Not broken out on PCB, available on McHCK) (Pull-up) | |||
PTA2 (") | |||
PTA4 (Pull-up) | |||
PTA18 (EXTAL) | |||
PTC0 | |||
PTC1 | |||
PTC2 | |||
PTC3 | |||
PTC6 | |||
PTC7 | |||
* Analog | |||
ADC0_DP0 | |||
ADC0_DM0 | |||
@@ -0,0 +1,73 @@ | |||
Name = MD1; | |||
Version = 0.2; | |||
Author = "HaaTa (Jacob Alexander) 2014"; | |||
KLL = 0.3; | |||
# Modified Date | |||
Date = 2014-09-14; | |||
S0x00 : U"Esc"; | |||
S0x01 : U"1"; | |||
S0x02 : U"2"; | |||
S0x03 : U"3"; | |||
S0x04 : U"4"; | |||
S0x05 : U"5"; | |||
S0x06 : U"6"; | |||
S0x07 : U"7"; | |||
S0x08 : U"8"; | |||
S0x09 : U"9"; | |||
S0x0A : U"0"; | |||
S0x0B : U"Minus"; | |||
S0x0C : U"Equal"; | |||
S0x0D : U"Backslash"; | |||
S0x0E : U"Tab"; | |||
S0x0F : U"Q"; | |||
S0x10 : U"W"; | |||
S0x11 : U"E"; | |||
S0x12 : U"R"; | |||
S0x13 : U"T"; | |||
S0x14 : U"Y"; | |||
S0x15 : U"U"; | |||
S0x16 : U"I"; | |||
S0x17 : U"O"; | |||
S0x18 : U"P"; | |||
S0x19 : U"LBrace"; | |||
S0x1A : U"RBrace"; | |||
S0x1B : U"Backspace"; | |||
S0x1C : U"Ctrl"; | |||
S0x1D : U"A"; | |||
S0x1E : U"S"; | |||
S0x1F : U"D"; | |||
S0x20 : U"F"; | |||
S0x21 : U"G"; | |||
S0x22 : U"H"; | |||
S0x23 : U"J"; | |||
S0x24 : U"K"; | |||
S0x25 : U"L"; | |||
S0x26 : U"Semicolon"; | |||
S0x27 : U"Quote"; | |||
S0x28 : U"Enter"; | |||
S0x29 : U"LShift"; | |||
S0x2A : U"Z"; | |||
S0x2B : U"X"; | |||
S0x2C : U"C"; | |||
S0x2D : U"V"; | |||
S0x2E : U"B"; | |||
S0x2F : U"N"; | |||
S0x30 : U"M"; | |||
S0x31 : U"Comma"; | |||
S0x32 : U"Period"; | |||
S0x33 : U"Slash"; | |||
S0x34 : U"RShift"; | |||
S0x35 : U"Function1"; # Fun key | |||
S0x36 : U"Function2"; # Left Blank Key | |||
S0x37 : U"LAlt"; | |||
S0x38 : U"LGui"; | |||
S0x39 : U"Space"; | |||
S0x3A : U"RGui"; | |||
S0x3B : U"RAlt"; | |||
S0x3C : U"Function3"; # Right Blank Key 1 | |||
S0x3D : U"Function4"; # Right Blank Key 2 | |||
S0x3E : U"BackTick"; | |||
@@ -0,0 +1,213 @@ | |||
/* Copyright (C) 2014-2016 by Jacob Alexander | |||
* | |||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||
* of this software and associated documentation files (the "Software"), to deal | |||
* in the Software without restriction, including without limitation the rights | |||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
* copies of the Software, and to permit persons to whom the Software is | |||
* furnished to do so, subject to the following conditions: | |||
* | |||
* The above copyright notice and this permission notice shall be included in | |||
* all copies or substantial portions of the Software. | |||
* | |||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |||
* THE SOFTWARE. | |||
*/ | |||
// ----- Includes ----- | |||
// Compiler Includes | |||
#include <Lib/ScanLib.h> | |||
// Project Includes | |||
#include <cli.h> | |||
#include <led.h> | |||
#include <print.h> | |||
#include <matrix_scan.h> | |||
#include <macro.h> | |||
// Local Includes | |||
#include "scan_loop.h" | |||
// ----- Function Declarations ----- | |||
// CLI Functions | |||
void cliFunc_echo( char* args ); | |||
// ----- Variables ----- | |||
// Scan Module command dictionary | |||
CLIDict_Entry( echo, "Example command, echos the arguments." ); | |||
CLIDict_Def( scanCLIDict, "Scan Module Commands" ) = { | |||
CLIDict_Item( echo ), | |||
{ 0, 0, 0 } // Null entry for dictionary end | |||
}; | |||
// Number of scans since the last USB send | |||
uint16_t Scan_scanCount = 0; | |||
// ----- Functions ----- | |||
// Setup | |||
inline void Scan_setup() | |||
{ | |||
// Register Scan CLI dictionary | |||
CLI_registerDictionary( scanCLIDict, scanCLIDictName ); | |||
// Setup GPIO pins for matrix scanning | |||
Matrix_setup(); | |||
// Reset scan count | |||
Scan_scanCount = 0; | |||
} | |||
// Main Detection Loop | |||
inline uint8_t Scan_loop() | |||
{ | |||
Matrix_scan( Scan_scanCount++ ); | |||
return 0; | |||
} | |||
// Signal from Macro Module that all keys have been processed (that it knows about) | |||
inline void Scan_finishedWithMacro( uint8_t sentKeys ) | |||
{ | |||
} | |||
// Signal from Output Module that all keys have been processed (that it knows about) | |||
inline void Scan_finishedWithOutput( uint8_t sentKeys ) | |||
{ | |||
// Reset scan loop indicator (resets each key debounce state) | |||
// TODO should this occur after USB send or Macro processing? | |||
Scan_scanCount = 0; | |||
} | |||
// ----- Capabilities ----- | |||
// Custom capability examples | |||
// Refer to kll.h in Macros/PartialMap for state and stateType information | |||
void CustomAction_action1_capability( uint8_t state, uint8_t stateType, uint8_t *args ) | |||
{ | |||
// Display capability name | |||
// XXX This is required for debug cli to give you a list of capabilities | |||
if ( stateType == 0xFF && state == 0xFF ) | |||
{ | |||
print("CustomAction_action1_capability()"); | |||
return; | |||
} | |||
// Prints Action1 info message to the debug cli | |||
info_print("Action1"); | |||
} | |||
uint8_t CustomAction_blockHold_storage = 0; | |||
void CustomAction_blockHold_capability( uint8_t state, uint8_t stateType, uint8_t *args ) | |||
{ | |||
// Display capability name | |||
if ( stateType == 0xFF && state == 0xFF ) | |||
{ | |||
print("CustomAction_blockHold_capability(usbCode)"); | |||
return; | |||
} | |||
// Retrieve 8-bit argument | |||
uint8_t key = args[0]; | |||
// We only care about normal keys | |||
if ( stateType == 0x00 ) | |||
{ | |||
// Block given key if we're in the "Press" or "Hold" state | |||
if ( ( state == 0x01 || state == 0x02 ) | |||
&& CustomAction_blockHold_storage == 0 ) | |||
{ | |||
CustomAction_blockHold_storage = key; | |||
info_msg("Blocking Key: "); | |||
printHex( key ); | |||
print( NL ); | |||
} | |||
// Release if in the "Off" or "Release" state and we're blocking | |||
else if ( ( state == 0x00 || state == 0x03 ) | |||
&& key == CustomAction_blockHold_storage ) | |||
{ | |||
info_msg("Unblocking Key: "); | |||
printHex( CustomAction_blockHold_storage ); | |||
print( NL ); | |||
CustomAction_blockHold_storage = 0; | |||
} | |||
} | |||
} | |||
void CustomAction_blockKey_capability( uint8_t state, uint8_t stateType, uint8_t *args ) | |||
{ | |||
// Display capability name | |||
if ( stateType == 0xFF && state == 0xFF ) | |||
{ | |||
print("CustomAction_blockKey_capability(usbCode)"); | |||
return; | |||
} | |||
// Retrieve 8-bit argument | |||
uint8_t key = args[0]; | |||
// If key is not blocked, process | |||
if ( key != CustomAction_blockHold_storage ) | |||
{ | |||
extern void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args ); | |||
Output_usbCodeSend_capability( state, stateType, &key ); | |||
} | |||
} | |||
// Signal from the Output Module that the available current has changed | |||
// current - mA | |||
void Scan_currentChange( unsigned int current ) | |||
{ | |||
// Indicate to all submodules current change | |||
Matrix_currentChange( current ); | |||
} | |||
// ----- CLI Command Functions ----- | |||
// XXX Just an example command showing how to parse arguments (more complex than generally needed) | |||
void cliFunc_echo( char* args ) | |||
{ | |||
char* curArgs; | |||
char* arg1Ptr; | |||
char* arg2Ptr = args; | |||
// Parse args until a \0 is found | |||
while ( 1 ) | |||
{ | |||
print( NL ); // No \r\n by default after the command is entered | |||
curArgs = arg2Ptr; // Use the previous 2nd arg pointer to separate the next arg from the list | |||
CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr ); | |||
// Stop processing args if no more are found | |||
if ( *arg1Ptr == '\0' ) | |||
break; | |||
// Print out the arg | |||
dPrint( arg1Ptr ); | |||
} | |||
} | |||
@@ -0,0 +1,50 @@ | |||
/* Copyright (C) 2014-2016 by Jacob Alexander | |||
* | |||
* Permission is hereby granted, free of charge, to any person obtaining a copy | |||
* of this software and associated documentation files (the "Software"), to deal | |||
* in the Software without restriction, including without limitation the rights | |||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
* copies of the Software, and to permit persons to whom the Software is | |||
* furnished to do so, subject to the following conditions: | |||
* | |||
* The above copyright notice and this permission notice shall be included in | |||
* all copies or substantial portions of the Software. | |||
* | |||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |||
* THE SOFTWARE. | |||
*/ | |||
#pragma once | |||
// ----- Includes ----- | |||
// Compiler Includes | |||
#include <stdint.h> | |||
// ----- Functions ----- | |||
// Functions to be called by main.c | |||
void Scan_setup( void ); | |||
uint8_t Scan_loop( void ); | |||
// Call-backs | |||
void Scan_finishedWithMacro( uint8_t sentKeys ); // Called by Macro Module | |||
void Scan_finishedWithOutput( uint8_t sentKeys ); // Called by Output Module | |||
void Scan_currentChange( unsigned int current ); // Called by Output Module | |||
// ----- Capabilities ----- | |||
// Example capabilities | |||
void CustomAction_action1_capability( uint8_t state, uint8_t stateType, uint8_t *args ); | |||
void CustomAction_blockHold_capability( uint8_t state, uint8_t stateType, uint8_t *args ); | |||
void CustomAction_blockKey_capability( uint8_t state, uint8_t stateType, uint8_t *args ); | |||
@@ -0,0 +1,97 @@ | |||
Name = MD1; | |||
Version = 0.3; | |||
Author = "HaaTa (Jacob Alexander) 2014-2015"; | |||
KLL = 0.3c; | |||
# Modified Date | |||
Date = 2015-08-16; | |||
S0x00 : U"Esc"; | |||
S0x01 : U"1"; | |||
S0x02 : U"2"; | |||
S0x03 : U"3"; | |||
S0x04 : U"4"; | |||
S0x05 : U"5"; | |||
S0x06 : U"6"; | |||
S0x07 : U"7"; | |||
S0x08 : U"8"; | |||
S0x09 : U"9"; | |||
S0x0A : U"0"; | |||
S0x0B : U"Minus"; | |||
S0x0C : U"Equal"; | |||
S0x0D : U"Backspace"; | |||
S0x0E : U"Backspace"; | |||
S0x0F : U"Tab"; | |||
S0x10 : U"Q"; | |||
S0x11 : U"W"; | |||
S0x12 : U"E"; | |||
S0x13 : U"R"; | |||
S0x14 : U"T"; | |||
S0x15 : U"Y"; | |||
S0x16 : U"U"; | |||
S0x17 : U"I"; | |||
S0x18 : U"O"; | |||
S0x19 : U"P"; | |||
S0x1A : U"LBrace"; | |||
S0x1B : U"RBrace"; | |||
S0x1C : U"Backslash"; | |||
S0x1D : U"Delete"; | |||
S0x1E : U"CapsLock"; | |||
S0x1F : U"A"; | |||
S0x20 : U"S"; | |||
S0x21 : U"D"; | |||
S0x22 : U"F"; | |||
S0x23 : U"G"; | |||
S0x24 : U"H"; | |||
S0x25 : U"J"; | |||
S0x26 : U"K"; | |||
S0x27 : U"L"; | |||
S0x28 : U"Semicolon"; | |||
S0x29 : U"Quote"; | |||
S0x2A : U"Enter"; | |||
S0x2B : U"Enter"; | |||
S0x2C : U"Pageup"; | |||
S0x2D : U"LShift"; | |||
S0x2E : U"Z"; | |||
S0x2F : U"X"; | |||
S0x30 : U"C"; | |||
S0x31 : U"V"; | |||
S0x32 : U"B"; | |||
S0x33 : U"N"; | |||
S0x34 : U"M"; | |||
S0x35 : U"Comma"; | |||
S0x36 : U"Period"; | |||
S0x37 : U"Slash"; | |||
S0x38 : U"RShift"; | |||
S0x39 : U"RShift"; | |||
S0x3A : U"Up"; | |||
S0x3B : U"PageDown"; | |||
S0x3C : U"LCtrl"; | |||
S0x3D : U"LGui"; | |||
S0x3E : U"LAlt"; | |||
S0x3F : U"App"; | |||
S0x40 : U"Space"; | |||
S0x41 : U"Space"; | |||
S0x42 : U"Space"; | |||
S0x43 : U"Space"; | |||
S0x44 : U"Function1"; | |||
S0x45 : U"RAlt"; | |||
S0x46 : U"RGui"; | |||
S0x47 : U"RCtrl"; | |||
S0x48 : U"Left"; | |||
S0x49 : U"Down"; | |||
S0x4A : U"Right"; | |||
# Custom Action Examples | |||
# Example capability, prints to cli | |||
action1 => CustomAction_action1_capability(); # No arguments | |||
# Blocks given USB Code, must be used with blockLink | |||
# Simple example, supports only blocking a single key at a time | |||
# Keys must be specified using numbers see Macro/PartialMap/usb_hid.h | |||
blockHold => CustomAction_blockHold_capability( usbCode : 1 ); # Single 8-bit argument | |||
blockKey => CustomAction_blockKey_capability( usbCode : 1 ); | |||
@@ -0,0 +1,32 @@ | |||
###| CMake Kiibohd Controller Scan Module |### | |||
# | |||
# Written by Jacob Alexander in 2014 for the Kiibohd Controller | |||
# | |||
# Released into the Public Domain | |||
# | |||
### | |||
### | |||
# Required Submodules | |||
# | |||
AddModule ( Scan MatrixARM ) | |||
### | |||
# Module C files | |||
# | |||
set ( Module_SRCS | |||
scan_loop.c | |||
) | |||
### | |||
# Compiler Family Compatibility | |||
# | |||
set ( ModuleCompatibility | |||
arm | |||
) | |||