Endpoint.c 12.5 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
  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.
*/

31
#define  __INCLUDE_FROM_USB_DRIVER
32
33
#include "../HighLevel/USBMode.h"

34
35
#if defined(USB_CAN_BE_DEVICE)

36
#define  __INCLUDE_FROM_ENDPOINT_C
37
38
39
40
41
42
#include "Endpoint.h"

#if !defined(FIXED_CONTROL_ENDPOINT_SIZE)
uint8_t USB_ControlEndpointSize = ENDPOINT_CONTROLEP_DEFAULT_SIZE;
#endif

43
uint8_t Endpoint_BytesToEPSizeMaskDynamic(const uint16_t Size)
44
{
45
	return Endpoint_BytesToEPSizeMask(Size);
46
}
47
48

bool Endpoint_ConfigureEndpoint_Prv(const uint8_t Number, const uint8_t UECFG0XData, const uint8_t UECFG1XData)
49
50
51
52
{
	Endpoint_SelectEndpoint(Number);
	Endpoint_EnableEndpoint();

53
	UECFG1X = 0;
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

	UECFG0X = UECFG0XData;
	UECFG1X = UECFG1XData;

	return Endpoint_IsConfigured();
}

void Endpoint_ClearEndpoints(void)
{
	UEINT = 0;

	for (uint8_t EPNum = 0; EPNum < ENDPOINT_TOTAL_ENDPOINTS; EPNum++)
	{
		Endpoint_SelectEndpoint(EPNum);	
		UEIENX = 0;
		UEINTX = 0;
		Endpoint_DeallocateMemory();
		Endpoint_DisableEndpoint();
	}
}

75
76
77
78
79
void Endpoint_ClearStatusStage(void)
{
	if (USB_ControlRequest.bmRequestType & REQDIR_DEVICETOHOST)
	{
		while (!(Endpoint_IsOUTReceived()))
80
		{
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
			if (USB_DeviceState == DEVICE_STATE_Unattached)
			  return;
		}

		Endpoint_ClearOUT();
	}
	else
	{
		while (!(Endpoint_IsINReady()))
		{
			if (USB_DeviceState == DEVICE_STATE_Unattached)
			  return;
		}
		
		Endpoint_ClearIN();
	}
}

99
#if !defined(CONTROL_ONLY_DEVICE)
100
101
uint8_t Endpoint_WaitUntilReady(void)
{
102
103
104
	#if (USB_STREAM_TIMEOUT_MS < 0xFF)
	uint8_t  TimeoutMSRem = USB_STREAM_TIMEOUT_MS;	
	#else
105
	uint16_t TimeoutMSRem = USB_STREAM_TIMEOUT_MS;
106
	#endif
107

108
	for (;;)
109
	{
110
111
112
113
114
115
116
117
118
119
120
		if (Endpoint_GetEndpointDirection() == ENDPOINT_DIR_IN)
		{
			if (Endpoint_IsINReady())
			  return ENDPOINT_READYWAIT_NoError;
		}
		else
		{
			if (Endpoint_IsOUTReceived())
			  return ENDPOINT_READYWAIT_NoError;		
		}
		
121
		if (USB_DeviceState == DEVICE_STATE_Unattached)
122
123
124
125
		  return ENDPOINT_READYWAIT_DeviceDisconnected;
		else if (Endpoint_IsStalled())
		  return ENDPOINT_READYWAIT_EndpointStalled;
			  
126
		if (USB_INT_HasOccurred(USB_INT_SOFI))
127
		{
128
			USB_INT_Clear(USB_INT_SOFI);
129
130
131
132
133
134
135
136
137

			if (!(TimeoutMSRem--))
			  return ENDPOINT_READYWAIT_Timeout;
		}
	}
}

