Blame view

Hardware/Demos/Device/Incomplete/TestAndMeasurement/TestAndMeasurement.c 14.3 KB
8b438d9c   root   Harmonisation ava...
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
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
126
127
128
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
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
182
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
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
  /*
               LUFA Library
       Copyright (C) Dean Camera, 2017.
  
    dean [at] fourwalledcubicle [dot] com
             www.lufa-lib.org
  */
  
  /*
    Copyright 2017  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.
  */
  
  #include "TestAndMeasurement.h"
  
  /** Contains the (usually static) capabilities of the TMC device. This table is requested by the
   *  host upon enumeration to give it information on what features of the Test and Measurement USB
   *  Class the device supports.
   */
  TMC_Capabilities_t Capabilities =
  	{
  		.Status     = TMC_STATUS_SUCCESS,
  		.TMCVersion = VERSION_BCD(1.00),
  
  		.Interface  =
  			{
  				.ListenOnly             = false,
  				.TalkOnly               = false,
  				.PulseIndicateSupported = false,
  			},
  
  		.Device     =
  			{
  				.SupportsAbortINOnMatch = false,
  			},
  	};
  
  /** Current TMC control request that is being processed */
  static uint8_t RequestInProgress = 0;
  
  /** Stream callback abort flag for bulk IN data */
  static bool IsTMCBulkINReset = false;
  
  /** Stream callback abort flag for bulk OUT data */
  static bool IsTMCBulkOUTReset = false;
  
  /** Last used tag value for data transfers */
  static uint8_t CurrentTransferTag = 0;
  
  /** Length of last data transfer, for reporting to the host in case an in-progress transfer is aborted */
  static uint16_t LastTransferLength = 0;
  
  /** Buffer to hold the next message to sent to the TMC host */
  static uint8_t NextResponseBuffer[64];
  
  /** Indicates the length of the next response to send */
  static uint8_t NextResponseLen;
  
  /** 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();
  
  	for (;;)
  	{
  		TMC_Task();
  		USB_USBTask();
  	}
  }
  
  /** 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();
  
  	/* Disable clock division */
  	clock_prescale_set(clock_div_1);
  #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 USB_Connect event. This indicates that the device is enumerating via the status LEDs and
   *  starts the library USB task to begin the enumeration and USB management process.
   */
  void EVENT_USB_Device_Connect(void)
  {
  	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  }
  
  /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
   *  the status LEDs and stops the USB management and CDC management tasks.
   */
  void EVENT_USB_Device_Disconnect(void)
  {
  	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  }
  
  /** Event handler for the USB_ConfigurationChanged event. This is fired when the host set the current configuration
   *  of the USB device after enumeration - the device endpoints are configured and the CDC management task started.
   */
  void EVENT_USB_Device_ConfigurationChanged(void)
  {
  	bool ConfigSuccess = true;
  
  	/* Setup TMC In, Out and Notification Endpoints */
  	ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_NOTIFICATION_EPADDR, EP_TYPE_INTERRUPT, TMC_IO_EPSIZE, 1);
  	ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_IN_EPADDR,  EP_TYPE_BULK, TMC_IO_EPSIZE, 1);
  	ConfigSuccess &= Endpoint_ConfigureEndpoint(TMC_OUT_EPADDR, EP_TYPE_BULK, TMC_IO_EPSIZE, 1);
  
  	/* Indicate endpoint configuration success or failure */
  	LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
  }
  
  /** Event handler for the USB_ControlRequest event. This is used to catch and process control requests sent to
   *  the device from the USB host before passing along unhandled control requests to the library for processing
   *  internally.
   */
  void EVENT_USB_Device_ControlRequest(void)
  {
  	uint8_t TMCRequestStatus = TMC_STATUS_SUCCESS;
  
  	/* Process TMC specific control requests */
  	switch (USB_ControlRequest.bRequest)
  	{
  		case Req_InitiateAbortBulkOut:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))
  			{
  				/* Check that no split transaction is already in progress and the data transfer tag is valid */
  				if (RequestInProgress != 0)
  				{
  					TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;
  				}
  				else if (USB_ControlRequest.wValue != CurrentTransferTag)
  				{
  					TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS;
  				}
  				else
  				{
  					/* Indicate that all in-progress/pending data OUT requests should be aborted */
  					IsTMCBulkOUTReset = true;
  
  					/* Save the split request for later checking when a new request is received */
  					RequestInProgress = Req_InitiateAbortBulkOut;
  				}
  
  				Endpoint_ClearSETUP();
  
  				/* Write the request response byte */
  				Endpoint_Write_8(TMCRequestStatus);
  
  				Endpoint_ClearIN();
  				Endpoint_ClearStatusStage();
  			}
  
  			break;
  		case Req_CheckAbortBulkOutStatus:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))
  			{
  				/* Check that an ABORT BULK OUT transaction has been requested and that the request has completed */
  				if (RequestInProgress != Req_InitiateAbortBulkOut)
  				  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;
  				else if (IsTMCBulkOUTReset)
  				  TMCRequestStatus = TMC_STATUS_PENDING;
  				else
  				  RequestInProgress = 0;
  
  				Endpoint_ClearSETUP();
  
  				/* Write the request response bytes */
  				Endpoint_Write_8(TMCRequestStatus);
  				Endpoint_Write_16_LE(0);
  				Endpoint_Write_32_LE(LastTransferLength);
  
  				Endpoint_ClearIN();
  				Endpoint_ClearStatusStage();
  			}
  
  			break;
  		case Req_InitiateAbortBulkIn:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))
  			{
  				/* Check that no split transaction is already in progress and the data transfer tag is valid */
  				if (RequestInProgress != 0)
  				{
  					TMCRequestStatus = TMC_STATUS_SPLIT_IN_PROGRESS;
  				}
  				else if (USB_ControlRequest.wValue != CurrentTransferTag)
  				{
  					TMCRequestStatus = TMC_STATUS_TRANSFER_NOT_IN_PROGRESS;
  				}
  				else
  				{
  					/* Indicate that all in-progress/pending data IN requests should be aborted */
  					IsTMCBulkINReset = true;
  
  					/* Save the split request for later checking when a new request is received */
  					RequestInProgress = Req_InitiateAbortBulkIn;
  				}
  
  				Endpoint_ClearSETUP();
  
  				/* Write the request response bytes */
  				Endpoint_Write_8(TMCRequestStatus);
  				Endpoint_Write_8(CurrentTransferTag);
  
  				Endpoint_ClearIN();
  				Endpoint_ClearStatusStage();
  			}
  
  			break;
  		case Req_CheckAbortBulkInStatus:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_ENDPOINT))
  			{
  				/* Check that an ABORT BULK IN transaction has been requested and that the request has completed */
  				if (RequestInProgress != Req_InitiateAbortBulkIn)
  				  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;
  				else if (IsTMCBulkINReset)
  				  TMCRequestStatus = TMC_STATUS_PENDING;
  				else
  				  RequestInProgress = 0;
  
  				Endpoint_ClearSETUP();
  
  				/* Write the request response bytes */
  				Endpoint_Write_8(TMCRequestStatus);
  				Endpoint_Write_16_LE(0);
  				Endpoint_Write_32_LE(LastTransferLength);
  
  				Endpoint_ClearIN();
  				Endpoint_ClearStatusStage();
  			}
  
  			break;
  		case Req_InitiateClear:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  			{
  				/* Check that no split transaction is already in progress */
  				if (RequestInProgress != 0)
  				{
  					Endpoint_Write_8(TMC_STATUS_SPLIT_IN_PROGRESS);
  				}
  				else
  				{
  					/* Indicate that all in-progress/pending data IN and OUT requests should be aborted */
  					IsTMCBulkINReset  = true;
  					IsTMCBulkOUTReset = true;
  
  					/* Save the split request for later checking when a new request is received */
  					RequestInProgress = Req_InitiateClear;
  				}
  
  				Endpoint_ClearSETUP();
  
  				/* Write the request response byte */
  				Endpoint_Write_8(TMCRequestStatus);
  
  				Endpoint_ClearIN();
  				Endpoint_ClearStatusStage();
  			}
  
  			break;
  		case Req_CheckClearStatus:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  			{
  				/* Check that a CLEAR transaction has been requested and that the request has completed */
  				if (RequestInProgress != Req_InitiateClear)
  				  TMCRequestStatus = TMC_STATUS_SPLIT_NOT_IN_PROGRESS;
  				else if (IsTMCBulkINReset || IsTMCBulkOUTReset)
  				  TMCRequestStatus = TMC_STATUS_PENDING;
  				else
  				  RequestInProgress = 0;
  
  				Endpoint_ClearSETUP();
  
  				/* Write the request response bytes */
  				Endpoint_Write_8(TMCRequestStatus);
  				Endpoint_Write_8(0);
  
  				Endpoint_ClearIN();
  				Endpoint_ClearStatusStage();
  			}
  
  			break;
  		case Req_GetCapabilities:
  			if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  			{
  				Endpoint_ClearSETUP();
  
  				/* Write the device capabilities to the control endpoint */
  				Endpoint_Write_Control_Stream_LE(&Capabilities, sizeof(TMC_Capabilities_t));
  				Endpoint_ClearOUT();
  			}
  
  			break;
  	}
  }
  
  void ProcessSentMessage(uint8_t* const Data, const uint8_t Length)
  {
  	if (strncmp((char*)Data, "*IDN?", 5) == 0)
  	  strcpy((char*)NextResponseBuffer, "LUFA TMC DEMO");
  
  	NextResponseLen = strlen((char*)NextResponseBuffer);
  }
  
  uint8_t GetNextMessage(uint8_t* const Data)
  {
  	  strcpy((char*)NextResponseBuffer, "LUFA TMC DEMO");
  
  	NextResponseLen = strlen((char*)NextResponseBuffer);
  // ---
  	uint8_t DataLen = MIN(NextResponseLen, 64);
  
  	strlcpy((char*)Data, (char*)NextResponseBuffer, DataLen);
  
  	return DataLen;
  }
  
  /** Function to manage TMC data transmission and reception to and from the host. */
  void TMC_Task(void)
  {
  	/* Device must be connected and configured for the task to run */
  	if (USB_DeviceState != DEVICE_STATE_Configured)
  	  return;
  
  	TMC_MessageHeader_t MessageHeader;
  	uint8_t             MessagePayload[128];
  
  	/* Try to read in a TMC message from the interface, process if one is available */
  	if (ReadTMCHeader(&MessageHeader))
  	{
  		/* Indicate busy */
  		LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
  
  		switch (MessageHeader.MessageID)
  		{
  			case TMC_MESSAGEID_DEV_DEP_MSG_OUT:
  				LastTransferLength = 0;
  				while (Endpoint_Read_Stream_LE(MessagePayload, MIN(MessageHeader.TransferSize, sizeof(MessagePayload)), &LastTransferLength) ==
  				       ENDPOINT_RWSTREAM_IncompleteTransfer)
  				{
  					if (IsTMCBulkOUTReset)
  					  break;
  				}
  
  				Endpoint_ClearOUT();
  
  				ProcessSentMessage(MessagePayload, LastTransferLength);
  				break;
  			case TMC_MESSAGEID_DEV_DEP_MSG_IN:
  				Endpoint_ClearOUT();
  
  				MessageHeader.TransferSize = GetNextMessage(MessagePayload);
  				MessageHeader.MessageIDSpecific.DeviceOUT.LastMessageTransaction = true;
  				WriteTMCHeader(&MessageHeader);
  
  				LastTransferLength = 0;
  				while (Endpoint_Write_Stream_LE(MessagePayload, MessageHeader.TransferSize, &LastTransferLength) ==
  				       ENDPOINT_RWSTREAM_IncompleteTransfer)
  				{
  					if (IsTMCBulkINReset)
  					  break;
  				}
  
  				Endpoint_ClearIN();
  				break;
  			default:
  				Endpoint_StallTransaction();
  				break;
  		}
  
  		LEDs_SetAllLEDs(LEDMASK_USB_READY);
  	}
  
  	/* All pending data has been processed - reset the data abort flags */
  	IsTMCBulkINReset  = false;
  	IsTMCBulkOUTReset = false;
  }
  
  /** Attempts to read in the TMC message header from the TMC interface.
   *
   *  \param[out] MessageHeader  Pointer to a location where the read header (if any) should be stored
   *
   *  \return Boolean \c true if a header was read, \c false otherwise
   */
  bool ReadTMCHeader(TMC_MessageHeader_t* const MessageHeader)
  {
  	uint16_t BytesTransferred;
  	uint8_t  ErrorCode;
  
  	/* Select the Data Out endpoint */
  	Endpoint_SelectEndpoint(TMC_OUT_EPADDR);
  
  	/* Abort if no command has been sent from the host */
  	if (!(Endpoint_IsOUTReceived()))
  	  return false;
  
  	/* Read in the header of the command from the host */
  	BytesTransferred = 0;
  	while ((ErrorCode = Endpoint_Read_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), &BytesTransferred)) ==
  	       ENDPOINT_RWSTREAM_IncompleteTransfer)
  	{
  		if (IsTMCBulkOUTReset)
  		  break;
  	}
  
  	/* Store the new command tag value for later use */
  	CurrentTransferTag = MessageHeader->Tag;
  
  	/* Indicate if the command has been aborted or not */
  	return (!(IsTMCBulkOUTReset) && (ErrorCode == ENDPOINT_RWSTREAM_NoError));
  }
  
  bool WriteTMCHeader(TMC_MessageHeader_t* const MessageHeader)
  {
  	uint16_t BytesTransferred;
  	uint8_t  ErrorCode;
  
  	/* Set the message tag of the command header */
  	MessageHeader->Tag        =  CurrentTransferTag;
  	MessageHeader->InverseTag = ~CurrentTransferTag;
  
  	/* Select the Data In endpoint */
  	Endpoint_SelectEndpoint(TMC_IN_EPADDR);
  
  	/* Send the command header to the host */
  	BytesTransferred = 0;
  	while ((ErrorCode = Endpoint_Write_Stream_LE(MessageHeader, sizeof(TMC_MessageHeader_t), &BytesTransferred)) ==
  	       ENDPOINT_RWSTREAM_IncompleteTransfer)
  	{
  		if (IsTMCBulkINReset)
  		  break;
  	}
  
  	/* Indicate if the command has been aborted or not */
  	return (!(IsTMCBulkINReset) && (ErrorCode == ENDPOINT_RWSTREAM_NoError));
  }