Data Structures | Defines | Enumerations

Common Class Definitions
[Still Image Class Driver - LUFA/Drivers/Class/StillImage.h]

Data Structures

struct  SI_PIMA_Container_t
 PIMA Still Image Device Command/Response Container. More...

Defines

#define UNICODE_STRING_LENGTH(Chars)   ((Chars) << 1)
#define PIMA_COMMAND_SIZE(Params)
#define PIMA_DATA_SIZE(DataLen)

Enumerations

enum  SI_PIMA_Container_Types_t {
  CType_Undefined = 0,
  CType_CommandBlock = 1,
  CType_DataBlock = 2,
  CType_ResponseBlock = 3,
  CType_EventBlock = 4
}
enum  SI_PIMA_ResponseCodes_t {
  PIMA_RESPONSE_OK = 1,
  PIMA_RESPONSE_GeneralError = 2,
  PIMA_RESPONSE_SessionNotOpen = 3,
  PIMA_RESPONSE_InvalidTransaction = 4,
  PIMA_RESPONSE_OperationNotSupported = 5,
  PIMA_RESPONSE_ParameterNotSupported = 6
}

Detailed Description

Description

Constants, Types and Enum definitions that are common to both Device and Host modes for the USB Still Image Class.


Define Documentation

#define PIMA_COMMAND_SIZE (   Params  ) 
Value:
((sizeof(SI_PIMA_Container_t) - 12) + \
                                                ((Params) * sizeof(uint32_t)))

Used in the DataLength field of a PIMA container, to give the total container size in bytes for a command container.

Parameters:
[in] Params Number of parameters which are to be sent in the Param field of the container.
#define PIMA_DATA_SIZE (   DataLen  ) 
Value:
((sizeof(SI_PIMA_Container_t) - 12) + \
                                                (DataLen))

Used in the DataLength field of a PIMA container, to give the total container size in bytes for a data container.

Parameters:
[in] DataLen Length in bytes of the data in the container.
#define UNICODE_STRING_LENGTH (   Chars  )     ((Chars) << 1)

Length in bytes of a given Unicode string's character length.

Parameters:
[in] Chars Total number of Unicode characters in the string.
Returns:
Number of bytes of the given unicode string.

Enumeration Type Documentation

Enum for the possible PIMA contains types.

Enumerator:
CType_Undefined 

Undefined container type.

CType_CommandBlock 

Command Block container type.

CType_DataBlock 

Data Block container type.

CType_ResponseBlock 

Response container type.

CType_EventBlock 

Event Block container type.

Enums for the possible status codes of a returned Response Block from an attached PIMA compliant Still Image device.

Enumerator:
PIMA_RESPONSE_OK 

Response code indicating no error in the issued command.

PIMA_RESPONSE_GeneralError 

Response code indicating a general error while processing the issued command.

PIMA_RESPONSE_SessionNotOpen 

Response code indicating that the sent command requires an open session before being issued.

PIMA_RESPONSE_InvalidTransaction 

Response code indicating an invalid transaction occurred.

PIMA_RESPONSE_OperationNotSupported 

Response code indicating that the issued command is not supported by the attached device.

PIMA_RESPONSE_ParameterNotSupported 

Response code indicating that one or more of the issued command's parameters are not supported by the device.