Rockwell Automation Allen-Bradley ControlLogix 1756-MVI User manual

ControlLogix
Multi-Vendor
Interface Module
1756-MVI
Programming Reference
Manual

Important User Information
Because of the variety of uses for the products described in this
publication, those responsible for the application and use of this
control equipment must satisfy themselves that all necessary steps
have been taken to assure that each application and use meets all
performance and safety requirements, including any applicable laws,
regulations, codes and standards.
The illustrations, charts, sample programs and layout examples shown
in this guide are intended solely for purposes of example. Since there
are many variables and requirements associated with any particular
installation, Allen-Bradley does not assume responsibility or liability
(to include intellectual property liability) for actual use based upon
the examples shown in this publication.
Allen-Bradley publication SGI-1.1, Safety Guidelines for the
Application, Installation and Maintenance of Solid-State Control
(available from your local Allen-Bradley office), describes some
important differences between solid-state equipment and
electromechanical devices that should be taken into consideration
when applying products such as those described in this publication.
Reproduction of the contents of this copyrighted publication, in whole
or part, without written permission of Rockwell Automation, is
prohibited.
Throughout this manual we use notes to make you aware of safety
considerations:
Attention statements help you to:
•identify a hazard
•avoid a hazard
•recognize the consequences
Allen-Bradley and ControlLogix are trademarks of Rockwell Automation.
Borland C++ is a trademark of Borland Corporation.
Microsoft C++, Windows 95/98, and Windows NT are trademarks of Microsoft Corporation.
ATTENTION
!
Identifies information about practices or
circumstances that can lead to personal injury or
death, property damage or economic loss
IMPORTANT Identifies information that is critical for successful
application and understanding of the product.

European Communities (EC)
Directive Compliance
If this product has the CE mark it is approved for installation within
the European Union and EEA regions. It has been designed and
tested to meet the following directives.
EMC Directive
This product is tested to meet the Council Directive 89/336/EC
Electromagnetic Compatibility (EMC) by applying the following
standards, in whole or in part, documented in a technical
construction file:
•EN 50081-2 EMC — Generic Emission Standard, Part 2 —
Industrial Environment
•EN 50082-2 EMC — Generic Immunity Standard, Part 2 —
Industrial Environment
This product is intended for use in an industrial environment.
Low Voltage Directive
This product is tested to meet Council Directive 73/23/EEC Low
Voltage, by applying the safety requirements of EN 61131-2
Programmable Controllers, Part 2 - Equipment Requirements and
Tests. For specific information required by EN 61131-2, see the
appropriate sections in this publication, as well as the Allen-Bradley
publication Industrial Automation Wiring and Grounding Guidelines
For Noise Immunity, publication 1770-4.1.
This equipment is classified as open equipment and must be
mounted in an enclosure during operation to provide safety
protection.

1Publication 1756-RM004B-EN-P - October 2000
Preface
About This Reference Manual
Introduction
This reference manual provides information needed to develop
application programs for the 1756-MVI ControlLogix Multi-Vendor
Interface Module. The 1756-MVI module allows access through the
ControlLogix platform to devices with a serial port. The MVI module is
user programmable to accommodate devices with unique serial
protocols.
This manual contains the available software API (Application
Programming Interface) libraries and tools, module configuration and
programming information, and example code.
Audience
This manual is intended for control engineers and technicians who are
installing, programming, and maintaining a control system that
includes a 1756-MVI module.
We assume that you:
•are familiar with software development in the 16-bit DOS
environment using the C programming language.
•are familiar with Allen-Bradley programmable controllers and
the ControlLogix platform.
Common Techniques Used
in this Manual
The following conventions are used throughout this manual:
•Bulleted lists provide information, not procedural steps.
•Numbered lists provide sequential steps.
•Information in bold contained within text identifies menu
windows, or screen options, screen names, and areas of the
screen.
•Change bars in the left margin of the page indicate material that
is new to this revision.

Publication 1756-RM004B-EN-P - October 2000
P-2 About This Reference Manual
Contents
This programming reference manual contains the following chapters:
References
For additional information refer to the following publications:
•ControlLogix 1756-MVI Multi-Vendor Interface Module
Installation Instructions, publication number1756-1N001A-US-P
•General Software Embedded DOS 6-XL Developer’s Guide 1.2
•Introduction to ControlLogix Module Development, CID#X1557
Screen captures are pictures of the software’s actual
screens and windows. The names of screen buttons and
fields are often in bold in the text of a procedure.
The “MORE” icon is placed beside any paragraph that
references sources of additional information outside of this
document.
More
2
1
3
Application
Development
Overview
4CIP Messaging
Serial Port API
5
1756-MVI Module
Overview
MVI Backplane API Programming the MVI
Module
6
More

