XPLAINBridge.c 7.97 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  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 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
  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.
*/

/** \file
 *
 *  Main source file for the XPLAINBridge project. This file contains the main tasks of
 *  the demo and is responsible for the initial application hardware configuration.
 */

#include "XPLAINBridge.h"

39
40
/* Current firmware mode, making the device behave as either a programmer or a USART bridge */
bool CurrentFirmwareMode = MODE_PDI_PROGRAMMER;
41
42
43
44
45
46
47
48
49
50
51
52
53

/** LUFA CDC Class driver interface configuration and state information. This structure is
 *  passed to all CDC Class driver functions, so that multiple instances of the same class
 *  within a device can be differentiated from one another.
 */
USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
	{
		.Config = 
			{
				.ControlInterfaceNumber         = 0,

				.DataINEndpointNumber           = CDC_TX_EPNUM,
				.DataINEndpointSize             = CDC_TXRX_EPSIZE,
54
				.DataINEndpointDoubleBank       = true,
55
56
57

				.DataOUTEndpointNumber          = CDC_RX_EPNUM,
				.DataOUTEndpointSize            = CDC_TXRX_EPSIZE,
58
				.DataOUTEndpointDoubleBank      = true,
59
60
61
62
63
64

				.NotificationEndpointNumber     = CDC_NOTIFICATION_EPNUM,
				.NotificationEndpointSize       = CDC_NOTIFICATION_EPSIZE,
				.NotificationEndpointDoubleBank = false,
			},
	};
65
66
67
68
69
70
71
	
/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
RingBuff_t USBtoUART_Buffer;

/** Circular buffer to hold data from the serial port before it is sent to the host. */
RingBuff_t UARTtoUSB_Buffer;

72
73
74
75
76
77
78
79
80
81
82

/** 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();
	
	Buffer_Initialize(&USBtoUART_Buffer);
	Buffer_Initialize(&UARTtoUSB_Buffer);

Dean Camera's avatar
Dean Camera committed
83
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
84
	sei();
Dean Camera's avatar
Dean Camera committed
85

86
87
	for (;;)
	{
Dean Camera's avatar
Dean Camera committed
88
89
90
91
92
		if (CurrentFirmwareMode == MODE_USART_BRIDGE)
		  USARTBridge_Task();
		else
		  AVRISP_Task();

93
94
95
96
		USB_USBTask();
	}
}

97
98
void AVRISP_Task(void)
{
Dean Camera's avatar
Dean Camera committed
99
100
101
102
	/* Must be in the configured state for the AVRISP code to process data */
	if (USB_DeviceState != DEVICE_STATE_Configured)
	  return;

103
	Endpoint_SelectEndpoint(AVRISP_DATA_OUT_EPNUM);
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
	
	/* Check to see if a V2 Protocol command has been received */
	if (Endpoint_IsOUTReceived())
	{
		LEDs_SetAllLEDs(LEDMASK_BUSY);

		/* Pass off processing of the V2 Protocol command to the V2 Protocol handler */
		V2Protocol_ProcessCommand();

		LEDs_SetAllLEDs(LEDMASK_USB_READY);
	}
}

void USARTBridge_Task(void)
{
Dean Camera's avatar
Dean Camera committed
119
120
121
122
	/* Must be in the configured state for the USART Bridge code to process data */
	if (USB_DeviceState != DEVICE_STATE_Configured)
	  return;

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
	/* Read bytes from the USB OUT endpoint into the UART transmit buffer */
	for (uint8_t DataBytesRem = CDC_Device_BytesReceived(&VirtualSerial_CDC_Interface); DataBytesRem != 0; DataBytesRem--)
	{
		if (!(BUFF_STATICSIZE - USBtoUART_Buffer.Elements))
		  break;
		  
		Buffer_StoreElement(&USBtoUART_Buffer, CDC_Device_ReceiveByte(&VirtualSerial_CDC_Interface));
	}
	
	/* Read bytes from the UART receive buffer into the USB IN endpoint */
	if (UARTtoUSB_Buffer.Elements)
	  CDC_Device_SendByte(&VirtualSerial_CDC_Interface, Buffer_GetElement(&UARTtoUSB_Buffer));
	
	/* Load bytes from the UART transmit buffer into the UART */
	if ((USBtoUART_Buffer.Elements) && SoftUART_IsReady())
	  SoftUART_TxByte(Buffer_GetElement(&USBtoUART_Buffer));
	
	/* Load bytes from the UART into the UART receive buffer */
Dean Camera's avatar
Dean Camera committed
141
142
	if (SoftUART_IsReceived())
	  Buffer_StoreElement(&UARTtoUSB_Buffer, SoftUART_RxByte());
143
144
145
146

	CDC_Device_USBTask(&VirtualSerial_CDC_Interface);
}

