Demos/Host/ClassDriver/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 /* Globals: */
  41 /** PIMA block container for the block to send to the device */
  42 PIMA_Container_t PIMA_SendBlock;
  43
  44 /** PIMA block container for the last received block from the device */
  45 PIMA_Container_t PIMA_ReceivedBlock;
  46
  47 /** PIMA block container for the last event block received from the device */
  48 PIMA_Container_t PIMA_EventBlock;
  49
  50
  51 /** Function to send the PIMA command container to the attached still image device. */
  52 void SImage_SendBlockHeader(void)
  53 {
  54         /* Unfreeze the data OUT pipe ready for data transmission */
  55         Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
  56         Pipe_Unfreeze();
  57
  58         /* Write the PIMA block to the data OUT pipe */
  59         Pipe_Write_Stream_LE(&PIMA_SendBlock, PIMA_COMMAND_SIZE(0));
  60
  61         /* If the block type is a command, send its parameters (if any) */
  62         if (PIMA_SendBlock.Type == CType_CommandBlock)
  63         {
  64                 /* Determine the size of the parameters in the block via the data length attribute */
  65                 uint8_t ParamBytes = (PIMA_SendBlock.DataLength - PIMA_COMMAND_SIZE(0));
  66
  67                 /* Check if any parameters in the command block */
  68                 if (ParamBytes)
  69                 {
  70                         /* Write the PIMA parameters to the data OUT pipe */
  71                         Pipe_Write_Stream_LE(&PIMA_SendBlock.Params, ParamBytes);
  72                 }
  73
  74                 /* Send the PIMA command block to the attached device */
  75                 Pipe_ClearOUT();
  76         }
  77
  78         /* Freeze pipe after use */
  79         Pipe_Freeze();
  80 }
  81
  82 /** Function to receive a PIMA event container from the attached still image device. */
  83 void SImage_RecieveEventHeader(void)
  84 {
  85         /* Unfreeze the events pipe */
  86         Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
  87         Pipe_Unfreeze();
  88
  89         /* Read in the event data into the global structure */
  90         Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock));
  91
  92         /* Clear the pipe after read complete to prepare for next event */
  93         Pipe_ClearIN();
  94
  95         /* Freeze the event pipe again after use */
  96         Pipe_Freeze();
  97 }
  98
  99 /** Function to receive a PIMA response container from the attached still image device. */
 100 uint8_t SImage_RecieveBlockHeader(void)
 101 {
 102         uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;
 103
 104         /* Unfreeze the data IN pipe */
 105         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 106         Pipe_Unfreeze();
 107
 108         /* Wait until data received on the IN pipe */
 109         while (!(Pipe_IsReadWriteAllowed()))
 110         {
 111                 /* Check to see if a new frame has been issued (1ms elapsed) */
 112                 if (USB_INT_HasOccurred(USB_INT_HSOFI))
 113                 {
 114                         /* Clear the flag and decrement the timeout period counter */
 115                         USB_INT_Clear(USB_INT_HSOFI);
 116                         TimeoutMSRem--;
 117
 118                         /* Check to see if the timeout period for the command has elapsed */
 119                         if (!(TimeoutMSRem))
 120                         {
 121                                 /* Return error code */
 122                                 return PIPE_RWSTREAM_Timeout;
 123                         }
 124                 }
 125
 126                 Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 127
 128                 /* Check if pipe stalled (command failed by device) */
 129                 if (Pipe_IsStalled())
 130                 {
 131                         /* Clear the stall condition on the OUT pipe */
 132                         SImage_ClearPipeStall(SIMAGE_DATA_OUT_PIPE);
 133
 134                         /* Return error code and break out of the loop */
 135                         return PIPE_RWSTREAM_PipeStalled;
 136                 }
 137
 138                 Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 139
 140                 /* Check if pipe stalled (command failed by device) */
 141                 if (Pipe_IsStalled())
 142                 {
 143                         /* Clear the stall condition on the IN pipe */
 144                         SImage_ClearPipeStall(SIMAGE_DATA_IN_PIPE);
 145
 146                         /* Return error code */
 147                         return PIPE_RWSTREAM_PipeStalled;
 148                 }
 149
 150                 /* Check to see if the device was disconnected, if so exit function */
 151                 if (!(USB_IsConnected))
 152                 {
 153                         /* Return error code */
 154                         return PIPE_RWSTREAM_DeviceDisconnected;
 155                 }
 156         };
 157
 158         /* Freeze OUT pipe after use */
 159         Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 160         Pipe_Freeze();
 161
 162         /* Select the IN data pipe for data reception */
 163         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 164
 165         /* Load in the response from the attached device */
 166         Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0));
 167
 168         /* Check if the returned block type is a response block */
 169         if (PIMA_ReceivedBlock.Type == CType_ResponseBlock)
 170         {
 171                 /* Determine the size of the parameters in the block via the data length attribute */
 172                 uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));
 173
 174                 /* Check if the device has returned any parameters */
 175                 if (ParamBytes)
 176                 {
 177                         /* Read the PIMA parameters from the data IN pipe */
 178                         Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes);
 179                 }
 180
 181                 /* Clear pipe bank after use */
 182                 Pipe_ClearIN();
 183         }
 184
 185         /* Freeze the IN pipe after use */
 186         Pipe_Freeze();
 187
 188         return PIPE_RWSTREAM_NoError;
 189 }
 190
 191 /** Function to send the given data to the device, after a command block has been issued.
 192  *
 193  *  \param Buffer  Source data buffer to send to the device
 194  *  \param Bytes   Number of bytes to send
 195  */
 196 void SImage_SendData(void* Buffer, uint16_t Bytes)
 197 {
 198         /* Unfreeze the data OUT pipe */
 199         Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
 200         Pipe_Unfreeze();
 201
 202         /* Write the data contents to the pipe */
 203         Pipe_Write_Stream_LE(Buffer, Bytes);
 204
 205         /* Send the last packet to the attached device */
 206         Pipe_ClearOUT();
 207
 208         /* Freeze the pipe again after use */
 209         Pipe_Freeze();
 210 }
 211
 212 /** Function to receive the given data to the device, after a response block has been received.
 213  *
 214  *  \param Buffer  Destination data buffer to put read bytes from the device
 215  *  \param Bytes   Number of bytes to receive
 216  *
 217  *  \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
 218  */
 219 uint8_t SImage_ReadData(void* Buffer, uint16_t Bytes)
 220 {
 221         uint8_t ErrorCode;
 222
 223         /* Unfreeze the data IN pipe */
 224         Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
 225         Pipe_Unfreeze();
 226
 227         /* Read in the data into the buffer */
 228         ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes);
 229
 230         /* Freeze the pipe again after use */
 231         Pipe_Freeze();
 232
 233         return ErrorCode;
 234 }
 235
 236 /** Function to test if a PIMA event block is waiting to be read in from the attached device.
 237  *
 238  *  \return True if an event is waiting to be read in from the device, false otherwise
 239  */
 240 bool SImage_IsEventReceived(void)
 241 {
 242         bool IsEventReceived = false;
 243
 244         /* Unfreeze the Event pipe */
 245         Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
 246         Pipe_Unfreeze();
 247
 248         /* If the pipe contains data, an event has been received */
 249         if (Pipe_BytesInPipe())
 250           IsEventReceived = true;
 251
 252         /* Freeze the pipe after use */
 253         Pipe_Freeze();
 254
 255         return IsEventReceived;
 256 }
 257
 258 /** Clears the stall condition in the attached device on the nominated endpoint number.
 259  *
 260  *  \param EndpointNum  Endpoint number in the attached device whose stall condition is to be cleared
 261  *
 262  *  \return A value from the USB_Host_SendControlErrorCodes_t enum
 263  */
 264 uint8_t SImage_ClearPipeStall(const uint8_t EndpointNum)
 265 {
 266         USB_ControlRequest = (USB_Request_Header_t)
 267                 {
 268                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_ENDPOINT),
 269                         .bRequest      = REQ_ClearFeature,
 270                         .wValue        = FEATURE_ENDPOINT_HALT,
 271                         .wIndex        = EndpointNum,
 272                         .wLength       = 0,
 273                 };
 274
 275         /* Select the control pipe for the request transfer */
 276         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 277
 278         return USB_Host_SendControlRequest(NULL);
 279 }