| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686 |
- /* Elan HID-over-I2C touchpad on the Braswell LPSS I2C bus.
- *
- * The HP Chromebook 11 G5 EE (setzer) wires its touchpad to LPSS I2C6 at
- * 0xD1327000, slave address 0x15. The LPSS I2C functions are hidden from
- * PCI in ACPI mode, so the driver scans the two firmware BAR windows for
- * DesignWare component types instead of enumerating PCI.
- *
- * The report line is a GPIO we have no driver for, so the input register is
- * polled. A read with no pending report returns a zero length immediately.
- * Reading the register back-to-back stalls the device: 25 ms (40 Hz) is the
- * rate it keeps up with, and the pointer still moves smoothly.
- *
- * Init follows Linux's elan_i2c: reset, consume the 2-byte reset
- * acknowledgement, read the HID descriptor and the max-X/Y commands, select
- * absolute mode (0x0300) and wake the device (0x0800).
- *
- * The clickpad has no right button, so a short stationary tap is turned into
- * a synthetic click: two fingers (or one finger in the bottom-right corner)
- * is a right click, one finger elsewhere is a left click. The press is held
- * briefly so ring-3 commands polling SYS_WIN_POINTER sample it. Resetting
- * last leaves the device silent until the next power cycle.
- */
- #include "touchpad.h"
- #include "i2c.h"
- #include "io.h"
- #include "paging.h"
- #include "timer.h"
- #define TP_ADDR 0x15
- #define TP_CTRL_MAX 16
- #define TP_CTRL_STEP 0x1000u
- #define TP_HID_DESC_REG 0x0001
- #define TP_HID_DESC_LEN 30
- #define TP_CMD_REG 0x0005
- #define TP_CMD_RESET 0x0100
- #define TP_CMD_WAKE 0x0800
- #define TP_MODE_REG 0x0300
- #define TP_MODE_ABS 0x0001
- #define TP_DW_COMP_TYPE 0x44570140u
- #define TP_REPORT_ID 0x5d
- #define TP_MAX_X_REG 0x0106
- #define TP_MAX_Y_REG 0x0107
- #define TP_ABS_MAX 4095
- #define TP_MAX_INPUT 64
- #define TP_POLL_MS 25
- /* Tap gestures. The report is polled at 40 Hz, so a tap must last at least
- * two samples to be seen; the movement cap keeps a swipe from clicking. */
- #define TP_TAP_MIN_MS 40
- #define TP_TAP_MAX_MS 300
- #define TP_TAP_MOVE 60
- #define TP_CLICK_HOLD_MS 120
- /* Software right button zones: right 25% x bottom 25% of the pad. The raw
- * Elan Y axis grows upwards, so the bottom is the low end. */
- #define TP_CORNER_X_PCT 75
- #define TP_CORNER_Y_PCT 25
- enum {
- TP_RC_OFF = 0,
- TP_RC_TAP = 1,
- TP_RC_CORNER = 2,
- TP_RC_BOTH = TP_RC_TAP | TP_RC_CORNER
- };
- static unsigned int tp_base;
- static unsigned int tp_addr = TP_ADDR;
- static int tp_present;
- static unsigned int tp_in_reg = 0x0003;
- static unsigned int tp_max_in = 34;
- static unsigned int tp_cmd_reg = TP_CMD_REG;
- static unsigned short tp_vendor;
- static unsigned short tp_product;
- static int tp_max_x = TP_ABS_MAX;
- static int tp_max_y = TP_ABS_MAX;
- static const char *tp_err;
- static unsigned int tp_err_val;
- static int tp_last_x, tp_last_y, tp_acc_x, tp_acc_y;
- static int tp_down, tp_last_buttons;
- static unsigned int tp_next_poll;
- /* Gesture configuration and synthesized-click state. */
- static unsigned int tp_rc_mode = TP_RC_BOTH;
- static int tp_tapclick = 1;
- static int tp_phys_raw; /* clickpad bit from the last report */
- static int tp_phys_btn; /* latched button: 0, 0x01 or 0x02 */
- static unsigned int tp_click_btn;
- static unsigned int tp_click_release_ms;
- static unsigned int tp_synth_left, tp_synth_right;
- /* One contact sequence: from the first finger down to the last finger up. */
- static int tp_gesture_active;
- static unsigned int tp_gesture_t0;
- static int tp_gesture_x0, tp_gesture_y0;
- static int tp_gesture_started;
- static int tp_gesture_moved;
- static int tp_gesture_two;
- static int tp_gesture_phys;
- /* Last report, for the `touchpad` status command. */
- static int tp_stat_fingers, tp_stat_f1, tp_stat_x, tp_stat_y;
- static void put_dec(unsigned int v);
- static const char *rc_name(void);
- static void put_hex16(unsigned int v)
- {
- static const char hex[] = "0123456789ABCDEF";
- io_putchar(hex[(v >> 12) & 0xf]);
- io_putchar(hex[(v >> 8) & 0xf]);
- io_putchar(hex[(v >> 4) & 0xf]);
- io_putchar(hex[v & 0xf]);
- }
- static void print_summary(void)
- {
- io_putstr("touchpad: elan ");
- put_hex16(tp_vendor);
- io_putchar(':');
- put_hex16(tp_product);
- io_putstr(" i2c 0x");
- io_puthex(tp_base);
- io_putstr(" addr 0x");
- io_puthex(tp_addr);
- io_putstr(" max ");
- put_dec((unsigned int)tp_max_x);
- io_putchar('x');
- put_dec((unsigned int)tp_max_y);
- io_putchar('\n');
- }
- static void print_status(void)
- {
- print_summary();
- io_putstr("touchpad: rightclick ");
- io_putstr(rc_name());
- io_putstr(" tapclick ");
- io_putstr(tp_tapclick ? "on" : "off");
- io_putstr(" corner x>=");
- put_dec((unsigned int)(tp_max_x * TP_CORNER_X_PCT / 100));
- io_putstr(" y<=");
- put_dec((unsigned int)(tp_max_y * TP_CORNER_Y_PCT / 100));
- io_putstr("\n");
- io_putstr("touchpad: last f=");
- put_dec((unsigned int)tp_stat_fingers);
- if (tp_stat_f1) {
- io_putstr(" x=");
- put_dec((unsigned int)tp_stat_x);
- io_putstr(" y=");
- put_dec((unsigned int)tp_stat_y);
- }
- io_putstr(" taps left=");
- put_dec(tp_synth_left);
- io_putstr(" right=");
- put_dec(tp_synth_right);
- io_putchar('\n');
- }
- static void msleep(unsigned int ms)
- {
- unsigned int t0 = get_ticks_ms();
- while (get_ticks_ms() - t0 < ms)
- ;
- }
- static unsigned int get16(const unsigned char *p)
- {
- return (unsigned int)p[0] | ((unsigned int)p[1] << 8);
- }
- static void put_dec(unsigned int v)
- {
- char buf[11];
- unsigned int i = 0;
- if (!v) {
- io_putchar('0');
- return;
- }
- while (v) {
- buf[i++] = (char)('0' + v % 10);
- v /= 10;
- }
- while (i)
- io_putchar(buf[--i]);
- }
- /* Match one whitespace-delimited word at s (end or space after it). */
- static int word_is(const char *s, const char *word)
- {
- while (*word) {
- if (*s != *word)
- return 0;
- s++;
- word++;
- }
- return *s == '\0' || *s == ' ';
- }
- static const char *skip_spaces(const char *s)
- {
- while (*s == ' ')
- s++;
- return s;
- }
- static unsigned int word_len(const char *s)
- {
- unsigned int n = 0;
- while (s[n] && s[n] != ' ')
- n++;
- return n;
- }
- static int finger_count(unsigned int ti)
- {
- unsigned int mask = (ti >> 3) & 0x1f;
- int n = 0;
- while (mask) {
- n += (int)(mask & 1);
- mask >>= 1;
- }
- return n;
- }
- static int in_corner(int x, int y)
- {
- return x >= tp_max_x * TP_CORNER_X_PCT / 100 &&
- y <= tp_max_y * TP_CORNER_Y_PCT / 100;
- }
- static const char *rc_name(void)
- {
- switch (tp_rc_mode) {
- case TP_RC_OFF: return "off";
- case TP_RC_TAP: return "tap";
- case TP_RC_CORNER: return "corner";
- default: return "both";
- }
- }
- static int hid_read_reg(unsigned int addr, unsigned int reg,
- unsigned char *buf, unsigned int len)
- {
- unsigned char r[2];
- r[0] = (unsigned char)(reg & 0xff);
- r[1] = (unsigned char)(reg >> 8);
- if (i2c_dw_transfer(tp_base, addr, r, 2, buf, len) == 0)
- return 0;
- /* Some devices do not answer the combined write+read (repeated
- * start). Retry with a STOP between the register address and the
- * data read. */
- if (i2c_dw_transfer(tp_base, addr, r, 2, 0, 0) != 0)
- return -1;
- return i2c_dw_transfer(tp_base, addr, 0, 0, buf, len);
- }
- static int hid_write_reg(unsigned int addr, unsigned int reg, unsigned int val)
- {
- unsigned char b[4];
- b[0] = (unsigned char)(reg & 0xff);
- b[1] = (unsigned char)(reg >> 8);
- b[2] = (unsigned char)(val & 0xff);
- b[3] = (unsigned char)(val >> 8);
- return i2c_dw_transfer(tp_base, addr, b, 4, 0, 0);
- }
- /* Native Elan max-coordinate commands (the same read-cmd path Linux
- * elan_i2c uses). They give the corner zone a physical frame instead of
- * assuming the full 12-bit range; on failure keep the 4095 fallback. */
- static void query_limits(void)
- {
- unsigned char v[2];
- if (hid_read_reg(tp_addr, TP_MAX_X_REG, v, 2) == 0) {
- unsigned int m = get16(v) & 0x0fff;
- if (m >= 256)
- tp_max_x = (int)m;
- }
- if (hid_read_reg(tp_addr, TP_MAX_Y_REG, v, 2) == 0) {
- unsigned int m = get16(v) & 0x0fff;
- if (m >= 256)
- tp_max_y = (int)m;
- }
- }
- static int probe_controller(unsigned int base)
- {
- unsigned char desc[TP_HID_DESC_LEN + 2];
- unsigned char ack[2];
- unsigned int off, len, ver;
- if (!i2c_dw_present(base))
- return 0;
- if (i2c_dw_init(base) != 0) {
- tp_err = "i2c init failed";
- return 0;
- }
- tp_base = base;
- /* The Elan address is fixed; a plain read is a harmless ACK check. */
- if (i2c_dw_transfer(base, TP_ADDR, 0, 0, ack, 1) != 0) {
- tp_err = "no device at 0x15";
- return 0;
- }
- /* Reset first and consume the acknowledgement, then read the HID
- * descriptor. The descriptor read is prefixed with two status
- * bytes and the 2-byte length, so accept either offset. */
- hid_write_reg(TP_ADDR, TP_CMD_REG, TP_CMD_RESET);
- msleep(150);
- (void)i2c_dw_transfer(base, TP_ADDR, 0, 0, ack, 2);
- if (hid_read_reg(TP_ADDR, TP_HID_DESC_REG, desc, sizeof(desc)) != 0) {
- tp_err = "descriptor read failed";
- tp_err_val = i2c_last_abort;
- return 0;
- }
- off = 0;
- if (get16(desc + 0) != TP_HID_DESC_LEN ||
- get16(desc + 2) != 0x0100) {
- if (get16(desc + 2) == TP_HID_DESC_LEN &&
- get16(desc + 4) == 0x0100)
- off = 2;
- }
- len = get16(desc + off);
- ver = get16(desc + off + 2);
- if (len != TP_HID_DESC_LEN || ver != 0x0100) {
- tp_err = "bad hid descriptor";
- return 0;
- }
- tp_in_reg = get16(desc + off + 8);
- tp_max_in = get16(desc + off + 10);
- tp_cmd_reg = get16(desc + off + 16);
- tp_vendor = (unsigned short)get16(desc + off + 20);
- tp_product = (unsigned short)get16(desc + off + 22);
- if (tp_max_in < 12 || tp_max_in > TP_MAX_INPUT)
- tp_max_in = 34;
- /* Absolute reporting, then wake: after the reset the Elan stays
- * quiet until the host selects a mode. */
- hid_write_reg(TP_ADDR, TP_MODE_REG, TP_MODE_ABS);
- msleep(40);
- hid_write_reg(TP_ADDR, tp_cmd_reg, TP_CMD_WAKE);
- msleep(60);
- /* Query the limits with the device awake (Linux reads them after
- * initialize()/wake and before enabling reports). */
- query_limits();
- tp_present = 1;
- tp_err = 0;
- print_summary();
- return 1;
- }
- int touchpad_init(void)
- {
- /* The ACPI _CRS address for the LPSS I2C blocks is 0x9132xxxx on
- * coreboot, but this firmware maps them at 0xD132xxxx. Both
- * windows are scanned; page 7 (I2C6) is tried first. */
- static const unsigned int ranges[2] = { 0x91320000u, 0xd1320000u };
- unsigned int r, k;
- if (tp_present)
- return 1;
- for (r = 0; r < 2; r++) {
- for (k = 0; k < TP_CTRL_MAX; k++) {
- unsigned int i = (k + 7) % TP_CTRL_MAX;
- unsigned int base = ranges[r] + i * TP_CTRL_STEP;
- paging_map_mmio(base, 0x1000);
- /* A block left in functional reset keeps its
- * register file but never clocks the I2C FSM. */
- i2c_dw_reset_release(base);
- if (probe_controller(base))
- return 1;
- }
- }
- return 0;
- }
- int touchpad_present(void)
- {
- return tp_present;
- }
- unsigned int touchpad_addr(void)
- {
- return tp_addr;
- }
- unsigned short touchpad_vendor(void)
- {
- return tp_vendor;
- }
- unsigned short touchpad_product(void)
- {
- return tp_product;
- }
- /* Track one contact sequence and turn a short, stationary tap into a
- * synthetic button press. The Elan report packs the touch info byte
- * (f5..f1 at bits 7..3, clickpad at bit 0) and five bytes per finger, so
- * the finger mask alone tells us whether this was a one- or two-finger
- * tap. Only finger 1 drives the pointer, and its data is valid only while
- * its presence bit is set. */
- static void touchpad_gesture(unsigned int ti, int x, int y, unsigned int now)
- {
- int fingers = finger_count(ti);
- int f1 = (ti & 0x08) != 0;
- unsigned int duration;
- tp_stat_fingers = fingers;
- tp_stat_f1 = f1;
- if (f1) {
- tp_stat_x = x;
- tp_stat_y = y;
- }
- if (fingers) {
- if (!tp_gesture_active) {
- tp_gesture_active = 1;
- tp_gesture_t0 = now;
- tp_gesture_started = 0;
- tp_gesture_moved = 0;
- tp_gesture_two = 0;
- tp_gesture_phys = 0;
- }
- if (f1) {
- if (!tp_gesture_started) {
- tp_gesture_started = 1;
- tp_gesture_x0 = x;
- tp_gesture_y0 = y;
- } else {
- int ddx = x - tp_gesture_x0;
- int ddy = y - tp_gesture_y0;
- if (ddx < 0)
- ddx = -ddx;
- if (ddy < 0)
- ddy = -ddy;
- if (ddx > TP_TAP_MOVE || ddy > TP_TAP_MOVE)
- tp_gesture_moved = 1;
- }
- }
- if (fingers >= 2)
- tp_gesture_two = 1;
- if (ti & 0x01)
- tp_gesture_phys = 1;
- return;
- }
- if (!tp_gesture_active)
- return;
- tp_gesture_active = 0;
- duration = now - tp_gesture_t0;
- if (duration < TP_TAP_MIN_MS || duration > TP_TAP_MAX_MS ||
- tp_gesture_moved || tp_gesture_phys)
- return;
- if (tp_gesture_two) {
- if (!(tp_rc_mode & TP_RC_TAP))
- return;
- tp_click_btn = 0x02;
- tp_synth_right++;
- } else if (tp_gesture_started &&
- (tp_rc_mode & TP_RC_CORNER) &&
- in_corner(tp_gesture_x0, tp_gesture_y0)) {
- tp_click_btn = 0x02;
- tp_synth_right++;
- } else if (tp_tapclick) {
- tp_click_btn = 0x01;
- tp_synth_left++;
- } else {
- return;
- }
- /* Hold the synthetic press long enough for a ring-3 app polling
- * SYS_WIN_POINTER (typically every 10-16 ms) to sample it. */
- tp_click_release_ms = now + TP_CLICK_HOLD_MS;
- }
- int touchpad_poll(int *buttons, int *dx, int *dy)
- {
- unsigned char buf[TP_MAX_INPUT];
- unsigned int now, b;
- if (!tp_present)
- return 0;
- now = get_ticks_ms();
- /* The synthetic tap press is released by time, whether or not a new
- * report arrives (the finger is already up). */
- if (tp_click_btn && (int)(now - tp_click_release_ms) >= 0) {
- tp_click_btn = 0;
- *buttons = (unsigned int)tp_phys_btn;
- tp_last_buttons = *buttons;
- return 1;
- }
- if ((int)(now - tp_next_poll) < 0)
- return 0;
- tp_next_poll = now + TP_POLL_MS;
- if (hid_read_reg(tp_addr, tp_in_reg, buf, tp_max_in) != 0)
- return 0;
- /* The addressed read returns two status bytes, the 2-byte length
- * and then the report, so locate the 0x5D report ID instead of
- * trusting a fixed offset. Layout after it (Linux hid-elan.c):
- * touch info (f5..f1 at bits 7..3, clickpad at bit 0), then 5
- * bytes per active finger: x11:8/y11:9, x7:0, y7:0, size,
- * pressure. */
- for (b = 0; b < 6 && b + 4 < tp_max_in; b++)
- if (buf[b] == TP_REPORT_ID)
- break;
- if (b >= 6 || b + 4 >= tp_max_in)
- return 0;
- {
- unsigned int ti = buf[b + 1];
- unsigned int xh = buf[b + 2];
- int x = ((int)(xh & 0xf0) << 4) | buf[b + 3];
- int y = ((int)(xh & 0x0f) << 8) | buf[b + 4];
- {
- int raw = (ti & 0x01) != 0;
- int f1 = (ti & 0x08) != 0;
- if (raw) {
- /* Latch at the leading edge: a physical
- * clickpad press in the bottom-right zone is
- * the right button, anywhere else the left
- * button, for the whole press (so a corner
- * drag stays a right drag). */
- if (!tp_phys_raw) {
- tp_phys_btn = 0x01;
- if ((tp_rc_mode & TP_RC_CORNER) && f1 &&
- in_corner(x, y))
- tp_phys_btn = 0x02;
- }
- } else {
- tp_phys_btn = 0;
- }
- tp_phys_raw = raw;
- }
- touchpad_gesture(ti, x, y, now);
- *buttons = (unsigned int)tp_phys_btn | tp_click_btn;
- if (!(ti & 0x08)) { /* finger 1 lifted */
- tp_down = 0;
- tp_acc_x = 0;
- tp_acc_y = 0;
- if (tp_last_buttons != *buttons) {
- tp_last_buttons = *buttons;
- return 1;
- }
- return 0;
- }
- if (!tp_down) {
- tp_down = 1;
- tp_last_x = x;
- tp_last_y = y;
- *dx = 0;
- *dy = 0;
- } else {
- tp_acc_x += x - tp_last_x;
- /* The Elan's Y axis increases upwards, already the
- * PS/2 convention: dragging up gives a positive dy. */
- tp_acc_y += y - tp_last_y;
- tp_last_x = x;
- tp_last_y = y;
- *dx = tp_acc_x / 2;
- tp_acc_x -= *dx * 2;
- *dy = tp_acc_y / 2;
- tp_acc_y -= *dy * 2;
- }
- if (*dx > 64)
- *dx = 64;
- if (*dx < -64)
- *dx = -64;
- if (*dy > 64)
- *dy = 64;
- if (*dy < -64)
- *dy = -64;
- if (tp_last_buttons != *buttons) {
- tp_last_buttons = *buttons;
- return 1;
- }
- return *dx || *dy;
- }
- }
- void program_touchpad_main(const char *arg)
- {
- if (!tp_present) {
- io_putstr("touchpad: absent (");
- io_putstr(tp_err ? tp_err : "unknown");
- if (tp_err_val) {
- io_putstr(" ab=");
- io_puthex(tp_err_val);
- }
- io_putstr(")\n");
- return;
- }
- arg = arg ? skip_spaces(arg) : 0;
- if (!arg || !*arg) {
- print_status();
- return;
- }
- while (*arg) {
- if (word_is(arg, "rightclick")) {
- const char *v = skip_spaces(arg + 10);
- if (!*v) {
- io_putstr("touchpad: rightclick ");
- io_putstr(rc_name());
- io_putchar('\n');
- return;
- }
- if (word_is(v, "off"))
- tp_rc_mode = TP_RC_OFF;
- else if (word_is(v, "tap"))
- tp_rc_mode = TP_RC_TAP;
- else if (word_is(v, "corner"))
- tp_rc_mode = TP_RC_CORNER;
- else if (word_is(v, "both"))
- tp_rc_mode = TP_RC_BOTH;
- else {
- io_putstr("touchpad: rightclick off|tap|corner|both\n");
- return;
- }
- io_putstr("touchpad: rightclick ");
- io_putstr(rc_name());
- io_putchar('\n');
- arg = skip_spaces(v + word_len(v));
- } else if (word_is(arg, "tapclick")) {
- const char *v = skip_spaces(arg + 8);
- if (!*v) {
- io_putstr("touchpad: tapclick ");
- io_putstr(tp_tapclick ? "on" : "off");
- io_putchar('\n');
- return;
- }
- if (word_is(v, "on"))
- tp_tapclick = 1;
- else if (word_is(v, "off"))
- tp_tapclick = 0;
- else {
- io_putstr("touchpad: tapclick on|off\n");
- return;
- }
- io_putstr("touchpad: tapclick ");
- io_putstr(tp_tapclick ? "on" : "off");
- io_putchar('\n');
- arg = skip_spaces(v + word_len(v));
- } else {
- io_putstr("touchpad: usage: touchpad [rightclick off|tap|corner|both | tapclick on|off]\n");
- return;
- }
- }
- }
|