4Links EtherSpaceLink Series User manual

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
EtherSp ceLink f milyUser M nu l
Diagnostic SpaceWire Interface
DSI-RG408 to Version 2.1
Manual Version 4
The 4Links Diagnostic SpaceWire Interface(DSI)is a rack-mountedtransparent interface
thatallows SpaceWirepacketstobe sent and received over Ethernet viaaTCP/IPsocket
connection. Itprovides remote access to aSpaceWirenetwork for softwaresimulation of
devices,remote monitoring anddistributedsystem integration activities.Inaddition,it
provides forthedetailed analysis ofSpaceWirecomponents,includingrouting switches.
Each packet received may be time-taggedto a resolutionbetterthan2ns.Thereis nolimit
to the lengthofthe SpaceWirepacketsthatcanbetransferred.Abnormaldata(“errors”)
may be injected andmonitored.The low-level SpaceWire link start-up andoperating
behaviourmay be modified for diagnostic purposes.Concurrent outputson severallinks
may be synchronized.Waveformcapturesofthe SpaceWire link signalsmay be triggered
by a verywideset ofevents.
TheEthernet portprovides a galvanically isolated connection with a cable lengthofupto
100 m. Attachingthis to theInternet allows world-scale connections.
Ethernet and TCP/IPprovidea standard interface mechanism thatissupportedby all
majoroperating systems, so no additionalsoftwaredrivers arerequired.
Thebasic DSI-RG408unitprovidesdatatransfersandmay be extendedwithoptionsto
providefortime codes,event reporting, waveformcaptureandtime-tags.Most options
canbeaddedasasimple fieldupgradeby replacingtheremovable memory cardonthe
front panelofthe unit.
Thisequipment isavailable withtwo, fouroreightactive portswhich may be mountedon
thefront panel (see thepictureabove) orontherear panel.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 1of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
Equipment Covered by this Manual
Model EtherSpaceLink family:
Diagnostic SpaceWire
Interface(DSI)- all RG models
Rack mountedEthernet to SpaceWireinterface.
Fast(100 Mb/s) orGbit(1000 Mb/s)Ethernet connection.
SpaceWire linkspeeds upto 400 Mb/s.
Two,Fouror Eight SpaceWireports
OptionsTT Time-Tags
EREvent / ErrorReporting
EIEvent / ErrorInjection
EW Event / Error Waveforms
SOSynchronizedoutputs
CO Controlledoutputs
ODOutput Disable
OE Output Enable
Revision history - DSI-RG408Manual
Version 4September2013
RMAPeel
Substantialadditions,includingincorporation oftheC-
languageprogramming APIdetails,new CO, OE andOD
options, anduse ofnewtext processingtools.
Version 3 20April2010
BM Cook
Added: RG8Rplatform,Platformdata, Usage
information.
Version 2 19 June 2007
BM Cook/CP H Walker
Added: Multi-unitsynchronisation,Delta Time-Tags,
Packet Generator/Checker.
Version 1 3 November2006
BM Cook/CP H Walker
Initial version.
SVN revision 229of2013/09/17
Variant a4:RG408
Legal noticeanddisclaimer:Copyright©2012-2013 4LinksLimited, all rightsreserved.Thename 4Linksandtheaccompanyingdeviceareregisteredasa
Trademark intheEuropeanUnion andintheUnitedStatesof America.Theinformation suppliedinthisdocument isbelievedto be accurate atthedate of issue.
4Linksreservestherighttochangespecificationsorto discontinue productswithoutnotice. 4Linksassumesnoliability arisingout oftheapplication oruse of
any information or product,nordoesitconvey anylicence underitspatent rightsortherightsofothers. Productsfrom 4LinksLimitedarenot designed,
intended, authorisedor warrantedto be suitable forusein life-supportdevicesorsystems.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 2of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
Table of Contents
CoverPage............................. 1
Equipment Coveredbythis Manual..................... 2
Revision history - DSI-RG408Manual.................... 2
1. GeneralSafety Summary....................... 7
1.1.Terms inthis Manual....................... 7
1.2. Symbolsonthe Product. ...................... 7
2.Description ofOperation ....................... 8
2.1.General............................ 8
2.2.GettingStarted......................... 9
2.3. Standard DiagnosticSpaceWireInterfaceCapabilities............. 10
2.4. DSIOptions.......................... 10
2.4.1.ER- Event / Error Reporting.................... 10
2.4.2.EW - Event / ErrorWaveforms................... 10
2.4.3.EI- Event / Error Injection.................... 10
2.4.4.TT -Time-tags ........................ 11
2.4.5. SO - SynchronizedOutputs.................... 11
2.4.6.CO -ControlledOutputs..................... 11
2.4.7.ODandOE - Output Disable andOutput Enable............. 12
2.5. Front-Panel Display ........................ 12
2.5.1.Ethernet information...................... 12
2.5.2. SpaceWireinformation..................... 12
2.6.Communication Protocols...................... 13
2.7. ProgrammingAPI........................ 13
3.Specification ........................... 14
3.1. SpaceWire Links......................... 14
3.1.1. SpaceWireReceive Performance.................. 14
3.1.2. SpaceWireTransmit Performance. ................. 14
3.1.3. SpaceWireConnectors ..................... 14
3.1.4. SpaceWireTime Codes..................... 15
3.2.TheEthernet Connection. ..................... 15
3.2.1.ICMPEcho (ping)Support.................... 15
3.2.2.Full-Duplex Ethernet ...................... 15
3.3. SMA Synchronization Connectors ................... 15
3.4. DiscoveringaUnit’s SerialNumberandInstalledProductOptions........ 16
3.4.1.TheUnit SerialNumberand its relationto theEthernet MAC address ...... 16
3.4.2.InstalledProductOptions..................... 16
3.5. TheRG408Hardware Platform.................... 17
3.5.1. Dimensions......................... 17
3.5.2.EnvironmentalRequirements................... 17
3.5.2.1.Ventilation Requirements................... 17
3.5.3. PowerSupply........................ 18
4Links Limited
www.4Links.co.uk
[email protected]
p ge 3of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
3.5.3.1. SupplyVoltage. ...................... 18
3.5.3.2. PowerConsumption. .................... 18
3.5.3.3. PowerConnector...................... 18
3.5.3.4.GroundingforElectrical Safety................. 19
3.5.3.5. Fuse Protection. ...................... 19
3.5.4. HandlingandTransportation................... 19
3.5.5. RG PlatformFirmware. ..................... 20
4. Block Diagram.......................... 21
5. Front Panel Display........................ 22
5.1.Initial (power-up)display ...................... 22
5.2.Normal (status)display ....................... 22
6. Front Panel Interactions ....................... 24
6.1.IPaddress ........................... 27
6.2.Time Synchronisation....................... 27
6.3. HealthDisplay ......................... 27
7. DSI Option Details ......................... 28
8. Option ER - Event / ErrorReporting.................. 28
9. Option TT -Time Tags....................... 29
10. Option EI- Event / Error Injection ................... 30
11. Option EW- Event / Error Waveforms ................. 31
12. Option SO - SynchronizedOutputs ................... 36
13. Option CO -ControlledOutputs .................... 39
14. Options ODandOE - Output Disable andOutput Enable ........... 40
15. Unit-to-Unit Time-Tag Synchronisation ................. 41
15.1. Settingthe Synchronisation Source.................. 42
16.Software............................ 44
16.1.FilesSuppliedwiththe DSI..................... 44
16.2.Controllingthe DSIusingtheSpWIO Program.............. 45
16.3.TheRMAPpluginfortheSpWIO Program................ 45
16.4.C-languageApplication Programming Interface.............. 45
16.5. WaveformHandling....................... 45
17. C-languageApplication Programming Interface .............. 47
17.1.EtherSpaceLinkFamily ArchitectureandProgrammingModel ......... 47
17.1.1. PrinciplesofOperation. .................... 47
17.1.2.Terminology........................ 48
17.1.3. Protocol Hierarchy ...................... 48
17.1.4.TheEthernet ConnectiontoanEtherSpaceLinkUnit........... 49
17.1.5. TheEtherSpaceLinkProtocol ................... 49
17.1.6. SpaceWireTransmissions.................... 50
17.2. SpaceWire Link Modeterms..................... 50
4Links Limited
www.4Links.co.uk
[email protected]
p ge 4of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
17.3.CompilingProgramsthat usetheEtherSpaceLink API............ 50
17.4.GettingStarted- aninitial example APIprogram.............. 51
17.5. AdvancedProgrammingConcepts................... 53
17.5.1.TransmittingSpaceWire Data,Extension SequencesandSpecialPackets..... 53
17.5.2.ReceivingSpaceWire Data,Extension Characters andSpecialPackets...... 53
17.5.3.AsynchronousIssuesduringStatusPolling.............. 54
17.5.4.UsingMultiple Threads Safely................... 55
17.5.5. MaximisingtheThroughput of APIPrograms............. 55
17.5.6.AnAdvancedAPIExample. ................... 56
17.6.TheAPI Functions........................ 62
17.6.1.EtherSpaceLink_open() .................. 63
17.6.2.EtherSpaceLink_close() .................. 65
17.6.3.EtherSpaceLink_set_log_file() .............. 66
17.6.4.EtherSpaceLink_set_id() ................. 67
17.6.5. EtherSpaceLink_set_mode() ................ 68
17.6.6.EtherSpaceLink_write_packet() .............. 71
17.6.7.EtherSpaceLink_write_EXTN() ............... 73
17.6.8.EtherSpaceLink_write_buffer_empty() ............ 76
17.6.9. EtherSpaceLink_flush() .................. 77
17.6.10. EtherSpaceLink_set_receive_timeout() ........... 78
17.6.11.EtherSpaceLink_read_packet() ............... 79
17.6.12.EtherSpaceLink_read_packet_callback() .......... 81
17.6.13.EtherSpaceLink_read_packet_special_callback() ...... 82
17.6.14.EtherSpaceLink_read_packet_extension_callback() ..... 84
17.6.15. EtherSpaceLink_callback_packet_type() .......... 86
17.6.16.EtherSpaceLink_read_packet_full() ............ 87
17.6.17.EtherSpaceLink_read_packet_full_nowait() ......... 92
17.6.18.EtherSpaceLink_read_packet_status() ........... 95
17.6.19. EtherSpaceLink_read_packet_wait_for_completion() ..... 96
17.6.20. EtherSpaceLink_set_speed() ................ 97
17.6.21.EtherSpaceLink_set_speed_double() ............ 98
17.6.22.EtherSpaceLink_link_connected() ............. 99
17.6.23.EtherSpaceLink_get_number_of_links() ...........100
17.6.24.EtherSpaceLink_set_active_link() .............101
17.6.25. EtherSpaceLink_get_manufacturer_string() .........102
17.6.26.EtherSpaceLink_get_product_string() ...........103
17.6.27.EtherSpaceLink_get_HWA() .................104
17.6.28.EtherSpaceLink_HWA_to_serial_number_string() .......105
17.6.29. EtherSpaceLink_extract_timetag() .............106
17.6.30. EtherSpaceLink_ER_enable_reporting() ...........107
17.6.31.EtherSpaceLink_EW_enable_reporting() ...........109
17.6.32.EtherSpaceLink_EW_source() ................112
17.6.33.EtherSpaceLink_TT_enable_reporting() ...........114
17.6.34.EtherSpaceLink_EI_ignore_events() ............116
17.6.35. EtherSpaceLink_EI_flow_control() .............118
18. TroubleshootingGuide.......................120
19. The SpaceWireState Machine ....................123
4Links Limited
www.4Links.co.uk
[email protected]
p ge 5of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
19.1.TheEtherSpaceLinkdisplay ofthe SpaceWirestate machine ..........123
19.2.TheEtherSpaceLink APIviewofthe SpaceWirestate machine .........123
20.Statement of Volatility .......................124
20.1.Removingall information from aUnit.................124
20.2. Security Notice. ........................124
21. Product Limitations andFeatures ...................124
21.1.Ethernet ...........................124
21.2. SpaceWire. ..........................124
22. RegulatoryInformation ......................125
22.1.ElectromagneticCompatibility....................125
22.2. Product Safety.........................125
22.3.Equipment Recycling.......................125
22.4.Restriction ofHazardousSubstances..................125
23. RG408 Product Drawings......................126
23.1. Plan views...........................126
23.2.Front views..........................128
23.3.Rearviews..........................129
4Links Limited
www.4Links.co.uk
[email protected]
p ge 6of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
1. GeneralSafety Summary
Reviewthefollowingsafetyprecautionsto avoidinjury andprevent damageto thisproduct orto any
productsconnectedto it.
Toavoidpotentialhazards,usethisproduct only asspecified.
There arenouser-serviceable parts insidethis equipment.
Do not remove covers.
Do not operate with suspectedfailures. If you suspectthatthereisdamageto thisproduct,
referto 4Linksfor advice.
Do not operate in wet or damp conditions.
Do not operate in anexplosiveatmosphere.
Keepproduct surfaces cleananddry.
Provide proper ventilation. Theair inlet andoutlet ontherear panel mustnotbe obstructed.
1.1. Terms inthis Manual
CAUTION:
Caution statementsidentify conditionsor practicesthatcouldresult indamageto this
product ortoother property.
1.2.Symbols onthe Product
Thefollowingsymbol may appear ontheproduct:
CAUTION:
Referto thisusermanualforsafety information.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 7of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
2.Description ofOperation
Thissection describesthe mainfeaturesofthe Diagnostic SpaceWireInterface.
The Diagnostic SpaceWireInterface(DSI)isa high-performanceEthernet-to-SpaceWire Bridgethat
canrelay traffic from asingle TCP/IPEthernet connectiontoupto eightconcurrently-operating
bidirectional SpaceWireports.
The DSImay be purchasedwithfirmwarethatsupportsfewerthantheeight SpaceWireconnectorson
theRG408hardwareplatform. Inthiscase,onlythe lowest-numberedSpaceWireconnectorsare
usable -e.g.ports1and2for2-portfirmwareandports1-4 for 4-portfirmware. Theremaining ports
aredisabled.Firmware upgradesto enable further portsareavailable from 4LinksLimited.
2.1. General
The DSIisconnectedto anEthernet network andpassivelywaitsfor a connection from a host
computer.Itisidentifiedby anIPaddress thatisusedbythehostcomputerto makethisconnection.
Theconnection ismade using a TCPsocket, which isflow-controlledandiscapable of recovering from
errorsthat might occuronthenetwork between the user andtheEtherSpaceLinkunit.
Upon makingtheconnection,the DSIisset to a knownstate withthe SpaceWire linksdisabled,the
linkspeedset to 10Mb/sandall the optionsreset. The user programmustenablethe SpaceWire links
beforedata canbesent orreceived.Onceenabled,data istransferred,transparently, from the
SpaceWire linkto theapplication program onthehost, andalsofrom theprogram to the SpaceWire
link.
Thereisnolimitation onthesize of packet transfersineach direction -noteven asa result offinite
buffersizes.The user hascomplete control overthe SpaceWirepacket content andstructure; a packet
may be sent orreceivedinsegments.
Thehostprogramcanalsocontrol thetransmission speedofthe SpaceWire links.Thetransmitspeed
canbechangedatanytime,includinginthe middle of a packet. Speedchangesaretransparent anddo
not require linkdisconnection. Inaccordancewiththestandard,the SpaceWire linksalwaysstartat
10Mb/sandthen, when the link(s)areestablished,theymay be changedto the user-selectedspeed.All
ofthe linksonthe DSIrun atthesame user-selectedspeed,exceptfor anythatareselectedto remain
attheinitial10Mb/srate.
Disconnection ofthe user’sprogramfrom the DSIresultsinthe SpaceWire linksbeingdisabledandall
ofthe DSIoptionsbeingreset.
The DSIcanthereforebeseen asatransparent interface- when the user programactivatesthe
SpaceWire links,they canconnectto thetarget SpaceWirenetwork, andwhen the user programis
stopped,the SpaceWire linksdisconnect.
The Diagnostic SpaceWireInterface may be operatedinthree ways:
By itsoperator from their computer keyboard,using a suppliedprogram to generate andmonitor
SpaceWiretraffic manually;
Through the use of pre-designedcommandscriptsthatrun standardsetsoftestsandanalysethe
resultsautomatically;
Using customer-createdsoftwarethatinteractswiththeir SpaceWirenetwork through the
EtherSpaceLink Application Programminginterface(API) under programcontrol.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 8of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
2.2. Getting Started
AsanEthernet-to-SpaceWirebridge,theprimarypurpose ofthe Diagnostic SpaceWireInterfaceisto
relay traffic from a hostcomputertoone ormore SpaceWireports, andvice-versa.Thiscaneasilybe
demonstratedby connecting port1ofthe DSIback to itselfusingthesuppliedloop-back connector:
PC
1 2 3 4 5 6 7 8Ports:
DSI
Loop−back connector Ethernet
Fig re 2.1: Connecting theDSI in loop-back mode
UsingtheSpWIO program, a SpaceWirepacket may be sent from thehostcomputerto the DSI’s
SpaceWireport1, from whereitflowsthrough the loop-back cable andback to port1.From there,it
will be returnedto thehostcomputer, displayedandrecorded.
java -jar SpWIO.jar /u 192.168.3.42
//-4Links.SpWIO (v24:20111201/v33:20110920) on Fri Sep 14 14:48:04 BST 2012
//-/u 192.168.3.42
//-Attached 192.168.3.42 is DSI-RG40x/8 v1.9 [EI,EW,ER,TT,SO], 8-ports,
//- link mode is normal at 10.0Mb/s
//-Log file is "SpWIO_20120914_144809.log"
//-Input from "(console)"
@1 2 4 6 8 eop
Tx:@1 #02 #04 #06 #08 EOP
Rx:@1 #02 #04 #06 #08 EOP
Herewecansee thata4-byte EOP-terminatedpacket wastransmittedto port1ofthe DSI, anda4-byte
packet wasthen receivedfrom port1.
Furtherexamplesinthismanualwill illustrate some oftheadvancederror-injection,error-reporting
andsynchronisation featuresofthe Diagnostic SpaceWireInterface.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 9of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

