User Manual High-Speed Serial I/O Adapter Windows NT 4 Software
Contents
1. printf Data received in CloseHandle overlap hEvent CloseHandl h_device CCII HSS 6 MAN 004 2009 09 03 CHSMANO04 WPD Page 22 of 23 Issue 1 2 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 http www ccii co za 7 5 Product Support Support on C I Systems products is available telephonically between Monday and Friday from 09 00 to 17 00 CAT Central African Time CAT GMT 2 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 23 of 232. 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 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 l 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 HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 19 of 23 5 7 SMC UART Mode This protocol may only be used with the two SMC ports HSS5 and 6 The SMC Dialogue window is shown in Figure 10 The settings are described in Paragraph 5 7 1 SIO Adapter 4 Port Settings v1 0 HSS1 Hss2 Hss3 Hss HSS5 Hss6 Protocol Elec Interface Baud Rate IT Aync Flow Control C USERT 115200 Freeze Transmit HDLC Rx with no stopbit Data Bits Stop bits Synchronous Mode C BISYNC e f 1 21 Disable Rx while T UART Mode Diagnostics Mode
3. Communications Computer Intelligence Integration Hsu Figure 1 Installation Wizard Uninstalling The HSS Windows NT 4 Software Driver In the Start menu select Control Panel from the Settings menu Click on Add Remove Programs Select the Cl SIO 4 Port Driver 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 driver is installed the corresponding firmware revision on the device is identical There might be incompatibilities between different device 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 SlO4Port 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 Warning Do not remove the power from the PC until the flash programming is completed CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMAN04 WPD Page 3 of 23 The syntax for the application is as follows Flashprog exe b s u filename The channel number residing on the device which will be updated The filename following this flag is a binary image The filename following this flag is a Motorola S record file No firmware updates will be done the current firmware image will be stor
4. CT Systems CCII Systems Pty Ltd Registration No 1990 005058 07 Communications Computer Intelligence 2 Integration 2 User Manual for the High Speed Serial I O Adapter Windows NT 4 Software Driver C Systems Document No CCII HSS 6 MAN 004 Issue Date 2009 09 03 Print Date 2009 09 04 File Name P HSS TECH MAN CHSMAN04 WPD C I 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 C I Systems Document prepared by C2I Systems Cape Town Signature Sheet AA EE COE 2009 09 03 rdiect Engifiger d amp 4 04 03 Completed by Board EER Products C I Systems Accepted by Project Manager Board Level Products C P Systems Ls DE Lom Accepted by Kou 2009 09 03 Issue 1 2 Page ii of vii CCII HSS 6 MAN 004 CHSMANO04 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 HSS 6 MAN 004 2009 09 03 Issue 1 2 Amendment History Changed title 2009 05 27 CCII BLPGEN 6 ECP 015 Improve document naming consistency 2009 09 03 CCII HSS 6 ECP 01
5. Control P Freeze Transmit Rx with no stopbit Synchronous Mode Disable Rx while Tx Disable Parity Checking Enable Retransm t Enable Flag Sharing Enable Bus Mode Enable RTS Mode Enable Muttitple Frames Send flags syncs r E E ransparent Mode Enable Reverse Data Advanced Settings 2 CU Systems HSS 4 Port SIO PMC adapter omen som Figure 8 BISYNC Dialogue il BISYNC Advanced Settings Min Sync Pairs i CRC Select i Sync Character ox 0000 Preset RX 0000 Preset TX 0000 Syn Length a i RX Control Character Mask Ox 000 SYNC register 0000 DLE register 0000 r Control Characters 1 Ox 8000 2 0x 8000 3 0x 8000 4 0x 8000 5 0x 8000 B Ox 8000 7 0x 8000 8 Ox 8000 GAAS Cancel d 3 Ss Figure 9 BISYNC Advanced Dialogue CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO04 WPD Page 16 of 23 5 6 1 BISYNC Protocol Information Members Options Description Baud Rate 1 200 115 kbit s RS 232 Used to specify a single baud rate for 1 200 12 Mbit s RS 422 RS 485 both transmitter and receiver Any values permissible Clock Source CLOCK_DEFAULT CLOCK_DEFAULT connects BRGs 1 4 to Ports 1 4 CLOCK_BRG1 BRGs 1 4 When the transmit clock is set to CLOCK_BRG2 CLOCK BRG 1 4 then receive clock CLOCK_BRG3 is still set to CLO
6. Program elec_interface RS 232 int control and connect TXD to RXD TXCLK to RXCLK for synchronous mode Ignore RTS CTL and CD For synchronous mode See encoding_method Maximum number of bytes to receive before closing buffer Set equal to max_frame_bytes Maximum number of bytes per frame Set equal to the number of data bytes plus the number of CRC bytes either two or four per frame HDLC address mask A one enables comparison and a zero masks it Issue 1 2 Name Optims Description 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 Ox7E 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 Minimum number of flags between or before frames Enable Retransmit Enable re transmit 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
7. UART Mode Elec Interface Baud Rate Rs232 int contr al 115200 Data Bits Stop bits NOA Ge z Diagnostics Mode y NORMAL TX Parity v Max RX Bytes Max Idle Characters Encoding Method NRz o RX Parity Clock Source Y cLock_DEFAULT m Preamble Length Pattern O Lock SETTINGS CRC Mode B js Aync Flovv Control Freeze Transmit Rx with no stopbit El Synchronous Mode Disable Rx while Tx Disable Parity Checking Enable Retransmit Enable Flag Sharing Enable Bus Mode Enable RTS Mode Enable Multitple Frames Send flags syncs v Enable RX BCS Enable RX Transparent Mode ho Enable Reverse Data Advanced Settings 2p CP Systems HSS 4 Port SIO PMC adapter OK Cancel Figure 6 HDLC Dialogue HDLC Advanced Settings Max Frame Bytes Address Mask Ox 0000 Addresses 1 Ox 0000 2 0x 0000 CCII HSS 6 MAN 004 2009 09 03 3 Ox 0000 4 Ox 0000 Flags Between Frames A C EN Figure 7 HDLC Advanced Dialogue Issue 1 2 CHSMANO04 WPD Page 12 of 23 5 5 1 Baud Rate Clock Source Diagnostics Mode Max RX Bytes Max Frame Bytes Address Mask HDLC Protocol Information Members 1 200 115 kbit s RS 232 1 200 12 Mbit s RS 422 RS 485 Any values permissible CLOCK_DEFAULT CLOCK_BRG1 CLOCK_BRG2 CLOCK_BRG3 CLOCK_BRG4 C
8. 1 0 Hsst Hss2 Hss3 Hss4 Hsss Hsse Aync Flow Control Y Freeze Transmit Rx with no stopbit Synchronous Mode Disable Rx while Tx Disable Parity Checking _ Enable Retransmit Enable Flag Sharing Enable de JP Enab JP Enab Send fl gs v Enab Enable RX Transparent Mode Enable Reverse Data Advanced Settings T 2 CT Systems HSS 4 Port SIO PMC adapter il OK Cancel Figure 4 UART Dialogue Protocol Elec Interface Baud Rate 115200 Data Bits Stop bits C BISYNC 8 oO El Diagnostics Mode UART Mode z TX Parity RX Parity vv n m Clock Source Max RX Bytes Max Idle Characters CRC Mode 2048 10 y Encoding Method Preamble Length Pattern O LOCK SETTINGS Systems UART Advanced Settings Control Characters 1 Ox 8000 Break Characters 2 0x 000 Multidrop Mode Address 1 Ox 0000 Address 2 3 Ox 8000 4 Ox 8000 5 Ox 8000 ox 0000 6 Ox 8000 7 Ox 8000 RX Control Character Mask Ox cono PTT 8 Ox 8000 Cancel Apply Figure 5 UART Advanced Dialogue CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 9 of 23 5 4 1 UART Protocol Information Description Baud Rate 1 200 115 kbit s RS 232 Used to specify a single baud rate for 1 200 2 4 Mbit s RS 422 RS 485 both transm
9. 2 Getting Started This paragraph contains example code extracts for using the Win32 API to access the HSS device Normal Write Operation HANDLE DCB char DWORD h_device dcb tx buffer 100 bytes seng h device CreateFile HSS1 GENERIC_READ GENERIC_WRITE 0 NULL OPEN EXISTING FILE ATTRIBUTE NORMAL NULL GetCommState h device amp dcb dcb ByteSize 8 dcb Parity NOPARITY dcb StopBits ONESTOPBIT dcb BaudRate 115200 dcb fOutxCtsFlow FALSE SetCommState h device amp dcb memset tx buffer WriteFile h device CloseHandle h device Overlapped Read Operation tx buffer sizeof tx buffer sizeof tx buffer amp bytes send NULL char rx buffer 100 DWORD bytes reag OVERLAPPED overlap DWORD wait event HANDLE h device h device CreateFile HSSL 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 amp bytes read amp overlap wait event WaitForSingleObject overlap hEvent INFINITE if WAIT_OBJECT_0 wait_event
10. 2 1 Applicable Documents 2 1 1 Motorola MPC8260 PowerQUICC Family Reference Manual MPC8260UM D Rev 1 dated May 2003 http e www motorola com 2 1 2 DI IPSC 81443 Data Item Description for a Software User Manual 2 1 3 MSDN Communication Resources http msdn microsoft com en us library aa363196 VS 85 aspx 2 2 Reference Documents None CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO04 WPD Page 2 of 23 3 1 3 2 3 3 Configuration Procedure This paragraph describes the installation procedure for the HSS Windows NT 4 Software Driver Installing The HSS Windows NT 4 Software Driver Files Unzip the file hss4ntxyz zip to any suitable folder on your local personal Computer PC Hard Disk Drive HDD You must have administrative privileges on the PC Run the application Setup exe Figure 1 All the driver files will be extracted to the required locations e the device driver file will be stored in WINNT system32 drivers the control panel applet in WINNT system32 and the flash update application in Program FilesiC212SystemsiSIO4Port As this is not a Windows Driver Model WDM driver Windows 2000 will report device conflicts between the driver and a Unknown PCI bridge device This is due to the HSS Windows NT 4 Software Driver not supporting PnP This reported conflict will not affect the performance of the driver under Windows 2000 CP SIO 4 Port WNT Driver v1 0 0
11. 3 Issue 1 2 CHSMANO04 WPD Page 17 of 23 Options Disable RX while TX RX Parity TX Parity NORMAL Normal operation Use this Diagnostics Mode 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 Loopback and echo operation occur simultaneously CRC Constant 0 CRC Preset RX 0x0000 or CRC Preset TX OxFFFF 0bv0000000ssssssss SYNC register DLE register Obv0000000dddddddd CCII HSS 6 MAN 004 2009 09 03 Disable receiver while sending Receive and transmit parity Parity is ignored unless crc select LRC Set diagnostic mode External loopback RS 485 Connect TXD to RXD TXD to RXD TXCLK to RXCLK and TXCLK to RXCLK External loopback RS 232 Connect TXD to RXD TXCLK to RXCLK and RTS to CTS and CD For HSS Frontpanel I O Adapter Program elec interface RS232 int control and connect TXD to RXD TXCLK to RXCLK Ignore RTS CTL and CD CRC constant value Preset receiver transmitter CRC16 LRC These values should be preset to all ones or zeros depending on the BCS used BISYNC SYNC register Contains the value of the SYNC character stripped from incoming data on receive once the re
12. 8 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 Contents T SCOPE JE 1 1 1 identification a A Ta A A A aie Rte a ata 1 1 2 INTOUCIO Na M A i pie Peis rt adhe ee aia a 1 2 Applicable and Reference Documents oooocccccoc cece eee 2 2 1 Applicable Documents 55 Louer eii A ee GE HE ewe n RU UE UR id 2 2 2 Reference Documents 2 3 Configuration Procedure gt custodios e a o 3 3 1 Installing The HSS Windows NT 4 Software Driver Files ooooococoocooooocrro eee 3 3 2 Uninstalling The HSS Windows NT 4 Software Driver ooooocooccccccoono eee 3 3 3 Updating the Device Firmware 0 tenets 3 3 4 Usmo the Event Viewer vsus E EKTET ii eux RR A TR D IRR RR 4 4 Application Program Interface llllle ee 5 4 1 Windows SDK Serial Functions llssllseleeee ees 5 4 2 Windows SDK Serial Structures llis as 5 4 3 Function Limitations a i peaa iama nna cc hh 5 4 3 1 ClearCommError o 5 4 3 2 GetComMmMask o o o ooo llenas 5 4 33 SetCommMask 00 ia ece Carine ec Yt o Des DO CAT RU a dye YER er ge AA Ra DOE oai 5 4 3 4 WaitCommEvent ree EEA Era has 6 4 3 5 Overlapped Writes lilslseeseseelee m hs 6 4 3 6 M FlushFileBuffers 0 0000s teenies 6 4 4 Struct re Limlitati rs rana a bedded A ti wd aaa A da idu 6 4 441 5GOMMGCONFIG 21i 2 uerb RETO Lr terra lea 6 4 42 GOMMBROP ra vieiras e aa 6 44 9 COMMTIMEQUTS sta rt
13. CK_EXT 1 4 for CLOCK_BRG4 Ports 1 4 CLOCK_EXT1 External Clocks connected CLOCK_EXT2 on Pins CLOCK_EXT3 RXCLK 1 4 RS 232 or CLOCK_EXT4 CLKIN 1 4 RS 485 RS 422 Note CLOCK_EXT 1 2 can only be used for SCC Ports 1 and 2 while CLOCK_EXT 3 4 can only be used for SCC Ports 3 and 4 Max RX Bytes 1 to 2 048 2 CRC bytes default Maximum number of bytes to receive before closing buffer Min Sync Pairs 0b0000 0 pairs 0b1111 16 pairs Minimum number of SYN1 SYN2 pairs sentbetween or before messages The entire pairis always sent regardless of the syn_length variable CRC Select CRC selection 1 CRC16 X16 X15 X2 1 Initialise prcrc and ptcrc to all zeros or all ones LRC sum check For even LRC initialise prcrc and pterc to zeros for odd LRC initialise to ones Enable RX BCS Enable Receive Block Check Sequence BCS Enable RX Transparent Enable Receiver transparent mode Mode FALSE Normal receiver mode with SYNC stripping and control character recognition TRUE Transparent receiver mode SYNC s DLE s and control characters 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 Reverse Data Enable Reverse data CCII HSS 6 MAN 004 2009 09 0
14. Disable Parity Checking o ues HW Enable Retransmit v Enable Flag Sharing H TX Parity RX Parity Clock Source J Enable Bus Mode ha M Enable RTS Made Max RX Bytes Max ldle Characters CRC Mode Fo Enable Mutitple Frames 2048 10 Send flags syncs v Enable RX BCS Encoding Method Preamble Length Pattern Enable RX Transparent Mode gt J Enable Reverse Data oO LOCK SETTINGS Advanced Settings C T 2 This port only supports the SMC protocol Systems il Cancel Apply Figure 10 SMC Dialogue 5 7 1 SMC UART Protocol Information Members Baud Rate 1 200 115 kbit s RS 232 RS 422 RS 485 Any values permissible Used to specify a single baud rate for both transmitter and receiver CLOCK_DEFAULT CLOCK_DEFAULT connects BRGs 1 2 to Ports 5 6 Clock Source CLOCK_BRG1 BRGs 1 4 Transmit and receive clocks can CLOCK_BRG2 be set to one of CLOCK BRG3 CLOCK BRG 1 4 or CLOCK BRG4 CLOCK EXT 1 4 CLOCK EXT1 External Clocks connected on CLOCK EXT2 Pins CLOCK EXT3 RXCLK 1 4 RS 232 or CLOCK_EXT4 CLKIN 1 4 RS 485 RS 422 Note CLOCK_EXT 1 2 can only be used for SMC Port 5 while CLOCK_EXT 3 4 can only be used for SMC Port 6 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 20 of 23 Name Options Description Stop bits ONE Number of full stop bits TWO Data Bits 5 Number of data bits Note on
15. LOCK_EXT1 CLOCK_EXT2 CLOCK_EXT3 CLOCK_EXT4 NORMAL LOOPBACK_ECHO BRGs 1 4 External Clocks connected on Pins RXCLK 1 4 RS 232 or CLKIN 1 4 RS 485 RS 422 Note CLOCK_EXT 1 2 can only be used for SCC Ports 1 and 2 while CLOCK_EXT 3 4 can only be used for SCC Ports 3 and 4 Normal operation Use this for external 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 The transmitter automatically resends received data bit by bit Loopback and echo operation occur simultaneously 1to 2 048 CRC bytes 2 or 4 default 1 to 2 048 default 0x0000 OXFFFF CCII HSS 6 MAN 004 2009 09 03 CHSMANO4 WPD Page 13 of 23 Description CLOCK DEFAULT connects BRGs 1 4 to Ports 1 4 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 For FMO 1 Manchester and Diff Manchester Transmit and receive clocks can be set to one of CLOCK BRG 1 4 or CLOCK EXT 1 4 HDLC CRC mode Set diagnostic mode External loopback RS 485 Connect TXD to RXD TXD to RXD TXCLK to RXCLK and TXCLK to RXCLK for synchronous mode External loopback RS 232 Connect TXD to RXD TXCLK to RXCLK for synchronous mode and RTS to CTS and CD For HSS Frontpanel I O Adapter
16. N 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 4 of 23 4 Application Program Interface The HSS Windows NT Software Driver complies to most of the Windows 32 Application Program Interface API for Serial devices Refer to the Platform SDK in 2 1 3 for the communications resource documentation The serial function prototypes can be found in the SDK file winbase h The device ports are named HSSx HSS1 HSS6 are the ports of the first device in the system HSS7 HSS12 are the ports of the second device 4 1 Windows SDK Serial Functions This paragraph lists the serial functions supported by the HSS Windows NT Software Driver BuildCommDCB BuildCommDCBAndTimeouts ClearCommError CommConfigDialog GetCommConfig GetCommMask GetCommProperties GetCommState GetCommTimeouts GetDefaultCommConfig PurgeComm SetCommConfig SetCommMask SetCommState SetCommTimeouts SetDefaultCommConfig SetupComm WaitCommEvent CreateFile ReadFile WriteFile CloseHandle m m m m O 4 2 Windows SDK Serial Structures This paragraph lists the serial structures supported by the HSS Windows NT Software Driver COMMCONF IG COMMP ROP COMMT IMEOUTS COMSTAT DCB 4 3 Function Limitations Not all settings are supported for each serial function This paragraph will mention all the exceptions 4 3 1 ClearCommError Only CE FRAME and CE RXPARITY are supported 4 3 2 GetCommMask Only the EV RXCHAR event mask is support
17. 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 defined by the protocol For HDLC the flag is defined as Ox7E NRZI encoding methods may only be used with flags syncs CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 14 of 23 5 5 2 Preamble Requirements Minimum Preamble Length Required Decoding Method Preamble Pattern Differential Manchester CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 15 of 23 5 6 BISYNC Mode This protocol may only be used with the four SCC ports HSS1 4 The BISYNC Dialogue windows is shown in Figures 8 and 9 The settings are described in Paragraph 5 6 1 SIO Adapter 4 Port Settings v1 0 Hsst uss2 Hss3 Hss4 Hsss Hsse Protocol Elec Interface C UART C wc Data Bits BISYNC UART Mode Baud Rate Rs232 int contr 115200 Stop bits s de Diagnostics Mode Y NORMAL m TX Parity Joop m RX Parity even m Max RX Bytes Max Idle Characters Encoding Method Clock Source CLOCK_DEFAULT Y CRC Mode B bit gt Preamble Length Pattern LOCK SETTINGS El Ayne How
18. anagement Controller TX Transmit WDM Windows Driver Model WMI Windows Management Instrumentation CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 1 Scope 1 1 Identification This documentis the User Manual for the C 1 System High Speed Serial HSS Windows NT 4 Software Driver 1 2 Introduction The HSS Windows NT 4 Software Driver is a low level device dependant interface for transferring data over a HSS Input Output I O Adapter The driver binaries are provided with explicit installation instructions The HSS Windows NT 4 Software Driver will also run as a legacy driver under Windows 2000 but does not support Plug and Play PnP Windows Management Instrumentation WMI or power management The driver software distribution consists of at least the following files hss4ntxyz zip Setup exe hss4wnt sys hss4port cpl flashprog exe hssReadme txt hssRelease_notes txt An archive file containing all the files required for The HSS Windows NT 4 Software Driver installation XYZ is the revision number for this driver release Install wizard application extracting the following files to the desired locations HSS 4 Channel Device Driver Control Panel Applet Flash update application General information Release notes and revision history Please check this file for information on the latest updates CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 1 of 23 2 Applicable and Reference Documents
19. ceiver 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 BISYNC DLE register In transparent mode the receiver discards any DLE character received v If v 1and 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 Issue 1 2 CHSMANO04 WPD Page 18 of 23 Control Characters 8 CCCCCCCC Valid entry Control character 1 to 8 CCCCCCCC Entry not valid and is not used Reserved Initialise to zero b z 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 LRC or CRC cccccccc 8 bits
20. ed 4 3 3 SetCommMask Only the EV RXCHAR event mask is supported CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 5 of 23 4 3 4 4 3 5 4 3 6 4 4 4 4 1 4 4 2 4 4 3 4 4 4 44 5 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 device 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 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 HSS Windows NT 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 dwProvSubT ype dwProvSpec1 dwProvSpec2 and wcProvChar are not supported COMMTIMEOUTS ReadintervalTimeout is not supported The write timeout value is used by the HSS Windows NT 4 Software Driver to flush its internal transmitter queue The inter
21. ed in filename Cook Inspect the HSS I O Adapter and find the oscillator module This is a silver can about 1 cm x 1 cm 0 4 x 0 4 in size The oscillator frequency is marked on the can On most adapters including the HSS Frontpanel I O Adapter it will be 39 3216 Use the corresponding S record file matching your oscillator frequency The S record filename will be ccHss4vx y z 39 3216 hex 39 3216 MHz oscillator on HSS I O Adapter ccHss4vx y z 39 9360 hex 39 9360 MHz oscillator on HSS I O Adapter ccHss4vx y z 40 0000 hex 40 0000 MHz oscillator on HSS I O Adapter ccHss4vx y z 48 0000 hex 48 0000 MHz oscillator on HSS I O Adapter ccHss4vx y z 50 0000 hex 50 0000 MHz oscillator on HSS I O Adapter Note X Y Z is the version of the firmware 3 4 Using the Event Viewer The Windows administrative tool Event Viewer can be used to inspect the event logs The HSS 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 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 ccHssvxyz hex Will update the firmware of the first device with the S record file ccHssvxyz hex Using channel number 7 will update the firmware on the second device CCII HSS 6 MA
22. itter and receiver Any values permissible Clock Source CLOCK_DEFAULT CLOCK_DEFAULT connects BRGs 1 4 to Ports 1 4 For synchronous UART 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 For asynchronous UART Transmit and receive clocks can be set to one of CLOCK BRG 1 4 or CLOCK_EXT 1 4 CLOCK_BRG1 Baud Rate Generators CLOCK_BRG2 BRGs 1 4 CLOCK_BRG3 CLOCK_BRG4 CLOCK_EXT1 External Clocks connected CLOCK_EXT2 on Pins CLOCK EXT3 RXCLK 1 4 RS 232 or CLOCK_EXT4 CLKIN 1 4 RS 485 RS 422 Note CLOCK EXT 1 2 can only be used for SCC Port 1 and 2 while CLOCK_EXT 3 4 can only be used for SCC Ports 2 and 3 Async Flow Control Normal or asynchronous flow control Stop bits Number of full stop bits Data Bits Number of data bits UART Mode NORMAL Select UART mode MAN MM Normal manual multidrop or automatic AUTO MM multidrop mode Freeze Transmit Pause freeze transmission Transmission continues when set back to normal RX with no stopbit set the receiver receives data without stop bits If Sync Mode Select asynchronous normal or synchronous mode Disable RX while TX Enable normal or disable receiver while transmitting Used in multidrop mode to prevent reception of own messages Disable Parity Enable or disable parity checking Checking TX parity RX parity Receive and transmit parit
23. ly 6 Ports 5 and 6 i e the SMC 7 ports support nine or more data 8 bits 9 10 11 12 13 14 Disable Parity Enable or disable parity Checking checking TX Parity ODD Receive and transmit parity EVEN Parity will only be checked if parity is enabled Diagnostics Mode NORMAL Normal operation Use this for Set diagnostic mode external loopback External loopback RS 485 Connect TXD to LOOPBACK Internal loopback RXD and TXD to RXD TXD and RXD are connected internally The value on RXD is External loopback RS 232 ignored Connect TXD to RXD ECHO The transmitter automatically resends received data bit by bit LOOPBACK ECHO Loopback and echo operation occur simultaneously Max RX Bytes 1 to 2 048 default Maximum number of bytes that may be copied into a buffer Max ld le 0to 2048 default Maximum idle characters When Characters 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 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO04 WPD Page 21 of 23 6 1 6
24. nal queue is only used when one byte is transmitted at a time COMSTAT Only cbinQue and cbOutQue are supported in this structure DCB The following fields are not supported fOutxDsrFlow fDtrControl fDsrSensitivity fTXContinueOnXotf fOutX fInX fErrorChar fNull fRtsControl fAbortOnError XonLim XoffLim XonChar XoffChar ErrorChar EofChar EvtChar StopBits of ONEBSTOPBITS is not supported by the HSS Windows NT Software Driver Note The XON XOFF flow control is not supported by the HSS Windows NT Software Driver To use no flowcontrol the fOutxCtsFlow field must be set to FALSE CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 6 of 23 5 Driver Protocol Settings The HSS I O Adapter has four serial communications controllers SCC s Ports 1 4 that support UART and HDLC SDLC protocols and two serial management controllers SMC s Ports 5 and 6 that support only asynchronous UART The control panel applet allows the user to set all the protocol specific options available on the HSS I O Adapter communication controller chip the MPC860 PowerQUICC 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 5 1 Protocol Selection Each port must be configured to use a protocol and electrical interface Protocol UART HDLC BISYNC SMC_UART Elec Interface only used for HSS F
25. rasala diarrea rd aha 6 444 COMSTA T o ta o Stine ek A eee A ole A A a GA AS eaters abe Bane pee 6 4450 DEB ai A fend AAE AS A A ard A Ga wee Ler eee 6 5 Driver Protocol Settings 25051020 online aaa cs 7 5 1 Protocol Selection 4o A e OP AAA AAA AAA e bah e CaS 7 5 2 Using the Control Panel to Change Port Settings ooooococccccncoo sees 8 5 3 Using the Control Panel to Obtain the Current Version Information lille 8 5 4 VART Mode to o A Rue me us E sient MR E RR EIA RS 9 5 4 14 UART Protocol Information llli 10 5 5 POLG Dr 12 5 5 1 HDLC Protocol Information Members oooooooocoor e 13 5 5 2 Preamble Requirements Tarip E EAEE ee hn 15 5 6 BISYNG Mode 1 5 adi euet esten bic ee RU SL Pre ete i CECI TR tas 16 5 6 1 BISYNC Protocol Information Members 0 000 cece cette eens 17 5 7 SMG UART MOde cio exe ore er dO eu e dev ye bol eae A dee 20 5 7 1 SMC UART Protocol Information Members 0 00 cc eee eas 20 6 Getting Started Ters voto ve RE bet teca afloat le ken re ta ag he nh Eel So 22 6 1 Normal Write Operation assau 00 cent teens 22 6 2 Overlapped Read Operation 0 00 ccc tte 22 Ta Contact Delalls s 2235 ee eee eee AR A a be hu eae as 23 7 1 CONTACT Perso zr A AAA ideo e Raed Tn D ae ee oe bye A a 23 7 2 Physical Address oe yaa deret eine Yd aod fee ji Mee je Ye wat Pek ees 23 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 7 3 Po
26. rontpanel I O Adapters RS 485 RS 485 422 RS 232 int control RS 232 control lines RTS CTS CD are connected internally RS 232 ext control RS 232 control lines RTS CTS CD need to be connected externally The protocol settings for the device can be set through a control panel applet Access 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 HOH Figure 2 Applet Icon CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO04 WPD Page 7 of 23 5 2 Using the Control Panel to Change Port 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 HSS port 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 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
27. stal Addresser onc A O ES AS AA AO A 23 7 4 Voice and Electronic Contacts ee eee eee eee 23 7 5 Product SUpport 25 ak Sie ERROR IM trae teins Siar iaa ee ae See ee eens Seer eee RE 23 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 List of Illustrations Figure T Installation Wizard coe er iaa a tit dis 3 Figure 2 x Applet GO s etii ra att aa ala a area ea decals a dae apta 7 Figure 3 Driver Information Dialogue 0 0 ccc tees 8 Figure 4 VART Dialogue seem id eee yet nM cd ene e Yen e b eem Yen eee e 9 Figure 5 UART Advanced Dialogue 1 ia opor ei a ts yn o ntel pee pic A 9 Figure 6 HDEG Dialogue s v ace are tex ether ei bet eae dere usw n tueix dea EA Rie 12 Figure 7 HDLC Advanced Dialogue oococcoocococ mns 12 Figure 8 BISYNC Dialogue o oo ooocr hh 16 Figure 9 BISYNC Advanced Dialogue oooocococc eens 16 Figure 10 SMC Dialogue x ii A A ERAI NER RU a eee ee 20 CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 Abbreviations and Acronyms API Application Program Interface bit s Bits per second BRG Baud Rate Generator C I CCII Systems Pty Ltd HDD Hard Disk Drive HSS High Speed Serial 1 0 Input Output PC Personal Computer PCI Peripheral Component Interconnect PMC Peripheral Component Interconnect Mezzanine Card PnP Plug and Play RX Receive SBC Single Board Computer SCC Serial Communications Controller SDK Software Development Kit SIO Serial Input Output SMC Serial M
28. the Windows registry under the keys HKEY_LOCAL_MACHINE SYSTEM CurrentControlSet Services SIO4P DeviceX PortX 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 Windows NT 4 Software Driver information dialogue shown in Figure 3 The HSS Windows NT 4 Software Driver version is referring to the device driver itself It has the format X Y Z A change in X would indicate that the driver has an added feature Y would mean that a new driver engine is used in the device driver Z indicates any corrections to problems in the driver The Engine version must be identical to the firmware version for all adapters in the PC Normally this would only be different when the driver version is checked after a firmware update and the driver itself has not been updated Driver Information Driver version 1 0 0 Engine version 40 0 Firmware 1 d d Firmware 2 Not installed Firmware 3 Not installed Firmware 4 Not installed Note At least one port must be closed per device oe Figure 3 Driver Information Dialogue CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 8 of 23 5 4 UART Mode This protocol may only be used with the four SCC ports HSS1 4 The UART Dialogue window is shown in Figures 4 and 5 The settings are described in Paragraph 5 4 1 SIO Adapter 4 Port Settings v
29. ws 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 Break Characters 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 Address1 Address2 0x0000 0x00FF Address in multidrop mode Only the lower 8 bits are used so the upper 8 bits should be cleared Control Characters 8 0b00 CCCCCCCC Valid entry Control character 1 to 8 These 0b10 CCCCCCCC Entry not valid and is not used characters can be used to delimit received messages 6 bits 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 control character mask A one Mask incoming character enables comparison and a zero masks it 0b11 11111111 Enable comparing the incoming character to cc n CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 11 of 23 5 5 HDLC Mode This protocol may only be used with the four SCC ports HSS1 4 The HDLC Dialogue windows is shown in Figures 6 and 7 The settings are described in Paragraph 5 5 1 SIO Adapter 4 Port Settings v1 0 Hsst Hss2 Hss3 Hss4 Hsss sss Protocol C UART HDLC C BISYNC
30. y Parity will only be checked if parity is enabled CCII HSS 6 MAN 004 2009 09 03 Issue 1 2 CHSMANO4 WPD Page 10 of 23 Diagnostics Mode NORMAL Normal operation Use this Set diagnostic mode for external loopback External loopback RS 485 Connect TXD to RXD TXD to RXD TXCLK to RXCLK and TXCLK to LOOPBACK Internal loopback RXCLK for synchronous mode TXD and RXD are connected internally The value on RXD CTS and CD is ignored The transmitter and receiver share the same clock source External loopback RS 232 Connect TXD to RXD TXCLK to RXCLK for synchronous mode and RTS to CTS and CD For HSS Frontpanel I O Adapter Program elec_interface RS232 int control and connect TXD to RXD TXCLK to RXCLK for synchronous mode Ignore RTS CTL and CD The transmitter automatically resends received data bit by bit LOOPBACK_ECHO Loopback and echo operation occur simultaneously 1 to 2 048 default Maximum number of bytes that may be Max RX Bytes copied into a buffer Max Idle Characters 0 to 2 048 default 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 follo
Download Pdf Manuals
Related Search