Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / Demos / Host / LowLevel / StillImageHost / Lib / StillImageCommands.c
index d9fc68a..5304509 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all 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
-/** 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
- *\r
- *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-uint8_t SImage_ReceiveEventHeader(void)\r
-{\r
-       uint8_t ErrorCode;\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
-       ErrorCode = 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
-       return ErrorCode;\r
-}\r
-\r
-/** Function to receive a PIMA response container from the attached still image device.\r
- *\r
- *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-uint8_t SImage_ReceiveBlockHeader(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_Freeze();\r
-               Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);\r
-               Pipe_Unfreeze();\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
-                       USB_Host_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_Freeze();\r
-               Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);\r
-               Pipe_Unfreeze();\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
-                       USB_Host_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_HostState == HOST_STATE_Unattached)\r
-                 return PIPE_RWSTREAM_DeviceDisconnected;\r
-       }\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[in] Buffer  Source data buffer to send to the device\r
- *  \param[in] Bytes   Number of bytes to send\r
- *\r
- *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum\r
- */\r
-uint8_t SImage_SendData(void* const Buffer, const uint16_t Bytes)\r
-{\r
-       uint8_t ErrorCode;\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
-       ErrorCode = 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
-       return ErrorCode;\r
-}\r
-\r
-/** Function to receive the given data to the device, after a response block has been received.\r
- *\r
- *  \param[out] Buffer  Destination data buffer to put read bytes from the device\r
- *  \param[in] 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* const Buffer, const 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
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  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 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"
+
+/** 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 */
+               Pipe_ClearOUT();
+       }
+                                       
+       /* Freeze pipe after use */
+       Pipe_Freeze();
+}
+
+/** Function to receive a PIMA event container from the attached still image device.
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+uint8_t SImage_ReceiveEventHeader(void)
+{
+       uint8_t ErrorCode;
+
+       /* Unfreeze the events pipe */
+       Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
+       Pipe_Unfreeze();
+       
+       /* Read in the event data into the global structure */
+       ErrorCode = Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock));
+       
+       /* Clear the pipe after read complete to prepare for next event */
+       Pipe_ClearIN();
+       
+       /* Freeze the event pipe again after use */
+       Pipe_Freeze();
+       
+       return ErrorCode;
+}
+
+/** Function to receive a PIMA response container from the attached still image device.
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+uint8_t SImage_ReceiveBlockHeader(void)
+{
+       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 */
+       while (!(Pipe_IsReadWriteAllowed()))
+       {
+               /* Check to see if a new frame has been issued (1ms elapsed) */
+               if (USB_INT_HasOccurred(USB_INT_HSOFI))
+               {
+                       /* Clear the flag and decrement the timeout period counter */
+                       USB_INT_Clear(USB_INT_HSOFI);
+                       TimeoutMSRem--;
+
+                       /* Check to see if the timeout period for the command has elapsed */
+                       if (!(TimeoutMSRem))
+                       {
+                               /* Return error code */
+                               return PIPE_RWSTREAM_Timeout;
+                       }
+               }
+               
+               Pipe_Freeze();
+               Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
+               Pipe_Unfreeze();
+
+               /* Check if pipe stalled (command failed by device) */
+               if (Pipe_IsStalled())
+               {
+                       /* Clear the stall condition on the OUT pipe */
+                       USB_Host_ClearPipeStall(SIMAGE_DATA_OUT_PIPE);
+
+                       /* Return error code and break out of the loop */
+                       return PIPE_RWSTREAM_PipeStalled;
+               }
+
+               Pipe_Freeze();
+               Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
+               Pipe_Unfreeze();
+
+               /* Check if pipe stalled (command failed by device) */
+               if (Pipe_IsStalled())
+               {
+                       /* Clear the stall condition on the IN pipe */
+                       USB_Host_ClearPipeStall(SIMAGE_DATA_IN_PIPE);
+
+                       /* Return error code */
+                       return PIPE_RWSTREAM_PipeStalled;
+               }
+                 
+               /* Check to see if the device was disconnected, if so exit function */
+               if (USB_HostState == HOST_STATE_Unattached)
+                 return PIPE_RWSTREAM_DeviceDisconnected;
+       }
+               
+       /* 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 */
+               Pipe_ClearIN();
+       }
+       
+       /* Freeze the IN pipe after use */
+       Pipe_Freeze();
+       
+       return PIPE_RWSTREAM_NoError;
+}
+
+/** Function to send the given data to the device, after a command block has been issued.
+ *
+ *  \param[in] Buffer  Source data buffer to send to the device
+ *  \param[in] Bytes   Number of bytes to send
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+uint8_t SImage_SendData(void* const Buffer, const uint16_t Bytes)
+{
+       uint8_t ErrorCode;
+
+       /* Unfreeze the data OUT pipe */
+       Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
+       Pipe_Unfreeze();
+       
+       /* Write the data contents to the pipe */
+       ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes);
+
+       /* Send the last packet to the attached device */
+       Pipe_ClearOUT();
+
+       /* Freeze the pipe again after use */
+       Pipe_Freeze();
+       
+       return ErrorCode;
+}
+
+/** Function to receive the given data to the device, after a response block has been received.
+ *
+ *  \param[out] Buffer  Destination data buffer to put read bytes from the device
+ *  \param[in] Bytes    Number of bytes to receive
+ *
+ *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
+ */
+uint8_t SImage_ReadData(void* const Buffer, const 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;
+}