STMPE1601 16-bit enhanced port expander with keypad and PWM controller Xpander Logic Preliminary Data Features ■ 16 GPIOs (8 operate at core supply VCC , 8 operate at IO supply Vio) ■ Operating voltage 1.8 − 3.3 V ■ Hardware keypad controller (8*8 matrix with 4 optional dedicated keys max) ■ Keypad controller capable of detecting keypress in hibernation mode ■ 4 basic PWM controller for LED brightness control ■ Interrupt output (open drain) pin ■ Optional 32 kHz clock input ■ 8-channel programmable level translator ■ Advanced power management system ■ Ultra-low standby-mode current ■ Package TFBGA25 (3 x 3 mm) TFBGA25 Description The STMPE1601 is a GPIO (general purpose input/output) port expander able to interface a main digital ASIC via the two-line bidirectional bus (I2C). A separate GPIO expander IC is often used in mobile multimedia platforms to solve the problems of the limited number of GPIOs typically available on the digital engine. The STMPE1601 offers great flexibility, as each I/O can be configured as input, output or specific functions. The device is able to scan a keyboard, also provides PWM outputs for brightness control in backlight, and GPIO. This device has been designed to include very low quiescent current, and a wake-up feature for each I/O, to optimize the power consumption of the IC. Potential applications of the STMPE1601 include portable media players, game consoles, mobile and smart phones. Table 1. Device summary Order code Package Packaging STMPE1601TBR TFBGA25 Tape and reel January 2008 Rev 1 This is preliminary information on a new product now in development or undergoing evaluation. Details are subject to change without notice. 1/58 www.st.com 58 Contents STMPE1601 Contents 1 Block diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2 Pin settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3 4 2.1 Pin connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.2 Pin assignment and TFBGA ball location . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.3 Pin mapping to TFBGA (top through view) . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.4 GPIO pin functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Maximum rating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.1 Absolute maximum rating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 3.2 Thermal data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Electrical specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 4.1 DC electrical characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 4.2 Input/Output DC electrical characteristics . . . . . . . . . . . . . . . . . . . . . . . . . 9 5 Register map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 6 I2C interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 7 2/58 6.1 Start condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.2 Stop condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 6.3 Acknowledge bit (ACK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.4 Data input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.5 Slave device address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.6 Memory addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 6.7 Operating modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 6.8 General call address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 System controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 7.1 States of operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 7.2 Autosleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 7.3 Keypress detect in the hibernate mode . . . . . . . . . . . . . . . . . . . . . . . . . . 20 STMPE1601 8 9 Contents Clocking system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 8.1 Clock source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 8.2 Power mode programming sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Interrupt system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 9.1 Interrupt system register map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 9.1.1 9.2 10 12 Programming sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 GPIO controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 10.1 GPIO control registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 10.2 Hotkey feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 10.3 11 Interrupt latency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 10.2.1 Programming sequence for Hotkey . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 10.2.2 Minimum pulse width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Level translator feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Basic PWM controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 11.1 Interrupt on basic PWM controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 11.2 Trigger feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Keypad controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 12.1 Keypad configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 12.2 Registers in keypad controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 13 Data registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 14 Keypad combination key registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 15 Miscellaneous features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 15.1 Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 15.2 Under voltage lockout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 16 Package mechanical data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 17 Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 3/58 Block diagram 1 STMPE1601 Block diagram Figure 1. STMPE1601 block diagram Keypad controller MUX Main FSM PWM GPIO control MUX CLK_IN Keypad output 0-7 /GPIO 0-7 /PWM 0-3 Keypad input 0-7 /ADDR 0-2 /GPIO 8-15 INT SCLK I2C SDAT interface GND1 GND2 A0 A1 A2 POR VCC VIO CS00024 4/58 STMPE1601 Pin settings 2 Pin settings 2.1 Pin connection Figure 2. Pin connection (bottom view) 1 2 3 4 5 TFBGA25 2.2 Pin assignment and TFBGA ball location Table 2. Pin assignment Ball name Name Type Description E5 GPIO_0 I/O GPIO 0/ KP_X0/ PWM_0 D4 GPIO_1 I/O GPIO 1/ KP_X1/ PWM_1 D5 GPIO_2 I/O GPIO 2/ KP_X2/ PWM_2 C4 GPIO_3 I/O GPIO 3/ KP_X3/ PWM_3 A5 GPIO_4 I/O GPIO 4/ KP_X4 A4 GPIO_5 I/O GPIO 5/ KP_X5 B3 GPIO_6 I/O GPIO 6/ KP_X6 A3 GPIO_7 I/O GPIO 7/ KP_X7 A2 GPIO_8 I/O GPIO 8/ KP_Y0 A1 GPIO_9 I/O GPIO 9/ KP_Y1 B2 GPIO_10 I/O GPIO 10/ KP_Y2 5/58 Pin settings STMPE1601 Table 2. 2.3 Ball Name Name Type B1 GPIO_11 IO GPIO 11/ KP_Y3 D1 GPIO_12 IO GPIO 12/ KP_Y4 D2 GPIO_13 IO GPIO 13/ KP_Y5/ ADDR0 E1 GPIO_14 IO GPIO 14/ KP_Y6/ ADDR1 E2 GPIO_15 IO GPIO 15/ KP_Y7/ ADDR2 B5 INT O Open drain interrupt output pin E4 Reset_N I External reset input, active LOW E3 SDATA A I2C DATA D3 SCLK A I2C clock B4 CLK_IN A 32 kHz input C5 VCC - 1.8 − 3.3 V input for I2C module and digital core C1 VIO - 1.8 − 3.3 V input for GPIO C2 GND - C3 GND - Description Pin mapping to TFBGA (top through view) Table 3. 6/58 Pin assignment (continued) Pin mapping 1 2 3 4 5 A GPIO_9 GPIO_8 GPIO_7 GPIO_5 GPIO_4 B GPIO_11 GPIO_10 GPIO_6 CLK_IN INT C VIO GND GND GPIO_3 VCC D GPIO_12 GPIO_13 SCLK GPIO_1 GPIO_2 E GPIO_14 GPIO_15 SDATA RESET_N GPIO_0 STMPE1601 2.4 Pin settings GPIO pin functions Table 4. GPIO pin functions Name Primary function Alternate function 1 Alternate function 2 GPIO_0 GPIO Keypad PWM GPIO_1 GPIO Keypad PWM GPIO_2 GPIO Keypad PWM GPIO_3 GPIO Keypad PWM GPIO_4 GPIO Keypad GPIO_5 GPIO Keypad GPIO_6 GPIO Keypad GPIO_7 GPIO Keypad GPIO_8 GPIO Keypad GPIO_9 GPIO Keypad GPIO_10 GPIO Keypad GPIO_11 GPIO Keypad GPIO_12 GPIO Keypad GPIO_13 GPIO Keypad I2C ADDR during RESET GPIO_14 GPIO Keypad I2C ADDR during RESET GPIO_15 GPIO Keypad I2C ADDR during RESET Note 7/58 Maximum rating 3 STMPE1601 Maximum rating Stressing the device above the rating listed in the “Absolute maximum ratings” table may cause permanent damage to the device. These are stress ratings only and operation of the device at these or any other conditions above those indicated in the Operating sections of this specification is not implied. Exposure to absolute maximum rating conditions for extended periods may affect device reliability. Refer also to the STMicroelectronics SURE Program and other relevant quality documents. 3.1 Absolute maximum rating Table 5. Absolute maximum rating Symbol Parameter Supply voltage 4.5 V VIN Input voltage on GPIO pin 4.5 V 2 kV ESD protection on each GPIO pin Thermal data Table 6. Symbol RthJA 8/58 Unit VCC VESD (HBM) 3.2 Value Thermal data Parameter Min Thermal resistance junction-ambient Typ Max 100 Unit °C/W TA Operating ambient temperature -40 25 85 °C TJ Operating junction temperature -40 25 125 °C STMPE1601 Electrical specification 4 Electrical specification 4.1 DC electrical characteristics Table 7. DC electrical characteristics Value Symbol Test conditions Unit Min Typ Max VCC 1.8 V supply voltage 1.65 − 3.6 V VIO IO supply voltage 1.65 − 3.6 V HIBERNATE mode current VCC and VIO = 1.8 V 5 10 uA SLEEP mode current VCC and VIO = 1.8 V 15 50 μA Icc Operating current (FSM working – no peripheral activity) VCC and VIO = 1.8 V 400 800 μA INT Open drain output current IHIBERNATE ISLEEP 4.2 Parameter 4 mA Input/Output DC electrical characteristics The 1.8 V I/O complies to the EIA/JEDEC standard JESD8-7. Table 8. I/O DC electrical characteristic Value Symbol Parameter Unit Min Vil Low level input voltage VIO = 1.8 V Vih High level input voltage VIO = 1.8 V Schmitt trigger hysteresis VIO = 1.8 V Vil Low level input voltage VIO = 3.3 V Vih High level input voltage VIO = 3.3 V Schmidt trigger hysteresis VIO = 3.3 V Vhyst Vhyst Typ Max 0.63 1.17 V V 0.10 V 1.15 2.14 V V 0.20 V 9/58 Electrical specification Table 9. Symbol DC input specification (1.55 V < VCC < 1.95 V) Parameter Test conditions Vol Low level output voltage Iol = 4 mA VIO = 1.8 V Voh High level output voltage Ioh = 4 mA VIO = 1.8 V Vol Low level output voltage Iol = 4 mA VIO = 3.3 V Voh High level output voltage Ioh = 4 mA VIO = 3.3 V Table 10. Symbol 10/58 STMPE1601 Value Unit Min Typ Max 0.45 1.35 V V 0.83 2.48 V V DC output specification (1.55 V < VCC < 1.95 V) Parameter Ipu Pull-up current Rup Equivalent pull-up resistance Test conditions Value Unit Min Typ Max Vi = 0 V 15 35 65 μA Vi = 0 V VCC = 1.8 V 30 50 103.3 KΩ VCC = 1.8 V 50 100 150 KΩ STMPE1601 5 Register map Register map All the registers have the size of 8-bit. For each of the module, their registers are residing within the given address range. Table 11. Register map summary table Address Module register Description Auto-increment (during read/write) 0x00 – 0x07 0x80 – 0x81 Clock and power manager module Clock and power manager register range Yes 0x10 – 0x1F Interrupt controller module Interrupt controller register range Yes 0x30 – 0x37 PWM controller module PWM controller register range Yes 0x38 – 0x3F PWM controller module PWM controller register range No 0x60 – 0x6F Keypad controller module Keypad controller register range Yes 0x70 – 0x77 Rotator controller module Rotator controller register range Yes 0x82 – 0xBF GPIO controller module GPIO controller register range Yes 11/58 I2C interface 6 STMPE1601 I2C interface The features that are supported by the I2C interface are listed below: ● I2C slave device ● Operates at 1.8 V ● Compliant to Philips I2C specification version 2.1 ● Supports standard (up to 100kbps) and fast (up to 400 kbps) modes ● 7-bit and 10-bit device addressing modes ● General Call ● Start/Restart/Stop ● Address up to 8 STMPE1601 devices via the I2C interface The address is selected by the state of 3 pins. The state of the pins is read upon reset and then the pins can be configured for normal operation. The pins have a pull-up or down to set the address. The I2C interface module allows the connected host system to access the registers in the STMPE1601. I2C addresses Table 12. 6.1 A2 A1 A0 Address 0 0 0 40h 0 0 1 41h 0 1 0 42h 0 1 1 43h 1 0 0 44h 1 0 1 45h 1 1 0 46h 1 1 1 47h Start condition A Start condition is identified by a falling edge of SDATA while SCLK is stable at high state. A Start condition must precede any data/command transfer. The device continuously monitors for a Start condition and does not respond to any transaction unless one is encountered. 6.2 Stop condition A Stop condition is identified by a rising edge of SDATA while SCLK is stable at high state. A Stop condition terminates the communication between the slave device and bus master. A read command that is followed by NoAck can be followed by a Stop condition to force the slave device into idle mode. When the slave device is in idle mode, it is ready to receive the next I2C transaction. A Stop condition at the end of a write command stops the write operation to the registers. 12/58 STMPE1601 6.3 I2C interface Acknowledge bit (ACK) The acknowledge bit is used to indicate a successful byte transfer. The bus transmitter releases the SDATA after sending eight bits of data. During the ninth bit, the receiver pulls the SDATA low to acknowledge the receipt of the eight bits of data. The receiver may leave the SDATA in high state if it would to not acknowledge the receipt of the data. 6.4 Data input The device samples the data input on SDATA on the rising edge of the SCLK. The SDATA signal must be stable during the rising edge of SCLK and the SDATA signal must change only when SCLK is driven low. 6.5 Slave device address The slave device address is a 7 or 10-bit address, where the least significant 3-bit are programmable. These 3-bit values will be loaded in once upon reset and after that these 3 pins no longer be needed with the exception during General Call. Up to 8 STMPE1601 devices can be connected on a single I2C bus. 6.6 Memory addressing For the bus master to communicate to the slave device, the bus master must initiate a Start condition and followed by the slave device address. Accompanying the slave device address, there is a Read/Write bit (R/W). The bit is set to 1 for Read and 0 for Write operation. If a match occurs on the slave device address, the corresponding device gives an acknowledgement on the SDA during the 9th bit time. If there is no match, it deselects itself from the bus by not responding to the transaction. 13/58 I2C interface 6.7 STMPE1601 Operating modes Table 13. Operating modes Mode Bytes Programming sequence START, Device address, R/W = 0, Register address to be read reSTART, Device address, R/W = 1, Data Read, STOP If no STOP is issued, the Data Read can be continuously performed. If the register address falls within the range that allows address autoincrement, then register address auto-increments internally after every byte of data being read. For register address that falls within a nonincremental address range, the address will be kept static throughout the entire read operations. Refer to the Memory Map table for the address ranges that are auto and non-increment. An example of such a non-increment address is FIFO. ≥1 Read START, Device address, R/W = 0, Register address to be written, Data Write, STOP. ≥1 Write Slave 14/58 Data to Write + 2 Ack Stop Data to Write + 1 Stop Data Read + 2 No Ack Data Read + 1 Ack Stop No Ack Ack Data Read Ack Ack Restart Data to Write Ack Reg Address R/W=1 Ack Restart Data to be written Ack Reg Address R/W=1 Ack Restart Device Address Data Read Ack Stop Ack Restart Reg Address Ack Ack R/W=0 Master Ack R/W=0 R/W=0 Device Address Device Address Ack Device Address Reg Address Ack More than one byte Read Device Address R/W=0 One byte Write Start More than one byte Read Device Address Start One byte Read Start I2C transaction Start Figure 3. If no STOP is issued, the Data Write can be continuously performed. If the register address falls within the range that allows address autoincrement, then register address auto-increments internally after every byte of data being written. For those register addresses that fall within a non-incremental address range, the address will be kept static throughout the all write operations. Refer to the memory map table for the address ranges that are auto and non-increment. An example of a non-increment address is Data Port for initializing the PWM commands. STMPE1601 6.8 I2C interface General call address A general call address is a transaction with the slave address of 0x00 and R/W = 0. When a general call address is made, STMPE1601 responds to this transaction with an acknowledgement and behaves as a slave-receiver mode. The meaning of a general call address is defined in the second byte sent by the master-transmitter. Table 14. Note: General call address R/W Second byte value Definition 0 0x06 A 2-byte transaction in which the second byte tells the slave device to reset and write (or latch in) the 2-bit programmable part of the slave address. 0 0x04 A 2-byte transaction in which the second byte tells the slave device not to reset and write (or latch in) the 2-bit programmable part of the slave address. 0 0x00 Not allowed as second byte. All other second byte values will be ignored. 15/58 System controller 7 STMPE1601 System controller The system controller is the heart of the STMPE1601. It contains the registers for power control, and the registers for chip identification. The system registers are: Table 15. System registers Address Register_Name 0x80 CHIP_ID 0x81 VERSION_ID 0x02 SYS_CTRL 0x03 SYS_CTRL_2 CHIP_ID Chip identification register 7 6 5 4 R R R R 0 0 0 0 3 2 1 0 R R R R 0 0 1 0 2 1 0 8-bit MSB of CHIP_ID VERSION_ID Version identification register 7 6 5 4 3 R R R R R R R R 0 0 0 1 0 0 0 0 8-bit VERSION_ID 16/58 STMPE1601 System controller SYS_CTRL System control register 7 6 5 4 3 2 1 0 SOFT_RESET CLOCK SOURCE DIS_32KHz SLEEP EN_GPIO RESERVED EN_KPC EN_SPWM W RW RW RW RW RW RW RW RW R R RW R R R R 0 0 0 0 1 ?? 1 1 Address: 0x02 Type: R/W Buffer: Reset: 0x0B Description: System control register. [7] SOFT_RESET Writing a ‘1’ to this bit will do a soft reset of the device. Once the reset is done, this bit will be cleared to ‘0’ by the HW. [6] CLOCK_SOURCE Set to ‘1’ if external 32 kHz clock were to be used. ‘0’ by default. [5] DIS_32 kHz: Set this bit to disable the 32 kHz OSC, thus putting the device in hibernate mode. [4] SLEEP: Writing a ‘1’ to this bit will put the device in sleep mode. On going to sleep mode, this mode is reset internally. When in sleep mode, the internal RC oscillator will output a slower sleep clock which will be used in the device. [3] EN_GPIO: Writing a ‘0’ to this bit will gate off the clock to the GPIO module, thus stopping its operation [2] RESERVED [1] EN_KPC: Writing a ‘0’ to this bit will gate off the clock to the Keypad Controller module, thus stopping its operation [0] EN_SPWM Writing a ‘0’ to this bit will gate off the clock to the Simple PWM Controller module, thus stopping its operation 17/58 System controller STMPE1601 SYS_CTRL_2 7 System control register 2 6 4 3 2 1 0 RESERVED VIO_OFF AUTOSLEEP_EN SLEEP_2 SLEEP_1 SLEEP_0 R R RW RW RW RW 0 0 0 0 0 0 Address: 0x03 Type: R/W 5 Buffer: Reset: 0x00 Description: System control register [7] RESERVED [6] RESERVED [5] RESERVED [4] VIO_OFF: Writing a ‘1’ to this bit is mandatory before shuting off the VIO supply while maintaining the VCC supply. This ensure that the level shifters for GPIOs 15-8 are properly powered down so as not to induce high current and also not to affect the integrity of any external signals that are on the bus where these GPIOs are connected. [3] AUTOSLEEP_EN: “1” to enable auto-sleep feature. “0” to disable auto-sleep. [2:0] SLEEP: 000 for 4 mS delay 001 for 16 mS delay 010 for 32 mS delay 011: for 64 mS delay 100: for 128 mS delay 101: for 256 mS delay 110: for 512 mS delay 111: for 1024 mS delay 18/58 STMPE1601 7.1 System controller States of operation Figure 4. Modes of operation OPERATIONAL 32K: ON RC: OFF Set Sleep bit or autosleep Set Disable_32K bit Keypad, Interrupts & I2 C transaction SLEEP 32K: ON RC: OFF Reset 2 I C transaction Valid Keypress detect HIBERNATE 32K: OFF RC: OFF The device has three main modes of operation: Note: ● Operational mode: This is the mode, whereby normal operation of the device takes place. In this mode, the RC4M clock is available and the main FSM unit routes this clock and the 32 KHz clock to all the device blocks that are enabled. In this mode, individual blocks that need not to be working can be turned off by the master by programming the bits 3 to 0 of the SYS_CTRL register. ● Sleep mode: In this low-power mode, the 4MHz RC oscillator is powered down. All the blocks which need clocks derived from the 32KHz clock will continue getting a 32 KHz clock. In this mode also, iindividual blocks can be turned off by the master by programming the bits 3 to 0 of the SYS_CTRL register. However, the master needs to program the SYS_CTRL register before coming into this mode, as in the sleep mode, the IIC interface is not active except to detect traffic for wakeup. Any activity on the I2C port (intended I2C transaction for the device) or Wakeup pin or Hotkey activity will cause the device to leave this mode and go into the Operational mode. When leaving this mode, the I2C will need to hold the SCLK till the RC4M clock is ready. ● Hibernate mode: This mode is entered when the system writes a ‘1’ to bit 5 of the SYS_CTRL register. In this mode, the device is completely inactive as there is absolutely no clock. Only a Reset or a wakeup on IIC will bring back the System to operational mode. A keypress detect will bring the system to Sleep mode, in which the debounce of the key will take place. The 32 kHz clock mentioned in this section can be (1) an externally fed 32 KHz clock, or (2) an internally generated (from RC OSC) clock. In case the internal clock is used, the clock has a range of 25 to 45 KHz. 19/58 System controller 7.2 STMPE1601 Autosleep The host system may configure the STMPE1601 to go into sleep mode automatically whenever there is a period of inactivity following a complete I2C transaction with the STMPE1601. This inactivity means there is no intended I2C transaction for the device. For example, if there is Ian 2C transaction sent by the host to other slave devices, the STMPE1601 device will still be counting down for the auto-sleep. The STMPE1601 device resets the autosleep time-out counter only when it receives an I2C transaction meant for the device itself. This autosleep feature is controlled by the SYS_CTRL_2 (system control register 2). All those events that trigger an interrupt (KPC, hot-key) would result in a transition from Sleep state to Operational state automatically. The wakeup can also be performed through the I2C transaction intended for the device. 7.3 Keypress detect in the hibernate mode When in Hibernate mode, a keypress detect causes the system to go into sleep mode. The sleep clock (32 kHz) is then used to debounce the key to detect a valid key. If the keypress is detected to be valid, the system stays in sleep mode. If the key is detected to be invalid, the system goes back into Hibernate mode. 20/58 STMPE1601 8 Clocking system Clocking system Figure 5. Clocking system Internal RC OSC System clock Clock control CLK_IN SCLK Pin System control register The decision on clocks is based on the bits written into the SYS_CTRL registers. Bits 0 to 4 of the SYS_CTRL register allow to control the gating of clocks to the Rotator, Keypad controller, PWM and GPIO respectively in the operational mode. 8.1 Clock source By default, when the STMPE1601 powers up, it derives a 32 KHz clock from the internal RC oscillator for its operation. If an external clock source is available, it must be configured to accept an external clock through the SYS_CTRL register. Reset control: There are 4 sources of reset: ● Reset_N pin ● LVD reset ● Soft reset bit of the SYS_CTRL register ● I2C reset from the I2C block. 21/58 Clocking system 8.2 STMPE1601 Power mode programming sequence To put the device in sleep mode, the following needs to be done by the host: – Write a '1' to bit 4 of the SYS_CTRL register. To wake up the device, the host is required to: – Assert a wakeup routine on the I2C bus by sending the Start bit, followed by the device address and the Write bit. Subsequently, proceed with sending the Base Register address and continue with a normal I2C transaction. The device wakes up upon receiving the correct device address and in Write direction. In other words, the procedure of waking up the device is performed by just sending an I2C transaction to the device. This procedure can be extended to wake up the device that is in hibernate mode. To do a soft reset to the device, the host needs to do the following: – Write a '1' to bit 7 of the SYS_CTRL register. This bit is automatically cleared upon reset. To go into Hibernate mode, the following needs to be done by the host: – Set the Disable_32K bit to '1' To come out of the Hibernate mode, the following needs to be done by the host: 22/58 – Assert a system reset – or put a wakeup on the I2C STMPE1601 9 Interrupt system Interrupt system The STMPE1601 uses a highly flexible interrupt system. It allows the host system to configure the type of system events that should result in an interrupt, and pinpoints the source of interrupt by status register. The INT pin can be configured as ACTIVE HIGH, or ACTIVE LOW. Once asserted, the INT pin would de-assert only if the corresponding bit in the interrupt status register is cleared. Figure 6. Interrupt system Keypad controller Interrupt status register Interrupt generation PWM controller Interrupt enable register GPIO controller 9.1 Interrupt polarity control (System control register) Interrupt system register map Table 16. Address 0x10 Register map Register name Description INT_CTRL_MSB Auto-increment (during sequential R/W) Yes Interrupt control register 0x11 INT__CTRL_LSB 0x12 INT_EN_MASK_MSB Yes Yes Interrupt enable mask register 0x13 INT_EN_MASK_LSB 0x14 INT_STA_MSB Yes Yes Interrupt status register 0x15 INT_STA_LSB 0x16 INT_EN_GPIO_MASK _MSB Yes Yes Interrupt enable GPIO mask register 0x17 INT_EN_GPIO_MASK _LSB 0x18 INT_STA_GPIO_MSB Yes Yes Interrupt status GPIO register 0x19 INT_STA_GPIO_LSB Yes 23/58 Interrupt system 9.1.1 STMPE1601 Interrupt latency When the generation of interrupts by the GPIO as input is enabled, the latency (time taken from actual transition at GPIO to time of INT pin assertion) is shown in the following table: Table 17. Interrupt latency State of operation Interrupt latency Hibernation 10 uS max Sleep 5 uS max Active 2 uS max INT_CTRL 15 14 Interrupt control register 13 12 11 10 9 8 7 6 5 INT_CTRL_msb 4 3 2 1 0 IC2 IC1 IC0 INT_CTRL_lsb Reserved R R R R R R R R R R R R R RW RW RW 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Address: 0x10, 0x11 Buffer: R, R/W Reset: 0x00 Description: The interrupt control register is used to configure the interrupt controller. It has a global enable interrupt mask bit that controls the interruption to the host. [15:3] RESERVED [2] IC2 [1] IC1: Output Interrupt Type ‘0’ = Level interrupt ‘1’ = Edge interrupt [0] IC0: Global Interrupt Mask bit When this bit is written a ‘1’, it will allow interruption to the host. If it is written with a ‘0’, then, it disables all interruption to the host. Writing to this bit does not affect the INT_EN_MASK value. 24/58 STMPE1601 Interrupt system INT_EN_MASK 15 14 13 Interrupt enable mask register 12 11 10 9 8 7 6 5 INT_EN_MASK_msb 4 3 2 1 0 INT_EN_MASK_lsb IE8 IE7 IE6 IE5 IE4 IE3 IE2 IE1 IE0 R R R R R R R RW R/W R/W RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Address: 0x12, 0x13 Buffer: R, R/W Reset: 0x00 Description: The interrupt enable mask register is used to enable the interruption from a particular interrupt source to the host. [15:9] INT_EN_MASK_MSB [8] IE[x]: Interrupt Enable Mask (where x = 8 to 0) IE0: Wake-up interrupt mask IE1: Keypad controller interrupt mask IE2: Keypad controller FIFO overflow interrupt mask IE3: Reserved IE4: Basic PWM controller 0 interrupt mask IE5: Basic PWM controller 1 interrupt mask IE6: Basic PWM controller 2 interrupt mask IE7: Basic PWM controller 3 interrupt mask IE8: GPIO controller interrupt mask Writing a ‘1’ to the IE[x] bit enables the interruption to the host. 25/58 Interrupt system STMPE1601 INT_STA 15 Interrupt status register 14 13 12 11 10 9 8 7 6 5 ISR_msb 4 3 2 1 0 ISR_lsb IS8 - - IS5 IS4 IS3 IS2 IS1 IS0 R R R R R R R RW - - RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Address: 0x14, 0x15 Type: R, R/W Buffer: Reset: 0x00 Description: The interrupt status register monitors the status of the interruption from a particular interrupt source to the host. Regardless whether the INT_EN bits are enabled or not, the INT_STA bits are still updated. [15:9] [8:0] IS[x]: Interrupt status (where x = 8 to 0) Read: IE0: Wake-up Interrupt Status IE1: Keypad controller interrupt status IE2: Keypad controller FIFO overflow interrupt status IE3: Reserved IE4: Basic PWM controller 0 interrupt status IE5: Basic PWM controller 1 interrupt status IE6: Basic PWM controller 2 Interrupt status IE7: Basic PWM controller 3 interrupt status IE8: GPIO Controller Interrupt Status Write: a write to a IS[x] bit with a value of ‘1’ will clear the interrupt and a write with a value of ‘0’ has no effect on the IS[x] bit. 26/58 STMPE1601 Interrupt system INT_EN_GPIO_MASK 15 14 13 Interrupt enable GPIO mask register 12 11 10 9 8 7 6 INT_EN_GPIO_MASK_msb 5 4 3 2 1 0 INT_EN_GPIO_MASK _lsb IEG15 IEG14 IEG13 IEG12 IEG11 IEG10 IEG9 IEG8 IEG7 IEG6 IEG5 IEG4 IEG3 IEG2 IEG1 IEG0 RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Address: 0x16, 0x17 Type: R/W Buffer: Reset: 0x00 Description: The interrupt enable GPIO mask register is used to enable the interruption from a particular GPIO interrupt source to the host. The IEG[15:0] bits are the interrupt enable mask bits correspond to the GPIO[15:0] pins . [15:0] IEG[x]: interrupt enable GPIO mask (where x = 15 to 0) Writing a ‘1’ to the IE[x] bit will enable the interruption to the host. INT_STA_GPIO 15 14 Interrupt status GPIO register 13 12 11 10 9 8 7 6 5 INT_STA_GPIOR_msb 4 3 2 1 0 INT_STA_GPIOR _lsb ISG15 ISG14 ISG13 ISG12 ISG11 ISG10 ISG9 ISG8 ISG7 ISG6 ISG5 ISG4 ISG3 ISG2 ISG1 ISG0 RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 Address: 0x18, 0x19 Type: R/W Buffer: Reset: 0x00 Description: The interrupt status GPIO register monitors the status of the interruption from a particular GPIO pin interrupt source to the host. Regardless whether the INT_EN_GPIO_MASK bits are enabled or not, the INT_STA_GPIO bits are still updated. The INT_STA_G[15:0] bits are the interrupt status bits correspond to the GPIO[15:0] pins. [15:0] ISG[x] Interrupt status GPIO (where x = 15 to 0) Read: Interrupt status of the GPIO[x]. Write: A write to a ISG[x] bit with a value of ‘1’ will clear the interrupt and a write with a value of ‘0’ has no effect on the ISG[x] bit. 27/58 Interrupt system 9.2 STMPE1601 Programming sequence To configure and initialize the Interrupt Controller to allow interruption to host, observe the following steps: 28/58 ● Set the INT_EN_MASK and INT_EN_GPIO_MASK registers to the desired values to enable the interrupt sources that are to be expected to receive from. ● Configure the output interrupt type and polarity and enable the global interrupt mask by writing to the INT_CTRL. ● Wait for interrupt. ● Upon receiving an interrupt, the INT pin is asserted. ● The host comes to read the INT_STA register through the I2C interface. A ‘1’ in the INT_STA bits indicates that the corresponding interrupt source is triggered. ● If the IS8 bit in INT_STA register is set, the interrupt is coming from the GPIO controller. Then, a subsequent read is performed on the INT_STA_GPIO register to obtain the interrupt status of all 16 GPIOs to locate the GPIO that triggers the interrupt. This is a feature so-called ‘Hot Key’. ● After obtaining the interrupt source that triggers the interrupt, the host performs the necessary processing and operations related to the interrupt source. ● If the interrupt source is from the GPIO Controller, two write operations with value of ‘1’ are performed to the ISG[x] bit (INT_STA_GPIO) and the IS[8] (ISR) to clear the corresponding GPIO interrupt. ● If the interrupt source is from other module, a write operation with value of ‘1’ is performed to the IS[x] (ISR) to clear the corresponding interrupt. ● Once the interrupt is being cleared, the INT pin will also be de-asserted if the interrupt type is level interrupt. An edge interrupt will only assert a pulse width of 250ns. ● When the interrupt is no longer required, the IC0 bit in INT_CTRL may be set to ‘0’ to disable the global interrupt mask bit. STMPE1601 10 GPIO controller GPIO controller A total of 16 GPIOs are available in the STMPE1601 port expander IC. Most of the GPIOs are sharing physical pins with some alternate functions. The GPIO controller contains the registers that allow the host system to configure each of the pins into either a GPIO, or one of the alternate functions. Unused GPIOs should be configured as outputs to minimize the power consumption. Table 18. GPIO controller Offset address 0x02 Register name Description GPIO_SET_MSB Auto-increment (during sequential R/W) Yes GPIO set pin state register 0x03 GPIO_SET_LSB 0x04 GPIO_CLR_msb Yes Yes GPIO clear pin state register 0x05 GPIO_CLR_LSB 0x06 GP_MP_MSB Yes Yes GPIO monitor pin state register 0x07 GPIO_MP_LSB 0x08 GPIO_SET_DIR_MSB Yes Yes GPIO set pin direction register 0x09 GPIO_SET_DIR_LSB 0x0A GPIO_ED_MSB 0x0B GPIO_ED_LSB 0x0C GPIO_RE_MSB Yes GPIO edge detect status register Yes Yes Yes GPIO rising edge register 0x0D GPIO_RE_LSB 0x0E GPIO_FE_MSB Yes Yes GPIO falling edge register 0x0F GPIO_FE_LSB 0x10 GPIO_PULL_UP_MS B 0x11 GPIO_PULL_UP_LSB 0x12 GPIO_AF_U_MSB 0x13 GPIO_AF_U_MSB 0x14 GPIO_AF_L_MSB 0x15 Yes Yes GPIO pull up register Yes GPIO alternate function register (upper bit) Yes Yes Yes GPIO_AF_L_LSB GPIO alternate function register (lower bit) Yes 0x16 GPIO_LT_EN GPIO level translator enable Yes 0x17 GPIO_LT_DIR GPIO level translator direction Yes RESERVED Reserved Yes 0x18-1F 29/58 GPIO controller 10.1 STMPE1601 GPIO control registers A group of registers is used to control the exact function of each of the 16 GPIOs. All the GPIO registers are named as GPxxx_yyy, where: – Xxx represents the functional group – Yyy represents the byte position of the GPIO – Lsb registers control GPIO[7:0] – Msb registers control GPIO[8:15] Table 19. Bit description 7 6 5 4 3 2 1 0 GPxxx_msb IO-15 IO-14 IO-13 IO-12 IO-11 IO-10 IO-9 IO-8 GPxxx_lsb IO-7 IO-6 IO-5 IO-4 IO-3 IO-2 IO-1 IO-0 The function of each bit is shown in the following table: Table 20. Register description Register name GPIO monitor pin state Reading this bit yields the current state of the bit. Writing has no effect. GPIO set pin state Writing ‘1’ to this bit causes the corresponding GPIO to go to ‘1’ state. Writing ‘0’ has no effect. GPIO clear pin state Writing ‘1’ to this bit causes the corresponding GPIO to go to ‘0’ state. Writing ‘0’ has no effect. GPIO set pin direction ‘0’ sets the corresponding GPIO to input state, and ‘1’ sets it to output state GPIO edge detect status Set to ‘1’ by hardware when there is a rising/falling edge on the corresponding GPIO. Writing ‘1’ clears the bit. Writing ‘0’ has no effect. GPIO rising edge Set to ‘1’ to enable rising edge detection on the corresponding GPIO. GPIO falling edge Set to ‘1’ to enable falling edge detection on the corresponding GPIO. GPIO pull up Set to ‘1’ to enable internal pull-up resistor GPIO alternate function (upper bit) ‘00’ for primary function ‘01’ for Alternate Function 1 ‘10’ for Alternate Function 2 ‘11’ - Reserved GPIO alternate function (lower bit) 30/58 Function STMPE1601 10.2 GPIO controller Hotkey feature A GPIO is known as ‘Hotkey’ when it is configured to trigger an interruption to the host whenever the GPIO input is being asserted. This feature is applicable in Operational mode (4 MHz clock is present) as well as Sleep mode (32 kHz clock is present). 10.2.1 Programming sequence for Hotkey 1. Configure the GPIO pin into GPIO mode by setting the corresponding bits in the GPAFR. 2. Configure the GPIO pin into input direction by setting the corresponding bit in GPDR. 3. Set the GPRER and GPFER to the desired values to enable the rising edge or falling edge detection. 4. Configure and enable the interrupt controller to allow the interruption to the host. 5. Now, the GPIO expander may be put into Sleep mode if it is desired. 6. Upon any hot-key being asserted, the device will wake up and issue an interrupt to the host. Below are the conditions to be fulfilled in order to configure a Hot Key: 10.2.2 1. The pin is configured into GPIO mode and as input pin. 2. The global interrupt mask bit is enabled. 3. The corresponding GPIO interrupt mask bit is enabled. Minimum pulse width The minimum pulse width of the assertion of the Hotkey must be at least 62.5 us. Any pulse width less than the stated value may not be registered. 31/58 GPIO controller 10.3 STMPE1601 Level translator feature Figure 7. Level translator feature GPIO 0-7 Direction & enable GPIO 8-15 When enabled, the GPIO 0-7 bits are internally mapped to GPIO 8-15 bits. The STMPE1601 becomes an 8-channel level translator where each of the channels may have its direction set individually. As GPIO 0-7 operates from Vcc, and GPIO 8-15 operates from Vio, this allows the 2 groups of GPIO to work as a level translator. Warning: 32/58 When the level translator feature is enabled, the “Set pin”, “Clear pin” and “Set direction” bits in the corresponding registers will be ignored. However, the “Monitor pin”, “Edge detect”, “Pull-up” features are still available in the GPIOs used as level translator. STMPE1601 11 Basic PWM controller Basic PWM controller The advanced PWM allows complex brightness and blinking control of an LED. The Basic PWM Controller allows simpler brightness control and basic blinking patterns. STMPE1601 is fitted with 4 channel of basic PWM controller. Table 21. Address Basic PWM controller Register name Description Auto-increment (during sequential R/W) 0x40 PWM_OFF_OUT Set the output level when PWM is disabled Yes 0x41 CHANNEL_FUNCT_EN Enable/disable individual basic PWM channels Yes 0x50 PWM_0_SET PWM_0 brightness and timing setting Yes 0x51 PWM_0_CTRL PWM_0 blinking control Yes 0x52 PWM_0_TRIGGER Enable use trigger on PWM 0 Yes 0x54 PWM_1_SET PWM_1 brightness and timing setting Yes 0x55 PWM_1_CTRL PWM_1 blinking control Yes 0x56 PWM_1_TRIGGER Enable use trigger on PWM 1 Yes 0x58 PWM_2_SET PWM_2 brightness and timing setting Yes 0x59 PWM_2_CTRL PWM_2 blinking control Yes 0x5A PWM_2_TRIGGER Enable use trigger on PWM 2 Yes 0x5C PWM_3_SET PWM_3 brightness and timing setting Yes 0x5D PWM_3_CTRL PWM_3 blinking control Yes 0x5E PWM_3_TRIGGER Enable use trigger on PWM 3 Yes 33/58 Basic PWM controller STMPE1601 PWM_OFF_OUTPUT PWM off output 7 6 5 4 3 2 1 0 - - - - OUT3 OUT2 OUT1 OUT0 RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 Address: 0x40 Type: R/W Buffer: Reset: 0x00 Description: Set the output level when the PWM is disabled [7:0] OUT7~0: Default is ‘0’ 1: PWM channel outputs ‘1’ when disabled 0: PWM channel outputs ‘0’ when disabled CHANNEL_FUNCT_EN Channel function enabling 7 6 4 3 2 1 0 ALT_3 ALT_2 ALT_1 ALT_0 EN_3 EN_2 EN_1 EN_0 ALT_3 RW RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 Address: 0x41 Type: R/W 5 Buffer: Reset: 0x00 Description: Enable/disable individual basic PWM channels. [7:4] ALT [3:0]: Alternate mode Default is ‘0’ HW writes to ‘1’ if alternate operating feature (one-shot/WDT) is required [3:0] EN [3:0]: PWM channel enable Default is ‘0’ SW writes ‘1’ to start PWM channel HW writes ‘0’ when PWM blinking is completed 34/58 STMPE1601 Basic PWM controller PWM_n_TRIGGER_n = 0 - 3 PWM trigger register n = 0 - 3 7 6 4 3 2 1 0 ARM Edge - AC MODE GS2 GS1 GS0 ARM RW RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 Address: 5 0x52, 0x56, 0x5A, 0x5E Type: Buffer: Reset: 0x00 Description: Enable use of trigger on PWM_n. [7] RESET: Always read ‘0’ S/W writes ‘1’ to reset counter in WDT mode Writing ‘1 and PWM/One [6] EDGE: 0: low-to-high 1: hi-to-low [5] RESERVED: 0: one-shot timer mode 1: watch-dog timer mode This bit is only valid if the ALT bits in the Channel_function_En register is set to ‘1’ [4] MODE: For one-shot mode only . Reload bit defines whether reload is necessary after trigger has occured 0: to disable Auto-Reload 1: to enable Auto-Reload [3] RELOAD [2:0] GS2:0: Trigger source select 000: GPIO-4 001: GPIO-5 010: GPIO-6 011: GPIO-7 100: GPIO-9 101: GPIO-10 110: GPIO-11 111: GPIO-12 35/58 Basic PWM controller STMPE1601 PWM_n_SET n=0-3 7 PWM_n_Setup n=0-3 6 5 4 3 2 Brightness 1 0 Timing R/W R/W R/W R/W R/W R/W R/W R/W 0 0 0 0 0 0 0 0 Address: 0x50, 0x54, 0x58, 0x5C Type: RW Buffer: Reset: 0x00 Description: PWM blinking control [7:4] BRIGTHNESS: Duty cycle of PWM output during period 0 [3:0] TIMING: In PWM mode: time unit of each ON or OFF period In WDT mode: Wait time In one-short mode: pulse width 0000 = 5 mS 0001 = 10 mS 0010 = 20 mS 0011 = 40 mS 0100 = 80 mS 0101 = 160 mS 0110 = 320 mS 0111 = 640 mS 1000 = 1001 = 1010 = 1011 = 1100 = 1101 = 1110 = 1111 = 36/58 1280 mS 2560 mS 5120 mS 10 S 20 S 40 S 80 S 160 S STMPE1601 Basic PWM controller PWM_n_CTRL_n=0-3 7 PWMn control register n=0-3 6 5 Period 0 4 Period 1 3 1 0 INT_EN Inverse Period 0 RW RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 0 Address: 0x51, 0x55, 0x59, 0x5D Type: R/W Repetition 2 Buffer: Reset: 0x00 Description: PWM blinking control register [7:6] Period 0: 1-4 time units of period 0 [5:4] Period 1: 0-3 time units of period 1 [3:2] Repetition: Number of repetition 0 for Infinite repetition [1] INT_EN: “0” to disable interrupt generation on completion of sequence “1” to enable interrupt generation on completion of sequence [0] FRAME: ‘0’ will output period 0 first ‘1’ will output period 1 first 37/58 Basic PWM controller 11.1 STMPE1601 Interrupt on basic PWM controller A basic PWM controller can be programmed to generate interrupts at the completion of a blinking sequence. However, there are some limitations: 11.2 a) Each basic PWM controller has its own bit in the interrupt enable/status registers. b) If enabled, completion in any of the PWM controller triggers interrupts. No interrupt will be generated if infinite repetition is set. c) In WDT mode, an interrupt is generated when timeout occurs d) In One-shot mode If Auto-reload, interrupt is generated every time a valid trigger is detected If Non-auto-reload, an interrupt is generated just once Trigger feature The basic PWM controller can be programmed to be controlled by an external “trigger” signal. This feature can be used to implement: ● One shot trigger circuit ● Watchdog timer A 120 μS pulse is generated at PWM output when the programmed timer has elapsed without getting any trigger for the trigger source. 38/58 STMPE1601 12 Keypad controller Keypad controller The keypad controller consists of: – 4 dedicated key controllers that support up to 4 simultaneous dedicated key presses; – a keyscan controller and two normal key controllers that support a maximum of 8 x 8 key matrix with detection of three simultaneous key presses; – 8 special function key controllers that support up to 8 simultaneous “special function” key presses. Four of the column inputs can be configured as dedicated keys through the setting of Dkey0~3 bits of the KPC_CTRL register. The normal key matrix size can be configured through the setting of KPC_ROW and KPC_COL registers. The scanning of each individual row output and column input can be enabled or masked to support a key matrix of variable size from 1 x 1 to 8 x 8. It is allowed to have other 8 special function keys incorporated in the key matrix. The operation of the keypad controller is enabled by the SCAN bit of KPC_CTRL register. Every key activity detected will be de-bounced for a period set by the DB_0~7 bits of KPC_CTRL register before a key press or key release is confirmed and updated into the output FIFO. The key data, indicating the key coordinates and its status (up or down), is loaded into the FIFO at the end of a specified number of scanning cycles (set by SCAN_COUNT0~3 bits of KPC_ROW_MSB register). An interrupt will be generated when a new set of key data is loaded. The FIFO has a capacity for ten sets of key data. Each set of key data consists of 5 bytes of information when any of the four dedicated keys is enabled. It is reduced to 4 bytes when no dedicated key is involved. When the FIFO is full before its content is read, an overflow signal will be generated while the FIFO will continue to hold its content but forbid loading of new key data set. Figure 8. Keypad controller Input 0-7 Keypad Matrix Output 0-7 The keypad column inputs enabled by the KPC_col register are normally 'high', with the corresponding input pins pulled up by resistors internally. After reset, all the keypad row outputs enabled by the KPC_row register are driven 'low'. If a key is pressed, its 39/58 Keypad controller STMPE1601 corresponding column input will become 'low' after making contact with the 'low' voltage on its corresponding row output. Once the keyscan controller senses a 'low' input on any of the column inputs, the scanning cycles will then start to determine the exact key that has been pressed. The twelve row outputs will be driven 'low' one by one during each scanning cycle. While one row is driven 'low', all other rows are in tri-state and pulled up. If there is any column input sensed as 'low' when a row is driven 'low', the key scan controller will then decode the key coordinates (its corresponding row number and column number), save the key data into a de-bounce buffer if available, confirm if it is a valid key press after de-bouncing, and update the key data into output data FIFO if valid. 12.1 Keypad configurations The keypad controller supports the following types of keys: ● Up to 8 input * 8 output matrix keys ● Up to 8 special function keys ● Up to 4 dedicated keys Figure 9. Maximum configuration Matrix Keypad (8*8) STMPE1601 Output 0-7 Input 0-7 Special Function Keys 8*8 (64) Matrix Keys 8 Special Function Keys 0 Dedicated Keys 40/58 STMPE1601 Keypad controller Figure 10. Maximum configuration STMPE1601 Output 0-7 Input 0-3 Matrix Keypad (4*8) Input 4-7 Dedicated Keys Special Function Keys 4*8 (32) Matrix Keys 4 Special Function Keys 4 Dedicated Keys 41/58 Keypad controller 12.2 STMPE1601 Registers in keypad controller Table 22. Address Registers in keypad controller Register name 0x60 KPC_COL 0x61 KPC_ROW_MSB Description Keypad column scanning register Auto-increment (during sequential R/W) Yes Yes Keypad row scanning register 0x62 KPC_ROW_LSB 0x63 KPC_CTRL_MSB Yes Yes Keypad control register 42/58 0x64 KPC_CTRL_LSB Yes 0x65 KPC_COMBI_KEY_0 Keypad combination key mask 0 Yes 0x66 KPC_COMBI_KEY_1 Keypad combination key mask 1 Yes 0x67 KPC_COMBI_KEY_2 Keypad combination key mask 2 Yes 0x68 KPC_DATA_BYTE0 Yes 0x69 KPC_DATA_BYTE1 Yes 0x6A KPC_DATA_BYTE2 Keypad data register Yes 0x6B KPC_DATA_BYTE3 Yes 0x6C KPC_DATA_BYTE4 Yes STMPE1601 Keypad controller KPC_COL Keypad colum register 7 6 5 4 3 2 1 0 RW RW RW RW 0 0 0 RW RW RW RW 0 0 0 0 0 Input Column 0 ~ 7 Address: 0x60 Type: R/W Buffer: Reset: 0x00 Description: Keypad column scanning [7] INPUT COLUMN: 1: turn on scanning of column 7 0: turn off [6] INPUT COLUMN: 1: turn on scanning of column 6 0: turn off [5] INPUT COLUMN: 1: turn on scanning of column 5 0: turn off [4] INPUT COLUMN: 1: turn on scanning of column 4 0: turn off [3] INPUT COLUMN: 1: turn on scanning of column 3 0: turn off [2] INPUT COLUMN: 1: turn on scanning of column 2 0: turn off [1] INPUT COLUMN: 1: turn on scanning of column 1 0: turn off [0] INPUT COLUMN: 1: turn on scanning of column 0 0: turn off 43/58 Keypad controller STMPE1601 KPC_ROW_MSB Keypad row MSB 7 6 5 SCAN_PW1 SCAN_PW0 HIB_WK - R/W R/W R/W 1 1 0 Address: 0x61 Type: R/W, R 4 3 2 1 0 R R R 0 0 R R 0 0 0 RESERVED Buffer: Reset: Description: Keypad row scanning register [7:6] SCAN_PW[1:0]: Row output scanning pulse width setting: 00: 1x period of internal clock 01: 16x period of internal clock 10: 64x period of internal clock 11: 128x period of internal clock (default) (This setting is only applicable during normal operation mode. The scanning pulse width is 1x period of 32 kHz clock during sleep mode.) [5] HIB_WK: 1: to enable the keypad wake-up from hibernate mode 0: to disable [4] [3:0] RESERVED: 44/58 STMPE1601 Keypad controller KPC_ROW_lsb Keypad controller row (LSB) 7 6 5 4 R/W R/W R/W R/W 0 0 0 0 3 2 1 0 R/W R/W R/W R/W 0 0 0 0 1 0 OUTPUT ROW 0 ~ 7 Address: 0x62 Type: Buffer: Reset: 0x00 Description: Keypad row scanning register. [7:0] OUTPUT ROW 0 ~ 7: ‘1’ to turn on scanning of the corresponding row; ‘0’ to turn off KPC_CTRL_msb 7 6 Keypad controller control (MSB) 5 4 3 2 SCAN_COUNT_0 ~ 3 DKEYy_0 ~ 3 RW RW RW RW RW RW RW RW 0 0 0 0 0 0 0 0 Address: 0x63 Type: R/W Buffer: Reset: 0x00 Description: Keypad control register. [7:4] SCAN_COUNT_0~ 3: Number of key scanning cycles elapsed before a confirmed key data is updated into output data FIFO (0 ~ 15 cycles) [3] DKEY_3: Set ‘1’ to use input column 3 as dedicated key [2] DKEY_2: Set ‘1’ to use input column 2 as dedicated key [1] DKEY_1: Set ‘1’ to use input column 1 as dedicated key [0] DKEY_0: Set ‘1’ to use input column 0 as dedicated key 45/58 Keypad controller STMPE1601 KPC_CTRL_lsb Keypad controller control (LSB) 7 6 5 R/W R/W R/W 0 0 0 4 3 2 1 R/W R/W R/W R/W R/W 0 0 0 0 0 DB_0 ~ 5 Address: 0x64 Type: R/W Buffer: Reset: 0x00 Description: Keypad control register. [7:1] DB_6:1: 0-128 ms of de-bounce time [0] SCAN: 1: to start scanning 0: to stop 46/58 0 SCAN STMPE1601 13 Data registers Data registers The KPC_DATA register contains three bytes of information. The first two bytes store the key coordinates and status of any two keys from the normal key matrix, while the third byte store the status of dedicated keys. KPC_DATA_BYTE0 Keypad data byte 0 7 6 5 4 3 2 1 0 UP/DOWN R3 R2 R1 R0 C2 C1 C0 R R R R R R R R 1 1 1 1 1 0 0 0 Address: 0x68 Type: R Buffer: Reset: 0xF8 Description: Keypad data register. [7] UP/DOWN: 0: key-down 1: key-up [6:3] R[3:0] Row number of key 1 (valid range: 0-7) 0x1111: No Key [2:0] C[2:0}: Column number of key 1 (valid range: 0-7) 47/58 Data registers STMPE1601 KPC_DATA_BYTE1 Keypad data byte 1 7 6 5 4 3 2 1 0 Up/Down R3 R2 R1 R0 C2 C1 C0 R R R R R R R R 1 1 1 1 1 0 0 0 Address: 0x69 Type: R Buffer: Reset: 0xF8 Description: Keypad data register. [7] UP/DOWN: 0: key-down 1: key-up [6:3] R[3:0] Row number of key 2 (valid range: 0-7) 0x1111: No key [2:0] C[2:0}: Column number of key 1 (valid range: 0-7) 48/58 STMPE1601 Data registers KPC_DATA_BYTE2 Keypad data byte 2 7 6 5 4 3 2 1 0 UP/DOWN R3 R2 R1 R0 C2 C1 C0 R R R R R R R R 1 1 1 1 1 0 0 0 Address: 0x6A Type: R Buffer: Reset: 0xF8 Description: Keypad data register. [7] UP/DOWN: 0: key-down 1: key-up [6:3] R[3:0] Row number of key 3 (valid range: 0 - 7) 0x1111: No key [2:0] C[2:0}: column number of key 3 (valid range: 0 -7) 49/58 Data registers STMPE1601 KPC_DATA_BYTE3 Keypad data byte 3 7 6 5 4 3 2 1 0 SF7 SF6 SF5 SF4 SF3 SF2 SF1 SF0 R R R R R R R R 1 1 1 1 1 1 1 1 2 1 0 Address: 0x6B Type: R Buffer: Reset: 0xFF Description: Keypad data register. [7:0] SF[7:0]: 0: key-down 1: key-up KPC_DATA_BYTE4 7 6 Keypad data byte 4 5 4 3 RESERVED Dedicated Key 0 ~ 3 R R R R R R R R 0 0 0 0 1 1 1 1 Address: 0x6C Type: R Buffer: Reset: Description: Keypad data register. [7:4] RESERVED: [3:0] Dedicated key [3:0]: 0: key-down 1 key-up 50/58 STMPE1601 14 Keypad combination key registers Keypad combination key registers The 3 KPC mask registers contains the key combination to be used to wake up the KPC and send an interrupt to the host system. KPC_COMB_KEY_0-2 Keypad combination 0-2 7 6 5 4 3 2 1 0 ACTIVE ACTIVE R2 R1 R0 C2 C1 C0 R/W R/W R/W R/W R/W R/W R/W R/W 1 1 1 1 1 0 0 0 Address: 0x65, 0x66, 0x67 Type: R/W Buffer: Reset: 0xF8 Description: Keypad combination key mask registers. [7:6] ACTIVE: 00: key defined by bits 5:0 to be used for combination key wakeup But [7:0] must be “F8” for No key from this register to be used for combination key wakeup [5:3] R[2:0]: Row number of key 1 (valid range: 0 -7) [2:0] C[2:0]: Column number of key 1 (valid range : 0-7) 51/58 Keypad combination key registers STMPE1601 Resistance The maximum resistance between keypad outputs and inputs, inclusive of switch resistance, protection circuit resistance and connection, must be less than 3.2 KΩ Using the keypad controller It is not necessary to explicitly enable the internal pull-up and direction by configuring the GPIO control registers. Once a GPIO is enabled for the keypad function, its internal pull-up and direction is controlled automatically. The scanning of column inputs should then be enabled for those GPIO ports that are configured as keypad inputs by writing '1's to the corresponding bits in the KPC_COL register. If any of the first three column inputs is to be used as dedicated key input, the corresponding bits in the KPC_CTRL_MSB register should be set to '1'. The bits in the KPC_ROW_MSB and KPC_ROW_LSB registers should also be set correctly to enable the row output scanning for the corresponding GPIO ports programmed as keypad outputs. The scan count and de-bounce count should also be programmed into the keypad control registers before enabling the keypad controller operation. To enable the keypad controller operation, the EN_KPC bit in the system control register must be set to '1' to provide the required clock signals. The keypad controller will then start its operation by setting the SCAN bit in the KPC_CTRL_LSB register to '1'. The keypad controller operation can be disabled by setting the SCAN bit back to '0'. To further reduce the power consumption, the clock signals can be cut off from the keypad controller by setting the EN_KPC bit to '0'. As long as there is any un-read key-press in the keypad controller buffer, the KPC interrupt will always be asserted. Ghost key handling The ghost key is an inherent in keypad matrix that is not equipped with a diode at each of the keys. While it is not possible to avoid ghost key occurrence, the STMPE1601 allows the detection of possible ghost keys by the capability of detecting 3 simultaneous key-presses in the key matrix. The ghost key is only possible if 3 keys are pressed and held down together in a keypad matrix. If 3 keys are reported by the STMPE1601 keypad controller, it indicates a potential ghost key situation. The system may check for the possibility of a ghost key by analyzing the coordinates of the 3 keys. If the 3 keys form 3 corners of a rectangle, it could be a ghost key situation. A ghost key may also occur in the “special function keys”. The keypad controller does not attempt to avoid the occurrence of ghost keys. However, the system should be aware that if more than one special function key is reported, then there is a possibility of ghost keys. Key detection priority A dedicated key is always detected, if this is enabled. When a special function key is detected, the matrix key scanning on the same input line is disabled. Up to 3 matrix keys can be detected. Matrix keys that fall on activated special function keys will not be counted. As a result of these priority rules, a matrix key is ignored by the keypad controller when the special function key on the same input line is detected, even if the matrix key is being 52/58 STMPE1601 Keypad combination key registers pressed down before the special function key. Hence, when a matrix is reported "key-down" and it is being held down while the corresponding special function is being pressed, a "nokey" status will be reported for the matrix key when the special function key is reported "keydown". If the matrix key is released while the special function key is still being held down, no "key-up" will be reported for the matrix key. On the other hand, if the matrix key is released after the special function key is reported "key-up", then a new "key-down" will be reported for the matrix key, followed by "key-up". Keypad wakeup from sleep and hibernate modes The keypad controller is functional in sleep mode as long as it is enabled before entering the sleep mode. It will then wake the system up into operational mode if a valid key press is detected. In the case of hibernate mode, the 'HIB_WK' bit in 'KPC_ROW_msb' register must be set to '1' in order to enable the system wakeup by means of a valid key press. When this is enabled, an asynchronous detection of the keypad column input activity is turned on during the hibernate mode. If any key activity is detected, the system is expected to enter the sleep mode temporarily to allow a debouncing of key press to take place. If a valid key is detected, the system will then wake up into operational mode; otherwise, the device will go back into hibernate mode. Keypad controller combination-Key interrupt The keypad controller (KPC) can be programmed to wake up from sleep mode if a unique combination keys is detected. This combination keys of up to 3 keys is specified in the KPC combination set 0-2 registers. Note that the sequence of the key press is not relevant, as long as the 1-3 keys specified in the KPC_CombiKey are detected, the KPC will wake up and interrupt the host. If any other keys (beside those specified in the KPC_CombiKey registers) are pressed, it would be considered invalid combination and interrupt will NOT be generated. All the "active" keys must be pressed and held together, for the combi-key interrupt to be generated. 53/58 Miscellaneous features 15 Miscellaneous features 15.1 Reset STMPE1601 The STMPE1601 is equipped with an internal POR circuit that holds the device in reset state, until the clock is steady and VCC input is valid. The host system may choose to reset the STMPE1601 by asserting the RESET_N pin. 15.2 Under voltage lockout The STMPE1601 is equipped with an internal UVLO (under voltage lockout) circuit that generates a RESET signal, when the main supply voltage falls below the allowed threshold. 54/58 STMPE1601 16 Package mechanical data Package mechanical data In order to meet environmental requirements, ST offers these devices in ECOPACK® packages. These packages have a Lead-free second level interconnect . The category of second level interconnect is marked on the package and on the inner box label, in compliance with JEDEC Standard JESD97. The maximum ratings related to soldering conditions are also marked on the inner box label. ECOPACK is an ST trademark. ECOPACK specifications are available at: www.st.com Figure 11. TFBGA25 package outline Table 23. TFBGA25 mechanical data mm. inch Dim. A Min Typ Max Min Typ Max 1.0 1.1 1.16 39.4 43.3 45.7 A1 0.25 A2 0.78 b 0.25 D 2.9 D1 E E1 9.8 0.86 30.7 0.30 0.35 9.8 11.8 13.8 3.0 3.1 114.2 118.1 122.0 2 2.9 3.0 33.9 78.8 3.1 114.2 118.1 2 78.8 e 0.5 19.7 SE 0.25 9.8 122.0 55/58 Package mechanical data STMPE1601 Figure 12. Tape and reel dimension Table 24. TFBGA25 tape and reel mechanical data millimeters inches Symbol Min Typ A Min Typ 330 13.2 Max 12.992 C 12.8 D 20.2 0.795 N 60 2.362 T 56/58 Max 0.504 0.519 14.4 0.567 Ao 3.3 0.130 Bo 3.3 0.130 Ko 1.60 0.063 Po 3.9 4.1 0.153 0.161 P 7.9 8.1 0.311 0.319 STMPE1601 17 Revision history Revision history Table 25. Document revision history Date Revision 10-Jan-2008 1 Changes Initial release. 57/58 STMPE1601 Please Read Carefully: Information in this document is provided solely in connection with ST products. STMicroelectronics NV and its subsidiaries (“ST”) reserve the right to make changes, corrections, modifications or improvements, to this document, and the products and services described herein at any time, without notice. All ST products are sold pursuant to ST’s terms and conditions of sale. Purchasers are solely responsible for the choice, selection and use of the ST products and services described herein, and ST assumes no liability whatsoever relating to the choice, selection or use of the ST products and services described herein. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted under this document. If any part of this document refers to any third party products or services it shall not be deemed a license grant by ST for the use of such third party products or services, or any intellectual property contained therein or considered as a warranty covering the use in any manner whatsoever of such third party products or services or any intellectual property contained therein. UNLESS OTHERWISE SET FORTH IN ST’S TERMS AND CONDITIONS OF SALE ST DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY WITH RESPECT TO THE USE AND/OR SALE OF ST PRODUCTS INCLUDING WITHOUT LIMITATION IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE (AND THEIR EQUIVALENTS UNDER THE LAWS OF ANY JURISDICTION), OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. UNLESS EXPRESSLY APPROVED IN WRITING BY AN AUTHORIZED ST REPRESENTATIVE, ST PRODUCTS ARE NOT RECOMMENDED, AUTHORIZED OR WARRANTED FOR USE IN MILITARY, AIR CRAFT, SPACE, LIFE SAVING, OR LIFE SUSTAINING APPLICATIONS, NOR IN PRODUCTS OR SYSTEMS WHERE FAILURE OR MALFUNCTION MAY RESULT IN PERSONAL INJURY, DEATH, OR SEVERE PROPERTY OR ENVIRONMENTAL DAMAGE. ST PRODUCTS WHICH ARE NOT SPECIFIED AS "AUTOMOTIVE GRADE" MAY ONLY BE USED IN AUTOMOTIVE APPLICATIONS AT USER’S OWN RISK. Resale of ST products with provisions different from the statements and/or technical features set forth in this document shall immediately void any warranty granted by ST for the ST product or service described herein and shall not create or extend in any manner whatsoever, any liability of ST. ST and the ST logo are trademarks or registered trademarks of ST in various countries. Information in this document supersedes and replaces all information previously supplied. The ST logo is a registered trademark of STMicroelectronics. All other names are the property of their respective owners. © 2008 STMicroelectronics - All rights reserved STMicroelectronics group of companies Australia - Belgium - Brazil - Canada - China - Czech Republic - Finland - France - Germany - Hong Kong - India - Israel - Italy - Japan Malaysia - Malta - Morocco - Singapore - Spain - Sweden - Switzerland - United Kingdom - United States of America www.st.com 58/58