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  *  Common definitions and declarations for the library USB Still Image Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/StillImage.h.
  38  */
  39
  40 /** \ingroup Group_USBClassSI
  41  *  @defgroup Group_USBClassSICommon  Common Class Definitions
  42  *
  43  *  \section Module Description
  44  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  45  *  Still Image Class.
  46  *
  47  *  @{
  48  */
  49
  50 #ifndef _SI_CLASS_COMMON_H_
  51 #define _SI_CLASS_COMMON_H_
  52
  53         /* Includes: */
  54                 #include "../../USB.h"
  55
  56                 #include <string.h>
  57
  58         /* Enable C linkage for C++ Compilers: */
  59                 #if defined(__cplusplus)
  60                         extern "C" {
  61                 #endif
  62
  63         /* Preprocessor Checks: */
  64                 #if !defined(__INCLUDE_FROM_SI_DRIVER)
  65                         #error Do not include this file directly. Include LUFA/Drivers/Class/StillImage.h instead.
  66                 #endif
  67
  68         /* Macros: */
  69                 /** Length in bytes of a given Unicode string's character length
  70                  *
  71                  *  \param[in] chars  Total number of Unicode characters in the string
  72                  *
  73                  *  \return Number of bytes of the given unicode string
  74                  */
  75                 #define UNICODE_STRING_LENGTH(chars)   ((chars) << 1)
  76
  77                 /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
  78                  *  a command container.
  79                  *
  80                  *  \param[in] params  Number of parameters which are to be sent in the Param field of the container
  81                  */
  82                 #define PIMA_COMMAND_SIZE(params)      ((sizeof(SI_PIMA_Container_t) - 12) + \
  83                                                         ((params) * sizeof(uint32_t)))
  84
  85                 /** Used in the DataLength field of a PIMA container, to give the total container size in bytes for
  86                  *  a data container.
  87                  *
  88                  *  \param[in] datalen  Length in bytes of the data in the container
  89                  */
  90                 #define PIMA_DATA_SIZE(datalen)        ((sizeof(SI_PIMA_Container_t) - 12) + \
  91                                                         (datalen))
  92
  93         /* Enums: */
  94                 /** Enum for the possible PIMA contains types. */
  95                 enum SI_PIMA_Container_Types_t
  96                 {
  97                         CType_Undefined         = 0, /**< Undefined container type */
  98                         CType_CommandBlock      = 1, /**< Command Block container type */
  99                         CType_DataBlock         = 2, /**< Data Block container type */
 100                         CType_ResponseBlock     = 3, /**< Response container type */
 101                         CType_EventBlock        = 4, /**< Event Block container type */
 102                 };
 103
 104         /* Enums: */
 105                 /** Enums for the possible status codes of a returned Response Block from an attached PIMA compliant Still Image device. */
 106                 enum SI_PIMA_ResponseCodes_t
 107                 {
 108                         PIMA_RESPONSE_OK                     = 1, /**< Response code indicating no error in the issued command */
 109                         PIMA_RESPONSE_GeneralError           = 2, /**< Response code indicating a general error while processing the
 110                                                                     *  issued command
 111                                                                     */
 112                         PIMA_RESPONSE_SessionNotOpen         = 3, /**< Response code indicating that the sent command requires an open
 113                                                                    *   session before being issued
 114                                                                    */
 115                         PIMA_RESPONSE_InvalidTransaction     = 4, /**< Response code indicating an invalid transaction occurred */
 116                         PIMA_RESPONSE_OperationNotSupported  = 5, /**< Response code indicating that the issued command is not supported
 117                                                                    *   by the attached device
 118                                                                    */
 119                         PIMA_RESPONSE_ParameterNotSupported  = 6, /**< Response code indicating that one or more of the issued command's
 120                                                                    *   parameters are not supported by the device
 121                                                                    */
 122                 };
 123
 124         /* Type Defines: */
 125                 /** \brief PIMA Still Image Device Command/Response Container.
 126                  *
 127                  *  Type define for a PIMA container, use to send commands and receive responses to and from an
 128                  *  attached Still Image device.
 129                  */
 130                 typedef struct
 131                 {
 132                         uint32_t DataLength; /**< Length of the container and data, in bytes */
 133                         uint16_t Type; /**< Container type, a value from the PIMA_Container_Types_t enum */
 134                         uint16_t Code; /**< Command, event or response code of the container */
 135                         uint32_t TransactionID; /**< Unique container ID to link blocks together */
 136                         uint32_t Params[3]; /**< Block parameters to be issued along with the block code (command blocks only) */
 137                 } SI_PIMA_Container_t;
 138
 139         /* Disable C linkage for C++ Compilers: */
 140                 #if defined(__cplusplus)
 141                         }
 142                 #endif
 143
 144 #endif
 145
 146 /** @} */