summaryrefslogtreecommitdiffstats
path: root/firmware/target/hosted/samsungypr/ypr1/mcs5000.h
blob: 45cce19a32424de171694d03b447ea8eeae9e928 (plain)
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
 /*
  * Unfortunately I couldn't find any datasheet for this touch controller nor
  * any other information. I tried to send Melfas an email but their servers
  * seem to be full in this period. The best thing I could find is a Linux
  * driver written by Samsung.
  * In the opensource package for YP-R1 there are also some more information
  * in the file r1TouchMelfasReg.h, which at the moment are not used (I2C stuff
  * and error codes)
  *
  * The rest, function definitions, are written by me (Lorenzo Miori)
  *
  * mcs5000_ts.c - Touchscreen driver for MELFAS MCS-5000 controller
  *
  * Copyright (C) 2009 Samsung Electronics Co.Ltd
  * Author: Joonyoung Shim <jy0922.shim@samsung.com>
  *
  * Based on wm97xx-core.c
  *
  *  This program is free software; you can redistribute  it and/or modify it
  *  under  the terms of  the GNU General  Public License as published by the
  *  Free Software Foundation;  either version 2 of the  License, or (at your
  *  option) any later version.
  *
  */

/**
 * This is the wrapper to r1Touch.ko module with the possible
 * ioctl calls
 * The touchscreen controller is the Melfas MCS5000
 */

#define MCS5000_IOCTL_MAGIC                  'X'

#define MCS5000_IOCTL_TOUCH_RESET             0
#define MCS5000_IOCTL_TOUCH_ON                1
#define MCS5000_IOCTL_TOUCH_OFF               2
#define MCS5000_IOCTL_TOUCH_FLUSH             3
#define MCS5000_IOCTL_TOUCH_SLEEP             4
#define MCS5000_IOCTL_TOUCH_WAKE              5
#define MCS5000_IOCTL_TOUCH_ENTER_FWUPG_MODE  6
#define MCS5000_IOCTL_TOUCH_I2C_READ          7
#define MCS5000_IOCTL_TOUCH_I2C_WRITE         8
#define MCS5000_IOCTL_TOUCH_RESET_AFTER_FWUPG 9
#define MCS5000_IOCTL_TOUCH_RIGHTHAND         10
#define MCS5000_IOCTL_TOUCH_LEFTHAND          11
#define MCS5000_IOCTL_TOUCH_IDLE              12
#define MCS5000_IOCTL_TOUCH_SET_SENSE         13
#define MCS5000_IOCTL_TOUCH_GET_VER           14
#define MCS5000_IOCTL_TOUCH_SET_REP_RATE      15
#define MCS5000_IOCTL_TOUCH_ENABLE_WDOG       16
#define MCS5000_IOCTL_TOUCH_DISABLE_WDOG      17

struct mcs5000_i2c_data
{
    int count;
    unsigned char addr;
    unsigned char pData[256];
} __attribute__((packed));

#define DEV_CTRL_TOUCH_RESET                    _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_RESET)
#define DEV_CTRL_TOUCH_ON                       _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_ON)
#define DEV_CTRL_TOUCH_OFF                      _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_OFF)
#define DEV_CTRL_TOUCH_FLUSH                    _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_FLUSH)
#define DEV_CTRL_TOUCH_SLEEP                    _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_SLEEP)
#define DEV_CTRL_TOUCH_WAKE                     _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_WAKE)
#define DEV_CTRL_TOUCH_ENTER_FWUPG_MODE         _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_ENTER_FWUPG_MODE)
#define DEV_CTRL_TOUCH_I2C_READ                 _IOWR(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_I2C_READ, mcs5000_i2c_data)
#define DEV_CTRL_TOUCH_I2C_WRITE                _IOWR(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_I2C_WRITE, mcs5000_i2c_data)
#define DEV_CTRL_TOUCH_RESET_AFTER_FWUPG        _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_RESET_AFTER_FWUPG)
#define DEV_CTRL_TOUCH_RIGHTHAND                _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_RIGHTHAND)
#define DEV_CTRL_TOUCH_LEFTHAND                 _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_LEFTHAND)
#define DEV_CTRL_TOUCH_IDLE                     _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_IDLE)
#define DEV_CTRL_TOUCH_SET_SENSE                _IOW(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_SET_SENSE, int)
#define DEV_CTRL_TOUCH_GET_VER                  _IOR(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_GET_VER, int)
#define DEV_CTRL_TOUCH_SET_REP_RATE             _IOW(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_SET_REP_RATE, int)
#define DEV_CTRL_TOUCH_ENABLE_WDOG              _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_ENABLE_WDOG)
#define DEV_CTRL_TOUCH_DISABLE_WDOG             _IO(MCS5000_IOCTL_MAGIC, MCS5000_IOCTL_TOUCH_DISABLE_WDOG)
#define DEV_CTRL_TOUCH_MAX_NR                   18

