HIDParser.c 11.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*
             LUFA Library
     Copyright (C) Dean Camera, 2009.
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

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

  Permission to use, copy, modify, and distribute this software
  and its documentation for any purpose and without fee is hereby
  granted, 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.
*/

Dean Camera's avatar
Dean Camera committed
31
32
33
#include "../../HighLevel/USBMode.h"
#if defined(USB_CAN_BE_HOST)

34
35
#include "HIDParser.h"

36
uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)
37
{
38
39
	HID_StateTable_t      StateTable[HID_STATETABLE_STACK_DEPTH];
	HID_StateTable_t*     CurrStateTable          = &StateTable[0];
40
	HID_CollectionPath_t* CurrCollectionPath      = NULL;
41
	HID_ReportSizeInfo_t* CurrReportIDInfo        = &ParserData->ReportIDSizes[0];			
42
43
	uint16_t              UsageStack[HID_USAGE_STACK_DEPTH];
	uint8_t               UsageStackSize          = 0;
44

45
46
47
	ParserData->TotalReportItems   = 0;
	ParserData->TotalDeviceReports = 1;
	ParserData->UsingReportIDs     = false;
48
49
50
51
	
	for (uint8_t CurrCollection = 0; CurrCollection < HID_MAX_COLLECTIONS; CurrCollection++)
	  ParserData->CollectionPaths[CurrCollection].Parent = NULL;

52
53
	memset(CurrStateTable,   0x00, sizeof(HID_StateTable_t));
	memset(CurrReportIDInfo, 0x00, sizeof(HID_ReportSizeInfo_t));
54
55
56

	while (ReportSize)
	{
57
		uint8_t  HIDReportItem  = *ReportData;
58
59
		uint32_t ReportItemData = 0;
		
60
		ReportData++;
61
62
63
		ReportSize--;
		
		switch (HIDReportItem & DATA_SIZE_MASK)
64
65
		{
			case DATA_SIZE_4:
66
67
68
				ReportItemData  = *((uint32_t*)ReportData);
				ReportSize     -= 4;
				ReportData     += 4;
69
70
				break;
			case DATA_SIZE_2:
71
72
73
				ReportItemData  = *((uint16_t*)ReportData);
				ReportSize     -= 2;
				ReportData     += 2;
74
75
				break;
			case DATA_SIZE_1:
76
77
78
				ReportItemData  = *((uint8_t*)ReportData);
				ReportSize     -= 1;
				ReportData     += 1;
79
80
81
				break;
		}

82
		switch (HIDReportItem & (TYPE_MASK | TAG_MASK))
83
84
		{
			case (TYPE_GLOBAL | TAG_GLOBAL_PUSH):
85
				if (CurrStateTable == &StateTable[HID_STATETABLE_STACK_DEPTH - 1])
86
87
				  return HID_PARSE_HIDStackOverflow;
	
88
89
				memcpy((CurrStateTable + 1),
				       CurrStateTable,
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
				       sizeof(HID_ReportItem_t));

				CurrStateTable++;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_POP):
				if (CurrStateTable == &StateTable[0])
				  return HID_PARSE_HIDStackUnderflow;
				  
				CurrStateTable--;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_USAGEPAGE):
				CurrStateTable->Attributes.Usage.Page       = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_LOGICALMIN):
				CurrStateTable->Attributes.Logical.Minimum  = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_LOGICALMAX):
				CurrStateTable->Attributes.Logical.Maximum  = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_PHYSMIN):
				CurrStateTable->Attributes.Physical.Minimum = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_PHYSMAX):
				CurrStateTable->Attributes.Physical.Maximum = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_UNITEXP):
				CurrStateTable->Attributes.Unit.Exponent    = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_UNIT):
				CurrStateTable->Attributes.Unit.Type        = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_REPORTSIZE):
				CurrStateTable->Attributes.BitSize          = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_REPORTCOUNT):
				CurrStateTable->ReportCount                 = ReportItemData;
				break;
			case (TYPE_GLOBAL | TAG_GLOBAL_REPORTID):
				CurrStateTable->ReportID                    = ReportItemData;
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

				if (ParserData->UsingReportIDs)
				{
					CurrReportIDInfo = NULL;

					for (uint8_t i = 0; i < ParserData->TotalDeviceReports; i++)
					{
						if (ParserData->ReportIDSizes[i].ReportID == CurrStateTable->ReportID)
						{
							CurrReportIDInfo = &ParserData->ReportIDSizes[i];
							break;
						}
					}
					
					if (CurrReportIDInfo == NULL)
					{
						if (ParserData->TotalDeviceReports++ > HID_MAX_REPORT_IDS)
						  return HID_PARSE_InsufficientReportIDItems;
					
						CurrReportIDInfo = &ParserData->ReportIDSizes[ParserData->TotalDeviceReports - 1];
						memset(CurrReportIDInfo, 0x00, sizeof(HID_ReportSizeInfo_t));
					}
				}

				ParserData->UsingReportIDs = true;				

				CurrReportIDInfo->ReportID     = CurrStateTable->ReportID;
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
				break;
			case (TYPE_LOCAL | TAG_LOCAL_USAGE):
				if (UsageStackSize == HID_USAGE_STACK_DEPTH)
				  return HID_PARSE_UsageStackOverflow;
			
				UsageStack[UsageStackSize++] = ReportItemData;
				break;
			case (TYPE_LOCAL | TAG_LOCAL_USAGEMIN):
				CurrStateTable->Attributes.Usage.MinMax.Minimum = ReportItemData;
				break;
			case (TYPE_LOCAL | TAG_LOCAL_USAGEMAX):
				CurrStateTable->Attributes.Usage.MinMax.Maximum = ReportItemData;
				break;
			case (TYPE_MAIN | TAG_MAIN_COLLECTION):
				if (CurrCollectionPath == NULL)
				{
					CurrCollectionPath = &ParserData->CollectionPaths[0];
				}
				else
				{
					HID_CollectionPath_t* ParentCollectionPath = CurrCollectionPath;
			
					CurrCollectionPath = &ParserData->CollectionPaths[1];

					while (CurrCollectionPath->Parent != NULL);
					{
182
						if (CurrCollectionPath == &ParserData->CollectionPaths[HID_MAX_COLLECTIONS - 1])
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
						  return HID_PARSE_InsufficientCollectionPaths;
					
						CurrCollectionPath++;
					}

					CurrCollectionPath->Parent = ParentCollectionPath;
				}
				
				CurrCollectionPath->Type = ReportItemData;
				CurrCollectionPath->Usage.Page = CurrStateTable->Attributes.Usage.Page;
				
				if (UsageStackSize)
				{
					CurrCollectionPath->Usage.Usage = UsageStack[0];

					for (uint8_t i = 0; i < UsageStackSize; i++)
					  UsageStack[i] = UsageStack[i + 1];
					  
					UsageStackSize--;
				}
				else
				{
					CurrCollectionPath->Usage.Usage = 0;
				}
				
				break;
			case (TYPE_MAIN | TAG_MAIN_ENDCOLLECTION):
				if (CurrCollectionPath == NULL)
				  return HID_PARSE_UnexpectedEndCollection;
		
				CurrCollectionPath = CurrCollectionPath->Parent;

				break;
			case (TYPE_MAIN | TAG_MAIN_INPUT):
			case (TYPE_MAIN | TAG_MAIN_OUTPUT):
			case (TYPE_MAIN | TAG_MAIN_FEATURE):
