X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/0d3a3f7536b6b2f22858f82541c383aa3759aa15..3dce79d68ccc50ee1007e485396826762b6965b5:/LUFA/Drivers/USB/Class/Common/StillImage.h

diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h
index 41942d407..2723aeb44 100644
--- a/LUFA/Drivers/USB/Class/Common/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Common/StillImage.h
@@ -52,10 +52,53 @@
 		#endif
 
 	/* Macros: */
+		/** Length in bytes of a given Unicode string's character length
+		 *
+		 *  \param[in] chars  Total number of Unicode characters in the string
+		 */
+		#define UNICODE_STRING_LENGTH(chars)   (chars << 1)
 
+		/** Timeout period between the issuing of a command to a device, and the reception of the first packet */
+		#define COMMAND_DATA_TIMEOUT_MS        5000
+		
+		/** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
+		 *  a command container.
+		 *
+		 *  \param[in] params  Number of parameters which are to be sent in the Param field of the container
+		 */
+		#define PIMA_COMMAND_SIZE(params)      ((sizeof(PIMA_SendBlock) - sizeof(PIMA_SendBlock.Params)) + \
+		                                        (params * sizeof(PIMA_SendBlock.Params[0])))
+
+		/** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
+		 *  a data container.
+		 *
+		 *  \param[in] datalen  Length in bytes of the data in the container
+		 */
+		#define PIMA_DATA_SIZE(datalen)        ((sizeof(PIMA_SendBlock) - sizeof(PIMA_SendBlock.Params)) + datalen)
 
 	/* Type defines: */
+		/** Type define for a PIMA container, use to send commands and receive responses to and from an
+		 *  attached Still Image device.
+		 */
+		typedef struct
+		{
+			uint32_t DataLength; /**< Length of the container and data, in bytes */
+			uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */
+			uint16_t Code; /**< Command, event or response code of the container */
+			uint32_t TransactionID; /**< Unique container ID to link blocks together */
+			uint32_t Params[4]; /**< Block parameters to be issued along with the block code (command blocks only) */
+		} SI_PIMA_Container_t;
 	
+	/* Enums: */
+		/** Enum for the possible PIMA contains types. */
+		enum SI_PIMA_Container_Types_t
+		{
+			CType_Undefined         = 0, /**< Undefined container type */
+			CType_CommandBlock      = 1, /**< Command Block container type */
+			CType_DataBlock         = 2, /**< Data Block container type */
+			CType_ResponseBlock     = 3, /**< Response container type */
+			CType_EventBlock        = 4, /**< Event Block container type */
+		};	
 		
 	/* Enums: */