147
148
149
150
151
152
153
154
155
156
157
158
/** Configures the board hardware and chip peripherals for the demo's functionality. */
void SetupHardware(void)
{
	/* Disable watchdog if enabled by bootloader/fuses */
	MCUSR &= ~(1 << WDRF);
	wdt_disable();

	/* Disable clock division */
	clock_prescale_set(clock_div_1);

	/* Hardware Initialization */
	SoftUART_Init();
159
	LEDs_Init();
160
	USB_Init();
161
	V2Protocol_Init();
162
	
163
164
165
166
167
168
169
170
171
172
	/* Disable JTAG debugging */
	MCUCR |= (1 << JTD);
	MCUCR |= (1 << JTD);

	/* Enable pullup on the JTAG TDI pin so we can use it to select the mode */
	PORTF |= (1 << 7);
	_delay_ms(10);

	/* Select the firmware mode based on the JTD pin's value */
	CurrentFirmwareMode = (PINF & (1 << 7)) ? MODE_USART_BRIDGE : MODE_PDI_PROGRAMMER;
173
174
175
176

	/* Re-enable JTAG debugging */
	MCUCR &= ~(1 << JTD);
	MCUCR &= ~(1 << JTD);
177
178
179
180
181
}

/** Event handler for the library USB Configuration Changed event. */
void EVENT_USB_Device_ConfigurationChanged(void)
{
182
	bool EndpointConfigSuccess = true;
183

Dean Camera's avatar
Dean Camera committed
184
	/* Configure the device endpoints according to the selected mode */
185
186
	if (CurrentFirmwareMode == MODE_USART_BRIDGE)
	{
187
		EndpointConfigSuccess &= CDC_Device_ConfigureEndpoints(&VirtualSerial_CDC_Interface);
188
189
190
	}
	else
	{
191
192
193
194
		EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_OUT_EPNUM, EP_TYPE_BULK,
										                    ENDPOINT_DIR_OUT, AVRISP_DATA_EPSIZE,
										                    ENDPOINT_BANK_SINGLE);

195
		#if defined(LIBUSB_FILTERDRV_COMPAT)
196
197
198
199
		EndpointConfigSuccess &= Endpoint_ConfigureEndpoint(AVRISP_DATA_IN_EPNUM, EP_TYPE_BULK,
		                                                    ENDPOINT_DIR_IN, AVRISP_DATA_EPSIZE,
		                                                    ENDPOINT_BANK_SINGLE);
		#endif
200
	}
201

202
203
204
205
	if (EndpointConfigSuccess)
	  LEDs_SetAllLEDs(LEDMASK_USB_READY);
	else
	  LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
206
207
208
209
210
}

/** Event handler for the library USB Unhandled Control Request event. */
void EVENT_USB_Device_UnhandledControlRequest(void)
{
211
212
213
214
	if (CurrentFirmwareMode == MODE_USART_BRIDGE)
	  CDC_Device_ProcessControlRequest(&VirtualSerial_CDC_Interface);
}

Dean Camera's avatar
Dean Camera committed
215
216
217
218
219
220
221
222
223
224
225
226
/** Event handler for the library USB Connection event. */
void EVENT_USB_Device_Connect(void)
{
	LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
}

/** Event handler for the library USB Disconnection event. */
void EVENT_USB_Device_Disconnect(void)
{
	LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
}

227
228
229
230
231
232
233
234
/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors"
 *  documentation) by the application code so that the address and size of a requested descriptor can be given
 *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function
 *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the
 *  USB host.
 */
uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
{
Dean Camera's avatar
Dean Camera committed
235
	/* Return the correct descriptors based on the selected mode */
236
237
238
239
	if (CurrentFirmwareMode == MODE_USART_BRIDGE)
	  return USART_GetDescriptor(wValue, wIndex, DescriptorAddress);
	else
	  return AVRISP_GetDescriptor(wValue, wIndex, DescriptorAddress);
240
}