4Links EtherSpaceLink Series User manual

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
EtherSp ceLink f milyUser M nu l
EtherSpaceLink-RG408
ESL-RG408 to Version 1.5
Manual Version 2
The 4Links EtherSpaceLinkprovides remote access to a SpaceWirenetworkfor software
simulation of devices,remote monitoring anddistributedsystem integration activities.
It provides a transparent interface allowing SpaceWire packets to be sent and received by
an application program using an Ethernet connexion. It is implemented onthe 4Links
Ethernet platformssuch as the one-port RG201 and theeight-port RG408.
AstandardTCP/IPsocket connection isusedto provide reliabledelivery ofdata despite
errorsoccurring onthe Ethernet link. Thisstandardinterface mechanism issupportedby
all majoroperating systems- additionalsoftware driversarenot required.
The Ethernet port providesa galvanically isolatedconnectionwith a cablelength ofup to
100 m. Attaching thistothe Internet allowsworld-scale connections.
There isnolimittothe length of the SpaceWire packetstransferred.
Thebasic EtherSpaceLink unit providesdata transfersandmaybe extendedwith options
to provide for time codes, event reporting, waveform capture andtime-tags. Mostoptions
canbe addedasasimple fieldupgradebyreplacing the removable memorycardinstalled
onthe front panelof the unit.
The RG408 hardware platform haseight SpaceWire ports,ofwhich justone maybe
utilisedat anytimebythe EtherSpaceLinkinterface. The purchaseof additionalfirmware
allowsthe hardware platform toserve many other purposeswhen it isnotbeing usedas
an ESL.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 1of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
Equipment Covered by this Manual
Model EtherSpaceLinkfamily:
EtherSpaceLink(ESL)- all
RG408 models
Rackmounted Ethernet toSpaceWireinterface.
Opticalfibreor copper1000 Mb/s/100 Mb/sEthernet
connection.
SpaceWirelinkspeeds up to400 Mb/s.
Two,FourorEight SpaceWireports.
Options TT Time-Tags
ER Event / ErrorReporting
EWEvent / Error Waveforms
TC Timecode receiveand transmit
SF Store-and-forward buffer
Revision history - ESL-RG408Manual
Version 2 September2013
RMAPeel
Substantialadditions and use ofnewtext processing
tools.
Version 1 23 May2005
BM Cook
Initialversion-derived fromtheESL-RF201 manual.
SVN revision 230Mof2013/09/17
Variant a4:RG408
Legalnoticeanddisclaimer:Copyright©2012-2013 4LinksLimited, all rights reserved. Thename4Linksand theaccompanyingdeviceareregistered asa
TrademarkintheEuropeanUnionand intheUnited States of America.Theinformation supplied inthisdocument is believed tobe accurate atthe date of issue.
4Linksreserves therighttochange specifications ortodiscontinueproducts withoutnotice. 4Linksassumes noliabilityarisingoutoftheapplicationoruse of
anyinformationorproduct,nordoes itconveyany licenceunderits patent rights ortherights ofothers. Products from 4LinksLimited arenot designed,
intended, authorised orwarranted tobe suitableforuse inlife-support devices orsystems.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 2of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
Table of Contents
CoverPage............................. 1
Equipment Covered bythisManual..................... 2
Revisionhistory-ESL-RG408Manual.................... 2
1. GeneralSafety Summary....................... 7
1.1. Terms inthisManual....................... 7
1.2. SymbolsontheProduct. ...................... 7
2.Description ofOperation ....................... 8
2.1. General............................ 8
2.2. Getting Started ......................... 9
2.3. StandardEtherSpaceLinkCapabilities .................. 10
2.4.EtherSpaceLinkOptions ...................... 10
2.4.1. ER-Event / Error Reporting.................... 10
2.4.2. EW - Event / ErrorWaveforms ................... 10
2.4.3. TT -Time-tags........................ 10
2.4.4.TC - SpaceWireTime Code generator/distributor............ 10
2.4.5.SF -Storeand ForwardBuffer................... 11
2.5.Front-PanelDisplay........................ 11
2.5.1. Ethernet information...................... 11
2.5.2. SpaceWireinformation..................... 11
2.6.CommunicationProtocols...................... 11
2.7.ProgrammingAPI........................ 12
3.Specification ........................... 13
3.1. SpaceWire Links......................... 13
3.1.1. SpaceWireReceivePerformance.................. 13
3.1.2. SpaceWireTransmitPerformance. ................. 13
3.1.3. SpaceWireConnectors..................... 13
3.1.4.SpaceWireTime Codes ..................... 14
3.2. TheEthernet Connection. ..................... 14
3.2.1. ICMP Echo(ping)Support.................... 14
3.2.2. Full-DuplexEthernet ...................... 14
3.3. SMA SynchronizationConnectors................... 14
3.4.DiscoveringaUnit’sSerialNumberandInstalled ProductOptions ........ 15
3.4.1. TheUnitSerialNumberand its relationtotheEthernet MAC address ...... 15
3.4.2. Installed ProductOptions ..................... 15
3.5.TheRG408 HardwarePlatform.................... 16
3.5.1. Dimensions ......................... 16
3.5.2. EnvironmentalRequirements ................... 16
3.5.2.1. VentilationRequirements ................... 16
3.5.3. Power Supply ........................ 17
3.5.3.1. Supply Voltage. ...................... 17
3.5.3.2. PowerConsumption. .................... 17
4Links Limited
www.4Links.co.uk
[email protected]
p ge 3of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
3.5.3.3. PowerConnector...................... 17
3.5.3.4.GroundingforElectricalSafety................. 18
3.5.3.5.Fuse Protection. ...................... 18
3.5.4. Handlingand Transportation................... 18
3.5.5.RG PlatformFirmware. ..................... 19
4. Block Diagram.......................... 20
5. Front Panel Display........................ 21
5.1. Initial(power-up)display...................... 21
5.2. Normal(status)display....................... 21
6. Front Panel Interactions ....................... 23
6.1. IPaddress ........................... 26
7. EtherSpaceLink Option Details .................... 27
8. Option ER - Event / ErrorReporting.................. 27
9. Option TT -Time Tags....................... 28
10. Option EW- Event / Error Waveforms ................. 29
11. Option TC - SpaceWire Time Codegenerator/distributor(TC)........ 31
12. Option SF-StoreandForward Buffer.................. 32
13.Software............................ 33
13.1. Files Supplied withtheEtherSpaceLinkUnit............... 34
13.2. ControllingtheEtherSpaceLink usingtheSpWIO Program.......... 34
13.3. ControllingtheEtherSpaceLink usingtheSpaceWireUI Program....... 34
13.4.ApplicationProgrammingInterface.................. 35
13.5.WaveformHandling....................... 35
14. C-languageApplication Programming Interface .............. 36
14.1. EtherSpaceLinkFamily Architectureand ProgrammingModel......... 36
14.1.1. Principles ofOperation. .................... 36
14.1.2. Terminology........................ 37
14.1.3. Protocol Hierarchy...................... 37
14.1.4.TheEthernet ConnectiontoanEtherSpaceLinkUnit........... 38
14.1.5.TheEtherSpaceLink Protocol ................... 38
14.1.6.SpaceWireTransmissions .................... 39
14.1.7.Modules,Options and Slots .................... 39
14.2. SpaceWire LinkModeterms ..................... 39
14.3. CompilingPrograms thatusetheEtherSpaceLinkAPI............ 40
14.4.Getting Started - aninitialexampleAPIprogram.............. 41
14.5.Advanced ProgrammingConcepts ................... 43
14.5.1. Transmitting SpaceWireDataand SpecialPackets ............ 43
14.5.2. Receiving SpaceWireDataand SpecialPackets ............. 43
14.5.3. AsynchronousIssuesduring StatusPolling.............. 44
14.5.4.UsingMultipleThreads Safely ................... 45
14.5.5.MaximisingtheThroughputof APIPrograms ............. 45
4Links Limited
www.4Links.co.uk
[email protected]
p ge 4of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
14.5.6.AnAdvanced APIExample. ................... 45
14.6.TheAPIFunctions ........................ 51
14.6.1. EtherSpaceLink_open() .................. 52
14.6.2. EtherSpaceLink_close() .................. 54
14.6.3. EtherSpaceLink_set_log_file() .............. 55
14.6.4.EtherSpaceLink_set_id() ................. 56
14.6.5.EtherSpaceLink_set_mode() ................ 57
14.6.6.EtherSpaceLink_write_packet() .............. 59
14.6.7.EtherSpaceLink_write_buffer_empty() ............ 61
14.6.8. EtherSpaceLink_flush() .................. 62
14.6.9.EtherSpaceLink_set_receive_timeout() ........... 63
14.6.10.EtherSpaceLink_read_packet() ............... 64
14.6.11. EtherSpaceLink_read_packet_callback() .......... 66
14.6.12. EtherSpaceLink_read_packet_special_callback() ...... 67
14.6.13. EtherSpaceLink_read_packet_full() ............ 69
14.6.14.EtherSpaceLink_read_packet_full_nowait() ......... 73
14.6.15.EtherSpaceLink_read_packet_status() ........... 76
14.6.16.EtherSpaceLink_read_packet_wait_for_completion() ..... 77
14.6.17.EtherSpaceLink_set_speed() ................ 78
14.6.18. EtherSpaceLink_set_speed_double() ............ 79
14.6.19.EtherSpaceLink_link_connected() ............. 80
14.6.20.EtherSpaceLink_get_number_of_links() ........... 81
14.6.21. EtherSpaceLink_set_active_link() ............. 82
14.6.22. EtherSpaceLink_get_manufacturer_string() ......... 83
14.6.23. EtherSpaceLink_get_product_string() ........... 84
14.6.24.EtherSpaceLink_get_HWA() ................. 85
14.6.25.EtherSpaceLink_HWA_to_serial_number_string() ....... 86
14.6.26.EtherSpaceLink_get_module_slot() ............. 87
14.6.27.EtherSpaceLink_get_control_packet() ........... 89
14.6.28. EtherSpaceLink_extract_module_type() ........... 90
14.6.29.EtherSpaceLink_set_timecode_receive() .......... 91
14.6.30.EtherSpaceLink_set_timecode_transmit() .......... 92
14.6.31. EtherSpaceLink_extract_timetag() ............. 94
14.6.32. EtherSpaceLink_ER_enable_reporting() ........... 95
14.6.33. EtherSpaceLink_EW_enable_reporting() ........... 97
14.6.34.EtherSpaceLink_TT_enable_reporting() ........... 99
15. TroubleshootingGuide.......................101
16. The SpaceWireState Machine ....................103
16.1. TheEtherSpaceLinkdisplay oftheSpaceWire state machine ..........103
16.2. TheEtherSpaceLinkAPIview oftheSpaceWire state machine .........103
17. Statement of Volatility .......................104
17.1. Removingall informationfromaUnit.................104
17.2. SecurityNotice. ........................104
18. Product Limitations andFeatures ...................104
18.1. Ethernet ...........................104
18.2. SpaceWire. ..........................104
4Links Limited
www.4Links.co.uk
[email protected]
p ge 5of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
19. RegulatoryInformation ......................105
19.1. ElectromagneticCompatibility....................105
19.2. ProductSafety.........................105
19.3. Equipment Recycling.......................105
19.4.RestrictionofHazardousSubstances ..................105
20. RG408 Product Drawings......................106
20.1. Planviews...........................106
20.2. Front views..........................108
20.3. Rear views..........................109
4Links Limited
www.4Links.co.uk
[email protected]
p ge 6of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
1. GeneralSafety Summary
Reviewthefollowingsafetyprecautions toavoidinjuryand prevent damagetothisproductortoany
products connected toit.
Toavoidpotentialhazards,usethisproductonly asspecified.
There arenouser-serviceable parts insidethis equipment.
Do not remove covers.
Do not operate with suspectedfailures. Ifyou suspectthatthereisdamagetothisproduct,
referto4Linksfor advice.
Do not operate in wet or damp conditions.
Do not operate in anexplosiveatmosphere.
Keepproduct surfaces cleananddry.
Provide proper ventilation. Theair inlet and outlet ontherear panelmustnotbeobstructed.
1.1. Terms inthis Manual
CAUTION:
Caution statements identifyconditions orpractices thatcouldresultin damagetothis
productortootherproperty.
1.2.Symbols onthe Product
Thefollowingsymbol mayappear ontheproduct:
CAUTION:
Refertothisuser manualforsafetyinformation.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 7of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
2.Description ofOperation
Thissection describes themainfeatures oftheEtherSpaceLink unit.
TheESL isa high-performanceEthernet-to-SpaceWireBridgethatcanbidirectionally relaytraffic from
a TCP/IP Ethernet connectiontoone SpaceWireport.
OntheRG408 hardwareplatform, whichhas eight SpaceWireconnectors,theESL-RG401/8provides
access tojusttheone SpaceWireportthathas been selected atanytime, and theremainingseven
SpaceWireports are disabled.
2.1. General
TheESL isconnected toanEthernet networkand passivelywaits for a connectionfrom a host
computer. It isidentified byan IPaddress thatisused bythehost computertomakethisconnection.
Theconnectionismade using a TCPsocket,which isflow-controlled and iscapableof recovering from
errors thatmightoccurontheEthernet networkbetween theuser and theEtherSpaceLink unit.
Uponmakingtheconnection,theESL isset toaknown state withtheSpaceWirelinksdisabled,the
linkspeedset to10 Mb/sand all theoptions reset. Theuserprogrammustenablethe SpaceWirelinks
before data canbe sent orreceived. Onceenabled,data is transferred,transparently, fromthe
SpaceWirelinktotheapplicationprogram onthehost, and alsofromtheprogram totheSpaceWire
link.
Thereis nolimitationonthe sizeofpacket transfersineach direction-noteven asa resultoffinite
buffersizes. Theuser hascomplete control overtheSpaceWirepacket content andstructure; apacket
maybe sent orreceived in segments.
Thehost program canalsocontrol thetransmission speed oftheSpaceWirelinks. Thetransmit speed
canbechanged atanytime,includinginthemiddleof a packet. Speed changes aretransparent anddo
notrequirelinkdisconnection. In accordancewiththeECSS-E-ST-50-12CSpaceWire standard,the
SpaceWirelinkalwaysstarts at 10 Mb/sand then,when thelinkis established,itmaybe changed to
theuser-selectedspeed.
Disconnectionoftheuser’sprogram fromtheESL results inthe SpaceWirelinkbeingdisabled and all
oftheESLoptions beingreset.
TheEtherSpaceLinkmaybe operated inthree ways:
By its operator fromtheir computerkeyboard,using a supplied program togenerate and monitor
SpaceWiretraffic manually;
Through theuse ofpre-designed commandscripts thatrun standardsets oftests and analysethe
results automatically;
Using customer-createdsoftwarethatinteracts withtheir SpaceWirenetworkthrough the
EtherSpaceLinkApplicationProgramminginterface(API) underprogram control.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 8of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
2.2. Getting Started
AsanEthernet-to-SpaceWirebridge,theprimarypurpose oftheEtherSpaceLinkis torelaytraffic from
a host computertoaSpaceWireport, and vice-versa.Thiscaneasily be demonstrated byconnecting
port 1 oftheESL backtoitselfusingthe supplied loop-backconnector:
1 2 3 4 5 6 7 8Ports:
PC
Ethernet
Loop−back connector
ESL−RG401/8
Fig re 2.1: Connecting theESL in loop-back mode
UsingtheSpWIO program, a SpaceWirepacket maythen be sent fromthehost computertotheESL’s
SpaceWireport, fromwhereitflows through theloop-backcableand backintotheport. Fromthere,it
will be returned tothehost computer, whereitcanbe displayed and recorded.
java -jar SpWIO.jar /u 192.168.3.40
//-4Links.SpWIO (v24:20111201/v33:20110920) on Tue May 07 04:52:57 BST 2013
//-/u 192.168.3.40
//-Attached 192.168.3.40 is ESL-RG201 v1.5, 1-port, link mode is normal at 10.0Mb/s
//-Log file is "SpWIO_20130507_045259.log"
//-Input from "(console)"
@1 2 4 6 8 eop
Tx:@1 #02 #04 #06 #08 EOP
Rx:@1 #02 #04 #06 #08 EOP
Thisactionmayalsobe performed withtheSpaceWireUI Graphical UserInterfaceprogram:
Fig re 2.2:Getting Started withtheSpaceWireUI program
Herewecan see thata4-byte EOP-terminated packet was transmitted to port 1 oftheESL unit, and a
4-byte packet was then received backinto port 1.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 9of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk

