CAPT_Protocol.h

Go to the documentation of this file.

//*****************************************************************************
// CAPT_Protocol.h
//
//
//
//*****************************************************************************
//*****************************************************************************
//*****************************************************************************

#ifndef CAPT_PROTOCOL_H_
#define CAPT_PROTOCOL_H_

#ifndef S_SPLINT_S
#include <stdio.h>
#include <stdbool.h>
#endif

//
// Include ByteQueue for queue APIs
//
#include "CAPT_ByteQueue.h"

//
// Include CAPT_TL_Type for CapTIvate&tm; types
//
#include "CAPT_Type.h"


//*****************************************************************************
//
//
//
//
//
//
//*****************************************************************************
#define TL_PROTOCOL_SYNC                                        (0x55)
#define TL_PROTOCOL_BLANK                                       (0xAA)
#define TL_PROTOCOL_READ                                        (0x00)
#define TL_PROTOCOL_WRITE                                       (0x01)

//*****************************************************************************
//
//
//
//*****************************************************************************
#define TL_SENSOR_PACKET_CMD                            (0x00)
#define TL_CYCLE_PACKET_CMD                                     (0x01)
#define TL_TRACKPAD_PACKET_CMD                          (0x02)
#define TL_GENERAL_PURPOSE_PACKET_CMD       (0x10)
#define TL_STRING_PACKET_CMD                (0x3E)

#define TL_PARAM_CMD_GENERIC_MASK                       (0x80)
#define TL_PARAM_CMD_SLIDER_WHEEL_MASK          (0x90)
#define TL_PARAM_CMD_TP_MASK                            (0xA0)
#define TL_PARAM_CMD_DYCAL_MASK                         (0xB0)
#define TL_PARAM_CMD_CTRL_MASK                          (0xC0)
#define TL_PARAM_CMD_SPECIAL_MASK                       (0xD0)
#define TL_PARAM_CMD_INVALID_MASK                       (0xF0)

//
// TRACKPAD PARAMETER COMMANDS
//
#define TL_PARAM_CMD_FILTER_ENABLE          (0x60)
#define TL_PARAM_CMD_STATIC_FILTER_BETA     (0x61)
#define TL_PARAM_CMD_HIGH_SPEED_THRESHOLD       (0x63)
#define TL_PARAM_CMD_LOW_SPEED_THRESHOLD    (0x64)
#define TL_PARAM_CMD_LOW_SPEED_BETA             (0x65)
#define TL_PARAM_CMD_FILTER_TYPE                (0x66)
#define TL_PARAM_CMD_RESOLUTION_X                       (0x67)
#define TL_PARAM_CMD_RESOLUTION_Y                       (0x68)
#define TL_PARAM_CMD_LOWER_TRIM_X                       (0x69)
#define TL_PARAM_CMD_UPPER_TRIM_X               (0x6A)
#define TL_PARAM_CMD_LOWER_TRIM_Y                       (0x6B)
#define TL_PARAM_CMD_UPPER_TRIM_Y                       (0x6C)
#define TL_PARAM_CMD_REJECTION_THRESHOLD        (0x6D)

//
// TRACKPAD GESTURE COMMANDS
//
#define TL_PARAM_CMD_TAP_TIME_MIN               (0x70)
#define TL_PARAM_CMD_TAP_TIME_MAX                       (0x71)
#define TL_PARAM_CMD_SWIPE_TIME_MAX                     (0x72)
#define TL_PARAM_CMD_DBLTAP_TIME_MAX            (0x73)
#define TL_PARAM_CMD_TAPHOLD_TIME_MIN           (0x74)
#define TL_PARAM_CMD_SWIPE_DISTANCE_MIN         (0x75)
#define TL_PARAM_CMD_END_TRACKPAD           (0x7F)

