Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Still Image Device commands, to issue PIMA commands to the device for
  34  *  reading device status, capacity, and other characteristics as well as
  35  *  reading and writing of stored image data.
  36  */
  37
  38 #include "StillImageCommands.h"
  39
  40 /** PIMA block container for the block to send to the device */
  41 PIMA_Container_t PIMA_SendBlock;
  42
  43 /** PIMA block container for the last received block from the device */
  44 PIMA_Container_t PIMA_ReceivedBlock;
  45
  46 /** PIMA block container for the last event block received from the device */
  47 PIMA_Container_t PIMA_EventBlock;
  48
  49
  50 /** Function to send the PIMA command container to the attached still image device. */
  51 void SImage_SendBlockHeader(void)
  52 {
  53         /* Unfreeze the data OUT pipe ready for data transmission */
  54         Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
  55         Pipe_Unfreeze();
  56
  57         /* Write the PIMA block to the data OUT pipe */
  58         Pipe_Write_Stream_LE(&PIMA_SendBlock, PIMA_COMMAND_SIZE(0));
  59
  60         /* If the block type is a command, send its parameters (if any) */
  61         if (PIMA_SendBlock.Type == CType_CommandBlock)
  62         {
  63                 /* Determine the size of the parameters in the block via the data length attribute */
  64                 uint8_t ParamBytes = (PIMA_SendBlock.DataLength - PIMA_COMMAND_SIZE(0));
  65
  66                 /* Check if any parameters in the command block */
  67                 if (ParamBytes)
  68                 {
  69                         /* Write the PIMA parameters to the data OUT pipe */
  70                         Pipe_Write_Stream_LE(&PIMA_SendBlock.Params, ParamBytes);
  71                 }
  72
  73                 /* Send the PIMA command block to the attached device */
  74                 Pipe_ClearOUT();
  75         }
  76
  77         /* Freeze pipe after use */
  78         Pipe_Freeze();
  79 }
  80
  81 /** Function to receive a PIMA event container from the attached still image device. */
  82 uint8_t SImage_ReceiveEventHeader(void)
  83 {
  84         uint8_t ErrorCode;
  85
  86         /* Unfreeze the events pipe */
  87         Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
  88         Pipe_Unfreeze();
  89
  90         /* Read in the event data into the global structure */
  91         ErrorCode = Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock));
  92
  93         /* Clear the pipe after read complete to prepare for next event */
  94         Pipe_ClearIN();
  95
  96         /* Freeze the event pipe again after use */
  97         Pipe_Freeze();
  98
  99         return ErrorCode;
 100 }
 101
 102 /** Function to receive a PIMA response container from the attached still image device. */
 103 uint8_t SImage_ReceiveBlockHeader(void)
 104 {
 105         uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;
 106
 107         /* Unfreeze the data IN pipe */
 108         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 109         Pipe_Unfreeze();
 110
 111         /* Wait until data received on the IN pipe */
 112         while (!(Pipe_IsReadWriteAllowed()))
 113         {
 114                 /* Check to see if a new frame has been issued (1ms elapsed) */
 115                 if (USB_INT_HasOccurred(USB_INT_HSOFI))
 116                 {
 117                         /* Clear the flag and decrement the timeout period counter */
 118                         USB_INT_Clear(USB_INT_HSOFI);
 119                         TimeoutMSRem--;
 120
 121                         /* Check to see if the timeout period for the command has elapsed */
 122                         if (!(TimeoutMSRem))
 123                         {
 124                                 /* Return error code */
 125                                 return PIPE_RWSTREAM_Timeout;
 126                         }
 127                 }
 128
 129                 Pipe_Freeze();
 130                 Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 131                 Pipe_Unfreeze();
 132
 133                 /* Check if pipe stalled (command failed by device) */
 134                 if (Pipe_IsStalled())
 135                 {
 136                         /* Clear the stall condition on the OUT pipe */
 137                         USB_Host_ClearPipeStall(SIMAGE_DATA_OUT_PIPE);
 138
 139                         /* Return error code and break out of the loop */
 140                         return PIPE_RWSTREAM_PipeStalled;
 141                 }
 142
 143                 Pipe_Freeze();
 144                 Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 145                 Pipe_Unfreeze();
 146
 147                 /* Check if pipe stalled (command failed by device) */
 148                 if (Pipe_IsStalled())
 149                 {
 150                         /* Clear the stall condition on the IN pipe */
 151                         USB_Host_ClearPipeStall(SIMAGE_DATA_IN_PIPE);
 152
 153                         /* Return error code */
 154                         return PIPE_RWSTREAM_PipeStalled;
 155                 }
 156
 157                 /* Check to see if the device was disconnected, if so exit function */
 158                 if (USB_HostState == HOST_STATE_Unattached)
 159                   return PIPE_RWSTREAM_DeviceDisconnected;
 160         }
 161
 162         /* Load in the response from the attached device */
 163         Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0));
 164
 165         /* Check if the returned block type is a response block */
 166         if (PIMA_ReceivedBlock.Type == CType_ResponseBlock)
 167         {
 168                 /* Determine the size of the parameters in the block via the data length attribute */
 169                 uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));
 170
 171                 /* Check if the device has returned any parameters */
 172                 if (ParamBytes)
 173                 {
 174                         /* Read the PIMA parameters from the data IN pipe */
 175                         Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes);
 176                 }
 177
 178                 /* Clear pipe bank after use */
 179                 Pipe_ClearIN();
 180         }
 181
 182         /* Freeze the IN pipe after use */
 183         Pipe_Freeze();
 184
 185         return PIPE_RWSTREAM_NoError;
 186 }
 187
 188 /** Function to send the given data to the device, after a command block has been issued.
 189  *
 190  *  \param[in] Buffer  Source data buffer to send to the device
 191  *  \param[in] Bytes   Number of bytes to send
 192  */
 193 uint8_t SImage_SendData(void* Buffer, uint16_t Bytes)
 194 {
 195         uint8_t ErrorCode;
 196
 197         /* Unfreeze the data OUT pipe */
 198         Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 199         Pipe_Unfreeze();
 200
 201         /* Write the data contents to the pipe */
 202         ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes);
 203
 204         /* Send the last packet to the attached device */
 205         Pipe_ClearOUT();
 206
 207         /* Freeze the pipe again after use */
 208         Pipe_Freeze();
 209
 210         return ErrorCode;
 211 }
 212
 213 /** Function to receive the given data to the device, after a response block has been received.
 214  *
 215  *  \param[out] Buffer  Destination data buffer to put read bytes from the device
 216  *  \param[in] Bytes    Number of bytes to receive
 217  *
 218  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
 219  */
 220 uint8_t SImage_ReadData(void* Buffer, uint16_t Bytes)
 221 {
 222         uint8_t ErrorCode;
 223
 224         /* Unfreeze the data IN pipe */
 225         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 226         Pipe_Unfreeze();
 227
 228         /* Read in the data into the buffer */
 229         ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes);
 230
 231         /* Freeze the pipe again after use */
 232         Pipe_Freeze();
 233
 234         return ErrorCode;
 235 }
 236
 237 /** Function to test if a PIMA event block is waiting to be read in from the attached device.
 238  *
 239  *  \return True if an event is waiting to be read in from the device, false otherwise
 240  */
 241 bool SImage_IsEventReceived(void)
 242 {
 243         bool IsEventReceived = false;
 244
 245         /* Unfreeze the Event pipe */
 246         Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
 247         Pipe_Unfreeze();
 248
 249         /* If the pipe contains data, an event has been received */
 250         if (Pipe_BytesInPipe())
 251           IsEventReceived = true;
 252
 253         /* Freeze the pipe after use */
 254         Pipe_Freeze();
 255
 256         return IsEventReceived;
 257 }