219
220
				uint8_t Count = CurrStateTable->ReportCount;
				for (uint8_t ReportItemNum = 0; ReportItemNum < Count; ReportItemNum++)
221
				{
222
					HID_ReportItem_t NewReportItem;
223
				  
224
					memcpy(&NewReportItem.Attributes,
225
226
227
					       &CurrStateTable->Attributes,
					       sizeof(HID_ReportItem_Attributes_t));

228
229
230
					NewReportItem.ItemFlags      = ReportItemData;
					NewReportItem.CollectionPath = CurrCollectionPath;
					NewReportItem.ReportID       = CurrStateTable->ReportID;
231
232
233

					if (UsageStackSize)
					{
234
						NewReportItem.Attributes.Usage.Usage = UsageStack[0];
235
236
237
238
239
240
241
242

						for (uint8_t i = 0; i < UsageStackSize; i++)
						  UsageStack[i] = UsageStack[i + 1];
						  
						UsageStackSize--;
					}
					else
					{
243
						NewReportItem.Attributes.Usage.Usage = 0;
244
					}
245
246
247

					uint8_t ReportSizeIndex = 0;

248
					switch (HIDReportItem & TAG_MASK)
249
250
					{
						case TAG_MAIN_INPUT:
251
							NewReportItem.ItemType  = REPORT_ITEM_TYPE_In;
252
							NewReportItem.BitOffset = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_In];
253
								
254
							ReportSizeIndex = REPORT_ITEM_TYPE_In;
255
256
							break;
						case TAG_MAIN_OUTPUT:
257
							NewReportItem.ItemType  = REPORT_ITEM_TYPE_Out;
258
							NewReportItem.BitOffset = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Out];
