LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
StillImageClassHost.c File Reference

Go to the source code of this file.

Functions

uint8_t SI_Host_ConfigurePipes (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, uint16_t ConfigDescriptorSize, void *ConfigDescriptorData)
 Host interface configuration routine, to configure a given Still Image host interface instance using the Configuration Descriptor read from an attached USB device. This function automatically updates the given Still Image Host instance's state values and configures the pipes required to communicate with the interface if it is found within the device. This should be called once after the stack has enumerated the attached device, while the host state machine is in the Addressed state.
 
uint8_t DCOMP_SI_Host_NextSIInterface (void *const CurrentDescriptor)
 
uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint (void *const CurrentDescriptor)
 
uint8_t SI_Host_SendBlockHeader (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, PIMA_Container_t *const PIMAHeader)
 Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send arbitrary PIMA blocks to the device with or without parameters.
 
uint8_t SI_Host_ReceiveBlockHeader (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, PIMA_Container_t *const PIMAHeader)
 Receives a raw PIMA block header from the device. This can be used to receive arbitrary PIMA blocks from the device with or without parameters.
 
uint8_t SI_Host_SendData (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, void *Buffer, const uint16_t Bytes)
 Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data transfer beyond the regular PIMA command block parameters.
 
uint8_t SI_Host_ReadData (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, void *Buffer, const uint16_t Bytes)
 Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data transfer beyond the regular PIMA command block parameters.
 
bool SI_Host_IsEventReceived (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo)
 Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe.
 
uint8_t SI_Host_ReceiveEventHeader (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, PIMA_Container_t *const PIMAHeader)
 Receives an asynchronous event block from the device via the asynchronous events pipe.
 
uint8_t SI_Host_OpenSession (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo)
 Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands are issued to the device. Only one session can be open at the one time.
 
uint8_t SI_Host_CloseSession (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo)
 Closes an already opened PIMA session with the attached device. This should be used after all session-orientated PIMA commands have been issued to the device.
 
uint8_t SI_Host_SendCommand (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo, const uint16_t Operation, const uint8_t TotalParams, uint32_t *const Params)
 Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically.
 
uint8_t SI_Host_ReceiveResponse (USB_ClassInfo_SI_Host_t *const SIInterfaceInfo)
 Receives and checks a response block from the attached Still Image device, once a command has been issued and all data associated with the command has been transferred.
 

Function Documentation

uint8_t DCOMP_SI_Host_NextSIInterface ( void *const  CurrentDescriptor)

Definition at line 157 of file StillImageClassHost.c.

uint8_t DCOMP_SI_Host_NextSIInterfaceEndpoint ( void *const  CurrentDescriptor)

Definition at line 176 of file StillImageClassHost.c.