/* Register definitions */
#define MCS5000_TS_STATUS               0x00
#define STATUS_OFFSET                   0
#define STATUS_NO                       (0 << STATUS_OFFSET)
#define STATUS_INIT                     (1 << STATUS_OFFSET)
#define STATUS_SENSING                  (2 << STATUS_OFFSET)
#define STATUS_COORD                    (3 << STATUS_OFFSET)
#define STATUS_GESTURE                  (4 << STATUS_OFFSET)
#define ERROR_OFFSET                    4
#define ERROR_NO                        (0 << ERROR_OFFSET)
#define ERROR_POWER_ON_RESET            (1 << ERROR_OFFSET)
#define ERROR_INT_RESET                 (2 << ERROR_OFFSET)
#define ERROR_EXT_RESET                 (3 << ERROR_OFFSET)
#define ERROR_INVALID_REG_ADDRESS       (8 << ERROR_OFFSET)
#define ERROR_INVALID_REG_VALUE         (9 << ERROR_OFFSET)

#define MCS5000_TS_OP_MODE              0x01
#define RESET_OFFSET                    0
#define RESET_NO                        (0 << RESET_OFFSET)
#define RESET_EXT_SOFT                  (1 << RESET_OFFSET)
#define OP_MODE_OFFSET                  1
#define OP_MODE_SLEEP                   (0 << OP_MODE_OFFSET)
#define OP_MODE_ACTIVE                  (1 << OP_MODE_OFFSET)
#define GESTURE_OFFSET                  4
#define GESTURE_DISABLE                 (0 << GESTURE_OFFSET)
#define GESTURE_ENABLE                  (1 << GESTURE_OFFSET)
#define PROXIMITY_OFFSET                5
#define PROXIMITY_DISABLE               (0 << PROXIMITY_OFFSET)
#define PROXIMITY_ENABLE                (1 << PROXIMITY_OFFSET)
#define SCAN_MODE_OFFSET                6
#define SCAN_MODE_INTERRUPT             (0 << SCAN_MODE_OFFSET)
#define SCAN_MODE_POLLING               (1 << SCAN_MODE_OFFSET)
#define REPORT_RATE_OFFSET              7
#define REPORT_RATE_40                  (0 << REPORT_RATE_OFFSET)
#define REPORT_RATE_80                  (1 << REPORT_RATE_OFFSET)

#define MCS5000_TS_SENS_CTL             0x02
#define MCS5000_TS_FILTER_CTL           0x03
#define PRI_FILTER_OFFSET               0
#define SEC_FILTER_OFFSET               4

#define MCS5000_TS_X_SIZE_UPPER         0x08
#define MCS5000_TS_X_SIZE_LOWER         0x09
#define MCS5000_TS_Y_SIZE_UPPER         0x0A
#define MCS5000_TS_Y_SIZE_LOWER         0x0B

#define MCS5000_TS_INPUT_INFO           0x10
#define INPUT_TYPE_OFFSET               0
#define INPUT_TYPE_NONTOUCH             (0 << INPUT_TYPE_OFFSET)
#define INPUT_TYPE_SINGLE               (1 << INPUT_TYPE_OFFSET)
#define INPUT_TYPE_DUAL                 (2 << INPUT_TYPE_OFFSET)
#define INPUT_TYPE_PALM                 (3 << INPUT_TYPE_OFFSET)
#define INPUT_TYPE_PROXIMITY            (7 << INPUT_TYPE_OFFSET)
#define GESTURE_CODE_OFFSET             3
#define GESTURE_CODE_NO                 (0 << GESTURE_CODE_OFFSET)

#define MCS5000_TS_X_POS_UPPER          0x11
#define MCS5000_TS_X_POS_LOWER          0x12
#define MCS5000_TS_Y_POS_UPPER          0x13
#define MCS5000_TS_Y_POS_LOWER          0x14
#define MCS5000_TS_Z_POS                0x15
#define MCS5000_TS_WIDTH                0x16
#define MCS5000_TS_GESTURE_VAL          0x17
#define MCS5000_TS_MODULE_REV           0x20
#define MCS5000_TS_FIRMWARE_VER         0x21

/* Touchscreen absolute values */
#define MCS5000_MAX_XC                  0x3ff
#define MCS5000_MAX_YC                  0x3ff

/* this struct also seems to have an alignment requirement (256-byte aligned?).
 * touchscreen won't work correctly with 8-byte alignment. The aligned attribute
 * cannot be attached here because it would make the struct larger and packed
 * be ignored.
 * See also mcs5000_read() */
struct mcs5000_raw_data
{
    unsigned char inputInfo;
    unsigned char xHigh;
    unsigned char xLow;
    unsigned char yHigh;
    unsigned char yLow;
    unsigned char z;
    unsigned char width;
    unsigned char gesture;
} __attribute__((packed));

/**
 * Two possibilities for hand usage
 */
enum
{
    RIGHT_HAND,
    LEFT_HAND,
};

/* Open device */
void mcs5000_init(void);
/* Close device */
void mcs5000_close(void);
/* Power up the chip (voltages) */
void mcs5000_power(void);
/* Shutdown the chip (voltages) */
void mcs5000_shutdown(void);
/* Set user hand usage */
void mcs5000_set_hand(int hand_setting);
/* Set touchscreen sensitivity. Valid values are 1,2,4,8 */
void mcs5000_set_sensitivity(int level);
/* Read controller's data */
int mcs5000_read(struct mcs5000_raw_data *touchData);