HID/src/System.h

/*
Copyright (c) 2014-2015 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.
*/

#pragma once

#include "HID.h"

#if !defined(_USING_HID)

#warning "Using legacy HID core (non pluggable)"

#else

//================================================================================
// System
//================================================================================

#ifndef HID_REPORTID_SYSTEMCONTROL
#define HID_REPORTID_SYSTEMCONTROL 5
#endif

#define SYSTEM_POWER_DOWN	0x81
#define SYSTEM_SLEEP	0x82
#define SYSTEM_WAKE_UP	0x83

static const u8 _hidReportDescriptor[] PROGMEM = {
	//TODO limit to system keys only?
	/*  System Control (Power Down, Sleep, Wakeup, ...) */
	0x05, 0x01,								/* USAGE_PAGE (Generic Desktop) */
	0x09, 0x80,								/* USAGE (System Control) */
	0xa1, 0x01, 							/* COLLECTION (Application) */
	0x85, HID_REPORTID_SYSTEMCONTROL,		/* REPORT_ID */
	/* 1 system key */
	0x15, 0x00, 							/* LOGICAL_MINIMUM (0) */
	0x26, 0xff, 0x00, 						/* LOGICAL_MAXIMUM (255) */
	0x19, 0x00, 							/* USAGE_MINIMUM (Undefined) */
	0x29, 0xff, 							/* USAGE_MAXIMUM (System Menu Down) */
	0x95, 0x01, 							/* REPORT_COUNT (1) */
	0x75, 0x08, 							/* REPORT_SIZE (8) */
	0x81, 0x00, 							/* INPUT (Data,Ary,Abs) */
	0xc0 									/* END_COLLECTION */
};

typedef union{
	// every usable system control key possible
	uint8_t whole8[];
	uint8_t key;
} HID_SystemControlReport_Data_t;

extern HID_ HID;

class System_{
public:
	inline System_(void){
		static HID_Descriptor cb = {
			.length = sizeof(_hidReportDescriptor),
			.descriptor = _hidReportDescriptor,
		};
		static HIDDescriptorListNode node(&cb);
		HID.AppendDescriptor(&node);
	}
	inline void begin(void){
		// release all buttons
		end();
	}
	inline void end(void){
		uint8_t _report = 0;
		HID.SendReport(HID_REPORTID_SYSTEMCONTROL, &_report, sizeof(_report));
	}
	inline void write(uint8_t s){
		press(s);
		release();
	}
	void press(uint8_t s);
	inline void release(void){
		begin();
	}
	inline void releaseAll(void){
		begin();
	}
};
extern System_ System;

#endif