Add FatFS library to the Webserver project, extend the HTTP server so that it now...

[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 dde7a74..bbdc0d0 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
 /*\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
               \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
 \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
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -29,6 +29,12 @@
 */\r
 \r
 /** \ingroup Group_USBClassSI\r
 */\r
 \r
 /** \ingroup Group_USBClassSI\r

+ *  @defgroup Group_USBClassSICommon  Common Class Definitions\r
+ *\r
+ *  \section Module Description\r
+ *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB\r
+ *  Still Image Class.\r
+ *\r

  *  @{\r
  */\r
 \r
  *  @{\r
  */\r
 \r


@@ -39,24 +45,81 @@
                #include "../../USB.h"\r
 \r
                #include <string.h>\r
                #include "../../USB.h"\r
 \r
                #include <string.h>\r

-\r
+               \r

        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r
        /* Macros: */\r
        /* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        extern "C" {\r
                #endif\r
 \r
        /* Macros: */\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
+                *  \return Number of bytes of the given unicode string\r
+                */\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

 \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

 \r
 \r

-       /* Type defines: */\r
-       \r
+       /* Enums: */\r
+               /** Enum for the possible PIMA contains types. */\r
+               enum SI_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
        /* Enums: */\r
                \r
        /* Enums: */\r

-       \r
+               /** Enums for the possible status codes of a returned Response Block from an attached PIMA compliant Still Image device. */\r
+               enum SI_PIMA_ResponseCodes_t\r
+               {\r
+                       PIMA_RESPONSE_OK                     = 1, /**< Response code indicating no error in the issued command */\r
+                       PIMA_RESPONSE_GeneralError           = 2, /**< Response code indicating a general error while processing the\r
+                                                                   *  issued command\r
+                                                                   */\r
+                       PIMA_RESPONSE_SessionNotOpen         = 3, /**< Response code indicating that the sent command requires an open\r
+                                                                  *   session before being issued\r
+                                                                  */\r
+                       PIMA_RESPONSE_InvalidTransaction     = 4, /**< Response code indicating an invalid transaction occurred */\r
+                       PIMA_RESPONSE_OperationNotSupported  = 5, /**< Response code indicating that the issued command is not supported\r
+                                                                  *   by the attached device\r
+                                                                  */\r
+                       PIMA_RESPONSE_ParameterNotSupported  = 6, /**< Response code indicating that one or more of the issued command's\r
+                                                                  *   parameters are not supported by the device\r
+                                                                  */\r
+               };\r

        \r
        /* Type Defines: */\r
        \r
        /* Type Defines: */\r

-       \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
+               {\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[5]; /**< 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
                #if defined(__cplusplus)\r
                        }\r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
                        }\r