GenericHID.c

/*
             LUFA Library
     Copyright (C) Dean Camera, 2015.

  dean [at] fourwalledcubicle [dot] com
           www.lufa-lib.org
*/

/*
  Copyright 2015  Dean Camera (dean [at] fourwalledcubicle [dot] com)

  Permission to use, copy, modify, distribute, and sell this
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
  software without specific, written prior permission.

  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, 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.
*/

/** \file
 *
 *  Main source file for the GenericHID demo. This file contains the main tasks of
 *  the demo and is responsible for the initial application hardware configuration.
 */

#include "GenericHID.h"
#include "webusb.h"
#include "Descriptors.h"
#include "MS_OS_20_Device.h"

/** Buffer to hold the previously generated HID report, for comparison purposes inside the HID class driver. */
static uint8_t PrevHIDReportBuffer[255]; 

/** LUFA HID Class driver interface configuration and state information. This structure is
 *  passed to all HID Class driver functions, so that multiple instances of the same class
 *  within a device can be differentiated from one another.
 */
USB_ClassInfo_HID_Device_t Generic_HID_Interface =
	{
		.Config =
			{
				.InterfaceNumber              = INTERFACE_ID_GenericHID,
				.ReportINEndpoint             =
					{
						.Address              = GENERIC_IN_EPADDR,
						.Size                 = GENERIC_EPSIZE,
						.Banks                = 1,
					},
				.PrevReportINBuffer           = PrevHIDReportBuffer,
				.PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),
			},
	};


/* the bootloader stuff */
uint32_t Boot_Key ATTR_NO_INIT;
void Bootloader_Jump_Check(void)
{
    // If the reset source was the bootloader and the key is correct, clear it and jump to the bootloader
    if ((MCUSR & (1 << WDRF)) && (Boot_Key == MAGIC_BOOT_KEY))
    {
		//overwrite boot key so that if the code that's loaded used the same location and value it will not re-bootload.
		//MCUSR &= 0 ; //~(1 << WDRF);
        Boot_Key = 0;
        ((void (*)(void))BOOTLOADER_START_ADDRESS)();
    }
}

void Jump_To_Bootloader(void)
{
    // If USB is used, detach from the bus and reset it
    //USB_Disable();
	USB_Detach();
    // Disable all interrupts
    cli();
    // Wait two seconds for the USB detachment to register on the host
    Delay_MS(1500);
    // Set the bootloader key to the magic value and force a reset
    Boot_Key = MAGIC_BOOT_KEY;
    wdt_enable(WDTO_500MS);
    for (;;);
}

/* end bootloader stuff*/

uint8_t send_raw;
uint8_t send_status;
uint8_t status_sent;

#define VALUE_TO_STRING(x) #x
#define VALUE(x) VALUE_TO_STRING(x)

/** Main program entry point. This routine contains the overall program flow, including initial
 *  setup of all components and the main program loop.
 */
int main(void)
{
	SetupHardware();
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
	GlobalInterruptEnable();
	buzzer_init();
	timer_init();
	box_init();
	adc_task();

	//Serial_Init(115200, 0);

	//could make a "box" struct with some function pointers but what's the point
	//TODO exactly how early can we do this? Definitely after ADC.
	box_type = determine_box_type();
	if (box_type == BOX_TYPE_PEGGY) {
		peggy_hardware();
		//TODO need to have autocalibration; grab it from operation
		read_peggy_thresholds();
	} else if (box_type == BOX_TYPE_POKEY) {
		pokey_init();
	}
	
	//TODO seed rng from adc read of unconnected line
	
	for (;;)
	{
		HID_Device_USBTask(&Generic_HID_Interface);
		USB_USBTask();
		adc_task();
		
		box_flash_handler();
		box_tick();
		if (box_type == BOX_TYPE_PEGGY) {
			peggy_stm_loop();
		} else if (box_type == BOX_TYPE_POKEY) {
			read_buttons(); // pokey
			pokey_loop();
			pokey_flash_handler();
		}
		
		
		//PORTB &= ~(1<<PB0); // written down to keep it down, not clear why
		
	}
}