uint8_t Endpoint_Discard_Stream(uint16_t Length
#if !defined(NO_STREAM_CALLBACKS)
138
                                , StreamCallbackPtr_t Callback
139
140
141
142
143
144
145
146
#endif
								)
{
	uint8_t  ErrorCode;
	
	if ((ErrorCode = Endpoint_WaitUntilReady()))
	  return ErrorCode;

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
	#if defined(FAST_STREAM_TRANSFERS)
	uint8_t BytesRemToAlignment = (Endpoint_BytesInEndpoint() & 0x07);

	if (Length >= 8)
	{
		Length -= BytesRemToAlignment;

		switch (BytesRemToAlignment)
		{
			default:
				do
				{
					if (!(Endpoint_IsReadWriteAllowed()))
					{
						Endpoint_ClearOUT();

						#if !defined(NO_STREAM_CALLBACKS)
						if ((Callback != NULL) && (Callback() == STREAMCALLBACK_Abort))
						  return ENDPOINT_RWSTREAM_CallbackAborted;
						#endif

						if ((ErrorCode = Endpoint_WaitUntilReady()))
						  return ErrorCode;
					}

					Length -= 8;
					
					Endpoint_Discard_Byte();
			case 7: Endpoint_Discard_Byte();
			case 6: Endpoint_Discard_Byte();
			case 5: Endpoint_Discard_Byte();
			case 4: Endpoint_Discard_Byte();
			case 3: Endpoint_Discard_Byte();
			case 2: Endpoint_Discard_Byte();
			case 1:	Endpoint_Discard_Byte();
				} while (Length >= 8);	
		}
	}
	#endif

187
	while (Length)
188
	{
189
		if (!(Endpoint_IsReadWriteAllowed()))
190
		{
191
			Endpoint_ClearOUT();
192
193
194

			#if !defined(NO_STREAM_CALLBACKS)
			if ((Callback != NULL) && (Callback() == STREAMCALLBACK_Abort))
195
			  return ENDPOINT_RWSTREAM_CallbackAborted;
196
197
198
199
200
			#endif

			if ((ErrorCode = Endpoint_WaitUntilReady()))
			  return ErrorCode;
		}
201
202
203
		else
		{
			Endpoint_Discard_Byte();
204
			Length--;
205
		}
206
207
	}
	
208
	return ENDPOINT_RWSTREAM_NoError;
209
210
}

211
212
213
/* The following abuses the C preprocessor in order to copy-past common code with slight alterations,
 * so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */

214
#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_Stream_LE
215
#define  TEMPLATE_BUFFER_TYPE                      const void*
216
217
#define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearIN()
#define  TEMPLATE_BUFFER_OFFSET(Length)            0
218
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(*((uint8_t*)BufferPtr++))
219
220
221
#include "Template/Template_Endpoint_RW.c"

#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_PStream_LE
222
#define  TEMPLATE_BUFFER_TYPE                      const void*
223
224
#define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearIN()
#define  TEMPLATE_BUFFER_OFFSET(Length)            0
225
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr++))
226
227
#include "Template/Template_Endpoint_RW.c"

228
229
230
231
232
233
234
235
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Write_EStream_LE
	#define  TEMPLATE_BUFFER_TYPE                  const void*
	#define  TEMPLATE_CLEAR_ENDPOINT()             Endpoint_ClearIN()
	#define  TEMPLATE_BUFFER_OFFSET(Length)        0
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     Endpoint_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr++))
	#include "Template/Template_Endpoint_RW.c"
#endif
236
237

#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_Stream_BE
238
#define  TEMPLATE_BUFFER_TYPE                      const void*
239
#define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearIN()
240
#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
241
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(*((uint8_t*)BufferPtr--))
242
243
#include "Template/Template_Endpoint_RW.c"

244
245
246
247
248
249
250
251
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Write_EStream_BE
	#define  TEMPLATE_BUFFER_TYPE                  const void*
	#define  TEMPLATE_CLEAR_ENDPOINT()             Endpoint_ClearIN()
	#define  TEMPLATE_BUFFER_OFFSET(Length)        (Length - 1)
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     Endpoint_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr--))
	#include "Template/Template_Endpoint_RW.c"
#endif
252
253

#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_PStream_BE
254
#define  TEMPLATE_BUFFER_TYPE                      const void*
255
#define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearIN()
256
#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
257
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr--))
258
259
260
#include "Template/Template_Endpoint_RW.c"

