qmk_firmware/Demos/Device/Incomplete/Sideshow/Lib/SideshowCommon.h

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

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

/*
  Copyright 2010  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 disclaim 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.
*/

#ifndef _SIDESHOW_COMMON_H_
#define _SIDESHOW_COMMON_H_

	/* Includes: */
		#include <avr/io.h>
		#include <string.h>

		#include <LUFA/Drivers/USB/USB.h>

	/* Macros: */
		#define GUID_COMPARE(a, b)                (memcmp(a, b, sizeof(GUID_t)) == 0)

		#define ARRAY_ELEMENTS(x)                 (sizeof(x) / sizeof(x[0]))

		#define UNICODE_STRING_t(x)               struct                          \
		                                          {                               \
		                                              uint16_t LengthInBytes;     \
		                                              int      UnicodeString[x];  \
		                                          }

		// {A33F248B-882F-4531-82C2-ED3B90C5C520}
		#define STANDARD_PROTOCOL_GUID            {0xA33F248B, 0x4531882F, 0x3BEDC282, 0x20C5C590}
		// {A9A5353F-2D4B-47CE-93EE-759F3A7DDA4F}
		#define SIMPLE_CONTENT_FORMAT_GUID        {0xA9A5353F, 0x47CE2D4B, 0x9F75EE93, 0x4FDA7D3A}
		// {8ABC88A8-857B-4ad7-A35A-B5942F492B99}
		#define SIDESHOW_PROPERTY_GUID            {0x8ABC88A8, 0x4AD7857B, 0x94B55AA3, 0x992B492F}
		// {26D4979A-E643-4626-9E2B-736DC0C92FDC}
		#define DEVICE_PROPERTY_GUID              {0x26D4979A, 0x4626E643, 0x6D732B9E, 0xDC2FC9C0}

		#define SECURITY_INTERACTIVE_RID_SID      L"S-1-5-4"

		#define MAX_APPLICATIONS                  4
		#define MAX_CONTENTBUFFER_PER_APP         1024

	/* Type Defines: */
		typedef struct
		{
			uint32_t         Chunks[4];
		} GUID_t;

		typedef struct
		{
			uint16_t         LengthInBytes;
			int              UnicodeString[];
		} Unicode_String_t;

		typedef union
		{
			uint32_t TypeLong;

			struct
			{
				uint8_t TypeBytes[3];

				int ErrorCode     : 6;
				int NAK           : 1;
				int Response      : 1;
			} TypeFields;
		} SideShowPacketType_t;

		typedef struct
		{
			uint32_t               Length;
			SideShowPacketType_t   Type;
			uint16_t               Number;
		} SideShow_PacketHeader_t;

	/* Function Prototypes: */
		uint16_t SideShow_Read_Unicode_String(void* UnicodeString,
		                                      const uint16_t MaxBytes);
		void     SideShow_Write_Unicode_String(void* UnicodeString);
		void     SideShow_Discard_Byte_Stream(void);

#endif