--- /dev/null
+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2009.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, and distribute this software\r
+ and its documentation for any purpose and without fee is hereby\r
+ granted, provided that the above copyright notice appear in all\r
+ copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ * Still Image Device commands, to issue PIMA commands to the device for\r
+ * reading device status, capacity, and other characteristics as well as\r
+ * reading and writing of stored image data.\r
+ */\r
+\r
+#include "StillImageCommands.h"\r
+\r
+/* Globals: */\r
+/** PIMA block container for the block to send to the device */\r
+PIMA_Container_t PIMA_SendBlock;\r
+\r
+/** PIMA block container for the last received block from the device */\r
+PIMA_Container_t PIMA_ReceivedBlock;\r
+\r
+/** PIMA block container for the last event block received from the device */\r
+PIMA_Container_t PIMA_EventBlock;\r
+\r
+\r
+/** Function to send the PIMA command container to the attached still image device. */\r
+void SImage_SendBlockHeader(void)\r
+{\r
+ /* Unfreeze the data OUT pipe ready for data transmission */\r
+ Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);\r
+ Pipe_Unfreeze();\r
+\r
+ /* Write the PIMA block to the data OUT pipe */\r
+ Pipe_Write_Stream_LE(&PIMA_SendBlock, PIMA_COMMAND_SIZE(0));\r
+ \r
+ /* If the block type is a command, send its parameters (if any) */\r
+ if (PIMA_SendBlock.Type == CType_CommandBlock)\r
+ {\r
+ /* Determine the size of the parameters in the block via the data length attribute */\r
+ uint8_t ParamBytes = (PIMA_SendBlock.DataLength - PIMA_COMMAND_SIZE(0));\r
+\r
+ /* Check if any parameters in the command block */\r
+ if (ParamBytes)\r
+ {\r
+ /* Write the PIMA parameters to the data OUT pipe */\r
+ Pipe_Write_Stream_LE(&PIMA_SendBlock.Params, ParamBytes);\r
+ }\r
+ \r
+ /* Send the PIMA command block to the attached device */\r
+ Pipe_ClearOUT();\r
+ }\r
+ \r
+ /* Freeze pipe after use */\r
+ Pipe_Freeze();\r
+}\r
+\r
+/** Function to receive a PIMA event container from the attached still image device. */\r
+void SImage_RecieveEventHeader(void)\r
+{\r
+ /* Unfreeze the events pipe */\r
+ Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);\r
+ Pipe_Unfreeze();\r
+ \r
+ /* Read in the event data into the global structure */\r
+ Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock));\r
+ \r
+ /* Clear the pipe after read complete to prepare for next event */\r
+ Pipe_ClearIN();\r
+ \r
+ /* Freeze the event pipe again after use */\r
+ Pipe_Freeze();\r
+}\r
+\r
+/** Function to receive a PIMA response container from the attached still image device. */\r
+uint8_t SImage_RecieveBlockHeader(void)\r
+{\r
+ uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;\r
+\r
+ /* Unfreeze the data IN pipe */\r
+ Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);\r
+ Pipe_Unfreeze();\r
+ \r
+ /* Wait until data received on the IN pipe */\r
+ while (!(Pipe_IsReadWriteAllowed()))\r
+ {\r
+ /* Check to see if a new frame has been issued (1ms elapsed) */\r
+ if (USB_INT_HasOccurred(USB_INT_HSOFI))\r
+ {\r
+ /* Clear the flag and decrement the timeout period counter */\r
+ USB_INT_Clear(USB_INT_HSOFI);\r
+ TimeoutMSRem--;\r
+\r
+ /* Check to see if the timeout period for the command has elapsed */\r
+ if (!(TimeoutMSRem))\r
+ {\r
+ /* Return error code */\r
+ return PIPE_RWSTREAM_Timeout;\r
+ }\r
+ }\r
+ \r
+ Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);\r
+\r
+ /* Check if pipe stalled (command failed by device) */\r
+ if (Pipe_IsStalled())\r
+ {\r
+ /* Clear the stall condition on the OUT pipe */\r
+ SImage_ClearPipeStall(SIMAGE_DATA_OUT_PIPE);\r
+\r
+ /* Return error code and break out of the loop */\r
+ return PIPE_RWSTREAM_PipeStalled;\r
+ }\r
+\r
+ Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);\r
+\r
+ /* Check if pipe stalled (command failed by device) */\r
+ if (Pipe_IsStalled())\r
+ {\r
+ /* Clear the stall condition on the IN pipe */\r
+ SImage_ClearPipeStall(SIMAGE_DATA_IN_PIPE);\r
+\r
+ /* Return error code */\r
+ return PIPE_RWSTREAM_PipeStalled;\r
+ }\r
+ \r
+ /* Check to see if the device was disconnected, if so exit function */\r
+ if (!(USB_IsConnected))\r
+ {\r
+ /* Return error code */\r
+ return PIPE_RWSTREAM_DeviceDisconnected;\r
+ }\r
+ };\r
+ \r
+ /* Freeze OUT pipe after use */\r
+ Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);\r
+ Pipe_Freeze();\r
+\r
+ /* Select the IN data pipe for data reception */\r
+ Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);\r
+ \r
+ /* Load in the response from the attached device */\r
+ Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0));\r
+ \r
+ /* Check if the returned block type is a response block */\r
+ if (PIMA_ReceivedBlock.Type == CType_ResponseBlock)\r
+ {\r
+ /* Determine the size of the parameters in the block via the data length attribute */\r
+ uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));\r
+\r
+ /* Check if the device has returned any parameters */\r
+ if (ParamBytes)\r
+ {\r
+ /* Read the PIMA parameters from the data IN pipe */\r
+ Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes);\r
+ }\r
+ \r
+ /* Clear pipe bank after use */\r
+ Pipe_ClearIN();\r
+ }\r
+ \r
+ /* Freeze the IN pipe after use */\r
+ Pipe_Freeze();\r
+ \r
+ return PIPE_RWSTREAM_NoError;\r
+}\r
+\r
+/** Function to send the given data to the device, after a command block has been issued.\r
+ *\r
+ * \param Buffer Source data buffer to send to the device\r
+ * \param Bytes Number of bytes to send\r
+ */\r
+void SImage_SendData(void* Buffer, uint16_t Bytes)\r
+{\r
+ /* Unfreeze the data OUT pipe */\r
+ Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);\r
+ Pipe_Unfreeze();\r
+ \r
+ /* Write the data contents to the pipe */\r
+ Pipe_Write_Stream_LE(Buffer, Bytes);\r
+\r
+ /* Send the last packet to the attached device */\r
+ Pipe_ClearOUT();\r
+\r
+ /* Freeze the pipe again after use */\r
+ Pipe_Freeze();\r
+}\r
+\r
+/** Function to receive the given data to the device, after a response block has been received.\r
+ *\r
+ * \param Buffer Destination data buffer to put read bytes from the device\r
+ * \param Bytes Number of bytes to receive\r
+ *\r
+ * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
+ */\r
+uint8_t SImage_ReadData(void* Buffer, uint16_t Bytes)\r
+{\r
+ uint8_t ErrorCode;\r
+\r
+ /* Unfreeze the data IN pipe */\r
+ Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);\r
+ Pipe_Unfreeze();\r
+\r
+ /* Read in the data into the buffer */\r
+ ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes);\r
+\r
+ /* Freeze the pipe again after use */\r
+ Pipe_Freeze();\r
+ \r
+ return ErrorCode;\r
+}\r
+\r
+/** Function to test if a PIMA event block is waiting to be read in from the attached device.\r
+ *\r
+ * \return True if an event is waiting to be read in from the device, false otherwise\r
+ */\r
+bool SImage_IsEventReceived(void)\r
+{\r
+ bool IsEventReceived = false;\r
+\r
+ /* Unfreeze the Event pipe */\r
+ Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);\r
+ Pipe_Unfreeze();\r
+ \r
+ /* If the pipe contains data, an event has been received */\r
+ if (Pipe_BytesInPipe())\r
+ IsEventReceived = true;\r
+ \r
+ /* Freeze the pipe after use */\r
+ Pipe_Freeze();\r
+ \r
+ return IsEventReceived;\r
+}\r
+\r
+/** Clears the stall condition in the attached device on the nominated endpoint number.\r
+ *\r
+ * \param EndpointNum Endpoint number in the attached device whose stall condition is to be cleared\r
+ *\r
+ * \return A value from the USB_Host_SendControlErrorCodes_t enum\r
+ */\r
+uint8_t SImage_ClearPipeStall(const uint8_t EndpointNum)\r
+{\r
+ USB_ControlRequest = (USB_Request_Header_t)\r
+ {\r
+ .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_ENDPOINT),\r
+ .bRequest = REQ_ClearFeature,\r
+ .wValue = FEATURE_ENDPOINT_HALT,\r
+ .wIndex = EndpointNum,\r
+ .wLength = 0,\r
+ };\r
+ \r
+ /* Select the control pipe for the request transfer */\r
+ Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
+ return USB_Host_SendControlRequest(NULL);\r
+}\r
projects / pub / lufa.git / blobdiff