X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/b7049da11b6fe3c37b23d8f7dddfff08ba14f449..064e6a2f32719da5b7ed2ff3a8a32c5788e753d0:/LUFA/Drivers/USB/Class/Host/StillImage.h

diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h
index c83ad5bd5..75f76eb8e 100644
--- a/LUFA/Drivers/USB/Class/Host/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Host/StillImage.h
@@ -28,9 +28,13 @@
   this software.
 */
 
-/** \ingroup Group_USBClassStillImage
+/** \ingroup Group_USBClassSI
  *  @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Host/StillImage.c
+ *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the Still Image USB Class driver.
  *
@@ -50,8 +54,114 @@
 		#endif
 
 	/* Public Interface - May be used in end-application: */
+		/* Macros: */
+			#define SI_ERROR_LOGICAL_CMD_FAILED              0xC0
+
+		/* Type Defines: */
+			typedef struct
+			{
+				const struct
+				{
+					uint8_t  DataINPipeNumber; /**< Pipe number of the Still Image interface's IN data pipe */
+					uint8_t  DataOUTPipeNumber; /**< Pipe number of the Still Image interface's OUT data pipe */
+					uint8_t  EventsPipeNumber; /**< Pipe number of the Still Image interface's IN events endpoint, if used */			
+				} Config; /**< Config data for the USB class interface within the device. All elements in this section
+				           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
+				           */
+				struct
+				{
+					bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
+					                *   after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the
+					                *   Configured state
+					                */
+
+					uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe */
+					uint16_t DataOUTPipeSize;  /**< Size in bytes of the Still Image interface's OUT data pipe */
+					uint16_t EventsPipeSize;  /**< Size in bytes of the Still Image interface's IN events pipe */
+					
+					bool IsSessionOpen; /**< Indicates if a PIMA session is currently open with the attached device */
+					uint32_t TransactionID; /**< Transaction ID for the next transaction to send to the device */
+				} State; /**< State data for the USB class interface within the device. All elements in this section
+						  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
+						  *   the interface is enumerated.
+						  */
+			} USB_ClassInfo_SI_Host_t;
+	
+		/* Enums: */
+			/** Enum for the possible error codes returned by the \ref SI_Host_ConfigurePipes() function. */
+			enum SIHost_EnumerationFailure_ErrorCodes_t
+			{
+				SI_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
+				SI_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
+				SI_ENUMERROR_NoSIInterfaceFound         = 2, /**< A compatible Still Image interface was not found in the device's
+				                                             *   Configuration Descriptor
+				                                             */
+				SI_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Still Image data endpoints were not found in the
+				                                              *   device's Still Image interface
+				                                              */
+			};
+
 		/* Function Prototypes: */
+			/** General management task for a given Still Image host class interface, required for the correct operation of the
+			 *  interface. This should be called frequently in the main program loop, before the master USB management task
+			 *  \ref USB_USBTask().
+			 *
+			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
+			 */
+			void SI_Host_USBTask(USB_ClassInfo_SI_Host_t* SIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
+
+
+			/** Host interface configuration routine, to configure a given Still Image host interface instance using the
+			 *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Still
+			 *  Image Host instance's state values and configures the pipes required to communicate with the interface if it is
+			 *  found within the device. This should be called once after the stack has enumerated the attached device, while
+			 *  the host state machine is in the Addressed state.
+			 *
+			 *  \param[in,out] SIInterfaceInfo  Pointer to a structure containing a Still Image Class host configuration and state
+			 *  \param[in] ConfigDescriptorLength  Length of the attached device's Configuration Descriptor
+			 *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+			 *
+			 *  \return A value from the \ref SIHost_EnumerationFailure_ErrorCodes_t enum
+			 */
+			uint8_t SI_Host_ConfigurePipes(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t ConfigDescriptorLength,
+                                           uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
+
+			uint8_t SImage_Host_OpenSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
+			uint8_t SImage_Host_CloseSession(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
+
+			uint8_t SImage_Host_SendCommand(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, uint16_t Operation, uint8_t UsedParams,
+			                                uint32_t Param1, uint32_t Param2, uint32_t Param3, void* DataBuff);
+			
+	/* Private Interface - For use in library only: */
+	#if !defined(__DOXYGEN__)
+		/* Macros: */
+			#define STILL_IMAGE_CLASS              0x06
+			#define STILL_IMAGE_SUBCLASS           0x01
+			#define STILL_IMAGE_PROTOCOL           0x01
+
+			#define SI_FOUND_EVENTS_IN             (1 << 0)
+			#define SI_FOUND_DATAPIPE_IN           (1 << 1)
+			#define SI_FOUND_DATAPIPE_OUT          (1 << 2)
+
+			#define COMMAND_DATA_TIMEOUT_MS        5000
 		
+		/* Function Prototypes: */
+			#if defined(INCLUDE_FROM_SI_CLASS_HOST_C)
+				static uint8_t DComp_SI_Host_NextSIInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+				static uint8_t DComp_SI_Host_NextSIInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+
+				static uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
+				                                           SI_PIMA_Container_t* PIMAHeader);
+				static uint8_t SImage_Host_ReceiveBlockHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
+				                                              SI_PIMA_Container_t* PIMAHeader);
+				static uint8_t SImage_Host_SendData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);
+				static uint8_t SImage_Host_ReadData(USB_ClassInfo_SI_Host_t* SIInterfaceInfo, void* Buffer, uint16_t Bytes);
+				static bool SImage_Host_IsEventReceived(USB_ClassInfo_SI_Host_t* SIInterfaceInfo);
+				static uint8_t SImage_Host_ReceiveEventHeader(USB_ClassInfo_SI_Host_t* SIInterfaceInfo,
+				                                              SI_PIMA_Container_t* PIMAHeader);
+			#endif
+	#endif
+	
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)
 			}