#define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Stream_LE
261
#define  TEMPLATE_BUFFER_TYPE                      void*
262
263
#define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearOUT()
#define  TEMPLATE_BUFFER_OFFSET(Length)            0
264
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr++) = Endpoint_Read_Byte()
265
266
#include "Template/Template_Endpoint_RW.c"

267
268
269
270
271
272
273
274
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Read_EStream_LE
	#define  TEMPLATE_BUFFER_TYPE                  void*
	#define  TEMPLATE_CLEAR_ENDPOINT()             Endpoint_ClearOUT()
	#define  TEMPLATE_BUFFER_OFFSET(Length)        0
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     eeprom_write_byte((uint8_t*)BufferPtr++, Endpoint_Read_Byte())
	#include "Template/Template_Endpoint_RW.c"
#endif
275
276

#define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Stream_BE
277
#define  TEMPLATE_BUFFER_TYPE                      void*
278
#define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearOUT()
279
#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
280
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr--) = Endpoint_Read_Byte()
281
282
#include "Template/Template_Endpoint_RW.c"

283
284
285
286
287
288
289
290
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Read_EStream_BE
	#define  TEMPLATE_BUFFER_TYPE                  void*
	#define  TEMPLATE_CLEAR_ENDPOINT()             Endpoint_ClearOUT()
	#define  TEMPLATE_BUFFER_OFFSET(Length)        (Length - 1)
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     eeprom_write_byte((uint8_t*)BufferPtr--, Endpoint_Read_Byte())
	#include "Template/Template_Endpoint_RW.c"
#endif
291

292
#endif
293

294
295
#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_Control_Stream_LE
#define  TEMPLATE_BUFFER_OFFSET(Length)            0
296
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(*((uint8_t*)BufferPtr++))
297
298
299
300
#include "Template/Template_Endpoint_Control_W.c"

#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_Control_PStream_LE
#define  TEMPLATE_BUFFER_OFFSET(Length)            0
301
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr++))
302
303
#include "Template/Template_Endpoint_Control_W.c"

304
305
306
307
308
309
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Write_Control_EStream_LE
	#define  TEMPLATE_BUFFER_OFFSET(Length)        0
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     Endpoint_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr++))
	#include "Template/Template_Endpoint_Control_W.c"
#endif
310
311

#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_Control_Stream_BE
312
#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
313
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(*((uint8_t*)BufferPtr--))
314
315
316
#include "Template/Template_Endpoint_Control_W.c"

#define  TEMPLATE_FUNC_NAME                        Endpoint_Write_Control_PStream_BE
317
#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
318
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         Endpoint_Write_Byte(pgm_read_byte((uint8_t*)BufferPtr--))
319
320
#include "Template/Template_Endpoint_Control_W.c"

321
322
323
324
325
326
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Write_Control_EStream_BE
	#define  TEMPLATE_BUFFER_OFFSET(Length)        (Length - 1)
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     Endpoint_Write_Byte(eeprom_read_byte((uint8_t*)BufferPtr--))
	#include "Template/Template_Endpoint_Control_W.c"
#endif
327
328
329

#define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Control_Stream_LE
#define  TEMPLATE_BUFFER_OFFSET(Length)            0
330
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr++) = Endpoint_Read_Byte()
331
332
#include "Template/Template_Endpoint_Control_R.c"

333
334
335
336
337
338
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Read_Control_EStream_LE
	#define  TEMPLATE_BUFFER_OFFSET(Length)        0
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     eeprom_write_byte((uint8_t*)BufferPtr++, Endpoint_Read_Byte())
	#include "Template/Template_Endpoint_Control_R.c"
#endif
339
340

#define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Control_Stream_BE
341
#define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
342
#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         *((uint8_t*)BufferPtr--) = Endpoint_Read_Byte()
343
344
#include "Template/Template_Endpoint_Control_R.c"

345
346
347
348
349
350
#if defined(__AVR__)
	#define  TEMPLATE_FUNC_NAME                    Endpoint_Read_Control_EStream_BE
	#define  TEMPLATE_BUFFER_OFFSET(Length)        (Length - 1)
	#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)     eeprom_write_byte((uint8_t*)BufferPtr--, Endpoint_Read_Byte())
	#include "Template/Template_Endpoint_Control_R.c"
#endif
351
352

#endif