HID/HID.cpp
2014-06-03 17:10:40 +02:00

516 lines
No EOL
12 KiB
C++

/*
Copyright (c) 2014 NicoHood
See the readme for credit to other people.
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.
*/
#include "HID.h"
//================================================================================
// HID
//================================================================================
HID_ HID;
void HID_::sendReport(uint8_t ReportID, const void* HIDReport, uint8_t length){
// write the Report via Protocol and checksum. 16bit for each sending
// send control address
NHPHID.sendChecksum(NHP_ADDRESS_CONTROL, (NHP_USAGE_ARDUINOHID<<8)|ReportID , Serial);
const uint8_t* report = (const uint8_t*)HIDReport;
for(int i = 0; i<length;i++){
uint8_t data0=report[i++];
uint8_t data1=0;
if(i!=length)
data1=report[i];
// valid HID reports start at Address 2
NHPHID.sendChecksum(2+i/2,(data1<<8) | data0, Serial);
}
}
//================================================================================
// Mouse
//================================================================================
Mouse_ Mouse;
Mouse_::Mouse_(void){
// empty
}
void Mouse_::begin(void){
memset(&_report, 0, sizeof(_report));
HID.sendReport(HID_REPORTID_MouseReport, &_report, sizeof(_report));
}
void Mouse_::end(void){
begin();
}
void Mouse_::click(uint8_t b){
_report.buttons = b;
move(0,0,0);
_report.buttons = 0;
move(0,0,0);
}
void Mouse_::move(signed char x, signed char y, signed char wheel){
_report.xAxis=x;
_report.yAxis=y;
_report.wheel=wheel;
HID.sendReport(HID_REPORTID_MouseReport, &_report, sizeof(HID_MouseReport_Data_t));
}
void Mouse_::buttons(uint8_t b){
if (b != _report.buttons) {
_report.buttons = b;
move(0,0,0);
}
}
void Mouse_::press(uint8_t b){
buttons(_report.buttons | b);
}
void Mouse_::release(uint8_t b){
buttons(_report.buttons & ~b);
}
void Mouse_::releaseAll(void){
begin();
}
bool Mouse_::isPressed(uint8_t b){
if ((b & _report.buttons) > 0)
return true;
return false;
}
//================================================================================
// Keyboard
//================================================================================
Keyboard_ Keyboard;
Keyboard_::Keyboard_(void){
// empty
}
void Keyboard_::begin(void){
memset(&_report, 0, sizeof(_report));
HID.sendReport(HID_REPORTID_KeyboardReport, &_report, sizeof(_report));
}
void Keyboard_::end(void){
begin();
}
extern
const uint8_t _asciimap[128] PROGMEM;
#define SHIFT 0x80
const uint8_t _asciimap[128] =
{
0x00, // NUL
0x00, // SOH
0x00, // STX
0x00, // ETX
0x00, // EOT
0x00, // ENQ
0x00, // ACK
0x00, // BEL
0x2a, // BS Backspace
0x2b, // TAB Tab
0x28, // LF Enter
0x00, // VT
0x00, // FF
0x00, // CR
0x00, // SO
0x00, // SI
0x00, // DEL
0x00, // DC1
0x00, // DC2
0x00, // DC3
0x00, // DC4
0x00, // NAK
0x00, // SYN
0x00, // ETB
0x00, // CAN
0x00, // EM
0x00, // SUB
0x00, // ESC
0x00, // FS
0x00, // GS
0x00, // RS
0x00, // US
0x2c, // ' '
0x1e|SHIFT, // !
0x34|SHIFT, // "
0x20|SHIFT, // #
0x21|SHIFT, // $
0x22|SHIFT, // %
0x24|SHIFT, // &
0x34, // '
0x26|SHIFT, // (
0x27|SHIFT, // )
0x25|SHIFT, // *
0x2e|SHIFT, // +
0x36, // ,
0x2d, // -
0x37, // .
0x38, // /
0x27, // 0
0x1e, // 1
0x1f, // 2
0x20, // 3
0x21, // 4
0x22, // 5
0x23, // 6
0x24, // 7
0x25, // 8
0x26, // 9
0x33|SHIFT, // :
0x33, // ;
0x36|SHIFT, // <
0x2e, // =
0x37|SHIFT, // >
0x38|SHIFT, // ?
0x1f|SHIFT, // @
0x04|SHIFT, // A
0x05|SHIFT, // B
0x06|SHIFT, // C
0x07|SHIFT, // D
0x08|SHIFT, // E
0x09|SHIFT, // F
0x0a|SHIFT, // G
0x0b|SHIFT, // H
0x0c|SHIFT, // I
0x0d|SHIFT, // J
0x0e|SHIFT, // K
0x0f|SHIFT, // L
0x10|SHIFT, // M
0x11|SHIFT, // N
0x12|SHIFT, // O
0x13|SHIFT, // P
0x14|SHIFT, // Q
0x15|SHIFT, // R
0x16|SHIFT, // S
0x17|SHIFT, // T
0x18|SHIFT, // U
0x19|SHIFT, // V
0x1a|SHIFT, // W
0x1b|SHIFT, // X
0x1c|SHIFT, // Y
0x1d|SHIFT, // Z
0x2f, // [
0x31, // bslash
0x30, // ]
0x23|SHIFT, // ^
0x2d|SHIFT, // _
0x35, // `
0x04, // a
0x05, // b
0x06, // c
0x07, // d
0x08, // e
0x09, // f
0x0a, // g
0x0b, // h
0x0c, // i
0x0d, // j
0x0e, // k
0x0f, // l
0x10, // m
0x11, // n
0x12, // o
0x13, // p
0x14, // q
0x15, // r
0x16, // s
0x17, // t
0x18, // u
0x19, // v
0x1a, // w
0x1b, // x
0x1c, // y
0x1d, // z
0x2f|SHIFT, //
0x31|SHIFT, // |
0x30|SHIFT, // }
0x35|SHIFT, // ~
0 // DEL
};
// removed <--
//uint8_t USBPutChar(uint8_t c);
size_t Keyboard_::write(uint8_t c)
{
uint8_t p = press(c); // Keydown
//uint8_t r =
release(c); // Keyup
return (p); // just return the result of press() since release() almost always returns 1
}
// press() adds the specified key (printing, non-printing, or modifier)
// to the persistent key report and sends the report. Because of the way
// USB HID works, the host acts like the key remains pressed until we
// call release(), releaseAll(), or otherwise clear the report and resend.
size_t Keyboard_::press(uint8_t k)
{
uint8_t i;
if (k >= 136) { // it's a non-printing key (not a modifier)
k = k - 136;
} else if (k >= 128) { // it's a modifier key
_report.modifiers |= (1<<(k-128));
k = 0;
} else { // it's a printing key
k = pgm_read_byte(_asciimap + k);
if (!k) {
setWriteError();
return 0;
}
if (k & 0x80) { // it's a capital letter or other character reached with shift
_report.modifiers |= 0x02; // the left shift modifier
k &= 0x7F;
}
}
// Add k to the key report only if it's not already present
// and if there is an empty slot.
if (_report.keys[0] != k && _report.keys[1] != k &&
_report.keys[2] != k && _report.keys[3] != k &&
_report.keys[4] != k && _report.keys[5] != k) {
for (i=0; i<6; i++) {
if (_report.keys[i] == 0x00) {
_report.keys[i] = k;
break;
}
}
if (i == 6) {
setWriteError();
return 0;
}
}
HID.sendReport(HID_REPORTID_KeyboardReport, &_report, sizeof(_report));
return 1;
}
// release() takes the specified key out of the persistent key report and
// sends the report. This tells the OS the key is no longer pressed and that
// it shouldn't be repeated any more.
size_t Keyboard_::release(uint8_t k)
{
uint8_t i;
if (k >= 136) { // it's a non-printing key (not a modifier)
k = k - 136;
} else if (k >= 128) { // it's a modifier key
_report.modifiers &= ~(1<<(k-128));
k = 0;
} else { // it's a printing key
k = pgm_read_byte(_asciimap + k);
if (!k) {
return 0;
}
if (k & 0x80) { // it's a capital letter or other character reached with shift
_report.modifiers &= ~(0x02); // the left shift modifier
k &= 0x7F;
}
}
// Test the key report to see if k is present. Clear it if it exists.
// Check all positions in case the key is present more than once (which it shouldn't be)
for (i=0; i<6; i++) {
if (0 != k && _report.keys[i] == k) {
_report.keys[i] = 0x00;
}
}
HID.sendReport(HID_REPORTID_KeyboardReport, &_report, sizeof(_report));
return 1;
}
void Keyboard_::releaseAll(void){
begin();
}
//================================================================================
// Media
//================================================================================
Media_ Media;
Media_::Media_(void){
// empty
}
void Media_::begin(void){
memset(&_report, 0, sizeof(_report));
HID.sendReport(HID_REPORTID_MediaReport, &_report, sizeof(_report));
}
void Media_::end(void){
begin();
}
void Media_::write(uint16_t m){
press(m);
release(m);
}
void Media_::press(uint16_t m){
// search for a free spot
for (int i=0; i<sizeof(HID_MediaReport_Data_t)/2; i++) {
if(_report.whole16[i] == 0x00) {
_report.whole16[i] = m;
break;
}
}
HID.sendReport(HID_REPORTID_MediaReport, &_report, sizeof(_report));
}
void Media_::release(uint16_t m){
// search and release the keypress
for (int i=0; i<sizeof(HID_MediaReport_Data_t)/2; i++) {
if (_report.whole16[i] == m) {
_report.whole16[i] = 0x00;
// no break to delete multiple keys
}
}
HID.sendReport(HID_REPORTID_MediaReport, &_report, sizeof(_report));
}
void Media_::releaseAll(void){
begin();
}
//================================================================================
// System
//================================================================================
System_ System;
System_::System_(void){
// empty
}
void System_::begin(void){
uint16_t _report = 0;
HID.sendReport(HID_REPORTID_SystemReport, &_report, sizeof(_report));
}
void System_::end(void){
begin();
}
void System_::write(uint16_t s){
press(s);
release();
}
void System_::press(uint16_t s){
HID.sendReport(HID_REPORTID_SystemReport, &s, sizeof(s));
}
void System_::release(void){
begin();
}
void System_::releaseAll(void){
begin();
}
//================================================================================
// Gamepad
//================================================================================
Gamepad_ Gamepad1(HID_REPORTID_Gamepad1Report);
Gamepad_ Gamepad2(HID_REPORTID_Gamepad2Report);
Gamepad_::Gamepad_(uint8_t reportID){
_reportID = reportID;
// empty
}
void Gamepad_::begin(void){
memset(&_report, 0, sizeof(_report));
HID.sendReport(_reportID, &_report, sizeof(_report));
}
void Gamepad_::end(void){
begin();
}
void Gamepad_::write(void){
HID.sendReport(_reportID, &_report, sizeof(_report));
}
void Gamepad_::press(uint8_t b){
_report.buttons|=(uint32_t)1<<(b-1);
}
void Gamepad_::release(uint8_t b){
_report.buttons&=~((uint32_t)1<<(b-1));
}
void Gamepad_::releaseAll(void){
_report.buttons=0;
}
//================================================================================
// Joystick
//================================================================================
Joystick_ Joystick1(HID_REPORTID_Joystick1Report);
Joystick_ Joystick2(HID_REPORTID_Joystick2Report);
Joystick_::Joystick_(uint8_t reportID){
_reportID = reportID;
// empty
}
void Joystick_::begin(void){
memset(&_report, 0, sizeof(_report));
HID.sendReport(_reportID, &_report, sizeof(_report));
}
void Joystick_::end(void){
begin();
}
void Joystick_::write(void){
HID.sendReport(_reportID, &_report, sizeof(_report));;
}
void Joystick_::press(uint8_t b){
if(b==1) _report.button1=1;
else if(b==2) _report.button2=1;
}
void Joystick_::release(uint8_t b){
if(b==1) _report.button1=0;
else if(b==2) _report.button2=0;
}
void Joystick_::releaseAll(void){
_report.button1=0;
_report.button2=0;
}