User’s Guide MIIC-102 / PCIe / PCI / PC-CARD / ISA I2C Bus Monitor Plus Version 2.4 Micro Computer Control Corporation www.mcc-us.
The MCC I2C Bus Monitor Plus™ (#MIIC-102) I2C Bus Monitor is a laboratory grade instrument that allows a Windows PC to monitor, analyze, log, and display I2C Bus and derived bus protocol activity. What is new for Version 2.4: C C Windows 7 x64 - Add Windows 7 x64 support. PCI Express (PCIe) Interface - Add PCI Express (PCIe) Interface support. What is new for Version 2.3: C C C C C C C Match/Non-Match Message Data Filter - Message data filter can now display matching, or non-matching, message data.
Copyright© 2010 by Micro Computer Control Corporation. All rights are reserved. No part of this publication may be reproduced by any means without the prior written permission of Micro Computer Control Corporation, PO Box 275, Hopewell, New Jersey 08525 USA. DISCLAIMER: Micro Computer Control Corporation makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose.
Table of Contents System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 System Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 I2C Bus Monitor Plus Software . . . . . . . . . . . . . . . . . . . . . . . . . 4 Installation . . . . . . . . . . . . . . . . .
Connecting to the System Under Test . . . . . . . . . . . . . . . . . 18 I2C Bus Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Trigger In Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Connecting to External Test Equipment . . . . . . . . . . . . . . . . . 19 Trigger Out Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Auxiliary Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File|Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Setup|Interface Board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Setup|Logic Level Threshold . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Setup|Trace Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Setup|Trigger Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Setup|Enable Bit Timing . . . . . . . . . . . . . . . . . . . .
Limited Warranty Micro Computer Control (MCC) Corporation warrants this product against defects in material and workmanship for a period of ninety (90) days from the original date of purchase. This limited warranty is not applicable to: 1. 2. 3. 4. Normal wear and tear. Abuse, unreasonable use, mistreatment or neglect. Damage caused by the equipment or system with which the product is used, or Damage caused by modifications or repair not authorized by MCC.
System Requirements To use the I2C Bus Monitor Plus, your PC must meet the following requirements: C C C C C C C C C Windows-based PC System. Pentium or compatible processor. 4 MB of RAM. 20 MB Free Hard Disk Space. CD Drive. Microsoft Windows (XP (x86), Vista and 7 (x86/x64)). Mouse. VGA or Better Monitor. Interface Card Slot (PCIe 1x, PCI, PC-CARD, or ISA). System Components The I2C Bus Monitor Plus package includes the following components: 1. 2. 3. 4. 5. 6. 7. 8. 9. I2C Bus Monitor Plus Pod.
I2C Bus Monitor Plus (#MIIC-102) 2
Introduction The I2C Bus Monitor Plus (#MIIC-102) is a laboratory grade troubleshooting instrument for the Inter-Integrated Circuit (I2C) Bus developed by Philips Semiconductors. When connected to an I2C Bus and a host computer, the I2C Bus Monitor Plus captures and displays I2C Bus or derived bus protocol communications. The complete I2C Bus Monitor Plus package consists of an external pod, interface card, connecting cables, and Windows based software.
I2C Bus Monitor Plus Software MCC provides both Distribution and Demonstration/Viewer Editions of the I2C Bus Monitor Plus software. The Distribution Edition of the software includes full support to capture and display bus messages. The Distribution Edition is distributed as an integral component of the I2C Bus Monitor Plus package. The Demonstration/Viewer Edition of the software supports the display of bus messages previously recorded in I2C Bus Monitor Plus log files.
Installation WARNING - The instructions that follow require certain technical skills in the field of computer electronics. If you feel that you are not qualified to perform the required setup and installation procedures, we recommend the you seek assistance from a qualified technician. ESD (Electrostatic Discharge) Precautions Electrostatic discharge is defined as the transfer of charge between bodies at different electrical potentials.
Host Computer Grounding Case 1 - Desktop and Single-board Computers. The chassis on a desktop or single-board host computer must be connected to earth ground to comply with safety regulations. If the computer chassis is NOT connected to earth ground for some reason (i.e., use of a two-prong power mains plug), the host computer power supply ground will float to some unknown voltage potential. Case 2 - Laptop Computers. Laptop computers present special ESD problems.
C C C C C Make sure that all interconnections are made BEFORE applying power to the host computer, I2C Bus Monitor, and target system. If you are using a laptop computer or host computer that is NOT connected to mains earth ground, make a hard-wired connection from the host computer (i.e., port connector shell) and the target system ground connector to a common earth ground point. Avoid plugging and unplugging system components while the host computer or target system is powered.
board and InstaCal driver software to access the external pod. 1. Installing the PCIe Card Driver Software Insert the InstaCal CD you received with the I2C Bus Monitor Plus into your DVD/CD-ROM drive. If the driver installer does not start automatically, double-click on the installer (icalsetup.exe) on the CD to begin the installation. Install the InstaCal software by following the instructions on screen.
Installation - PCI Interface Card Version The following instructions apply to installing and configuring the PCI version of the I2C Bus Plus interface card in most PCs. Refer to the manual that accompanied your PC for detailed instructions on installing cards in your PC. The I2C Bus Monitor Plus uses a PCI-DIO24 PCI interface board and InstaCal driver software to access the external pod. 1.
restart your computer to complete the installation. 2. Installing the PCI Card and Driver This board is completely plug and play capable. To install the interface board: 4. Following instructions provided with your computer, turn your computer off, unplug the power, open the case, and insert the PCI-DIO24 board into an available PCI slot. 5. Close your computer up, plug in power, and turn it on. 6. Windows will automatically detect the board as it starts up and will install the driver software.
3. Configuring the PCI Card Configure your interface board by running the InstaCal program via the Start|Programs|Measurement Computing|InstaCal menu. InstaCal will automatically detect the new board. Follow the instructions on screen to complete the board configuration and testing. Installation - PC-CARD Interface Version (XP x86 ONLY) The following instructions apply to installing and configuring the PC-CARD version of the I2C Bus Plus interface card in most PCs.
1. Installing the PC-CARD Driver Software Insert the InstaCal CD you received with the I2C Bus Monitor Plus into your DVD/CD-ROM drive. If the driver installer does not start automatically, double-click on the installer (icalsetup.exe) on the CD to begin the installation. Install the InstaCal software by following the instructions on screen. NOTE: Once the InstaCal software is installed, you must restart your computer to complete the installation. 2.
Installation - ISA Interface Card Version (XP x86 ONLY) The following instructions apply to installing and configuring the ISA version of the I2C Bus Plus interface card in most PCs. Refer to the manual that accompanied your PC for detailed instructions on installing cards in your PC. The I2C Bus Monitor Plus uses a CIO-DIO24 ISA interface board and InstaCal driver software to access the external pod. 1.
NOTE: Once the InstaCal software is installed, you must restart your computer to complete the installation. 2. Setting ISA Card Address Each ISA I/O card installed in a PC uses one or more I/O address locations within your computer's I/O address space. These address locations are used by software running on the PC's processor in communicating with electronics on the card. In order to not interfere with other installed cards in the PC, each card must use unique addresses.
3. Installing the ISA Card To install the interface board: 1. Following instructions provided with your computer, turn your computer off, unplug the power, open the case, and insert the CIO-DIO24 board into any available ISA slot. 2. Close your computer case, plug in power, and turn it on. 4. Configuring the ISA Card Configure your interface board by running the InstaCal program via the Start|Programs|Measurement Computing|InstaCal menu. InstaCal will automatically detect the new board.
Installing - I2C Bus Monitor Plus Software This section covers software installation procedures for the both the Distribution and Demonstration/Viewer Editions of the I2C Bus Monitor Plus software. Installing - Distribution Edition The Distribution Edition of the I2C Bus Monitor Plus software includes full support to capture and display bus messages. This version of the software is distributed as a component of the I2C Bus Monitor Plus package. To install the Distribution Edition: 1.
Download the Demonstration/Viewer Edition of the software from the MCC web site (www.mcc-us.com/BMPlusDemo.htm). Follow the instructions on screen. Connecting Your PC to the Pod The I2C Bus Monitor Plus pod contains the electronic circuitry required to capture and record bus events, and communicate these events with the interface card and software installed in your PC. This section describes how to connect your PC to the I2C Bus Monitor Plus pod. 1.
"Setup|Initialize External Pod" from the main menu. When pod initialization is complete, the Run light on the front of the pod will blink. The pod is now ready to be connected to the system under test and optionally to external test equipment. Proceed to the next section, "Connecting to the System Under Test". Connecting to the System Under Test The I2C Bus Monitor Plus pod includes several ports for connecting the pod to a system under test. These ports include: 1.
2. Trigger In Port The Trigger In port is optionally used to synchronize I2C Bus data collection with an external event. This port is located on the front of the pod, and uses a BNC type connector. Input lines are provided for signal and ground. When Trigger In is enabled with the software Trace Control dialog, data capture begins on the first I2C Bus Start condition after a high to low transition on the Trigger In signal line.
The Trigger Out port is optionally used to synchronize external equipment with I2C Bus events or data match pattern. This port is located on the front of the pod, and uses a BNC type connector. Output lines are provided for signal and ground. When Trigger Out is enabled and configured with the software Trigger Out dialog, a high to low transition on the signal line occurs on: a. b. c. d. e. I2C Bus Start events. I2C Bus Stop events. I2C Bus Acknowledge event. I2C Bus Negative Acknowledge event.
Pin 1 - I2C Bus Data (SDA) Pin 2 - I2C Bus Clock (SCL) Pin 3 - TTL I2C Bus Clock (TSCL) Pin 4 - TTL I2C Bus Data (TSDA) Pin 5 - Ground (GND) Pin 6 - Trigger Out (TOUT) Pin 7 - Trigger In (TIN) Pin 8 - Optional I/O (OIO) Pin 9 - Vcc +5 Output (VOUT) 21
Starting the I2C Bus Monitor Plus Software The best way to get familiar with the I2C Bus Monitor Plus software is to start it up. Even without the interface card installed or external pod connected, you can exercise various product features by loading one of the sample log files included with the product. Viewing Sample Log Files 1. From the Windows Start menu, select Programs|I2C Bus Monitor Plus x.x|I2C Bus Monitor Plus. 2.
Program Controls The I2C Bus Monitor Plus software provides a rich set of features designed to collect, time-stamp, analyze, and display I2C Bus messages. User control of these features is provided by a graphical user interface consisting of Trace Controls, Display Options, Data Protocol selections, Pull-Down Menus, and Pop-Up Menus. Main Screen - HEX Data Protocol The operation of these controls are described below: Trace Controls: Trace - Enter Trace mode.
Halt - Stop display of data and enter Halt mode. Clear - Clear the main display window. Display [Options] None - Disables all message parsing and display activities. Use this option along with “Open Log File for Write” to maximize pod recording memory utilization. Start, Stop, Ack, NAck and R/W - Controls display of I2C events. Start Time, Byte Time, and Bit Rate - Controls display of message timing information. Filtering - Enables Slave Address and Message Data filtering.
Absolute Time Mode Absolute Mode displays timing information from a fixed I2C Bus event. Displayed Start timing is the time since the first I2C Bus Start event. Displayed Byte or Bit timing is the time since the current message I2C Bus Start event. Data Protocols Captured message data can be displayed using several standard protocols. These protocols include: ASCII - Display printable data in ASCII format. HEX - Display data in Hexadecimal format. BIN - Display data in Binary format. (New for V2.
Main Screen - Smart Battery System Protocol Pull-Down Menu Controls: File|Print Setup - Setup printer. File|Print - Print Displayed Data with option to print selected text only. File|Exit - Terminate program. Setup|Interface Board - Displays the Interface Board dialog box. Use the Interface Board dialog box to select the interface board connected to the external pod.
Setup|Logic Level Threshold - Displays the Logic Level Threshold dialog box. Use the Logic Level Threshold dialog box to set the logic level threshold on the I2C Clock and Data lines. Logic levels for TTL (5V Logic), 3.3V Logic, and Custom levels for 0.50V to 2.50V are supported. Setup|Trace Control - Displays the Trace Control dialog box. Use the Trace Control dialog box to set Trace start conditions. Select "Auto Start" to start tracing messages on the first I2C Bus Start event.
Select "Start", "Stop", "Ack", or "Nack" to generate a low pulse on the Trigger Out port each time the selected I2C Bus event occurs. Select "Bit Pattern" to generate a low pulse on the Trigger Out port when the Bit Pattern Data match and Trigger Out Position conditions occurs. Bit Pattern data and Trigger Position selection is provided for the I2C Bus address and first 15 data bytes within a message. Bits may be specified as 0, 1, or Don't Care.
Setup|Enable Bit Timing - Enable collection of I2C Bus Bit Timing information. Bit timing information is available in the "Show Message Timing" pop-up menu described below. Bit Timing causes the external pod to generate a 9 times increase in data, and can result in pod data recording memory overflow on high bandwidth or high speed bus traffic. Setup|Select SBS Revision - Displays the Smart Battery System (SBS) Revision dialog box. Use this dialog box to select the SBS revision used by system components.
[SINGLE BIT VIOLATION 0xXXXX] [SLAVE ADDRESS NACK] [0xXX RESERVED FUNCTION] [READ ONLY ACCESS VIOLATION] [PEC=XX CRC=XX ERR] [PEC ACK ERROR] [PEC NACK ERROR] [MSG TOO LONG] [WRITE ONLY ACCESS VIOLATION] [UNITIALIZED READ OPERATION] [MSG BYTES MISSING] [INVALID REPEATED START ADDRESS] [ALERT RESPONSE READ ONLY ACCESS VIOLATION] For details on the SBS protocol, visit the Smart Battery Implementors Forum at www.sbs-forum.org Setup|Open Log File for Write - Open a log file (*.
that require the pod. Setup|Program Settings|Save/Load/Restore Default - Select this menu item to Save, Load, or Restore Default I2C Bus Monitor Plus software parameters. Setup|System Diagnostics - Select System Diagnostics display system diagnostic data used for product support. Options|Show Hints - Enable display of cursor sensitive help. Options|Set Line Length - Set display line length for message wrap. Options|Set Font - Select display font and size.
Filtering|Slave Address - Displays the Slave Address Map dialog box. (New for V2.3) Use the Slave Address Map dialog box to select I2C messages to display by Slave Address, Read/Write Access, and Slave Device Acknowledgment, and to globally monitor all address activity. Click on grid cells to access Slave Address Filter editor. Slave Address Activity Info shows acknowledged bus messages with a solid dot. Negative acknowledged bus messages with a hollow dot.
Filtering|Message Data - Displays the Message Data Filter dialog box. (New for V2.3) Use the Message Data Filter dialog box to select I2C messages to display by data content and by protocol error detection. Click on a grid cell to enter match data in hexadecimal digits (00...FF), ASCII codes (i.e. 'a for the letter a), or XX for don't care. Enter up to 8 match data per message byte. Click “Match” to display message on Match (Y) or Non-Match (N) condition.
View|Activity Chart - Displays the Activity Chart dialog box. Use the Activity Chart dialog box to display a bar chart of message activity for the top 16 most frequently used slave addresses. View|Message Detail - Displays the Message Detail dialog box. Use the Message Detail dialog box to display a report of message activity for all active slave addresses.
View|Byte Mode Viewer - Displays the Byte Mode Viewer. The main message screen displays filtered I2C messages upon detecting an I2C Bus STOP event at end of message. The Byte Mode Viewer displays unfiltered I2C Bus events as they cross the bus, displaying message data even if the bus stalls within a message. View|Address Alias Table - Displays the Address Alias Table dialog box. Use the Address Alias Table dialog box to specify an alias name for slave addresses.
box. Use the Bus Status Viewer dialog box to view the current voltage levels on the I2C Bus Clock, Data, and A.bV lines. This viewer is useful in determining if the Clock or Data lines are stuck low. Pop-Up Menu Controls: The Pop-Up Menu is used to view details on a specific displayed message. This menu is available on the main screen when displayed I2C Bus messages are present and the system is in Halt mode.
Select the Message Timing menu item to display timing information on the currently selected message. I2C Bus Start/Stop events and Data bytes are displayed. Bit timing data is displayed if "Enable Bit Timing" (see Setup Menu) was enabled when the message data was collected. Show Message Diagnostics Select the Message Diagnostics menu item to display diagnostic data used for product support.
Filename Convention: The I2C Bus Monitor Plus uses a variety of file types to save or record information. These file types include: *.als Address Alias Table File - This file type is used to save Slave Address name aliasing information. *.bps Setup File - This file is used to save software setup parameters. *.dmf Data Match File - This file type is used to save Message Filter match data. *.log Log File - This file type is used to record data packets from the external pod. *.
Direct Comments/Feedback to: Attn: Product Support (#MIIC-102) Micro Computer Control Corporation P.O. Box 275 Hopewell, NJ 08525 USA Voice - (609) 466-1751 Fax - (609) 466-4116 Email - info@mcc-us.com WWW - http://www.mcc-us.
Declaration of Conformity This Declaration of Conformity is issued by the indicated company which is solely responsible for the declared compliance.