Publication 1756-RM004B-EN-P - October 2000
About This Reference Manual P-3
Definitions of Terms
Used in this Manual
Rockwell Automation
Support
Rockwell Automation offers support services worldwide, with over 75
sales/support offices, 512 authorized distributors, and 260 authorized
systems integrators located throughout the United States alone, plus
Rockwell Automation representatives in every major country in the
world.
Local Product Support
Contact your local Rockwell Automation representative for:
•sales and order support
•product technical training
•warranty support
•support service agreements
Technical Product Assistance
If you need to contact Rockwell Automation for technical assistance,
call your local Rockwell Automation representative, or call Rockwell
directly at: 1 440 646-6800.
For presales support, call 1 440 646-3NET.
This term Means
API Application Programming Interface.
Backplane The electrical interface, or bus, to which modules connect when inserted
into the rack. The 1756-MVI module communicates with the control
processor(s) through the ControlLogix backplane (a.k.a. ControlBus).
BIOS Basic Input Output System. The BIOS firmware initializes the module at
power-on, performs self-diagnostics, and provides a DOS compatible
interface to the console and Flash ROM disk.
CIP Control and Information Protocol. This is the messaging protocol used for
communications over the ControlLogix backplane. See the ControlNet
Specification for details.
Connection A logical binding between two objects. A connection allows more efficient
use of bandwidth, since the message path is not included once the
connection is established.
Consumer A destination for data.
Library The library file containing the API functions. The library must be linked with
the developer’s application code to create the final executable program.
Originator A client that establishes a connection path to a target.
Producer A source of data.
Target The end-node to which a connection is established by an originator.

Publication 1756-RM004B-EN-P - October 2000
P-4 About This Reference Manual
You can obtain technical assistance online from the following
Rockwell Automation WEB sites:
•www.ab.com/mem/technotes/kbhome.html (knowledge base)
•www.ab.com/networks/eds (electronic data sheets)
Your Questions or Comments about This Manual
If you find a problem with this manual, please notify us of it on the
enclosed Publication Problem Report (at the back of this manual).
If you have any suggestions about how we can make this manual
more useful to you, please contact us at the following address:
Rockwell Automation, Allen-Bradley Company, Inc.
Control and Information Group
Technical Communication
1 Allen-Bradley Drive
Mayfield Heights, OH 44124-6118

iPublication 1756-RM004B-EN-P - October 2000
Table of Contents
Chapter 1
1756-MVI Module Overview
What This Chapter Contains . . . . . . . . . . . . . . . . . . . . . . . 1-1
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
LED Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Configuration Jumpers . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
System Firmware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
BIOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
BIOS Console Services . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
BIOS Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Operating System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Chapter 2
Application Development
Overview
What This Chapter Contains . . . . . . . . . . . . . . . . . . . . . . . 2-2
API Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Calling Convention . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Header Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Sample Application Code . . . . . . . . . . . . . . . . . . . . . . . 2-3
Multithreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Development Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Chapter 3
MVI Backplane API
What This Chapter Contains . . . . . . . . . . . . . . . . . . . . . . . 3-1
MVI API Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
MVI Backplane API Architecture . . . . . . . . . . . . . . . . . . . . 3-2
MVI Backplane API Functions . . . . . . . . . . . . . . . . . . . . . . 3-5
Initialization Functions . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Direct I/O Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Miscellaneous Functions. . . . . . . . . . . . . . . . . . . . . . . . 3-20
Chapter 4
CIP Messaging API
What This Chapter Contains . . . . . . . . . . . . . . . . . . . . . . . 4-1
CIP Messaging API Files . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
CIP API Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Backplane Device Driver. . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
CIP API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Initialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Object Registration. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Connected Data Transfer . . . . . . . . . . . . . . . . . . . . . . . 4-10
Callback Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Special Callback Registration . . . . . . . . . . . . . . . . . . . . 4-25
Miscellaneous Functions. . . . . . . . . . . . . . . . . . . . . . . . 4-28

Publication 1756-RM004B-EN-P - October 2000
Table of Contents ii
Chapter 5
Serial Port API
What This Chapter Contains . . . . . . . . . . . . . . . . . . . . . . . 5-1
Serial API Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Serial Data Transfer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Serial Port API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Initialization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Port Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Miscellaneous Functions. . . . . . . . . . . . . . . . . . . . . . . . 5-35
Chapter 6
Programming the MVI Module
What This Chapter Contains . . . . . . . . . . . . . . . . . . . . . . . 6-1
ROM Disk Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
CONFIG.SYS File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Command Interpreter. . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Sample ROM Disk Image . . . . . . . . . . . . . . . . . . . . . . . 6-3
Creating a ROM Disk Image . . . . . . . . . . . . . . . . . . . . . . . 6-4
Using DISKIMAG: DOS Disk Image Builder . . . . . . . . . 6-4
Using WINIMAGE: Windows Disk Image Builder . . . . . 6-6
Downloading a ROM Disk Image. . . . . . . . . . . . . . . . . . . . 6-8
MVI Flash Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Using the MVI Flash Update Utility . . . . . . . . . . . . . . 6-8
MVIUPDAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Booting from the C: (Compact Flash) Drive . . . . . . . . . . . . 6-11
Index