319 lines
8.5 KiB
C
319 lines
8.5 KiB
C
/* Copyright (C) 2011-2014 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/OutputLib.h>
|
|
|
|
// Project Includes
|
|
#include <cli.h>
|
|
#include <led.h>
|
|
#include <print.h>
|
|
#include <scan_loop.h>
|
|
|
|
// USB Includes
|
|
#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
|
|
#include "avr/usb_keyboard_serial.h"
|
|
#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
|
|
#include "arm/usb_dev.h"
|
|
#include "arm/usb_keyboard.h"
|
|
#include "arm/usb_serial.h"
|
|
#endif
|
|
|
|
// Local Includes
|
|
#include "output_com.h"
|
|
|
|
|
|
|
|
// ----- Function Declarations -----
|
|
|
|
void cliFunc_kbdProtocol( char* args );
|
|
void cliFunc_readLEDs ( char* args );
|
|
void cliFunc_sendKeys ( char* args );
|
|
void cliFunc_setKeys ( char* args );
|
|
void cliFunc_setMod ( char* args );
|
|
|
|
|
|
// ----- Variables -----
|
|
|
|
// Output Module command dictionary
|
|
const char outputCLIDictName[] = "USB Module Commands";
|
|
const CLIDictItem outputCLIDict[] = {
|
|
{ "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
|
|
{ "readLEDs", "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_readLEDs },
|
|
{ "sendKeys", "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
|
|
{ "setKeys", "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
|
|
{ "setMod", "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI", cliFunc_setMod },
|
|
{ 0, 0, 0 } // Null entry for dictionary end
|
|
};
|
|
|
|
|
|
// Which modifier keys are currently pressed
|
|
// 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
|
|
// 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
|
|
uint8_t USBKeys_Modifiers = 0;
|
|
uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
|
|
|
|
// Currently pressed keys, max is defined by USB_MAX_KEY_SEND
|
|
uint8_t USBKeys_Array [USB_MAX_KEY_SEND];
|
|
uint8_t USBKeys_ArrayCLI[USB_MAX_KEY_SEND]; // Separate CLI send buffer
|
|
|
|
// The number of keys sent to the usb in the array
|
|
uint8_t USBKeys_Sent = 0;
|
|
uint8_t USBKeys_SentCLI = 0;
|
|
|
|
// 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
|
|
volatile uint8_t USBKeys_LEDs = 0;
|
|
|
|
// Protocol setting from the host.
|
|
// 0 - Boot Mode (Default, until set by the host)
|
|
// 1 - NKRO Mode
|
|
volatile uint8_t USBKeys_Protocol = 1;
|
|
|
|
// Indicate if USB should send update
|
|
// OS only needs update if there has been a change in state
|
|
uint8_t USBKeys_Changed = 0;
|
|
|
|
// the idle configuration, how often we send the report to the
|
|
// host (ms * 4) even when it hasn't changed
|
|
uint8_t USBKeys_Idle_Config = 125;
|
|
|
|
// count until idle timeout
|
|
uint8_t USBKeys_Idle_Count = 0;
|
|
|
|
|
|
// ----- Capabilities -----
|
|
|
|
// Adds a single USB Code to the USB Output buffer
|
|
// Argument #1: USB Code
|
|
void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
|
|
{
|
|
// Display capability name
|
|
if ( stateType == 0xFF && state == 0xFF )
|
|
{
|
|
print("Output_usbCodeSend(usbCode)");
|
|
return;
|
|
}
|
|
|
|
// TODO Analog inputs
|
|
// Only indicate USB has changed if either a press or release has occured
|
|
if ( state == 0x01 || state == 0x03 )
|
|
USBKeys_Changed = 1;
|
|
|
|
// Only send keypresses if press or hold state
|
|
if ( stateType == 0x00 && state == 0x03 ) // Release state
|
|
return;
|
|
|
|
// Get the keycode from arguments
|
|
uint8_t key = args[0];
|
|
|
|
// Set the modifier bit if this key is a modifier
|
|
if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
|
|
{
|
|
USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
|
|
}
|
|
// Normal USB Code
|
|
else
|
|
{
|
|
// USB Key limit reached (important for Boot Mode)
|
|
if ( USBKeys_Sent >= USBKeys_MaxSize )
|
|
{
|
|
warn_msg("USB Key limit reached");
|
|
errorLED( 1 );
|
|
return;
|
|
}
|
|
|
|
USBKeys_Array[USBKeys_Sent++] = key;
|
|
}
|
|
}
|
|
|
|
|
|
|
|
// ----- Functions -----
|
|
|
|
// USB Module Setup
|
|
inline void Output_setup()
|
|
{
|
|
// 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 */ ;
|
|
|
|
// Register USB Output CLI dictionary
|
|
CLI_registerDictionary( outputCLIDict, outputCLIDictName );
|
|
|
|
// 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); // TODO (is this actually necessary?)
|
|
}
|
|
|
|
|
|
// USB Data Send
|
|
inline void Output_send(void)
|
|
{
|
|
// Don't send update if USB has not changed
|
|
if ( !USBKeys_Changed )
|
|
{
|
|
// Clear modifiers and keys
|
|
USBKeys_Modifiers = 0;
|
|
USBKeys_Sent = 0;
|
|
|
|
return;
|
|
}
|
|
USBKeys_Changed = 0;
|
|
|
|
// TODO undo potentially old keys
|
|
for ( uint8_t c = USBKeys_Sent; c < USBKeys_MaxSize; c++ )
|
|
USBKeys_Array[c] = 0;
|
|
|
|
// Send keypresses
|
|
usb_keyboard_send();
|
|
|
|
// Clear modifiers and keys
|
|
USBKeys_Modifiers = 0;
|
|
USBKeys_Sent = 0;
|
|
|
|
// Signal Scan Module we are finished
|
|
Scan_finishedWithOutput( USBKeys_Sent <= USBKeys_MaxSize ? USBKeys_Sent : USBKeys_MaxSize );
|
|
}
|
|
|
|
|
|
// Sets the device into firmware reload mode
|
|
inline void Output_firmwareReload()
|
|
{
|
|
usb_device_reload();
|
|
}
|
|
|
|
|
|
// USB Input buffer available
|
|
inline unsigned int Output_availablechar()
|
|
{
|
|
return usb_serial_available();
|
|
}
|
|
|
|
|
|
// USB Get Character from input buffer
|
|
inline int Output_getchar()
|
|
{
|
|
// XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
|
|
return (int)usb_serial_getchar();
|
|
}
|
|
|
|
|
|
// USB Send Character to output buffer
|
|
inline int Output_putchar( char c )
|
|
{
|
|
return usb_serial_putchar( c );
|
|
}
|
|
|
|
|
|
// USB Send String to output buffer, null terminated
|
|
inline int Output_putstr( char* str )
|
|
{
|
|
#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
|
|
uint16_t count = 0;
|
|
#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
|
|
uint32_t count = 0;
|
|
#endif
|
|
// Count characters until NULL character, then send the amount counted
|
|
while ( str[count] != '\0' )
|
|
count++;
|
|
|
|
return usb_serial_write( str, count );
|
|
}
|
|
|
|
|
|
// Soft Chip Reset
|
|
inline void Output_softReset()
|
|
{
|
|
usb_device_software_reset();
|
|
}
|
|
|
|
|
|
// ----- CLI Command Functions -----
|
|
|
|
void cliFunc_kbdProtocol( char* args )
|
|
{
|
|
print( NL );
|
|
info_msg("Keyboard Protocol: ");
|
|
printInt8( USBKeys_Protocol );
|
|
}
|
|
|
|
|
|
void cliFunc_readLEDs( char* args )
|
|
{
|
|
print( NL );
|
|
info_msg("LED State: ");
|
|
printInt8( USBKeys_LEDs );
|
|
}
|
|
|
|
|
|
void cliFunc_sendKeys( char* args )
|
|
{
|
|
// Copy USBKeys_ArrayCLI to USBKeys_Array
|
|
for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
|
|
{
|
|
USBKeys_Array[key] = USBKeys_ArrayCLI[key];
|
|
}
|
|
USBKeys_Sent = USBKeys_SentCLI;
|
|
|
|
// Set modifier byte
|
|
USBKeys_Modifiers = USBKeys_ModifiersCLI;
|
|
}
|
|
|
|
|
|
void cliFunc_setKeys( char* args )
|
|
{
|
|
char* curArgs;
|
|
char* arg1Ptr;
|
|
char* arg2Ptr = args;
|
|
|
|
// Parse up to USBKeys_MaxSize args (whichever is least)
|
|
for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USBKeys_MaxSize; ++USBKeys_SentCLI )
|
|
{
|
|
curArgs = arg2Ptr;
|
|
CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
|
|
|
|
// Stop processing args if no more are found
|
|
if ( *arg1Ptr == '\0' )
|
|
break;
|
|
|
|
// Add the USB code to be sent
|
|
USBKeys_ArrayCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
|
|
}
|
|
}
|
|
|
|
|
|
void cliFunc_setMod( char* args )
|
|
{
|
|
// Parse number from argument
|
|
// NOTE: Only first argument is used
|
|
char* arg1Ptr;
|
|
char* arg2Ptr;
|
|
CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
|
|
|
|
USBKeys_ModifiersCLI = numToInt( arg1Ptr );
|
|
}
|
|
|