diff options
Diffstat (limited to 'Demos/Host/LowLevel/StillImageHost/Lib')
3 files changed, 431 insertions, 431 deletions
diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/PIMACodes.h b/Demos/Host/LowLevel/StillImageHost/Lib/PIMACodes.h index 41aa04daa6..7bd8d4fe82 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/PIMACodes.h +++ b/Demos/Host/LowLevel/StillImageHost/Lib/PIMACodes.h @@ -1,51 +1,51 @@ -/*
- 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 containing macros for possible PIMA commands. Refer to the PIMA standard
- * documentation for more information on each PIMA command.
- */
-
-#ifndef _PIMA_CODES_H_
-
- /* Macros: */
- #define PIMA_OPERATION_GETDEVICEINFO 0x1001
- #define PIMA_OPERATION_OPENSESSION 0x1002
- #define PIMA_OPERATION_CLOSESESSION 0x1003
-
- #define PIMA_RESPONSE_OK 0x2001
- #define PIMA_RESPONSE_GENERALERROR 0x2002
- #define PIMA_RESPONSE_SESSIONNOTOPEN 0x2003
- #define PIMA_RESPONSE_INVALIDTRANSACTIONID 0x2004
- #define PIMA_RESPONSE_OPERATIONNOTSUPPORTED 0x2005
- #define PIMA_RESPONSE_PARAMETERNOTSUPPORTED 0x2006
-
-#endif
+/* + 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 containing macros for possible PIMA commands. Refer to the PIMA standard + * documentation for more information on each PIMA command. + */ + +#ifndef _PIMA_CODES_H_ + + /* Macros: */ + #define PIMA_OPERATION_GETDEVICEINFO 0x1001 + #define PIMA_OPERATION_OPENSESSION 0x1002 + #define PIMA_OPERATION_CLOSESESSION 0x1003 + + #define PIMA_RESPONSE_OK 0x2001 + #define PIMA_RESPONSE_GENERALERROR 0x2002 + #define PIMA_RESPONSE_SESSIONNOTOPEN 0x2003 + #define PIMA_RESPONSE_INVALIDTRANSACTIONID 0x2004 + #define PIMA_RESPONSE_OPERATIONNOTSUPPORTED 0x2005 + #define PIMA_RESPONSE_PARAMETERNOTSUPPORTED 0x2006 + +#endif diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c index d9fc68a770..5304509885 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c +++ b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.c @@ -1,265 +1,265 @@ -/*
- 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
- *
- * Still Image Device commands, to issue PIMA commands to the device for
- * reading device status, capacity, and other characteristics as well as
- * reading and writing of stored image data.
- */
-
-#include "StillImageCommands.h"
-
-/** PIMA block container for the block to send to the device */
-PIMA_Container_t PIMA_SendBlock;
-
-/** PIMA block container for the last received block from the device */
-PIMA_Container_t PIMA_ReceivedBlock;
-
-/** PIMA block container for the last event block received from the device */
-PIMA_Container_t PIMA_EventBlock;
-
-
-/** Function to send the PIMA command container to the attached still image device. */
-void SImage_SendBlockHeader(void)
-{
- /* Unfreeze the data OUT pipe ready for data transmission */
- Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
- Pipe_Unfreeze();
-
- /* Write the PIMA block to the data OUT pipe */
- Pipe_Write_Stream_LE(&PIMA_SendBlock, PIMA_COMMAND_SIZE(0));
-
- /* If the block type is a command, send its parameters (if any) */
- if (PIMA_SendBlock.Type == CType_CommandBlock)
- {
- /* Determine the size of the parameters in the block via the data length attribute */
- uint8_t ParamBytes = (PIMA_SendBlock.DataLength - PIMA_COMMAND_SIZE(0));
-
- /* Check if any parameters in the command block */
- if (ParamBytes)
- {
- /* Write the PIMA parameters to the data OUT pipe */
- Pipe_Write_Stream_LE(&PIMA_SendBlock.Params, ParamBytes);
- }
-
- /* Send the PIMA command block to the attached device */
- Pipe_ClearOUT();
- }
-
- /* Freeze pipe after use */
- Pipe_Freeze();
-}
-
-/** Function to receive a PIMA event container from the attached still image device.
- *
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
- */
-uint8_t SImage_ReceiveEventHeader(void)
-{
- uint8_t ErrorCode;
-
- /* Unfreeze the events pipe */
- Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
- Pipe_Unfreeze();
-
- /* Read in the event data into the global structure */
- ErrorCode = Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock));
-
- /* Clear the pipe after read complete to prepare for next event */
- Pipe_ClearIN();
-
- /* Freeze the event pipe again after use */
- Pipe_Freeze();
-
- return ErrorCode;
-}
-
-/** Function to receive a PIMA response container from the attached still image device.
- *
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
- */
-uint8_t SImage_ReceiveBlockHeader(void)
-{
- uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS;
-
- /* Unfreeze the data IN pipe */
- Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
- Pipe_Unfreeze();
-
- /* Wait until data received on the IN pipe */
- while (!(Pipe_IsReadWriteAllowed()))
- {
- /* Check to see if a new frame has been issued (1ms elapsed) */
- if (USB_INT_HasOccurred(USB_INT_HSOFI))
- {
- /* Clear the flag and decrement the timeout period counter */
- USB_INT_Clear(USB_INT_HSOFI);
- TimeoutMSRem--;
-
- /* Check to see if the timeout period for the command has elapsed */
- if (!(TimeoutMSRem))
- {
- /* Return error code */
- return PIPE_RWSTREAM_Timeout;
- }
- }
-
- Pipe_Freeze();
- Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
- Pipe_Unfreeze();
-
- /* Check if pipe stalled (command failed by device) */
- if (Pipe_IsStalled())
- {
- /* Clear the stall condition on the OUT pipe */
- USB_Host_ClearPipeStall(SIMAGE_DATA_OUT_PIPE);
-
- /* Return error code and break out of the loop */
- return PIPE_RWSTREAM_PipeStalled;
- }
-
- Pipe_Freeze();
- Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
- Pipe_Unfreeze();
-
- /* Check if pipe stalled (command failed by device) */
- if (Pipe_IsStalled())
- {
- /* Clear the stall condition on the IN pipe */
- USB_Host_ClearPipeStall(SIMAGE_DATA_IN_PIPE);
-
- /* Return error code */
- return PIPE_RWSTREAM_PipeStalled;
- }
-
- /* Check to see if the device was disconnected, if so exit function */
- if (USB_HostState == HOST_STATE_Unattached)
- return PIPE_RWSTREAM_DeviceDisconnected;
- }
-
- /* Load in the response from the attached device */
- Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0));
-
- /* Check if the returned block type is a response block */
- if (PIMA_ReceivedBlock.Type == CType_ResponseBlock)
- {
- /* Determine the size of the parameters in the block via the data length attribute */
- uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0));
-
- /* Check if the device has returned any parameters */
- if (ParamBytes)
- {
- /* Read the PIMA parameters from the data IN pipe */
- Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes);
- }
-
- /* Clear pipe bank after use */
- Pipe_ClearIN();
- }
-
- /* Freeze the IN pipe after use */
- Pipe_Freeze();
-
- return PIPE_RWSTREAM_NoError;
-}
-
-/** Function to send the given data to the device, after a command block has been issued.
- *
- * \param[in] Buffer Source data buffer to send to the device
- * \param[in] Bytes Number of bytes to send
- *
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
- */
-uint8_t SImage_SendData(void* const Buffer, const uint16_t Bytes)
-{
- uint8_t ErrorCode;
-
- /* Unfreeze the data OUT pipe */
- Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE);
- Pipe_Unfreeze();
-
- /* Write the data contents to the pipe */
- ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes);
-
- /* Send the last packet to the attached device */
- Pipe_ClearOUT();
-
- /* Freeze the pipe again after use */
- Pipe_Freeze();
-
- return ErrorCode;
-}
-
-/** Function to receive the given data to the device, after a response block has been received.
- *
- * \param[out] Buffer Destination data buffer to put read bytes from the device
- * \param[in] Bytes Number of bytes to receive
- *
- * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum
- */
-uint8_t SImage_ReadData(void* const Buffer, const uint16_t Bytes)
-{
- uint8_t ErrorCode;
-
- /* Unfreeze the data IN pipe */
- Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE);
- Pipe_Unfreeze();
-
- /* Read in the data into the buffer */
- ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes);
-
- /* Freeze the pipe again after use */
- Pipe_Freeze();
-
- return ErrorCode;
-}
-
-/** Function to test if a PIMA event block is waiting to be read in from the attached device.
- *
- * \return True if an event is waiting to be read in from the device, false otherwise
- */
-bool SImage_IsEventReceived(void)
-{
- bool IsEventReceived = false;
-
- /* Unfreeze the Event pipe */
- Pipe_SelectPipe(SIMAGE_EVENTS_PIPE);
- Pipe_Unfreeze();
-
- /* If the pipe contains data, an event has been received */
- if (Pipe_BytesInPipe())
- IsEventReceived = true;
-
- /* Freeze the pipe after use */
- Pipe_Freeze();
-
- return IsEventReceived;
-}
+/* + 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 + * + * Still Image Device commands, to issue PIMA commands to the device for + * reading device status, capacity, and other characteristics as well as + * reading and writing of stored image data. + */ + +#include "StillImageCommands.h" + +/** PIMA block container for the block to send to the device */ +PIMA_Container_t PIMA_SendBlock; + +/** PIMA block container for the last received block from the device */ +PIMA_Container_t PIMA_ReceivedBlock; + +/** PIMA block container for the last event block received from the device */ +PIMA_Container_t PIMA_EventBlock; + + +/** Function to send the PIMA command container to the attached still image device. */ +void SImage_SendBlockHeader(void) +{ + /* Unfreeze the data OUT pipe ready for data transmission */ + Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE); + Pipe_Unfreeze(); + + /* Write the PIMA block to the data OUT pipe */ + Pipe_Write_Stream_LE(&PIMA_SendBlock, PIMA_COMMAND_SIZE(0)); + + /* If the block type is a command, send its parameters (if any) */ + if (PIMA_SendBlock.Type == CType_CommandBlock) + { + /* Determine the size of the parameters in the block via the data length attribute */ + uint8_t ParamBytes = (PIMA_SendBlock.DataLength - PIMA_COMMAND_SIZE(0)); + + /* Check if any parameters in the command block */ + if (ParamBytes) + { + /* Write the PIMA parameters to the data OUT pipe */ + Pipe_Write_Stream_LE(&PIMA_SendBlock.Params, ParamBytes); + } + + /* Send the PIMA command block to the attached device */ + Pipe_ClearOUT(); + } + + /* Freeze pipe after use */ + Pipe_Freeze(); +} + +/** Function to receive a PIMA event container from the attached still image device. + * + * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum + */ +uint8_t SImage_ReceiveEventHeader(void) +{ + uint8_t ErrorCode; + + /* Unfreeze the events pipe */ + Pipe_SelectPipe(SIMAGE_EVENTS_PIPE); + Pipe_Unfreeze(); + + /* Read in the event data into the global structure */ + ErrorCode = Pipe_Read_Stream_LE(&PIMA_EventBlock, sizeof(PIMA_EventBlock)); + + /* Clear the pipe after read complete to prepare for next event */ + Pipe_ClearIN(); + + /* Freeze the event pipe again after use */ + Pipe_Freeze(); + + return ErrorCode; +} + +/** Function to receive a PIMA response container from the attached still image device. + * + * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum + */ +uint8_t SImage_ReceiveBlockHeader(void) +{ + uint16_t TimeoutMSRem = COMMAND_DATA_TIMEOUT_MS; + + /* Unfreeze the data IN pipe */ + Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE); + Pipe_Unfreeze(); + + /* Wait until data received on the IN pipe */ + while (!(Pipe_IsReadWriteAllowed())) + { + /* Check to see if a new frame has been issued (1ms elapsed) */ + if (USB_INT_HasOccurred(USB_INT_HSOFI)) + { + /* Clear the flag and decrement the timeout period counter */ + USB_INT_Clear(USB_INT_HSOFI); + TimeoutMSRem--; + + /* Check to see if the timeout period for the command has elapsed */ + if (!(TimeoutMSRem)) + { + /* Return error code */ + return PIPE_RWSTREAM_Timeout; + } + } + + Pipe_Freeze(); + Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE); + Pipe_Unfreeze(); + + /* Check if pipe stalled (command failed by device) */ + if (Pipe_IsStalled()) + { + /* Clear the stall condition on the OUT pipe */ + USB_Host_ClearPipeStall(SIMAGE_DATA_OUT_PIPE); + + /* Return error code and break out of the loop */ + return PIPE_RWSTREAM_PipeStalled; + } + + Pipe_Freeze(); + Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE); + Pipe_Unfreeze(); + + /* Check if pipe stalled (command failed by device) */ + if (Pipe_IsStalled()) + { + /* Clear the stall condition on the IN pipe */ + USB_Host_ClearPipeStall(SIMAGE_DATA_IN_PIPE); + + /* Return error code */ + return PIPE_RWSTREAM_PipeStalled; + } + + /* Check to see if the device was disconnected, if so exit function */ + if (USB_HostState == HOST_STATE_Unattached) + return PIPE_RWSTREAM_DeviceDisconnected; + } + + /* Load in the response from the attached device */ + Pipe_Read_Stream_LE(&PIMA_ReceivedBlock, PIMA_COMMAND_SIZE(0)); + + /* Check if the returned block type is a response block */ + if (PIMA_ReceivedBlock.Type == CType_ResponseBlock) + { + /* Determine the size of the parameters in the block via the data length attribute */ + uint8_t ParamBytes = (PIMA_ReceivedBlock.DataLength - PIMA_COMMAND_SIZE(0)); + + /* Check if the device has returned any parameters */ + if (ParamBytes) + { + /* Read the PIMA parameters from the data IN pipe */ + Pipe_Read_Stream_LE(&PIMA_ReceivedBlock.Params, ParamBytes); + } + + /* Clear pipe bank after use */ + Pipe_ClearIN(); + } + + /* Freeze the IN pipe after use */ + Pipe_Freeze(); + + return PIPE_RWSTREAM_NoError; +} + +/** Function to send the given data to the device, after a command block has been issued. + * + * \param[in] Buffer Source data buffer to send to the device + * \param[in] Bytes Number of bytes to send + * + * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum + */ +uint8_t SImage_SendData(void* const Buffer, const uint16_t Bytes) +{ + uint8_t ErrorCode; + + /* Unfreeze the data OUT pipe */ + Pipe_SelectPipe(SIMAGE_DATA_OUT_PIPE); + Pipe_Unfreeze(); + + /* Write the data contents to the pipe */ + ErrorCode = Pipe_Write_Stream_LE(Buffer, Bytes); + + /* Send the last packet to the attached device */ + Pipe_ClearOUT(); + + /* Freeze the pipe again after use */ + Pipe_Freeze(); + + return ErrorCode; +} + +/** Function to receive the given data to the device, after a response block has been received. + * + * \param[out] Buffer Destination data buffer to put read bytes from the device + * \param[in] Bytes Number of bytes to receive + * + * \return A value from the Pipe_Stream_RW_ErrorCodes_t enum + */ +uint8_t SImage_ReadData(void* const Buffer, const uint16_t Bytes) +{ + uint8_t ErrorCode; + + /* Unfreeze the data IN pipe */ + Pipe_SelectPipe(SIMAGE_DATA_IN_PIPE); + Pipe_Unfreeze(); + + /* Read in the data into the buffer */ + ErrorCode = Pipe_Read_Stream_LE(Buffer, Bytes); + + /* Freeze the pipe again after use */ + Pipe_Freeze(); + + return ErrorCode; +} + +/** Function to test if a PIMA event block is waiting to be read in from the attached device. + * + * \return True if an event is waiting to be read in from the device, false otherwise + */ +bool SImage_IsEventReceived(void) +{ + bool IsEventReceived = false; + + /* Unfreeze the Event pipe */ + Pipe_SelectPipe(SIMAGE_EVENTS_PIPE); + Pipe_Unfreeze(); + + /* If the pipe contains data, an event has been received */ + if (Pipe_BytesInPipe()) + IsEventReceived = true; + + /* Freeze the pipe after use */ + Pipe_Freeze(); + + return IsEventReceived; +} diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h index c6d7f033a2..f309abf1b7 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h +++ b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h @@ -1,115 +1,115 @@ -/*
- 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
+/* + 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 |