Fixed PDI/TPI programming speed of ~250KHz in the AVRISP-MKII Clone project, instead...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / StillImage.c
index 0f4cac0..d3dda8f 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
-              
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  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 
+  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 
+  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
@@ -32,8 +32,8 @@
 #include "../../HighLevel/USBMode.h"
 #if defined(USB_CAN_BE_HOST)
 
-#define  __INCLUDE_FROM_SI_CLASS_HOST_C
 #define  __INCLUDE_FROM_SI_DRIVER
+#define  __INCLUDE_FROM_STILLIMAGE_HOST_C
 #include "StillImage.h"
 
 uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
@@ -46,7 +46,7 @@ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
        USB_Descriptor_Interface_t* StillImageInterface = NULL;
 
        memset(&SIInterfaceInfo->State, 0x00, sizeof(SIInterfaceInfo->State));
-       
+
        if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
          return SI_ENUMERROR_InvalidConfigDescriptor;
 
@@ -57,13 +57,13 @@ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
                                              DCOMP_SI_Host_NextSIInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
                {
                        if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
-                                                                                 DCOMP_SI_Host_NextSIInterface) != DESCRIPTOR_SEARCH_COMP_Found)
+                                                     DCOMP_SI_Host_NextSIInterface) != DESCRIPTOR_SEARCH_COMP_Found)
                        {
                                return SI_ENUMERROR_NoCompatibleInterfaceFound;
                        }
 
                        StillImageInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);
-                       
+
                        DataINEndpoint  = NULL;
                        DataOUTEndpoint = NULL;
                        EventsEndpoint  = NULL;
@@ -85,13 +85,13 @@ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
                        DataOUTEndpoint = EndpointData;
                }
        }
-       
+
        for (uint8_t PipeNum = 1; PipeNum < PIPE_TOTAL_PIPES; PipeNum++)
        {
                if (PipeNum == SIInterfaceInfo->Config.DataINPipeNumber)
                {
                        Pipe_ConfigurePipe(PipeNum, EP_TYPE_BULK, PIPE_TOKEN_IN,
-                                                          DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize,
+                                          DataINEndpoint->EndpointAddress, DataINEndpoint->EndpointSize,
                                           SIInterfaceInfo->Config.DataINPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);
 
                        SIInterfaceInfo->State.DataINPipeSize = DataINEndpoint->EndpointSize;
@@ -113,8 +113,8 @@ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 
                        SIInterfaceInfo->State.EventsPipeSize = EventsEndpoint->EndpointSize;
                }
-       }       
-       
+       }
+
        SIInterfaceInfo->State.InterfaceNumber = StillImageInterface->InterfaceNumber;
        SIInterfaceInfo->State.IsActive = true;
 
@@ -123,38 +123,40 @@ uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 
 uint8_t DCOMP_SI_Host_NextSIInterface(void* const CurrentDescriptor)
 {
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+       if (Header->Type == DTYPE_Interface)
        {
-               USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
-                                                                               USB_Descriptor_Interface_t);
+               USB_Descriptor_Interface_t* Interface = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Interface_t);
 
-               if ((CurrentInterface->Class    == STILL_IMAGE_CLASS)    &&
-                   (CurrentInterface->SubClass == STILL_IMAGE_SUBCLASS) &&
-                   (CurrentInterface->Protocol == STILL_IMAGE_PROTOCOL))
+               if ((Interface->Class    == SI_CSCP_StillImageClass)    &&
+                   (Interface->SubClass == SI_CSCP_StillImageSubclass) &&
+                   (Interface->Protocol == SI_CSCP_BulkOnlyProtocol))
                {
                        return DESCRIPTOR_SEARCH_Found;
                }
        }
-       
+
        return DESCRIPTOR_SEARCH_NotFound;
 }
 
 uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor)
 {
-       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
+       USB_Descriptor_Header_t* Header = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Header_t);
+
+       if (Header->Type == DTYPE_Endpoint)
        {
-               USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
-                                                                             USB_Descriptor_Endpoint_t);
-       
-               uint8_t EndpointType = (CurrentEndpoint->Attributes & EP_TYPE_MASK);
+               USB_Descriptor_Endpoint_t* Endpoint = DESCRIPTOR_PCAST(CurrentDescriptor, USB_Descriptor_Endpoint_t);
+
+               uint8_t EndpointType = (Endpoint->Attributes & EP_TYPE_MASK);
 
                if (((EndpointType == EP_TYPE_BULK) || (EndpointType == EP_TYPE_INTERRUPT)) &&
-                   (!(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress))))
+                   (!(Pipe_IsEndpointBound(Endpoint->EndpointAddress))))
                {
                        return DESCRIPTOR_SEARCH_Found;
                }
        }
-       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
+       else if (Header->Type == DTYPE_Interface)
        {
                return DESCRIPTOR_SEARCH_Fail;
        }
@@ -163,10 +165,10 @@ uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint(void* const CurrentDescriptor)
 }
 
 uint8_t SI_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
