HID.c 10.8 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
31
32
33
/*
             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.
*/

#include "../../HighLevel/USBMode.h"
#if defined(USB_CAN_BE_HOST)

34
#define INCLUDE_FROM_HID_CLASS_HOST_C
35
36
#include "HID.h"

Dean Camera's avatar
Dean Camera committed
37
38
#warning The HID Host mode Class driver is currently incomplete and is for preview purposes only.

39
uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,
40
                                uint8_t* ConfigDescriptorData)
41
{
42
	uint8_t FoundEndpoints = 0;
43

44
45
	memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));

46
	if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
47
	  return HID_ENUMERROR_InvalidConfigDescriptor;
48
	
49
50
	USB_Descriptor_Interface_t* CurrentHIDInterface;
	
51
52
53
54
55
56
57
	do
	{
		if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
									  DComp_HID_Host_NextHIDInterface) != DESCRIPTOR_SEARCH_COMP_Found)
		{
			return HID_ENUMERROR_NoHIDInterfaceFound;
		}
58
59
60
61
62
		
		CurrentHIDInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);
	} while (HIDInterfaceInfo->Config.HIDInterfaceProtocol &&
	         (CurrentHIDInterface->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol));

63
	HIDInterfaceInfo->State.InterfaceNumber      = CurrentHIDInterface->InterfaceNumber;
64
	HIDInterfaceInfo->State.SupportsBootProtocol = (CurrentHIDInterface->SubClass != HID_NON_BOOT_PROTOCOL);
65

66
67
68
69
70
71
72
	if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, DComp_NextHID) != DESCRIPTOR_SEARCH_COMP_Found)
	{
		return HID_ENUMERROR_NoHIDDescriptorFound;
	}

	HIDInterfaceInfo->State.HIDReportSize = DESCRIPTOR_CAST(ConfigDescriptorData, USB_HID_Descriptor_t).HIDReportLength;

73
	while (FoundEndpoints != (HID_FOUND_DATAPIPE_IN | HID_FOUND_DATAPIPE_OUT))
74
75
	{
		if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
76
		                              DComp_HID_Host_NextHIDInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
77
		{
78
			if (FoundEndpoints & HID_FOUND_DATAPIPE_IN)
79
80
81
82
83
84
85
86
87
88
89
			  break;
				
			return HID_ENUMERROR_EndpointsNotFound;
		}
		
		USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);

		if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
		{
			Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
							   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
90
			HIDInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
91
			
92
			FoundEndpoints |= HID_FOUND_DATAPIPE_IN;
93
94
95
96
97
		}
		else
		{
			Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,
							   EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
98
			HIDInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
99
			
100
101
			HIDInterfaceInfo->State.DeviceUsesOUTPipe = true;
			
102
			FoundEndpoints |= HID_FOUND_DATAPIPE_OUT;		
103
104
105
		}
	}

106
	HIDInterfaceInfo->State.IsActive = true;
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
	return HID_ENUMERROR_NoError;
}

static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor)
{
	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
	{
		USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
		                                                                USB_Descriptor_Interface_t);
	
		if (CurrentInterface->Class == HID_INTERFACE_CLASS)
		  return DESCRIPTOR_SEARCH_Found;
	}
	
	return DESCRIPTOR_SEARCH_NotFound;
}

124
125
126
127
128
129
130
131
132
133
static uint8_t DComp_NextHID(void* CurrentDescriptor)
{
	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_HID)
	  return DESCRIPTOR_SEARCH_Found;
	else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
	  return DESCRIPTOR_SEARCH_Fail;
	else
	  return DESCRIPTOR_SEARCH_NotFound;	  
}

134
static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor)
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
{
	if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
	{
		USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
		                                                              USB_Descriptor_Endpoint_t);	

		if (!(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress)))
		  return DESCRIPTOR_SEARCH_Found;
	}
	else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
	{
		return DESCRIPTOR_SEARCH_Fail;
	}

	return DESCRIPTOR_SEARCH_NotFound;
}

152
void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
153
154
155
156
{

}