/** Configures the board hardware and chip peripherals for the demo's functionality. */
void SetupHardware(void)
{
#if (ARCH == ARCH_AVR8)
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

	/* enable and configure ADC */
	ADCSRA |= (1<<ADPS2) | (1<<ADPS1) | (1<<ADPS0); /* sets clock division */ 
	ADCSRA |= (1<<ADEN); /*enable*/
	/* to select channel, write to ADMUX */

	ADMUX = (1<<REFS0) /*| (1<<REFS1)*/; /* set ref, arduino uses 1<<6 */

	/* Disable clock division */
	clock_prescale_set(clock_div_1);
	ADCSRA |= (1<<ADSC); /* do the longer first conversion */
	
#elif (ARCH == ARCH_XMEGA)
	/* Start the PLL to multiply the 2MHz RC oscillator to 32MHz and switch the CPU core to run from it */
	XMEGACLK_StartPLL(CLOCK_SRC_INT_RC2MHZ, 2000000, F_CPU);
	XMEGACLK_SetCPUClockSource(CLOCK_SRC_PLL);

	/* Start the 32MHz internal RC oscillator and start the DFLL to increase it to 48MHz using the USB SOF as a reference */
	XMEGACLK_StartInternalOscillator(CLOCK_SRC_INT_RC32MHZ);
	XMEGACLK_StartDFLL(CLOCK_SRC_INT_RC32MHZ, DFLL_REF_INT_USBSOF, F_USB);

	PMIC.CTRL = PMIC_LOLVLEN_bm | PMIC_MEDLVLEN_bm | PMIC_HILVLEN_bm;
#endif

	/* Hardware Initialization */
	LEDs_Init();
	USB_Init();
}

/** Event handler for the library USB Connection event. */
void EVENT_USB_Device_Connect(void)
{
	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
}

/** Event handler for the library USB Disconnection event. */
void EVENT_USB_Device_Disconnect(void)
{
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
}

/** Event handler for the library USB Configuration Changed event. */
void EVENT_USB_Device_ConfigurationChanged(void)
{
	bool ConfigSuccess = true;

	ConfigSuccess &= HID_Device_ConfigureEndpoints(&Generic_HID_Interface);

	USB_Device_EnableSOFEvents();

	LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
}

/** Microsoft OS 2.0 Descriptor. This is used by Windows to select the USB driver for the device.
 *
 *  For WebUSB in Chrome, the correct driver is WinUSB, which is selected via CompatibleID.
 *
 *  Additionally, while Chrome is built using libusb, a magic registry key needs to be set containing a GUID for
 *  the device.
 */
const MS_OS_20_Descriptor_t PROGMEM MS_OS_20_Descriptor =
{
	.Header =
		{
			.Length = CPU_TO_LE16(10),
			.DescriptorType = CPU_TO_LE16(MS_OS_20_SET_HEADER_DESCRIPTOR),
			.WindowsVersion = MS_OS_20_WINDOWS_VERSION,
			.TotalLength = CPU_TO_LE16(MS_OS_20_DESCRIPTOR_SET_TOTAL_LENGTH)
		},

	.CompatibleID =
		{
			.Length = CPU_TO_LE16(20),
			.DescriptorType = CPU_TO_LE16(MS_OS_20_FEATURE_COMPATBLE_ID),
			.CompatibleID = u8"WINUSB\x00", // Automatically null-terminated to 8 bytes
			.SubCompatibleID = {0, 0, 0, 0, 0, 0, 0, 0}
		}
};

/** URL descriptor string. This is a UTF-8 string containing a URL excluding the prefix. At least one of these must be
 * 	defined and returned when the Landing Page descriptor index is requested.
 */
const WebUSB_URL_Descriptor_t PROGMEM WebUSB_LandingPage = WEBUSB_URL_DESCRIPTOR(1, u8"www.xlms.org");