-                                SI_PIMA_Container_t* const PIMAHeader)
+                                PIMA_Container_t* const PIMAHeader)
 {
        uint8_t ErrorCode;
-       
+
        if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive))
          return PIPE_RWSTREAM_DeviceDisconnected;
 
@@ -178,7 +180,7 @@ uint8_t SI_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 
        if ((ErrorCode = Pipe_Write_Stream_LE(PIMAHeader, PIMA_COMMAND_SIZE(0), NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
-       
+
        uint8_t ParamBytes = (PIMAHeader->DataLength - PIMA_COMMAND_SIZE(0));
 
        if (ParamBytes)
@@ -186,17 +188,17 @@ uint8_t SI_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
                if ((ErrorCode = Pipe_Write_Stream_LE(&PIMAHeader->Params, ParamBytes, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
                  return ErrorCode;
        }
-       
-       Pipe_ClearOUT();        
+
+       Pipe_ClearOUT();
        Pipe_Freeze();
-       
+
        return PIPE_RWSTREAM_NoError;
 }
 
 uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
-                                   SI_PIMA_Container_t* const PIMAHeader)
+                                   PIMA_Container_t* const PIMAHeader)
 {
-       uint16_t TimeoutMSRem        = COMMAND_DATA_TIMEOUT_MS;
+       uint16_t TimeoutMSRem        = SI_COMMAND_DATA_TIMEOUT_MS;
        uint16_t PreviousFrameNumber = USB_Host_GetFrameNumber();
 
        if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive))
@@ -204,11 +206,11 @@ uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInf
 
        Pipe_SelectPipe(SIInterfaceInfo->Config.DataINPipeNumber);
        Pipe_Unfreeze();
-       
+
        while (!(Pipe_IsINReceived()))
        {
                uint16_t CurrentFrameNumber = USB_Host_GetFrameNumber();
-               
+
                if (CurrentFrameNumber != PreviousFrameNumber)
                {
                        PreviousFrameNumber = CurrentFrameNumber;
@@ -216,7 +218,7 @@ uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInf
                        if (!(TimeoutMSRem--))
                          return PIPE_RWSTREAM_Timeout;
                }
-               
+
                Pipe_Freeze();
                Pipe_SelectPipe(SIInterfaceInfo->Config.DataOUTPipeNumber);
                Pipe_Unfreeze();
@@ -236,25 +238,25 @@ uint8_t SI_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInf
                        USB_Host_ClearPipeStall(SIInterfaceInfo->Config.DataINPipeNumber);
                        return PIPE_RWSTREAM_PipeStalled;
                }
-                 
+
                if (USB_HostState == HOST_STATE_Unattached)
                  return PIPE_RWSTREAM_DeviceDisconnected;
        }
-       
+
        Pipe_Read_Stream_LE(PIMAHeader, PIMA_COMMAND_SIZE(0), NO_STREAM_CALLBACK);
-       
-       if (PIMAHeader->Type == SI_PIMA_CONTAINER_ResponseBlock)
+
+       if (PIMAHeader->Type == PIMA_CONTAINER_ResponseBlock)
        {
                uint8_t ParamBytes = (PIMAHeader->DataLength - PIMA_COMMAND_SIZE(0));
 
                if (ParamBytes)
                  Pipe_Read_Stream_LE(&PIMAHeader->Params, ParamBytes, NO_STREAM_CALLBACK);
-               
+
                Pipe_ClearIN();
        }
-       
+
        Pipe_Freeze();
-       
+
        return PIPE_RWSTREAM_NoError;
 }
 
@@ -269,12 +271,12 @@ uint8_t SI_Host_SendData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 
        Pipe_SelectPipe(SIInterfaceInfo->Config.DataOUTPipeNumber);
        Pipe_Unfreeze();
-       
+
        ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes, NO_STREAM_CALLBACK);
 
        Pipe_ClearOUT();
        Pipe_Freeze();
-       
+
        return ErrorCode;
 }
 
@@ -293,7 +295,7 @@ uint8_t SI_Host_ReadData(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
        ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes, NO_STREAM_CALLBACK);
 
        Pipe_Freeze();
-       
+
        return ErrorCode;
 }
 
@@ -306,17 +308,17 @@ bool SI_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
 
        Pipe_SelectPipe(SIInterfaceInfo->Config.EventsPipeNumber);
        Pipe_Unfreeze();
-       
+
        if (Pipe_BytesInPipe())
          IsEventReceived = true;
-       
+
        Pipe_Freeze();
-       
+
        return IsEventReceived;
 }
 
 uint8_t SI_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
