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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 disclaims 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), NULL);
  59
  60         /* If the block type is a command, send its parameters (if any) */
  61         if (PIMA_SendBlock.Type == PIMA_CONTAINER_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, NULL);
  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  *
  83  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
  84  */
  85 uint8_t SImage_ReceiveEventHeader(void)
  86 {
  87         uint8_t ErrorCode;
  88
  89         /* Unfreeze the events pipe */
  90         Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
  91         Pipe_Unfreeze();
  92
  93         /* Read in the event data into the global structure */
  94         ErrorCode = Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock), NULL);
  95
  96         /* Clear the pipe after read complete to prepare for next event */
  97         Pipe_ClearIN();
  98
  99         /* Freeze the event pipe again after use */
 100         Pipe_Freeze();
 101
 102         return ErrorCode;
 103 }
 104
 105 /** Function to receive a PIMA response container from the attached still image device.
 106  *
 107  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
 108  */
 109 uint8_t SImage_ReceiveBlockHeader(void)
 110 {
 111         uint16_t TimeoutMSRem        = COMMAND_DATA_TIMEOUT_MS;
 112         uint16_t PreviousFrameNumber = USB_Host_GetFrameNumber();
 113
 114         /* Unfreeze the data IN pipe */
 115         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 116         Pipe_Unfreeze();
 117
 118         /* Wait until data received on the IN pipe */
 119         while (!(Pipe_IsINReceived()))
 120         {
 121                 uint16_t CurrentFrameNumber = USB_Host_GetFrameNumber();
 122
 123                 /* Check to see if a new frame has been issued (1ms elapsed) */
 124                 if (CurrentFrameNumber != PreviousFrameNumber)
 125                 {
 126                         /* Save the new frame number and decrement the timeout period */
 127                         PreviousFrameNumber = CurrentFrameNumber;
 128                         TimeoutMSRem--;
 129
 130                         /* Check to see if the timeout period for the command has elapsed */
 131                         if (!(TimeoutMSRem))
 132                           return PIPE_RWSTREAM_Timeout;
 133                 }
 134
 135                 Pipe_Freeze();
 136                 Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 137                 Pipe_Unfreeze();
 138
 139                 /* Check if pipe stalled (command failed by device) */
 140                 if (Pipe_IsStalled())
 141                 {
 142                         /* Clear the stall condition on the OUT pipe */
 143                         USB_Host_ClearEndpointStall(Pipe_GetBoundEndpointAddress());
 144
 145                         /* Return error code and break out of the loop */
 146                         return PIPE_RWSTREAM_PipeStalled;
 147                 }
 148
 149                 Pipe_Freeze();
 150                 Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 151                 Pipe_Unfreeze();
 152
 153                 /* Check if pipe stalled (command failed by device) */
 154                 if (Pipe_IsStalled())
 155                 {
 156                         /* Clear the stall condition on the IN pipe */
 157                         USB_Host_ClearEndpointStall(Pipe_GetBoundEndpointAddress());
 158
 159                         /* Return error code */
 160                         return PIPE_RWSTREAM_PipeStalled;
 161                 }
 162
 163                 /* Check to see if the device was disconnected, if so exit function */
 164                 if (USB_HostState == HOST_STATE_Unattached)
 165                   return PIPE_RWSTREAM_DeviceDisconnected;
 166         }
 167
 168         /* Load in the response from the attached device */
 169         Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0), NULL);
 170
 171         /* Check if the returned block type is a response block */
 172         if (PIMA_ReceivedBlock.Type == PIMA_CONTAINER_ResponseBlock)
 173         {
 174                 /* Determine the size of the parameters in the block via the data length attribute */
 175                 uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));
 176
 177                 /* Check if the device has returned any parameters */
 178                 if (ParamBytes)
 179                 {
 180                         /* Read the PIMA parameters from the data IN pipe */
 181                         Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes, NULL);
 182                 }
 183
 184                 /* Clear pipe bank after use */
 185                 Pipe_ClearIN();
 186         }
 187
 188         /* Freeze the IN pipe after use */
 189         Pipe_Freeze();
 190
 191         return PIPE_RWSTREAM_NoError;
 192 }
 193
 194 /** Function to send the given data to the device, after a command block has been issued.
 195  *
 196  *  \param[in] Buffer  Source data buffer to send to the device
 197  *  \param[in] Bytes   Number of bytes to send
 198  *
 199  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
 200  */
 201 uint8_t SImage_SendData(void* const Buffer,
 202                         const uint16_t Bytes)
 203 {
 204         uint8_t ErrorCode;
 205
 206         /* Unfreeze the data OUT pipe */
 207         Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 208         Pipe_Unfreeze();
 209
 210         /* Write the data contents to the pipe */
 211         ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes, NULL);
 212
 213         /* Send the last packet to the attached device */
 214         Pipe_ClearOUT();
 215
 216         /* Freeze the pipe again after use */
 217         Pipe_Freeze();
 218
 219         return ErrorCode;
 220 }
 221
 222 /** Function to receive the given data from the device, after a response block has been received.
 223  *
 224  *  \param[out] Buffer  Destination data buffer to put read bytes from the device
 225  *  \param[in] Bytes    Number of bytes to receive
 226  *
 227  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
 228  */
 229 uint8_t SImage_ReadData(void* const Buffer,
 230                         const uint16_t Bytes)
 231 {
 232         uint8_t ErrorCode;
 233
 234         /* Unfreeze the data IN pipe */
 235         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 236         Pipe_Unfreeze();
 237
 238         /* Read in the data into the buffer */
 239         ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes, NULL);
 240
 241         /* Freeze the pipe again after use */
 242         Pipe_Freeze();
 243
 244         return ErrorCode;
 245 }
 246
 247 /** Function to test if a PIMA event block is waiting to be read in from the attached device.
 248  *
 249  *  \return True if an event is waiting to be read in from the device, \c false otherwise
 250  */
 251 bool SImage_IsEventReceived(void)
 252 {
 253         bool IsEventReceived = false;
 254
 255         /* Unfreeze the Event pipe */
 256         Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
 257         Pipe_Unfreeze();
 258
 259         /* If the pipe contains data, an event has been received */
 260         if (Pipe_BytesInPipe())
 261           IsEventReceived = true;
 262
 263         /* Freeze the pipe after use */
 264         Pipe_Freeze();
 265
 266         return IsEventReceived;
 267 }
 268