//
// TL PARAMETER GENERIC COMMANDS
//
#define TL_PARAM_CMD_CONVERSIONGAIN                     (0x80)
#define TL_PARAM_CMD_CONVERSIONCOUNT            (0x81)
#define TL_PARAM_CMD_PROX_THRESH                        (0x82)
#define TL_PARAM_CMD_TOUCH_THRESH                       (0x83)
#define TL_PARAM_CMD_PROX_DBIN                          (0x84)
#define TL_PARAM_CMD_PROX_DBOUT                         (0x85)
#define TL_PARAM_CMD_TOUCH_DBIN                         (0x86)
#define TL_PARAM_CMD_TOUCH_DBOUT                        (0x87)
#define TL_PARAM_CMD_TIMEOUT                            (0x88)
#define TL_PARAM_CMD_COUNTFILTEN                        (0x89)
#define TL_PARAM_CMD_COUNTFILTBETA                      (0x8A)
#define TL_PARAM_CMD_LTAFILTBETA                        (0x8B)
#define TL_PARAM_CMD_LTAFILTERHALT                      (0x8C)
#define TL_PARAM_CMD_DRIFTRECALENABLE           (0x8D)
#define TL_PARAM_CMD_FORCERECALIBRATE           (0x8E)
#define TL_PARAM_CMD_BIAS_CURRENT                       (0x8F)
#define TL_PARAM_CMD_CS_DISCHARGE                       (0x95)
#define TL_PARAM_CMD_MODENABLE                          (0x96)
#define TL_PARAM_CMD_FREQDIV                            (0x97)
#define TL_PARAM_CMD_CPLEN                                      (0x98)
#define TL_PARAM_CMD_TPLEN                                      (0x99)
#define TL_PARAM_CMD_ERROR_THRESH                       (0x9A)
#define TL_PARAM_CMD_NEG_TOUCH_THRESH           (0x9B)
#define TL_PARAM_CMD_IDLE_STATE                         (0x9C)
#define TL_PARAM_CMD_INPUT_SYNC                         (0x9D)
#define TL_PARAM_CMD_TIMER_SYNC                         (0x9E)
#define TL_PARAM_CMD_LPMCTRL                            (0x9F)
#define TL_PARAM_CMD_LTA_SENSOR_PTHALT          (0xA0)
#define TL_PARAM_CMD_LTA_ELEMENT_PTHALT         (0xA1)
#define TL_PARAM_CMD_COARSE_GAIN_RATIO          (0xA2)
#define TL_PARAM_CMD_FINE_GAIN_RATIO            (0xA3)
#define TL_PARAM_CMD_OFFSET_SUBTRACTION         (0xA4) // Deprecated for 1.00.01.00
#define TL_PARAM_CMD_OFFSET_SCALE           (0xD0) // Added for 1.00.01.00
#define TL_PARAM_CMD_OFFSET_LEVEL           (0xD1) // Added for 1.00.01.00

//
// TL PARAMETER SLIDER/WHEEL COMMANDS
//
#define TL_PARAM_CMD_SLIDER_FILTEREN            (0x90)
#define TL_PARAM_CMD_SLIDER_FILTERBETA          (0x91)
#define TL_PARAM_CMD_SLIDER_RES                         (0x92)
#define TL_PARAM_CMD_SLIDER_LTRIM                       (0x93)
#define TL_PARAM_CMD_SLIDER_UTRIM                       (0x94)


//
// TL PARAMETER CONTROLLER COMMANDS
//
#define TL_PARAM_CMD_CTRL_ELEMENTTXEN           (0xC0)
#define TL_PARAM_CMD_CTRL_SENSORTXEN            (0xC1)
#define TL_PARAM_CMD_CTRL_REPORTRATE_ACTIVE     (0xC2)
#define TL_PARAM_CMD_CTRL_REPORTRATE_AUTO       (0xC3)
#define TL_PARAM_CMD_CTRL_WAKEINTERVAL_AUTO     (0xC4)
#define TL_PARAM_CMD_CTRL_TIMEOUT_ACTIVE        (0xC5)

//*****************************************************************************
//
//
//
//
//
//
//
//
//
//
//
//
//
//*****************************************************************************
#define TL_PCKT_SERIAL_OVRHD_LENGTH                     (0x03)
#define TL_PCKT_CHKSUM_LENGTH                           (0x02)
#define TL_CYCLE_STATE_OFFSET                           (0x06)
#define TL_CYCLE_STATE_LEN                                      (0x03)
#define TL_CYCLE_LEN_PER_ELEMENT                        (0x04)
#define TL_CYCLE_OVRHD_LEN                                      (0x06)
#define TL_SENSOR_PACKET_LENGTH                         (0x0B)
#define TL_PARAMETER_PACKET_LENGTH                      (0x0C)
#define TL_PARAMETER_DATA_LENGTH                        (0x07)
#define TL_GENERAL_PURPOSE_MAX_CNT          (0x1D)
#define TL_STRING_MAX_CNT                   (0x3A)

