Bluetooth demo can now create and maintain logical channels - need to determine why...

[pub/USBasp.git] / 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 84dee71..1648431 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/StillImage.h
+++ b/LUFA/Drivers/USB/Class/Common/StillImage.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
 \r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  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
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief Common definitions and declarations for the library USB Still Image Class driver.\r
+ *\r
+ *  Common definitions and declarations for the library USB Still Image Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.\r
+ */\r
+\r
 /** \ingroup Group_USBClassSI\r
  *  @defgroup Group_USBClassSICommon  Common Class Definitions\r
  *\r
@@ -51,6 +60,11 @@
                        extern "C" {\r
                #endif\r
 \r
+       /* Preprocessor Checks: */\r
+               #if !defined(__INCLUDE_FROM_SI_DRIVER)\r
+                       #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.\r
+               #endif\r
+               \r
        /* Macros: */\r
                /** Length in bytes of a given Unicode string's character length\r
                 *\r
@@ -58,23 +72,23 @@
                 *\r
                 *  \return Number of bytes of the given unicode string\r
                 */\r
-               #define UNICODE_STRING_LENGTH(chars)   (chars << 1)\r
+               #define UNICODE_STRING_LENGTH(chars)   ((chars) << 1)\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(SI_PIMA_Container_t) - sizeof(((SI_PIMA_Container_t*)NULL)->Params)) + \\r
-                                                       (params * sizeof(uint32_t)))\r
+               #define PIMA_COMMAND_SIZE(params)      ((sizeof(SI_PIMA_Container_t) - 12) + \\r
+                                                       ((params) * sizeof(uint32_t)))\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(SI_PIMA_Container_t) - sizeof(((SI_PIMA_Container_t*)NULL)->Params)) + \\r
-                                                       datalen)\r
+               #define PIMA_DATA_SIZE(datalen)        ((sizeof(SI_PIMA_Container_t) - 12) + \\r
+                                                       (datalen))\r
 \r
        /* Enums: */\r
                /** Enum for the possible PIMA contains types. */\r
@@ -108,7 +122,9 @@
                };\r
        \r
        /* Type Defines: */\r
-               /** Type define for a PIMA container, use to send commands and receive responses to and from an\r
+               /** \brief PIMA Still Image Device Command/Response Container.\r
+                *\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
@@ -117,7 +133,7 @@
                        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[4]; /**< Block parameters to be issued along with the block code (command blocks only) */\r
+                       uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only) */\r
                } SI_PIMA_Container_t;\r
                \r
        /* Disable C linkage for C++ Compilers: */\r