/** Event handler for the library USB Control Request reception event. */
void EVENT_USB_Device_ControlRequest(void)
{
	switch (USB_ControlRequest.bmRequestType) {
		/* Handle Vendor Requests for WebUSB & MS OS Descriptors */
		case (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE):
			Serial_SendString("Got Vendor Control Request:"); Serial_SendData(&USB_ControlRequest, sizeof(USB_ControlRequest)); Serial_SendByte(0x0A);
			/* Free the endpoint for the next Request */
			Endpoint_ClearSETUP();
			switch (USB_ControlRequest.bRequest) {
				case WEBUSB_VENDOR_CODE:
					switch (USB_ControlRequest.wIndex) {
						case WebUSB_RTYPE_GetURL:
							switch (USB_ControlRequest.wValue) {
								case WEBUSB_LANDING_PAGE_INDEX:
									/* Write the descriptor data to the control endpoint */
									Endpoint_Write_Control_PStream_LE(&WebUSB_LandingPage, WebUSB_LandingPage.Header.Size);
									/* Release the endpoint after transaction. */
									Endpoint_ClearOUT();
									break;
								default:    /* Stall transfer on invalid index. */
									Endpoint_StallTransaction();
									break;
							}
							break;
						default:    /* Stall on unknown WebUSB request */
							Endpoint_StallTransaction();
							break;
					}
					break;
				case MS_OS_20_VENDOR_CODE:
					switch (USB_ControlRequest.wIndex) {
						case MS_OS_20_DESCRIPTOR_INDEX:
//							Serial_SendString("Sending MS_OS_20_Descriptor:"); Serial_SendData(&MS_OS_20_Descriptor, MS_OS_20_DESCRIPTOR_SET_TOTAL_LENGTH); Serial_SendByte(0x0A);
//							Endpoint_Write_Control_Stream_LE(&MS_OS_20_Descriptor, MS_OS_20_DESCRIPTOR_SET_TOTAL_LENGTH);
							/* Write the descriptor data to the control endpoint */
							Endpoint_Write_Control_PStream_LE(&MS_OS_20_Descriptor, MS_OS_20_Descriptor.Header.TotalLength);
							/* Release the endpoint after transaction. */
							Endpoint_ClearOUT();
							break;
						default:    /* Stall on unknown MS OS 2.0 request */
							Endpoint_StallTransaction();
							break;
					}
					break;
				default:    /* Stall on unknown Vendor Code */
					Endpoint_StallTransaction();
					break;
			}
			break;
		default:
			HID_Device_ProcessControlRequest(&Generic_HID_Interface);
	}
}

/** Event handler for the USB device Start Of Frame event. */
void EVENT_USB_Device_StartOfFrame(void)
{
	HID_Device_MillisecondElapsed(&Generic_HID_Interface);
}

/** HID class driver callback function for the creation of HID reports to the host.
 *
 *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 *
 *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
 */
