Protocol.h

Go to the documentation of this file.

#ifndef PROTOCOL_PROTOCOL_H
#define PROTOCOL_PROTOCOL_H

#ifndef ZFORCECOMMON_H
    #error Please include "zForceCommon.h" before this file.
#endif // ZFORCECOMMON_H

typedef struct Protocol Protocol;
struct Protocol
{
    Protocol      * Base; 
    Connection    * Connection;  
    uint64_t        ResponseSerialNumber;

    uint64_t        NotificationSerialNumber;

    void        ( * Destructor)(Protocol * self);

    void        ( * DestroyPrivateDeviceData)(Protocol * self,
                                              void * privateDeviceData);

    zForce        * zForce; 

    bool        ( * Connect)(Protocol * self);

    bool        ( * Disconnect)(Protocol * self);

    bool        ( * DecodeDataFrame) (Protocol * self, DataFrame * dataFrame);
#if 0

    DataFrame * ( * CreateDeviceCountRequest) (Protocol * self,
                                               Device * device,
                                               MessageAction action,
                                               uint32_t totalNumberOfDevices,
                                               bool HasTotalNumberOfDevices,
                                               uint32_t coreDevices,
                                               bool HasCoreDevices,
                                               uint32_t airDevices,
                                               bool HasAirDevices,
                                               uint32_t plusDevices,
                                               bool HasPlusDevices,
                                               uint32_t lightingDevices,
                                               bool HasLightingDevices);
#endif

    DataFrame * ( * CreateResolutionRequest) (Protocol * self,
                                              Device * device,
                                              MessageAction action,
                                              uint32_t x,
                                              bool hasX,
                                              uint32_t y,
                                              bool hasY,
                                              uint32_t z,
                                              bool hasZ);
    DataFrame * ( * CreateTouchActiveAreaRequest) (Protocol * self,
                                                   Device * device,
                                                   MessageAction action,
                                                   uint32_t lowerBoundaryX,
                                                   uint32_t upperBoundaryX,
                                                   bool xIsValid,
                                                   uint32_t lowerBoundaryY,
                                                   uint32_t upperBoundaryY,
                                                   bool yIsValid);

    DataFrame * ( * CreateReverseTouchActiveAreaRequest) (Protocol * self,
                                                          Device * device,
                                                          MessageAction action,
                                                          bool xIsReversed,
                                                          bool yIsReversed);

    DataFrame * ( * CreateMcuUniqueIdentifierRequest) (Protocol * self, Device * device, MessageAction action,
                                                       uint8_t * identifier, uint32_t bufferSize);

    DataFrame * ( * CreateEnableRequest) (Protocol * self,
                                          Device * device,
                                          MessageAction action,
                                          bool continuousMode,
                                          uint32_t numberOfMessages);
    DataFrame * ( * CreateOperationModesRequest) (Protocol * self,
                                                  Device * device,
                                                  MessageAction action,
                                                  OperationModes modeMask,
                                                  OperationModes modeValues);
    DataFrame * ( * CreateDisableRequest) (Protocol * self,
                                           Device * device,
                                           MessageAction action);
    DataFrame * ( * CreateFingerFrequencyRequest) (Protocol * self,
                                                   Device * device,
                                                   MessageAction action,
                                                   uint32_t frequency);
    DataFrame * ( * CreateIdleFrequencyRequest) (Protocol * self,
                                                 Device * device,
                                                 MessageAction action,
                                                 uint32_t frequency);
    DataFrame * ( * CreateDetectedObjectSizeRestrictionRequest)
                     (Protocol * self,
                      Device * device,
                      MessageAction action,
                      bool maximumSizeEnabled,
                      uint32_t maximumSize,
                      bool minimumSizeEnabled,
                      uint32_t minimumSize);

    DataFrame * ( * CreateNumberOfTrackedObjectsRequest)
                        (Protocol * self,
                         Device * device,
                         MessageAction action,
                         uint32_t numberOfTrackedObjects);

    DataFrame * ( * CreateOffsetRequest) (Protocol * self, Device * device, MessageAction action,
                                                                            uint32_t offsetX, bool offsetXIsValid,
                                                                            uint32_t offsetY, bool offsetYIsValid);

    DataFrame * ( * CreateHidDisplaySizeRequest) (Protocol * self, Device * device, MessageAction action,
                                                                   uint32_t sizeX, bool sizeXIsValid,
                                                                   uint32_t sizeY, bool sizeYIsValid);

};

// Exported Functions

DLLEXTERNAL Protocol * Protocol_GetInstance (Connection * connection,
                                             char * protocolString,
                                             char * dataFrameType);

DLLEXTERNAL bool Protocol_AddProtocol (ProtocolEntry * protocolEntry);

DLLINTERNAL bool Protocol_Initialize (void);

DLLINTERNAL void Protocol_Uninitialize (void);

#endif // PROTOCOL_PROTOCOL_H