HIDParser.c 10.6 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
	uint16_t              UsageList[HID_USAGE_STACK_DEPTH];
43
44
	uint8_t               UsageListSize           = 0;
	HID_MinMax_t          UsageMinMax             = {0, 0};
45

46
	memset(ParserData,       0x00, sizeof(HID_ReportInfo_t));
47
48
	memset(CurrStateTable,   0x00, sizeof(HID_StateTable_t));
	memset(CurrReportIDInfo, 0x00, sizeof(HID_ReportSizeInfo_t));
49

50
51
	ParserData->TotalDeviceReports = 1;	

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

79
		switch (HIDReportItem & (TYPE_MASK | TAG_MASK))
80
81
		{
			case (TYPE_GLOBAL | TAG_GLOBAL_PUSH):
82
				if (CurrStateTable == &StateTable[HID_STATETABLE_STACK_DEPTH - 1])
83
84
				  return HID_PARSE_HIDStackOverflow;
	
85
86
				memcpy((CurrStateTable + 1),
				       CurrStateTable,
87
88
89
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
				       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;
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

				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)
					{
142
						if (ParserData->TotalDeviceReports == HID_MAX_REPORT_IDS)
143
144
						  return HID_PARSE_InsufficientReportIDItems;
					
145
						CurrReportIDInfo = &ParserData->ReportIDSizes[ParserData->TotalDeviceReports++];
146
147
148
149
150
151
						memset(CurrReportIDInfo, 0x00, sizeof(HID_ReportSizeInfo_t));
					}
				}

				ParserData->UsingReportIDs = true;				

152
				CurrReportIDInfo->ReportID = CurrStateTable->ReportID;
153
154
				break;
			case (TYPE_LOCAL | TAG_LOCAL_USAGE):
155
156
				if (UsageListSize == HID_USAGE_STACK_DEPTH)
				  return HID_PARSE_UsageListOverflow;
157
			
158
				UsageList[UsageListSize++] = ReportItemData;
159
160
				break;
			case (TYPE_LOCAL | TAG_LOCAL_USAGEMIN):
161
				UsageMinMax.Minimum = ReportItemData;
162
163
				break;
			case (TYPE_LOCAL | TAG_LOCAL_USAGEMAX):
164
				UsageMinMax.Maximum = ReportItemData;
165
166
167
168
169
170
171
172
173
174
175
176
				break;
			case (TYPE_MAIN | TAG_MAIN_COLLECTION):
				if (CurrCollectionPath == NULL)
				{
					CurrCollectionPath = &ParserData->CollectionPaths[0];
				}
				else
				{
					HID_CollectionPath_t* ParentCollectionPath = CurrCollectionPath;
			
					CurrCollectionPath = &ParserData->CollectionPaths[1];

177
					while (CurrCollectionPath->Parent != NULL)
178
					{
179
						if (CurrCollectionPath == &ParserData->CollectionPaths[HID_MAX_COLLECTIONS - 1])
180
181
182
183
184
185
186
187
188
189
190
						  return HID_PARSE_InsufficientCollectionPaths;
					
						CurrCollectionPath++;
					}

					CurrCollectionPath->Parent = ParentCollectionPath;
				}
				
				CurrCollectionPath->Type = ReportItemData;
				CurrCollectionPath->Usage.Page = CurrStateTable->Attributes.Usage.Page;
				
191
				if (UsageListSize)
192
				{
193
					CurrCollectionPath->Usage.Usage = UsageList[0];
194

195
196
					for (uint8_t i = 0; i < UsageListSize; i++)
					  UsageList[i] = UsageList[i + 1];
197
					  
198
					UsageListSize--;
199
				}
200
201
202
203
				else if (UsageMinMax.Minimum <= UsageMinMax.Maximum)
				{
					CurrCollectionPath->Usage.Usage = UsageMinMax.Minimum++;
				}
204
205
206
207
208
209
210
211
212
213
214
				
				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):
215
				for (uint8_t ReportItemNum = 0; ReportItemNum < CurrStateTable->ReportCount; ReportItemNum++)