int times;
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
                                         uint8_t* const ReportID,
                                         const uint8_t ReportType,
                                         void* ReportData,
                                         uint16_t* const ReportSize)
{
	uint8_t* Data  = (uint8_t*)ReportData;
	//uint8_t  CurrLEDMask = LEDs_GetLEDs();
	//uint16_t cb_wValue;
	//const USB_Descriptor_String_t* str_addr = NULL;
	//const void** const cb_descriptoraddr = (void*) &str_addr;
	//const uint8_t* strchars;
	//uint16_t cb_strlen;
	//uint16_t strlen_rem;
	static int times;
	UNUSED(HIDInterfaceInfo);
	switch (ReportType) {
	case HID_REPORT_ITEM_Feature:
		if (*ReportID == MSG_CONFIG_ID) {
			//return the current timeout
			uint32_to_wire(timeout, Data);
			Data+=4;
			uint16_to_wire(wall_error_timeout, Data);
			Data+=2;
			if (box_type == BOX_TYPE_POKEY) {
				memcpy(Data, target_order, 10);
				*ReportSize = MSG_CONFIG_SIZE_POKEY;
			} else {
				*ReportSize = MSG_CONFIG_SIZE_PEGGY;
			}
			return true;
		} else if (*ReportID == 69) {
			Data[0] = get_box_type();
			*ReportSize = 1;
			return true;
		} else if (*ReportID == 70) {
			//TODO return hardware fault
		} else if (*ReportID == 71) {
			//return peg thresholds
			for (int i = 0; i < PEG_COUNT;i++)
				uint16_to_wire(pegs[i].thresh, &Data[2*i]);
			*ReportSize = 12;
			return true;
		}
		break;
	case HID_REPORT_ITEM_In:
		//send start, task success, end messages
		//send error messages
	
		if (send_status) {
			send_status = 0;
			status_sent = 1;
			//timestamp
			time_to_wire(host_millis(), Data);
			//status
			uint32_to_wire(status, Data+8);
			
			*ReportID = MSG_STATUS_ID;
			*ReportSize = MSG_STATUS_SIZE;
			return true;
		}
		// Eventbufs must be first because we cannot lose them and that will not happen if there is a connection
		//send event MSG_EVENT_ID
		//TODO FEATURE add output repot on this number that toggles sending these on or off
		if (0){//evtbuf.occupancy) {
			extract_event(&evtbuf, Data, MSG_EVENT_SIZE);
			*ReportID = MSG_EVENT_ID;
			*ReportSize = MSG_EVENT_SIZE;
			return true;
		}
		//send poke event on MSG_POKE_ID
		if (pokebuf.occupancy) {
			extract_poke(&pokebuf, Data, MSG_POKE_SIZE);
			*ReportID = MSG_POKE_ID;
			*ReportSize = MSG_POKE_SIZE;
			return true;
		}
		//send peg event on MSG_PEG_ID
		if (peg_msg_pending) {
			for (int i = 0; i < PEG_COUNT; i++) {
				uint8_t flag = (1<<i);
				if (peg_msg_pending & flag) {
					//stamp 8byte
					time_to_wire(peg_stamps[i],Data);
					//loc byte
					Data[8] = i;
					//newst byte
					Data[9] = !!(peg_msg_state & flag);
					peg_msg_pending &= ~flag;
					*ReportID = MSG_PEG_ID;
					*ReportSize = MSG_PEG_SIZE;
					return true;
				} else {
					//continue,it will be a later one
				}
			}
		}
		//send wall_error report on MSG_WALL_ERROR_ID
		if (werrbuf.occupancy) {
			extract_wall_error(&werrbuf, Data, MSG_WALL_ERROR_SIZE);
			*ReportID = MSG_WALL_ERROR_ID;
			*ReportSize = MSG_WALL_ERROR_SIZE;
			return true;
		}
		//send drop_error report on MSG_DROP_ERROR_ID
		if (derrbuf.occupancy) {
			extract_drop_error(&derrbuf, Data, MSG_DROP_ERROR_SIZE);
			*ReportID = MSG_DROP_ERROR_ID;
			*ReportSize = MSG_DROP_ERROR_SIZE;
			return true;
		}
		//send tool state transition event on MSG_TOOL_ID
		//this records whether it's in or out, not the tool state
		// don't send until status is sent, so that first response to timestamp is correct
		if (toolbuf.occupancy && status_sent) {
			extract_tool(&toolbuf, Data, MSG_TOOL_SIZE);
			*ReportID = MSG_TOOL_ID;
			*ReportSize = MSG_TOOL_SIZE;
			return true;
		}
		
		//if send_raw then send raw values on 69
		if (send_raw) { //implicitly nothing else needs to be sent now
			//ratelimit because chrome
			times++;
			if (times < 100) return false;
			times = 0;
			
			//send all 3 tool adcs
			uint16_to_wire(adc_values[TOOL_ERROR_LINE], Data+0);
			uint16_to_wire(adc_values[TOOL_HOLDER_LINE], Data+2);
			uint16_to_wire(adc_values[TOOL_CONNECTED_LINE], Data+4);
			
			Data+=6;
			
			//send all 6+1 peggy optic adcs
			uint16_to_wire(adc_values[0], Data+0);
			uint16_to_wire(adc_values[1], Data+2);
			uint16_to_wire(adc_values[4], Data+4);
			uint16_to_wire(adc_values[5], Data+6);
			uint16_to_wire(adc_values[6], Data+8);
			uint16_to_wire(adc_values[7], Data+10);
			uint16_to_wire(adc_values[DROP_ERROR_LINE], Data+12);
			
			Data += 14;
			
			//send all 10 pokey buttons
			memcpy(Data,button_values,10);
			
			*ReportSize = (3+7)*2 + 10;
			*ReportID = 69;
			return true;
		}
	}
	return false;
}