Di gnostic Sp ceWireInterf ce
EtherSp ceLink f milyUser M nu l
2.3.Standard Diagnostic SpaceWire Interface Capabilities
All DSIunitsincludethefollowing capabilities:
Bridgingofbidirectionalstreamsof charactersfrom Ethernet to SpaceWire;
Theabilityto support upto eightconcurrently-active SpaceWireports,dependingonthe
configuration purchased;
Thetransmitspeedofthe linkscanbeset at upto 400 Mb/sinstepsof1Mb/sorless;
Thereceive speedofthe linksisinexcess of 400 Mb/s;
Softwareisprovidedforthe manualandscriptedgeneration ofSpaceWiretraffic, together with a
C-languageprogramming APIfor automatedtesting.
2.4. DSI Options
ADiagnostic SpaceWireInterfacecanbesuppliedwithfirmwarethatprovidesadditionaloptional
features. Detailedinformation aboutthese optionscanbefoundinsection 7,“DSIOption Details”.
2.4.1. ER - Event / Error Reporting
Tokensdefinedaserrors,thatwouldnormallybe hidden (typically resultinginalink reset) and
replacedby(at most) anEEPcharacter, canbe made visibleto the user.Correct,butnormally hidden
tokens(such asflow-control tokens)canalso be transferredto the user.
2.4.2. EW- Event / Error Waveforms
Each SpaceWireporthasanassociatedwaveformstorethatcapturestransmitandreceive wiresignals
forthatport. Waveformcapturescanbetriggeredon a wide varietyofeventsonthatand/orother
ports.Itispossible, forexample,to capturewiresignalsfor all portsafter a triggersignalon one port.
Triggersincludeall error conditions,receiveddata, liftingofthesynchronisedoutputsbarrier, signals
ontheexternal SMA connectors, anduser-insertedflagsinthetransmitdatastream.
2.4.3. EI- Event / Error Injection
SpaceWiretokensthatarenotnormally generated,becausethey aredefinedaserrors, canbeexplicitly
insertedinto thedatastream:
Parityerrorbetween tokens
ESC-EOP-escapeend-of-packet
ESC-EEP-escapeerror-end-of-packet
ESC-ESC-escapeescape
Idle periods - when D andSremainconstant. Anextendedidle period(greaterthanthe
SpaceWiredisconnecttimeout, which isnominally850 ns)shouldtrigger a SpaceWiretimeout
response.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 10 of 130
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk