User Manual PMC High-Speed Serial Windows NT 4
Contents
1. char rx buffer 100 DWORD bytes_read 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 printf Data received n CloseHandle overlap hEvent CloseHandl h_device CCII HSS 6 MAN 004 2009 05 27 CHSMAN04 WPD Page 22 of 23 Issue 1 1 7 Contact Details 7 1 Contact Person Direct all correspondence and or support queries to the Project Manager HSS at C2l Systems 7 2 Physical Address CCII Systems Pty Ltd Unit 3 Rosmead Place 67 Rosmead Avenue Kenilworth 7708 Cape Town South Africa 7 3 Postal Address CCII Systems Pty Ltd 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 Awww ccii co za 75 Product Support Support on C l Systems products is available telephonically between Monday and Friday from 09 00 to2. CDis External loopback RS232 ignored The transmitter connect TXD to RXD TXCLK to and receiver share the RXCLK for synchronous mode and same clock source RTS to CTS amp CD ECHO The transmitter For HSS Front Panel I O Board automatically resends program elec_interface RS232 received data bit by bit int control and connect TXD to RXD TXCLK to RXCLK for synchronous mode Ignore RTS LOOPBACK_ECHO Loopback and echo CTL amp CD operation occur simultaneously Max RX Bytes 1 to 2048 default Maximum number of bytes that may be copied into a buffer Max Idle 0 to 2048 default Maximum idle characters When a character is received the receiver Characters 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 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 Cont
3. 1 CRC16 X16 X15 X2 1 initialise prere amp pterc to all zeros or all ones 2 LRC sum check for even LRC initialise prere 8 ptere to zeros for odd LRC initialise to ones Enable Receive Block Check Sequence BCS Enable RX 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 Enable Reverse data Disable Rx while Tx Disable receiver while sending CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 17 of 23 Rx Parity Tx Parity Diagnostics Mode CRC Constant CRC Preset RX CRC Preset TX SYNC register DLE register Obv0000000dddddddd NORMAL LOOPBACK ECHO LOOPBACK_ECHO 0 0x0000 or OxFFFF 0bv0000000ssssssss Normal operation Use this for external loopback Internal loopback TXD 8 RXD are connected internally The value on RXD CTS amp 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 simultaneo
4. CT Systems CCIl Systems Pty Ltd Registration No 1990 005058 07 Communications Computer Intelligence 2 Integration 2 User Manual for the PMC High Speed Serial Windows NT 4 Driver CI Systems Document No CCII HSS 6 MAN 004 Issue Date 2009 05 27 Print Date 2009 05 28 File Name P HSS TECH MAN CHSMAN04 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 and for CI Systems Cape Town Signature Sheet Completed by Gl R B ennet C I Systems Accepted by Lo NE Lm Project Manager HSS C l Systems Accepted by CCIVHSS 6 MAN 004 2009 05 27 CHSMANDA WPD Amendment History Changed title 2009 05 27 CCI BLPGEN 6 ECP 015 CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 Contents T CODE A is ees 1 1 1 identification a A A auntie Perea A aie Rte eur eee demas ata 1 1 2 INTOdUCIO Ma ra A le da pie Peis a upd ae a hia eaten adhe ee Ey ares Med 1 2s Applicable Documents 2 2 42 2 as yA Bet DESEO E a 2 2 1 Specifications acer raf A AL a A A A e deel RAYS Soe 2 22 Stonda wade A A A A A A AA E 2 2 3 Other Documents 34a eo as Pas cde Wy heed Pea ital Pb aie aoe Peat al SR Bhs 2 3 Configuration Procedure
5. XoffLim XonChar XoffChar ErrorChar EofChar EviChar StopBits of ONE5STOPBITS is not supported by the HSS device driver Note The XON XOFF flow control is not supported by the HSS device driver To use no flowcontrol the fOutxCtsFlow field must be set to FALSE CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 6 of 23 5 1 Driver Protocol Settings The HSS PMC 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 586 that support only asynchronous UART The control panel applet allows the user to set all the protocol specific options available on the HSS PMC communication controller chip the MPC860 PowerQUICC For available options for each of the fields see 2 3 1 This section details the information used by each protocol and explains the use and limitations of every member 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 Front Panel boards RS485 RS485 422 RS232 int control RS232 control lines RTS CTS CD are connected internally RS232 ext control RS232 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
6. 00 Sync Character Preset TX 4 0x 8000 ox 0000 ox 0000 5 Ox 8000 Syn Length SYNC register lt 0000 6 Ox 8000 A 7 0x 8000 RX Control Character Mask DLE register Ox E000 Ox 0000 8 Ox 8000 Figure 9 BISYNC Advanced Dialog CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMANO4 WPD Page 16 of 23 5 6 1 BISYNC Protocol Information Members Options Description Baud Rate 1200 115kbps RS232 This member is used to specify a 1200 12Mbps RS422 RS485 single baudrate for both transmitter Any values permissible and receiver Clock Source CLOCK_DEFAULT CLOCK_DEFAULT connects BRG 1 4 to Port 1 4 CLOCK_BRG1 Baudrate Generators 1 4 When the transmit clock is set to CLOCK_BRG2 CLOCK_BRG3 CLOCK_BRG4 CLOCK_BRG 1 4 then receive clock is still set to CLOCK_EXT 1 4 for Port 1 4 CLOCK_EXT1 External Clocks connected CLOCK_EXT2 on Pins RXCLK 1 4 CLOCK_EXT3 RS232 or CLKIN 1 4 CLOCK_EXT4 RS485 RS422 Note CLOCK_EXT 1 2 can only be used for SCC Port 1 amp 2 while CLOCK_EXT 3 4 can only be used for SCC Port 3 amp 4 Max RX Bytes 1 to 2048 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 sent between or before messages The entire pair is always sent regardless of the syn_length variable CRC Select 16 CRC selection LRC
7. 17 00 CAT Central African Time CAT GMT 2 Email support is available at support ccii co za CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 23 of 23
8. 7 5 Product S ppo a DAAA wh and Saas en eee 23 CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 List of Illustrations Installation Wizard a e fk ial ee da ee ea ee dee Se ee ee A A peed ee 3 AOPE ICON cris Seale a a a ic Gerdes eds a AS Mae aire Wray 7 Driver Information Dialog sessed ie beta de bai he hee ad eed eee BA ae 8 VART Dialog ista toate secret dio a aoa dim A an E EEEE A 9 UART Advanced Dialogs ios kiera weed pds cae dae wad bedi A weed pte e aed dae ease Bae 9 HDLG Dialog ance geet eine BAe oe he Ga eee oe SL Facet ee Shoe cee ven Se 12 HDLC Advanced Dialog 00 0 cee nett eens 12 BISYNG Dialog 0 a ain oe ee 16 BISYNC Advanced Dialog 0 00 cnt eens 16 SOMG Dialog iu AAN 20 CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 Abbreviations and Acronyms API Application Program Interface BIT Built In Test BRG Baudrate Generator CCIl Communications Computer Intelligence Integration GE C2l2 Systems Pty Ltd HDD Hard Diskdrive HSS High Speed Serial Acronym for the C2l PMC Serial I O card project 1 0 Input Output PC Personal Computer PCI Peripheral Component Interconnect PMC PCI Mezzanine Card PnP Plug and Play SBC Single Board Computer SCC Serial Communications Controller SDK Software Development Kit SIO Serial Input Output SMC Serial Management Controller TBD To Be De
9. OCK_DEFAULT connects BRG 1 2 to Port 5 6 CLOCK_BRG1 Baudrate Generators 1 4 Ale 8 receive clocks CLOCK_BRG2 can 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 RXCLK 1 4 RS232 or CLOCK_EXT3 CLKIN 1 4 RS485 RS422 CLOCK_EXT4 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 Stop bits Number of full stop bits CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMANO04 WPD Page 20 of 23 Data Bits 5 Number of data bits Note 6 only ports 5 amp 6 i e the SMC 7 ports can select 9 or more 8 data 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 operation Use this for Set diagnostic mode external loopback External loopback RS485 connect TXD to RXD amp LOOPBACK Internal loopback TXD amp RXD TXD to RXD are connected internally The value on RXD is ignored External loopback RS232 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 2048 default Maximum number of bytes that may be copied into a buffer Max Idle O to 2048 default Maximum idle characters Charact
10. Source 7 Enable Bus be al 3 JT Enable RTS Mode Max RX Bytes Max Idle Characters CRC Mode Enable Multiple Frames 2048 10 J Send flaqs synes IV Enable RX BCS Encoding Method Preamble Length Pattern Enable RX Transparent Mode z gt zj _ Enable Reverse Data O Lock SETTINGS Advanced Settings T 2 CPF Systems HSS 4 Port SIO PMC adapter ems il OK Cancel Figure 4 UART Dialog UART Advanced Settings xi Break Characters Control Characters 1 Ox 8000 2 Ox 8000 Multidrop Mode 3 Ox 8000 Address 1 Ox 0000 4 Ox 8000 Address 2 15 Ox 8000 Ox 0000 6 Ox 8000 8000 RX Control Character Mask fale Ox CODO 8 Ox 8000 Cancel Apply Figure 5 UART Advanced Dialog UAT CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMANO04 WPD Page 9 of 23 5 4 1 UART Protocol Information a na en Baud Rate 1200 115kbps RS232 This member is used to specify a 1200 2 4Mbps RS422 RS485 single baudrate for both transmitter Any values permissible and receiver Clock Source CLOCK_DEFAULT CLOCK_DEFAULT connects BRG 1 4 to Port 1 4 For synchronous UART when transmit clock is set to CLOCK_BRG 1 4 then receive CLOCK_BRG1 Baudrate Generators 1 4 dE s CLOCK BRG2 clock is still set to CLOCK_EXT 1 4 for Port 1 4 DB For asynchronous UART transmit amp receive clocks can be set to one f CLOCK BRG 1 4 or CLOCK
11. 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 Address 4 Minimum number of flags between or before frames Flags between 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 in transmit Enable Multiple Frames FIFO NRZ Rx Tx encoding method NRZ NRZI_MARK and NRZI use no DPLL FMO 1 NRZI_SPACE Manchester amp Diff_Manchester FMO use the DPLL for clock FM1 recovery The clock rate is 16x MANCHESTER when the DPLL is used DIFF_MANCHESTER Encoding Method 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 0x7E NRZI encoding methods may only be used with flags syncs CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 14 of 23 5 5 2 Preamb
12. X BCS Encoding Method Preamble Length Pattern TT Enable RX Transparent Mode nrz o fio JP Enable Reverse Data O LOCK SETTINGS Advanced Settings T 2 CF Systems HSS 4 Port SIO PMC adapter il OK Cancel Figure 6 HDLC Dialog HDLC Advanced Settings Max Frame Bytes Addresses Flags Between Frames h 1 Ox 0000 0 Address Mask 2 0x 0000 ox 0000 61 ox 5000 4 Ox 9000 cora ase Figure 7 HDLC Advanced Dialog CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 12 of 23 5 5 1 Baud Rate Clock Source CRC Mode Diagnostics Mode Max RX Bytes Max Frame Bytes Address Mask HDLC Protocol Information Members Options 1200 115kbps RS232 1200 12Mbps RS422 RS485 Any values permissible CLOCK_DEFAULT CLOCK_BRG1 CLOCK_BRG2 CLOCK_BRG3 CLOCK_BRG4 CLOCK_EXT1 CLOCK_EXT2 CLOCK_EXT3 CLOCK_EXT4 NORMAL LOOPBACK LOOPBACK_ECHO Baudrate Generators 1 4 External Clocks connected on Pins RXCLK 1 4 RS232 or CLKIN 1 4 RS485 RS422 Note CLOCK_EXT 1 2 can only be used for SCC Port 1 amp 2 while CLOCK_EXT 3 4 can only be used for SCC Port 3 amp 4 Normal operation Use this for external loopback Internal loopback TXD amp RXD are connected internally The value on RXD CTS amp CD is ignored The transmitter and receiver share the same clock source The t
13. _EXT1 External Clocks connected Y CLOCK _EXT2 on Pins RXCLK 1 4 CLOCK ExT toa CLOCK_EXT3 RS232 or CLKIN 1 4 CLOCK_EXT4 RS485 RS422 Note CLOCK_EXT 1 2 can only be used for SCC Port 1 amp 2 while CLOCK_EXT 3 4 can only be used for SCC Port 2 amp 3 Async Flow Control Normal or asynchronous flow control Stop bits ONE Number of full stop bits TWO Data Bits Number of data bits UART Mode NORMAL Select UART mode normal MAN MM manual multidrop or automatic AUTO MM multidrop mode Pause freeze transmission Transmission continues when set back to normal If set the receiver receives data without stop bits Sync Mode Select asynchronous normal o synchronous mode Freeze Transmit Rx with no stopbit 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 parity Parity will only be checked if parity is enabled CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 10 of 23 Diagnostics Mode NORMAL Normal operation Use this Set diagnostic mode for external loopback External loopback RS485 connect TXD to RXD TXD to RXD TXCLK to RXCLK and LOOPBACK Internal loopback TXD amp TXCLK to RXCLK for synchronous RXD are connected mode internally The value on RXD CTS amp
14. aracter Mask Sync Character Syn Length Enable flags syncs ObObh cccccccc Ob1bh cccccccc 0b11 00000000 0b11 11111111 Oxssss 2 bytes valid entry entry not valid and is not used ignore these bits when comparing incoming character enable comparing the incoming character to cc n CCII HSS 6 MAN 004 2009 05 27 CHSMAN04 WPD Page 19 of 23 Control character 1 to 8 5 bits reserved Initialise to 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 LRC 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 Receive control character mask A one enables comparison and a zero masks it SYNC character should be programmed with the sync pattern SYNL_8 implement mono sync protocol The receiver sync
15. ers 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 CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 21 of 23 6 1 6 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_send 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 fO0utxCtsFlow 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
16. evice 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 cards 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 Firmyvare 1 Sin Firmware 2 Not installed Firmware 3 Not installed Firmware 4 Not installed Note At least one port must be closed per device concer Figure 3 Driver Information Dialog CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMANO04 WPD Page 8 of 23 5 4 UART Mode This protocol may only be used with the four SCC ports HSS1 4 The UART Dialog window is shown in Figures 4 and 5 The settings are described in Paragraph 5 4 1 SIO Adapter 4 Port Settings v1 0 Hsst Hss2 Hss3 Hss4 Hsss Hsse Protocol Elec Interface Baud Rate TT Aye Flow Control UART 115200 7 Freeze Transmit 7 Rx with no stopbit Data Bits Stop bits J Synchronous Mode C BISYNC 8 1 2 7 Disable Rx while Tx UART Mode Diagnostics Mode J Disable Parity Checking E B IP Enable Retransmit v v J Enab Jaring e Flag She TX Parity RX Parity Clock
17. hronizes on an 8 bit sync pattern in sync should be chosen to SYNL_16 The receiver synchronizes on a 16 bit sync pattern stored in sync Send either idles or flags syncs between frames as defined by the protocol The flag character is equal to sync Issue 1 1 5 7 SMC UART Mode This protocol may only be used with the two SMC ports HSS5 amp 6 The SMC Dialog window is shown in Figure 10 The settings are described in Paragraph 5 7 1 SIO Adapter 4 Port Settings v1 0 Hsst Hss2 Hss3 Hss4 HSS5 Hsse Protocol Elec Interface Baud Rate C UART 115200 y Em Data Bits m Stop bits C BISYNC E I loi A o E UART Mode Diagnostics Mode v e TX Parity RX Parity Clock Source Ba of v v Aync Floyy Contro Freeze Transmit kx with no stopbit Synchronous Mode Disable Rx while Tx Disable Parity Checking Enable Retransmit DEBE Bele a Max RX Bytes Max Idle Characters CRC Mode 2048 10 v Encoding Method Preamble Length Pattern 7 Enable Ry O Lock SETTINGS Advanced Settings CT This port only supports the SMC protocol systems i ceca are Figure 10 SMC Dialog 5 7 1 SMC UART Protocol Information Members Name Options Description Baud Rate 1200 115kbps RS232 RS422 RS485 This member is used to Any values permissible specify a single baudrate for both transmitter and receiver Clock Source CLOCK_DEFAULT CL
18. iver 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 ports on the device are closed The firmware images are located on the supplied CD ROM or the C2l Systems website Do not remove the power from the PC until the flash programming is completed CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 3 of 23 3 4 The syntax for the application is as follows Flashprog exe b s u filename The port 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 stored in filename coo Note 1 Only one port per device must be specified Note 2 Whenever the firmware is updated the current firmware
19. knhe phketnheuteantdhen nt ob oia 7 5 1 Protocol Seleccion ii A A AAA AE eile Few A Pa A hae E 7 5 2 Using the Control Panel to Change Port Settings 000 cece teens 8 5 3 Using the Control Panel to Obtain the Current Version Information 0 0 ccc cece eee eee 8 5 4 UART MOUS sitas da a Gand acest id washes Mabie Aa OE 9 5 4 1 UART Protocol Information oo ooooocoooocor eee 10 5 5 ADLE MOOG sota rad A ad a a ada 12 5 5 1 HDLC Protocol Information Members oooooooooooor 13 5 5 2 Preamble Requirements oooo ococccocooc eae 15 5 6 BISYNG Mode oi A A dnc Aven dl awe a ca ada aa Medea ad a 16 5 6 1 BISYNC Protocol Information Members 0 000 ccc ene nee eens 17 5 7 SMC UART Mode vico serail ts tice fee andes a dad al Bata ot aiid vata ae aaa eh oda ak 20 5 7 1 SMC UART Protocol Information Members 0 00 ccna 20 67 Getting Started e Se ustara lists a il ey ia lage car aia 22 6 1 Normal Write Operation ccc teen eee 22 6 2 Overlapped Read Operation auauna cette eens 22 Ts G ntact Details ia a ee desea ata AS EA es se EEn AS el ese Ae a Na ea 23 7 1 Contact PerSON 00 ARA A A a AA dd E Aa A E A 23 CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 7 2 Physical Address sans wen A eee Mea A aed oe eke hae Cae coe en Sane teed 28 23 7 3 Postal Adri da ld Revenge mee ts ee Me Sean ie Ae ee oe tac to cea ease 23 7 4 Voice and Electronic Contacts ee eee eee 23
20. le Requirements Decoding Method Preamble Pattern Minimum Preamble Length Required All ones All zeros Manchester 101010 10 Differential Manchester CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 15 of 23 5 6 BISYNC Mode This protocol may only be used with the four SCC ports HSS1 4 The BISYNC Dialog 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 Baud Rate F ync Flow Control C UART R5232 int contr 115200 HDLC x With no stophit Data Bits Stop bits F Synchronous Mode BISYNC 8 E 1 2 PF Disable Rx while Tx E UART Mode Diagnostics Mode IF Disable Parity Checking IF Enable Retransmit NORMAL had bee JP Enable Flag Sharing TX Parity RX Parity Clock Source F Enab de Joop even gt cLock_DEFAULT gt 7 Enable RTS Moc je Max RX Bytes Max Idle Characters CRC Mode FO Enable Multitple Frames 2048 10 Encoding Method Preamble Length Pattern f Enable RX O Mode Juez gt E gt fic TT Enable Reverse Data LOCK SETTINGS Advanced Settings 2 CP Systems HSS 4 Port SIO PMC adapter Systems il Cancel Apply Figure 8 BISYNC Dialog BISYNC Advanced Settings Min Sync Pairs Control Characters 1 Ox 8000 CRC Select Preset RX 2 Ox 8000 Ox 0000 3 0x 80
21. 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 card 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 device driver This paragraph will mention all the exceptions COMMCONFIG dwProviderSubType none of the types makes provision for a device that is both RS232 and RS422 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 HSS driver to flush its internal transmitter queue The internal queue is only used when one byte is transmitted at 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
22. ndards 2 2 1 DI IPSC 81443 Data Item Description for a Software User Manual 2 3 Other Documents 2 3 1 MPC860 PowerQUICC User s Manual Rev 1 http e www motorola com 2 3 2 MSDN Communications Resources http msdn microsoft com library default asp url library en us devio base communications_resources asp CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 2 of 23 3 1 3 2 3 3 Configuration Procedure This paragraph describes the installation procedure for the HSS driver Installing the Driver Files Unzip the file hss4ntxyz 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 driver files will be extracted to the required locations i 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 Files C2I2Systems SIO4Port 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 NT 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 Ee Communications Computer Intelligence Integration _ coa Figure 1 Installation Wizard Uninstalling the Dr
23. occ ti A beeen Geen en Gen ene 3 3 1 Installing the Driver Files ee rere rererere rerda tia rE DEEA nee ee 3 3 2 Uninstalling the Driver syre rerit eusa PEE EEUE E UE e ERA EE EE TE EUR E ERE ORS 3 3 3 Updating the Device Firmware orrera sraa anska a SK TOR EKTE ERK eens 3 3 4 Using the Event Viewer rissaa eran Aa E PAI S AI E ATEA TAIE PENE FAIT EETA 4 4 Application Program Interface API 0 0 00 5 4 1 Windows SDK Serial Functions 0 0 0 00 eee nee n tenes 5 4 2 Windows SDK Serial Structures 1 0 0 cc eee nee nents 5 4 3 Function Limitations 000000 eee eee 5 43 1 ClearCommError o 5 432 GeICOMMMASK aa a E at lat Bay A la ew aid 5 4 3 3 SetCommMask 0 ccc eee ene been beeen een een neeans 5 4 3 4 WaitCommEvent 0 0 00 eee ene nee n eens 6 4 3 5 Overlapped Writes saanuna aaea 6 43 6 FlushPileButlers sish tac airada atari wade abet ede ed ae eee Pei eee 6 4 4 Structure Limitations 4 2h004 ahae eth wedi atada bia dee Greet a da das 6 4 41 COMMGONEIGI 1 0040 a4 artes Gada Ad wh be Gilet Sawada we eared he 6 4 4 2 7COMMPROP atari daras Gh alates nd oh alae is batata das 6 4 4 3 COMMTIMEOUTS 0 ccc een een eee nee nee nee E GURS 6 44 4 GCOMSTAT sarrin a oat ei RG De Leena ae RR Oe Pane aa ee Re Ee Peg E 6 AAS DCB bee chica Md a Monat hay SE WOES cere Ri Mend hy ENE AES beat aes 6 5 Driver Protocol SeningS lt lt i0 lt ich piece nhe
24. ransmitter automatically resends received data bit by bit Loopback and echo operation occur simultaneously 1 to 2048 CRC bytes 2 or 4 default 1 to 2048 default 0x0000 OxFFFF CCII HSS 6 MAN 004 2009 05 27 Description CLOCK_DEFAULT connects BRG 1 4 to Port 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 Port 1 4 For FMO 1 Manchester Diff Manchester transmit amp 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 RS485 connect TXD to RXD TXD to RXD TXCLK to RXCLK and TXCLK to RXCLK for synchronous mode External loopback RS232 connect TXD to RXD TXCLK to RXCLK for synchronous mode and RTS to CTS amp CD For HSS Front Panel I O Board program elec_interface RS232 int control and connect TXD to RXD TXCLK to RXCLK for synchronous mode Ignore RTS CTL 8 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 2 or 4 per frame HDLC address mask Aone enables comparison and a zero masks it Issue 1 1 CHSMAN04 WPD Page 13 of 23 0x0000 OxFFFF Four address registers for address recognition
25. rm SDK in 2 3 2 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 device 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 device 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 supported 4 3 3 SetCommMask Only the EV_RXCHAR event mask is supported CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 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 4 4 5 WaitCommEvent Only the EV_RX_CHAR event
26. rol cccccccc valid entry Control character 1 to 8 These cccccccc entry not valid and is not used characters can be used to delimit Characters 8 received messages 6 bits reserved Initialise to cccccccc 8 bits defines control characters to be compared to the incoming character RX Control 0b11 00000000 ignore these bits when Receive control character mask A comparing incoming character one enables comparison and a zero Character Mask 0b11 11111111 enable comparing the incoming masks it character to cc n CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 11 of 23 5 5 HDLC Mode This protocol may only be used with the four SCC ports HSS1 4 The HDLC Dialog 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 Hss Protocol Elec Interface Baud Rate F Ayne Flow Control C UART R5232 int contr 115200 wi F Freeze Transmit Rex with no stopbit e HDLC F E Data Bits Stop bits IF Synchronous Mode BISYNC 8 E 1 C2 J Disable Rx while Tx UART Mode Diagnostics Mode E Disable Rarity Encina Enable Retransmit Y NORMAL ed Enable Flag Sharing TX Parity RX Parity Clock Source Enable Bus Mode z 7 CLOCK_DEFAULT Y J Enable RTS Mode Max RX Bytes Max Idle Characters CRC Mode Enable Multitple Frames 2048 10 7 J7 Send flags syncs JV Enable R
27. selecting the Control Panel from the Settings option Click on the icon shown in Figure 2 HOHP Figure 2 Applet Icon CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 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 dialog must be entered to create a valid protocol setting Always click the Apply button before closing any of the dialog 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 baudrate 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 baudrate 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 S1O4P DeviceX Portx 5 3 Using the Control Panel to Obtain the Current Version Information Clicking on the Information icon near the bottom of the dialog screen will display the driver information dialog shown in Figure 3 The Driver version is referring to the d
28. termined WDM Windows Driver Model WMI Windows Management Instrumentation CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 As Scope 1 1 Identification This document is the User s Manual for the C 1 Systems Peripheral Component Interconnect PCI Mezzanine Card PMC High Speed Serial Windows NT 4 Driver 1 2 Introduction The PMC High Speed Serial HSS driver is a low level device dependant interface for transferring data over a C I Systems HSS PCI Mezzanine Card PMC The driver binaries are provided with explicit installation instructions The 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 An archive file containing all the files required for the driver installation XYZ is the revision number for this driver release Setup exe Install wizard application extracting the following files to the desired locations hss4wnt sys HSS 4 Port Device Driver hss4port 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 HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 1 of 23 2 Applicable Documents 2 1 Specifications Not applicable 2 2 Sta
29. usly CCII HSS 6 MAN 004 2009 05 27 CHSMAN04 WPD Page 18 of 23 Receive and transmit parity Parity is ignored unless crc_select LRC Set diagnostic mode External loopback RS485 connect TXD to RXD TXD to RXD TXCLK to RXCLK and TXCLK to RXCLK External loopback RS232 connect TXD to RXD TXCLK to RXCLK and RTS to CTS amp CD For HSS Front Panel I O Board program elec_interface RS232 int control and connect TXD to RXD TXCLK to RXCLK Ignore RTS CTL amp 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 receiver synchronizes to the data using the SYN1 SYN2 pair v if v 1and 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 1 Control Characters 8 RX Control Ch
30. 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 port number 7 will update the firmware on the second device Inspect the HSS PMC card and find the oscillator module This is a silver can about 1cm x 1cm 0 4 x 0 4 in size The oscillator frequency is marked on the can On most boards including the front panel board 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 PMC card ccHss4vx y z 39 9360 hex 39 9360 MHz oscillator on PMC card ccHss4vx y z 40 0000 hex 40 0000 MHz oscillator on PMC card ccHss4vx y z 48 0000 hex 48 0000 MHz oscillator on PMC card ccHss4vx y z 50 0000 hex 50 0000 MHz oscillator on PMC card Where x y z is the version of the firmware Using the Event Viewer The Windows administrative tool Event Viewer can be used to inspect the event logs The HSS driver logs certain information and fatal errors to the event log Refer to the event log when an operation does not function as expected CCII HSS 6 MAN 004 2009 05 27 Issue 1 1 CHSMAN04 WPD Page 4 of 23 4 Application Program Interface API The HSS Windows NT driver complies to most of the Windows 32 API for Serial devices Refer to the Platfo
Download Pdf Manuals
Related Search