216
				{
217
					HID_ReportItem_t NewReportItem;
218
				  
219
					memcpy(&NewReportItem.Attributes,
220
221
222
					       &CurrStateTable->Attributes,
					       sizeof(HID_ReportItem_Attributes_t));

223
224
225
					NewReportItem.ItemFlags      = ReportItemData;
					NewReportItem.CollectionPath = CurrCollectionPath;
					NewReportItem.ReportID       = CurrStateTable->ReportID;
226

227
					if (UsageListSize)
228
					{
229
						NewReportItem.Attributes.Usage.Usage = UsageList[0];
230

231
232
						for (uint8_t i = 0; i < UsageListSize; i++)
						  UsageList[i] = UsageList[i + 1];
233
						  
234
						UsageListSize--;
235
					}
236
237
238
239
240
					else if (UsageMinMax.Minimum <= UsageMinMax.Maximum)
					{
						CurrCollectionPath->Usage.Usage = UsageMinMax.Minimum++;
					}
				
241
242
243
244
245
246
247
248
					uint8_t ItemTag = (HIDReportItem & TAG_MASK);

					if (ItemTag == TAG_MAIN_INPUT)
					  NewReportItem.ItemType = REPORT_ITEM_TYPE_In;
					else if (ItemTag == TAG_MAIN_OUTPUT)
					  NewReportItem.ItemType = REPORT_ITEM_TYPE_Out;
					else
					  NewReportItem.ItemType = REPORT_ITEM_TYPE_Feature;
249
					
250
251
252
					NewReportItem.BitOffset = CurrReportIDInfo->ReportSizeBits[NewReportItem.ItemType];

					CurrReportIDInfo->ReportSizeBits[NewReportItem.ItemType] += CurrStateTable->Attributes.BitSize;
253

254
255
					if (ParserData->LargestReportSizeBits < NewReportItem.BitOffset)
					  ParserData->LargestReportSizeBits = NewReportItem.BitOffset;
256
					
257
					if (!(ReportItemData & IOF_CONSTANT) && CALLBACK_HIDParser_FilterHIDReportItem(&NewReportItem))
258
259
260
261
262
263
					{					
						if (ParserData->TotalReportItems == HID_MAX_REPORTITEMS)
						  return HID_PARSE_InsufficientReportItems;
					
						memcpy(&ParserData->ReportItems[ParserData->TotalReportItems],
						       &NewReportItem, sizeof(HID_ReportItem_t));
264
					
265
266
						ParserData->TotalReportItems++;
					}
267
268
269
270
271
				}
				
				break;
		}
	  
272
		if ((HIDReportItem & TYPE_MASK) == TYPE_MAIN)
273
		{
274
275
276
			UsageMinMax.Minimum = 0;
			UsageMinMax.Maximum = 0;
			UsageListSize   = 0;
277
278
279
		}
	}
	
280
281
282
	if (!(ParserData->TotalReportItems))
	  return HID_PARSE_NoUnfilteredReportItems;
	
283
284
285
	return HID_PARSE_Successful;
}

286
bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
287
288
289
290
291
{
	uint16_t DataBitsRem  = ReportItem->Attributes.BitSize;
	uint16_t CurrentBit   = ReportItem->BitOffset;
	uint32_t BitMask      = (1 << 0);

292
	ReportItem->PreviousValue = ReportItem->Value;
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
	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;
}

315
void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
316
317
318
319
320
321
322
323
324
325
326
{
	uint16_t DataBitsRem  = ReportItem->Attributes.BitSize;
	uint16_t CurrentBit   = ReportItem->BitOffset;
	uint32_t BitMask      = (1 << 0);

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

327
328
	ReportItem->PreviousValue = ReportItem->Value;

329
330
331
332
333
334
335
336
337
	while (DataBitsRem--)
	{
		if (ReportItem->Value & (1 << (CurrentBit % 8)))
		  ReportData[CurrentBit / 8] |= BitMask;

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

339
uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData, const uint8_t ReportID, const uint8_t ReportType)
340
341
342
343
{
	for (uint8_t i = 0; i < HID_MAX_REPORT_IDS; i++)
	{
		if (ParserData->ReportIDSizes[i].ReportID == ReportID)
344
		  return ParserData->ReportIDSizes[i].ReportSizeBits[ReportType];
345
346
347
348
349
	}

	return 0;
}

350
#endif