StillImageCommands.c 7.56 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
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
/*
             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.
*/

/** \file
 *
 *  Still Image Device commands, to issue PIMA commands to the device for
 *  reading device status, capacity, and other characteristics as well as
 *  reading and writing of stored image data.
 */

#include "StillImageCommands.h"

/* Globals: */
/** PIMA block container for the block to send to the device */
PIMA_Container_t PIMA_SendBlock;

/** PIMA block container for the last received block from the device */
PIMA_Container_t PIMA_ReceivedBlock;

/** PIMA block container for the last event block received from the device */
PIMA_Container_t PIMA_EventBlock;


/** Function to send the PIMA command container to the attached still image device. */
void SImage_SendBlockHeader(void)
{
	/* Unfreeze the data OUT pipe ready for data transmission */
	Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
	Pipe_Unfreeze();

	/* Write the PIMA block to the data OUT pipe */
	Pipe_Write_Stream_LE(&PIMA_SendBlock, PIMA_COMMAND_SIZE(0));
	
	/* If the block type is a command, send its parameters (if any) */
	if (PIMA_SendBlock.Type == CType_CommandBlock)
	{
		/* Determine the size of the parameters in the block via the data length attribute */
		uint8_t ParamBytes = (PIMA_SendBlock.DataLength - PIMA_COMMAND_SIZE(0));

		/* Check if any parameters in the command block */
		if (ParamBytes)
		{
			/* Write the PIMA parameters to the data OUT pipe */
			Pipe_Write_Stream_LE(&PIMA_SendBlock.Params, ParamBytes);
		}
		
		/* Send the PIMA command block to the attached device */
75
		Pipe_ClearOUT();
76
77
78
79
80
81
82
	}
					
	/* Freeze pipe after use */
	Pipe_Freeze();
}

/** Function to receive a PIMA event container from the attached still image device. */
83
uint8_t SImage_ReceiveEventHeader(void)
84
{
85
86
	uint8_t ErrorCode;

87
88
89
90
91
	/* Unfreeze the events pipe */
	Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
	Pipe_Unfreeze();
	
	/* Read in the event data into the global structure */
92
	ErrorCode = Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock));
93
94
	
	/* Clear the pipe after read complete to prepare for next event */
95
	Pipe_ClearIN();
96
97
98
	
	/* Freeze the event pipe again after use */
	Pipe_Freeze();
99
100
	
	return ErrorCode;
101
102
103
}

/** Function to receive a PIMA response container from the attached still image device. */
104
uint8_t SImage_ReceiveBlockHeader(void)
105
106
107
108
109
110
111
112
{
	uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;

	/* Unfreeze the data IN pipe */
	Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
	Pipe_Unfreeze();
	
	/* Wait until data received on the IN pipe */
113
	while (!(Pipe_IsReadWriteAllowed()))
114
115
	{
		/* Check to see if a new frame has been issued (1ms elapsed) */
116
		if (USB_INT_HasOccurred(USB_INT_HSOFI))
117
		{
118
			/* Clear the flag and decrement the timeout period counter */
119
			USB_INT_Clear(USB_INT_HSOFI);
120
121
122
123
124
125
			TimeoutMSRem--;

			/* Check to see if the timeout period for the command has elapsed */
			if (!(TimeoutMSRem))
			{
				/* Return error code */
126
				return PIPE_RWSTREAM_Timeout;
127
128
129
			}
		}
		
130
		Pipe_Freeze();
131
		Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
132
		Pipe_Unfreeze();
133
134
135
136
137

		/* Check if pipe stalled (command failed by device) */
		if (Pipe_IsStalled())
		{
			/* Clear the stall condition on the OUT pipe */
138
			USB_Host_ClearPipeStall(SIMAGE_DATA_OUT_PIPE);
139
140

			/* Return error code and break out of the loop */
141
			return PIPE_RWSTREAM_PipeStalled;
142
143
		}

144
		Pipe_Freeze();
145
		Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
146
		Pipe_Unfreeze();
147
148
149
150
151

		/* Check if pipe stalled (command failed by device) */
		if (Pipe_IsStalled())
		{
			/* Clear the stall condition on the IN pipe */
152
			USB_Host_ClearPipeStall(SIMAGE_DATA_IN_PIPE);
153
154

			/* Return error code */
155
			return PIPE_RWSTREAM_PipeStalled;
156
157
158
		}
		  
		/* Check to see if the device was disconnected, if so exit function */
159
160
161
		if (USB_HostState == HOST_STATE_Unattached)
		  return PIPE_RWSTREAM_DeviceDisconnected;
	}
162
		
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
	/* Load in the response from the attached device */
	Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0));
	
	/* Check if the returned block type is a response block */
	if (PIMA_ReceivedBlock.Type == CType_ResponseBlock)
	{
		/* Determine the size of the parameters in the block via the data length attribute */
		uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));

		/* Check if the device has returned any parameters */
		if (ParamBytes)
		{
			/* Read the PIMA parameters from the data IN pipe */
			Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes);
		}
		
		/* Clear pipe bank after use */
180
		Pipe_ClearIN();
181
182
183
184
185
	}
	
	/* Freeze the IN pipe after use */
	Pipe_Freeze();
	
186
	return PIPE_RWSTREAM_NoError;
187
188
189
190
}

/** Function to send the given data to the device, after a command block has been issued.
 *
191
192
 *  \param[in] Buffer  Source data buffer to send to the device
 *  \param[in] Bytes   Number of bytes to send
193
 */
194
uint8_t SImage_SendData(void* Buffer, uint16_t Bytes)
195
{
196
197
	uint8_t ErrorCode;

198
199
200
201
202
	/* Unfreeze the data OUT pipe */
	Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
	Pipe_Unfreeze();
	
	/* Write the data contents to the pipe */
203
	ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes);
204

205
	/* Send the last packet to the attached device */
206
	Pipe_ClearOUT();
207

208
209
	/* Freeze the pipe again after use */
	Pipe_Freeze();
210
211
	
	return ErrorCode;
212
213
214
215
}

/** Function to receive the given data to the device, after a response block has been received.
 *
216
217
 *  \param[out] Buffer  Destination data buffer to put read bytes from the device
 *  \param[in] Bytes    Number of bytes to receive
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
 *
 *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
 */
uint8_t SImage_ReadData(void* Buffer, uint16_t Bytes)
{
	uint8_t ErrorCode;

	/* Unfreeze the data IN pipe */
	Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
	Pipe_Unfreeze();

	/* Read in the data into the buffer */
	ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes);

	/* Freeze the pipe again after use */
	Pipe_Freeze();
	
	return ErrorCode;
}

/** Function to test if a PIMA event block is waiting to be read in from the attached device.
 *
 *  \return True if an event is waiting to be read in from the device, false otherwise
 */
bool SImage_IsEventReceived(void)
{
	bool IsEventReceived = false;

	/* Unfreeze the Event pipe */
	Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
	Pipe_Unfreeze();
	
	/* If the pipe contains data, an event has been received */
	if (Pipe_BytesInPipe())
	  IsEventReceived = true;
	
	/* Freeze the pipe after use */
	Pipe_Freeze();
	
	return IsEventReceived;
}