USB_ClassInfo_SI_Host_t Struct Reference

Still Image Class Host Mode Configuration and State Structure. More...

#include <StillImageClassHost.h>

Data Fields
struct {
uint8_t   DataINPipeNumber
bool   DataINPipeDoubleBank
uint8_t   DataOUTPipeNumber
bool   DataOUTPipeDoubleBank
uint8_t   EventsPipeNumber
bool   EventsPipeDoubleBank
}	Config
struct {
bool   IsActive
uint8_t   InterfaceNumber
uint16_t   DataINPipeSize
uint16_t   DataOUTPipeSize
uint16_t   EventsPipeSize
bool   IsSessionOpen
uint32_t   TransactionID
}	State

---

Detailed Description

Class state structure. An instance of this structure should be made within the user application, and passed to each of the Still Image class driver functions as the SIInterfaceInfo parameter. This stores each Still Image interface's configuration and state information.

---

Field Documentation

struct { ... } USB_ClassInfo_SI_Host_t::Config

Config data for the USB class interface within the device. All elements in this section must be set or the interface will fail to enumerate and operate correctly.

bool USB_ClassInfo_SI_Host_t::DataINPipeDoubleBank

Indicates if the Still Image interface's IN data pipe should use double banking.

uint8_t USB_ClassInfo_SI_Host_t::DataINPipeNumber

Pipe number of the Still Image interface's IN data pipe.

uint16_t USB_ClassInfo_SI_Host_t::DataINPipeSize

Size in bytes of the Still Image interface's IN data pipe.

bool USB_ClassInfo_SI_Host_t::DataOUTPipeDoubleBank

Indicates if the Still Image interface's OUT data pipe should use double banking.

uint8_t USB_ClassInfo_SI_Host_t::DataOUTPipeNumber

Pipe number of the Still Image interface's OUT data pipe.

uint16_t USB_ClassInfo_SI_Host_t::DataOUTPipeSize

Size in bytes of the Still Image interface's OUT data pipe.

bool USB_ClassInfo_SI_Host_t::EventsPipeDoubleBank

Indicates if the Still Image interface's events data pipe should use double banking.

uint8_t USB_ClassInfo_SI_Host_t::EventsPipeNumber

Pipe number of the Still Image interface's IN events endpoint, if used.

uint16_t USB_ClassInfo_SI_Host_t::EventsPipeSize

Size in bytes of the Still Image interface's IN events pipe.

uint8_t USB_ClassInfo_SI_Host_t::InterfaceNumber

Interface index of the Still Image interface within the attached device.

bool USB_ClassInfo_SI_Host_t::IsActive

Indicates if the current interface instance is connected to an attached device, valid after SI_Host_ConfigurePipes() is called and the Host state machine is in the Configured state.

bool USB_ClassInfo_SI_Host_t::IsSessionOpen

Indicates if a PIMA session is currently open with the attached device.

struct { ... } USB_ClassInfo_SI_Host_t::State

State data for the USB class interface within the device. All elements in this section may be set to initial values, but may also be ignored to default to sane values when the interface is enumerated.

uint32_t USB_ClassInfo_SI_Host_t::TransactionID

Transaction ID for the next transaction to send to the device.

---

The documentation for this struct was generated from the following file:

• Drivers/USB/Class/Host/StillImageClassHost.h