-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- * Header file for StillImageCommands.c.\r
- */\r
- \r
-#ifndef _STILL_IMAGE_COMMANDS_H_\r
-#define _STILL_IMAGE_COMMANDS_H_\r
-\r
- /* Includes: */\r
- #include <LUFA/Drivers/USB/USB.h>\r
- \r
- #include "PIMACodes.h"\r
-\r
- /* Macros: */\r
- /** Pipe number of the Still Image data IN pipe */\r
- #define SIMAGE_DATA_IN_PIPE 0x01\r
-\r
- /** Pipe number of the Still Image data OUT pipe */\r
- #define SIMAGE_DATA_OUT_PIPE 0x02\r
-\r
- /** Pipe number of the Still Image events pipe */\r
- #define SIMAGE_EVENTS_PIPE 0x03\r
- \r
- /** Length in bytes of a given Unicode string's character length\r
- *\r
- * \param[in] chars Total number of Unicode characters in the string\r
- */\r
- #define UNICODE_STRING_LENGTH(chars) ((chars) << 1)\r
-\r
- /** Timeout period between the issuing of a command to a device, and the reception of the first packet */\r
- #define COMMAND_DATA_TIMEOUT_MS 10000\r
- \r
- /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for\r
- * a command container.\r
- *\r
- * \param[in] params Number of parameters which are to be sent in the Param field of the container\r
- */\r
- #define PIMA_COMMAND_SIZE(params) ((sizeof(PIMA_SendBlock) - sizeof(PIMA_SendBlock.Params)) + \\r
- ((params) * sizeof(PIMA_SendBlock.Params[0])))\r
-\r
- /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for\r
- * a data container.\r
- *\r
- * \param[in] datalen Length in bytes of the data in the container\r
- */\r
- #define PIMA_DATA_SIZE(datalen) ((sizeof(PIMA_SendBlock) - sizeof(PIMA_SendBlock.Params)) + datalen)\r
-\r
- /* Type Defines: */\r
- /** Type define for a PIMA container, use to send commands and receive responses to and from an\r
- * attached Still Image device.\r
- */\r
- typedef struct\r
- {\r
- uint32_t DataLength; /**< Length of the container and data, in bytes */\r
- uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */\r
- uint16_t Code; /**< Command, event or response code of the container */\r
- uint32_t TransactionID; /**< Unique container ID to link blocks together */\r
- uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only) */\r
- } PIMA_Container_t;\r
- \r
- /* Enums: */\r
- /** Enum for the possible PIMA contains types. */\r
- enum PIMA_Container_Types_t\r
- {\r
- CType_Undefined = 0, /**< Undefined container type */\r
- CType_CommandBlock = 1, /**< Command Block container type */\r
- CType_DataBlock = 2, /**< Data Block container type */\r
- CType_ResponseBlock = 3, /**< Response container type */\r
- CType_EventBlock = 4, /**< Event Block container type */\r
- };\r
- \r
- /* External Variables: */\r
- extern PIMA_Container_t PIMA_SendBlock;\r
- extern PIMA_Container_t PIMA_ReceivedBlock;\r
- extern PIMA_Container_t PIMA_EventBlock;\r
- \r
- /* Function Prototypes: */\r
- void SImage_SendBlockHeader(void);\r
- uint8_t SImage_ReceiveBlockHeader(void);\r
- uint8_t SImage_ReceiveEventHeader(void);\r
- uint8_t SImage_SendData(void* const Buffer, const uint16_t Bytes);\r
- uint8_t SImage_ReadData(void* const Buffer, const uint16_t Bytes);\r
- bool SImage_IsEventReceived(void);\r
-\r
-#endif\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ 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
+ 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
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ *
+ * Header file for StillImageCommands.c.
+ */
+
+#ifndef _STILL_IMAGE_COMMANDS_H_
+#define _STILL_IMAGE_COMMANDS_H_
+
+ /* Includes: */
+ #include <LUFA/Drivers/USB/USB.h>
+
+ #include "PIMACodes.h"
+
+ /* Macros: */
+ /** Pipe number of the Still Image data IN pipe */
+ #define SIMAGE_DATA_IN_PIPE 0x01
+
+ /** Pipe number of the Still Image data OUT pipe */
+ #define SIMAGE_DATA_OUT_PIPE 0x02
+
+ /** Pipe number of the Still Image events pipe */
+ #define SIMAGE_EVENTS_PIPE 0x03
+
+ /** 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 10000
+
+ /** 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[3]; /**< Block parameters to be issued along with the block code (command blocks only) */
+ } PIMA_Container_t;
+
+ /* Enums: */
+ /** Enum for the possible PIMA contains types. */
+ enum 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 */
+ };
+
+ /* External Variables: */
+ extern PIMA_Container_t PIMA_SendBlock;
+ extern PIMA_Container_t PIMA_ReceivedBlock;
+ extern PIMA_Container_t PIMA_EventBlock;
+
+ /* Function Prototypes: */
+ void SImage_SendBlockHeader(void);
+ uint8_t SImage_ReceiveBlockHeader(void);
+ uint8_t SImage_ReceiveEventHeader(void);
+ uint8_t SImage_SendData(void* const Buffer, const uint16_t Bytes);
+ uint8_t SImage_ReadData(void* const Buffer, const uint16_t Bytes);
+ bool SImage_IsEventReceived(void);
+
+#endif
projects / pub / USBasp.git / blobdiff