1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2006-2014 MStar Semiconductor, Inc.
// All rights reserved.
//
// Unless otherwise stipulated in writing, any and all information contained
// herein regardless in any format shall remain the sole proprietary of
// MStar Semiconductor Inc. and be kept in strict confidence
// (??MStar Confidential Information??) by the recipient.
// Any unauthorized act including without limitation unauthorized disclosure,
// copying, use, reproduction, sale, distribution, modification, disassembling,
// reverse engineering and compiling of the contents of MStar Confidential
// Information is unlawful and strictly prohibited. MStar hereby reserves the
// rights to any and all damages, losses, costs and expenses resulting therefrom.
//
////////////////////////////////////////////////////////////////////////////////
/**
*
* @file mstar_drv_mutual_fw_control.h
*
* @brief This file defines the interface of touch screen
*
*
*/
#ifndef __MSTAR_DRV_MUTUAL_FW_CONTROL_H__
#define __MSTAR_DRV_MUTUAL_FW_CONTROL_H__
/*--------------------------------------------------------------------------*/
/* INCLUDE FILE */
/*--------------------------------------------------------------------------*/
#include "mstar_drv_common.h"
#ifdef CONFIG_ENABLE_HOTKNOT
#include "mstar_drv_hotknot.h"
#endif //CONFIG_ENABLE_HOTKNOT
#if defined(CONFIG_ENABLE_TOUCH_DRIVER_FOR_MUTUAL_IC)
/*--------------------------------------------------------------------------*/
/* PREPROCESSOR CONSTANT DEFINITION */
/*--------------------------------------------------------------------------*/
#define DEMO_MODE_PACKET_LENGTH (43)
#define MAX_TOUCH_NUM (10)
#define MSG26XXM_FIRMWARE_MAIN_BLOCK_SIZE (32) //32K
#define MSG26XXM_FIRMWARE_INFO_BLOCK_SIZE (8) //8K
#define MSG26XXM_FIRMWARE_WHOLE_SIZE (MSG26XXM_FIRMWARE_MAIN_BLOCK_SIZE+MSG26XXM_FIRMWARE_INFO_BLOCK_SIZE) //40K
#define MSG28XX_FIRMWARE_MAIN_BLOCK_SIZE (128) //128K
#define MSG28XX_FIRMWARE_INFO_BLOCK_SIZE (2) //2K
#define MSG28XX_FIRMWARE_WHOLE_SIZE (MSG28XX_FIRMWARE_MAIN_BLOCK_SIZE+MSG28XX_FIRMWARE_INFO_BLOCK_SIZE) //130K
#define MSG28XX_EMEM_SIZE_BYTES_PER_ONE_PAGE (128)
#define MSG28XX_EMEM_SIZE_BYTES_ONE_WORD (4)
#define MSG28XX_EMEM_MAIN_MAX_ADDR (0x3FFF) //0~0x3FFF = 0x4000 = 16384 = 65536/4
#define MSG28XX_EMEM_INFO_MAX_ADDR (0x1FF) //0~0x1FF = 0x200 = 512 = 2048/4
#define MSG26XXM_FIRMWARE_MODE_UNKNOWN_MODE (0xFFFF)
#define MSG26XXM_FIRMWARE_MODE_DEMO_MODE (0x0005)
#define MSG26XXM_FIRMWARE_MODE_DEBUG_MODE (0x0105)
#define MSG28XX_FIRMWARE_MODE_UNKNOWN_MODE (0xFF)
#define MSG28XX_FIRMWARE_MODE_DEMO_MODE (0x00)
#define MSG28XX_FIRMWARE_MODE_DEBUG_MODE (0x01)
#define DEBUG_MODE_PACKET_LENGTH (1280) //It is a predefined maximum packet length, not the actual packet length which queried from firmware.
#ifdef CONFIG_UPDATE_FIRMWARE_BY_SW_ID
#define UPDATE_FIRMWARE_RETRY_COUNT (2)
#endif //CONFIG_UPDATE_FIRMWARE_BY_SW_ID
#ifdef CONFIG_ENABLE_GESTURE_WAKEUP
#ifdef CONFIG_ENABLE_GESTURE_INFORMATION_MODE
#define FIRMWARE_GESTURE_INFORMATION_MODE_A (0x00)
#define FIRMWARE_GESTURE_INFORMATION_MODE_B (0x01)
#define FIRMWARE_GESTURE_INFORMATION_MODE_C (0x02)
#endif //CONFIG_ENABLE_GESTURE_INFORMATION_MODE
#endif //CONFIG_ENABLE_GESTURE_WAKEUP
/*--------------------------------------------------------------------------*/
/* DATA TYPE DEFINITION */
/*--------------------------------------------------------------------------*/
typedef struct
{
u16 nId;
u16 nX;
u16 nY;
u16 nP;
} TouchPoint_t;
/// max 80+1+1 = 82 bytes
typedef struct
{
u8 nCount;
u8 nKeyCode;
TouchPoint_t tPoint[MAX_TOUCH_NUM];
} TouchInfo_t;
typedef struct
{
u16 nFirmwareMode;
u8 nType;
u8 nLogModePacketHeader;
u8 nMy;
u8 nMx;
u8 nSd;
u8 nSs;
u16 nLogModePacketLength;
} FirmwareInfo_t;
#ifdef CONFIG_UPDATE_FIRMWARE_BY_SW_ID
/*
* Note.
* 0x0000 and 0xFFFF are not allowed to be defined as SW ID.
* SW_ID_UNDEFINED is a reserved enum value, do not delete it or modify it.
* Please modify the SW ID of the below enum value depends on the TP vendor that you are using.
*/
typedef enum {
MSG26XXM_SW_ID_XXXX = 0x0001,
MSG26XXM_SW_ID_YYYY = 0x0002,
MSG26XXM_SW_ID_UNDEFINED
} Msg26xxmSwId_e;
/*
* Note.
* 0x0000 and 0xFFFF are not allowed to be defined as SW ID.
* SW_ID_UNDEFINED is a reserved enum value, do not delete it or modify it.
* Please modify the SW ID of the below enum value depends on the TP vendor that you are using.
*/
typedef enum {
MSG28XX_SW_ID_XXXX = 0x0001,
MSG28XX_SW_ID_YYYY = 0x0002,
MSG28XX_SW_ID_UNDEFINED
} Msg28xxSwId_e;
#endif //CONFIG_UPDATE_FIRMWARE_BY_SW_ID
/*--------------------------------------------------------------------------*/
/* GLOBAL FUNCTION DECLARATION */
/*--------------------------------------------------------------------------*/
#ifdef CONFIG_ENABLE_GESTURE_WAKEUP
extern void DrvFwCtrlOpenGestureWakeup(u32 *pMode);
extern void DrvFwCtrlCloseGestureWakeup(void);
#ifdef CONFIG_ENABLE_GESTURE_DEBUG_MODE
extern void DrvFwCtrlOpenGestureDebugMode(u8 nGestureFlag);
extern void DrvFwCtrlCloseGestureDebugMode(void);
#endif //CONFIG_ENABLE_GESTURE_DEBUG_MODE
#endif //CONFIG_ENABLE_GESTURE_WAKEUP
extern u32 DrvFwCtrlReadDQMemValue(u16 nAddr);
extern void DrvFwCtrlWriteDQMemValue(u16 nAddr, u32 nData);
#ifdef CONFIG_UPDATE_FIRMWARE_BY_SW_ID
extern void DrvFwCtrlCheckFirmwareUpdateBySwId(void);
#endif //CONFIG_UPDATE_FIRMWARE_BY_SW_ID
extern u16 DrvFwCtrlChangeFirmwareMode(u16 nMode);
extern void DrvFwCtrlGetFirmwareInfo(FirmwareInfo_t *pInfo);
extern u16 DrvFwCtrlGetFirmwareMode(void);
extern void DrvFwCtrlRestoreFirmwareModeToLogDataMode(void);
#ifdef CONFIG_ENABLE_SEGMENT_READ_FINGER_TOUCH_DATA
extern void DrvFwCtrlGetTouchPacketAddress(u16 *pDataAddress, u16 *pFlagAddress);
#endif //CONFIG_ENABLE_SEGMENT_READ_FINGER_TOUCH_DATA
#ifdef CONFIG_ENABLE_PROXIMITY_DETECTION
extern s32 DrvFwCtrlEnableProximity(void);
extern s32 DrvFwCtrlDisableProximity(void);
#endif //CONFIG_ENABLE_PROXIMITY_DETECTION
extern void DrvFwCtrlVariableInitialize(void);
extern void DrvFwCtrlOptimizeCurrentConsumption(void);
extern u8 DrvFwCtrlGetChipType(void);
extern void DrvFwCtrlGetCustomerFirmwareVersionByDbBus(EmemType_e eEmemType, u16 *pMajor, u16 *pMinor, u8 **ppVersion);
extern void DrvFwCtrlGetCustomerFirmwareVersion(u16 *pMajor, u16 *pMinor, u8 **ppVersion);
extern void DrvFwCtrlGetPlatformFirmwareVersion(u8 **ppVersion);
extern void DrvFwCtrlHandleFingerTouch(void);
extern s32 DrvFwCtrlUpdateFirmware(u8 szFwData[][1024], EmemType_e eEmemType);
extern s32 DrvFwCtrlUpdateFirmwareBySdCard(const char *pFilePath);
#ifdef CONFIG_ENABLE_HOTKNOT
extern void ReportHotKnotCmd(u8 *pPacket, u16 nLength);
#endif //CONFIG_ENABLE_HOTKNOT
#ifdef CONFIG_ENABLE_GLOVE_MODE
extern void DrvIcFwCtrlOpenGloveMode(void);
extern void DrvIcFwCtrlCloseGloveMode(void);
extern void DrvIcFwCtrlGetGloveInfo(u8 *pGloveMode);
#endif //CONFIG_ENABLE_GLOVE_MODE
#endif //CONFIG_ENABLE_TOUCH_DRIVER_FOR_MUTUAL_IC
#endif /* __MSTAR_DRV_MUTUAL_FW_CONTROL_H__ */
|