259
								
260
							ReportSizeIndex = REPORT_ITEM_TYPE_Out;
261
262
							break;
						case TAG_MAIN_FEATURE:
263
							NewReportItem.ItemType  = REPORT_ITEM_TYPE_Feature;						
264
							NewReportItem.BitOffset = CurrReportIDInfo->ReportSizeBits[REPORT_ITEM_TYPE_Feature];
265
								
266
							ReportSizeIndex = REPORT_ITEM_TYPE_Feature;
267
268
							break;
					}
269
270
					
					CurrReportIDInfo->ReportSizeBits[ReportSizeIndex] += CurrStateTable->Attributes.BitSize;
271

272
273
274
					if (ParserData->LargestReportSizeBits < CurrReportIDInfo->ReportSizeBits[ReportSizeIndex])
					  ParserData->LargestReportSizeBits = CurrReportIDInfo->ReportSizeBits[ReportSizeIndex];
					
275
276
277
278
279
280
281
					if (!(ReportItemData & IOF_CONSTANT) && CALLBACK_HIDParser_FilterHIDReportItem(&CurrStateTable->Attributes))
					{					
						if (ParserData->TotalReportItems == HID_MAX_REPORTITEMS)
						  return HID_PARSE_InsufficientReportItems;
					
						memcpy(&ParserData->ReportItems[ParserData->TotalReportItems],
						       &NewReportItem, sizeof(HID_ReportItem_t));
282
					
283
284
						ParserData->TotalReportItems++;
					}
285
286
287
288
289
290
291
				}
				
				UsageStackSize = 0;
				
				break;
		}
	  
292
		if ((HIDReportItem & TYPE_MASK) == TYPE_MAIN)
293
294
295
296
297
298
299
		{
			CurrStateTable->Attributes.Usage.MinMax.Minimum = 0;
			CurrStateTable->Attributes.Usage.MinMax.Maximum = 0;
			UsageStackSize = 0;
		}
	}
	
300
301
302
	if (!(ParserData->TotalReportItems))
	  return HID_PARSE_NoUnfilteredReportItems;
	
303
304
305
	return HID_PARSE_Successful;
}

306
bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
{
	uint16_t DataBitsRem  = ReportItem->Attributes.BitSize;
	uint16_t CurrentBit   = ReportItem->BitOffset;
	uint32_t BitMask      = (1 << 0);

	ReportItem->Value = 0;
	
	if (ReportItem->ReportID)
	{
		if (ReportItem->ReportID != ReportData[0])
		  return false;

		ReportData++;
	}

	while (DataBitsRem--)
	{
		if (ReportData[CurrentBit / 8] & (1 << (CurrentBit % 8)))
		  ReportItem->Value |= BitMask;
		
		CurrentBit++;
		BitMask <<= 1;
	}
	
	return true;
}

334
void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
{
	uint16_t DataBitsRem  = ReportItem->Attributes.BitSize;
	uint16_t CurrentBit   = ReportItem->BitOffset;
	uint32_t BitMask      = (1 << 0);

	if (ReportItem->ReportID)
	{
		ReportData[0] = ReportItem->ReportID;
		ReportData++;
	}

	while (DataBitsRem--)
	{
		if (ReportItem->Value & (1 << (CurrentBit % 8)))
		  ReportData[CurrentBit / 8] |= BitMask;

		CurrentBit++;
		BitMask <<= 1;
	}
}
355

356
uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData, const uint8_t ReportID, const uint8_t ReportType)
357
358
359
360
{
	for (uint8_t i = 0; i < HID_MAX_REPORT_IDS; i++)
	{
		if (ParserData->ReportIDSizes[i].ReportID == ReportID)
361
		  return ParserData->ReportIDSizes[i].ReportSizeBits[ReportType];
362
363
364
365
366
	}

	return 0;
}

367
#endif