LM8323 LM8323 Mobile I/O Companion Supporting Keyscan, I/O Expansion, PWM, and ACCESS.bus Host Interface Literature Number: SNLS273 LM8323 Mobile I/O Companion Supporting Keyscan, I/O Expansion, PWM, and ACCESS.bus Host Interface Key events, errors, and dedicated hardware interrupts 1.0 General Description The LM8323 key-scan controller is a dedicated device to unburden a host from scanning a matrix-addressed keypad. In addition, the LM8323 provides general-purpose I/O expansion, a rotary encoder interface and PWM outputs useful for dynamic LED brightness modulation. It communicates with the host through an I2C-compatible ACCESS.bus interface. An interrupt output is available for signaling key-press and key-release events. Communication frequencies up to 400 kHz (Fast-mode) bus speed are supported. The LM8323 supports a predefined set of commands. These commands enable a host device to keep control over all functions. 2.0 Features Key Features Supports keypad matrices of up to 8 x 12 keys plus 8 special-function (SF) keys for a total of 104 keys. SF keys pull keypad scan inputs directly to ground, rather than connecting to a keypad scan output. Supports I2C-compatible ACCESS.bus interface in slave mode up to 400 kHz (Fast-mode). Three host-programmable PWM outputs useful for smooth LED brightness modulation. Supports general-purpose I/O expansion on pins not otherwise used for keypad or rotary encoder interface. Key-scan event storage in a FIFO buffer for up to 15 events. (c) 2010 National Semiconductor Corporation 300211 request host service by asserting the IRQ output. The correct reception of a command may be assumed, if no error is reported from the LM8323 after receiving it. Wake-up from Halt mode on any matrix key-scan event, any use of the SF keys, or any activity on the ACCESS.bus interface, or any change in the rotary encoder counter value (if enabled). Host-Controlled Functions Three PWM outputs Period of inactivity that triggers entry into Halt mode Debounce time for reliable key event polling Configuration of general-purpose I/O ports Various initialization options (keypad size, etc.) Key Device Characteristics 01.8V 180 mV single-supply operation On-chip power-on reset (POR) Watchdog timer Dedicated slow clock input for 32 kHz -40C to +85C industrial temperature range 36-pin MICRO-ARRAY package Applications Cordless phones Smart handheld devices www.national.com LM8323 Mobile I/O Companion supporting Keyscan, I/O Expansion, PWM, and ACCESS.bus Host Interface July 19, 2010 LM8323 3.0 Block Diagram 30021120 4.0 Ordering Information NSID Spec.* Firmware* No. of Pins Package Type Temperature Package Method LM8323JGR8 NOPB FW4 36 Micro-Array -40C +85C 1000 pcs Tape & Reel LM8323JGR8X NOPB FW4 36 Micro-Array -40C +85C 3500 pcs Tape & Reel LM8323JGR8AXM NOPB FW6 36 Micro-Array -40C +85C 1000 pcs Tape & Reel LM8323JGR8AXMX NOPB FW6 36 Micro-Array -40C +85C 3500 pcs Tape & Reel *Note: NOPB = No PB (No Lead) Firmware version FW6 will replace FW4. Firmware version FW4 is not recommended for new designs. www.national.com 2 LM8323 5.0 Pin Assignments 30021121 Top View 36-Pin MICRO-ARRAY Package See NS Package Number GRA36A 3 www.national.com LM8323 Table of Contents 1.0 General Description ......................................................................................................................... 1 2.0 Features ........................................................................................................................................ 1 3.0 Block Diagram ................................................................................................................................ 2 4.0 Ordering Information ........................................................................................................................ 2 5.0 Pin Assignments ............................................................................................................................. 3 6.0 Signal Descriptions .......................................................................................................................... 6 6.1 TERMINATION OF UNUSED SIGNALS ...................................................................................... 7 7.0 Application Example ........................................................................................................................ 8 7.1 FEATURES ............................................................................................................................. 8 8.0 Clocks ........................................................................................................................................... 9 8.1 INTERNAL EXECUTION CYCLE ............................................................................................... 9 8.2 BUFFERED CLOCK ................................................................................................................. 9 8.3 CLOCK CONFIGURATION ..................................................................................................... 10 9.0 Reset ........................................................................................................................................... 11 9.1 EXTERNAL RESET ................................................................................................................ 11 9.2 POWER-ON RESET (POR) ..................................................................................................... 11 9.3 PIN CONFIGURATION AFTER RESET .................................................................................... 11 9.4 DEVICE CONFIGURATION AFTER RESET .............................................................................. 12 9.5 CONFIGURATION INPUTS ..................................................................................................... 12 9.6 INITIALIZATION ..................................................................................................................... 12 9.7 INITIALIZATION EXAMPLE ..................................................................................................... 14 10.0 Halt Mode ................................................................................................................................... 15 10.1 ACCESS.bus ACTIVITY ........................................................................................................ 15 11.0 Keypad Interface ......................................................................................................................... 16 11.1 EVENT CODE ASSIGNMENT ................................................................................................ 16 11.2 KEYPAD SCAN CYCLES ...................................................................................................... 16 11.2.1 Timing Parameters ..................................................................................................... 17 11.2.2 Multiple Key Pressings ................................................................................................ 17 11.3 EXAMPLE KEYPAD CONFIGURATION .................................................................................. 18 12.0 General-Purpose I/O Ports ............................................................................................................ 19 12.1 USING THE CONFIG_X PINS FOR GPIO ............................................................................... 19 12.2 USING THE ROT_IN_X PINS FOR GPIO ................................................................................ 19 12.3 GPIO TIMING ...................................................................................................................... 19 13.0 Rotary Encoder Interface .............................................................................................................. 21 14.0 PWM Output Generation ............................................................................................................... 23 14.1 COMMAND QUEUE ............................................................................................................. 23 14.2 PWM TIMER OPERATION .................................................................................................... 23 14.3 PWM SCRIPT COMMANDS .................................................................................................. 24 14.4 RAMP COMMAND ............................................................................................................... 25 14.5 SET_PWM COMMAND ......................................................................................................... 25 14.6 GO_TO_START COMMAND ................................................................................................. 25 14.7 BRANCH COMMAND ........................................................................................................... 25 14.8 END COMMAND .................................................................................................................. 26 14.9 TRIGGER COMMAND .......................................................................................................... 26 14.10 PWM SCRIPT EXAMPLE .................................................................................................... 26 14.10.1 PWM Channel 0 Script .............................................................................................. 27 14.10.2 PWM Channel 1 Script .............................................................................................. 27 14.10.3 PWM Channel 2 Script .............................................................................................. 27 14.11 SELECTABLE SCRIPT EXAMPLE ........................................................................................ 28 15.0 Digital Multiplexers ....................................................................................................................... 29 16.0 Host Interface ............................................................................................................................. 29 16.1 START AND STOP CONDITIONS .......................................................................................... 29 16.2 CONTINUOUS COMMAND STRINGS .................................................................................... 29 16.3 DEVICE ADDRESS .............................................................................................................. 30 16.4 HOST WRITE COMMANDS .................................................................................................. 30 16.5 HOST READ COMMANDS .................................................................................................... 30 16.6 INTERRUPTS ...................................................................................................................... 31 16.7 INTERRUPT CODE .............................................................................................................. 31 16.8 ERROR CODE ..................................................................................................................... 32 16.9 WAKE-UP FROM HALT MODE .............................................................................................. 32 17.0 Host Commands .......................................................................................................................... 33 17.1 READ_ID COMMAND ........................................................................................................... 34 17.2 WRITE_CFG COMMAND ...................................................................................................... 34 17.3 READ_INT COMMAND ......................................................................................................... 35 www.national.com 4 5 35 35 36 36 36 36 37 37 37 38 38 38 38 38 39 39 39 39 40 40 41 41 42 43 www.national.com LM8323 17.4 RESET COMMAND .............................................................................................................. 17.5 WRITE_PULL_DOWN COMMAND ......................................................................................... 17.6 WRITE_PORT_SEL COMMAND ............................................................................................ 17.7 WRITE_PORT_STATE COMMAND ........................................................................................ 17.8 READ_PORT_SEL COMMAND ............................................................................................. 17.9 READ_PORT_STATE COMMAND ......................................................................................... 17.10 READ_FIFO COMMAND ..................................................................................................... 17.11 RPT_READ_FIFO COMMAND ............................................................................................. 17.12 SET_ACTIVE COMMAND ................................................................................................... 17.13 READ_ERROR COMMAND ................................................................................................. 17.14 READ_ROTATOR COMMAND ............................................................................................. 17.15 SET_DEBOUNCE COMMAND ............................................................................................. 17.16 SET_KEY_SIZE COMMAND ................................................................................................ 17.17 READ_KEY_SIZE COMMAND ............................................................................................. 17.18 READ_CFG COMMAND ..................................................................................................... 17.19 WRITE_CLOCK COMMAND ................................................................................................ 17.20 READ_CLOCK COMMAND ................................................................................................. 17.21 PWM_WRITE COMMAND ................................................................................................... 17.22 PWM_START COMMAND ................................................................................................... 17.23 PWM_STOP COMMAND ..................................................................................................... 18.0 Absolute Maximum Ratings ........................................................................................................... 19.0 DC Electrical Characteristics ......................................................................................................... 20.0 AC Electrical Characteristics ......................................................................................................... 21.0 Physical Dimensions .................................................................................................................... LM8323 6.0 Signal Descriptions Pin Function I/O A6 KP-X0 Input Wake-up input/Keyboard scanning input 0 A5 KP-X1 Input Wake-up input/Keyboard scanning input 1 F1 KP-X2 Input Wake-up input/Keyboard scanning input 2 KP-X3 Input Wake-up input/Keyboard scanning input 3 F2 A2 B3 A3 GPIO_13 I/O KP-X4 Input GPIO_12 I/O KP-X5 Input GPIO_11 I/O KP-X6 Input GPIO_10 I/O Description General-purpose I/O port 13 Wake-up input/Keyboard scanning input 4 General-purpose I/O port 12 Wake-up input/Keyboard scanning input 5 General-purpose I/O port 11 Wake-up input/Keyboard scanning input 6 General-purpose I/O port 10 KP-X7 Input Wake-up input/Keyboard scanning input 7 GPIO_09 Input General-purpose I/O port 9 C6 KP_Y0 Output Keyboard scanning output 0 C5 KP-Y1 Output Keyboard scanning output 1 B6 KP-Y2 Output Keyboard scanning output 2 KP-Y3 Output Keyboard scanning output 3 GPIO_08 I/O General-purpose I/O port 8 KP-Y4 Output Keyboard scanning output 4 GPIO_07 I/O General-purpose I/O port 7 B4 B5 B2 A1 B1 KP-Y5 Output Keyboard scanning output 5 GPIO_06 I/O General-purpose I/O port 6 KP-Y6 Output Keyboard scanning output 6 GPIO_05 I/O General-purpose I/O port 5 KP-Y7 Output Keyboard scanning output 7 GPIO_04 I/O General-purpose I/O port 4 KP-Y8 Output Keyboard scanning output 8 SLOWCLKOUT Output 32.768 kHz clock output GPIO_03 I/O General-purpose I/O port 3 KP-Y9 Output Keyboard scanning output 9 MUX2_IN1 Input GPIO_02 I/O KP-Y10 Output MUX2_IN2 Input GPIO_01 I/O KP-Y11 Output Keyboard scanning output 11 F6 MUX2_OUT Output Multiplexer 2 output GPIO_00 I/O General-purpose I/O port 0 E2 ACB_SDA I/O ACCESS.bus data signal E1 ACB_SCL I/O ACCESS.bus clock signal C2 E3 D5 E6 E4 F5 E5 www.national.com PWM_0 Output MUX_IN1 Input PWM_1 Output Multiplexer 2 input 1 General-purpose I/O port 2 Keyboard scanning output 10 Multiplexer 2 input 2 General-purpose I/O port 1 Pulse-width modulated output 0 Multiplexer 1 input 1 Pulse-width modulated output 1 MUX_IN2 Input PWM_2 Output Multiplexer 1 input 2 Pulse-width modulated output 2 MUX1_OUT Output Multiplexer 1 output CONFIG_2 Input Slave address select input 2 GPIO_15 I/O General-purpose I/O port 15 6 Function I/O CONFIG_1 Input Slave address select input 1 GPIO_14 I/O General-purpose I/O port 14 XTAL_OUT Output SLOWCLK Input 32.768 kHz clock XTAL_IN Input 32.768 kHz crystal input F3 IRQ Output Interrupt request output D6 D1 D2 LM8323 Pin Description 32.768 kHz crystal output C1 RESET Input Reset Input A4, F4 VCC N/A VCC C3, C4, D3, D4 GND N/A Ground 6.1 TERMINATION OF UNUSED SIGNALS TABLE 1. Termination of Unused Signals Signal RESET CONFIG_1 XTAL_IN XTAL_OUT Termination Connect to VCC if not driven from an external Supervisory circuit. Connect to VCC or GND through a pullup or pulldown resistor because the slave address is selected by the level on this pin. This pin cannot be left unconnected. This pin is a high-impedance input and must be connected to VCC or GND if it is unused. This pin has a weak pullup and can be left open-circuit if it is unused. KP-X[2:0] These pins are dedicated keypad pins. In the minimum configuration, these pins are keypad inputs with weak pullups. KP-X[7:3] These pins are in high-impedance mode after power-on initialization. There are two ways to handle these pins if unused: * Connect to VCC or GND. * Program as inputs with weak pullups or outputs. Care must be taken when connecting to VCC or GND. Erroneous parameters sent with the WRITE_PORT_SEL or WRITE_PORT_STATE commands could cause excessive current consumption. A better approach is to leave unused keyboard inputs open-circuit and use the WRITE_PORT_SEL and WRITE_PORT_STATE commands to configure the pins as inputs with weak pullups or outputs. KP-X7 can only be an input. This pin should be programmed as an input with a weak pullup. KP-Y[2:0] These pins are dedicated keypad pins. In the minimum configuration, these pins are keypad outputs driven low. These pins are in high-impedance mode after power-on initialization. There are two ways to handle these pins if unused: * Connect to VCC or GND. KP-Y[11:3] * Program as inputs with weak pullups or outputs Care must be taken when connecting to VCC or GND. Erroneous parameters sent with the WRITE_PORT_SEL or WRITE_PORT_STATE commands could cause excessive current consumption. A better approach is to leave unused keyboard inputs open-circuit and use the WRITE_PORT_SEL and WRITE_PORT_STATE commands to configure the pins as inputs with weak pullups or outputs. PWM_0, PWM_1 These pins must be connected to VCC or GND if they are not used for any optional function described in the datasheet. PWM_2/ CONFIG_2 Connect to VCC or GND through a pullup or pulldown resistor because the slave address is selected by the level on this pin. This pin cannot be left unconnected. IRQ This pin must be connected. 7 www.national.com LM8323 7.0 Application Example 30021101 FIGURE 1. Typical Application 7.1 FEATURES The application example shown in Figure 1 supports the following features: * 8 x 9 standard keys. * 8 special function keys (SF keys) with wake-up capability by forcing a WAKE_INx pin to ground. Pressing a SF key overrides any other key in the same row. * ACCESS.bus (I2C-compatible) interface for communication with the host. * Hardware IRQ interrupt to host to signal keypad, rotary encoder, error, and status events. By default, this is an open-drain output, so an external pullup resistor may be required to avoid false assertion. The host can program this output for push-pull mode, in which case the pullup might not be required, if the host can ignore a false assertion before the LM8323 has been programmed. * Two LEDs driven by PWM outputs with programmable ramp-up and ramp-down. PWM_2 (shared with GPIO_15 www.national.com * * * 8 and CONFIG_2) could be used as an additional PWM driver port to control a third external LED. Rotary encoder interface shares pins with KP-Y9, KP-Y10, and KP-Y11. For larger keyboard configurations (such as QWERTY layouts), the rotary encoder interface is not available. ACCESS.bus address is selected by the CONFIG_1 and CONFIG_2 inputs. These pins may also be used as GPIO pins after reset initialization has occurred. If extra GPIO pins are not needed, CONFIG_1 and CONFIG_2 may be tied directly to VCC and GND. Crystal pins XTAL_IN and XTAL_OUT may be used to connect to an external 32.768 kHz crystal or receive an external 32.768 kHz clock input for running the PWM peripheral. By default, the PWM is clocked by an on-chip clock source. * * * System Clock (mclk) -- The system clock is in the range of about 21 MHz (7%) typical. This clock is used to drive the I2C-compatible serial ACCESS bus and is the input clock for other function blocks. Processing and Command Execution Clock (tC) -- The internal processing is based on a 2MHz clock. This clock is derived from the System Clock. Internal PWM Clock -- The internal PWM clock is a fixed scaled down clock (/ 64) of the Processing and Command * * Execution Clock. This clock is close to 32 kHz which is in a good range to source the PWM function block as an alternative to an external clock source. External 32.768 kHz Clock -- driven into the SLOWCLK input. May be used internally as the timebase for the PWM and driven on the SLOWCLKOUT output. External 32.768 kHz Crystal -- connected across the XTAL_IN and XTAL_OUT pins (XTAL_IN is an alternate function of the SLOWCLK pin). May be used internally as the timebase for the PWM and driven on the SLOWCLKOUT output. 30021102 FIGURE 2. Clock Architecture 8.1 INTERNAL EXECUTION CYCLE The Processing - and Command - execution clock is about 2MHz. This clock is stopped in Halt mode, which only occurs under control of the LM8323. However, the host can set the period of inactivity which causes the device to enter Halt mode. Exit from Halt mode can be triggered by any of these events: * Occurrence of a key-press or key-release event. * A Start condition driven by the host on the ACCESS.bus interface. * Any change to the rotary encoder counter value (if the interface is enabled). * Assertion of the RESET input. After reset, the default timebase for the PWM outputs is the internal execution clock divided by 64. 8.2 BUFFERED CLOCK The timebase for the PWM comes from any of three sources: * Prescaled internal Execution clock. * External 32.768 kHz clock received on the SLOWCLK input. * On-chip oscillator with an external crystal connected across XTAL_IN and XTAL_OUT. Any of these sources may be buffered and driven on the SLOWCLKOUT output. The clock buffer is enabled with the WRITE_CLOCK command. If XTAL_IN is not used it must be terminated to VCC or GND. 9 www.national.com LM8323 8.0 Clocks LM8323 mand. The WRITE_CLOCK command must be issued only once during system initialization. This command is used to override the default settings. 8.3 CLOCK CONFIGURATION Table 2 shows the clock configurations available by loading the clock configuration register with the WRITE_CLOCK com- TABLE 2. Clock Configuration Register 7 6 5 4 3 2 0 SLOWCLKOUT 0 0 SLOWCLKEN 0 Bit SLOWCLKOUT SLOWCLKEN RCPWM Value 0 RCPWM Description 0 Disable SLOWCLKOUT buffer. 1 Enable SLOWCLKOUT buffer. 0 External 32.768 kHz crystal is installed between the XTAL_IN and XTAL_OUT pins. 1 External 32.768 kHz clock is received on the SLOWCLK pin, or no 32.768 kHz clock is required. 00 On-chip RC clock divided by 64 drives the PWM and clock buffer. 01 Reserved 10 Reserved 11 External 32.768 kHz clock or crystal drives the PWM and clock buffer. The SLOWCLKOUT signal is an alternate function of the pin used for the KP-Y8 scanning output and the GPIO_03 port. If www.national.com 1 the SLOWCLKOUT function is enabled, these other functions of the pin are unavailable. 10 The LM8323 may be reset by either an external reset, RESET command, or an internally generated power-on reset (POR) signal. The RESET input must not be allowed to float. If the external RESET input is not used, it must be connected to VCC, either directly or through a pull-up resistor. 9.2 POWER-ON RESET (POR) The POR circuit is always enabled. When VCC rises above the POR threshold voltage VPOR (about 1.2-1.5V), an on-chip reset signal is asserted. The VCC rise time must be greater than 20 s and less than 10 ms, otherwise the on-chip reset signal may deassert before VCC reaches the minimum operating voltage. While VCC is below VPOR, the LM8323 is held in reset and a timer clocked by the on-chip RC clock is preset with 0xFF (256 clock cycles). When VCC reaches a value greater than VPOR, the timer starts counting down. When it underflows, the on-chip reset signal is deasserted and the LM8323 begins operation. 9.1 EXTERNAL RESET The device enters a reset state immediately when the RESET input is driven low. RESET must be held low for a minimum of 700 ns to guarantee a valid reset. If RESET is asserted at power-on, it must be held low until VCC rises above the minimum operating voltage (1.62V). If an RC circuit is used to drive RESET, it must have a time constant 5 times (5x) greater than the VCC rise time to this level. When RESET goes low, the I/O ports are initialized immediately, any observed delay being only propagation delay. 9.3 PIN CONFIGURATION AFTER RESET Table 3 shows the pin configuration after reset. TABLE 3. Pin Configuration After Reset Pins After Reset After LM8323 Initialization KP-X00 KP-X01 KP-X02 High-impedance mode. Input mode with an on-chip pullup enabled. KP-X03 KP-X04 KP-X05 KP-X06 KP-X07 High-impedance mode. High-impedance mode, until host configures them as keypad inputs or GPIO. KP-Y00 KP-Y01 KP-Y02 High-impedance mode. Active drive low. KP-Y03 KP-Y04 KP-Y05 KP-Y06 KP-Y07 KP-Y08 KP-Y09 KP-Y10 KP-Y11 High-impedance mode. High-impedance mode, until host configures them as keypad outputs or GPIO. CONFIG_1 CONFIG_2 High-impedance mode. The ACCESS.bus slave address must be selected with external pullup or pulldown resistors or direct connections to VCC or GND. IRQ High-impedance mode. Active drive low. PWM_0 PWM_1 PWM_2 High-impedance mode. High-impedance mode. Open-drain mode. Open-drain mode. High-impedance mode. High-impedance mode. Terminate to VCC or GND if not used. Weak pullup device. Weak pullup device. High-impedance mode. High-impedance mode. ACB_SDA ACB_SCL XTAL_IN XTAL_OUT RESET 11 www.national.com LM8323 When the RESET pin goes high, the LM8323 comes out of the reset state within about 1400 ns. 9.0 Reset LM8323 9.4 DEVICE CONFIGURATION AFTER RESET After the LM8323 has completed its reset initialization, it will have the following internal configuration: * PWM Clock: The PWM clock source is the on-chip clock divided by 64. This remains in effect until changed by a host command. * Keypad Size: 3 x 3. * Rotary Encoder Interface: disabled. * Digital Multiplexers: disabled. * IRQ: enabled, active low. * NOINIT Bit : set. * Debounce Time: 3 scan cycles (about 12 milliseconds). * Active Time: 500 milliseconds. Note: When FW6 version devices receive a RESET command the IRQ line is set high and held high for 60 ms and then pulled low to show the device was successfully reset and is ready to be used. 9.5 CONFIGURATION INPUTS The states sampled from the CONFIG_1 and CONFIG_2 inputs during reset select the ACCESS.bus address used by the LM8323, as shown in Table 4. The address occupies the high seven bits of the first byte of a bus transaction, with the LSB (shown as X below) indicating the direction of transfer. TABLE 4. Bus Address Selection CONFIG_1 CONFIG_2 Bus Address 0 0 1000 010X 0 1 1000 011X 1 0 1000 100X 1 1 1000 101X 30021103 FIGURE 3. LM8323 Initialization Behavior When these pins are used as GPIO ports, the design must ensure that they have the desired states during reset. For example, a 100-k resistor to ground can impose a logic 0 during reset without interfering with normal operation as a GPIO port. Figure 4 shows the timing of IRQ relative to a RESET or POR event and the WRITE_CFG command. 100 s after a RESET or POR event, IRQ is asserted and any READ_INT command will return an interrupt code with the NOINIT bit set. 90 s after a WRITE_CFG command is received, IRQ is deasserted. 9.6 INITIALIZATION The LM8323 waits for a WRITE_CFG command from the host. During this time, IRQ is asserted to request service from the host. Figure 3 describes the behavior of the LM8323 following reset. 30021104 FIGURE 4. IRQ Reset Timing www.national.com 12 quest received from the LM8323 during operation. Such requests will be made from the LM8323 as a result of key pressed events, the detection of an error, the termination of a PWM cycle and others. 30021105 FIGURE 5. Host-Side LM8323 Initialization 13 www.national.com LM8323 After sending the WRITE_CFG command, the host must send a series of commands to configure the LM8323, as shown in Figure 5. (See left hand side.) This Flow - diagram illustrates also the basic host communication steps which the host must execute upon an IRQ re- LM8323 Most of these settings can be verified by executing commands such as READ_CONF, READ_PORT_SEL, READ_CLOCK, etc. ALL GPIO pin states can be read using the READ_PORT_STATE command, without regard to whether the pin is an input or an output. An open-drain signal can be created by alternating between input mode and driving the output low. All GPIOs can sink and source 16 mA when configured as an output. 9.7 INITIALIZATION EXAMPLE In the following example, the LM8323 is configured as: * Keypad matrix configuration is 8 x 4. * Rotary encoder interface enabled. * GPIO_03 through GPIO_07 are available to use as GPIO pins. * GPIO_03 is an output driven low. * GPIO_4 and GPIO_5 are outputs driven high. * GPIO_06 and GPIO_07 are inputs with weak pulldowns. * GPIO_14 and GPIO_15 are inputs with weak pullups. * The PWM clock source is the internal execution clock divided by 64 (about 32 kHz). Command Encoding Parameter 1 Parameter 2 Description WRITE_CFG 0x81 0x40 Selects 36-pin package and disables the two digital multiplexers. WRITE_CLK 0x93 0x08 SLOWCLKOUT disabled, no external 32.768 kHz clock required, PWM clock source is internal. SET_KEY_SIZE 0x90 0x84 Selects a keypad matrix size of 8 x 4. SET_ACTIVE 0x8B 0x4B Sets the active time to about 300 milliseconds (75 x 4 milliseconds). SET_DEBOUNCE 0x8F 0x03 Sets the key debouncing time to about 12 milliseconds (3 x 4 ms). This is actually the default and would not have to be performed. WRITE_PORT_SEL 0x85 0x00 0x38 Configure GPIO_03, GPIO_04, and GPIO_05 as outputs. Configure GPIO_06, GPIO_07, GPIO_14, and GPIO_15 as inputs. WRITE_PULL_DOWN 0x84 0x00 0x3F Set the direction for the pullup/pulldown devices on GPIO_06 and GPIO_07 to pulldown. Set the direction for the pullup/pulldown devices on GPIO_14 and GPIO_15 to pullup. WRITE_PORT_STATE 0x86 0xC0 0xF0 Set GPIO_04 and GPIO_05 to drive high. Enable the pullups on GPIO_06, GPIO_07, GPIO_14, and GPIO_15. www.national.com 14 The fully static architecture of the LM8323 allows stopping the internal RC clock in Halt mode, which reduces power consumption to the minimum level. Figure 6 shows the current in Halt mode at the maximum VCC (1.98V) from 25C to +85C. 10.1 ACCESS.bus ACTIVITY When the LM8323 is in Halt mode, any activity on the ACCESS.bus interface will cause the LM8323 to exit from Halt mode. However, the LM8323 will not be able to acknowledge the first bus cycle immediately following wake-up from Halt mode. It will respond with a negative acknowledgement, and the host should then repeat the cycle. The LM8323 will be prevented from entering Halt mode if it shares the bus with peripherals that are continuously active. For lowest power consumption, the LM8323 should only share the bus with peripherals that require little or no bus activity after system initialization. 30021106 FIGURE 6. Halt Current vs. Temperature at 1.98V 15 www.national.com LM8323 Halt mode is entered when no key-press event, key-release event, change in the rotary encoder counter value or ACCESS.bus activity is detected for a certain period of time (by default, 500 ms). The mechanism for entering Halt mode is always enabled in hardware, but the host can program the period of inactivity which triggers entry into Halt mode. Note: When FW4 version devices enter the Halt mode there is approximately a 33% chance the device may miss key events during the period of 3ms before entering Halt mode until 3ms after entering Halt mode resulting in lost key events. This was corrected in FW6 devices so that 100% of all key events are captured, even as the device is entering Halt mode. 10.0 Halt Mode LM8323 mode to minimize power consumption (typically <9 A standby current). Table 5 lists the codes assigned to the matrix positions encoded by the hardware. Key-press events are assigned the codes listed in Table 5, but with the MSB set. When a key is released, the MSB of the code is clear. 11.0 Keypad Interface 11.1 EVENT CODE ASSIGNMENT After power-on reset and host initialization, the LM8323 starts scanning the keypad. It stays active for a default time of about 500 ms after the last key is released, after which it enters Halt TABLE 5. Keypad Matrix Code Assignments KP-Y0 KP-Y1 KP-Y2 KP-Y3 KP-Y4 KP-Y5 KP-Y6 KP-Y7 KP-Y8 KP-Y9 KP-Y10 KP-Y11 SF Keys KP-X0 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08 0x09 0x0A 0x0B 0x0C 0x0F KP-X1 0x11 0x12 0x13 0x14 0x15 0x16 0x17 0x18 0x19 0x1A 0x1B 0x1C 0x1F KP-X2 0x21 0x22 0x23 0x24 0x25 0x26 0x27 0x28 0x29 0x2A 0x2B 0x2C 0x2F KP-X3 0x31 0x32 0x33 0x34 0x35 0x36 0x37 0x38 0x39 0x3A 0x3B 0x3C 0x3F KP-X4 0x41 0x42 0x43 0x44 0x45 0x46 0x47 0x48 0x49 0x4A 0x4B 0x4C 0x4F KP-X5 0x51 0x52 0x53 0x54 0x55 0x56 0x57 0x58 0x59 0x5A 0x5B 0x5C 0x5F KP-X6 0x61 0x62 0x63 0x64 0x65 0x66 0x67 0x68 0x69 0x6A 0x6B 0x6C 0x6F KP-X7 0x71 0x72 0x73 0x74 0x75 0x76 0x77 0x78 0x79 0x7A 0x7B 0x7C 0x7F When the rotary encoder interface is enabled, KP-Y9, KPY10, and KP-Y11 (bolded in Keypad Matrix Code Assignments) become unavailable for keypad scanning, which limits the keypad to a maximum size of 8 x 9 + 8 SF keys. The codes are loaded into the FIFO buffer in the order in which they occurred. Table 6 shows an example sequence of events, and Figure 7 shows the resulting sequence of event codes loaded into the FIFO buffer. TABLE 6. Example Sequence of Events Event Number Event Code Event on Input Driven Output 1 0xC5 KP-X4 KP-Y4 Key is pressed Description 2 0xB2 KP-X3 KP-Y1 Key is pressed 3 0x45 KP-X4 KP-Y4 Key is released 4 0x32 KP-X3 KP-Y1 Key is released 5 0x81 KP-X0 KP-Y0 Key is pressed 6 0x5F KP-X5 N/A 7 0x01 KP-X0 KP-Y0 8 0x00 N/A N/A SF Key is released Key is released Indicates end of stored events 30021107 FIGURE 7. Example Event Codes Loaded in FIFO Buffer 11.2 KEYPAD SCAN CYCLES The LM8323 starts new scan cycles at fixed time intervals of about 4 milliseconds. If a change in the state of the keypad is detected, the keypad is rescanned after a debounce delay. When the state change has been reliably captured, it is encoded and written to the FIFO buffer. Figure 8 shows the relationship between a KP-Yx output and a KP-Xx input over multiple scan cycles during a key press event. Between scan cycles, the KP-Yx outputs that are specified by the SET_KEY_SIZE command (0x90) for keypad scanning are driven low. www.national.com 16 11.2.1 Timing Parameters Two timing parameters affect scanning of the keypad: * Debounce Time -- minimum delay between detecting a keypad event and confirming the event before asserting IRQ. The default debounce time is 3 scan cycles (about 12 milliseconds), but the host can set values in the range 1-255 cycles (4-1020 milliseconds). * Active Time -- period without detecting a state change in the keypad or rotary encoder that triggers entry into Halt mode, during which keypad scanning is suspended. The default active time is 500 milliseconds, but the host can set it values in the range 4-1020 milliseconds. The active time must be greater than the debounce time. 30021108 FIGURE 8. Keypad Scan Cycles 11.2.2 Multiple Key Pressings If more than two keys are pressed at the same time, the LM8323 stores all key pressed and released events in the FIFO buffer in the sequence in which they were decoded. For multiple key pressings the following circumstances have to be respected: * A multiple key-press event is given if two or more keypress events are reported but no corresponding keyrelease event. * With the activity time set between the minimum and maximum time (4 ms to 1 second) it is not safe to detect two simultaneous key pressings in one input row (see Figure 9 on the left hand side.) * If all key pressings (two or more) are located in different input rows (see Figure 9 on the right hand side) then the key pressed events will be correctly found in the FIFO buffer without any restriction. During a scan cycle, only one KP-Yx output pin will be driven low at any time, while the others are driven high or undriven. At the time scale used in Figure 8, the low phase of a KP-Yx output during a scan cycle is not visible. The KP-Xx input pins are pulled high by weak pullups. There are capacitive loads on the KP-Xx inputs and KP-Yx outputs due to protection circuits, wiring, etc. The LM8323 inserts delays to allow complete charging or discharging of these loads before sampling the input levels on the KP-Xx inputs. The maximum parasitic load capacitance on the KPXx inputs is 5nF. After detecting a key-press or key-release event, the debounce time specified by the SET_DEBOUNCE command (0x8F) sets the minimum time for confirming the event before the IRQ output is asserted. If more than two keys are pressed simultaneously, the pattern of key closures may be ambiguous, in which case the the interrupt code indicates an error and the IRQ output is asserted (if enabled). 30021109 FIGURE 9. Simultaneous Keys Pressed * In order to securely detect and store the key codes of simultaneous key pressings in the same input row the following precautions must be taken from the host side: As soon as the host device has detected a key pressed event the host must send the SET_ACTIVE Command with the parameter set to "00". This will prevent the LM8323 from entering HALT mode. If all keyboard events are resolved (no remaining key pressed status in the LM8323 anymore) then the host must send the SET_ACTIVE Command again with the parameter setting the desired duration for the active time. This will enable the LM8323 to enter low power HALT mode once the activity time has passed without detecting any events. * Once one or more key (pressed and/or released) events have been read from the host with the help of the READ 17 www.national.com LM8323 The SF keys connect KP-Xx inputs directly to ground. There can be up to eight SF keys. If any of these keys are pressed, other keys that use the same KP-Xx pin are ignored. LM8323 FIFO command there are two conditions cleaning the FIFO buffer contents: -- A second execution of the READ FIFO Command or, -- A new key event detected from the LM8323. scanning outputs (KP-Y0 through KP-Y3). The remaining scanning outputs KP-Y4 through KP-Y11 are available for use as GPIO pins. Enabling the rotary encoder interface reduces the number of available GPIO pins to KP-Y4 through KP-Y8. 11.3 EXAMPLE KEYPAD CONFIGURATION Figure 10 shows an 8 x 4 keypad matrix. This configuration occupies all scanning inputs (KP-X0 through KP-X7) and four 30021110 FIGURE 10. Keypad Interface Example In the example above, three keys (Up, Down, and Select) are connected as SF keys (connected directly to ground). Although they could have shared the KP-Xx inputs used with the scanned keys, the advantage of placing them on their own KP-Xx inputs is that it allows scanning the keypad while an SF key is pressed. If an SF key shares a KP-Xx input with any scanned keys, pressing the SF key prevents the LM8323 from reading the scanned keys. The SET_KEY_SIZE command includes a data byte that specifies the keypad size. The upper 4 bits of the data byte www.national.com specify the number of KP-Xx inputs, and the lower 4 bits specify the number of KP-Yx outputs. The minimum number of inputs and outputs is 3. Therefore, the minimum keypad configuration supports 3 x 3 + 3 SF keys (total of 12 keys). The maximum number of KP-Xx inputs is 8, and the maximum number of KP-Yx pins is 12. All KP-Xx and KP-Yx pins not used for the keyboard interface can be used for general-purpose I/O. For the example shown in Figure 10, the SET_KEY_SIZE command would specify 8 KP-Xx inputs and 4 KP-Yx outputs. 18 Any unused KP-Xx and KP-Yx pins may be used as generalpurpose I/O (GPIO) port pins. The WRITE_PORT_SEL (0x85) command selects the port direction, in which a clear bit in the parameter to the command selects the input direction and a set bit selects the output direction. The WRITE_PORT_STATE (0x86) command selects either the port level when configured as output (by the WRITE_PORT_SEL command) or when configured as an in- TABLE 7. GPIO Port Control Bits WRITE_PORT_SEL WRITE_PORT_STATE WRITE_PULL_DOWN 0 0 x High-Impedance Input 0 1 0 Input with Pullup Device 0 1 1 Input with Pulldown Device 1 0 x Output, Drive Low 1 1 x Output, Drive High Any pins used as GPIO ports must be configured after the peripheral configuration has been initialized with the WRITE_CFG command (0x81) and the keypad configuration has been initialized with the SET_KEY_SIZE command (0x90). The default keypad configuration after reset is a 3 x 3 keyboard matrix. The default GPIO configuration is an input with the pullup disabled. Description WRITE_CFG command (0x81), in which case it will not be available as a GPIO pin. It can also be configured as a PWM output, which also would override its use as a GPIO pin. 12.2 USING THE ROT_IN_X PINS FOR GPIO The rotary encoder interface uses alternate functions of KPY9, KP-Y10, and KP-Y11. The maximum keypad size is automatically reduced to a 8 x 9 matrix if the rotary encoder interface is enabled. 12.1 USING THE CONFIG_X PINS FOR GPIO The CONFIG_1 and CONFIG_2 pins are available for use as GPIO pins after power-on or reset. However, stable states must be provided on these pins during power-on or reset to select the I2C-compatible ACCESS.bus address. External pullup or pulldown resistors can be used to pull either CONFIG_x pin low, while retaining the ability to drive it to another state when used as a GPIO pin. CONFIG_2 has two alternate functions, in addition to GPIO. It can be configured as a multiplexer output using the 12.3 GPIO TIMING When a WRITE_PORT_STATE command (0x86) is received, the GPIO outputs do not change to their new states immediately or simultaneously. The first one changes 54 s after the command is acknowledged, and the others change at intervals of 7.3 s, as shown in Figure 11. 19 www.national.com LM8323 put selects between a high-impedance input or an input with a pullup or pulldown device. The selection between pullup or pulldown devices is controlled by the parameter bytes to the WRITE_PULL_DOWN (0x84) command. Clear bits in the parameter bytes select pullup devices, while set bits select pulldown devices. Table 7 shows the GPIO port configurations selected by the bits in the WRITE_PORT_SEL, WRITE_PORT_STATE, and WRITE_PULL_DOWN command parameters. 12.0 General-Purpose I/O Ports LM8323 30021111 FIGURE 11. GPIO Port State Change Timing www.national.com 20 A three-wire interface is provided for an external rotary encoder. Setting the ROTEN bit with the WRITE_CFG command enables the interface and the ROT_IN_x inputs, which 30021122 FIGURE 12. Rotary Encorder External Interface The ROT_IN_x inputs are alternate functions of KP-Y9, KPY10, and KP-Y11. When the rotary encoder interface is enabled, these keypad scanning outputs are not available for keypad interface. Steps which correspond to clockwise rotation increment a counter, while counterclockwise steps decrement the counter, as shown in the example sequence in Table 8. The READ_ROTATOR command returns a data byte which indicates the accumulated count since the counter was last read. 21 www.national.com LM8323 are alternate functions of certain keypad scanning pins. The ROT_IN_x inputs are bidirectional signals used to test the status of switches in an external rotary encoder, as shown in Figure 12. 13.0 Rotary Encoder Interface LM8323 TABLE 8. Rotary Encoder Example Sequence Switch 1-2 Switch 2-3 Switch 3-1 Action Counter Closed Closed Open Closed Open Increment 00000000 Open No Change Open 00000000 Closed Closed Increment 00000001 Open Open Closed No Change 00000001 Closed Open Closed Increment 00000010 Closed Open Open No Change 00000010 Closed Closed Open Increment 00000011 Open Closed Open No Change 00000011 Open Closed Closed Increment 00000100 Open Open Closed No Change 00000100 Open Closed Closed Decrement 00000011 Open Closed Open No Change 00000011 Closed Closed Open Decrement 00000010 Closed Open Open No Change 00000010 Closed Open Closed Decrement 00000001 Open Open Closed No Change 00000001 Open Closed Closed Decrement 00000000 Open Closed Open No Change 00000000 Closed Closed Open Decrement 11111111 Closed Open Open No Change 11111111 Closed Open Closed Decrement 11111110 Open Open Closed No Change 11111110 Open Closed Closed Decrement 11111101 The value of the data byte is in two's complement form, in which positive values indicate clockwise rotation and negative values indicate counterclockwise rotation. This is shown in the example when the counter decrements below zero. www.national.com A rotary encoder event will only wake up the LM8323 from Halt mode if it changes the counter value. 22 PWM_WRITE -- load one word into the script command file at a specified address. * PWM_START -- start execution of the script. * PWM_STOP -- stop execution of the script. Please note: The PWM_STOP command might not take immediate effect if the current command being executed is a command with long execution time. If a PWM_STOP command is sent when the PWM engine is running a long RAMP command, the PWM will only stop after the RAMP is completed. The script commands have their own fixed-length 16-bit format and encoding unrelated to the variable-length, bytebased format used for host commands. A script command is sent by the host to the LM8323 as a parameter to the PWM_WRITE command. Another parameter to the PWM_WRITE command specifies an address in the script command file for receiving the command. Three pulse-width modulated (PWM) outputs are provided with advanced capabilities for ramp-up and ramp-down of the PWM duty cycle and execution of simple to complex command sequences. These capabilities are supported by three independent script-execution engines capable of autonomous operation after setup and launch by the host. Figure 13 shows the architecture of a script-execution engine. 14.1 COMMAND QUEUE After the host issues a PWM_START command, script commands are read from the script command file into a command queue which consists of a command file output register, command buffer, and active command register. This allows one command to be active while another command is queued in the command buffer, which allows seamless back-to-back command execution. A command loaded into the command file output register is synchronized to the 32.768 kHz clock and stored in the command buffer. If no command is currently active, the command passes through to the active command register. In this case, another command can be read from the script command file, which is queued in the command buffer. On completion of the currently active command, the contents of the command buffer are transferred to the active command register, and the command buffer may then receive a new command. The host does not have direct access to any of the registers in the command queue. The operations which read script commands from the script command file occur automatically after the host issues the PWM_START command. Script execution stops when the host sends a PWM_STOP command or when the script engine executes an END command. Executing an END command asserts IRQ to the host. 30021112 14.2 PWM TIMER OPERATION The timers implement a fixed 256-cycle period with a programmable duty cycle and programmable ramp-up/rampdown of the duty cycle. Figure 14 shows the architecture of a PWM timer. FIGURE 13. PWM Script Execution Engine The host has three commands for interfacing to the script execution engine. The following commands are always associated with one particular PWM channel: 23 www.national.com LM8323 * 14.0 PWM Output Generation LM8323 30021113 FIGURE 14. PWM Timer The period counter is a free running 8-bit up-counter which starts counting when the script command file issues the first RAMP command. An END command stops the period counter. The duty cycle of the PWM output is controlled by the ramp counter. If the PWM period counter is active, the PWM output signal is asserted while the period counter has a value less than or equal to the value of the ramp counter. The ramp counter can increment or decrement at a rate controlled by the prescaler and step time counter. The prescaler selects a factor of 16 or 512 for dividing down the frequency of the 32.768 kHz clock. The ramp counter saturates at either 0x00 or 0xFF depending on the ramp direction. The number of increment or decrement steps is specified by the INCREMENT field of the RAMP command, which is loaded into the step counter. Even if the ramp counter hits its saturation value, the requested number of steps will be performed. An option enables assertion of the IRQ output to the host after the last step is performed. 14.3 PWM SCRIPT COMMANDS Table 9 summarizes the script commands. TABLE 9. PWM Script Commands Command 15 14 RAMP 0 PRES CALE 13 12 11 10 STEPTIME SET_PWM 0 1 0 9 6 5 4 3 2 1 0 INCREMENT PWMVALUE 0 1 0 1 END 1 1 0 TRIGGER 1 1 1 www.national.com 7 SIGN GO_TO_ START BRANCH 8 LOOPCOUNT 0 RES ET 0 ADDRESS 0 WAITTRIGGER 24 SENDTRIGGER 0 15 14 0 PRESCALE 13 12 11 10 9 8 7 STEPTIME Bit or Field 6 STEPTIME INCREMENT 0 Divide the 32.768 kHz clock by 16 1 Divide the 32.768 kHz clock by 512 Increment ramp counter 1 Decrement ramp counter 1 0 Number of steps executed by this instruction lished by initializing the duty cycle to either 100% or 0% followed by a RAMP command. 14.5 SET_PWM COMMAND The SET_PWM command loads the ramp counter from the 8-bit DUTYCYCLE field in the instruction. Please note: Only 0x00 and 0xFF are valid values for the duty cycle in SET_PWM command. Other values can be estab15 14 13 12 11 10 9 8 0 1 0 0 0 0 0 0 7 6 5 4 3 2 1 0 2 1 0 DUTYCYCLE Value Description 0 DUTYCYCLE 2 Number of prescaled clock cycles per step 0 1-126 Bit or Field 3 Description 1-63 SIGN 4 INCREMENT Value PRESCALE 5 SIGN Duty cycle is 0%. 255 Duty cycle is 100%. 14.6 GO_TO_START COMMAND The GO_TO_START command jumps to the first command in the script command file. 15 14 13 12 11 10 9 8 7 6 5 4 3 0 14.7 BRANCH COMMAND The BRANCH command jumps to the specified command in the script command file, with the option of looping for a specified number of repetitions. Nested loops are not allowed. 15 14 13 1 0 1 Field LOOPCOUNT ADDRESS 12 11 10 9 8 7 LOOPCOUNT 5 0 Value 0 6 4 3 2 1 0 ADDRESS Description Loop until a STOP PWM SCRIPT command is issued by the host. 1-63 Number of repetitions to perform, biased by -1. The range is 0-62 repetitions. 0-59 Branch destination address in the script command file. If this field is greater than 59, no looping will be performed. 25 www.national.com LM8323 which supports both very fast and very slow ramps. The INCREMENT field specifies the number of steps to be executed by the command. The maximum value is 126, which corresponds to half of full scale. There are two special cases in the instruction encoding. If all bits and fields are 0, it is interpreted as the GO TO START command. If the STEPTIME field is 0 but any other bit or field is non-zero, it is interpreted as the SET_PWM command. 14.4 RAMP COMMAND The RAMP command generates a duty-cycle ramp starting from the current value. At each step, the ramp counter is incremented or decremented by one, unless it has reached its its saturation value (0xFF for increment, or 0x00 for decrement). The time for one step is controlled by the PRESCALE bit and STEPTIME field. The minimum time for one step is 0.49 milliseconds. and the maximum time is about 1 second, LM8323 Please note: If a PWM channel is waiting for the trigger (last executed command was "TRIGGER") and the script execution is halted then the "END" command can't be executed because the previous command is still pending. This is an exception - in this case the IRQ signal will not be asserted. 14.8 END COMMAND The END command terminates script execution and asserts an interrupt to the host if the RESET bit is set to "1" or "0". If the END command is executed with the RESET bit set to "1" , the PWM output will be disabled. If the RESET bit is "0" when executing the END command, the PWM channel remains active with the fixed duty cycle it was last set to. 15 14 13 12 11 1 1 0 0 RESET Bit 10 9 8 7 14 13 1 1 1 Field WAITTRIGGER SENDTRIGGER 4 PWM_x output is active when script execution terminates. 1 PWM_x output is Tristate when script execution terminates. 12 3 2 1 Then, it will clear the trigger(s) and continue to the next command. When a trigger is sent, it is stored by the receiving channel and can only be cleared when the receiving channel executes a TRIGGER command that waits for the trigger. 11 10 9 8 7 6 5 WAITTRIGGER 4 3 2 1 SENDTRIGGER Value Description 000xx1 Wait for trigger from channel 0 000x1x Wait for trigger from channel 1 0001xx Wait for trigger from channel 2 000xx1 Send trigger to channel 0 000x1x Send trigger to channel 1 0001xx Send trigger to channel 2 30021114 FIGURE 15. PWM Outputs 26 0 0 14.10 PWM SCRIPT EXAMPLE This example shows a complex ramping sequence that uses triggers for synchronization. Three scripts implement the example. Figure 15 shows the PWM outputs for this example. www.national.com 0 Description 0 14.9 TRIGGER COMMAND Triggers are used to synchronize operations between PWM channels. A TRIGGER command that sends a trigger takes sixteen 32.768 kHz clock cycles, and a command that waits for a trigger takes at least sixteen 32.768 kHz clock cycles. A TRIGGER command that waits for a trigger (or triggers) will stall script execution until the trigger conditions are satisfied. 15 5 0 Value RESET 6 LM8323 14.10.1 PWM Channel 0 Script Script Command Address PWM_WRITE Parameter 1 PWM_WRITE Parameter 2 PWM_WRITE Parameter 3 Script Command 0x00 0x01 0x40 0x00 SET_PWM Initialize channel for 0% duty cycle 0x01 0x05 0xE2 0x00 TRIGGER Wait for trigger from channel 2 0x02 0x09 0x07 0x7E RAMP Ramp up by 126 steps 0x03 0x0D 0x07 0x7E RAMP Ramp up by 126 steps 0x04 0x11 0x07 0xFE RAMP Ramp down by 126 steps 0x05 0x15 0x07 0xFE RAMP Ramp down by 126 steps 0x06 0x19 0xA1 0x82 BRANCH 0x07 0x1D 0xC8 0x00 END Terminate script and assert IRQ to host Description Description Loop 2 times starting at address 0x02 14.10.2 PWM Channel 1 Script Script Command Address PWM_WRITE Parameter 1 PWM_WRITE Parameter 2 PWM_WRITE Parameter 3 Script Command 0x00 0x02 0x40 0xFF SET_PWM Initialize channel for 100% duty cycle 0x01 0x06 0xE2 0x00 TRIGGER Wait for trigger from channel 2 0x02 0x0A 0x0F 0xFE RAMP Ramp down by 126 steps 0x03 0x0E 0x0F 0xFE RAMP Ramp down by 126 steps 0x04 0x12 0x0F 0x7E RAMP Ramp up by 126 steps Ramp up by 126 steps 0x05 0x16 0x0F 0x7E RAMP 0x06 0x1A 0xA2 0x02 BRANCH Loop 3 times starting at address 0x02 0x07 0x1E 0xE0 0x08 TRIGGER Send trigger to channel 2 0x08 0x22 0xC8 0x00 END Terminate script and assert IRQ to host Description 14.10.3 PWM Channel 2 Script Script Command Address PWM_WRITE Parameter 1 PWM_WRITE Parameter 2 PWM_WRITE Parameter 3 Script Command 0x00 0x03 0x40 0x00 SET_PWM 0x01 0x07 0x03 0x7E RAMP Ramp up by 126 steps 0x02 0x0B 0x03 0x7E RAMP Ramp up by 126 steps 0x03 0x0F 0x03 0xFE RAMP Ramp down by 126 steps 0x04 0x13 0x03 0xFE RAMP Ramp down by 126 steps 0x05 0x17 0xE1 0x06 TRIGGER 0x06 0x1B 0x03 0x7E RAMP Ramp up by 126 steps 0x07 0x1F 0x03 0x7E RAMP Ramp up by 126 steps 0x08 0x23 0x03 0xFE RAMP Ramp down by 126 steps 0x09 0x27 0x03 0xFE RAMP Ramp down by 126 steps 0x0A 0x2B 0xC8 0x00 END 27 Initialize channel for 0% duty cycle Send triggers to channels 0 and 1, wait for trigger from channel 1 Terminate script and assert IRQ to host www.national.com LM8323 14.11 SELECTABLE SCRIPT EXAMPLE Multiple scripts can be placed in a single buffer. The script which is executed is selected by the address in the parameter to the PWM_START command (0x96). Script Command Address PWM_WRITE Parameter 1 0x00 0x01 PWM_WRITE Parameter 3 Script Command 0x01 0x40 0x00 Set PWM_0 to 0% duty cycle Description 0x05 0x0F 0x33 Ramp up 51 steps 0x02 0x09 0xC0 0x00 Keep channel at 20% duty cycle 0x03 0x0D 0x40 0xFF Set PWM_0 to 100% duty cycle 0x04 Script 1 PWM_WRITE Parameter 2 Script 2 0x11 0x0F 0xD5 Ramp down 85 steps 0x05 0x15 0xC0 0x00 Keep channel at 66.6% duty cycle 0x06 0x19 0x40 0x00 Set PWM_0 to 0% duty cycle 0x07 0x1D 0x07 0x7E Ramp up 126 steps 0x08 0x21 0x07 0x7E Ramp up 126 steps 0x25 0x07 0xFE Ramp down 126 steps 0x0A 0x29 0x07 0xFE Ramp down 126 steps 0x0B 0x2D 0xA5 0x07 Loop ten times to script address 0x07 0x31 0xC8 0x00 Switch PWM_0 off (script 3 automatically enters here) 0x35 0x40 0x00 Set PWM_0 to 0% duty cycle 0x09 0x0C Script 3 Script 4 0x0D 0x0E Script 5 0x39 0x07 0x25 Ramp up 37 steps 0x3D 0xC0 0x00 Keep channel at 14.5% duty cycle Script 6 0x41 0x40 0x00 Set PWM_0 to 0% duty cycle (Alternates between 25% and 75% duty cycle) 0x45 0x01 0x40 Ramp up 64 steps 0x0F 0x10 0x11 0x12 0x13 0x14 0x49 0x3F 0x7E Ramp up 126 steps 0x4D 0x3F 0xFE Ramp down 126 steps 0x51 0xA0 0x12 Always branch to script address 0x12 0x15 ..... Script 7 0x3B To set a fixed duty cycle on a PWM channel requires 3 steps (see script 1 for duty cycles from 0% to 49% and script 2 for duty cycles from 51% to 100%). To keep a PWM channel active providing a fixed duty cycle on its output, the script must terminate with the END command leaving the RESET bit clear. To switch this channel off, the host must send another PWM_START command (0x96 followed by the parameter bytes) triggering the single command described in script 4. This END command will set the RESET bit and the dedicated PWM output will be disabled. Script 3 will automatically enter into this command when the 10 loops of ramping up and down are executed. www.national.com Script 7 can be finished by two commands: * PWM_STOP command with parameter 0x01 * PWM_START command with parameter 0x31 (start PWM_0 from address 0x0C to run script 4) The script address is the physical address to be used from BRANCH instructions inside the script file buffer. The parameter 1 byte contains the same address with the 2 channel bits appended and will be associated with the PWM_START command. 28 Two 2:1 multiplexers are provided for host-controlled digital switching. Setting the MUX1EN or MUX2EN bits with the WRITE_CFG command enables the corresponding multiplexer and its input and output signals, which overrides any other functions which may use these pins. The MUX1 signals are alternate functions of the PWM_x outputs. The MUX2 signals are alternate functions of three KP-Yx pins shared with the rotary encoder interface, so MUX2 is unavailable when the interface is used. TABLE 10. Digital Multiplexer Function Table MUXxEN Bit MUXxSEL Bit MUXx_IN2 Pin MUXx_IN1 Pin MUXx_OUT Pin 1 0 X 0 0 1 0 X 1 1 1 1 0 X 0 1 1 1 X 1 X MUXx_OUT not enabled 0 X X TABLE 11. Minimal Command String 16.0 Host Interface Command The two-wire ACCESS.bus interface is used to communicate with a host. The ACCESS.bus interface is compatible with the I2C bus standard. The LM8323 operates as a bus slave at 400 kHz (Fast mode). All communication with the LM8323 over the ACCESS.bus interface is initiated by the host, usually in response to an interrupt request (IRQ low) asserted by the LM8323. The LM8323 may request service from the host by asserting the IRQ interrupt output. READ_ID READ_INT WRITE_CFG SET_KEY_SIZE 16.1 START AND STOP CONDITIONS Every transfer is preceded by a Start condition or a Repeated Start condition. The latter occurs when a command follows immediately upon another command without an intervening Stop condition. A Stop condition indicates the end of transmission. Every byte is acknowledged by the receiver. Description Read vendor ID and software version Check if NOINT bit is set in interrupt register Configure the LM8323 Set the size of the keypad WRITE_CLK Set the clock mode for the PWM unit WRITE_PORT_SEL Set port direction for GPIO pins WRITE_PORT_STATE Set port states of GPIO pins A more comprehensive command string may include the additional commands shown in Table 12. TABLE 12. Additional Commands Command SET_DEBOUNCE SET_ACTIVE Description Set debounce time Set active time READ_CLK Verify PWM clock settings READ_CFG Verify configuration setting Read all port states (physical levels READ_PORT_STATE on pins) 30021115 Note: Very long continuous command strings exceeding 30 milliseconds could overrun the ability of the LM8323 to process commands if the time from the last clock cycle of a command until the next Start condition or Repeated Start condition is always shorter than 60 s. A very long command chain could prevent the LM8323 from performing any watchdog service and consequently could trigger a physical RESET to the device. To avoid overrunning the LM8323, the host should provide a 1ms break between long (>30 ms) command sequences for SCL frequencies > 100 kHz. FIGURE 16. Start and Stop Conditions 16.2 CONTINUOUS COMMAND STRINGS A host device may send a continuous string of commands using the Repeated Start condition, which would block another ACCESS.bus device from gaining control of the bus. After Power-On the host device must send multiple commands to initialize the LM8323 device. A minimal command string will include the commands shown in Table 11. 29 www.national.com LM8323 The data select inputs for the multiplexers are controlled by the MUX1SEL and MUX2SEL bits, which are written by the WRITE_CFG command. If it is important to avoid momentarily passing an incorrect input to the output, the select bit must be loaded with a first WRITE_CFG command before sending a second WRITE_CFG command to set the enable bit. The truth table for the multiplexers is shown in Table 10. 15.0 Digital Multiplexers LM8323 16.3 DEVICE ADDRESS The device address is controlled by states sampled on the CONFIG_1 and CONFIG_2 pins, as shown in Table 13. In the first byte of a bus transaction, a 7-bit address plus a direction bit are broadcast by the bus master to all bus slaves. 16.4 HOST WRITE COMMANDS Some host commands include one or more data bytes written to the LM8323. Figure 17 shows a SET_KEY_SIZE command, which consists of an address byte, a command byte, and one data byte. The first byte is composed of a 7-bit slave address in bits 7:1 and a direction bit in bit 0. The state of the direction bit is 0 on writes from the host to the slave and 1 on reads from the slave to the host. The second byte sends the command. The SET_KEY_SIZE command is 0x90. The third byte sends the data, in this case specifying the number of rows and columns for the keypad. TABLE 13. Device Address Selection CONFIG_1 CONFIG_2 Device Address 0 0 1000 010X 0 1 1000 011X 1 0 1000 100X 1 1 1000 101X CONFIG_1 and CONFIG_2 pins should be connected to GND or VCC using pulldown or pullup resistors. The pins cannot be left unconnected. 30021116 FIGURE 17. Host Write Command The bus master can send any number of Repeated Start conditions without releasing control of the bus. This technique can be used to implement atomic transactions, in which the bus master sends a command and then reads a register without allowing any other device to get control of the bus between these events. The data is sent from the slave to the host in the fourth and fifth bytes. The fifth byte ends with a negative acknowledgement (NACK) to indicate the end of the data. 16.5 HOST READ COMMANDS Some host commands include one or more data bytes read from the LM8323. Figure 18 shows a READ_PORT_SEL command which consists of an address byte, a command byte, a second address byte, and two data bytes. The first address byte is sent with the direction bit driven low to indicate a write transaction of the command to the LM8323. The second address byte is sent with the direction bit undriven (pulled high) to indicate a read transaction of the data from the LM8323. The Repeated Start condition must be repeated whenever the slave address or the direction bit is changed. In this case, the direction bit is changed. www.national.com 30 LM8323 30021117 FIGURE 18. Host Read Command 16.6 INTERRUPTS The IRQ output may be asserted on these conditions: * Any new key-event after the last interrupt was asserted but not yet acknowledged by reading the interrupt code. * Any change in the state of the rotary encoder inputs. * Termination of a PWM script (END command). * Any error condition, which is indicated by the error code. 16.7 INTERRUPT CODE The interrupt code is read and acknowledged with the READ_INT command (0x82). This command clears the code and deasserts the IRQ output. Table 14 shows the format of the interrupt code. TABLE 14. Interrupt Code 7 6 5 4 3 2 1 0 PWM2END PWM1END PWM0END NOINIT ERROR 0 ROTATOR KEYPAD Bit Description PWM2END An END script command was executed by PWM channel 2. PWM1END An END script command was executed by PWM channel 1. PWM0END An END script command was executed by PWM channel 0. NOINIT The LM8323 is waiting for an initialization sequence. ERROR An error condition occurred. ROTATOR KEYPAD A state change was detected in the rotary encoder inputs. A key-press or key-release event occurred. 31 www.national.com LM8323 16.8 ERROR CODE If the LM8323 reports an error, the READ_ERROR command (0x8C) is used to read the error code. This command clears the error code. Table 15 shows the format of the error code. TABLE 15. Error Code 7 6 5 4 3 2 1 0 0 FIFOOVR 0 0 0 KEYOVR CMDUNK BADPAR Bit FIFOOVER Description Event occurred while the FIFO was full. KEYOVR More than two keys were pressed simultaneously. CMDUNK Not a valid command. BADPAR Bad command parameter. terminates without being acknowledged (shown as NACK in Figure 19). The host then aborts the transaction by sending a Stop condition. After aborting the bus cycle, the host may then retry the bus cycle. On the second attempt, the LM8323 will be able to acknowledge the slave address, because it will be in Active mode. Alternatively, the I2C specification allows sending a START byte (00000001), which will not be acknowledged by any device. This byte can be used to wake up the LM8323 from Halt mode. The LM8323 may also stall the bus transaction by pulling the SCL low, which is a valid behavior defined by the I2C specification. 16.9 WAKE-UP FROM HALT MODE Any bus transaction initiated by the host may encounter the LM8323 device in Halt mode or busy with processing data, such as controlling the FIFO buffer or executing interrupt service routines. LM8323 shows the case in which the host sends a command while the LM8323 is in Halt mode (Internal execution clock is stopped). Any activity on the ACCESS.bus wakes up the LM8323, but it cannot acknowledge the first bus cycle immediately after wake-up. The host drives a Start condition followed by seven address bits and a R/W bit. The host then releases SDA for one clock period, so that it can be driven by the LM8323. If the LM8323 does not drive SDA low during the high phase of the clock period immediately after the R/W bit, the bus cycle 30021118 FIGURE 19. LM8323 Responds with NACK, Host Retries Command www.national.com 32 LM8323 17.0 Host Commands Function Cmd Dir READ_ID 0x80 R WRITE_CFG 0x81 W Data Bytes Description nnnn nnnn pppp pppp Read the manufacturer code (nnnn nnnn) and the device revision number (pppp pppp). nnnn nnnn Write the hardware configuration register. READ_INT 0x82 R nnnn nnnn Read the interrupt code, deassert the IRQ output, and clear the code. (If the NOINIT bit is set, it remains set and IRQ remains asserted until a WRITE_CFG command is received.) RESET 0x83 W nnnn nnnn Reset the LM8323. Error if nnnn nnnn is not 0xAA. WRITE_PULL_DOWN 0x84 W nnnn nnnn Select pullup (0) or pulldown (1) direction for the corresponding general-purpose I/O (GPIO) port pins. WRITE_PORT_SEL 0x85 W WRITE_PORT_STATE 0x86 W READ_PORT_SEL 0x87 R READ_PORT_STATE 0x88 R READ_FIFO 0x89 R Up to 15 event codes Read an event from the FIFO. Maximum of 14 event codes stored in the FIFO. RPT_READ_FIFO 0x8A R Up to 15 event codes Repeats a FIFO read without advancing the FIFO pointer, for example to retry a read after an error. pppp pppp nnnn nnnn pppp pppp nnnn nnnn pppp pppp nnnn nnnn pppp pppp nnnn nnnn pppp pppp Select input (0) or output (1) for the corresponding generalpurpose I/O (GPIO) port pins. For pins configured as inputs, 0 selects high-impedance mode and 1 enables a weak pullup. For pins configured as outputs, each bit specifies the logic level driven on the pin. Read the direction of the corresponding GPIO port pins. Read the state on the corresponding GPIO port pins. SET_ACTIVE 0x8B W nnnn nnnn Set the time during which the LM8323 stays active before entering Halt mode. The active time must be greater than the debounce time. The default time is 500 milliseconds. The valid range is 1255. Active time = n x 4 milliseconds. READ_ERROR 0x8C R nnnn nnnn Read and clear the error code. READ_ROTATOR 0x8E R nnnn nnnn Read accumulated rotation steps since previous read. SET_DEBOUNCE 0x8F W nnnn nnnn Set the time for rescanning the keypad after detecting a key-press or key-release event to verify the event. The default time is 12 milliseconds. The valid range is 1255. Debounce time = n x 4 milliseconds and must not exceed active time. SET_KEY_SIZE 0x90 W nnnn pppp Set keypad size. nnnn = KP-Xx pins, pppp = KP-Yx pins READ_KEY_SIZE 0x91 R nnnn pppp Read keypad size. nnnn = KP-Xx pins, pppp = KP-Yx pins READ_CFG 0x92 R nnnn nnnn Read the hardware configuration register. WRITE_CLOCK 0x93 W nnnn nnnn Write the clock configuration register. READ_CLOCK 0x94 R nnnn nnnn Read the clock configuration register. Write a command to the PWM script command file. nn = PWM channel number (01, 10, or 11) aaaaaa = address in script command file (0-59) pppp pppp = high byte of script command qqqq qqqq = low byte of script command PWM_WRITE 0x95 W aaaa aann pppp pppp qqqq qqqq PWM_START 0x96 W aaaa aann Start script on channel nn (01, 10, or 11) at address aaaaaa. PWM_STOP 0x97 W 0000 00nn Stop script on channel nn (01, 10, or 11). 33 www.national.com LM8323 Please note: The data bytes which follow the command can be reads (toward the host) or writes (toward the LM8323). In the case of the READ_FIFO and RPT_READ_FIFO commands, the number of data bytes is variable, with the last transaction indicated by returning a negative acknowledgement (NACK). 7 6 5 4 3 2 1 0 1 0 0 0 0 0 0 0 7 6 5 17.1 READ_ID COMMAND The READ_ID command consists of a command byte (0x80) from the host and two data bytes from the LM8323. The first data byte returns the manufacturer code, and the second byte returns the device revision level. 4 3 2 1 0 7 6 MANUFACTURER 5 4 3 2 1 0 REVISION into the hardware configuration register. The default state of this register is 0x80. 17.2 WRITE_CFG COMMAND The WRITE_CFG command consists of a command byte (0x81) and a data byte from the host. The data byte is loaded 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 1 0 0 0 0 0 0 1 IRQPST ROTEN 0 0 MUX2EN MUX2SEL MUX1EN MUX1SEL Bit IRQPST ROTEN MUX2EN MUX2SEL MUX1EN MUX1SEL www.national.com Value Description 0 IRQ is an open-drain output. 1 IRQ is a push-pull output. 0 Rotary encoder interface disabled. 1 Rotary encoder interface enabled. This selection enables the ROT_IN_x inputs which are alternate functions of certain KP-Yx pins. 0 MUX2_OUT output disabled. 1 MUX2_OUT output enabled. This overrides any other function available on this pin. 0 If the MUX2 EN bit is 1, the MUX2_IN1 input drives the MUX2_OUT output. 1 If the MUX2 EN bit is 1, the MUX2_IN2 input drives the MUX2_OUT output. 0 MUX1_OUT output disabled. 1 MUX1_OUT output enabled. This overrides any other function available on this pin. 0 If the MUX1 EN bit is 1, the MUX1_IN1 input drives the MUX1_OUT output. 1 If the MUX1 EN bit is 1, the MUX1_IN2 input drives the MUX1_OUT output. 34 7 6 5 4 3 2 1 0 1 0 0 0 0 0 1 0 Bit 7 6 5 Value PWM2END PWM1END PWM0END NOINIT ERROR ROTATOR KEYPAD 4 PWM2END PWM1END PWM0END NOINIT 3 2 ERROR 0 1 0 ROTATOR KEYPAD Description 0 No interrupt from PWM channel 2. 1 An END script command was executed by PWM channel 2. 0 No interrupt from PWM channel 1. 1 An END script command was executed by PWM channel 1. 0 No interrupt from PWM channel 0. 1 An END script command was executed by PWM channel 0. 0 Normal operation. 1 LM8323 is waiting for the initialization sequence. 0 No error condition is indicated. 1 An error condition occurred. 0 No state change in the rotary encoder inputs is indicated. 1 A state change was detected in the rotary encoder inputs. 0 No key-press or key-release event is indicated. 1 A key-press or key-release event occurred. Note: When FW6 version devices receive a RESET command the IRQ line is set high and held high for 60 ms, then pulled low to show the device was successfully reset and is ready to be used. 17.4 RESET COMMAND The RESET command consists of a command byte (0x83) and one data byte from the host. The command causes a reset, identical to an external reset. The data byte must be 0xAA, otherwise no reset will occur and an error condition will be signalled. 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 1 0 0 0 0 0 1 1 1 0 1 0 1 0 1 0 0 Bit GPIO_xx 0 7 6 5 4 3 2 Value 1 0 GPIO_00 0 1 GPIO_02 1 2 GPIO_03 0 3 GPIO_04 0 4 GPIO_05 0 5 GPIO_06 0 6 GPIO_07 1 7 GPIO_08 0 GPIO_09 1 GPIO_10 2 GPIO_11 3 GPIO_12 4 GPIO_13 5 GPIO_14 6 GPIO_15 7 GPIO_01 responding general-purpose I/O ports as pullups (0) or pulldowns (1). The first data byte controls ports GPIO_15 through GPIO_08, and the second byte controls ports GPIO_07 through GPIO_00. 17.5 WRITE_PULL_DOWN COMMAND The WRITE_PORT_SEL command consists of a command byte (0x84) and two data bytes from the host. The data bytes configure the pullup/pulldown device (if enabled) for the cor- Description 0 GPIO port pin pullup/pulldown device is a pullup. 1 GPIO port pin pullup/pulldown device is a pulldown. 35 www.national.com LM8323 interrupt code. An exception to this behavior occurs if the NOINIT bit is set, in which case IRQ will not be deasserted and the interrupt code will not be cleared until a WRITE_CFG command is received. 17.3 READ_INT COMMAND The READ_INT command consists of a command byte (0x82) from the host and a data byte from the LM8323. The data byte is the interrupt code. Reading the interrupt code acknowledges the interrupt (which deasserts IRQ) and clears the 6 5 4 3 2 1 1 0 0 0 0 1 0 1 GPIO_15 GPIO_14 GPIO_13 GPIO_12 GPIO_11 GPIO_10 0 Value GPIO port pin is an input. 1 GPIO port pin is an output. 4 3 2 1 0 0 1 1 0 2 1 0 7 6 5 4 3 2 1 0 GPIO_00 0 3 GPIO_01 0 4 GPIO_02 0 5 GPIO_03 1 GPIO_15 6 GPIO_04 7 GPIO_05 0 GPIO_06 1 GPIO_09 2 GPIO_10 3 GPIO_11 4 GPIO_12 5 GPIO_13 6 GPIO_14 7 GPIO_07 general-purpose I/O ports configured as inputs, the data bytes select whether the inputs are high-impedance (0) or have a weak pullup (1). For ports configured as outputs, the data bytes control the state driven on the output. The first data byte controls ports GPIO_15 through GPIO_08, and the second byte controls ports GPIO_07 through GPIO_00. 17.7 WRITE_PORT_STATE COMMAND The WRITE_PORT_STATE command consists of a command byte (0x86) and two data bytes from the host. For Value Description 0 If the GPIO port pin is an input, pullup device is disabled. If the GPIO port pin is an output, it is driven low. 1 If the GPIO port pin is an input, pullup device is enabled. If the GPIO port pin is an output, it is driven high. the corresponding ports, either input (0) or output (1). The first data byte controls ports GPIO_15 through GPIO_08, and the second byte controls ports GPIO_07 through GPIO_00. 0 1 1 1 2 1 Value 7 6 5 4 3 2 1 0 Description 0 GPIO port pin is an input. 1 GPIO port pin is an output. 5 4 1 0 0 0 1 0 0 0 GPIO_14 GPIO_13 GPIO_12 3 2 1 0 7 6 5 36 4 3 2 1 0 GPIO_00 6 GPIO_01 7 GPIO_02 0 GPIO_05 1 GPIO_06 2 GPIO_07 3 GPIO_08 4 GPIO_09 5 GPIO_10 6 GPIO_11 7 GPIO_03 sponding ports. The first data byte controls ports GPIO_15 through GPIO_08, and the second byte controls ports GPIO_07 through GPIO_00. 17.9 READ_PORT_STATE COMMAND The READ_PORT_STATE command consists of a command byte (0x88) from the host and two data bytes from the LM8323. The data bytes indicate the states on the corre- GPIO_04 GPIO_xx 0 GPIO_00 0 3 GPIO_01 0 4 GPIO_02 0 5 GPIO_03 1 Bit 6 GPIO_04 7 GPIO_05 0 GPIO_06 1 GPIO_09 2 GPIO_10 3 GPIO_11 4 GPIO_12 5 GPIO_13 6 GPIO_14 7 GPIO_15 17.8 READ_PORT_SEL COMMAND The READ_PORT_SEL command consists of a command byte (0x87) from the host and two data bytes from the LM8323. The data bytes indicate the direction configured for GPIO_07 GPIO_xx www.national.com 5 Description 0 The GPIO_09 port pin can only be configured as an input with weak pullup/pulldown device. Bit 6 GPIO_08 GPIO_xx 7 GPIO_08 Bit 0 GPIO_00 7 GPIO_01 0 GPIO_02 1 GPIO_03 2 GPIO_04 3 GPIO_05 4 GPIO_06 5 GPIO_07 6 GPIO_08 7 GPIO_15 LM8323 puts (0) or outputs (1). The first data byte controls ports GPIO_15 through GPIO_08, and the second byte controls ports GPIO_07 through GPIO_00. 17.6 WRITE_PORT_SEL COMMAND The WRITE_PORT_SEL command consists of a command byte (0x85) and two data bytes from the host. The data bytes configure the corresponding general-purpose I/O ports as in- Value Description 0 If the GPIO port pin is an input, pullup is disabled. If the GPIO port pin is an output, it is driven low. 1 If the GPIO port pin is an input, pullup is enabled. If the GPIO port pin is an output, it is driven high. GPIO_xx the FIFO is empty. The last data byte is indicated by its value (0x00) and a negative acknowledgement (NACK) on the ACCESS.bus interface. The data bytes correspond to keypress and key-release events, as described in Table 5. 17.10 READ_FIFO COMMAND The READ_FIFO command consists of a command byte (0x89) sent from the host and a variable number of data bytes received from the LM8323. The LM8323 will provide data until 7 6 5 4 3 2 1 0 1 0 0 0 1 0 0 1 Field 7 6 5 4 3 2 1 Key-release event. 1xxxxxxx Key-press event. 7 6 5 4 3 2 1 0 1 0 0 0 1 0 1 0 7 6 5 4 3 2 1 0 Key-release event. 1xxxxxxx Key-press event. 7 6 5 4 3 2 1 0 1 0 0 0 1 0 1 1 3 2 1 0 6 5 4 3 2 1 0 0x00 press, key-release or rotary encoder event before entering Halt mode. The default active time is 500 milliseconds. The host can program ACTIVETIME from 4-1020 milliseconds with a granularity of 4 milliseconds. 7 6 5 4 3 2 1 0 ACTIVETIME Value 1-255 4 Description 17.12 SET_ACTIVE COMMAND The SET_ACTIVE command consists of a command byte (0x8B) and a data byte from the host. This command sets the time that the LM8323 stays active without detecting a key- ACTIVETIME 7 FIFODATA 0xxxxxxx 0 5 0x00 Value Field 6 data as a previous READ_FIFO command, but without advancing the FIFO pointer. It may be used to recover from an error encountered during a READ_FIFO command. 17.11 RPT_READ_FIFO COMMAND The RPT_READ_FIFO command consists of a command byte (0x8A) and from the host and a variable number of data bytes from the LM8323. This command provides the same FIFODATA 7 Description 0xxxxxxx Field 0 FIFODATA Value FIFODATA LM8323 Bit Description Halt mode is disabled. Active time = n x 4 milliseconds. 37 www.national.com LM8323 reading an interrupt code that indicates an error condition, this command is used to read an error code that indicates the cause of the error condition. 17.13 READ_ERROR COMMAND The READ_ERROR command consists of a command byte (0x8C) from the host and a data byte from the LM8323. After 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 1 0 0 0 1 1 0 0 0 FIFOOVR 0 0 0 KEYOVR CMDUNK BADPAR Bit Value FIFOOVR KEYOVR CMDUNK BADPAR Description 0 No FIFO overrun occurred. 1 Event occurred while the FIFO was full. 0 No keypad overrun occurred. 1 More than two keys were pressed simultaneously. 0 No invalid command was encountered. 1 Not a valid command. 0 No bad parameter was encountered. 1 Bad command parameter. dicates the accumulated number of rotation steps of an external rotary encoder since the last time the READ_ROTATOR command was executed. 17.14 READ_ROTATOR COMMAND The READ_ROTATOR command consists of a command byte (0x8E) from the host and a data byte from the LM8323. The data byte is a signed two's complement value which in7 6 5 4 3 2 1 0 1 0 0 0 1 1 1 0 Field ROTATION 7 6 5 3 2 1 0 Value Description -128 to +127 Clockwise rotation is indicated by a positive value. Counterclockwise movement is indicated by a negative value. bounce time is 12 milliseconds. The host can program DEBOUNCETIME from 4-1020 milliseconds with a granularity of 4 milliseconds. The DEBOUNCETIME must not exceed the active time set with the SET_ACTIVE command. 17.15 SET_DEBOUNCE COMMAND The SET_DEBOUNCE command consists of a command byte (0x8F) and a data byte from the host. This command sets the time that the LM8323 waits before rescanning the keypad to confirm a key-press or key-release event. The default de7 6 5 4 3 2 1 0 1 0 0 0 1 1 1 1 Field Value DEBOUNCETIME 1-255 7 6 5 4 3 2 1 0 DEBOUNCETIME Description Active time = n x 4 milliseconds. The maximum number of KP-Xx inputs is 8, and the maximum number of KP-Yx outputs is 12. If the digital multiplexer MUX2 or the rotary encoder interface is used, the maximum number of KP-Yx outputs is 9. If the SLOWCLKOUT pin is used, the maximum number is 8. 17.16 SET_KEY_SIZE COMMAND The SET_KEY_SIZE command consists of a command byte (0x90) and a data byte from the host. This command specifies the keypad size in terms of the number of KP-Xx inputs and KP-Yx outputs which are used. Any unused KP-Xx and KPYx pins may be used for general-purpose I/O. The minimum value for either field is 3, which corresponds to a keypad configuration that supports 3 x 3 + 3 SF keys (total of 12 keys). 7 6 5 4 3 2 1 0 1 0 0 1 0 0 0 0 7 6 5 4 KP-X Field Value KP-X 3-8 Number of KP-Xx inputs. KP-Y 3-12 Number of KP-Yx outputs. 3 2 1 0 KP-Y Description The host can issue the command at any time to read the configuration of the keypad. 17.17 READ_KEY_SIZE COMMAND The READ_KEY_SIZE command consists of a command byte (0x91) from the host and a data byte from the LM8323. www.national.com 4 ROTATION 38 6 5 4 3 2 1 0 0 0 1 0 0 0 1 7 6 Field Value KP-X 3-8 Number of KP-Xx inputs. KP-Y 3-12 Number of KP-Yx outputs. 2 1 0 7 6 5 4 0 0 1 0 0 ROTEN 0 0 3 Value MUX1SEL 0 2 1 0 MUX1SEL 3 1 MUX1EN 1 MUX1EN 4 0 MUX2SEL 5 0 MUX2SEL 2 KP-Y MUX2EN 6 1 MUX2EN 3 data byte returns the settings in the hardware configuration register. The default state of this register is 0x80. 7 ROTEN 4 Description 17.18 READ_CFG COMMAND The READ_CFG command consists of a command byte (0x92) from the host and a data byte from the LM8323. The Bit 5 KP-X LM8323 7 1 Description 0 Rotary encoder interface disabled. 1 Rotary encoder interface enabled. This selection enables the ROT_IN_x inputs, which are alternate functions of certain KP-Yx pins. 0 MUX2_OUT output disabled. 1 MUX2_OUT output enabled. This overrides any other function available on this pin. 0 If the MUX2 EN bit is 1, the MUX2_IN1 input drives the MUX2_OUT output. 1 If the MUX2 EN bit is 1, the MUX2_IN2 input drives the MUX2_OUT output. 0 MUX1_OUT output disabled. 1 MUX1_OUT output enabled. This overrides any other function available on this pin. 0 If the MUX1 EN bit is 1, the MUX1_IN1 input drives the MUX1_OUT output. 1 If the MUX1 EN bit is 1, the MUX1_IN2 input drives the MUX1_OUT output. 17.19 WRITE_CLOCK COMMAND The WRITE_CLOCK command consists of a command byte (0x93) and a data byte from the host. This command sets the clock configuration, as described in Table 2. 7 6 5 4 3 2 1 0 1 0 0 1 0 0 1 1 7 7 6 5 4 3 2 1 0 0 0 1 0 1 0 0 7 4 3 2 1 0 1 0 0 1 0 1 0 1 7 6 5 ADDRESS Bit Value ADDRESS 0-59 CH 4 3 2 1 3 2 1 6 5 4 3 2 CONFIGURATION 0 1 0 1 0 writes a 16-bit script command into a specified address in the script command file of the specified PWM channel. 17.21 PWM_WRITE COMMAND The PWM_WRITE command consists of a command byte (0x95) and three data bytes from the host. The command 5 4 command reads bits 7:2 of the clock configuration, as described in Table 2 , Section 8.3 CLOCK CONFIGURATION. 1 6 5 CONFIGURATION 17.20 READ_CLOCK COMMAND The READ_CLOCK command consists of a command byte (0x94) from the host and a data byte from the LM8323. This 7 6 0 7 6 5 4 3 2 CH 1 0 7 6 5 4 3 2 1 0 COMMAND Description Location in the PWM script command file. 01 PWM channel 0. 10 PWM channel 1. 11 PWM channel 2. 39 www.national.com LM8323 execution of the script command file at the specified address for the specified channel. 17.22 PWM_START COMMAND The PWM_START command consists of a command byte (0x96) and a data byte from the host. This command starts 7 6 5 4 3 2 1 0 1 0 0 1 0 1 1 0 Bit Value ADDRESS 0-59 CH 7 6 5 4 3 2 1 ADDRESS 0 CH Description Start address in the PWM script command file. 01 PWM channel 0. 10 PWM channel 1. 11 PWM channel 2. 17.23 PWM_STOP COMMAND The PWM_STOP command consists of a command byte (0x97) and a data byte from the host. This command stops execution of the script command file for the specified channel. 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 0 1 0 1 1 1 0 0 0 0 0 0 Bit CH www.national.com Value Description 01 PWM channel 0. 10 PWM channel 1. 11 PWM channel 2. 40 1 0 CH 1) If Military/Aerospace specified devices are required, please contact the National Semiconductor Sales Office/ Distributors for availability and specifications. If Military/Aerospace specified devices are required, please contact the National Semiconductor Sales Office/Distributors for availability and specifications. Supply Voltage (VCC) Voltage at Any Pin 100 mA 2 kV 200V 750V 100 mA 100 mA -65C to +140C 2V -0.3V to VCC +0.3V 19.0 DC Electrical Characteristics (Temperature: -40C TA +85C, unless otherwise specified) Data sheet specification limits are guaranteed by design, test, or statistical analysis. Symbol Parameter VCC Operating Voltage IDD Supply Current (Note 2) IHALT Standby Mode Current (Note 4) VIL Logical 0 Input Voltage (Note 5) VIH Logical 1 Input Voltage (Note 5) Hi-Z Input Leakage (TRI-STATE Output) Conditions Typ 1.62 Max Units 1.98 V Internal Clock, No loads on pins, VCC = 1.9V, TC = 0.5 s (Note 3) 1.9 3.0 mA Typical: VCC = 1.9V, TA = 25C <9 40 A 0.3 x VCC V 0.7 x VCC VCC = 1.8V Port Input Hysteresis (Note 5, Note 6) CPAD Min -2 100 2 400 V A mV Weak Pull-Up/Pull-Down Current 1.6V<VCC< 2.0V 150 A Output Current Source (Push-Pull Mode) VCC = 1.62V, VOH = 0.7 x VCC -16 mA Output Current Sink (Push-Pull Mode) VCC = 1.62V, VOL = 0.3 x VCC 16 mA Allowable Sink and Source Current per Pin (Note 7) 16 mA Input/Output Capacitance (Note 6) 5 pF Note 1: Absolute Maximum Ratings indicate limits beyond which damage to the device may occur. Operating Ratings indicate conditions for which the device is intended to be functional, but specific performance is not guaranteed. For guaranteed specifications and test conditions, see the Electrical Characteristics tables. Note 2: Supply current is measured with inputs connected to VCC and outputs driven low but not connected to a load. Note 3: Command execution cycle = 0.5 s. Note 4: In standby mode, the internal clock is switched off. Supply current in standby mode is measured with inputs connected to VCC and outputs driven low but not connected to a load. Note 5: Applied to all digital pins (including RESET) except for SLOWCLK when configured for an external clock. Note 6: Guaranteed by design, not tested. Note 7: The sum of all I/O sink/source current must not exceed the maximum total current into VCC and out of GND as specified in the absolute maximum ratings. 41 www.national.com LM8323 Maximum Input Current Without Latchup ESD Protection Level (Human Body Model) (Machine Model) (Charge Device Model) Total Current into VCC Pin (Source) Total Current out of GND Pin (Sink) Storage Temperature Range 18.0 Absolute Maximum Ratings (Note LM8323 20.0 AC Electrical Characteristics (Temperature: -40C TA +85C) Data sheet specification limits are guaranteed by design, test, or statistical analysis. Parameter Conditions System Clock Frequency System Clock Period (mclk) Internal RC Processing and Command Execution Cycle (tC) 1.62V VCC 1.98V Min ns s 0.5 CLOAD = 50 pF Output Fall Time(Note 8) ACCESS.bus Output Signals SCL Hold Time (tSDAho) (Note 8) Units MHz 48 System Clock, Processing and Command Execution Cycle Variation ACCESS.bus Input Signals Bus Free Time Between Stop and Start Condition (tBUFi) (Note 8) SCL Setup Time (tCSTOsi) (Note 8) SCL Hold Time (tCSTRhi) (Note 8) SCL Setup Time (tCSTRsi) (Note 8) Data High Setup Time (tDHCsi) (Note 8, Note 9) Data Low Setup Time (tDLCsi) (Note 8, Note 9) SCL Low Time (tSCLlowi) (Note 8) SCL High Time (tSCLhighi) (Note 8, Note 9) SDA Hold Time (tSDAhi) (Note 8) SDA Setup Time (tSDAsi) (Note 8, Note 9) Max 21 1.62V VCC 1.98V General-Purpose I/O (GPIO) Output Rise Time(Note 8) Typ 7 % 15 ns 15 ns 16 mclk Before Stop Condition After Start Condition Before Start Condition Before SCL Rising Edge (RE) Before SCL RE After SCL Falling Edge (FE) After SCL RE After SCL FE Before SCL RE 8 8 8 2 2 12 12 0 2 mclk mclk mclk mclk mclk mclk mclk mclk mclk After SCL FE 7 mclk Note 8: Guaranteed by design, not tested. Note 9: The ACCESS.bus interface implements and meets the timing necessary for interface to the I2C and SMBus protocol at logic levels. The bus drivers are designed with open-drain output for bidirectional operation. Due to System Clock (mclk) Variation, this specification may not meet the AC timing and current/ voltage drive requirements of the full bus specifications. 30021119 FIGURE 20. ACB Start and Stop Condition Timing www.national.com 42 LM8323 21.0 Physical Dimensions inches (millimeters) unless otherwise noted Micro Array Package Order Number LM8323GGR8 NS Package Number GRA36A 43 www.national.com LM8323 Mobile I/O Companion supporting Keyscan, I/O Expansion, PWM, and ACCESS.bus Host Interface Notes For more National Semiconductor product information and proven design tools, visit the following Web sites at: www.national.com Products Design Support Amplifiers www.national.com/amplifiers WEBENCH(R) Tools www.national.com/webench Audio www.national.com/audio App Notes www.national.com/appnotes Clock and Timing www.national.com/timing Reference Designs www.national.com/refdesigns Data Converters www.national.com/adc Samples www.national.com/samples Interface www.national.com/interface Eval Boards www.national.com/evalboards LVDS www.national.com/lvds Packaging www.national.com/packaging Power Management www.national.com/power Green Compliance www.national.com/quality/green Switching Regulators www.national.com/switchers Distributors www.national.com/contacts LDOs www.national.com/ldo Quality and Reliability www.national.com/quality LED Lighting www.national.com/led Feedback/Support www.national.com/feedback Voltage References www.national.com/vref Design Made Easy www.national.com/easy www.national.com/powerwise Applications & Markets www.national.com/solutions Mil/Aero www.national.com/milaero PowerWise(R) Solutions Serial Digital Interface (SDI) www.national.com/sdi Temperature Sensors www.national.com/tempsensors SolarMagicTM www.national.com/solarmagic PLL/VCO www.national.com/wireless www.national.com/training PowerWise(R) Design University THE CONTENTS OF THIS DOCUMENT ARE PROVIDED IN CONNECTION WITH NATIONAL SEMICONDUCTOR CORPORATION ("NATIONAL") PRODUCTS. NATIONAL MAKES NO REPRESENTATIONS OR WARRANTIES WITH RESPECT TO THE ACCURACY OR COMPLETENESS OF THE CONTENTS OF THIS PUBLICATION AND RESERVES THE RIGHT TO MAKE CHANGES TO SPECIFICATIONS AND PRODUCT DESCRIPTIONS AT ANY TIME WITHOUT NOTICE. NO LICENSE, WHETHER EXPRESS, IMPLIED, ARISING BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. TESTING AND OTHER QUALITY CONTROLS ARE USED TO THE EXTENT NATIONAL DEEMS NECESSARY TO SUPPORT NATIONAL'S PRODUCT WARRANTY. EXCEPT WHERE MANDATED BY GOVERNMENT REQUIREMENTS, TESTING OF ALL PARAMETERS OF EACH PRODUCT IS NOT NECESSARILY PERFORMED. NATIONAL ASSUMES NO LIABILITY FOR APPLICATIONS ASSISTANCE OR BUYER PRODUCT DESIGN. BUYERS ARE RESPONSIBLE FOR THEIR PRODUCTS AND APPLICATIONS USING NATIONAL COMPONENTS. PRIOR TO USING OR DISTRIBUTING ANY PRODUCTS THAT INCLUDE NATIONAL COMPONENTS, BUYERS SHOULD PROVIDE ADEQUATE DESIGN, TESTING AND OPERATING SAFEGUARDS. EXCEPT AS PROVIDED IN NATIONAL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, NATIONAL ASSUMES NO LIABILITY WHATSOEVER, AND NATIONAL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY RELATING TO THE SALE AND/OR USE OF NATIONAL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. LIFE SUPPORT POLICY NATIONAL'S PRODUCTS ARE NOT AUTHORIZED FOR USE AS CRITICAL COMPONENTS IN LIFE SUPPORT DEVICES OR SYSTEMS WITHOUT THE EXPRESS PRIOR WRITTEN APPROVAL OF THE CHIEF EXECUTIVE OFFICER AND GENERAL COUNSEL OF NATIONAL SEMICONDUCTOR CORPORATION. As used herein: Life support devices or systems are devices which (a) are intended for surgical implant into the body, or (b) support or sustain life and whose failure to perform when properly used in accordance with instructions for use provided in the labeling can be reasonably expected to result in a significant injury to the user. A critical component is any component in a life support device or system whose failure to perform can be reasonably expected to cause the failure of the life support device or system or to affect its safety or effectiveness. National Semiconductor and the National Semiconductor logo are registered trademarks of National Semiconductor Corporation. All other brand or product names may be trademarks or registered trademarks of their respective holders. Copyright(c) 2010 National Semiconductor Corporation For the most current product information visit us at www.national.com National Semiconductor Americas Technical Support Center Email: support@nsc.com Tel: 1-800-272-9959 www.national.com National Semiconductor Europe Technical Support Center Email: europe.support@nsc.com National Semiconductor Asia Pacific Technical Support Center Email: ap.support@nsc.com National Semiconductor Japan Technical Support Center Email: jpn.feedback@nsc.com IMPORTANT NOTICE Texas Instruments Incorporated and its subsidiaries (TI) reserve the right to make corrections, modifications, enhancements, improvements, and other changes to its products and services at any time and to discontinue any product or service without notice. Customers should obtain the latest relevant information before placing orders and should verify that such information is current and complete. All products are sold subject to TI's terms and conditions of sale supplied at the time of order acknowledgment. TI warrants performance of its hardware products to the specifications applicable at the time of sale in accordance with TI's standard warranty. Testing and other quality control techniques are used to the extent TI deems necessary to support this warranty. Except where mandated by government requirements, testing of all parameters of each product is not necessarily performed. TI assumes no liability for applications assistance or customer product design. Customers are responsible for their products and applications using TI components. To minimize the risks associated with customer products and applications, customers should provide adequate design and operating safeguards. TI does not warrant or represent that any license, either express or implied, is granted under any TI patent right, copyright, mask work right, or other TI intellectual property right relating to any combination, machine, or process in which TI products or services are used. Information published by TI regarding third-party products or services does not constitute a license from TI to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property of the third party, or a license from TI under the patents or other intellectual property of TI. Reproduction of TI information in TI data books or data sheets is permissible only if reproduction is without alteration and is accompanied by all associated warranties, conditions, limitations, and notices. Reproduction of this information with alteration is an unfair and deceptive business practice. TI is not responsible or liable for such altered documentation. Information of third parties may be subject to additional restrictions. Resale of TI products or services with statements different from or beyond the parameters stated by TI for that product or service voids all express and any implied warranties for the associated TI product or service and is an unfair and deceptive business practice. TI is not responsible or liable for any such statements. TI products are not authorized for use in safety-critical applications (such as life support) where a failure of the TI product would reasonably be expected to cause severe personal injury or death, unless officers of the parties have executed an agreement specifically governing such use. Buyers represent that they have all necessary expertise in the safety and regulatory ramifications of their applications, and acknowledge and agree that they are solely responsible for all legal, regulatory and safety-related requirements concerning their products and any use of TI products in such safety-critical applications, notwithstanding any applications-related information or support that may be provided by TI. Further, Buyers must fully indemnify TI and its representatives against any damages arising out of the use of TI products in such safety-critical applications. TI products are neither designed nor intended for use in military/aerospace applications or environments unless the TI products are specifically designated by TI as military-grade or "enhanced plastic." Only products designated by TI as military-grade meet military specifications. Buyers acknowledge and agree that any such use of TI products which TI has not designated as military-grade is solely at the Buyer's risk, and that they are solely responsible for compliance with all legal and regulatory requirements in connection with such use. TI products are neither designed nor intended for use in automotive applications or environments unless the specific TI products are designated by TI as compliant with ISO/TS 16949 requirements. Buyers acknowledge and agree that, if they use any non-designated products in automotive applications, TI will not be responsible for any failure to meet such requirements. Following are URLs where you can obtain information on other Texas Instruments products and application solutions: Products Applications Audio www.ti.com/audio Communications and Telecom www.ti.com/communications Amplifiers amplifier.ti.com Computers and Peripherals www.ti.com/computers Data Converters dataconverter.ti.com Consumer Electronics www.ti.com/consumer-apps DLP(R) Products www.dlp.com Energy and Lighting www.ti.com/energy DSP dsp.ti.com Industrial www.ti.com/industrial Clocks and Timers www.ti.com/clocks Medical www.ti.com/medical Interface interface.ti.com Security www.ti.com/security Logic logic.ti.com Space, Avionics and Defense www.ti.com/space-avionics-defense Power Mgmt power.ti.com Transportation and Automotive www.ti.com/automotive Microcontrollers microcontroller.ti.com Video and Imaging RFID www.ti-rfid.com OMAP Mobile Processors www.ti.com/omap Wireless Connectivity www.ti.com/wirelessconnectivity TI E2E Community Home Page www.ti.com/video e2e.ti.com Mailing Address: Texas Instruments, Post Office Box 655303, Dallas, Texas 75265 Copyright (c) 2011, Texas Instruments Incorporated