/** HID class driver callback function for the processing of HID reports from the host.
 *
 *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 *  \param[in] ReportID    Report ID of the received report from the host
 *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 *  \param[in] ReportSize  Size in bytes of the received HID report
 */
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
                                          const uint8_t ReportID,
                                          const uint8_t ReportType,
                                          const void* ReportData,
                                          const uint16_t ReportSize)
{
	uint8_t* Data = (uint8_t*)ReportData;
	//uint8_t  NewLEDMask = LEDS_NO_LEDS;
	UNUSED(HIDInterfaceInfo);
	UNUSED(ReportSize);
	switch (ReportType) {
	case HID_REPORT_ITEM_Feature:
		if (ReportID == START_BOOTLOADER_REPORT_ID) {
			//check that proper code was supplied
			//FIXME lol always succeed
			//start bootloader
			LEDs_SetAllLEDs(LEDS_LED1|LEDS_LED2|LEDS_LED3);
			Jump_To_Bootloader();
		} else if (ReportID == 69) {
			set_box_type(Data[0]);
		} else if (ReportID == MSG_CONFIG_ID) {
			//set timestamp, wall timeout, and task order
			timeout = uint32_from_wire(Data);
			Data+=4;
			wall_error_timeout = Data[0]<<8 | Data[1];
			Data+=2;
			if (box_type == BOX_TYPE_POKEY) {
				int allmax = 1;
				//check that these are actually 0-9
				for (int i = 0; i < 10; i++) {
					allmax = allmax && Data[i] == 0xff;
					if (Data[i] > 9)
						Data[i] = 0;
				}
				// If you send the same target twice in a row, it only counts as one because the second is completed in the same press. Not a bug.
				if (allmax) {
					// so that random generator will work, and easier than seeding off of an ADC line
					srand(millis());
					shuffle_order = 1;
				} else {
					memcpy(target_order, Data, 10);
				}
			}
		} else if (ReportID == 71) {
			//update peg thresholds in eeprom
			//hard 6 because it doesn't magically update if I change the number of pegs
			//PEG_COUNT so that looking for it will find that it is used here
			for (int i = 0; i < 6; i++) {
				pegs[i].thresh = uint16_from_wire(&Data[2*i]);
			}
			write_peggy_thresholds();
		}
		break;
	case HID_REPORT_ITEM_Out:
		//process commands from chrome app
		if (ReportID == TIMESTAMP_OFFSET_FR_ID) {
			TIME_t oset;
			oset = time_from_wire(Data);
			set_time_oset(oset);
			send_status = 1;
			lms_said_to_start = 1; // Also restarts the task completely.
			// TODO set a flag that controls box type auto-detection so that it doesn't run until there has been a message from a computer received. This will prevent bare boards incorrectly autoconfiguring themselves.
			// Fixup the timestamps of the tool buffer because one was being put in early. Direct call is much less space than funtion call.
			for (int i = 0; i < TOOL_BUFFER_SIZE;i++)
				toolbuf.stamps[i] += oset;
			
			// Do not send initial messages, but rather use status for that information. Because any messages in the "buffer" will not be sent, do not bother updating the timestamps
			peg_msg_pending = 0;
		} else if (ReportID == 69) {
			send_raw = !send_raw;
		}
		break;
	}
}