19-4984; Rev 3; 8/10 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM Features Fast (400kHz) I2C Interface EEPROM is a multifunction device that provides a clock/calendar, programmable watchdog timer, powersupply monitor with reset, and 512 bytes of EEPROM. The clock provides hundredths of seconds, seconds, minutes, and hours, and operates in 24-hour or 12-hour format with an AM/PM indicator. The calendar provides day, date, month, and year information. The date at the end of the month is automatically adjusted for months with fewer than 31 days, including corrections for leap year. A watchdog timer provides a reset for an unresponsive microprocessor. It is programmable in 10ms intervals from 0.01 to 99.99 seconds. A temperaturecompensated voltage reference and comparator circuit monitors the status of VCC. If a primary power failure is detected, the device automatically switches to the backup supply and drives the reset output to the active state. The backup supply maintains time and date operation in the absence of VCC. When VCC returns to nominal levels, the reset is held low for a period to allow the power supply and processor to stabilize. The device also has a pushbutton reset controller, which debounces a reset input signal. The device is accessed through an I2C serial interface. RTC Counts Hundredths of Seconds, Seconds, Minutes, Hours, Day, Date, Month, and Year with Leap Year Compensation Valid Up to 2100 Applications Portable Instruments Point-of-Sale Equipment Programmable Watchdog Timer Automatic Power-Fail Detect and Switch Circuitry Reset Output with Pushbutton Reset Input Capability 512 x 8 Bits of EEPROM Integrated Trickle-Charge Capability for Backup Supply Three Operating Voltages: 5.0V, 3.3V, and 3.0V Low Timekeeping Voltage Down to 1.3V -40C to +85C Temperature Range UL Recognized Ordering Information PART TEMP RANGE PIN-PACKAGE TOP MARK DS1388Z-5+ -40C to +85C 8 SO (150 mils) DS1388-5 DS1388Z-33+ -40C to +85C 8 SO (150 mils) DS138833 DS1388Z-3+ -40C to +85C 8 SO (150 mils) DS1388-3 +Denotes a lead(Pb)-free/RoHS-compliant package. Network Interface Cards Wireless Equipment Pin Configuration Typical Operating Circuit VCC VCC CRYSTAL VCC TOP VIEW X1 1 + 8 VCC RPU X2 2 7 RST 6 SCL RPU X1 X2 VCC DS1388 VBACKUP 3 GND 4 5 SCL CPU DS1388 RST SDA SDA VBACKUP SO GND RPU = tR/CB ______________________________________________ Maxim Integrated Products For pricing, delivery, and ordering information, please contact Maxim Direct at 1-888-629-4642, or visit Maxim's website at www.maxim-ic.com. 1 DS1388 General Description The DS1388 I2C real-time clock (RTC), supervisor, and DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM ABSOLUTE MAXIMUM RATINGS Voltage Range on VCC Pin Relative to Ground .....-0.3V to +6.0V Voltage Range on Inputs Relative to Ground ...............................................-0.3V to (VCC + 0.3V) Junction-to-Ambient Thermal Resistance (JA) (Note 1)..170C/W Junction-to-Case Thermal Resistance (JC) (Note 1) ......40C/W Note 1: Operating Temperature Range (noncondensing) .............................................-40C to +85C Storage Temperature Range .............................-55C to +125C Lead Temperature (soldering, 10s) .................................+260C Soldering Temperature (reflow) .......................................+260C Package thermal resistances were obtained using the method described in JEDEC specification JESD51-7, using a fourlayer board. For detailed information on package thermal considerations, refer to www.maxim-ic.com/thermal-tutorial. Stresses beyond those listed under "Absolute Maximum Ratings" may cause permanent damage to the device. These are stress ratings only, and functional operation of the device at these or any other conditions beyond those indicated in the operational sections of the specifications is not implied. Exposure to absolute maximum rating conditions for extended periods may affect device reliability. RECOMMENDED DC OPERATING CONDITIONS (TA = -40C to +85C, unless otherwise noted.) (Note 2) PARAMETER Supply Voltage SYMBOL VCC CONDITIONS (Note 3) MIN TYP MAX DS1388Z-5 4.5 5 5.5 DS1388Z-33 2.97 3.3 3.63 DS1388Z-3 2.7 3 3.3 UNITS V Logic 1 VIH (Note 3) 0.7 x VCC VCC + 0.3 V Logic 0 VIL (Note 3) -0.3 +0.3 x VCC V Pullup Voltage (SCL, SDA), VCC = 0V VPU 5.5 V V VBACKUP Voltage Power-Fail Voltage VBACKUP (Note 3) VPF (Note 3) 1.3 3.0 5.5 DS1388Z-5 4.15 4.33 4.50 DS1388Z-33 2.70 2.88 2.97 DS1388Z-3 2.45 2.60 2.70 MIN TYP MAX V DC ELECTRICAL CHARACTERISTICS (VCC = VCC(MIN) to VCC(MAX), TA = -40C to +85C, unless otherwise noted.) (Note 2) PARAMETER Trickle-Charger Current-Limiting Resistors SYMBOL CONDITIONS R1 (Notes 4, 5) 250 R2 (Note 6) 2000 R3 (Note 7) UNITS 4000 Input Leakage (SCL) ILI -1 +1 A I/O Leakage (SDA) ILO -1 +1 A I/O Leakage (RST) ILORST -200 +10 A 3 mA SDA Logic 0 Output (VOL = 0.15 x VCC) 2 (Note 8) I OLDOUT _____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM DS1388 DC ELECTRICAL CHARACTERISTICS (continued) (VCC = VCC(MIN) to VCC(MAX), TA = -40C to +85C, unless otherwise noted.) (Note 2) PARAMETER RST Logic 0 Output VCC Active Current, EEPROM 2 Read, I C Read/Write Access VCC Active Current, EEPROM Write Cycle SYMBOL I OLSIR ICCER ICCEW CONDITIONS MIN TYP VCC > 2V; VOL = 0.4V 3.0 1.8V < VCC < 2V; VOL = 0.2 x VCC 3.0 1.3V < VCC < 1.8V; VOL = 0.2 x VCC DS1388Z-5 250 600 (Note 9) DS1388Z-33 250 DS1388Z-3 225 (Note 9) DS1388Z-5 1.0 DS1388Z-33 0.70 DS1388Z-3 0.65 DS1388Z-5 VCC Standby Current ICCS (Note 10) EEPROM Write/Erase Cycles 100 mA A A mA 150 A 140 IBACKUPLKG tWR UNITS 270 DS1388Z-33 DS1388Z-3 VBACKUP Leakage Current (VBACKUP = 3.7V, VCC = VCC(MAX)) MAX 15 TA = +25C (guaranteed by design) 200k TA = -40C to +85C (guaranteed by design) 50k 100 nA Cycles DC ELECTRICAL CHARACTERISTICS (VCC = 0V, VBACKUP = 3.7V, TA = +25C, unless otherwise noted.) (Note 2) PARAMETER SYMBOL CONDITIONS MIN TYP MAX UNITS VBACKUP Current, OSC On (EOSC = 0), SDA = SCL = 0V IBACKUP (Note 11) 410 550 nA VBACKUP Current, OSC Off (EOSC = 1), SDA = SCL = 0V (Data Retention) IBACKUPDR (Note 11) 10 100 nA _____________________________________________________________________ 3 DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM AC ELECTRICAL CHARACTERISTICS (VCC = VCC(MIN) to VCC(MAX), TA = -40C to +85C, unless otherwise noted.) (Note 2) PARAMETER SYMBOL SCL Clock Frequency f SCL Bus Free Time Between a STOP and START Condition tBUF Hold Time (Repeated) START Condition (Note 12) tHD:STA LOW Period of SCL Clock tLOW HIGH Period of SCL Clock tHIGH Setup Time for a Repeated START Condition t SU:STA Data Hold Time (Notes 13, 14) tHD:DAT Data Setup Time (Note 15) t SU:DAT Rise Time of Both SDA and SCL Signals (Note 16) tR Fall Time of Both SDA and SCL Signals (Note 16) tF Setup Time for STOP Condition t SU:STO Capacitive Load for Each Bus Line CB I/O Capacitance (SDA, SCL, RST) CI/O Pushbutton Debounce CONDITION Fast mode Standard mode MIN 400 0 100 1.3 Standard mode 4.7 Fast mode 0.6 Standard mode 4.0 Fast mode 1.3 Standard mode 4.7 Fast mode 0.6 Standard mode 4.0 Fast mode 0.6 Standard mode 4.7 Fast mode 0 Standard mode 0 Fast mode 100 Standard mode 250 Standard mode Fast mode Standard mode MAX 100 Fast mode Fast mode TYP s s s s 0.9 300 20 + 0.1CB 300 0.6 4.0 s ns 1000 Standard mode kHz s 20 + 0.1CB Fast mode UNITS 300 ns ns s (Note 16) +25C 400 pF 10 pF PBDB 160 180 ms Reset Active Time tRST 160 180 ms EEPROM Write Cycle Time tWEE 8 10 ms Oscillator Stop Flag (OSF) Delay t OSF 4 (Note 17) _____________________________________________________________________ 20 ms I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM DS1388 POWER-UP/POWER-DOWN CHARACTERISTICS (TA = -40C to +85C) (Note 2) (Figures 1, 2) PARAMETER SYMBOL VCC Detect to Recognize Inputs (VCC Rising) tRST VCC Fall Time; VPF(MAX) to V PF(MIN) VCC Rise Time; V PF(MIN) to V PF(MAX) CONDITIONS MIN TYP MAX UNITS 160 180 ms (Note 18) tF 300 s tR 0 s VCC VPF(MAX) VPF VPF(MIN) VPF tF tR tRPU tRST RST RECOGNIZED INPUTS DON'T CARE RECOGNIZED HIGH IMPEDANCE OUTPUTS VALID VALID Figure 1. Power-Up/Down Timing RST PBDB tRST Figure 2. Pushbutton Reset Timing _____________________________________________________________________ 5 DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM WARNING: Under no circumstances are negative undershoots, of any amplitude, allowed when device is in write protection. Note 2: Note 3: Note 4: Note 5: Note 6: Note 7: Note 8: Note 9: Note 10: Note 11: Note 12: Note 13: Note 14: Note 15: Note 16: Note 17: Note 18: 6 Limits at -40C are guaranteed by design and are not production tested. All voltages are referenced to ground. Measured at VCC = typ, VBACKUP = 0V, register 0Ah, block 0h = A5h. The use of the 250 trickle-charge resistor is not allowed at VCC > 3.63V and should not be enabled. Measured at VCC = typ, VBACKUP = 0V, register 0Ah, block 0h = A6h. Measured at VCC = typ, VBACKUP = 0V, register 0Ah, block 0h = A7h. The RST pin has an internal 50k pullup resistor to VCC. ICCA--SCL clocking at max frequency = 400kHz. Specified with I2C bus inactive. Measured with a 32.768kHz crystal attached to X1 and X2. After this period, the first clock pulse is generated. A device must internally provide a hold time of at least 300ns for the SDA signal (referred to the VIHMIN of the SCL signal) to bridge the undefined region of the falling edge of SCL. The maximum tHD:DAT need only be met if the device does not stretch the LOW period (tLOW) of the SCL signal. A fast-mode device can be used in a standard-mode system, but the requirement tSU:DAT 250ns must then be met. This is automatically the case if the device does not stretch the LOW period of the SCL signal. If such a device does stretch the LOW period of the SCL signal, it must output the next data bit to the SDA line tR(MAX) + tSU:DAT = 1000 + 250 = 1250ns before the SCL line is released. CB--total capacitance of one bus line in pF. The parameter tOSF is the period of time that the oscillator must be stopped for the OSF flag to be set over the voltage range of 0V VCC VCC(MAX) and 1.3V VBACKUP 3.7V. If the oscillator is disabled or stopped, RST goes inactive after tRST plus the startup time of the oscillator. _____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM IBACKUP SUPPLY CURRENT VOLTAGE vs. TEMPERATURE IBACKUP SUPPLY CURRENT VOLTAGE vs. VBACKUP VBACKUP = 3V 550 SUPPLY CURRENT (nA) 450 400 350 DS1388 toc02 VCC = 0V SUPPLY CURRENT (nA) 600 DS1388 toc01 500 500 450 400 350 300 300 250 250 1.3 1.7 2.1 2.5 2.9 3.3 3.7 4.1 4.5 4.9 5.3 VBACKUP (V) -40 -25 10 5 20 35 50 65 80 TEMPERATURE (C) OSCILLATOR FREQUENCY vs. SUPPLY VOLTAGE DS1388 toc03 32768.40 10,000 VCC = VPF + 0.1V TO 0V DS1388 toc04 VCC FALLING vs. RST DELAY 32768.45 RESET DELAY (s) FREQUENCY (Hz) 32768.35 32768.30 32768.25 32768.20 32768.15 1000 100 32768.10 32768.05 10 32768.00 1.3 1.8 2.3 2.8 3.3 3.8 4.3 SUPPLY (V) 4.8 5.3 0.01 0.1 1 10 100 VCC FALLING (V/ms) _____________________________________________________________________ 7 DS1388 Typical Operating Characteristics (VCC = +3.3V, TA = +25C, unless otherwise noted.) I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM DS1388 Pin Description PIN NAME 1 X1 2 X2 FUNCTION Connections for a Standard 32.768kHz Quartz Crystal. The internal oscillator circuitry is designed for operation with a crystal having a specified load capacitance (CL) of 6.0pF. Pin X1 is the input to the oscillator and can optionally be connected to an external 32.768kHz oscillator. The output of the internal oscillator, pin X2, is left unconnected if an external oscillator is connected to pin X1. Connection for a Secondary Power Supply. Supply voltage must be held between 1.3V and 5.5V for proper operation. This pin can be connected to a primary cell, such as a lithium button cell. Additionally, this pin can be connected to a rechargeable cell or a super cap when used with the trickle-charge feature. If not used, this pin must be connected to ground. UL recognized to ensure against reverse charging current when used with a lithium battery (www.maxim-ic.com/qa/info/ul/). 3 VBACKUP 4 GND Ground 5 SDA Serial Data Output. SDA is the input/output for the I2C serial interface. This pin is open drain and requires an external pullup resistor. 6 SCL Serial Clock Input. SCL is the clock input for the I2C interface and is used to synchronize data movement on the serial interface. 7 RST Active-Low, Open-Drain Reset Output. This pin indicates the status of VCC relative to the V PF specification. As VCC falls below VPF, the RST pin is driven low. When VCC exceeds V PF, for tRST, the RST pin is driven high impedance. The active-low, open-drain output is combined with a debounced pushbutton input function. This pin can be activated by a pushbutton reset request. It has an internal 50k nominal value pullup resistor to VCC. No external pullup resistors should be connected. If the crystal oscillator is disabled, the startup time of the oscillator is added to the tRST delay. 8 VCC DC Power Pin for Primary Power Supply Block Diagram BLOCK 0 BLOCK 1 BLOCK 2 X1 CL CLOCK AND CALENDAR REGISTERS CL X2 EEPROM VCC GND VBACKUP POWER CONTROL AND TRICKLE CHARGER RST SDA SCL EEPROM WATCHDOG TIMER I2C INTERFACE STATUS CONTROL/ TRICKLE EEPROM INTERFACE DS1388 8 _____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM multifunction device that provides a clock/calendar, programmable watchdog timer, power-supply monitor with reset, and 512 bytes of EEPROM. The clock provides hundredths of seconds, seconds, minutes, and hours, and operates in 24-hour or 12-hour format with an AM/PM indicator. The calendar provides day, date, month, and year information. The date at the end of the month is automatically adjusted for months with fewer than 31 days, including corrections for leap year. A watchdog timer provides a reset for an unresponsive microprocessor. It is programmable in 10ms intervals from 0.01 to 99.99 seconds. A temperature-compensated voltage reference and comparator circuit monitors the status of VCC. If a primary power failure is detected, the device automatically switches to the backup supply and drives the reset output to the active state. When VCC returns to nominal levels, the reset is held low for a period to allow the power supply and processor to stabilize. The device also has a pushbutton reset controller, which debounces a reset input signal. The device is accessed through an I2C serial interface. Operation The DS1388 operates as a slave device on the I2C bus. Access is obtained by implementing a START condition and providing a device identification code followed by data. Subsequent registers can be accessed sequentially until a STOP condition is executed. See the Block Diagram, which shows the main elements of the serial real-time clock. Power Control The power-control function is provided by a precise, temperature-compensated voltage reference and a comparator circuit that monitors the VCC level. The device is fully accessible and data can be written and read when VCC is greater than VPF. However, when VCC falls below VPF, the internal clock registers are blocked from any access. If VPF is less than VBACKUP, the device power is switched from VCC to VBACKUP when V CC drops below V PF . If V PF is greater than VBACKUP, the device power is switched from VCC to VBACKUP when VCC drops below VBACKUP. The registers are maintained from the VBACKUP source until VCC is returned to nominal levels (Table 1). After V CC returns above VPF, read and write access is allowed after RST goes high (Figure 1). On first application of power to the device, the time and date registers are set to 00/00/00 00 00:00:00 (MM/DD/YY DOW HH:MM:SS). The user should initialize all RTC registers to valid date and time settings. Table 1. Power Control SUPPLY CONDITION READ/WRITE ACCESS POWERED BY VCC < VPF, VCC < VBACKPUP No VBACKUP VCC < VPF, VCC > VBACKUP No VCC VCC > VPF, VCC < VBACKUP Yes VCC VCC > VPF, VCC > VBACKUP Yes VCC Oscillator Circuit The DS1388 uses an external 32.768kHz crystal. The oscillator circuit does not require any external resistors or capacitors to operate. Table 2 specifies several crystal parameters for the external crystal. Using a crystal with the specified characteristics, the startup time is usually less than one second. Table 2. Crystal Specifications* PARAMETER SYMBOL Nominal Frequency fO Series Resistance ESR Load Capacitance CL MIN TYP MAX 32.768 kHz 50 6 UNITS k pF *The crystal, traces, and crystal input pins should be isolated from RF generating signals. Refer to Application Note 58: Crystal Considerations for Dallas Real-Time Clocks for additional specifications. _____________________________________________________________________ 9 DS1388 Detailed Description The DS1388 I2C RTC, supervisor, and EEPROM is a DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM LOCAL GROUND PLANE (LAYER 2) X1 CRYSTAL X2 NOTE: AVOID ROUTING SIGNAL LINES IN THE CROSSHATCHED AREA (UPPER LEFT QUADRANT) OF THE PACKAGE UNLESS THERE IS A GROUND PLANE BETWEEN THE SIGNAL LINE AND THE DEVICE PACKAGE. GND Figure 3. Layout Example Clock Accuracy The accuracy of the clock is dependent upon the accuracy of the crystal and the accuracy of the match between the capacitive load of the oscillator circuit and the capacitive load for which the crystal was trimmed. Additional error is added by crystal frequency drift caused by temperature shifts. External circuit noise coupled into the oscillator circuit can result in the clock running fast. Figure 3 shows a typical PC board layout for isolation of the crystal and oscillator from noise. Refer to Application Note 58: Crystal Considerations with Dallas Real-Time Clocks for detailed information. Address Map Figure 4 shows the address map for the DS1388. The memory map is divided into three blocks. The memory block accessed is determined by the value of the block address bits in the slave address byte. The timekeeping registers reside in block 0h. During a multibyte access of the timekeeping registers, when the internal address pointer reaches 0Ch, it wraps around to location 00h. On an I2C START or address pointer incrementing to location 00h, the current time is transferred to a second set of registers. The time information is read from these secondary registers, while the clock may continue to run. This eliminates the need to reread the registers in case the main registers update during a 10 read. The EEPROM is divided into two 256-byte blocks located in blocks 1h and 2h. During a multibyte read of the EEPROM registers, when the internal address pointer reaches FFh, it wraps around to location 00h of the block of EEPROM specified in the block address. During a multibyte write of the EEPROM registers, when the internal address pointer reaches the end of the current 8-byte EEPROM page, it wraps around to the beginning of the EEPROM page. See the Write Operation section for details. To avoid rollover issues when writing to the time and date registers, all registers should be written before the hundredths-of-seconds register reaches 99 (BCD). Hundredths-of-Seconds Generator The hundredths-of-seconds generator circuit shown in the Block Diagram is a state machine that divides the incoming frequency (4096Hz) by 41 for 24 cycles and 40 for 1 cycle. This produces a 100Hz output that is slightly off during the short term, and is exactly correct every 250ms. The divide ratio is given by: Ratio = [41 x 24 + 40 x 1] / 25 = 40.96 Thus, the long-term average frequency output is exactly 100Hz. ____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM BLK WORD 0h 00h BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 Tenth Seconds BIT 2 BIT 1 BIT 0 FUNCTION RANGE Hundredths of Seconds Hundredths of Seconds 00-99 0h 01h 0 10 Seconds Seconds Seconds 00-59 0h 02h 0 10 Minutes Minutes Minutes 00-59 0h 03h 0 12/24 AM/ PM Hours Hours 1-12+ AM/PM 00-23 0h 04h 0 0 0 0h 05h 0 0 0h 06h 0 0 0h 07h 0h 10 Hour 10 Hour 0 X Day 01-07 Date Day Date 01-31 Month Month 01-12 10 Year Year Year 00-99 08h Watchdog Tenths of Seconds Watchdog Hundredths of Seconds Watchdog Hundredth Seconds 00-99 0h 09h Watchdog Tenths of Seconds Watchdog Seconds Watchdog Seconds 00-99 0h 0Ah TCS3 TCS2 TCS1 TCS0 DS1 DS0 ROUT1 ROUT0 Trickle Charger -- 0h 0Bh OSF WF 0 0 0 0 0 0 Flag -- 0h 0Ch EOSC 0 0 0 0 0 WDE WD/RST Control -- 1h 00-FFh 256 x 8 EEPROM EEPROM 00-FFh 2h 00-FFh 256 x 8 EEPROM EEPROM 00-FFh 10 Date 10 Month X DS1388 ADDRESS Figure 4. Address Map Note: Unless otherwise specified, the state of the registers is not defined when power (VCC and VBACKUP) is first applied. X = General-purpose read/write bit. 0 = Always reads as a zero. Clock and Calendar The time and calendar information is obtained by reading the appropriate register bytes. Figure 4 illustrates the RTC registers. The time and calendar are set or initialized by writing the appropriate register bytes. The contents of the time and calendar registers are in the binary-coded decimal (BCD) format. The end of the month date is automatically adjusted for months with fewer than 31 days, including corrections for leap years through 2099. The day-of-week register increments at midnight. Values that correspond to the day-of-week are user-defined but must be sequential (i.e., if 1 equals Sunday, then 2 equals Monday, and so on). Illogical time and date entries result in undefined operation. The DS1388 can be run in either 12-hour or 24hour mode. Bit 6 of the hours register is defined as the 12- or 24-hour mode-select bit. When high, the 12-hour mode is selected. In the 12-hour mode, bit 5 is the AM/PM bit with logic-high being PM. In the 24-hour mode, bit 5 is the second 10-hour bit (20-23 hours). Changing the 12/24 bit requires that the hours data be re-entered in the proper format. ____________________________________________________________________ 11 DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM Watchdog Alarm Counter The contents of the watchdog alarm counter, which is a separate two-byte BCD down counter, are accessed in the address range 08h-09h in block 0h. It is programmable in 10ms intervals from 0.01 to 99.99 seconds. When this counter is written, both the counter and a seed register are loaded with the desired value. When the counter is to be reloaded, it uses the value in the seed register. When the counter is read, the current counter value is latched into a register, which is output on the serial data line and the watchdog counter reloads the seed value. If the counter is not needed, it can be disabled and used as a 16-bit cache of battery-backed RAM by setting the WDE bit in the control register to logic 0. If all 16 bits of the watchdog alarm counter are written to a zero when WDE = 1, the counter is disabled and the WF bit is not set. When the WDE bit in the control register is set to a logic 1 and a non-zero value is written into the watchdog registers, the watchdog alarm counter decrements every 1/100 second, until it reaches zero. At this point, the WF bit in the flag register is set. If WD/RST = 1, the RST pin is pulsed low for tRST and access to the DS1388 is inhibited. At the end of tRST, the RST pin becomes high impedance, and read/write access to the DS1388 is enabled. The WF flag remains set until cleared by writing WF to logic 0. The watchdog alarm counter can be reloaded and restarted before the counter reaches zero by reading or writing any of the watchdog alarm counter registers. The WF flag and WDE bit must be set to zero before writing the watchdog registers. After writing the watchdog registers, WDE must be set to one to enable the watchdog. Power-Up/Down, Reset, and Pushbutton Reset Functions A precision temperature-compensated reference and comparator circuit monitors the status of VCC. When an out-of-tolerance condition occurs, an internal power-fail signal is generated that blocks read/write access to the device and forces the RST pin low. When VCC returns to an in-tolerance condition, the internal power-fail signal is held active for tRST to allow the power supply to stabilize, and the RST pin is held low. If the EOSC bit is set to a logic 1 (to disable the oscillator in battery-backup mode), the internal power-fail signal and the RST pin are kept active for tRST plus the oscillator startup time. Access is inhibited whenever RST is low. The DS1388 provides for a pushbutton switch to be connected to the RST output pin. When the DS1388 is not in a reset cycle, it continuously monitors the RST signal for a low-going edge. If an edge is detected, the part debounces the switch by pulling the RST pin low and inhibits read/write access. After the internal timer has expired, the part continues to monitor the RST line. If the line is still low, it continues to monitor the line looking for a rising edge. Upon detecting release, the part forces the RST pin low and holds it low for tRST. Special-Purpose Registers The DS1388 has three additional registers (control, flag, and trickle charger) that control the real-time clock, watchdog, and trickle charger. Flag Register (00Bh) Bit 7: Oscillator Stop Flag (OSF). A logic 1 in this bit indicates that the oscillator has stopped or was stopped for some period of time and may be used to judge the validity of the clock and calendar data. This bit is edge triggered and is set to logic 1 when the internal circuitry senses the oscillator has transitioned from a normal run state to a STOP condition. The following are examples of conditions that can cause the OSF bit to be set: 1) The first time power is applied. 2) The voltage present on both VCC and VBACKUP are insufficient to support oscillation. 3) The EOSC bit is turned off. 4) External influences on the crystal (i.e., noise, leakage, etc.). This bit remains at logic 1 until written to logic 0. This bit can only be written to logic 0. Attempting to write OSF to logic 1 leaves the value unchanged. Bit 6: Watchdog Alarm Flag (WF). A logic 1 in this bit indicates that the watchdog counter reached zero. If WDE and WD/RST are set to 1, the RST pin pulses low for tRST when the watchdog counter reaches zero and sets WF = 1. At the completion of the pulse, the WF bit remains set to logic 1. Writing this bit to logic 0 clears the WF flag. This bit can only be written to logic 0. Attempting to write logic 1 leaves the value unchanged. Bits 5 to 0: These bits read as zero and cannot be modified. Flag Register (00Bh) 12 BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 BIT 2 BIT 1 BIT 0 OSF WF 0 0 0 0 0 0 ____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 BIT 2 BIT 1 BIT 0 EOSC 0 0 0 0 0 WDE WD/RST Control Register (00Ch) Bit 7: Enable Oscillator (EOSC). When set to logic 0, the oscillator is started. When set to logic 1, the oscillator is stopped when the DS1388 switches to battery power. This setting can be used to conserve battery power when timekeeping operation is not required. This bit is cleared (logic 0) when power is first applied. When the DS1388 is powered by VCC, the oscillator is always on regardless of the status of the EOSC bit. The clock can be halted whenever the timekeeping functions are not required, which minimizes VBAT current (IBACKUPDR). Bits 6 to 2: These bits read as zero and cannot be modified. Bit 1: Watchdog Enable (WDE). When set to logic one, the watchdog counter is enabled. When set to logic 0, the watchdog counter is disabled, and the two registers can be used as NV RAM. This bit is cleared (logic 0) when power is first applied. Bit 0: Watchdog Reset (WD/RST). This bit enables the watchdog alarm output to drive the RST pin. When the WD/RST bit is set to logic 1, RST pulses low for tRST if WDE = 1 and the watchdog counter reaches zero. When the WD/RST bit is set to logic 0, the RST pin is not driven by the watchdog alarm; only the watchdog flag bit (WF) in the flag register is set to logic 1. This bit is logic 0 when power is first applied. Trickle-Charge Register (00Ah) The simplified schematic of Figure 5 shows the basic components of the trickle charger. The trickle-charge select (TCS) bits (bits 4-7) control the selection of the trickle charger. To prevent accidental enabling, only a pattern on 1010 enables the trickle charger. All other patterns disable it. The trickle charger is disabled when power is first applied. The diode-select (DS) bits (bits 2 and 3) select whether or not a diode is connected between VCC and VBACKUP. If DS is 01, no diode is selected, yet if DS is 10, a diode is selected. The ROUT bits (bits 0 and 1) select the value of the resistor connected between VCC and VBACKUP. Table 3 shows the resistor selected by the resistor select (ROUT) bits and the diode selected by the diode-select (DS) bits. Warning: The ROUT value of 250 must not be selected whenever VCC is greater than 3.63V. The user determines the diode and resistor selection according to the maximum current desired for battery or super cap charging. The maximum charging current can be calculated as illustrated in the following example. Assume that a system power supply of 3.3V is applied to V CC and a super cap is connected to VBACKUP. Also, assume that the trickle charger has been enabled with a diode and resistor R2 between VCC and VBACKUP. The maximum current IMAX would be calculated as follows: IMAX = (3.3V - diode drop) / R2 (3.3V - 0.7V) / 2k 1.3mA As the super cap charges, the voltage drop between VCC and VBACKUP decreases and therefore the charge current decreases. Table 3. Trickle-Charge Register TCS3 TCS2 TCS1 TCS0 DS1 DS0 ROUT1 ROUT0 X X X X 0 0 X X FUNCTION X X X X 1 1 X X Disabled X X X X X X 0 0 Disabled 1 0 1 0 0 1 0 1 No diode, 250 resistor 1 0 1 0 1 0 0 1 One diode, 250 resistor 1 0 1 0 0 1 1 0 No diode, 2k resistor 1 0 1 0 1 0 1 0 One diode, 2k resistor 1 0 1 0 0 1 1 1 No diode, 4k resistor 1 0 1 0 1 0 1 1 One diode, 4k resistor 0 0 0 0 0 0 0 0 Initial default value--disabled Disabled ____________________________________________________________________ 13 DS1388 Control Register (00Ch) DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM TRICKLE-CHARGE REGISTER (00Ah) BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 BIT 2 TCS3 TCS2 TCS1 TCS0 DS1 DS0 1 0F 16 SELECT NOTE: ONLY 1010b ENABLES CHARGER BIT 1 BIT 0 ROUT1 ROUT0 1 OF 2 SELECT TCS0-3 = TRICKLE-CHARGE SELECT DS0-1 = DIODE SELECT ROUT0-1 = RESISTOR SELECT 1 OF 3 SELECT R1 250 R2 2k VCC VBACKUP R3 4k Figure 5. Programmable Trickle Charger EEPROM The DS1388 provides 512 bytes of EEPROM organized into two blocks of 256 bytes. Each 256-byte block is divided into 32 pages consisting of 8 bytes per page. The EEPROM can be written one page at a time. Page write operations are limited to writing bytes within a single physical page, regardless of the number of bytes actually being written. Physical page boundaries start at addresses that are integer multiples of the page size (8 bytes) and end at addresses that are integer multiples of [page size -1]. For example, page 0 contains word addresses 00h to 07h. Similarly, page 1 contains word addresses 08h to 0Fh. If a page write command attempts to write across a physical page boundary, the result is that the data wraps around to the beginning of the current page (overwriting data previously stored there), instead of being written to the next page as might be expected. Therefore, it is necessary for the application software to prevent page write operations that would attempt to cross a page boundary. I2C Serial Data Bus The DS1388 supports a bidirectional I2C bus and data transmission protocol. A device that sends data onto the bus is defined as a transmitter and a device receiving data is defined as a receiver. The device that controls the message is called a master. The devices that are controlled by the master are slaves. The bus must be controlled by a master device that generates the serial clock (SCL), controls the bus access, and generates the START and STOP conditions. The DS1388 14 operates as a slave on the I2C bus. Connections to the bus are made through the open-drain I/O lines SDA and SCL. Within the bus specifications, a standard mode (100kHz maximum clock rate) and a fast mode (400kHz maximum clock rate) are defined. The DS1388 works in both modes. The following bus protocol has been defined (Figure 6): * Data transfer can be initiated only when the bus is not busy. * During data transfer, the data line must remain stable whenever the clock line is high. Changes in the data line while the clock line is high will be interpreted as control signals. Accordingly, the following bus conditions have been defined: Bus not busy: Both data and clock lines remain high. Start data transfer: A change in the state of the data line from high to low, while the clock line is high, defines a START condition. Stop data transfer: A change in the state of the data line from low to high, while the clock line is high, defines a STOP condition. Data valid: The state of the data line represents valid data when, after a START condition, the data line is stable for the duration of the high period of the clock signal. The data on the line must be changed during the low period of the clock signal. There is one clock pulse per bit of data. ____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM Figures 7 and 8 detail how data transfer is accomplished on the I2C bus. Depending upon the state of the R/W bit, two types of data transfer are possible: Data transfer from a master transmitter to a slave receiver. The first byte transmitted by the master is the slave address. Next follows a number of data bytes. The slave returns an acknowledge bit after each received byte. Data are transferred with the most significant bit (MSB) first. Data transfer from a slave transmitter to a master receiver. The first byte (the slave address) is transmitted by the master. The slave then returns an acknowledge bit. Next follows a number of data bytes transmitted by the slave to the master. The master returns an acknowledge bit after all received bytes other than the last byte. At the end of the last received byte, a NACK is returned. Acknowledge: Each receiving device, when addressed, is obliged to generate an acknowledge (ACK) after the reception of each byte. The master device must generate an extra clock pulse, which is associated with this acknowledge bit. The DS1388 does not generate any acknowledge bits if access to the EEPROM is attempted during an internal programming cycle. A device that acknowledges must pull down the SDA line during the acknowledge clock pulse in such a way that the SDA line is stable low during the high period of the acknowledge-related clock pulse. Of course, setup and hold times must be taken into account. A master must signal an end of data to the slave by generating a not-acknowledge (NACK) bit on the last byte that has been clocked out of the slave. In this case, the slave must leave the data line high to enable the master to generate the STOP condition. MSB FIRST MSB The master device generates all the serial clock pulses and the START and STOP conditions. A transfer is ended with a STOP condition or with a repeated START condition. Since a repeated START condition is also the beginning of the next serial transfer, the bus is not released. Data are transferred with the most significant bit (MSB) first. LSB MSB LSB SDA SLAVE ADDRESS SCL 1-7 IDLE START CONDITION R/W 8 ACK 9 DATA 1-7 ACK 8 REPEATED IF MORE BYTES ARE TRANSFERRED 9 DATA 1-7 ACK/ NACK 8 9 STOP CONDITION REPEATED START Figure 6. I2C Data Transfer Overview ____________________________________________________________________ 15 DS1388 Each data transfer is initiated with a START condition and terminated with a STOP condition. The number of data bytes transferred between the START and the STOP conditions is not limited, and is determined by the master device. The information is transferred byte-wise and each receiver acknowledges with a ninth bit. DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM Device Addressing The slave address byte is the first byte received following the START condition from the master device. The slave address byte consists of a 4-bit control code. For the DS1388, this is set as 1101 binary for read and write operations. The next three bits of the slave address byte are the block select bits (B2, B1, B0). B2 is always logic 0 for the DS1388. These bits are used by the master device to select which of the three blocks in the memory map are to be accessed. These bits are the three most significant bits of the word address. The last bit of the slave address byte defines the operation to be performed. When set to 1, a read operation is selected; when set to 0, a write operation is selected. Write Operation Slave Receiver Mode (Write Mode) Following the START condition from the master, the device code (4 bits); the block address (3 bits); and the R/W bit, which is logic-low, is placed onto the bus by the master transmitter. This indicates to the DS1388 that a byte with a word address follows after the DS1388 has generated an acknowledge bit during the ninth clock cycle. The next byte transmitted by the master is the word address and will set the internal address pointer of the DS1388, with the DS1388 acknowledging the transfer on the ninth clock cycle. The master device can then transmit zero or more bytes of data, with the DS1388 acknowledging the transfer on the ninth clock cycle. The master generates a STOP condition to terminate the data write. Byte Write The write-slave address byte and word address are transmitted to the DS1388 as described in the Slave Receiver Mode section. The master transmits one data byte, with the DS1388 acknowledging the transfer on the ninth clock cycle. The master then generates a STOP condition to terminate the data write. This initiates the internal write cycle, and, if the write was to the EEPROM, the DS1388 does not generate acknowledge signals during the internal EEPROM write cycle. EEPROM Page Write The write-slave address byte, word address, and the first data byte are transmitted to the DS1388 in the same way as in a byte write. But instead of generating a STOP condition, the master transmits up to 8 data bytes to the DS1388, which are temporarily stored in the on-chip page buffer and are written into the memory after the master has transmitted a STOP condition. Data bytes within the page that are not written remain unchanged. The internal address pointer automatically increments after each byte is written. If the master should transmit more than 8 data bytes prior to generating the STOP condition, the address pointer rolls over and the previously received data is overwritten. As with the byte write operation, once the STOP condition is received an internal write cycle begins. RTC Multibyte Write Writing multiple bytes to the RTC works much the same way as the EEPROM page write, except that the entire contents of block 0h can be written at once. The 8-byte page size limitation does not apply to the block 0. If the master should transmit more bytes than exists in block 0 prior to generating the STOP condition, the internal address pointer rolls over and the previously received data is overwritten. As with the byte write operation, once the STOP condition is received an internal write cycle begins. Slave Address Byte 16 BIT 7 BIT 6 BIT 5 BIT 4 BIT 3 BIT 2 BIT 1 BIT 0 1 1 0 1 B2 B1 B0 R/W OPERATION CONTROL CODE BLOCK SELECT Read Clock 1101 000 R/W 1 Write Clock 1101 000 0 Read Lower Block of EEPROM 1101 001 1 Write Lower Block of EEPROM 1101 001 0 Read Upper Block of EEPROM 1101 010 1 Write Upper Block of EEPROM 1101 010 0 ____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM Since the DS1388 does not acknowledge during an EEPROM write cycle, acknowledge polling can be used to determine when the cycle is complete (this feature can be used to maximize bus throughput). Once the master issues the STOP condition for a write command, the DS1388 initiates the internally timed write cycle. ACK polling can be initiated immediately. This involves the master sending a START condition, followed by the slave address byte for a write command (R/W = 0) to the EEPROM. If the device is still busy with the write cycle, then a NACK is returned. If the cycle is complete, then the device returns the ACK and the master can then proceed with the next read or write command. The RTC registers in block 0 are accessible during an EEPROM write cycle. Read Operation Read operations are initiated in the same way as write operations with the exception that the R/W bit of the slave address is set to 1. There are three basic types of read operations: current address read, random read, and sequential read. Current Address Read The DS1388 contains an address pointer that maintains the last address accessed, internally incremented by 1. Therefore, if the previous access (either a read or write operation) was to address n, the next current address read operation would access data from address n + 1. Upon receipt of the slave address with the R/W bit set to 1, the DS1388 issues an acknowledge and transmits the 8-bit data byte. The master issues a NACK followed by a STOP condition, and the DS1388 discontinues transmission. <SLAVE ADDRESS> S 1101000 <R/W> 0 A <WORD ADDRESS (n)> XXXXXXXX Random Read Random read operations allow the master to access any memory location in a random manner. To perform this type of read operation, first the word address must be set. This is done by sending the word address to the DS1388 as part of a write operation. After the word address is sent, the master generates a START condition following the acknowledge. This terminates the write operation, but not before the internal address pointer is set. Then the master issues the slave address byte again but with the R/W bit set to 1. The DS1388 then issues an acknowledge and transmits the 8-bit data byte. The master issues a NACK followed by a STOP condition, and the DS1388 discontinues transmission. Sequential Read Sequential reads are initiated in the same way as a random read except that after the DS1388 transmits the first data byte, the master issues an acknowledge as opposed to a STOP condition in a random read. This directs the DS1388 to transmit the next sequentially addressed 8-bit byte. To provide sequential reads, the DS1388 contains an internal address pointer, which is incremented by one at the completion of each operation. This allows the entire memory contents of the block specified in the slave address to be serially read during one operation. The master terminates the read by generating a NACK followed by a STOP condition. No page boundaries exist for read operations. When the address pointer reaches the end of an EEPROM block (FFh), the address pointer wraps to the beginning (00h) of the same block. The DS1388 can operate in the two modes illustrated in Figures 7 and 8. <DATA (n)> A S - START SLAVE TO MASTER A - ACKNOWLEDGE (ACK) P - STOP R/W - READ/WRITE OR DIRECTION BIT ADDRESS XXXXXXXX <DATA (n + 1)> A XXXXXXXX <DATA (n + X) A ... XXXXXXXX A P MASTER TO SLAVE DATA TRANSFERRED (X + 1 BYTES + ACKNOWLEDGE) Figure 7. Data Write--Slave Receiver Mode ____________________________________________________________________ 17 DS1388 Acknowledge Polling DS1388 I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM <SLAVE ADDRESS> S 1101BBB <R/W> <DATA (n)> 1 XXXXXXXX A <DATA (n + 1)> A B - BLOCK SELECT MASTER TO SLAVE S - START A - ACKNOWLEDGE (ACK) P - STOP A - NOT ACKNOWLEDGE (NACK) R/W - READ/WRITE OR DIRECTION BIT ADDRESS <DATA (n + 2)> XXXXXXXX A <DATA (n + X)> XXXXXXXX A ... XXXXXXXX A P SLAVE TO MASTER DATA TRANSFERRED (X + 1 BYTES + ACKNOWLEDGE) NOTE: LAST DATA BYTE IS FOLLOWED BY A NACK. Figure 8. Data Read--Slave Transmitter Mode <SLAVE ADDRESS> <R/W> S 1101BBB 0 <DATA (n)> XXXXXXXX <WORD ADDRESS (n)> A XXXXXXXX A <DATA (n + 1)> A XXXXXXXX <SLAVE ADDRESS (n)> <R/W> Sr 1101BBB 1 A <DATA (n + 2)> A B - BLOCK SELECT MASTER TO SLAVE S - START Sr - REPEATED START A - ACKNOWLEDGE (ACK) P - STOP A - NOT ACKNOWLEDGE (NACK) R/W - READ/WRITE OR DIRECTION BIT ADDRESS XXXXXXXX <DATA (n + X)> A ... XXXXXXXX A P SLAVE TO MASTER DATA TRANSFERRED (X + 1 BYTES + ACKNOWLEDGE) NOTE: LAST DATA BYTE IS FOLLOWED BY A NACK. Figure 9. Data Write/Read (Write Pointer, Then Read)--Slave Receive and Transmit Chip Information SUBSTRATE CONNECTED TO GROUND PROCESS: CMOS 18 Package Information For the latest package outline information and land patterns, go to www.maxim-ic.com/packages. Note that a "+", "#", or "-" in the package code indicates RoHS status only. Package drawings may show a different suffix character, but the drawing pertains to the package regardless of RoHS status. PACKAGE TYPE PACKAGE CODE OUTLINE NO. LAND PATTERN NO. 8 SO S8+4 21-0041 90-0096 ____________________________________________________________________ I2C RTC/Supervisor with Trickle Charger and 512 Bytes EEPROM REVISION NUMBER REVISION DATE 0 4/05 DESCRIPTION Initial release. -- Removed the leaded parts from the Ordering Information. 1 Indicated the pullup voltage for SDA and SCL in the Pin Description table. Added the oscillator bias circuit to the Block Diagram and removed the original Figure 1 9/08 3 10/09 8/10 8 8, 10 Added time and date POR values in the Power Control section. 9 Changed the last sentence of the Watchdog Alarm Counter section (first paragraph) to "When the counter is read, the current counter value is latched into a register, which is output on the serial data line and the watchdog counter reloads the seed value." 12 Added "Access is inhibited whenever RST is low." To the end of the Power-Up/Down, Reset, and Pushbutton Reset Functions section (first paragraph). 12 In the Control Register (00Ch) section, bit 7 description, added a statement that EOSC is used to reduce VBAT current when timekeeping is not required. 13 Replaced the I2C read and write figures. 2 PAGES CHANGED 17, 18 Corrected the RTC power-on default values in the Power Control section. 9 Corrected the date register range in Figure 4. 11 Added WF flag clear to the Watchdog Alarm Counter section. 12 In the Absolute Maximum Ratings section, added the thermal information, lead information, and new Note 1, and updated the soldering information. 2-6 In the Pin Description, corrected X2 pin name and bias limit on SDA, SCL. 8 Added the package code and land pattern no. to the Package Information table. 18 Maxim cannot assume responsibility for use of any circuitry other than circuitry entirely embodied in a Maxim product. No circuit patent licenses are implied. Maxim reserves the right to change the circuitry and specifications without notice at any time. Maxim Integrated Products, 120 San Gabriel Drive, Sunnyvale, CA 94086 408-737-7600 ____________________ 19 (c) 2010 Maxim Integrated Products Maxim is a registered trademark of Maxim Integrated Products, Inc. is a registered trademark of Maxim Integrated Products, Inc. DS1388 Revision History