//*****************************************************************************
//
//
//
//
//
//
//
//
//*****************************************************************************
#define TL_PCKT_CMD_FIELD                                       (0x03)
#define TL_SENSOR_PCKT_ID_FIELD                         (0x04)
#define TL_CYCLE_PCKT_ID_FIELD                          (0x04)
#define TL_CYCLE_PCKT_CYCLE_FIELD                       (0x05)
#define TL_PARAM_PCKT_RW_FIELD                          (0x04)
#define TL_PARAM_PCKT_ID_FIELD                          (0x05)

 //*****************************************************************************
//
//
//
//
//
//*****************************************************************************
/*
 * TRACKPAD PACKET BASE LENGTH
 */

#define TL_TRACKPAD_PACKET_BASE_LENGTH          (0x09)


//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{
        int8_t i8currPacketIndex;
        bool bStuffedByteDetected;
} tTLProtocolProcessingVariables;

//*****************************************************************************
//
//
//*****************************************************************************
enum
{
        eInvalidSensor = 0x00,
        eInvalidCmd = 0x01,
        eValidCmd = 0x02,
        eValidCmdWithReCalibrate = 0x03
};
typedef uint8_t tTLParameterAccessResult;


//*****************************************************************************
//
//
//*****************************************************************************
typedef union
{
        struct
        {
                uint8_t ui8Sync;
                uint8_t ui8Blank;
                uint8_t ui8Length;
                uint8_t ui8Command;
                uint8_t ui8Write;
                uint8_t ui8SensorID;
                uint8_t ui8Param0;
                uint8_t ui8Param1;
                uint8_t ui8Param2;
                uint8_t ui8Param3;
                uint16_t ui16Checksum;
        };
        uint8_t ui8Packet[TL_PARAMETER_PACKET_LENGTH];
} tParameterPacket;
extern tTLParameterAccessResult CAPT_accessTrackPadSensorParameter(tSensor **sensorArray, tParameterPacket *pPacket);
//
// TL Protocol API Prototypes
//

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t CAPT_getCyclePacket(tSensor **sensorArray,
                uint8_t ui8SensorID, uint8_t ui8Cycle, uint8_t *pBuffer);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t CAPT_getSensorPacket(tSensor **sensorArray,
                uint8_t ui8SensorID, uint8_t *pBuffer);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t CAPT_getGeneralPurposePacket(uint16_t *pData,
                uint8_t ui8Cnt, uint8_t *pBuffer);
        
//*****************************************************************************
//
//
//
//
//*****************************************************************************         
extern uint16_t CAPT_getStringPacket(const char *pSrcString, uint8_t *pBuffer);


//*****************************************************************************
//
//
//
//
extern uint16_t CAPT_getTrackPadPacket(tSensor **sensorArray, uint8_t ui8SensorID, uint8_t *pBuffer);



//*****************************************************************************
//
//
//
extern uint16_t CAPT_getTrackPadSensorStatusPacket(tSensor **sensorArray, uint8_t ui8SensorID, uint8_t *pBuffer);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t CAPT_getChecksum(const uint8_t *pBuffer,
                const uint16_t ui16Length);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern bool CAPT_verifyChecksum(const uint8_t *pBuffer, const uint16_t ui16Length,
                const uint16_t ui16Checksum);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t CAPT_stuffSyncBytes(uint8_t *pBuffer,
                uint16_t ui16Length);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern bool CAPT_processReceivedData(tByteQueue *pReceiveQueue,
                tParameterPacket *pPacket, tTLProtocolProcessingVariables *pVariables);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern tTLParameterAccessResult CAPT_accessSensorParameter(
                tSensor **sensorArray, tParameterPacket *pPacket);

//*****************************************************************************
//
//
//
//
//*****************************************************************************         
extern tTLParameterAccessResult CAPT_accessSpecialSensorParameter(
                tSensor **sensorArray, tParameterPacket *pPacket);


//
//
//
//
extern tTLParameterAccessResult CAPT_accessTrackPadSensorParameter(
                tSensor **sensorArray, tParameterPacket *pPacket);

#endif /* CAPT_PROTOCOL_H_ */
//*****************************************************************************
//*****************************************************************************