-/* Copyright (C) 2011 by Jacob Alexander
+/* Copyright (C) 2011-2013 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
* THE SOFTWARE.
*/
-#include <avr/io.h>
-#include <avr/pgmspace.h>
-#include <avr/interrupt.h>
-#include <util/delay.h>
-//#include "usb_keyboard.h"
+// ----- Includes -----
-// TEMP INCLUDES
-#include "usb_keyboard_debug.h"
+// Compiler Includes
+#include <Lib/MainLib.h>
+
+// Project Includes
+#include <macro.h>
+#include <scan_loop.h>
+#include <output_com.h>
+
+#include <led.h>
#include <print.h>
+
+
+// ----- Defines -----
+
+// Verified Keypress Defines
+#define USB_TRANSFER_DIVIDER 10 // 1024 == 1 Send of keypresses per second, 1 == 1 Send of keypresses per ~1 millisecond
+
+
+
+// ----- Macros -----
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
#define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
+#endif
-// Sleep defined in milliseconds
-#define PRE_DRIVE_SLEEP 10
-#define POST_DRIVE_SLEEP 10
-
-
-// Drive Pin Defines
-#define DRIVE_reg_1 PORTD
-#define DRIVE_reg_2 PORTD
-#define DRIVE_reg_3 PORTD
-#define DRIVE_reg_4 PORTD
-#define DRIVE_reg_5 PORTD
-#define DRIVE_reg_6 PORTD
-#define DRIVE_reg_7 PORTE
-#define DRIVE_reg_8 PORTE
-#define DRIVE_reg_9 PORTE
-#define DRIVE_reg_10 <blank>
-#define DRIVE_reg_11 <blank>
-#define DRIVE_reg_12 <blank>
-
-#define DRIVE_pin_1 2
-#define DRIVE_pin_2 3
-#define DRIVE_pin_3 4
-#define DRIVE_pin_4 5
-#define DRIVE_pin_5 6
-#define DRIVE_pin_6 7
-#define DRIVE_pin_7 0
-#define DRIVE_pin_8 1
-#define DRIVE_pin_9 6
-#define DRIVE_pin_10 <blank>
-#define DRIVE_pin_11 <blank>
-#define DRIVE_pin_12 <blank>
-
-// Detect Pin/Group Defines
-#define DETECT_group_1 1
-#define DETECT_group_2 2
-#define DETECT_group_3 3
-#define DETECT_group_4 4
-#define DETECT_group_5 5
-#define DETECT_group_6 6
-#define DETECT_group_7 7
-#define DETECT_group_8 8
-#define DETECT_group_9 9
-#define DETECT_group_10 <blank>
-#define DETECT_group_11 <blank>
-#define DETECT_group_12 <blank>
-
-#define DETECT_group_size_1 4
-#define DETECT_group_size_2 8
-#define DETECT_group_size_3 8
-#define DETECT_group_size_4 7
-#define DETECT_group_size_5 7
-#define DETECT_group_size_6 8
-#define DETECT_group_size_7 6
-#define DETECT_group_size_8 7
-#define DETECT_group_size_9 7
-#define DETECT_group_size_10 <blank>
-#define DETECT_group_size_11 <blank>
-#define DETECT_group_size_12 <blank>
-
-#define DETECT_group_array_1 {{KEY_ESC,KEY_CTRL,KEY_CAPS_LOCK,KEY_SHIFT},{0,1,0,1}}
-#define DETECT_group_array_2 {{KEY_BACKSPACE,KEY_UP,KEY_DOWN,KEY_A,KEY_INSERT,KEY_ALT,KEY_Z,KEY_RIGHT},{0,0,0,0,0,1,0,0}}
-#define DETECT_group_array_3 {{KEY_TILDE,KEY_DELETE,KEY_LEFT,KEY_SPACE,KEY_X,KEY_S,KEY_TAB,KEY_1},{0,0,0,0,0,0,0,0}}
-#define DETECT_group_array_4 {{KEY_SLASH,KEY_RIGHT_BRACE,KEY_ENTER,KEY_D,KEY_2,KEY_Q,KEY_C},{0,0,0,0,0,0,0}}
-#define DETECT_group_array_5 {{KEY_EQUAL,KEY_LEFT_BRACE,KEY_QUOTE,KEY_F,KEY_3,KEY_W,KEY_V},{0,0,0,0,0,0,0}}
-#define DETECT_group_array_6 {{KEY_MINUS,KEY_P,KEY_SEMICOLON,KEY_G,KEY_4,KEY_E,KEY_B,KEY_BACKSLASH},{0,0,0,0,0,0,0,0}}
-#define DETECT_group_array_7 {{KEY_8,KEY_U,KEY_K,KEY_7,KEY_Y,KEY_COMMA},{0,0,0,0,0,0}}
-#define DETECT_group_array_8 {{KEY_9,KEY_I,KEY_PERIOD,KEY_J,KEY_6,KEY_T,KEY_M},{0,0,0,0,0,0,0}}
-#define DETECT_group_array_9 {{KEY_0,KEY_O,KEY_L,KEY_H,KEY_5,KEY_R,KEY_N},{0,0,0,0,0,0,0}}
-#define DETECT_group_array_10 <blank>
-#define DETECT_group_array_11 <blank>
-#define DETECT_group_array_12 <blank>
-
-
-
-// Drive Macros (Generally don't need to be changed), except for maybe DRIVE_DETECT
-#define DRIVE_DETECT(reg,pin,group) \
- reg &= ~(1 << pin); \
- detection(group); \
- reg |= (1 << pin); \
- _delay_ms(POST_DRIVE_SLEEP);
-
-#define DD_CASE(number) \
- case number:\
- DRIVE_DETECT(DRIVE_reg##_##number, DRIVE_pin##_##number, DETECT_group##_##number)
-
-#define DD_CASE_ORD(number) \
- DD_CASE(number) \
- break;
-
-#define DD_CASE_END(number,var) \
- DD_CASE(number) \
- var = -1; \
- break;
-
-
-// Detection Macros (Probably don't need to be changed, but depending the matrix, may have to be)
-// Determine if key is either normal or a modifier
-#define DET_GROUP_CHECK(index) \
- { \
- if ( groupArray[1][index] ) \
- curDetect.modifiers |= groupArray[0][index]; \
- else \
- curDetect.keyDetectArray[curDetect.keyDetectCount++] = groupArray[0][index]; \
- }
-
-
-// XXX - Detection Groups
-// Checks each of the specified pins, and then if press detected, determine if the key is normal or a modifier
-// Inverse logic applies for the PINs
-
-// Used for 1 detection group
-#define DET_GROUP_1 \
- if ( !( PINC & (1 << 0) ) ) \
- DET_GROUP_CHECK(3) \
- if ( !( PINE & (1 << 1) ) ) \
- DET_GROUP_CHECK(2) \
- if ( !( PINE & (1 << 0) ) ) \
- DET_GROUP_CHECK(1) \
- if ( !( PINB & (1 << 7) ) ) \
- DET_GROUP_CHECK(0)
-
-// Used for 4 detection groups
-#define DET_GROUP_2 \
- if ( !( PINC & (1 << 0) ) ) \
- DET_GROUP_CHECK(0) \
- if ( !( PINC & (1 << 1) ) ) \
- DET_GROUP_CHECK(1) \
- if ( !( PINC & (1 << 2) ) ) \
- DET_GROUP_CHECK(2) \
- if ( !( PINC & (1 << 3) ) ) \
- DET_GROUP_CHECK(3) \
- if ( !( PINC & (1 << 4) ) ) \
- DET_GROUP_CHECK(4) \
- if ( !( PINC & (1 << 5) ) ) \
- DET_GROUP_CHECK(5) \
- if ( !( PINC & (1 << 6) ) ) \
- DET_GROUP_CHECK(6) \
-
-// Used for 1 detection group
-#define DET_GROUP_3 \
- if ( !( PINC & (1 << 0) ) ) \
- DET_GROUP_CHECK(0) \
- if ( !( PINC & (1 << 1) ) ) \
- DET_GROUP_CHECK(1) \
- if ( !( PINC & (1 << 3) ) ) \
- DET_GROUP_CHECK(2) \
- if ( !( PINC & (1 << 4) ) ) \
- DET_GROUP_CHECK(3) \
- if ( !( PINC & (1 << 5) ) ) \
- DET_GROUP_CHECK(4) \
- if ( !( PINC & (1 << 6) ) ) \
- DET_GROUP_CHECK(5) \
-
-// Used for 3 detection groups
-#define DET_GROUP_4 \
- if ( !( PINC & (1 << 0) ) ) \
- DET_GROUP_CHECK(0) \
- if ( !( PINC & (1 << 1) ) ) \
- DET_GROUP_CHECK(1) \
- if ( !( PINC & (1 << 2) ) ) \
- DET_GROUP_CHECK(2) \
- if ( !( PINC & (1 << 3) ) ) \
- DET_GROUP_CHECK(3) \
- if ( !( PINC & (1 << 4) ) ) \
- DET_GROUP_CHECK(4) \
- if ( !( PINC & (1 << 5) ) ) \
- DET_GROUP_CHECK(5) \
- if ( !( PINC & (1 << 6) ) ) \
- DET_GROUP_CHECK(6) \
- if ( !( PINE & (1 << 1) ) ) \
- DET_GROUP_CHECK(7) \
-
-// Combines the DET_GROUP_Xs above for the given groupArray
-#define DET_GROUP(group,det_group) \
- case group: \
- { \
- uint8_t groupArray[2][DETECT_group_size##_##group] = DETECT_group_array##_##group; \
- DET_GROUP##_##det_group \
- } \
- break;
-
-struct keys {
- uint8_t keyDetectCount;
- uint8_t keyDetectArray[40];
- uint8_t modifiers;
-} curDetect, prevDetect;
-
-void detection( int group )
-{
- _delay_ms(PRE_DRIVE_SLEEP);
-
- // XXX Modify for different detection groups <-> groupArray mappings
- switch ( group ) {
- DET_GROUP(1,1)
- /*
- DET_GROUP(2,4)
- DET_GROUP(3,4)
- DET_GROUP(4,1)
- DET_GROUP(5,4)
- DET_GROUP(6,2)
- DET_GROUP(7,2)
- DET_GROUP(8,3)
- DET_GROUP(9,2)
- */
- }
- // Print out the current keys pressed
- if ( curDetect.keyDetectCount > 0 ) {
- print("Keys: ");
- for ( int c = 0; c < curDetect.keyDetectCount; c++ ) {
- phex( curDetect.keyDetectArray[c] );
- print(" ");
- }
- print("\n");
- }
- if ( curDetect.modifiers ) {
- print("Modifiers: ");
- phex( curDetect.modifiers );
- print("\n");
- }
-}
+// ----- Variables -----
+// Timer Interrupt for flagging a send of the sampled key detection data to the USB host
+uint16_t sendKeypressCounter = 0;
+// Flag generated by the timer interrupt
+volatile uint8_t sendKeypresses = 0;
-// XXX This part is configurable
-void pinSetup(void)
+
+
+// ----- Functions -----
+
+// Initial Pin Setup, make sure they are sane
+inline void pinSetup(void)
{
+
+// AVR
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
+
// For each pin, 0=input, 1=output
+#if defined(__AVR_AT90USB1286__)
DDRA = 0x00;
- DDRB = 0x07;
- DDRC = 0x80;
+#endif
+ DDRB = 0x00;
+ DDRC = 0x00;
DDRD = 0x00;
- DDRE = 0xC0;
- DDRF = 0x31;
+ DDRE = 0x00;
+ DDRF = 0x00;
+
// Setting pins to either high or pull-up resistor
+#if defined(__AVR_AT90USB1286__)
PORTA = 0x00;
- PORTB = 0x0F;
- PORTC = 0xFF;
+#endif
+ PORTB = 0x00;
+ PORTC = 0x00;
PORTD = 0x00;
- PORTE = 0xC2;
- PORTF = 0x3F;
+ PORTE = 0x00;
+ PORTF = 0x00;
+
+// ARM
+#elif defined(_mk20dx128_)
+ // TODO - Should be cleared, but not that necessary due to the pin layout
+#endif
}
-int main( void )
+
+inline void usbTimerSetup(void)
{
- // set for 16 MHz clock
+// AVR
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
+
+ // Setup with 16 MHz clock
CPU_PRESCALE( 0 );
+ // Setup ISR Timer for flagging a kepress send to USB
+ // Set to 256 * 1024 (8 bit timer with Clock/1024 prescalar) timer
+ TCCR0A = 0x00;
+ TCCR0B = 0x03;
+ TIMSK0 = (1 << TOIE0);
+
+// ARM
+#elif defined(_mk20dx128_)
+ // 48 MHz clock by default
+
+ // System Clock Gating Register Disable
+ SIM_SCGC6 |= SIM_SCGC6_PIT;
+
+ // Enable Timers
+ PIT_MCR = 0x00;
+
+ // Setup ISR Timer for flagging a kepress send to USB
+ // 1 ms / (1 / 48 MHz) - 1 = 47999 cycles -> 0xBB7F
+ PIT_LDVAL0 = 0x0000BB7F;
+ PIT_TCTRL0 = 0x3; // Enable Timer 0 interrupts, and Enable Timer 0
+
+ // Insert the required vector for Timer 0
+ NVIC_ENABLE_IRQ( IRQ_PIT_CH0 );
+#endif
+}
+
+
+int main(void)
+{
// Configuring Pins
pinSetup();
+ init_errorLED();
- // Initialize the USB, and then wait for the host to set configuration.
- // If the Teensy is powered without a PC connected to the USB port,
- // this will wait forever.
- usb_init();
- while ( !usb_configured() ) /* wait */ ;
+ // Setup Output Module
+ output_setup();
- // Wait an extra second for the PC's operating system to load drivers
- // and do whatever it does to actually be ready for input
- _delay_ms(1000);
+ // Enable CLI
+ init_cli();
- // Make sure variables are properly initialized
- curDetect.keyDetectCount = 0;
- curDetect.modifiers = 0;
+ // Setup ISR Timer for flagging a kepress send to USB
+ usbTimerSetup();
// Main Detection Loop
- // XXX Change number of ORDs if number of lines differ
- for ( int group = 1;;group++ ) {
- // Determine which keys are being pressed
- switch ( group ) {
- /*
- DD_CASE_ORD(1)
- DD_CASE_ORD(2)
- DD_CASE_ORD(3)
- DD_CASE_ORD(4)
- DD_CASE_ORD(5)
- DD_CASE_ORD(6)
- DD_CASE_ORD(7)
- DD_CASE_ORD(8)
- */
- DD_CASE_END(9,group)
+ uint8_t ledTimer = F_CPU / 1000000; // Enable LED for a short time
+ while ( 1 )
+ {
+ // Setup the scanning module
+ scan_setup();
+
+ while ( 1 )
+ {
+ // Acquire Key Indices
+ // Loop continuously until scan_loop returns 0
+ cli();
+ while ( scan_loop() );
+ sei();
+
+ // Run Macros over Key Indices and convert to USB Keys
+ process_macros();
+
+ // Send keypresses over USB if the ISR has signalled that it's time
+ if ( !sendKeypresses )
+ continue;
+
+ // Send USB Data
+ usb_send();
+
+ // Clear sendKeypresses Flag
+ sendKeypresses = 0;
+
+ // Indicate Error, if valid
+ errorLED( ledTimer );
+
+ if ( ledTimer > 0 )
+ ledTimer--;
}
- if ( group != -1 )
- continue;
+ // Loop should never get here (indicate error)
+ ledTimer = 255;
- // After going through each of the key groups, send the detected keys and modifiers
- // Currently limited to the USB spec (6 keys + modifiers)
- // Making sure to pass zeros when there are no keys being pressed
- for ( int c = 0; c < 6 && c < curDetect.keyDetectCount; c++ )
- keyboard_keys[c] = c < curDetect.keyDetectCount ? curDetect.keyDetectArray[c] : 0;
+ // HID Debug Error message
+ erro_print("Detection loop error, this is very bad...bug report!");
+ }
+}
- // Modifiers
- keyboard_modifier_keys = curDetect.modifiers;
- // Send keypresses
- usb_keyboard_send();
+// ----- Interrupts -----
- // Cleanup
- curDetect.keyDetectCount = 0;
- curDetect.modifiers = 0;
+// USB Keyboard Data Send Counter Interrupt
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
+ISR( TIMER0_OVF_vect )
+#elif defined(_mk20dx128_) // ARM
+void pit0_isr(void)
+#endif
+{
+ sendKeypressCounter++;
+ if ( sendKeypressCounter > USB_TRANSFER_DIVIDER ) {
+ sendKeypressCounter = 0;
+ sendKeypresses = 1;
}
- // usb_keyboard_press(KEY_B, KEY_SHIFT);
- return 0;
+#if defined(_mk20dx128_) // ARM
+ // Clear the interrupt flag
+ PIT_TFLG0 = 1;
+#endif
}
projects / kiibohd-controller.git / blobdiff