157
158
uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const bool ControlRequest,
                               uint8_t* ReportID, void* Buffer)
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
{
	if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
	  return false;

	if (ControlRequest)
	{
		USB_ControlRequest = (USB_Request_Header_t)
		{
			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
			.bRequest      = REQ_SetReport,
			.wValue        = *ReportID,
			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
			.wLength       = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, *ReportID, REPORT_ITEM_TYPE_In),
		};

		Pipe_SelectPipe(PIPE_CONTROLPIPE);
		
		return USB_Host_SendControlRequest(Buffer);
	}
	else
	{
		uint8_t ErrorCode;
	
		Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);
		Pipe_Unfreeze();
		
		uint16_t ReportSize;

		if (HIDInterfaceInfo->State.UsingBootProtocol)
		{
			ReportSize = Pipe_BytesInPipe();
		}
		else
		{
			if (HIDInterfaceInfo->Config.HIDParserData->UsingReportIDs)
				*ReportID = Pipe_Read_Byte();
			else
				*ReportID = 0;
			
			ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, *ReportID, REPORT_ITEM_TYPE_In);
		}

		if ((ErrorCode = Pipe_Read_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
		  return ErrorCode;
203
204
		 
		Pipe_ClearIN();		
205
206
207
208
209
210
		Pipe_Freeze();
		
		return PIPE_RWSTREAM_NoError;		
	}
}

211
212
uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint8_t ReportID, void* Buffer,
                            const uint16_t ReportSize)
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
{
	if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
	  return false;
	  
	if (HIDInterfaceInfo->State.DeviceUsesOUTPipe)
	{
		USB_ControlRequest = (USB_Request_Header_t)
		{
			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
			.bRequest      = REQ_SetReport,
			.wValue        = ReportID,
			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
			.wLength       = ReportSize,
		};

		Pipe_SelectPipe(PIPE_CONTROLPIPE);
		
		return USB_Host_SendControlRequest(Buffer);
	}
	else
	{
		uint8_t ErrorCode;
	
		Pipe_SelectPipe(HIDInterfaceInfo->Config.DataOUTPipeNumber);
		Pipe_Unfreeze();
		
		if (ReportID)
		  Pipe_Write_Stream_LE(&ReportID, sizeof(ReportID), NO_STREAM_CALLBACK);
		
		if ((ErrorCode = Pipe_Write_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
		  return ErrorCode;
		
245
		Pipe_ClearOUT();
246
247
248
249
250
251
		Pipe_Freeze();
		
		return PIPE_RWSTREAM_NoError;
	}
}

252
bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
253
{
254
	if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
255
256
	  return false;

257
258
	bool ReportReceived;

259
	Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);
260
261
	Pipe_Unfreeze();
	
262
	ReportReceived = Pipe_IsINReceived();
263
264
	
	Pipe_Freeze();
265
	
266
	return ReportReceived;
267
268
}

269
uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
270
{
271
272
	uint8_t ErrorCode;

273
274
275
276
	USB_ControlRequest = (USB_Request_Header_t)
		{
			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
			.bRequest      = REQ_SetProtocol,
277
			.wValue        = 0,
278
279
280
281
282
283
			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
			.wLength       = 0,
		};

	Pipe_SelectPipe(PIPE_CONTROLPIPE);
	
284
	if (!(HIDInterfaceInfo->State.SupportsBootProtocol))
285
	  return HID_ERROR_LOGICAL;
286

287
	if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
288
289
290
	  return ErrorCode;

	HIDInterfaceInfo->State.UsingBootProtocol = true;
291
	
292
	return HOST_SENDCONTROL_Successful;
293
294
}

295
uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
{
	uint8_t ErrorCode;

	uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];
	
	USB_ControlRequest = (USB_Request_Header_t)
		{
			.bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),
			.bRequest      = REQ_GetDescriptor,
			.wValue        = (DTYPE_Report << 8),
			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
			.wLength       = HIDInterfaceInfo->State.HIDReportSize,
		};

	Pipe_SelectPipe(PIPE_CONTROLPIPE);

	if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)
	  return ErrorCode;
	  
	USB_ControlRequest = (USB_Request_Header_t)
		{
			.bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
			.bRequest      = REQ_SetProtocol,
319
			.wValue        = 1,
320
321
322
323
324
325
326
			.wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
			.wLength       = 0,
		};

	if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
	  return ErrorCode;

327
328
	HIDInterfaceInfo->State.UsingBootProtocol = false;
	
329
330
331
332
333
334
335
336
	if (HIDInterfaceInfo->Config.HIDParserData == NULL)
	  return HID_ERROR_LOGICAL;
	  
	if ((ErrorCode = USB_ProcessHIDReport(HIDReportData, HIDInterfaceInfo->State.HIDReportSize,
	                                      HIDInterfaceInfo->Config.HIDParserData)) != HID_PARSE_Successful)
	{
		return HID_ERROR_LOGICAL | ErrorCode;
	}
337

338
339
340
	return 0;
}

341
#endif