incubator-nuttx/drivers/input/ft5x06.h

/****************************************************************************
 * drivers/input/ft5x06.h
 *
 *   Copyright (C) 2011-2012 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <gnutt@nuttx.org>
 *
 * References:
 *   "FT5x06", FocalTech Systems Co., Ltd, D-FT5x06-1212-V4.0, Revised
 *   Dec. 18, 2012
 *
 * Some of this driver was developed with input from NXP sample code for
 * the LPCXpresso-LPC54628 board.  That sample code as a compatible BSD
 * license:
 *
 *   Copyright (c) 2016, Freescale Semiconductor, Inc.
 *   Copyright 2016-2017 NXP
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/* The FT5x06 Series ICs are single-chip capacitive touch panel controller
 * ICs with a built-in 8 bit Micro-controller unit (MCU).  They adopt the
 * mutual capacitance approach, which supports true multi-touch capability.
 * In conjunction with a mutual capacitive touch panel, the FT5x06 have
 * user-friendly input functions, which can be applied on many portable
 * devices, such as cellular phones, MIDs, netbook and notebook personal
 * computers.
 */

#ifndef __DRIVERS_INPUT_FT5X06_H
#define __DRIVERS_INPUT_FT5X06_H

/****************************************************************************
 * Included Files
 ****************************************************************************/

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/* WARNING: Some definitions may apply only to the FT5336 */

/* FT5x06 maximum number of simultaneously detected touches. */

#define FT5X06_MAX_TOUCHES                (5)

/* FT5x06 raw touch data length. */

#define FT5X06_TOUCH_DATA_LEN             (0x20)

/* FT5x06 register addresses */

#define FT5X06_TOUCH_MODE_REG             (0x00) /* Mode register */
#define FT5X06_TOUCH_GESTID_REG           (0x01) /* Gesture ID register */
#define FT5X06_TOUCH_STAT_REG             (0x02) /* Touch data status */
                                                 /* See struct ft5x06_touch_point_s */
#define FT5X06_TH_GROUP_REG               (0x80) /* Threshold for touch detection */
#define FT5X06_TH_DIFF_REG                (0x85) /* Filter function coefficients */
#define FT5X06_CTRL_REG                   (0x86) /* Control register */
#define FT5X06_TIMEENTERMONITOR_REG       (0x87) /* Time switching Active to Monitor */
#define FT5X06_PERIODACTIVE_REG           (0x88) /* Report rate in Active mode */
#define FT5X06_PERIODMONITOR_REG          (0x89) /* Report rate in Monitor mode */
#define FT5X06_RADIAN_VALUE_REG           (0x91) /* Minimum allowing angle */
#define FT5X06_OFFSET_LEFT_RIGHT_REG      (0x92) /* Minimum offset */
#define FT5X06_OFFSET_UP_DOWN_REG         (0x93) /* Maximum offset */
#define FT5X06_DISTANCE_LEFT_RIGHT_REG    (0x94) /* Minimum distance */
#define FT5X06_DISTANCE_UP_DOWN_REG       (0x95) /* Minimum distance */
#define FT5X06_DISTANCE_ZOOM_REG          (0x96) /* Maximum distance */
#define FT5X06_LIB_VER_H_REG              (0xa1) /* MS LIB version */
#define FT5X06_LIB_VER_L_REG              (0xa2) /* LS LIB version */
#define FT5X06_CIPHER_REG                 (0xa3) /* Chip selecting */
#define FT5X06_GMODE_REG                  (0xa4) /* Interrupt mode */
#define FT5X06_PWR_MODE_REG               (0xa5) /* Power mode */
#define FT5X06_FIRMID_REG                 (0xa6) /* Firmware version */
#define FT5X06_CHIP_ID_REG                (0xa8) /* Chip ID */
#define FT5X06_RELEASE_CODE_ID_REG        (0xaf) /* Release code version */
#define FT5X06_STATE_REG                  (0xbc) /* Current operating mode */

#define FT5X06_TOUCH_DATA_STARTREG        (1)    /* Address where data begins */

/* Possible values of the DEV_MODE register */

#define FT5X06_DEV_MODE_WORKING           (0x00)
#define FT5X06_DEV_MODE_FACTORY           (0x04)

/* Possible values of the GEST_ID register */

#define FT5X06_GEST_ID_NO_GESTURE         (0x00)
#define FT5X06_GEST_ID_MOVE_UP            (0x10)
#define FT5X06_GEST_ID_MOVE_RIGHT         (0x14)
#define FT5X06_GEST_ID_MOVE_DOWN          (0x18)
#define FT5X06_GEST_ID_MOVE_LEFT          (0x1c)
#define FT5X06_GEST_ID_SINGLE_CLICK       (0x20)
#define FT5X06_GEST_ID_DOUBLE_CLICK       (0x22)
#define FT5X06_GEST_ID_ROTATE_CLOCKWISE   (0x28)
#define FT5X06_GEST_ID_ROTATE_C_CLOCKWISE (0x29)
#define FT5X06_GEST_ID_ZOOM_IN            (0x40)
#define FT5X06_GEST_ID_ZOOM_OUT           (0x49)

/* Values related to FT5X06_CTRL_REG */

#define FT5X06_CTRL_KEEP_ACTIVE_MODE      (0x00)
#define FT5X06_CTRL_KEEP_AUTO_SWITCH_MONITOR_MODE (0x01)

/* Possible values of FT5X06_GMODE_REG */

#define FT5X06_G_MODE_INTERRUPT_POLLING   (0x00)
#define FT5X06_G_MODE_INTERRUPT_TRIGGER   (0x01)

/* Possible values of FT5X06_CHIP_ID_REG */

#define FT5X06_ID_VALUE                   (0x51)

/* Operations on struct ft5x06_touch_point_s */

#define TOUCH_POINT_GET_EVENT(t)          ((t).xh >> 6)
#define TOUCH_POINT_GET_ID(t)             ((t).yh >> 4)
#define TOUCH_POINT_GET_X(t)              ((((t).xh & 0x0f) << 8) | (t).xl)
#define TOUCH_POINT_GET_Y(t)              ((((t).yh & 0x0f) << 8) | (t).yl)

/****************************************************************************
 * Public Types
 ****************************************************************************/

enum touch_event_e
{
  FT5X06_DOWN    = 0,  /* The state changed to touched */
  FT5X06_UP      = 1,  /* The state changed to not touched */
  FT5X06_CONTACT = 2,  /* There is a continuous touch being detected */
  FT5X06_INVALID = 3   /* No touch information available */
};

/* Describes on touchpoint returned by the FT5x06 */

struct ft5x06_touch_point_s
{
  uint8_t xh;
  uint8_t xl;
  uint8_t yh;
  uint8_t yl;
  uint8_t weight;
  uint8_t area;
};

/* Describes all touch data returned by the FT5x06 */

struct ft5x06_touch_data_s
{
  uint8_t gestid;      /* Gesture ID */
  uint8_t tdstatus;    /* Touch status */
  struct ft5x06_touch_point_s touch[FT5X06_MAX_TOUCHES];
};

/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/

#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif

#undef EXTERN
#ifdef __cplusplus
}
#endif

#endif /* __DRIVERS_INPUT_FT5X06_H */