Home

User Manual 4-Channel New Generation 8-Channel High

1. On success If opening of port failed Invalid dev id or port id supplied or the function has been called with the incorrect number of variables If the port does not exist If an Open is attempted on a port before configuring the port If no PCI buffer is available Ifthe HSS8 control block could not be accessed within a certain time If failed to create semaphore or spawn tasks hss8Status hss80pen port hss8ArgType num args Note This function must be called prior to attempting to send or receive on the specified port Opening a port spawns a receive send and clock detect task for that specific port The priority of these tasks is specified by the user CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 17 of 51 6 2 6 Close Port Function Purpose Arguments num args dev id port id Returns HSS8 OK HSS8 ERROR HSS8 INVALID PARAM HSS8 PORT NOT INSTALLED HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING hss8Close port Close specified port for send and receive The number of arguments to follow Needs to be at least two dev id port id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Port to close for send and receive On success If opening of port failed or Rx Tx tasks have not been destroyed Invalid dev id or port id supplied or the function has been called wit
2. Receive control character mask A one enables comparison and a zero masks it SYNC character Should be programmed with the sync pattern HSS8 BISYNC SYNL 8 Should be chosen to implement mono sync protocol The receiver synchronizes on an 8 bit sync pattern in sync HSS8 BISYNC 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 6 6 3 4 SMC UART Mode This protocol may only be used with the four SMC channels Channels L 6 3 4 1 SMC UART Protocol Information Structure The following structure is defined in the file hss8Controllfc h and is given here in abbreviated format i e reserved and obsolete members are not shown Always use the structure as defined in hss8Controllfc h struct hss8SmcUartInfoStruct hss8UINT32 hss8UINT32 hss8UINT32 hss8UINT32 hss8UINT32 hss8UINT32 hss8UINT32 hss8UINT32 y max receive bytes max idl data bits stop bits parity enable parity mode diag mode baud rate typedef struct hss8SmcUartInfoStruct hss8SmcUartInfo CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 47 of 51 6 3 4 2 SMC UART Protocol Information Structure Members m mes e o baud rate 1 200 115 2 kbit s RS 232 RS 422 485 Any values permissible The equation to calculate the
3. The number of arguments to follow Needs to be at least one dev id esa on the PCI bus The HSS8 device in the lowest PCI sae ii 0 next HSS8 device lt dev_id gt 1 etc Returns On success Invalid lt dev_id gt supplied or the function has been called with the incorrect number of variables HSS8 PCI INIT FAIL PCI initialisation failed HSS8 ERROR Device has already been destroyed HSS8 OK HSS8 INVALID PARAM hss8Status hss8Destroy device hss8ArgType num args Note After this function is called no other function call to the specified device will be valid except for hss8Create_device CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 14 of 51 6 2 3 Set Port Configuration Function Purpose Arguments num args dev id port id p info Returns HSS8 OK HSS8 PCI INIT FAIL HSS8 ERROR HSS8 INVALID PARAM HSS8 PORT NOT INSTALLED HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING hss8Set port config Set port protocol and protocol configuration The number of arguments to follow Needs to be at least three dev id port id p info Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Port to configure Pointer to information struct hss8Protocollnfo used for configuration On success PCI initialisation failed If the Tx Rx tasks have not been destroyed Invali
4. The transmitter automatically resends received data bit by bit Loopback and echo operation occur simultaneously 1 to 2 048 default or up to 32 kBytes depending on how many bytes have been allocated to the RX and TX buffers See function hss8Create device O to 2 048 default or up to 32 kBytes depending on how many bytes have been allocated to the RX and TX buffers See function hss8Create_device Pause freeze transmission Transmission continues when set back to normal If set to none 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 RS 422 485 Connect TxD to RxD TxD to RxD CLK_OUT to CLK_IN and CLK OUT to CLK IN for synchronous mode loopback 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 id idle characters are received before the next data character an idle timeout occurs and the buffer is closed Thus max idl offers a way
5. baud rate clock source crc mode 1 200 1 Mbit s RS 232 1 200 16 Mbit s RS 422 485 Any values permissible 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 HSS8 CLOCK DEFAULT BRGs 1 4 BRG1 for Channels A and E BRG2 for Channels B and F BRG3 for Channels C and G BRG4 for Channels D and H HSS8_CLOCK_BRG1 HSS8_CLOCK_BRG2 HSS8_CLOCK_BRG3 HSS8_CLOCK_BRG4 HSS8_CLOCK_EXT1 HSS8_CLOCK_EXT2 HSS8_CLOCK_EXT3 HSS8_CLOCK_EXT4 Note HSS8 CLOCK EXT 1 2 can only be used for Channels A and B and E and F while HSS8 CLOCK EXT 3 4 can only be used for Channels C and D and G and H External Clocks connected on CLK IN Pins HSS8_HDLC_CRC_MODE_16_BIT HSS8_HDLC_CRC_MODE_32_BIT CCII HSS8 6 MAN 002 2015 09 18 Used to specify a single baud rate for both transmitter and receiver Units in bit s HSS8 CLOCK DEFAULT connects BRGs 1 4 to Channels A D and Channels E H For NRZ NRZI When transmit clock is set to HSS8_CLOCK_BRG 1 4 then receive clock is still set to HSS8 CLOCK EXT 1 4 for Channels A
6. Actual baud rate 100 MHz ROUND 100 MHz Desired baud rate Where ROUND implies that the result is rounded to the nearest integer HSS8 CLOCK DEFAULT HSS8_CLOCK_BRG1 HSS8_CLOCK_BRG2 HSS8_CLOCK_BRG3 HSS8_CLOCK_BRG4 HSS8_CLOCK_EXT1 HSS8_CLOCK_EXT2 HSS8_CLOCK_EXT3 HSS8_CLOCK_EXT4 BRGs 1 4 BRG1 for Channels A and E BRG2 for Channels B and F BRG3 for Channels C and G BRGA for Channels D and H External Clocks connected on CLK IN Pins Note HSS8 CLOCK EXT 1 2 can only be used for Channels A and B and E and F while HSS8_CLOCK_EXT 3 4 can only be used for Channes C and D and G and H 1 to 2 048 2 CRC bytes default or up to 32 kBytes 2 CRC bytes depending on how many bytes have been allocated to the RX and TX buffers See function hss8Create_device 0b0000 0 pairs 0b1111 16 pairs HSS8 BISYNC CRC MODE 16 HSS8 BISYNC CRC MODE LRC TRUE FALSE CCII HSS8 6 MAN 002 2015 09 18 CH8MANO2 WPD Page 43 of 51 Used to specify a single baud rate for both transmitter and receiver Units in bit s HSS8 CLOCK DEFAULT connects BRGs 1 4 to Channels A D and Channels E HJ When transmit clock is set to HSS8 CLOCK BRO 1 4 then receive clock is still set to HSS8_CLOCK_EXT 1 4 for Channels A D and E H Note There are four BRGs and four clock input pins per PowerQUICC Il processor Maximum number of bytes to receive
7. HSS8_CB_ON_RECEIVE_DONE Process rx data 0 5 5 Sending and Receiving Data To send and receive data on a specified channel the user must first open the channel To stop sending or receiving data from a channel the user must close the channel Example Send some data on device 0 Channel B Open port for sending data hss80pen port HSS8 ARG 5 0 HSS8 PORT B 15 16 17 Send some data hss8Send data HSS8 ARG 5 0 HSS8 PORT B 0 256 pbuffer256 Do other stuff 75 EJ Close port after final usage hss8Close port HSS8 ARG 2 0 HSS8 PORT B CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 8 of 51 5 6 5 7 5 8 5 9 Destroying the Device When the device is no longer required it should be destroyed to free system resources Example Device 0 is no longer required Close all ports after final usage hss8Close port HSS8 ARG 2 0 HSS8 PORT A hss8Close port HSS8 ARG 2 0 HSS8 PORT B hss8Close port HSS8 ARG 2 0 HSS8 PORT C hss8Close port HSS8 ARG 2 0 HSS8 PORT D hss8Close port HSS8 ARG 2 0 HSS8 PORT E hss8Close port HSS8 ARG 2 0 HSS8 PORT FP hss8Close port HSS8 ARG 2 0 HSS8 PORT G hss8Close port HSS8 ARG 2 0 HSS8 PORT H hss8Close port HSS8 ARG 2 0 HSS8 PORT I hss8Close port HSS8 ARG 2 0 HSS8 PORT J hss8Close port HSS8 ARG 2 0 HSS8 PORT K hss8Close port HSS8 AR
8. 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 HSS8 CLOCK DEFAULT BRGs 1 4 BRG1 for Channels A and E BRG2 for Channels B and F BRG3 for Channels C and G BRG4 for Channels D and H HSS8_CLOCK_BRG1 HSS8_CLOCK_BRG2 HSS8 CLOCK BRGS3 HSS8 CLOCK BRG4 HSS8 CLOCK EXT1 HSS8 CLOCK EXT2 HSS8 CLOCK EXT3 HSS8 CLOCK EXT4 External Clocks connected on CLK IN Pins Note HSS8_CLOCK_EXT 1 2 can only be used for Channels A and B and E and F while HSS8_CLOCK_EXTI S 4 can only be used for Channels C and D and G and H HSS8 UART FLOW NORMAL flow control HSS8 UART FLOW ASYNC stop bits data bits HSS8 UART MODE NORMAL HSS8 UART MODE MAN MM HSS8 UART MODE AUTO MM CCII HSS8 6 MAN 002 2015 09 18 Used to specify a single baud rate for both transmitter and receiver Units in bit s HSS8 CLOCK DEFAULT connects Baud Rate Generator BRGs 1 4 to Channels A D and Channels E H For synchronous UART When transmit clock is set to HSS8_CLOCK_BRG 1 4 then receive clock is still set to HSS8 CLOCK EXT 1 4 for Channel A D and E H For
9. er vro tn Et mated arg er S 49 5 Contact Details oV ok eere tete ete oca eo tet e Eee qu e ce en carens ended Bh uz 50 8 1 ontacE Person tdeo unb ert m e cer A eed de pipe ue La DS NO LESE 50 8 2 Physical Address sse Ree da ate dede 50 8 3 Postal Address elu RR aic mA ie AA s eu dex me EMI a E 50 8 4 Voice and Electronic Contacts rss 50 8 5 Product Suppor nis ai tn ur EPIS CAL ie ER Pet a ed MN XI UT FERA ERR SR RARUS RATS qua 50 ANNE UFO uei rumeur cree eta EM UM de le D e Ei ME d I M E 51 Making Changes to sysLib C TOE X86 apean e iua urhrkerzsebctente uburivehnepinb xen MERE EET GR 51 CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 Abbreviations and Acronyms API Application Program Interface BCS Block Check Sequence BISYNC Binary Synchronous Communication BIT Built in Test bit s bits per second BRG Baud Rate Generator BSP Board Support Package CD Carrier Detect CRC Cyclic Redundancy Check CTS Clear to Send DLE Data Link Escape DPLL Digital Phase Locked Loop EEPROM Electrically Erasable Programable Read Only Memory FIFO First In First Out HDLC High Level Data Link Control HSS8 8 Channel High Speed Serial y o Input Output LED Light Emitting Diode MHz MegaHertz NRZ Non Return to Zero NRZI Non Return to Zero Inverted PC Personal Computer PCI Peripheral Component Interconnect PMC Peripheral Component Interconnect Mezzanine Card POST Power On Self Test RAM Random Access Memor
10. supplied or the function has been called with the incorrect number of variables If no PCI buffer is available If the HSS8 control block could not be accessed within a certain time hss8Status hss8Bit report hss8ArgType num args CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 26 of 51 Function hss8Bit clear Purpose To clear each port s counters Arguments num args The number of arguments to follow Needs to be at least one dev id benc lo on the PCI bus The HSS8 device in the lowest PCI Mies 0 next HSS8 device dev id 1 etc Returns HSS8 OK HSS8 INVALID PARAM On success Invalid dev id supplied or the function has been called with the incorrect number of variables HSS8 DEVICE BUSY If no PCI buffer is available HSS8 DEVICE NOT RESPONDING If the HSS8 control block could not be accessed within a certain time hss8Status hss8Bit clear hss8ArgType num args CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 27 of 51 6 2 14 Enable Disable POST Function Purpose Arguments dev id test enable Returns HSS8 OK HSS8 INVALID PARAM HSS8 DEVICE NOT FOUND HSS8 MEM INVALID ADDRESS HSS8 MEM EEPROM BUSY hss8Post enable Enable disable selected POSTS Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc One or all of the fo
11. 057 Added procedure to configure pins as outputs on startup 2015 09 18 CCII HSS8 6 ECP 059 D CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 Contents T CODE Ar 1 1 1 identification z na atere ele a iaei a hia D c 1 1 2 EU CIBO Th MR tee neres ee Meth E AEE e A a E BAE 1 1 3 Document Overview eir rerirerue krete en KA EER EEP EER as 1 2 Applicable and Reference Documents 00000 ee 2 2 1 Applicable Documents l rrna ae eee hn 2 2 2 Reference Documents 2 3 Software Driver Distribution 0 0 0 0 0 00 cee eee 3 4 Installation Procedure ir era Pier etner nn aran 4 4 1 To Build the HSS8 VxWorks Software Driver into the VxWorks Kernel oooo ooooooomoo 4 4 2 To Load the HSS8 VxWorks Software Driver Separately 0 00 c cece eee 4 5 Taing the HSS8 VxWorks Software Driver o o oooccccoocooccoo 5 Overview of the HSS8 VxWorks Software Driver 0 00 cc eee eens 5 S Creating the Device ooooccoco hmm 6 5 3 Configuring the Channels 0 0 ccc ehh he 6 5 4 Adding Call back Functions 00 000 ccc mh 6 5 5 Sending and Receiving Data 0 0 cnet ete 8 5 6 Destroying the Device x vehe e Reed da LW era os Re be mn 9 5 7 Detecting an Active Clock Signal on Channels 000 0c eects 9 5 8 Obtaining the Current Host and Firmware Version Number 0000 0c eee eee ees 9
12. 14 Enable Disable POST oo cococccocor ehh hh hh hr hs 28 6 2 15 Return POST Status sc aie ae Yael asia Res aet See rate Re d ak a OUR ae o a ec Sn 29 6 2 16 Return Adapter Type oo oococco tetas 30 6 2 17 Set PCI Base Address osos e oe Soe eder a a aes giras os 31 6 2 18 Set Output Pin Values at Startup oooococccccocoo ees 32 6 3 Software Driver Data Structures o oooooooooo eas 33 6 3 WART Mode iom da tra aos ted vun eitis Seale x ERE e e AIR oec T n o DERI UR Wed a 34 6 3 1 1 UART Protocol Information Structure 2 0 0 teen eee 34 6 3 1 2 UART Protocol Information Structure Members 000 ce eee ee eee 35 CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 63 2 HDE CG MOdO 6 une oan Et Beas SERV ENSE RES AE A AS 2S 38 6 3 2 1 HDLC Protocol Information Structure illl 38 6 3 2 2 HDLC Protocol Information Structure Members o o o oooooccoooo 39 6 3 2 3 Preamble Requirements o ocoooccccccoocco eh 41 6 3 3 BISYNG MOd IR ah a IRE TUON QU 42 6 3 3 1 BISYNC Protocol Information Structure 0 000000 ee 42 6 3 3 2 BISYNC Protocol Information Structure Members 0000000008 43 6 3 4 SMC UART Mode kA ELI Se tees We aad eb dt ele iy dade 47 6 3 4 1 SMC UART Protocol Information Structure llle 47 6 3 4 2 SMC UART Protocol Information Structure Members lesen 48 Te Getting Started
13. CT Systems CCII 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 VxWorks Software Driver Cl Systems Document No CCII HSS8 6 MAN 002 Issue Date 2015 09 18 Print Date 2015 09 18 File Name W HSS8 TECH MAN CH8MANO2 WPD C4 Systems The copyright of this document is the property of C I Systems The document is issued for the sole purpose for which it is supplied on the express terms that it may not be copied in whole or part used by or disclosed to others except as authorised in writing by C I Systems Document prepared by C I Systems Cape Town Signature Sheet Completed by Cory ME LAm Project Engineer Board Level Products CAP Systems Accepted by os DEM Project Manager Board Level Products C 1 Systems Accepted by Y HEH ME CAL Quality Assurance CA Systems CCII HSS8 6 MAN 002 2015 09 18 CHEMANO2 WPD Amendment History Description Date 0 4 Fist arat aw 1 0 Baselined document 2004 07 20 1 1 Added description for 4 channel version of HSS8 Adapter 2004 11 25 1 2 Implemented ECP made references to adapter more generic 1 3 Added description for the hss8Set_pci_base function 1 4 Improve document naming consistency 1 5 Added description of POST progress indicator 2014 02 06 CCII HSS8 6 ECP
14. D and E H For FMO 1 Manchester and Diff Manchester Transmit and receive clocks can be set to one of HSS8_CLOCK_BRG 1 4 or HSS8 CLOCK EXT 1 4 Note There are four BRGs and four clock input pins per PowerQUICC II processor HDLC CRC mode Issue 1 6 CH8MANO02 WPD Page 39 of 51 diag mode HSS8 DIAG NORMAL Normal operation Use this for Set diagnostic mode E external loopback External loopback RS 422 485 Connect TxD to RxD TxD to RxD CLK_OUT to CLK IN and CLK OUT to CLK IN for synchronous mode HSS8 DIAG 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 External loopback RS 232 Connect TxD to RxD CLK OUT to CLK IN for synchronous HSS8 DIAG ECHO The transmitter automatically resends received data bit by bit MOde and RTS to CTS and CD Set diagnostic mode For synchronous mode see encoding_method HSS8_DIAG_LOOPBACK_EC Loopback and echo operation HO occur simultaneously max_receive_bytes 1 to 2 048 CRC bytes 2 or 4 default or up to 32 kBytes CRC Maximum number of bytes to bytes 2 or 4 depending on how many bytes have been allocated receive before closing buffer Set to the RX and TX buffers See function hss8Create_device equal to max_frame_bytes max frame bytes 1 to 2 048 default or up to 32 kBytes dep
15. Issue 1 6 CH8MANO2 WPD Page 10 of 51 Note IfHSS8 POST PROGRESS ENABLE is enabled host software earlier than V 1 9 1 will hang when hss8Create device is called 5 11 Return Adapter Type The following function returns the adapter type The return value will be either 4 or 8 describing a 4 Channel four SCCs and two SMCs available or 8 Channel eight SCCs and four SMCs available adapter When a 4 Channel adapter is present only the following channels are valid HSS8 PORT A D four SCC channels and HSS8 PORT I J two SMC channels Example Get adapter type of device 0 hss8UINT8 adapter type hss8Adapter type 0 amp adapter type CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 11 of 51 6 Application Program Interface API 6 1 General Function Structure The general function structure is as follows hss8Status hss8Function name hss8ArgType num args With num args indicating the number of arguments to follow It can be one the following HSS8_ARG_1 HSS8 ARG 15 depending on each individual function 6 2 High Speed Serial VxWorks Software Driver Interface The zip file ccHss8HfilesV lt version gt zip contains the following header files which should always be included e hss8Defs h e hss8HostDriver h e hss8Controllfc h CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 12 of 51 6 2 1 Create Device Function Purpose Arguments num args d
16. Number Function Purpose Arguments num args dev id Returns HSS8 OK HSS8 INVALID PARAM HSS8 DEVICE BUSY hss8Version print To obtain the current version number of the software driver and firmware software This function essentially calls hss8Bit getstruct and prints out the contents of the hss8BoardBitInfo struct See paragraph 6 2 13 The number of arguments to follow Needs to be at least one dev id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc On success Invalid dev id supplied or the function has been called with the incorrect number of variables If no PCI buffer is available HSS8 DEVICE NOT RESPONDING If the HSS8 control block could not be accessed within a certain time hss8Status hss8Version print hss8ArgType num args Note This function can only be used after a call to hss8Create_device CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 23 of 51 6 2 12 Print Out Current Embedded Software Version Number Function hss8Firmware version Purpose Return the firmware version number stored in the EEPROM Arguments dev id Device ID on the PCI bus The HSS8 device in the lowest PCI ede id eg next HSS8 device dev id 1 etc version Return value for version number version 100 revision 10 beta Returns HSS8 OK On succes
17. actual baud rate for the SMC UART is 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 Used to specify a single baud rate for both transmitter and receiver Units in bit s stop bits HSS8 UART STOP BITS ONE Number of full stop bits HSS8 UART STOP BITS TWO HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA HSS8 UART DATA data bits Number of data bits Note only Channels H i e the SMC channels support nine or more data bits parity enable HSS8 UART PARITY NO PARITY Enable or disable parity checking g HSS8_UART_PARITY_ENABLE HSS8 UART SMC PARITY ODD parity mode HSS8 UART SMC PARITY EVEN HSS8 DIAG NORMAL Normal operation Use this for external loopback diag mode HSS8 DIAG LOOPBACK Internal loopback TxD and RxD are connected internally The value on RxD is ignored HSS8 DIAG ECHO The transmitter automatically resends received data bit by bit HSS8 DIAG LOOPBACK ECHO Loopback and echo operation occur simultaneously 1 to 2 048 default or up to 32 kBytes depending on how many bytes have been allocated to the RX and TX buffers See function hss8Create device max receive bytes 0 to 2 048 default or up to 32 kBytes depending on how many
18. before closing buffer Minimum number of SYN1 SYN2 pairs sentbetween or before messages The entire pair is always sent regardless of the syn length variable CRC selection 1 CRC16 X16 X15 X2 1 Initialise prcrc and ptcrc to all zeros or all ones 2 LRC sum check For even LRC initialise prcrc and ptcrc to zeros for odd LRC initialise to ones Enable Receive Block Check Sequence BCS Issue 1 6 rx transparant mode reverse data disable rx while tx rx parity ix parity diag mode Options HSS8 BISYNC PARITY ODD HSS8 BISYNC PARITY LOW HSS8 BISYNC PARITY EVEN HSS8 BISYNC PARITY HIGH HSS8 DIAG NORMAL HSS8 DIAG LOOPBACK HSS8 DIAG ECHO HSS8 DIAG LOOPBACK ECHO 0x0000 or OxFFFF 0 65 535 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 CCII HSS8 6 MAN 002 2015 09 18 CH8MANO2 WPD Page 44 of 51 Enable Receiver transparent 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
19. bytes have been allocated to the RX and TX buffers See function hss8Create_device max idl CCII HSS8 6 MAN 002 2015 09 18 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 and TxD to RxD External loopback RS 232 Connect TxD to RxD 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 Issue 1 6 CH8MANO2 WPD Page 48 of 51 7 Getting Started After installing the HSS8 VxWorks Software Driver according to Paragraph 4 test the host software driver following the test procedure given in hss8Test txt CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 49 of 51 8 Contact Details 8 1 Contact Person Direct all correspondence and or support queries to the Project Manager at C I Systems 8 2 Physical Address Cl Systems Real Time House Greenfor
20. data pointer to buffer containing the data that was send 8 missed rx done variable that is incremented when the HSS8 Adapter was not able to generate an interrupt to the host SBC e Clock Detect Call back function three arguments 1 dev id device ID 2 port id port ID 3 user id user defined ID CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 7 of 51 Example Add a Call back function for handling receives Receive function prototype this function is implemented by the user void Process rx data hss8ArgType num args hss8DeviceId dev_id hss8PortId port_id hss8ChannelId chan ig hss8UserId user id hss8UINT32 error hss8UINT32 nr bytes hss8UINT32 missed rx hss8BufferPtr p data declare a variable of type va list va list arg ptr initialize the argument pointer va start arg ptr num args retrieve each argument in the variable list dev id va arg arg ptr hss8Deviceld port id va arg arg ptr hss8Portld chan id va arg arg ptr hss8ChannelId always 0 for now user id va arg arg ptr hss8Userld error va arg arg ptr hss8UINT32 nr bytes va arg arg ptr hss8UINT32 p data hss8BufferPtr va arg arg ptr hss8UINT32 missed rx va arg arg ptr hss8UINT32 perform clean up va end arg ptr user specific code here Add receive call back hss8Add_callback HSS8_ARG_4 0
21. sequence even if it is programmed to LRC while in transparent mode Initialize prcrc to the CRC16 preset value before setting rx transparant mode Enable Reverse data Disable receiver while sending Receive and transmit parity Parity is ignored unless crc select LRC Set diagnostic mode External loopback RS 422 485 Connect TxD to RxD TxD to RxD CLK_OUT to CLK_IN and CLK OUT to CLK IN External loopback RS 232 Connect TxD to RxD CLK OUT to CLK IN and RTS to CTS 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 Number of received parity errors Issue 1 6 bsync 0bv0000000ssssssss 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 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 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
22. 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 0 65 535 Number of received parity errors CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 36 of 51 frmec 0 65 535 Number of received characters with framing errors nosec 0 65 585 Number of received characters with noise errors brkec 0 65535 Number of break conditions on the signal uaddr1 uaddr2 0x0000 0x00FF Address in multidrop mode Only the lower 8 bits are used so the upper 8 bits should be cleared toseq 0x0000 0x00FF Transmit out of sequence character e g XON XOFF 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 6 bits Reserved Initialise to zero cccccccc 8 bits Defines control characters to be compared to the incoming character 0b11 00000000 Ignore these bits when comparing Receive control character mask A incoming character one enables comparison and a 0b11 11111111 Enable comparing the incoming zero masks it characte
23. 5 9 HSS8 Built in Tests BIT siari an i aa a m ren 9 5 10 HSS8 Power On Self Tests o ooooooooooro ene een eee n een eee 10 5 11 Return Adapter Type sasa ana a a a ehh eee 11 6 Agere Program Interface API 0 0 eee 12 General Function Str ct re sesse od aise a fe dO as A Xe RU War wade e Med 12 En High Speed Serial VxWorks Software Driver Interface oo oooooooooooorr 12 6 2 4 Create Device olet a ii ad sre e eon ae au Ear ae ah ae ii 13 06 2 2 Destroy Devices sisse nieta daria dat 14 62 3 Set Port Configuration s is4 2 shecrvet teed tsi aaa ds 15 0 2 4 Get Port Configuration auci er hee meae i whee lee eee tet hea ies Meu ende de 16 0 2 b Open Porti aso weeds ta EE Ur RU I Peu nsi ed hr epe dus IURE E UL penne ied 17 6 2 6 CloSe POL coco ati A CENTS RISE A a NORTE De NURSE UE TIR UENIRE ae qa 18 6 2 Send Dala nico ix tut rv eres A AKEE a ENSIS nig aed DR S COUSINS RE 9L SR 19 6 2 8 Add CallBack a eei oi ene nin Dames e tie dee an deck E UR s PR RR DANG RI Va URL US 20 6 2 9 Remove Call back oyra se piana E EE RKE iA ehh has 21 6 2 10 Detecting an Active Clock Signal on Ports ooooccooccccoocoo eee 22 6 2 11 Print Out Current Host Software Version Number 0 0000 cece ee enna 23 6 2 12 Print Out Current Embedded Software Version Number l l 24 6 249 HSSS BIT Structures ucro oae e a m eK ncn Rig DEKAT Wake on RR Re MR am BS 25 6 2
24. 8LibPPCV lt version gt a to your present working directory as ccHss8 a e From the VxWorks shell type ld lt ccHss8 a CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 4 of 51 5 Using the HSS8 VxWorks Software Driver 5 1 Overview of the HSS8 VxWorks Software Driver The following flow chart shows the main functions of the HSS8 VxWorks Software Driver Establish a connection to the HSS8 Adapter by calling hss8Create device Configure each channel by calling hss8Set port config Add Call back functions for the receive and transmit channel and for clock detection if required Call function hss8Add callback Open Channel by calling hss8Open_port Send data by calling hss8Send_data Figure 1 Overview of HSS8 VxWorks Software Driver CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 5 of 51 5 2 Creating the Device The HSS8 VxWorks Software Driver supports multiple HSS8 Adapters on a single host To establish a connection and construct all the device specific structures a user must create each of the devices separately using the device ID to identify it The device ID starts at O and increments by 1 for each of the devices Device O refers to the device in the lowest slot The HSS8 VxWorks Software Driver can not be used until the user has created the device Example For device 0 Create one HSS8 device hss8Create device HSS8 ARG 1 0 The dev
25. B ON SEND DONE HSS8 CB ON RECEIVE DONE HSS8 CB ON CLOCK DETECT User function to remove User identifier This identifier must be the same as the one passed to hss8Add callback On success Invalid dev id supplied or the function has been called with the incorrect number of variables hss8Status hss8Remove callback hss8ArgType num args CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 21 of 51 6 2 10 Detecting an Active Clock Signal on Ports Function Purpose Arguments num args dev id port id Returns HSS8 OK HSS8 INVALID PARAM HSS8 PORT NOT INSTALLED HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING hss8Clock detect Set up a port to detect when a clock signal becomes active The number of arguments to follow Needs to be at least two dev id port id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Port on which to detect clock signal On success Invalid dev id or port id supplied or the function has been called with the incorrect number of variables If the port does not exist If no PCI buffer is available If the HSS8 control block could not be accessed within a certain time hss8Status hss8Clock detect hss8ArgType num args CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 22 of 51 6 2 11 Print Out Current Host Software Version
26. C hss8SendBitInfo tx smc bit HSS8 HW NR SMC hss8ReceiveBitInfo rx smc bit HSS8 HW NR SMC y typedef struct hss8BitInfoStruct hss8BitInfo CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 25 of 51 Three functions give access to the HSS8 BIT structures Function Purpose Arguments num args dev id bit info Returns HSS8 OK HSS8 INVALID PARAM HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING hss8Bit getstruct To obtain the latest BIT variables The number of arguments to follow Needs to be at least two dev id bit info Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Pointer to hss8Bitlnfo struct On success Invalid dev id supplied or the function has been called with the incorrect number of variables If no PCI buffer is available If the HSS8 control block could not be accessed within a certain time hss8Status hss8Bit getstruct hss8ArgType num args Function hss8Bit report Purpose To display each port s statistics Arguments num args The number of arguments to follow Needs to be at least one dev id dev id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Returns HSS8 OK On success HSS8 INVALID PARAM HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING Invalid dev id
27. CPU PCI MEM ADRS define CPU PCI MEM ADRS OxFF500000 base of PCI MEM addr Hendif PHYS MEM DESC sysPhysMemDesc adrs and length parameters must be page aligned multiples of 4KB 4MB if VM_PAGE SIZE PAGE SIZE A4KB lower memory video ram etc upper memory for OS upper memory for Application PCI I O space void CPU PCI MEM ADRS void CPU PCI MEM ADRS 0xA00000 VM STATE MASK VALID VM STATE MASK WRITABLE VM STATE MASK CACHEABLE VM STATE VALID VM STATE WRITABLE VM STATE CACHEABLE NOT entries for dynamic mappings create sufficient entries DUMMY MMU ENTRY DUMMY MMU ENTRY DUMMY MMU ENTRY telse CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 51 of 51
28. D Page 33 of 51 6 3 1 UART Mode This protocol may only be used with the eight SCC channels Channels A H 6 3 1 1 UART Protocol Information Structure The following structure is defined in the file hss8Controllfc h and is given here in abbreviated format i e reserved and obsolete members are not shown Always use the structure as defined in hss8Controllfc h struct hss8UartInfoStruct hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 hss8 y HHHHHHHHHHHHHHHHHHHHHHHHHH NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 NT32 baud_rate flow_control stop_bits data_bits uart mode freeze tx rx zero stop bits sync mode disable rx while tx parity enable rx parity tx parity diag mode max receive bytes max idl brkcr parec frmec nosec brkec uaddrl uaddr2 toseq cc 8 rccm clock_source typedef struct hss8UartInfoStruct hss8UartInfo CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 34 of 51 6 3 1 2 UART Protocol Information Structure Members Nme Options scription baud rate 1 200 1 Mbit s RS 232 1 200 16 Mbit s RS 422 485 Any values permissible The equation to calculate the actual baud rate for asynchronous
29. G 2 0 HSS8 PORT D Destroy device to free resources hss8Destroy device HSS8 ARG 1 0 Detecting an Active Clock Signal on Channels To detect when a channel s clock signal becomes active use the following function Example Detecting a clock signal on device 0 and Channel A Enable port to detect clock hss8Clock detect HSS8 ARG 2 0 HSS8 PORT A A Call back function gets called once a clock has been detected After this Call back function has been serviced the user can re initialise the clock detection routine as shown above Obtaining the Current Host and Firmware Version Number The following function prints out the current version number of the software driver and firmware software Print current version number hss8Version print HSS8 ARG 1 0 Note Run hss8Create device first The following function returns the firmware version stored in the EEPROM Return firmware version number version 100 revision 10 beta hss8Firmware version 0 andversion Note This function may be called without running hss8Create_device first HSS8 Built in Tests BIT The following function displays each channel s statistics e g how many bytes packets have been accepted rejected sent received and how many errors were reported Example Displaying each channel s statistics for device O hss8Bit report HSS8 ARG 1 0 To clear the counters of the hss8Bit_report function use the funct
30. METHOD NRZI SPACE HSS8 HDLC ENCODING METHOD FMO HSS8 HDLC ENCODING METHOD FM1 tions Description Enable multiple frames in transmit FIFO RX TX encoding method NRZ and NRZI use no DPLL FMO 1 Manchester and Diff Manchester use the DPLL for clock recovery The clock rate is 16x HSS8 HDLC ENCODING METHOD MANCHESTER when the DPLL is used HSS8 HDLC ENCODING METHOD DIFF MANCHESTER HSS8 DPLL PREAMBLE LENGTH 0 HSS8 DPLL PREAMBLE LENGTH 8 HSS8 DPLL PREAMBLE LENGTH 16 HSS8 DPLL PREAMBLE LENGTH 32 HSS8 DPLL PREAMBLE LENGTH 48 HSS8 DPLL PREAMBLE LENGTH 64 HSS8 DPLL PREAMBLE LENGTH 128 Determines the length of the preamble length preamble pattern Determines what bit precedes each TX frame HSS8 DPLL PREAMBLE PATTERN 00 HSS8 DPLL PREAMBLE PATTERN 10 HSS8 DPLL PREAMBLE PATTERN 01 HSS8 DPLL PREAMBLE PATTERN 11 preamble pattern pattern HSS8 HDLC SEND IDLES HSS8 HDLC SEND FLAGS SYNCS 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 send_idles_or_flags 6 3 2 3 Preamble Requirements Minimum Preamble Length Required Decoding Method Preamble Pattern NRZI Mark NRZI Space Manchester Differential Manchester CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 41 of 51 6 3 3 BISYNC Mode This protocol may only be used with the eight SCC channels Chann
31. S8_INVALID_PARAM HSS8_DEVICE_BUSY HSS8_ERROR hss8Set_pci_base This function is used to set the PCI base address used by the adapter s firmware for the PCI reverse mapping adapter to host A default value of 0x00000000 is assumed by the adapter at start up Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc A 32 bit value to be used as the new PCI base address On success Invalid dev id supplied If no PCI buffer is available If firmware did not respond to configuration change hss8Status hss8Set pci base hss8DevicelId dev id hss8UINT32 addr Note This function can only be used after a call to hss8Create_device CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 31 of 51 6 2 18 Set Output Pin Values at Startup Function Purpose Arguments num args dev id enable mask Returns HSS8 OK HSS8 INVALID PARAM HSS8 DEVICE BUSY HSS8 MEM EEPROM BUSY hss8Set init config The standard behaviour is that all line drivers are disabled lines are tristate until the channel is initialised In some cases it may be desirable to force the lines to a known state as soon as the adapter is powered up This function stores a value in the adapter EEPROM which is used to selectively enable the line drivers at startup if required The default line idle state is a logic one The number of arguments t
32. This Call back will be called as soon as the data has been handed over to the software driver for sending This Call back will be called when all the data for a given send has been sent by the software driver This Call back will be called when a block of data has been received by the software driver The user must add at least one of these Call backs to receive data This Call back will be called when a clock signal has been detected on a port and only if the port has been instructed to detect a clock signal e g calling the function hss8Clock detect Only one Call back for each above type per device is recommended The Call back function receives the port id such that the user can distinguish which port triggered the Call back More than one Call back function may be used in which case the Call backs will be called in the sequence they were added CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 20 of 51 6 2 9 Remove Call back Function Purpose Arguments num args dev id cb type callback user id Returns HSS8 OK HSS8 INVALID PARAM hss8Remove callback Remove a user defined Call back routine The number of arguments to follow Needs to be at least four dev id cb type callback user id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Call back type one of HS88 CB ON SEND BEGIN HSS8 C
33. as follows see also header file hss8Controllfc h e HSS EEPROM UPDATE 1 flash e HSS EEPROM ERROR 2 flashes e HSS RAM DATA ERROR 8 flashes e HSS RAM ADDR ERROR 4 flashes e HSS RAM DEVICE ERROR 5 flashes e HSS FLASH MAGIC ERROR 6 flashes e HSS FLASH KERNEL CRC ERROR 7 flashes e HSS8 SLAVE POWERQUICC l FAIL 8 flashes The above codes are also written to the EEPROM and may be read back with the following function Example Obtain POST error status on device 0 hss8Post status 0 amp data To enable disable selected tests the following function may be used Example Enable all RAM tests but disable Flash CRC checking on device 0 hss8Post enable 0 HSS8 POST RAM DATA ENABLE HSS8 POST RAM ADDR ENABLE HSS8 POST RAM DEV ENABLE Note The function hss8Create device will return HS88 POWER ON SELFTEST FAIL if any ofthe tests fail The function hss8Post_status may then be used to determine which one of the tests has failed If a fast host processor is used it is possible that the user might attempt to initialise the adapter while the POST routine is still executing This will result in hss8Create device not executing correctly Starting with software version 1 9 1 enabling HSS8 POST PROGRESS ENABLE will delay hss8Create device until POST has completed hss8Post enable 0 HSS8 POST PROGRESS ENABLE CCII HSS8 6 MAN 002 2015 09 18
34. asynchronous UART Transmit and receive clocks can be set to one of HSS8_CLOCK_BRG 1 4 or HSS8 CLOCK EXTI 1 4 Note There are four BRGs and four clock input pins per PowerQUICC II processor Normal or control asynchronous flow HSS8 UART STOP BITS ONE Number of full stop bits HSS8 UART STOP BITS TWO Number of data bits Note only channels I L i e the SMC channels support nine or more data bits Select UART mode Normal manual multidrop or automatic multidrop mode Issue 1 6 CH8MANO2 WPD Page 35 of 51 fame Options Description HSS8 UART FREEZE TX NORMAL HSS8 UART FREEZE TX FREEZE freeze tx rx zero stop bits sync mode disable rx while tx parity enable rx parity tx parity diag mode max receive bytes HSS8 UART RX ZERO STOP BITS NORMAL HSS8 UART RX ZERO STOP BITS NONE HSS8 UART SYNC MODE ASYNC HSS8 UART SYNC MODE SYNC HSS8 UART DISABLE RX WHILE TX NORMAL HSS8 UART DISABLE RX WHILE TX DISABLE HSS8 UART PARITY NO PARITY HSS8 UART PARITY ENABLE HSS8 UART PARITY ODD HSS8 UART PARITY LOW HSS8 UART PARITY EVEN HSS8 UART PARITY HIGH HSS8 DIAG NORMAL HSS8 DIAG LOOPBACK HSS8 DIAG ECHO HSS8 DIAG LOOPBACK EC HO 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
35. d dev id or port id supplied or the function has been called with the incorrect number of variables If the port does not exist If no PCI buffer is available If the HSS8 control block could not be accessed within a certain time HSS8 INCORRECT PARAM COMBINATION If an incorrect parameter combination was selected in the protocol structure hss8Status hss8Set port config hss8ArgType num args Note The p info pointer must point to a valid hss8Protocollnfo structure with all protocol information set as required If only a few items need to change the hss8Get port config function should be used to fill in the rest of the structure Warning Do not call this function while sending or receiving data as this may result in data loss CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 15 of 51 6 2 4 Get Port Configuration Function Purpose Arguments num args dev id port id p info Returns HSS8 OK HSS8 ERROR HSS8 INVALID PARAM HSS8 PORT NOT INSTALLED HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING hss8Get port config Get port protocol and protocol configuration The number of arguments to follow Needs to be at least three dev id port id p info Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Port to get configuration info from Pointer to information struct hss8Prot
36. d Office Estate Punters Way Kenilworth Cape Town 7708 South Africa 8 3 Postal Address C212 Systems P O Box 171 Rondebosch 7701 South Africa 8 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 WWW http Awww ccii co za 8 5 Product Support Support on C l 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 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 50 of 51 Annexure A Making Changes to sysLib c for x86 The PCI free memory space may need to be defined in the memory descriptor table Consult the relevant reference manual and obtain the upper address of the PCI memory Allocate at least 5 MBytes of memory per HSS8 Adapter Subtract that amount from the upper address of the PCI memory and use this value as the base of the PCI memory space Note If there are other devices on the PCI bus it may be necessary to allocate more memory Example For 2 HSS8 Adapters allocate 10 MBytes of memory If the upper address of the PCI memory space is defined as OxFFF00000 then subtracting 10 MBytes gives a base address of OxFFF00000 0xA00000 OxFF500000 In the PC 386 486 Pentium Pentiumpro system dependent library sysLib c code shown in bold text needs to be added to the memory descriptor table sysPhysMemDesc ifndef
37. els A H 6 3 3 1 BISYNC Protocol Information Structure The following structure is defined in the file hss8Controllfc h and is given here in abbreviated format i e reserved and obsolete members are not shown Always use the structure as defined in hss8Controllfc h struct hss8BisyncInfoStruct hss8UIN hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U FH F4 F4 Fd FJ Ed FH Fd Ed Fdo Fd Ed Fd Fd Fd oEd Fdo FE F4 F4 FE FE H uuum 32 32 32 32 32 32 32 32 32 r32 32 32 32 32 32 32 32 32 32 32 32 32 hss8U y 32 baud_rate clock_source max_receive_bytes min_no_sync_pairs crc select receive bcs rx transparant mode reverse data disable rx while tx rx parity tx parity diag mode Gro prerc pterce parec bsync bdle cc 8 recm Sync syn length send idles or flags typedef struct hss8BisyncInfoStruct CCII HSS8 6 MAN 002 2015 09 18 hss8BisyncInfo Issue 1 6 CH8MANO02 WPD Page 42 of 51 6 3 3 2 baud rate clock source max receive bytes min no sync pairs crc select receive bcs BISYNC Protocol Information Structure Members Options 1 200 1 Mbit s RS 232 1 200 16 Mbit s RS 422 485 Any values permissible The equation to calculate the actual baud rate for BISYNC is as follows
38. ending on how many Maximum number of bytes per at bytes have been allocated to the RX and TX buffers See function frame Set equal to the number hss8Create device of data bytes plus the number of CRC bytes either two or four per frame address mask 0x0000 OxFFFF HDLC address mask A one m enables comparison and a zero masks it address1 address2 0x0000 OXFFFF Four address registers for address3 address4 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 nr flags between frames 0 15 Minimum number of flags between or before frames retransmit enabled TRUE Enable re transmit FALSE flag_sharing_enabled TRUE Enable flag sharing FALSE rx_disabled_during_tx TRUE Disable receive during transmit B a g FALSE bus mode TRUE Enable bus mode FALSE bus_mode_rts TRUE Enable special RTS operation in E B FALSE HDLC bus mode CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 40 of 51 multiple tx frames encoding method TRUE FALSE HSS8 HDLC ENCODING METHOD NRZ HSS8 HDLC ENCODING METHOD NRZI MARK HSS8 HDLC ENCODING
39. ev id buffer size Returns HSS8 OK HSS8 INVALID PARAM HSS8 PCI INIT FAIL HSS8 MEM ALLOC FAILED HSS8 DEVICE NOT FOUND HSS8 MEM INVALID ADDRESS HSS8 MEM EEPROM BUSY HSS8 POWER ON SELFTEST FAIL hss8Status hss8Create device hss8ArgType num args Note will be valid CCII HSS8 6 MAN 002 2015 09 18 hss8Create device Create and initialise the HSS8 device specific structures The number of arguments to follow Needs to be at least one dev id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Maximum RX and TX buffer size for specific port optional One of HSS8 2K HSS8 4K HSS8 8K HSS8 16K or HSS8_ 32K If not specified the default size is HSS8 2K On success Invalid dev id supplied or the function has been called with the incorrect number of variables PCI initialisation failed If HSS8 device structure could not be created in memory If HSS8 device lt dev_id gt was not found on the PCI bus If the HSS8 device PCI address was not valid If HSS8 device could not read version number from EEPROM If the POST failed A This function has to be called once per device before any other function call to the specified device Issue 1 6 CH8MANO2 WPD Page 13 of 51 6 2 2 Destroy Device Function hss8Destroy device Purpose Destroy the HSS8 device specific structures Arguments num args
40. ev id supplied Second PowerQUICC Il processor failed to start up If HSS8 device dev id was not found on the PCI bus If the HSS8 device PCI address was not valid If the HSS8 device could not read status from EEPROM hss8Status hss8Post status hss8DeviceId dev id hss8UINT8 status Note This function may be called without calling hss8Create_device first CCII HSS8 6 MAN 002 2015 09 18 CH8MANO2 WPD Page 29 of 51 Issue 1 6 6 2 16 Return Adapter Type Function hss8Adapter type Purpose Return adapter type either 4 Channel or 8 Channel Arguments dev id Device ID on the PCI bus The HSS8 device in the lowest PCI EP 0 next HSS8 device dev id 1 etc adapter type Byte returning the adapter type either 4 or 8 Returns HSS8 OK On success HSS8 INVALID PARAM Invalid dev id supplied HSS8 DEVICE NOT FOUND If HSS8 device dev id was not found on the PCI bus HSS8 MEM INVALID ADDRESS If the HSS8 device PCI address was not valid HSS8 MEM EEPROM BUSY If the HSS8 device could not read status from EEPROM hss8Status hss8Adapter type hss8Deviceld dev id hss8UINT8 adapter type Note This function may be called without calling hss8Create device first CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 30 of 51 6 2 17 Set PCI Base Address Function Purpose Arguments dev id lt addr gt Returns HSS8_OK HS
41. h the incorrect number of variables If the port does not exist If no PCI buffer is available If the HSS8 control block could not be accessed within a certain time hss8Status hss8Close port hss8ArgType num args Note Closing a port a second time has no effect and still returns HSS8 OK since the port was already successfully closed CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 18 of 51 6 2 7 Send Data Function Purpose Arguments num args dev id port id chan id nr bytes p data Returns HSS8 OK HSS8 INVALID PARAM HSS8 PORT NOT INSTALLED HSS8 PORT NOT OPEN HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING hss8Send data Send data over the specified port The number of arguments to follow Needs to be at least five dev id port id chan id nr bytes p data Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Port on which data must be sent Channel on which data must be sent If a port has only one channel chan id 0 not currently implemented Number of bytes to send Pointer to buffer with at least nr bytes bytes of data On success Invalid dev id port id chan id nr bytes or p data supplied or the function has been called with the incorrect number of variables If the port does not exist If the port is not yet open If
42. ice ID is used in all calls to the HSS8 VxWorks Software Driver to identify the correct device 5 3 Configuring the Channels The HSS8 Adapter has eight Serial Communications Controllers SCCs Channels A H that support UART HDLC SDLC and BISYNC protocols and four Serial Management Controllers SMCs Channels L that support only asynchronous UART After the HSS8 device has been created the user must first set the default configuration for each of the Channels To set the configuration of a Channel a protocol specific information structure is used Examples of the required structure is given in ccHss8Test c for the UART protocol and can be used as a starting point The structures allow 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 structure fields see 2 1 1 Example Setfour SCC channels to UART mode the other four SCC channels to HDLC mode and all four SMC channels to UART mode Set initial SCC port configuration hss8Set port config HSS8 ARG 3 0 HSS8 PORT A anduart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT B anduart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT C anduart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT D anduart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT E andhdlo info hss8Set port config HSS8 ARG 3 0 HSS8 PORT F andhdloc
43. info hss8Set port config HSS8 ARG 3 0 HSS8 PORT G andhdlo info hss8Set port config HSS8 ARG 3 0 HSS8 PORT H andhdlo info Set initial SMC port configuration hss8Set port config HSS8 ARG 3 0 HSS8 PORT I andsmc uart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT J andsmc uart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT K andsmc uart info hss8Set port config HSS8 ARG 3 0 HSS8 PORT L andsmc uart info 5 4 Adding Call back Functions The HSS8 VxWorks Software Driver notifies the user of different events by calling a user defined Call back function The events for which the user may specify one or more Call back functions are Transmit Begin The software driver has accepted the data for sending Transmit Done The software driver has finished sending the data Receive Done Data has been received into a buffer specifically allocated by the software driver Clock Detect A clock signal has been detected on a specific channel CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 6 of 51 Only one Call back function for each event is recommended For the user to receive data at least the Receive Done Call back must be installed While the Receive Done Call back is executed the corresponding buffer will not be accessed by the HSS8 VxWorks Software Driver The user can process the data in the Call back function or copy the data somewhere else for process
44. ing Call back function prototype void hss8Callback function hss8ArgType num args Where num args indicates the number of arguments to follow The number of arguments differs for each call back function e Transmit Begin Call back function six arguments 1 dev id device ID 2 port id port ID 3 chan id channel ID 4 User id user defined ID 5 nr bytes length of transmitted data 6 p data pointer to buffer containing the data to be send e Transmit Done Call back function eight arguments 1 dev id device ID 2 port id port ID 3 chan id channel ID 4 User id user defined ID 5 error HSS8 OK no errors HSS8 TX BUFFER UNDERRUN ERROR HDLC and BISYNC only H8SS8 TX CTS LOST ERROR All protocols 6 nr bytes length of transmitted data 7 p data pointer to buffer containing the data that was send 8 missed tx done variable that is incremented when the HSS8 Adapter was not able to generate an interrupt to the host SBC e Receive Done Call back function eight arguments 1 dev id device ID 2 port id port ID 3 chan id channel ID 4 User id user defined ID 5 error HSS8 OK no errors H888 RX FRAMING ERROR UART only HSS8 RX PARITY ERROR UART and BISYNC only HSS8 RX CRC ERROR HDLC and BISYNC only HS88 RX NONOCTET ALIGNED FRAME HDLC and BISYNC only HSS8 RX ABORT SEQUENCE HDLC only 6 nr bytes length of transmitted data 7 p
45. ion history Please check this file for information on the latest updates ccHss8HfilesV lt version gt zip Zip file which contains all header files that define the Application Program Interface API to the HSS8 VxWorks Software Driver ccHss8Test c and Sample C code for accessing the HSS8 VxWorks ccHss8Test lt arch gt lt long gt a Software Driver hss8Changes txt Changes to be made to VxWorks and Board Support Package BSP files hss8Flash txt Procedure for updating the firmware if required hss8Test txt Test procedure for verifying host software driver and firmware CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 3 of 51 4 Installation Procedure This paragraph describes the installation procedure for the HSS8 VxWorks Software Driver The examples given are for a PowerPC host 4 1 To Build the HSS8 VxWorks Software Driver into the VxWorks Kernel Assume the BSP directory is given as BSP DIR tornado target config dy4181 e Copy ccHss8LibPPCV lt version gt a to your BSP DIR lib directory as ccHss8 a e Inthe Builds section ofthe Project Workspace change the Kernel properties to include the ccHss8 a library file in the Macros LIBs option e Rebuild all VxWorks images 4 2 To Load the HSS8 VxWorks Software Driver Separately Note This step is not required if the software driver was built into the BSP If the software driver is not built into the BSP a user can load it separately e Copy ccHss
46. ion hss8Bit clear CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 9 of 51 5 10 Note Instead of displaying each channel s statistics the function hss8Bit_getstruct only returns the corresponding statistics in a structure See paragraph 6 2 13 HSS8 Power On Self Tests The Power On Self Tests POST are disabled by default but can be selectively enabled The following tests are defined e Magic number checking checks the start of the flash for a correct magic number This test is always performed and cannot be disabled e Flash CRC checks that the checksum of the kernel in flash is correct This test is disabled by default e EEPROM verification verifies the contents of the EEPROM If the contents is corrupt the EEPROM is reprogrammed This test is always performed e RAM databus test checks the databus connected to the RAM for any errors This test is disabled by default e RAM addressbus test checks the addressbus connected to the RAM for any errors This test is disabled by default e RAM device test checks the whole RAM device for any errors This test is disabled by default If any of the above tests fail an error code is flashed on the LEDs D1 D3 and the card will not boot up further If the card is reset and the card still does not boot up contact C I Systems The error codes are continuously flashed on the LEDs D1 D3 followed by a short break The number of flashes are defined
47. llowing ORed together HSS8 POST RAM DATA ENABLE HSS8 POST RAM ADDR ENABLE HSS8 POST RAM DEV ENABLE HSS8 POST KERNEL CRC ENABLE On success Invalid dev id supplied If HSS8 device dev id was not found on the PCI bus If the HSS8 device PCI address was not valid If the HSS8 device could not write to EEPROM hss8Status hss8Post enable hss8DeviceId dev id hss8UINT8 test enable Note This function may be called without calling hss8Create device first CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 28 of 51 6 2 15 Return POST Status Function Purpose Arguments dev id status Returns HSS8 OK E HSS8_INVALID_PARAM HSS8_DEVICE_NOT_FOUND HSS8_MEM_INVALID_ADDRESS HSS8_MEM_EEPROM_BUSY hss8Post status Return POST status or error code slot dev id 0 next HSS8 device dev id 1 etc Device ID on the PCI bus The HSS8 device in the lowest PCI Byte returning the error code of the POST One of HSS8 OK HSS8 EEPROM UPDATE HSS8 EEPROM ERROR HSS8 RAM DATA ERROR HSS8 RAM ADDR ERROR HSS8 RAM DEVICE ERROR HSS8 FLASH MAGIC ERROR On success EEPROM was corrupt and was reprogrammed EEPROM read write error RAM databus error RAM addressbus error RAM device error Flash magic number corrupt HSS8 FLASH KERNEL CRC ERROR Flash CRC error HSS8 SLAVE POWERQUICC I FAIL On success Invalid d
48. no PCI buffer is available If the HSS8 control block could not be accessed within a certain time hss8Status hss8Send data hss8ArgType num args Note The port must be opened before attempting to send data over it CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 19 of 51 6 2 8 Add Call back Function Purpose Arguments num args dev id cb type callback user id Returns HSS8 OK HSS8 INVALID PARAM HSS8 MEM ALLOC FAILED hss8Add callback Add a user defined Call back routine The number of arguments to follow Needs to be at least four dev id cb type callback user id Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Call back type one of HS88 CB ON SEND BEGIN HSS8 CB ON SEND DONE HSS8 CB ON RECEIVE DONE HSS8 CB ON CLOCK DETECT User function User identifier This identifier will be passed to the Call back function when it is called On success Invalid dev id supplied or the function has been called with the incorrect number of variables If HSS8 Call back node could not be created in memory hss8Status hss8Add callback hss8ArgType num args Four Call backs are provided for user notification from the software driver e HSS8 CB ON SEND BEGIN e HSS8 CB ON SEND DONE e HSS8 CB ON RECEIVE DONE e HSS8 CB ON CLOCK DETECT
49. o follow Needs to be at least one dev id Device ID on the PCI bus 0x00 to OxFF where 0x01 enables Channel A 0x02 enables Channel B etc On success Invalid dev id supplied If no PCI buffer is available EEPROM error HSS8 ERROR f firmware did not respond to configuration change hss8Status hss8Set init config hss8ArgType num args Example From the VxWorks command line hss8Set init config 2 0 0x01 will program the adapter so that the line drivers for Channel A is enabled at startup A reboot is required to verify correct behaviour hss8Set init config 2 0 0 will program the adapter to default behaviour CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 32 of 51 6 3 Software Driver Data Structures Each protocol defines a protocol information structure used to configure a port with protocol specific options This paragraph details the information structures used by each protocol and explains the use and limitations of every structure member hss8Protocollnfo Structure struct hss8ProtocollnfoStruct hss8UINT32 protocol id union SCC info hss8Uartlnfo uart hss8Hdlclnfo hdlc hss8Bisynclnfo bisync SMC info hss8SmcUartInfo smc uart info typedef struct hss8ProtocollnfoStruct hss8Protocollnfo protocol id HSS8 PROTOCOL UART HSS8 PROTOCOL HDLC HSS8 PROTOCOL BISYNC HSS8 PROTOCOL SMC UART CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WP
50. ocollnfo used for configuration On success If the Tx Rx tasks have not been destroyed Invalid dev id or port id supplied or the function has been called with the incorrect number of variables If the port does not exist If no PCI buffer is available If the HSS8 control block could not be accessed within a certain time hss8Status hss8Get port config hss8ArgType num args Note The p info pointer must point to an existing hss8Protocollnfo structure CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 16 of 51 6 2 5 Open Port Function Purpose Arguments num args dev id port id tx rx clk priority fp options Returns HSS8 OK HSS8 ERROR HSS8 INVALID PARAM HSS8 PORT NOT INSTALLED HSS8 PORT NOT CONFIGURED HSS8 DEVICE BUSY HSS8 DEVICE NOT RESPONDING HSS8 MEM ALLOC FAILED hss8O0pen port Open specified port for send and receive The number of arguments to follow Needs to be at least five dev id port id tx priority rx priority clk priority Device ID on the PCI bus The HSS8 device in the lowest PCI slot dev id 0 next HSS8 device dev id 1 etc Port to open for send and receive Priority of the send receive and clock detection task servicing this port Floating point enable for send receive and clock detect task HSS8 TX TASK FP ENABLE HSS8 RX TASK FP ENABLE HSS8 CLK TASK FP ENABLE
51. r to cc n CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 37 of 51 6 3 2 HDLC Mode This protocol may only be used with the eight SCC channels Channels A H 6 3 2 1 HDLC Protocol Information Structure The following structure is defined in the file hss8Controllfc h and is given here in abbreviated format i e reserved and obsolete members are not shown Always use the structure as defined in hss8Controllfc h struct hss8HdlcInfoStruct hss8UIN hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U hss8U FM F4 Fd Fd F4 Fd Fd Fd Fd Fd Fdo Fd Fd Fd oFd Fd Fd FA Fd FE E H Zutuutuuxuutuutuuutuuuuuutuutuuuux5 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 32 hss8U y 32 baud rate crc mode diag mode max receive bytes max frame bytes address mask address1 address2 address3 address4 nr flags between frames retransmit enableg flag sharing enableg rx disabled during tx bus mode bus mode rts multiple tx frames encoding method preamble length preamble pattern send idles or flags clock source typedef struct hss8HdlcInfoStruct hss8HdlcInfo CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 38 of 51 6 3 2 2 HDLC Protocol Information Structure Members Opis Desoription
52. receiver that the next character is text cc 8 ObObh cccccccc Valid entry Control characters 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 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 CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO2 WPD Page 45 of 51 rccm syn length send idles or flags 0b11 00000000 0b11 11111111 Oxssss 2 bytes HSS8 BISYNC SYNL 8 HSS8 BISYNC SYNL 16 Options Ignore these bits when comparing incoming character Enable comparing the character to cc n incoming HSS8 BISYNC SEND IDLES HSS8 BISYNC SEND FLAGS SYNCS CCII HSS8 6 MAN 002 2015 09 18 CH8MANO2 WPD Page 46 of 51
53. rogram Interface API CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 1 of 51 2 Applicable and Reference Documents 2 1 Applicable Documents 2 1 1 Motorola MPC8260 PowerQUICC II Family Reference Manual MPC8260UM D Rev 1 dated May 2003 2 1 2 CCII HSS8 6 MAN 001 Hardware Reference Manual for the 4 Channel New Generation and 8 Channel High Speed Serial I O Adapters 2 2 Reference Documents None CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 2 of 51 3 Software Driver Distribution The VxWorks Software Driver distribution consists of at least the following files ccHss8Lib lt arch gt V lt version gt lt long gt a Host architecture specific driver object file cc CCII Systems Pty Ltd Hss8Lib 8 Channel High Speed Serial VxWorks Software Driver arch Host for which the binary is built e X86 e PPC lt version gt Software version is a 3 digit integer e 1 digit version number 2 digit revision number e 3 digit beta number long VxWorks Software Driver compiled with mlongcall flag only for a PPC host e g ccHss8LibPPCV100 a for version 1 0 0 of the HSS8 software built for a PPC processor ccHss8EmbV lt version gt hex HSS8 firmware ccHss8Flash lt arch gt V lt version gt lt long gt a Flash update driver hss8Readme txt General information and installation notes hss8Release emb txt hss8Release host txt Release notes and revis
54. s HSS8 INVALID PARAM Invalid dev id supplied HSS8 DEVICE NOT FOUND If HSS8 device dev id was not found on the PCI bus HSS8 MEM INVALID ADDRESS If the HSS8 device PCI address was not valid HSS8 MEM EEPROM BUSY If the HSS8 device could not read version number from EEPROM hss8Status hss8Firmware version hss8DeviceId dev id hss8UINT32 version CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 CH8MANO02 WPD Page 24 of 51 6 2 13 HSS8 BIT Structures The following structures define the HSS8 BIT variables defined in hss8Controllfc h BIT Structures struct hss8BoardBitInfoStruct hss8UINT32 board_number hss8UINT32 firmware_version hss8UINT32 firmware_revision hss8UINT32 firmware_beta char firmware_creation_date 30 y typedef struct hss8BoardBitInfoStruct hss8BoardBitInfo struct hss8SendBitInfoStruct hss8Count nr_accepted hss8Count nr_rejected hss8Count nr_errors hss8Count nr_sent hss8Count nr_bytes_accepted hss8Count nr_bytes_rejected hss8Count nr_bytes_sent y typedef struct hss8SendBitInfoStruct hss8SendBitInfo struct hss8ReceiveBitInfoStruct hss8Count nr_buffers_busy hss8Count nr_received hss8Count nr_bytes_received hss8Count nr_errors typedef struct hss8ReceiveBitInfoStruct hss8ReceiveBitInfo Main BIT Structure struct hss8BitInfoStruct hss8BoardBitInfo board bit hss8SendBitInfo tx scc bit HSS8 HW NR SCC hss8ReceiveBitInfo rx scc bit HSS8 HW NR SC
55. y RTS Request to Send RxD Receive Data SBC Single Board Computer SCC Serial Communications Controller SDLC Synchronous Data Link C SMC Serial Management Controller SYNC Synchronisation TxD Transmit Data UART Universal Asynchronous Receiver Transmitter CCII HSS8 6 MAN 002 2015 09 18 Issue 1 6 As Scope 1 1 Identification This document is the user manual for the VxWorks Software Driver for the 8 Channel High Speed Serial HSS8 Adapter and the 4 Channel High Speed Serial Adapter HSS4NG The 4 Channel Adapter is based on a stripped down HSS8 Adapter and as such this manual applies except that only SCC Channels A D and SMC Channels J will be available 1 2 System Overview The HSS8 Adapter provides eight channels of simultaneous high speed bi directional serial communications and an additional four channels of lower speed serial communications available only on the frontpanel HSS8 Adapter The eight high speed channels are jumper configurable on a per channel basis for RS 232 or RS 422 485 drivers while the lower speed channels have RS 232 drivers only The HSS8 VxWorks Software Driver is a low level device dependant interface for transferring data over a C l2 Systems HSS8 Adapter The HSS8 VxWorks Software Driver binaries are provided with explicit installation instructions 1 3 Document Overview This document gives an overview of the HSS8 VxWorks Software Driver installation procedure and its Application P

User Manual 4-Channel New Generation 8-Channel High

Contents

Download Pdf Manuals

Related Search

Related Contents