EtherSp ceLink-RG408
EtherSp ceLink f milyUser M nu l
Furtherexamples inthismanual will illustrate someoftheadvanced error-reporting and interfacing
features oftheEtherSpaceLink unit.
2.3.StandardEtherSpaceLink Capabilities
All ESL units includethefollowing capabilities:
Bridgingof a bidirectionalstream of charactersfromEthernet toSpaceWire;
Theabilitytosupportone activeSpaceWireportatanytime,selected fromtheeightports onthe
RG408 platform.
Thetransmit speed ofthelinkscanbe set atup to400 Mb/sin stepsof1Mb/sorless;
Thereceive speed ofthelinksisinexcess of 400 Mb/s;
Softwareisprovided forthemanualandscripted generationof SpaceWiretraffic, togetherwith a
C-languageprogramming APIfor automated testing.
2.4. EtherSpaceLink Options
AnEtherSpaceLink unitcanbe supplied withfirmwarethatprovides additionaloptionalfeatures.
Detailed informationaboutthese options canbefound in section7,“EtherSpaceLinkOption Details”.
2.4.1. ER - Event / Error Reporting
Tokensdefined as errors,thatwould normally be hidden (typically resultinginalinkreset)and
replaced by(at most)anEEP character, canbe made visibletotheuser.Correct,butnormally hidden
tokens (such asflow-control tokens)canalsobe transferred totheuser.
2.4.2. EW- Event / Error Waveforms
TheSpaceWireporthasanassociated waveform storethatcaptures transmitand receivewire signals
forthatport. Waveformcaptures canbetriggered onawide variety ofevents onthatport.
Triggersinclude all error conditions,receiveddatabytes, and SpaceWiretime-codes.
2.4.3. TT -Time-tags
Thefirstbyte ofeach SpaceWirepacket,theEnd-of-packet marker and all intermediate packet bytes
canbetime-tagged with a resolutionofbetterthan 10 ns.
2.4.4. TC - SpaceWire Time Code generator / distributor
SpaceWiretime codes maybe automatically generated usingtheTC optionatintervals between 10 µs
and 999 s,orindividually uponuserrequest.
All eightbits ofthetime code value maybe set,totestthattheattached SpaceWirenetworkhandles
these cases properly,even though theSpaceWireStandard mandates thatthe most significant two
reserved bitsshould be transmitted aszeroes.
4Links Limited
www.4Links.co.uk
[email protected]
p ge 10 of 110
T+44 1908 642001; F+44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley P rk