LUFA/Drivers/USB/Class/Common/StillImage.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Common definitions and declarations for the library USB Still Image Class driver.
  33  *
  34  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  35  *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.
  36  */
  37
  38 /** \ingroup Group_USBClassSI
  39  *  @defgroup Group_USBClassSICommon  Common Class Definitions
  40  *
  41  *  \section Module Description
  42  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  43  *  Still Image Class.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef _SI_CLASS_COMMON_H_
  49 #define _SI_CLASS_COMMON_H_
  50
  51         /* Includes: */
  52                 #include "../../USB.h"
  53
  54                 #include <string.h>
  55
  56         /* Enable C linkage for C++ Compilers: */
  57                 #if defined(__cplusplus)
  58                         extern "C" {
  59                 #endif
  60
  61         /* Preprocessor Checks: */
  62                 #if !defined(__INCLUDE_FROM_SI_DRIVER)
  63                         #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.
  64                 #endif
  65
  66         /* Macros: */
  67                 /** Length in bytes of a given Unicode string's character length
  68                  *
  69                  *  \param[in] chars  Total number of Unicode characters in the string
  70                  *
  71                  *  \return Number of bytes of the given unicode string
  72                  */
  73                 #define UNICODE_STRING_LENGTH(chars)   ((chars) << 1)
  74
  75                 /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
  76                  *  a command container.
  77                  *
  78                  *  \param[in] params  Number of parameters which are to be sent in the Param field of the container
  79                  */
  80                 #define PIMA_COMMAND_SIZE(params)      ((sizeof(SI_PIMA_Container_t) - 12) + \
  81                                                         ((params) * sizeof(uint32_t)))
  82
  83                 /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
  84                  *  a data container.
  85                  *
  86                  *  \param[in] datalen  Length in bytes of the data in the container
  87                  */
  88                 #define PIMA_DATA_SIZE(datalen)        ((sizeof(SI_PIMA_Container_t) - 12) + \
  89                                                         (datalen))
  90
  91         /* Enums: */
  92                 /** Enum for the possible PIMA contains types. */
  93                 enum SI_PIMA_Container_Types_t
  94                 {
  95                         CType_Undefined         = 0, /**< Undefined container type */
  96                         CType_CommandBlock      = 1, /**< Command Block container type */
  97                         CType_DataBlock         = 2, /**< Data Block container type */
  98                         CType_ResponseBlock     = 3, /**< Response container type */
  99                         CType_EventBlock        = 4, /**< Event Block container type */
 100                 };
 101
 102         /* Enums: */
 103                 /** Enums for the possible status codes of a returned Response Block from an attached PIMA compliant Still Image device. */
 104                 enum SI_PIMA_ResponseCodes_t
 105                 {
 106                         PIMA_RESPONSE_OK                     = 1, /**< Response code indicating no error in the issued command */
 107                         PIMA_RESPONSE_GeneralError           = 2, /**< Response code indicating a general error while processing the
 108                                                                     *  issued command
 109                                                                     */
 110                         PIMA_RESPONSE_SessionNotOpen         = 3, /**< Response code indicating that the sent command requires an open
 111                                                                    *   session before being issued
 112                                                                    */
 113                         PIMA_RESPONSE_InvalidTransaction     = 4, /**< Response code indicating an invalid transaction occurred */
 114                         PIMA_RESPONSE_OperationNotSupported  = 5, /**< Response code indicating that the issued command is not supported
 115                                                                    *   by the attached device
 116                                                                    */
 117                         PIMA_RESPONSE_ParameterNotSupported  = 6, /**< Response code indicating that one or more of the issued command's
 118                                                                    *   parameters are not supported by the device
 119                                                                    */
 120                 };
 121
 122         /* Type Defines: */
 123                 /** Type define for a PIMA container, use to send commands and receive responses to and from an
 124                  *  attached Still Image device.
 125                  */
 126                 typedef struct
 127                 {
 128                         uint32_t DataLength; /**< Length of the container and data, in bytes */
 129                         uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */
 130                         uint16_t Code; /**< Command, event or response code of the container */
 131                         uint32_t TransactionID; /**< Unique container ID to link blocks together */
 132                         uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only) */
 133                 } SI_PIMA_Container_t;
 134
 135         /* Disable C linkage for C++ Compilers: */
 136                 #if defined(__cplusplus)
 137                         }
 138                 #endif
 139
 140 #endif
 141
 142 /** @} */