SSCI HSS8, HSS4NG User Manual
C
CI
I
ommunications
omputer ntelligence
ntegration
CCII Systems (Pty) Ltd Registration No. 1990/005058/07
User Manual
for the
4-Channel New Generation
and
8-Channel High-Speed Serial I/O Adapters
Windows NT 4 Software Driver
C²I² Systems Document No.
CCII/HSS8/6-MAN/004
Document Issue
1.2
Issue Date
2009-08-31
Print Date
2009-09-03
File Name
W:\HSS8\TECH\MAN\CH8MAN04.WPD
Distribution List No.
© C²I² Systems The copyright of this document is the property of C²I² Systems. The document is issued for the sole
purpose for which it is supplied, on the express terms that it may not be copied in whole or part, used by
or disclosed to others except as authorised in writing by C²I² Systems.
Document prepared by C²I² Systems, Cape Town
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page ii of vii
Signature Sheet
Name Signature Date
Completed by
Project Engineer
Board Level Products
C²I² Systems
Accepted by
Project Manager
Board Level Products
C²I² Systems
Accepted by
Quality Assurance
C²I² Systems
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page iii of vii
Amendment History
Issue Description Date ECP No.
0.1 First draft. 2005-09-26 -
1.0 Updated after review by WRM. 2005-10-20 -
1.1 Implemented ECP, references to adapters made more generic. 2006-06-29 CCII/HSS8/6-ECP/026
1.2 Improve document naming consistency. 2009-08-31 CCII/HSS8/6-ECP/042
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page iv of vii
Contents
1. Scope ...................................................................1
1.1 Identification .........................................................................1
1.2 Introduction .........................................................................1
2. Applicable and Reference Documents .........................................2
2.1 Applicable Documents.................................................................2
2.2 Reference Documents.................................................................2
3. Configuration Procedure ....................................................3
3.1 Installing the Software Driver Files .......................................................3
3.2 Special Instructions for Windows 2000 or XP ...............................................3
3.3 Uninstalling the Software Driver..........................................................4
3.4 Updating the Device Firmware ...........................................................4
3.5 Using the Event Viewer ................................................................5
4. Application Program Interface (API) ..........................................6
4.1 Windows SDK Serial Functions ..........................................................6
4.2 Windows SDK Serial Structures .........................................................6
4.3 Function Limitations...................................................................6
4.3.1 ClearCommError ..............................................................6
4.3.2 GetCommMask ................................................................6
4.3.3 SetCommMask ................................................................6
4.3.4 WaitCommEvent...............................................................7
4.3.5 Overlapped Writes .............................................................7
4.3.6 FlushFileBuffers ...............................................................7
4.4 Structure Limitations ..................................................................7
4.4.1 COMMCONFIG ...............................................................7
4.4.2 COMMPROP .................................................................7
4.4.3 COMMTIMEOUTS .............................................................7
4.4.4 COMSTAT ...................................................................7
4.4.5 DCB ........................................................................7
5. HSS8 Windows NT 4 Software Driver Protocol Settings ..........................8
5.1 Protocol Selection ....................................................................8
5.2 Using the Control Panel to Change Channel Settings .........................................8
5.3 Using the Control Panel to Obtain the Current Version Information ..............................9
5.4 UART Mode........................................................................10
5.4.1 UART Protocol Information......................................................11
5.5 HDLC Mode........................................................................14
5.5.1 HDLC Protocol Information Members..............................................15
5.5.2 Preamble Requirements ........................................................17
5.6 BISYNC Mode ......................................................................18
5.6.1 BISYNC Protocol Information Members............................................19
5.7 SMC UART Mode ...................................................................23
5.7.1 SMC UART Protocol Information Members .........................................23
6. Getting Started ...........................................................25
6.1 Normal Write Operation...............................................................25
6.2 Overlapped Read Operation ...........................................................25
7. Contact Details ...........................................................26
7.1 Contact Person .....................................................................26
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page v of vii
7.2 Physical Address ....................................................................26
7.3 Postal Address......................................................................26
7.4 Voice and Electronic Contacts ..........................................................26
7.5 Product Support .....................................................................26
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page vi of vii
List of Illustrations
Figure 1 : Installation Wizard ..................................................................4
Figure 2 : Applet Icon........................................................................8
Figure 3 : Driver Information Dialogue ...........................................................9
Figure 4 : UART Dialogue ...................................................................10
Figure 5 : UART Advanced Dialogue ...........................................................10
Figure 6 : HDLC Dialogue ...................................................................14
Figure 7 : HDLC Advanced Dialogue ...........................................................14
Figure 8 : BISYNC Dialogue .................................................................18
Figure 9 : BISYNC Advanced Dialogue .........................................................18
Figure 10 : SMC Dialogue ...................................................................23
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page vii of vii
Abbreviations and Acronyms
API Application Program Interface
bit/s bit per second
BIT Built-in Test
BRG Baud Rate Generator
HAL Hardware Abstraction Layer
HDD Hard Diskdrive
HDLC High Level Data Link Control
HSS High-Speed Serial (Acronym for the C²I² Serial I/O Adapter project)
HSS8 8-Channel High-Speed Serial I/O Adapter
I/O Input / Output
ISA Industry Standard Architecture
MSDN Microsoft Developer Network
PC Personal Computer
PCI Peripheral Component Interconnect
PMC Peripheral Component Interconnect Mezzanine Card
PnP Plug and Play
SCC Serial Communications Controller
SDK Software Development Kit
SDLC Synchronous Data Link control
SIO Serial Input / Output
SMC Serial Management Controller
UART Universal Asynchronous Receiver/Transmitter
WDM Windows Driver Model
WMI Windows Management Instrumentation
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page 1 of 26
1. Scope
1.1 Identification
This document is the user manual for the HSS8 Windows NT 4 Software Driver for the C²I² Systems 8-Channel
High-Speed Serial I/O (HSS8) Adapter and the 4-Channel New Generation High-Speed Serial Adapter
(HSS4NG). The HSS4NG is based on a stripped down HSS8 Adapter and as such this manual applies, except
that only SCC channels 1 - 4 and SMC channels 9 - 10 will be available.
1.2 Introduction
The HSS8 Adapter provides eight channels of simultaneous, high-speed, bi-directional serial communications
and an additional four channels of lower-speed serial communications. The eight high-speed channels are
jumper configurable (on a per channel basis) for RS-232 or RS-422/485 drivers while the lower-speed channels
have RS-232 drivers only.
The HSS8 Windows NT 4 software driver is a low level, device-dependent interface for transferring data over
a C²I² Systems HSS8 Adapter. The HSS8 Windows NT 4 Software Driver binaries are provided with explicit
installation instructions.
The HSS8 Windows NT 4 Software Driver will also run as a legacy software driver under Windows 2000 or XP,
but does not support Plug and Play (PnP), Windows Management Instrumentation (WMI) or power
management.
The HSS8 Windows NT 4 Software Driver distribution consists of (at least) the following files :
ccHss8NTvXYZ.zip An archive file containing all the files required for the
HSS8 Windows NT 4 Software Driver installation.
XYZ is the revision number for this HSS8 Windows NT 4
Software Driver release.
Setup.exe Install wizard application extracting the following files to
the desired locations :
hss8nt.sys HSS8 Windows NT 4 Software Driver.
hss8.cpl Control panel applet.
flashprog.exe Flash update application.
hssReadme.txt General information.
hssRelease_notes.txt Release notes and revision history. Please check this file
for information on the latest updates.
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page 2 of 26
2. Applicable and Reference Documents
2.1 Applicable Documents
2.1.1 Motorola, MPC8260 PowerQUICC II Family Reference Manual, MPC8260UM/D Rev. 1, dated May 2003.
2.1.2 CCII/HSS8/6-MAN/001, Hardware Reference Manual for the 4-Channel New Generation and 8-Channel
High-Speed Serial I/O Adapters.
2.1.3 DI-IPSC-81443, Data Item Description for a Software User Manual.
2.1.4 MSDN Communication Resources, http://msdn.microsoft.com/en-us/library/aa363196(VS.85).aspx
.
2.2 Reference Documents
None.
CCII/HSS8/6-MAN/004 2009-08-31 Issue 1.2
CH8MAN04.WPD
Page 3 of 26
3. Configuration Procedure
This paragraph describes the installation procedure for the HSS8 Windows NT 4 Software Driver.
3.1 Installing the Software Driver Files
Unzip the file “hss8ntvxyz.zip” to any suitable folder on your local PC Hard Disk Drive (HDD). You must have
administrative privileges on the PC. Run the application “Setup.exe” (Figure 1). All the software driver files will
be extracted to the required locations, i.e. the software driver file will be stored in “WINNT\system32\drivers”,
the control panel applet in “WINNT\system32" and the flash update application in “Program Files\C2I2\HSS8”.
As this is not a Windows Driver Model (WDM) driver, Windows 2000 and XP will report device conflicts between
the software driver and an “Unknown PCI bridge” device. This is due to the NT software driver not supporting
plug and play (PnP).
3.2 Special Instructions for Windows 2000 or XP
The software driver can be installed as a legacy software driver under both Windows 2000 and Windows XP.
However, to obtain optimum performance it is recommended that the "Standard PC" Hard Disk Drive (HAL) be
used. For detailed instruction on how to install the "Standard PC" HAL refer to the Microsoft Knowledge Base
articles : KB237556, KB299340 and KB309283.
During the installation of Windows 2000 or XP, press the F5 key when the text "Setup is inspecting..." appears.
Select the "Standard PC" HAL from the list of options.
To change the HAL after installation of Windows 2000 or XP with an ACPI HAL :
(1) Go to the Control Panel.
(2) Click the Administrative Tools icon.
(3) Click the Computer Management icon.
(4) Select "Device Manager".
(5) Expand the Computer node.
(6) Select the ACPI item. Right click and select properties.
(7) Click "Update Driver...".
(8) Select "Display a list of known drivers for this device, so that I can choose a specific driver".
(9) Select "All hardware for this device class".
(10) Select "Standard PC".
When installing under Windows 2000 or XP the "Found New Hardware" wizard will appear. To prevent this
wizard at start-up please install the HSS8 NULL software driver ("Hss8null.inf").
(1) Go to the Control Panel.
(2) Click the Add/Remove Hardware icon.
(3) Select "Add/Troubleshoot a device".
(4) Select "Add a new device".
(5) Select "No, I want to select the hardware from a list".
(6) Select "Multi-channel serial adapters".
(7) Click "Have Disk..."
(8) Click "Browse..."
(9) Select the "Program Files\C2I2\HSS8\hss8null.inf" file.
(10) Click "Finish".
Please note that by default the software driver will not be listed in the Device Manager. To view the adapter,
select View and then “Show hidden devices”. The HSS8 is listed under the “Non-Plug and Play Drivers” node.
Windows will indicate the adapter as an ISA device, this is normal as it is how Windows treats non-PnP drivers.
Loading...