-                                   SI_PIMA_Container_t* const PIMAHeader)
+                                   PIMA_Container_t* const PIMAHeader)
 {
        uint8_t ErrorCode;
 
@@ -325,12 +327,12 @@ uint8_t SI_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceInf
 
        Pipe_SelectPipe(SIInterfaceInfo->Config.EventsPipeNumber);
        Pipe_Unfreeze();
-       
-       ErrorCode = Pipe_Read_Stream_LE(PIMAHeader, sizeof(SI_PIMA_Container_t), NO_STREAM_CALLBACK);
-       
+
+       ErrorCode = Pipe_Read_Stream_LE(PIMAHeader, sizeof(PIMA_Container_t), NO_STREAM_CALLBACK);
+
        Pipe_ClearIN();
        Pipe_Freeze();
-       
+
        return ErrorCode;
 }
 
@@ -344,23 +346,23 @@ uint8_t SI_Host_OpenSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
        SIInterfaceInfo->State.TransactionID = 0;
        SIInterfaceInfo->State.IsSessionOpen = false;
 
-       SI_PIMA_Container_t PIMABlock = (SI_PIMA_Container_t)
+       PIMA_Container_t PIMABlock = (PIMA_Container_t)
                {
                        .DataLength    = PIMA_COMMAND_SIZE(1),
-                       .Type          = SI_PIMA_CONTAINER_CommandBlock,
+                       .Type          = PIMA_CONTAINER_CommandBlock,
                        .Code          = 0x1002,
                        .Params        = {1},
                };
-       
+
        if ((ErrorCode = SI_Host_SendBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
-         
+
        if ((ErrorCode = SI_Host_ReceiveBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
-         
-       if ((PIMABlock.Type != SI_PIMA_CONTAINER_ResponseBlock) || (PIMABlock.Code != 0x2001))
+
+       if ((PIMABlock.Type != PIMA_CONTAINER_ResponseBlock) || (PIMABlock.Code != 0x2001))
          return SI_ERROR_LOGICAL_CMD_FAILED;
-         
+
        SIInterfaceInfo->State.IsSessionOpen = true;
 
        return PIPE_RWSTREAM_NoError;
@@ -373,23 +375,23 @@ uint8_t SI_Host_CloseSession(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
 
        uint8_t ErrorCode;
 
-       SI_PIMA_Container_t PIMABlock = (SI_PIMA_Container_t)
+       PIMA_Container_t PIMABlock = (PIMA_Container_t)
                {
                        .DataLength    = PIMA_COMMAND_SIZE(1),
-                       .Type          = SI_PIMA_CONTAINER_CommandBlock,
+                       .Type          = PIMA_CONTAINER_CommandBlock,
                        .Code          = 0x1003,
                        .Params        = {1},
                };
-       
+
        if ((ErrorCode = SI_Host_SendBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
-         
+
        if ((ErrorCode = SI_Host_ReceiveBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
 
        SIInterfaceInfo->State.IsSessionOpen = false;
 
-       if ((PIMABlock.Type != SI_PIMA_CONTAINER_ResponseBlock) || (PIMABlock.Code != 0x2001))
+       if ((PIMABlock.Type != PIMA_CONTAINER_ResponseBlock) || (PIMABlock.Code != 0x2001))
          return SI_ERROR_LOGICAL_CMD_FAILED;
 
        return PIPE_RWSTREAM_NoError;
@@ -405,15 +407,15 @@ uint8_t SI_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 
        uint8_t ErrorCode;
 
-       SI_PIMA_Container_t PIMABlock = (SI_PIMA_Container_t)
+       PIMA_Container_t PIMABlock = (PIMA_Container_t)
                {
                        .DataLength    = PIMA_COMMAND_SIZE(TotalParams),
-                       .Type          = SI_PIMA_CONTAINER_CommandBlock,
+                       .Type          = PIMA_CONTAINER_CommandBlock,
                        .Code          = Operation,
                };
-                                                       
+
        memcpy(&PIMABlock.Params, Params, sizeof(uint32_t) * TotalParams);
-                                                       
+
        if ((ErrorCode = SI_Host_SendBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
 
@@ -423,7 +425,7 @@ uint8_t SI_Host_SendCommand(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo,
 uint8_t SI_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
 {
        uint8_t ErrorCode;
-       SI_PIMA_Container_t PIMABlock;
+       PIMA_Container_t PIMABlock;
 
        if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive))
          return HOST_SENDCONTROL_DeviceDisconnected;
@@ -431,10 +433,11 @@ uint8_t SI_Host_ReceiveResponse(USB_ClassInfo_SI_Host_t* const SIInterfaceInfo)
        if ((ErrorCode = SI_Host_ReceiveBlockHeader(SIInterfaceInfo, &PIMABlock)) != PIPE_RWSTREAM_NoError)
          return ErrorCode;
 
-       if ((PIMABlock.Type != SI_PIMA_CONTAINER_ResponseBlock) || (PIMABlock.Code != 0x2001))
+       if ((PIMABlock.Type != PIMA_CONTAINER_ResponseBlock) || (PIMABlock.Code != 0x2001))
          return SI_ERROR_LOGICAL_CMD_FAILED;
-         
+
        return PIPE_RWSTREAM_NoError;
 }
 
 #endif
+