X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/f1199200e167a737a4676378da184387e543830c..a9e0935a90346beb0c981924becc1f55d969a08b:/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h diff --git a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h index ad0ba55a2..c6d7f033a 100644 --- a/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h +++ b/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h @@ -1,21 +1,21 @@ /* LUFA Library - Copyright (C) Dean Camera, 2009. + Copyright (C) Dean Camera, 2010. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* - Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, and distribute this software - and its documentation for any purpose and without fee is hereby - granted, 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 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 @@ -37,7 +37,7 @@ #define _STILL_IMAGE_COMMANDS_H_ /* Includes: */ - #include // USB Functionality + #include #include "PIMACodes.h" @@ -50,22 +50,28 @@ /** 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 5000 + #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 params Number of parameters which are to be sent in the Param field of the 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]))) + ((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 datalen Length in bytes of the data in the 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) @@ -79,7 +85,7 @@ 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) */ + uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only) */ } PIMA_Container_t; /* Enums: */ @@ -100,11 +106,10 @@ /* Function Prototypes: */ void SImage_SendBlockHeader(void); - uint8_t SImage_RecieveBlockHeader(void); - void SImage_RecieveEventHeader(void); - void SImage_SendData(void* Buffer, uint16_t Bytes); - uint8_t SImage_ReadData(void* Buffer, uint16_t Bytes); + 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); - uint8_t SImage_ClearPipeStall(const uint8_t EndpointNum); #endif