From b2381506a253cae5d3ad8b5dfd9a434c7386cfcf Mon Sep 17 00:00:00 2001
From: Martino Facchin <m.facchin@arduino.cc>
Date: Fri, 17 Jul 2015 12:13:21 +0200
Subject: [PATCH] sam: add HID library

---
 hardware/arduino/sam/libraries/HID/HID.cpp    | 168 ++++++++++++++++++
 hardware/arduino/sam/libraries/HID/HID.h      |  94 +++++++++-
 .../arduino/sam/libraries/HID/keywords.txt    |  21 +++
 .../sam/libraries/HID/library.properties      |   8 +
 4 files changed, 289 insertions(+), 2 deletions(-)
 create mode 100644 hardware/arduino/sam/libraries/HID/HID.cpp
 create mode 100644 hardware/arduino/sam/libraries/HID/keywords.txt
 create mode 100644 hardware/arduino/sam/libraries/HID/library.properties

diff --git a/hardware/arduino/sam/libraries/HID/HID.cpp b/hardware/arduino/sam/libraries/HID/HID.cpp
new file mode 100644
index 000000000..d704bc883
--- /dev/null
+++ b/hardware/arduino/sam/libraries/HID/HID.cpp
@@ -0,0 +1,168 @@
+/* Copyright (c) 2015, Arduino LLC
+**
+** Original code (pre-library): Copyright (c) 2011, Peter Barrett
+**
+** Permission to use, copy, modify, and/or distribute this software for  
+** any purpose with or without fee is hereby granted, provided that the  
+** above copyright notice and this permission notice appear in all copies.  
+** 
+** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL  
+** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED  
+** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR  
+** BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES  
+** OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,  
+** WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,  
+** ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS  
+** SOFTWARE.  
+*/
+
+#include "USB/PluggableUSB.h"
+#include "HID.h"
+
+HID_ HID;
+
+static uint8_t HID_ENDPOINT_INT;
+
+//================================================================================
+//================================================================================
+
+//	HID report descriptor
+
+#define LSB(_x) ((_x) & 0xFF)
+#define MSB(_x) ((_x) >> 8)
+
+#define RAWHID_USAGE_PAGE	0xFFC0
+#define RAWHID_USAGE		0x0C00
+#define RAWHID_TX_SIZE 64
+#define RAWHID_RX_SIZE 64
+
+static uint8_t HID_INTERFACE;
+
+HIDDescriptor _hidInterface;
+
+static HIDDescriptorListNode* rootNode = NULL;
+static uint8_t sizeof_hidReportDescriptor = 0;
+static uint8_t modules_count = 0;
+//================================================================================
+//================================================================================
+//	Driver
+
+uint8_t _hid_protocol = 1;
+uint8_t _hid_idle = 1;
+
+int HID_GetInterface(uint8_t* interfaceNum)
+{
+	interfaceNum[0] += 1;	// uses 1
+	_hidInterface =
+	{
+		D_INTERFACE(HID_INTERFACE,1,3,0,0),
+		D_HIDREPORT(sizeof_hidReportDescriptor),
+		D_ENDPOINT(USB_ENDPOINT_IN (HID_ENDPOINT_INT),USB_ENDPOINT_TYPE_INTERRUPT,0x40,0x01)
+	};
+	return USBD_SendControl(0,&_hidInterface,sizeof(_hidInterface));
+}
+
+int HID_GetDescriptor(int8_t t)
+{
+	if (HID_REPORT_DESCRIPTOR_TYPE == t) {
+		HIDDescriptorListNode* current = rootNode;
+		int total = 0;
+		while(current != NULL) {
+			total += USBD_SendControl(0,current->cb->descriptor,current->cb->length);
+			current = current->next;
+		}
+		return total;
+	} else {
+		return 0;
+	}
+}
+
+void HID_::AppendDescriptor(HIDDescriptorListNode *node)
+{
+	if (modules_count == 0) {
+		rootNode = node;
+	} else {
+		HIDDescriptorListNode *current = rootNode;
+		while(current->next != NULL) {
+			current = current->next;
+		}
+		current->next = node;
+	}
+	modules_count++;
+	sizeof_hidReportDescriptor += node->cb->length;
+}
+
+void HID_::SendReport(uint8_t id, const void* data, int len)
+{
+	uint8_t p[64];
+	const uint8_t *d = reinterpret_cast<const uint8_t *>(data);
+
+	p[0] = id;
+	for (uint32_t i=0; i<len; i++)
+		p[i+1] = d[i];
+	USBD_Send(HID_TX, p, len+1);
+}
+
+bool HID_Setup(USBSetup& setup, uint8_t i)
+{
+	if (HID_INTERFACE != i) {
+		return false;
+	} else {
+		uint8_t r = setup.bRequest;
+		uint8_t requestType = setup.bmRequestType;
+		if (REQUEST_DEVICETOHOST_CLASS_INTERFACE == requestType)
+		{
+			if (HID_GET_REPORT == r)
+			{
+			//HID_GetReport();
+				return true;
+			}
+			if (HID_GET_PROTOCOL == r)
+			{
+			//Send8(_hid_protocol);	// TODO
+				return true;
+			}
+		}
+		
+		if (REQUEST_HOSTTODEVICE_CLASS_INTERFACE == requestType)
+		{
+			if (HID_SET_PROTOCOL == r)
+			{
+				_hid_protocol = setup.wValueL;
+				return true;
+			}
+
+			if (HID_SET_IDLE == r)
+			{
+				_hid_idle = setup.wValueL;
+				return true;
+			}
+		}
+		return false;
+	}
+}
+
+HID_::HID_(void)
+{
+	static uint8_t endpointType[1];
+
+	endpointType[0] = EP_TYPE_INTERRUPT_IN;
+
+	static PUSBCallbacks cb = {
+		.setup = &HID_Setup,
+		.getInterface = &HID_GetInterface,
+		.getDescriptor = &HID_GetDescriptor,
+		.numEndpoints = 1,
+		.numInterfaces = 1,
+		.endpointType = endpointType,
+	};
+
+	static PUSBListNode node(&cb);
+
+	HID_ENDPOINT_INT = PUSB_AddFunction(&node, &HID_INTERFACE);
+}
+
+int HID_::begin(void)
+{
+	return 0;
+}
\ No newline at end of file
diff --git a/hardware/arduino/sam/libraries/HID/HID.h b/hardware/arduino/sam/libraries/HID/HID.h
index 47ad936fa..7288552d8 100644
--- a/hardware/arduino/sam/libraries/HID/HID.h
+++ b/hardware/arduino/sam/libraries/HID/HID.h
@@ -1,3 +1,93 @@
-// HID.h
+/*
+  HID.h
 
-// placeholder waiting for HID library to be DUE compatible
\ No newline at end of file
+  Copyright (c) 2015, Arduino LLC
+  Original code (pre-library): Copyright (c) 2011, Peter Barrett
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef HID_h
+#define HID_h
+
+#include <stdint.h>
+#include <Arduino.h>
+
+#define _USING_HID
+
+//================================================================================
+//================================================================================
+//  HID 'Driver'
+
+#define HID_GET_REPORT        0x01
+#define HID_GET_IDLE          0x02
+#define HID_GET_PROTOCOL      0x03
+#define HID_SET_REPORT        0x09
+#define HID_SET_IDLE          0x0A
+#define HID_SET_PROTOCOL      0x0B
+
+#define HID_HID_DESCRIPTOR_TYPE         0x21
+#define HID_REPORT_DESCRIPTOR_TYPE      0x22
+#define HID_PHYSICAL_DESCRIPTOR_TYPE    0x23
+
+typedef struct __attribute__((packed)) {
+  uint8_t length;
+  const void* descriptor;
+} HID_Descriptor;
+
+class HIDDescriptorListNode {
+public:
+  HIDDescriptorListNode *next = NULL;
+  const HID_Descriptor * cb;
+  HIDDescriptorListNode(const HID_Descriptor *ncb) {cb = ncb;}
+};
+
+class HID_
+{
+public:
+  HID_(void);
+  int begin(void);
+  void SendReport(uint8_t id, const void* data, int len);
+  void AppendDescriptor(HIDDescriptorListNode* node);
+};
+
+typedef struct
+{
+  uint8_t len;     // 9
+  uint8_t dtype;   // 0x21
+  uint8_t addr;
+  uint8_t  versionL; // 0x101
+  uint8_t  versionH; // 0x101
+  uint8_t  country;
+  uint8_t  desctype; // 0x22 report
+  uint8_t  descLenL;
+  uint8_t  descLenH;
+} HIDDescDescriptor;
+
+typedef struct
+{
+  InterfaceDescriptor     hid;
+  HIDDescDescriptor     desc;
+  EndpointDescriptor      in;
+} HIDDescriptor;
+
+#define HID_TX HID_ENDPOINT_INT
+
+#define D_HIDREPORT(_descriptorLength) \
+  { 9, 0x21, 0x1, 0x1, 0, 1, 0x22, _descriptorLength, 0 }
+
+#define WEAK __attribute__ ((weak))
+
+#endif
\ No newline at end of file
diff --git a/hardware/arduino/sam/libraries/HID/keywords.txt b/hardware/arduino/sam/libraries/HID/keywords.txt
new file mode 100644
index 000000000..32a9ba5f2
--- /dev/null
+++ b/hardware/arduino/sam/libraries/HID/keywords.txt
@@ -0,0 +1,21 @@
+#######################################
+# Syntax Coloring Map HID
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+HID	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+begin	KEYWORD2
+SendReport	KEYWORD2
+AppendDescriptor	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+HID_TX	LITERAL1
\ No newline at end of file
diff --git a/hardware/arduino/sam/libraries/HID/library.properties b/hardware/arduino/sam/libraries/HID/library.properties
new file mode 100644
index 000000000..5114f1bc5
--- /dev/null
+++ b/hardware/arduino/sam/libraries/HID/library.properties
@@ -0,0 +1,8 @@
+name=HID
+version=1.0
+author=Arduino
+maintainer=Arduino <info@arduino.cc>
+sentence=Module for PluggableUSB infrastructure. Exposes an API for devices like Keyboards, Mice and Gamepads
+paragraph=
+url=http://www.arduino.cc/en/Reference/HID
+architectures=sam
\ No newline at end of file