User Manual 4-Channel New Generation 8-Channel
Contents
1. JV Enable RX BCS Enable RX Transparent Mode J Enable Reverse Data Advanced Settings ces um Figure 8 BISYNC Dialogue Min Sync Pairs 16384 L i CRC Select i Sync Character Ox 0000 Syn Length 1 RX Control Character Mask Ox 0000 CRC Constant Preset RX Ox 0000 Preset TX Ox 0000 SYNC register Ox 0000 DLE register Ox 0000 Cancel BISYNC Advanced Settings xj m Control Characters 1 Ox 0000 2 Ox 0002 3 Ox 0000 4 Ox 0000 5 Ox 9000 6 Ox 0000 7 Ox 0000 8 Ox 0000 aaah p 3 Figure 9 BISYNC Advanced Dialogue CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 18 of 26 5 6 1 Baud Rate Clock Source Max RX Bytes Min Sync Pairs CRC Select Enable RX BCS CCII HSS8 6 MAN 004 CH8MAN04 WPD BISYNC Protocol Information Members Used to specify a single baud rate for both transmitter and receiver Options 1 200 1 Mbit s RS 232 1 200 16 Mbit s RS 422 485 Any values permissible Units in bit s The equation to calculate the actual baud rate for BISYNC is as follows Actual baud rate 100 MHz ROUND 100 MHz Desired baud rate Where ROUND implies that the result is rounded to the nearest integer CLOCK_DEFAULT CLOCK_DEFAULT connects BRGs 1 4 to Ports 1 4 and 5 8 Wh2. 100 DWORD bytes_send h_device CreateFile HSS8_1 GENERIC_READ GENERIC_WRITE 0 NULL OPEN_EXISTING FILE_ATTRIBUTE_NORMAL NULL GetCommState h_device and dcb dcb ByteSize 8 dcb Parity NOPARITY dcb StopBits ONESTOPBIT dcb BaudRate 115200 dcbh fOutxCtsFlow FALSE SetCommState h_device and dcb memset tx_buffer sizeof tx _buffer WriteFile h_device tx_buffer sizeof tx_buffer and bytes_send NULL CloseHandle h_device 6 2 Overlapped Read Operation HANDLE h_device char rx buffer 100 DWORD bytes_read OVERLAPPED overlap DWORD wait_event h_device CreateFile HSS8_1 GENERIC_READ GENERIC_WRITE 0 NULL OPEN_EXISTING FILE_ATTRIBUTE_NORMAL FILE_FLAG_OVERLAPPED NULL overlap Offset 0 overlap OffsetHigh 0 overlap hEvent CreateEvent NULL FALSE FALSE NULL ReadFile h_device rx_buffer sizeof rx_buffer and bytes_read and overlap E wait_event WaitForSingleObject overlap hEvent INFINITI if WAIT_OBJECT_0O wait_event i printf Data received s n rx_buffer CloseHandle overlap hEvent CloseHandle h_device CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 25 of 2
3. CT Systems CCIl Systems Pty Ltd Registration No 1990 005058 07 Communications Computer Intelligence 2 Integration 2 User Manual for the 4 Channel New Generation and 8 Channel High Speed Serial I O Adapters Windows NT 4 Software Driver C 1 Systems Document No CCII HSS8 6 MAN 004 Issue Date 2009 08 31 Print Date 2009 09 03 File Name W HSS8 TECH MAN CH8MAN04 WPD C4 Systems The copyright of this document is the property of C2l 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 Cl Systems Document prepared by C l Systems Cape Town Signature Sheet FRA IMM ees Completed by p X Keue Accepted by Project Manager Lew uio Board Level Products Cl Systems JS Ly DE Comme Accepted by A Kruger ty Assurance Systems 2009 08 31 Issue 1 2 Page ii of vii CCII HSS8 6 MAN 004 CH8MAN04 WPD Signature Sheet Completed by Project Engineer Board Level Products C l Systems Accepted by Project Manager Board Level Products C212 Systems Quality Assurance C l Systems CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 Amendment History Updated after review by WRM 2005 10 20 LES 4 Implemented ECP references to adapters made more generic 2006
4. Windows 32 API for serial devices i e channels can be opened and used in the Windows HyperTerminal application Refer to the Platform SDK in 2 1 4 for the communications resource documentation The serial function prototypes can be found in the SDK file winbase h The device channels are named HSS8_1 to HSS8_12 HSS8_1 to HSS8_8 are the SCC channels HSS8_9 to HSS8_12 are the SMC channels Windows SDK Serial Functions This paragraph lists the serial functions supported by the HSS8 Windows NT 4 Software Driver BuildCommDCB BuildCommDCBAndTimeouts ClearCommError CommConfigDialog GetCommConfig GetCommMask GetCommProperties GetCommState GetCo imeouts GetDe tCommConfig Purge SetCo SetCo SetCo SetCom SetDefa SetupCo WaitCommEvent CreateFile ReadFile WriteFile CloseHandle m m m m ze T a o a w m m m mTimeouts tCommConfig 1 1 m onfig a 1 Windows SDK Serial Structures This paragraph lists the serial structures supported by the HSS8 Windows NT 4 Software Driver COMMCONF IG COMMPROP COMMTIMEOUTS COMSTAT DCB Function Limitations Not all settings are supported for each serial function This paragraph will mention all the exceptions ClearCommeError Only CE_FRAME and CE_RXPARITY are supported GetCommMask Only the EV_RXCHAR event mask is supported CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 6 of 26 4 3 3 4 3 4 4 3
5. data on receive once the receiver synchronizes to the data using the SYN1 SYN2 pair v If v 1 and the receiver is not in hunt mode when a SYNC character is received this character is discarded ssssssss 8 bits SYNC character When using 7 bit characters with parity the parity bit should be included in the SYNC register value DLE register Obv0000000dddddddd BISYNC DLE register In transparent mode the receiver discards any DLE character received v If v 1 and the receiver is not in hunt mode when a DLE character is received this character is discarded dddddddd 8 bits DLE character This character tells the receiver that the next character is text Control Characters 8 ObObh cccccccc Valid entry Control character 1 to 8 Ob1bh cccccccc Entry not valid and is not used Reserved Initialise to zero b Block check sequence expected A maskable interrupt is generated after the buffer is closed b 0 The character is written into the receive buffer and the buffer is closed b 1 The character is written into the receive buffer The receiver waits for 1 LRC or 2 CRC bytes and then closes the buffer h Enables hunt mode when the current buffer is closed h 0 The BISYNC controller maintains character synchronisation after closing the buffer h 1 The BISYNC controller enters hunt mode after closing the buffer When b 1 the controller enters hunt mode after receiving LR
6. 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 Go to the Control Panel Click the Administrative Tools icon Click the Computer Management icon Select Device Manager Expand the Computer node Select the ACPI item Right click and select properties Click Update Driver Select Display a list of known drivers for this device so that can choose a specific driver Select All hardware for this device class Select Standard PC SS OONDORWND aa ee ee eee D 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 Go to the Control Panel Click the Add Remove Hardware icon Select Add Troubleshoot a device Select Add a new device Select No want to select the hardware from a list Select Multi channel serial adapters Click Have Disk Click Browse Select the Program Files C2I2 HSS8 hss8null inf file Click Finish SPS OONDORWN aa ee ee eee om D o Please note that by def
7. 06 29 CCII HSS8 6 ECP 026 Improve document naming consistency 2009 08 31 CCII HSS8 6 ECP 042 CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 Contents T SCOPE A ds nt 1 1 1 identification a A Ta A A A aie Rte a ata 1 1 2 INTOUCIO Na rar A i pie Peis rt adhe ee aia a 1 2 Applicable and Reference Documents oooocccccoc cece eee 2 2 1 Applicable Documents 2 2 2i cRes hee de A ee GE HE ewe et a LA id 2 2 2 Reference Documents 2 3 GOMMNQUPATION PIOCGOUIG Saxo ees bakes sees esas hee eens hes Sees bees hess 3 3 1 Installing the Software Driver Files 0 000 cc cece ttt ete 3 3 2 Special Instructions for Windows 2000 or XP 1 teens 3 3 3 Uninstalling the Software Driver 1 2 0 6 0 teeta 4 3 4 Updating the Device Firmware sartea as kaa anska e ea eet teens 4 3 5 Using the Event Viewer rissaa eran TAARE PAI ete PENE FAIT eens 5 4 Application Program Interface API 0 000 es 6 4 1 Windows SDK Serial Functions ooooooooooo n eens 6 4 2 Windows SDK Serial Structures 1 0 0 0 cent nee ne ene eas 6 4 3 Function Limitations o 6 43 1 ClearCommError o 6 432 GOICOMMMASK aa a E at dts Bade YR ta AA eee ea 6 4 3 3 SetCommMask 0 ccc eee een eee been beeen eee nee nneeans 6 4 3 4 WaitCommEvent 0 00 0 cc etna 7 4 3 5 Overlapped Writes 2 cette eee eae 7 43 6 FlushPileButlers cerciorarse A ae eee Peta 7 4 4 Structure Limitations 4 2
8. 5 4 3 6 4 4 4 4 1 4 4 2 4 4 3 4 4 4 44 5 SetCommMask Only the EV_RXCHAR event mask is supported WaitCommEvent Only the EV_RX_CHAR event mask is supported Overlapped Writes When a port is opened in overlapped non blocking mode overlapped writes might not behave as expected An overlapped read will return immediately and the event will be signalled once data has been received For an overlapped write the function will not return immediately The HSS8 Windows NT 4 Software Driver has to send the data to the adapter where it will be transmitted This transfer does require a finite amount of time Changing the HSS8 Windows NT 4 Software Driver architecture to match the overlapped read operation would degrade its throughput performance on transmission FlushFileBuffers Not supported Structure Limitations Not all the fields of the serial structures are used by the HSS8 Windows NT 4 Software Driver This paragraph will mention all the exceptions COMMCONFIG dwProviderSubType none of the types makes provision for a device that is both RS 232 and RS 422 capable No provider specific data is supplied COMMPROP dwProvSubType dwProvSpec1 dwProvSpec2 and wcProvChar are not supported COMMTIMEOUTS ReadintervalTimeout is not supported The write timeout value is used by the HSS8 Windows NT 4 Software Driver to flush its internal transmitter queue The internal queue is only used when one byte is transmitted at
9. 6 7 Contact Details 7 1 Contact Person Direct all correspondence and or support queries to the Project Manager at C2l Systems 7 2 Physical Address Cl Systems Unit 3 Rosmead Place Rosmead Centre 67 Rosmead Avenue Kenilworth Cape Town 7708 South Africa 7 3 Postal Address Cl Systems P O Box 171 Rondebosch 7701 South Africa 7 4 Voice and Electronic Contacts Tel 27 0 21 683 5490 Fax 27 0 21 683 5435 Email info ccii co za Email support ccii co za URL a http www ccii co za 7 5 Product Support Support on C2l2 Systems products is available telephonically between Monday and Friday from 09 00 to 17 00 CAT Central African Time CAT GMT 2 CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 26 of 26
10. 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 2 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
11. 8 Windows NT 4 Software Driver information dialogue shown in Figure 3 The Driver version is referring to the HSS8 Windows NT 4 Software Driver itself It has the format X Y Z A change in X would indicate thatthe HSS8 Windows NT 4 Software Driver has an added feature Y would mean that a new software driver engine is used in the software driver Z indicates any corrections to problems in the HSS8 Windows NT 4 Software Driver The Engine version must be identical to the firmware version for all cards in the PC Normally this would only be different when the software driver version is checked after a firmware update and the software driver itself has not been updated Driver Information xj Driver version 11 0 Engine version A0 Firmware 1 120 Firmware 2 Not installed Firmware 3 Not installed Firmware 4 Not installed Note At least one port must be closed per device Cancel Figure 3 Driver Information Dialogue CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 9 of 26 5 4 UART Mode This protocol may only be used with the eight SCC Channels HSS8_1 to HSS8_8 See Paragraph 5 7 1 for the settings for the SMC Channels The UART dialogue window is shown in Figures 4 and 5 The settings are described in Paragraph 5 4 1 HSS8 Adapter Port Settings v1 1 x Hsse_1 hsse_2 Hsse_3 Hsse_s Hss8_s Hssa_s Hsse_7 Hsse_s Hss 4 gt Protocol Baud Rate Aync Fl
12. C or CRC cccccccc 8 bits Defines control characters to be compared to the incoming character When using 7 bit characters with parity include the parity bit in the character value CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 21 of 26 RX Control Character Mask 0b11 00000000 Ignore these bits when comparing Receive control character mask A one incoming character enables comparison and a zero masks 0b11 11111111 Enable comparing the incoming it character to cc n Sync Character Oxssss 2 bytes SYNC character Should be programmed with the sync pattern Syn Length SYNL_8 Should be chosen to implement mono sync protocol The receiver synchronizes on an 8 bit sync pattern in sync SYNL_16 The receiver synchronizes on a 16 bit sync pattern stored in sync Enable flags syncs Send either idles or flags syncs between frames as defined by the protocol The flag character is equal to sync CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 22 of 26 5 7 SMC UART Mode This protocol may only be used with the four SMC ports HSS8_9 to HSS8_12 The SMC dialogue window is shown in Figure 10 The settings are described in Paragraph 5 7 1 HSS8 Adapter Port Settings w1 1 3 xi Hsse_s Hss _s HSs8_7 Hssa_e HSS8_9 Hsss_to Hsse_11 Hss8_12 gt m Protocol Baud Rate Eyne Flow Control C UART 115200 y Freeze
13. Transmit C HDLC Rx with no stopbit Data Bits m Stop bits F Synchronous Mode BISYNC 8 a 4 2 PF Disable Rx while Tx UART Mode Diagnostics Mode Disable Parity Checking E F Enable Retransmit v hos 7 Enable Flag Sharing TX Parity RX Parity Clock Source Enable Bus Mode hd nf TJ T Enable RTS Mode Max RX Bytes Max Idle Characters CRC Mode Fo Enable Muttitple Frames 16384 10 JP Send flagsisyncs J Enable RX BCS Encoding Method Preamble Length Pattern F Enable RX Transparent Mode P Enable Reverse Data O LOCK SETTINGS Advanced Settings 2 2 This port only supports the SMC protocol sin E cmo um Figure 10 SMC Dialogue 5 7 1 SMC UART Protocol Information Members Options Description Baud Rate 1 200 115 2 kbit s RS 232 RS 422 485 Used to specify a single baud rate for both transmitter and Any values permissible receiver The equation to calculate the actual baud rate for the SMC UART is Units in bit s as follows Actual baud rate 100 MHz 16 ROUND 100 MHz 16 Desired baud rate Where ROUND implies that the result is rounded to the nearest integer CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 23 of 26 Options Description Data Bits Number of data bits Note only ports 9 12 i e the SMC ports support nine or more data bits Disable Parity Enable or disable parity Checking checking TX Parity Receive and tr
14. a time COMSTAT Only cb nQue and cbOutQue are supported in this structure DCB The following fields are not supported fOutxDsrFlow fDtrControl fDsrSensitivity FTXContinueOnXoff fOutX fInX fErrorChar fNull fRtsControl fAbortOnError XonLim XoffLim XonChar XoffChar ErrorChar EofChar EvtChar StopBits of ONES5STOPBITS is not supported by the HSS8 Windows NT 4 Software Driver Note The XON XOFF flow control is not supported by the HSS8 Windows NT 4 Software Driver To use no flowcontrol the fOutxCtsFlow field must be set to FALSE CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 7 of 26 5 1 5 2 HSS8 Windows NT 4 Software Driver Protocol Settings The HSS8 has eight serial communications controllers SCCs Channels 1 8 that support UART and HDLC SDLC protocols and four serial management controllers SMCs Channels 9 12 that support only asynchronous UART The control panel applet allows the user to set all the protocol specific options available on the HSS8 communication controller chip the MPC8260 PowerQUICC II For available options for each of the fields see 2 1 1 This section details the information used by each protocol and explains the use and limitations of every member Protocol Selection Each Channel must be configured to use a protocol Protocol UART HDLC BISYNC SMC_UART The protocol settings for the device can be set through a control panel applet Acces
15. ansmit parity Parity will only be checked if parity is enabled Diagnostics Mode NORMAL Normal operation Use this for Set diagnostic mode external loopback External loopback RS485 Connect TxD to RxD and LOOPBACK Internal loopback TxD to RxD TxD and RxD are connected internally The value on RxD is External loopback RS 232 ignored Connect TxD to RxD The transmitter automatically resends received data bit by bit LOOPBACK_ECHO Loopback and echo operation occur simultaneously Max RX Bytes 1 to 16 384 default Maximum number of bytes that may be copied into a buffer Maximum idle characters When a character is received the receiver begins counting idle characters If max_idl idle characters are received before the next data character an idle timeout occurs and the buffer is closed Thus max_idl offers a way to demarcate frames To disable the feature clear max_idl The bit length of an idle character is calculated as follows 1 data length 5 14 1 if parity is used number of stop bits 1 2 For 8 data bits no parity and 1 stop bit the character length is 10 bits Max Idle 0 to 16 384 default Characters CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 24 of 26 6 Getting Started This paragraph contains example code extracts for using the Win32 API to access the HSS8 device 6 1 Normal Write Operation HANDLE h_device DCB d b char tx_buffer
16. as follows Flashprog exe b s u filename The channel number residing on the device which will be updated b The filename following this flag is a binary image s The filename following this flag is a Motorola S record file u No firmware updates will be done the current firmware image will be stored in filename Note X Y Z is the version of the firmware Only one channel per device must be specified Whenever the firmware is updated the current firmware will be stored in the file ccbackup bin Rename this file before using the application again Example flashprog 1 s ccHss8EmbVxyz hex Will update the firmware of the first device with the S record file ccHss8EmbVvxyz hex Using channel number 13 will update the firmware on the second device CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 4 of 26 3 5 Using the Event Viewer The Windows administrative tool Event Viewer can be used to inspect the event logs The HSS8 Windows NT 4 Software Driver logs certain information and fatal errors to the event log Refer to the event log when an operation does not function as expected 1 Go to the Control Panel 2 Click the Administrative Tools icon 3 Click the Event Viewer icon CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 5 of 26 4 1 4 2 4 3 4 3 1 4 3 2 Application Program Interface API The HSS8 Windows NT Software Driver complies to most of the
17. ault 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 CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 3 of 26 3 3 3 4 HSS8 Windows Driver v1 1 0 Figure 1 Installation Wizard Uninstalling the Software Driver In the Start menu select Control Panel from the Settings menu Click on Add Remove Programs Selectthe HSS8 Windows Driver vX Y Z from the list and click the Remove button Answer yes to delete all files from the HDD Updating the Device Firmware Always ensure that when a new software driver is installed the corresponding firmware revision on the device is identical There might be incompatibilities between different software driver and firmware versions The Engine version reported by the control panel applet must match the firmware version of all devices in the system The flash update application is located in the Program Files C2I2 HSS8 folder Before running the application ensure that all channels on the device are closed The firmware images are located on the supplied CD ROM or the Cl Systems website Note Do not remove the power from the PC until the flash programming is completed The syntax for the application is
18. ct UART mode MAN MM Normal manual multidrop or AUTO MM automatic multidrop mode CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 11 of 26 fame Options Description Freeze Transmit RX with no stopbit Disable RX while TX Disable Parity Checking TX parity RX parit ODD parity parity LOW EVEN HIGH Diagnostics Mode NORMAL Normal operation Use this for external loopback LOOPBACK Internal loopback TxD and RxD are connected internally The value on RxD CTS and CD is ignored The transmitter and receiver share the same clock source ECHO The transmitter automatically resends received data bit by bit LOOPBACK_ECHO echo occur Loopback and operation simultaneously 1 to 16 384 default Max RX Bytes Max Idle Characters 0 to 16 384 default Break Characters 0 2048 Address1 Address2 0x0000 Ox00FF Pause freeze transmission Transmission continues when set back to normal If set the receiver receives data without stop bits Select asynchronous normal or synchronous mode Enable normal or disable receiver while transmitting Used in multidrop mode to prevent reception of own messages Enable or disable parity checking Receive and transmit parity Parity will only be checked if parity is enabled Set diagnostic mode External loopback RS 422 485 Connect TxD to RxD TxD to RxD CLK_OUT to CLKIN and CLKOUT to CLK_IN for synch
19. d by the protocol For HDLC the flag is defined as Ox7E NRZI encoding methods may only be used with flags syncs CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 16 of 26 5 5 2 Preamble Requirements Minimum Preamble Length Required Decoding Method Preamble Pattern Differential Manchester CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 17 of 26 5 6 BISYNC Mode This protocol may only be used with the eight SCC ports Ports HSS8_1 to HSS8_8 The BISYNC dialogue windows is shown in Figures 8 and 9 The settings are described in Paragraph 5 6 1 Protocol C UART Baud Rate C HpLe Data Bits o a pisync fa KT UART Mode y NORMAL ii TX Parity RX Parity Joop ODD y 15384 E Encoding Method O LOCK SETTINGS T il Max RX Bytes Max Idle Characters 115200 Stop bits wi gia Diagnostics Mode Clock Source cLock_DEFALLT v CRC Mode 16bi y Preamble Length Pattern NRZ gt fo CP Systems HSS8 adapter fic gt HSS8 Adapter Port Settings v1 1 x Hsse_1 Hss8_2 Hssa_3 Hsse_4 Hsse_5 Hsss_6 Hsse_7 Hsse_s Hss 4 gt _ Ayne Flow Control Freeze Transmit _ Rx with no stopbit Synchronous Mode Disable Rx while Tx JA Disable Parity Checking JP Enable Retransm t Enable Flag Sharing JP Enable Bus Mode J Enable RTS Mode JA Enable Muttitple Frames I Send flags synes
20. de GOMtaCt Detalls 200 ii eased esa SRA Sate Ged atk tak tke vg coke RAR RA RRA a 26 7 1 Contact PERSON serea RA A A A fered AA dd a A AR ALA A ii 26 CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 7 2 Physical Address s oac05 wen A eee Mea A aed oe eke hate Cae ces Man Sane teed 2S 26 7 3 Postal Addr SS euni session bccn eee te ea tant da Dl tl Pie ae Me Sean ie cee ee oe oes to cea aa kc eT 26 7 4 Voice and Electronic Contacts 26 7 5 Product S ppo A a ais e whe and Saas en eee as 26 CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 List of Illustrations Figure T Installation Wizard tocara rta iaa ai aida de Ra 4 Figure 2 Applet ICOM scort ata aaa ala atracado ts 8 Figure 3 Driver Information Dialogue ooocoooccoooo nee 9 Figure 4 VART Dialogue ooo ooooooror eens 10 Figure 5 UART Advanced Dialogue vias serin ses taa ta resco E ewe ded RAR e 10 Figure 6 HDLEC Dialogue 2204 anes feces pets eee daca ei det abba dei tiee abet eedigioaeeuPetaad 14 Figure 7 HDLC Advanced Dialogue 00 0 tnt ete eee 14 Figure 8 BISYNC Dialogue oo oo oooor eee tenet eee 18 Figure 9 BISYNC Advanced Dialogue 0 00 cette teens 18 Figure 10 SMO Dialogue fees eat es oes hie dew A a eee a eee BE 23 CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 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 Diskd
21. en transmit clock is set to CLOCK_BRG 1 4 then receive clock CLOCK_BRG1 BRGs 1 4 CLOC CLOCK BRG2 BRG1 for Ports 1 and 5 is still set to CLOCK_EXT 1 4 for CLOCK_BRG3 BRG2 for Ports 2 and 6 Ports 1 4 and 5 8 CLOCK_BRG4 BRG3 for Ports 3 and 7 Note BRG4 for P 4 ator Pors lange There are four BRGs and four clock CLOCK_EXT1 External Clocks connected input pins per PowerQUICC II CLOCK_EXT2 on CLK_IN Pins processor CLOCK_EXT3 CLOCK_EXT4 Note CLOCK_EXT 1 2 can only be used for Ports 1 and 2 and 5 and 6 while CLOCK_EXT 3 4 can only be used for Ports 3 and 4 and 7 and 8 1 to 16 384 2 CRC bytes default Maximum number of bytes to receive before closing buffer 0b0000 0 pairs 0b1111 16 pairs Minimum number of SYN1 SYN2 pairs sent between or before messages The entire pair is always sent regardless of the syn_length variable 16 LRC CRC selection 1 CRC16 X16 X15 X2 1 Initialise prere and pterc to all zeros or all ones 2 LRC sum check For even LRC initialise prere and ptcrc to zeros for odd LRC initialise to ones Enable Receive Block Check Sequence BCS 2009 08 31 Issue 1 2 Page 19 of 26 Enable Receiver transparent mode Enable RX Transparent Mode FALSE Normal receiver mode with SYNC stripping and control character recognition TRUE Transparent receiver mode SYNC s DLE s and control characte
22. h004 at44 eth wedi atada bia dee Greet Saadeh da da 7 4 441 GOMMCONFIG H xtc tral da AA Hho a ss 7 4 4 2 GOMMPROP oure arrasa dad daria det Samad tk pad 7 443 COMMTIMEOUTS 0o occcocccc ete eee 7 BAA COMSTAT in A a 8 wee tarda Rae eine WARE are paiva Ba ee a 7 4400 DCB rar rt Mens aaa GPE Gee DPA ake E Mord aie Seether ees 7 5 HSS8 Windows NT 4 Software Driver Protocol Settings 8 5 1 Protocol Selecione ed he we ga fetta cava ested A AE AE eed Sew arte doin PA hed ies 8 5 2 Using the Control Panel to Change Channel Settings ooooccccccccon 8 5 3 Using the Control Panel to Obtain the Current Version Information 0 00 c cece eee eee 9 5 4 VART MOGE tatiana ata id trote Gath A a ate o A ds Earn ae Rene 10 5 4 1 UART Protocol Information o ooooocooooconr eee 11 5 5 ADLE MOOG sota att E EA ad tt ia aaa 14 5 5 1 HDLC Protocol Information Members oooooocoocoor ene nena 15 5 5 2 Preamble Requirements oooo oocccoooc ae 17 5 6 BISYNG Mode 2h eed tebe e haw te wae noe ee 18 5 6 1 BISYNC Protocol Information Members 000 cee nena 19 5 7 SMG UART Mode 0 i0 a id ae dew a lone a ergs 23 5 7 1 SMC UART Protocol Information Members 0 00 cease 23 67 Getting Started ia ir e ti apa o a il aa lage gna Saas a 25 6 1 Normal Write Operation 20 000 ccc teeta 25 6 2 Overlapped Read Operation 0 0 cnet eee eee tees 25
23. ntrol character mask A Mask incoming character one enables comparison and a zero 0b11 11111111 Enable comparing the incoming masks it character to cc n CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 13 of 26 5 5 HDLC Mode This protocol may only be used with the eight SCC ports HSS8_1 to HSS8_8 The HDLC dialogue windows is shown in Figures 6 and 7 The settings are described in Paragraph 5 5 1 HSS8 Adapter Port Settings v1 1 xj HSS8_1 Hsse_2 Hsse_3 Hsse_4 Hsse_s Hsse_s Hsse_7 Hsse_s Hss gt m Protocol Baud Rate 7 Ayne Flow Control C UART 115200 IF Freeze Transmit PF Rx with no stopbit Data Bits Stop bits _ Synchronous Mode 8 ES 1 2 7 Disable Rx while Tx C BISYNC UART Mode Diagnostics Mode JP Disable Parity Checking Enable Retransmit NORMAL v NORMAL J Enable Flag Sharing TX Parity RX Parity Clock Source TT Enable Bus Mode Y Joop Y cLock_DEFAULT a Enable RTS Mode Max RX Bytes Max Idle Characters CRC Mode Enable Multitple Frames 16384 10 16 bit Send flags syncs IV Enable RX BCS Encoding Method Preamble Length Pattern J Enable RX Transparent Mode NRz o y fio JP Enable Reverse Data O Lock SETTINGS Advanced Settings 2 2 CP Systems HSS8 adapter Systems lil Cancel Apply Figure 6 HDLC Dialogue HDLC Advanced Settings y xj 4 Ox 0001 jg eee Flags Between Frame
24. of CLOCK_BRG 1 4 or CLOCK_EXT1 External Clocks connected on CLOCK_EXT 1 4 CLOCK_EXT2 CLK_IN Pins CLOCK_EXT3 Note CLOCK_EXT4 Note There are four BRGs and four clock CLOCK_EXT 1 2 can only be input pins per PowerQUICC Il used for Ports 1 and 2 and processor 5 and 6 while CLOCK_EXT 3 4 can only be used for Ports 3 and 4 and 7 and 8 HDLC CRC mode NORMAL Normal operation Use this for external loopback Diagnostics Mode Set diagnostic mode External loopback RS 422 485 Connect TxD to RxD TxD to LOOPBACK Internal loopback RxD CLK_OUT to CLK_IN and TxD and RxD are connected CLK_OUT to CLK_IN for internally The value on RxD Synchronous mode CTS and CD is ignored The transmitter and receiver share External loopback RS 232 the same clock source Connect TxD to RxD CLK_OUT to CLK_IN for synchronous mode and The transmitter automatically RTS to CTS and CD resends received data bit by Set diagnostic mode bit For synchronous mode LOOPBACK_ECHO Loopback and echo operation 88 encoding_method occur simultaneously CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 15 of 26 Options TC Max RX Bytes 1 to 16 384 CRC bytes two or four default Maximum number of bytes to receive before closing buffer Set equal to max_frame_bytes Max Frame Bytes 1 to 16 384 default Maximum number of byte
25. ow Control Freeze Transmit 115200 Rx with no stopbit Data Bits Stop bits FF Synchronous Mode fe 4 41 2 J Disable Rx while Tx Diagnostics Mode 7 Disable Parity Checking C HDLC C BISYNC UART Mode JP Enable Retransmit y normal ae J Enable Flag Sharing TX Parity RX Parity Clock Source 7 Enable Bus Mode cLock DEFAULT z Enable RTS Mode Max RX Bytes Max Idle Characters CRC Mode FO Enable Muttitple Frames 16304 10 fis ot L Sen is eh JV Enable RX Encoding Method Preamble Length Pattern 7 Enab ent Mode irez E gt fi 0 _ Enable Reverse Data Advanced Settings O Lock SETTINGS 272 CP Systems HSS8 adapter Sy stems il Cancel Apply Figure 4 UART Dialogue UART Advanced Settings xi Break Characters Control Characters RX Control Character Mask Ox 0000 pages J 1 Ox 0000 2 Ox 0000 Multidrop Mode 310 0000 Address 1 3 Ox Ox 0000 4 Ox 0000 Address 2 5 Ox 0000 Dx 0000 foo 6 0x 0000 z Ox 0000 8 Ox 0000 ply E Cancel Figure 5 UART Advanced Dialogue CCII HSS8 6 MAN 004 2009 08 31 CH8MANO4 WPD Page 10 of 26 Issue 1 2 5 4 1 UART Protocol Information e Js eee Baud Rate 1 200 1 Mbit s RS 232 Used to specify a single baud rate 1 200 16 Mbit s RS 422 485 for both transmitter and receiver Any values permissible Uni
26. rive HDLC High Level Data Link Control HSS High Speed Serial Acronym for the C l Serial I O Adapter project HSS8 8 Channel High Speed Serial I O Adapter 1 0 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 SCG 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 As Scope 1 1 Identification This document is the user manual for the HSS8 Windows NT 4 Software Driver for the C212 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 d
27. rivers only The HSS8 Windows NT 4 software driver is a low level device dependent interface for transferring data over a C l 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 1 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
28. ronous mode External loopback RS 232 Connect TxD to RxD CLK_OUT to CLK_IN for synchronous mode and RTS to CTS and CD Maximum number of bytes that may be copied into a buffer Maximum idle characters When a character is received the receiver begins counting idle characters If max_idl idle characters are received before the next data character an idle timeout occurs and the buffer is closed Thus max_idl offers a way to demarcate frames To disable the feature clear max_idl The bit length of an idle character is calculated as follows 1 data length 5 9 1 if parity is used number of stop bits 1 2 For 8 data bits no parity and 1 stop bit the character length is 10 bits Number of break characters sent by transmitter For 8 data bits no parity 1 stop bit and 1 start bit each break character consists of 10 zero bits Address in multidrop mode Only the lower 8 bits are used so the upper 8 bits should be cleared CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 12 of 26 ame Y ps o Control Characters 8 cccccccc Valid entry Control character 1 to 8 These cccccccc Entry not valid and is not used characters can be used to delimit received messages Reserved Initialise to zero cccccccc 8 bits Defines control characters to be compared to the incoming character RX Control Character 0b11 00000000 Ignore these bits when comparing Receive co
29. rs are recognised only after the leading DLE character The receiver calculates the CRC16 sequence even if it is programmed to LRC while in transparent mode Initialize prere to the CRC16 preset value before setting rx_transparant_mode Enable Reverse Data Enable Reverse data Disable RX while TX Disable receiver while sending RX Parity ODD Receive and transmit parity fay is LOW ignored unless crc_select LRC TX Parity EVEN HIGH Diagnostics Mode NORMAL Normal operation Use this Set diagnostic mode for external loopback External loopback RS 422 485 Connect TxD to RxD TxD to RxD LOOPBACK Internal loopback CLK_OUT to CLK_IN and TxD and RxD are connected CLK_OUT to CLK_IN internally The value on RxD CTS and CD is ignored The External loopback RS 232 transmitter and receiver Connect TxD to RxD CLK_OUT to share the same clock CLK_IN and RTS to CTS and CD source ECHO The transmitter automatically resends received data bit by bit LOOPBACK_ECHO Loopback and echo operation occur simultaneously CRC constant value CRC Constant pia Led E OFF CRCIGILRC These values should be x These values should be CRC Preset TX preset to all ones or zeros depending on the BCS used CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 20 of 26 SYNC register Obv0000000ssssssss BISYNC SYNC register Contains the value of the SYNC character stripped from incoming
30. s E 1 Ox 0000 0 a Address Mask 2 0x 0000 dd a 3 0x 0000 Cancel Apply Figure 7 HDLC Advanced Dialogue CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MANO4 WPD Page 14 of 26 5 5 1 HDLC Protocol Information Members Options E 1 200 1 Mbit s RS 232 1 200 16 Mbit s RS 422 485 Baud Rate Used to specify a single baud rate for both transmitter and receiver Any values permissible Units in bit s The equation to calculate the actual baud rate for FMO 1 Manchester and Diff Manchester is as follows Actual baud rate 100 MHz 16 ROUND 100 MHz 16 Desired baud rate The equation to calculate the actual baud rate for NRZ NRZI is as follows Actual baud rate 100 MHz ROUND 100 MHz Desired baud rate Where ROUND implies that the result is rounded to the nearest integer CLOCK_DEFAULT CLOCK_DEFAULT connects BRGs 1 4 to Ports 1 4 and Ports 5 8 Clock Source For NRZ NRZI When transmit clock is set to CLOCK_BRG 1 4 then receive clock is still set to CLOCK_EXT 1 4 for Ports 1 4 and 5 8 CLOCK_BRG1 CLOCK_BRG2 CLOCK_BRG3 CLOCK_BRG4 BRG 1 4 BRG1 for Ports 1 and 5 BRG2 for Ports 2 and 6 BRG3 for Ports 3 and 7 BRG4 for Ports 4 and 8 For FMO 1 Manchester and Diff Manchester Transmit and receive clocks can be set to one
31. s per frame Set equal to the number of data bytes plus the number of CRC bytes either two or four per frame Address Mask 0x0000 OxFFFF HDLC address mask A one enables comparison and a zero masks it Address 4 0x0000 OxFFFF Four address registers for address recognition The SCC reads the frame address from the HDLC receiver compares it with the address registers and masks the result with address_mask For example to recognize a frame that begins 0x7E flag 0x68 OxAA using 16 bit address recognition the address registers should contain OxAA68 and address_mask should contain OxFFFF For 8 bit addresses clear the eight high order address bits Flags between Frames z Minimum number of flags between or before frames Enable Flag Sharing Enable flag sharing Disable RX while TX Disable receive during transmit Enable Bus Mode Enable bus mode Enable RTS Mode Enable special RTS operation in HDLC bus mode Enable Multiple Frames Enable multiple frames in transmit FIFO Encoding Method NRZ RX TX encoding method NRZ and NRZI_MARK NRZI use no DPLL FMO 1 NRZI_SPACE Manchester and Diff_Manchester FMO use the DPLL for clock recovery The FM1 clock rate is 16x when the DPLL is MANCHESTER used DIFF_MANCHESTER Preamble Length Determines the length of the preamble pattern Pattern Determines what bit pattern precedes each TX frame Send flags sync Send either idles or flags syncs between frames as define
32. s the applet by clicking on the Start menu and selecting the Control Panel from the Settings option Click on the icon shown in Figure 2 Figure 2 Applet Icon Using the Control Panel to Change Channel Settings The control panel applet selection boxes list available options for the specific protocols Options that are not available for the selected protocol are grayed out All the options including the options in the Advanced dialogue must be entered to create a valid protocol setting Always click the Apply button before closing any of the dialogue windows The settings are applied to the HSS8 Channel when it is reopened When Lock Settings is checked all requests via the Win32 API will be ignored Any change in baud rate or parity will then not be updated the HSS8 Windows NT 4 Software Driver will keep the setting as specified in the control panel When the settings are not locked the baud rate etc may be updated via the Win32 API functions When using the HDLC or BISYNC protocols it is recommended to use the Lock Settings option The settings are stored in the Windows registry under the keys HKEY_LOCAL_MACHINE SYSTEM CurrentControlSet Services HSS8 DeviceX PortX CCII HSS8 6 MAN 004 2009 08 31 Issue 1 2 CH8MAN04 WPD Page 8 of 26 5 3 Using the Control Panel to Obtain the Current Version Information Clicking on the Information icon near the bottom of the dialogue screen will display the HSS
33. ts in bit s The equation to calculate the actual baud rate for asynchronous UART is as follows Actual baud rate 100 MHz 16 ROUND 100 MHz 16 Desired baud rate The equation to calculate the actual baud rate for synchronous UART is as follows Actual baud rate 100 MHz ROUND 100 MHz Desired baud rate Where ROUND implies that the result is rounded to the nearest integer Clock Source CLOCK_DEFAULT CLOCK_DEFAULT connects Baud Rate Generators BRGs 1 4 to Ports 1 4 and Ports 5 8 For synchronous UART When transmit clock is set to CLOCK BRG BROS 1 4 clocks sil setto CLOCK EXTI1 4 CLOCK_BRG2 BRG1 for Ports 1 and 5 for Ports 1 4 and Ports 5 8 CLOCK_BRG3 BRG2 for Ports 2 and 6 CLOCK_BRG4 BRG3 for Ports 3 and 7 For asynchronous UART BRG4 for Ports 4 and 8 Transmit and receive clocks can be set to one of CLOCK_BRG 1 4 or CLOCK_EXT1 External Clocks connected CLOCK_EXT 1 4 CLOCK_EXT2 on CLK_IN pins CLOCK_EXT3 Note CLOCK EXT4 There are four BRGs and four clock input pins per PowerQUICC Il Note processor CLOCK_EXT 1 2 can only be used for Ports 1 and 2 and 5 and 6 while CLOCK_EXT 3 4 can only be used for Ports 3 and 4 and 7 and 8 Async Flow Control Normal or asynchronous flow control Stop bits ONE Number of full stop bits TWO Data Bits Number of data bits Note only Ports 9 12 support nine or more data bits UART Mode NORMAL Sele
Download Pdf Manuals
Related Search