User Manual Gigabit Ethernet Adapter VxWorks
Contents
1. CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 4 of 12 5 1 5 2 5 3 5 4 Using the Gigabit Ethernet Software Driver DualNet and RLMT Modes The two ports of the GE Adapter may be used either to provide two independent communication channels DualNet mode or as a single dual redundant channel RLMT mode In DualNet mode each channel is assigned is own IP address In RLMT mode the secondary port becomes a hot standby in the event of failure of the primary port Only one IP address is assigned as the hardware will determine over which physical channel the data is routed Loading and Starting the Driver in DualNet Mode To start the driver in DualNet mode muxDevStart muxDevLoad 0 geLoad 0 0 muxDevStart muxDevLoad 1 geLoad 0 0 This will create two devices ccgeO and ccge1 Loading and Starting the Driver in RLMT Mode To start the driver in RLMT mode muxDevStart muxDevLoad 0 geLoad RlmtMode CheckLinkState 0 0 Command Line Parameters The general form of the Gigabit Ethernet Software Driver loads command is as follows muxDevLoad device geLoad parameter 1 parameter 2 parameter 3 0 0 where device is a unique instance number starting from 0 and parameter n is as described in the following table Parameter Description Permitted Default Value Values This parameter is used to set the speed capabilities It is only valid for copper adapters Usually the sp2. 4 1 1 4 2 4 3 Installation Procedure This paragraph describes the installation procedure for the Gigabit Ethernet VxWorks Software Driver The examples given are for a DY4 SVME DMV181 PowerPC host Large UDP Packet Support In order to transmit large UDP packets typically larger than 1 992 bytes the VxWorks Network Stack Memory Pool Configuration has to be changed to add larger data clusters The procedure for doing this differs between VxWorks 5 5 and VxWorks 6 x Procedure for VxWorks 5 5 if building target images using Tornado This configuration change cannot be performed from the Tornado Project GUI itself The file tornado target config comps src net usrNetLib c needs to be changed as shown in Annexure B The example in Annexure B adds 10 clusters each of 4 096 8 192 16 384 32 768 and 65 536 bytes to the Network Stack Memory Pool This translates to an additional 1 21 MB of system memory being allocated to the Network Stack Memory Pool Depending on the availability of free memory resources the number of clusters added can be adjusted A new VxWorks target image has to be built for these changes to take effect Procedure for VxWorks 5 5 if building target images using the command line If you are using the command line to build your VxWorks target images the relevant file to edit will be tornado target src config usrNetwork c not usrNetLib c The basic procedure and changes though are roughly the same as
3. RLMT modes CLP and CLPSS are designed to operate in configurations where a network path between the channels on one adapter exists Moreover they are not designed to work where adapters are connected back to back IntsPerSec This parameter is only used if either static or dynamic interrupt 30 40 000 moderation is used on a network adapter Using this parameter if interrupts per no moderation is applied will lead to no action performed second This parameter determines the length of any interrupt moderation interval Assuming that static interrupt moderation is to be used an IntsPerSec parameter value of 2 000 will lead to an interrupt moderation interval of 500 microseconds Note The duration of the moderation interval is to be chosen with care At first glance selecting a very long duration e g only 100 interrupts per second seems to be meaningful butthe increase of packet processing delay is tremendous On the other hand selecting a very short moderation time might compensate the use of any moderation being applied CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO2 WPD Page 7 of 12 Parameter Description Permitted Default Value Values Moderation Interrupt moderation is employed to limit the maximum number of None Dynamic interrupts the driver has to serve That is one or more interrupts Static which indicate any transmit or receive packet to be processed are Dynamic queued until the driver proc
4. 0c eects 5 5 3 Loading and Starting the Driver in RLMT Mode 000 cece eet n 5 5 4 Command Line Parameter S es siei aa ea ta a aee aa a a hh 5 6 Contact DelallS s s eret err 542 ESTEE SEAGER Ahh Eee dpa hs p OSES 10 6 1 Contact Persom sender ets aenea Rane ean Asai hated aaah ath Ape diane E a E ect AEEA 10 6 2 Physical Address is utes oto poit edi er te dea AE N tica GaSe bonita nadia doe 10 6 3 Postal Address 3 2 aaa A devel ad E cant thi E E Yee pet ee EEEE E dt EE an thane veer a E 10 6 4 Voice and Electronic Contacts 0 0c ccc hrs 10 6 5 Product SUpport TEL Em 10 Annexure A e T 11 Making Changes to sysNet c for X86 1 20 ttt teens 11 AhHBXUID et 52 Ahab bibentes eA Oe Ae Oe Oe Le ORO EE eee ees 12 Making Changes to usrNetLib c for Large UDP Packets 0 0 ccc ene nee eas 12 CCII GE 6 MAN 002 2009 08 20 Issue 1 1 Abbreviations and Acronyms API Application Program Interface BIT Built In Test bit s bits per second BSP Board Support Package CCPMC Conduction Cooled Peripheral Component Interconnect Mezzanine Card CD Carrier Detect CRC Cyclic Redundancy Check EEPROM Electrically Erasable and Programmable Read Only Memory FIFO First In First Out GE Gigabit Ethernet y o Input Output LED Light Emitting Diode MHz MegaHertz PC Personal Computer PCI Peripheral Component Interconnect PMC Peripheral Component Interconnect Mezzanine Card POST Power On Self Test R
5. CT Systems CCII Systems Pty Ltd Registration No 1990 005058 07 Communications Computer Intelligence Integration g User Manual for the Gigabit Ethernet Adapter VxWorks Software Driver Cl Systems Document No CCII GE 6 MAN 002 Issue Date 2009 08 20 Print Date 2009 08 20 File Name W GE TECH MAN CGEMANO2 WPD C4 Systems The copyright of this document is the property of C2l Systems The document is issued for the sole purpose for which it is supplied on the express terms that it may not be copied in whole or part used by or disclosed to others except as authorised in writing by C I Systems Document prepared by C2l Systems Cape Town Signature Sheet ENL NN NNNM Completed by e X Cei Accepted by Project Manager Board Level Products C l Systems Accepted by K Ceuge 2009 08 20 21 Systems 2009 08 20 Issue 1 1 Page ii of v CCII GE 6 MAN 002 CGEMANO2 WPD Signature Sheet Completed by Project Engineer Board Level Products C l Systems Accepted by Project Manager Board Level Products C212 Systems Quality Assurance C l Systems CCII GE 6 MAN 002 2009 08 20 Issue 1 1 Amendment History Description Date ECP No oA First arat 2007 0228 0 2 Added command line parameter descriptions 2007 06 07 LE Procedure added describing the addition of larger Network 2007
6. 10 18 CCII GE 6 ECP 008 Stack Memory Pool data clusters 1 1 Improve document naming consistency 2009 08 20 CCII GE 6 ECP 017 eo CCII GE 6 MAN 002 2009 08 20 Issue 1 1 Contents T CODE Ar 1 1 1 IdentifiCatlon 2 usa ae Dare m 1 1 2 EU CIBO Th MR cx 1 1 3 Document Overview lllsllseeeeseelle ehh she 1 2 Applicable and Reference Documents 00000 ee 2 2 1 Applicable Documents ae a a a Oa eee hn 2 2 2 Reference Documents 0 00 cece ehh hr 2 3 Software Driver Distribution coz eter ten bt Rx on V ERN ER MERE Y ws 3 4 Installation PFOCeOUFe S aenbihenebereee6RORORDReRRRESOReRPORORDPEEBERE DEI S 4 4 1 Large UDP Packet Support isuisusseeslselsleeel eher 4 4 1 1 Procedure for VxWorks 5 5 if building target images using Tornado 04 4 4 1 2 Procedure for VxWorks 5 5 if building target images using the command line 4 4 1 3 Procedure for VxWorks 6 x if building target images using the Workbench IDE 4 4 2 To Build the Gigabit Ethernet VxWorks Software Driver into the VxWorks Kernel 2 5 4 4 3 To Load the Software Driver Separately 00 cece cette eee 4 5 Pub the Gigabit Ethernet Software Driver 0 0 0 0 cece eens 5 DualNet and RLMT Modes saska eE EEEE ee tenet hh 5 Loading and Starting the Driver in DualNet Mode 0
7. 24 NULL 0 2048 NUM 2048 NULL 0 C I Systems 4096 NUM 4096 NULL 0 C I Systems 8192 NUM 8192 NULL 0 C I Systems 16384 NUM_16384 NULL 0 C I Systems 32768 NUM 32768 NULL 0 C I Systems 65536 NUM 65536 NULL 0 CCII GE 6 MAN 002 2009 08 20 CGEMANO2 WPD Page 12 of 12 Issue 1 1
8. AM Random Access Memory SBC Single Board Computer CCII GE 6 MAN 002 2009 08 20 Issue 1 1 Scope Identification This document is the user manual for the Gigabit Ethernet VxWorks Software Driver System Overview The Gigabit Ethernet Adapter attach computers to 10 Mbit s 100 Mbit s and 1 Gbit s Ethernet networks using Copper or Fibre cabling The GE Adapter is currently available in Air Cooled PMC Conduction Cooled PMC CCPMC and PCI 104 formfactors Applicable Part Numbers are PMC CCII GNET PMC 2P RJ FP COM CCII GNET PMC 2P RJ FP IND CCII GNET PMC 2P SX FP COM CCII GNET PMC 2P SX FP IND CCII GNET PMC 2P LX FP COM CCII GNET PMC 2P LX FP IND CCPMC CCII GNET PMC 2P BP CC PCI 104 CCII GNET PC104 2P RJ COM CCII GNET PC104 2P RJ IND CCII GNET PC104 2P SX COM CCII GNET PC104 2P SX IND CCII GNET PC104 2P LX COM CCII GNET PC104 2P LX IND UTP Commercial Grade Adapter UTP Industrial Grade Adapter Multimode Fibre Commercial Grade Adapter Multimode Fibre Industrial Grade Adapter Singlemode Fibre Commercial Grade Adapter Singlemode Fibre Industrial Grade Adapter UTP Backplane I O Conduction Cooled Adapter UTP Commercial Grade Adapter UTP Industrial Grade Adapter Multimode Fibre Commercial Grade Adapter Multimode Fibre Industrial Grade Adapter Singlemode Fibre Commercial Grade Adapter Singlemode Fibre Industrial Grade Adapter The software driver binaries are provided with explicit installation instru
9. Contact Person Direct all correspondence and or support queries to the Project Manager Board Level Products at C2l Systems 6 2 Physical Address C212 Systems Unit 3 Rosmead Place Rosmead Centre 67 Rosmead Avenue Kenilworth Cape Town 7708 South Africa 6 3 Postal Address Cl Systems P O Box 171 Rondebosch 7701 South Africa 6 4 Voice and Electronic Contacts Tel 27 0 21 683 5490 Fax 27 0 21 683 5435 Email info ccii ccii co za Email support 2ccii co za URL http www ccii co za 6 5 Product Support Support on C I Systems products is available telephonically between Monday and Friday from 09 00 to 17 00 CAT Central African Time CAT GMT 2 Email support is available at support 2ccii co za CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 10 of 12 Annexure A Making Changes to sysNet c for X86 On X86 platforms the following amendment must be made to the BSP Copy the file sysCcGeEnd c to your BSP configuration directory target config BSPName Make the following two amendments to the file sysNet c in the same directory Amendment 1 ifdef INCLUDE END include sysDec21x40End c dec21x40End support routines include sysEl3c90xEnd c el3c90xEnd support routines include sysE1t3c509End c elt3c509End support routines include sysFei82557End c fei82557End su
10. UDP Packets OVS Added these lines to add larger Network Data Pool clusters to the VxWorks image C I Systems To restore file to original config simply delete all lines marked C I Systems C I Systems undef NUM CL BLKS C I Systems define NUM CL BLKS NUM 64 NUM 128 NUM 256 NUM 512 NUM 1024 NUM 2048 NUM 4096 NUM 8192 NUM 16384 NUM 32768 NUM 65536 C I Systems undef NUM 64 C I Systems define NUM 64 100 C I Systems undef NUM 128 C I Systems define NUM 128 100 C I Systems undef NUM 256 C I Systems define NUM 256 40 C I Systems undef NUM 512 C I Systems define NUM 512 40 C I Systems undef NUM 1024 C I Systems define NUM 1024 25 C I Systems undef NUM 2048 C I Systems define NUM 2048 25 C I Systems define NUM 4096 10 C I Systems define NUM 8192 10 C I Systems define NUM 16384 10 C I Systems define NUM 32768 10 C I Systems define NUM 65536 10 C I Systems undef NUM NET MBLKS C I Systems define NUM NET MBLKS 2 NUM CL BLKS CL DESC clDescTbl clusterSize num memArea memSize AA 64 NUM 64 NULL 0 128 NUM 128 NULL 0 256 NUM_256 NULL 0 15127 NUM 512 NULL 0 1024 NUM 10
11. ctions Document Overview This document gives an overview of the Gigabit Ethernet VxWorks Software Driver installation procedure and its Application Program Interface API CCII GE 6 MAN 002 2009 08 20 CGEMANO2 WPD Page 1 of 12 Issue 1 1 2 Applicable and Reference Documents 2 1 Applicable Documents 2 1 1 CCII GE 6 MAN 001 Hardware Reference Manual for the Gigabit Ethernet Adapter 2 2 Reference Documents None CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO2 WPD Page 2 of 12 3 Software Driver Distribution The software driver distribution consists of at least the following files ccGeEnd lt arch gt lt vxworks_version gt a Host architecture specific driver object file cc CCII Systems Pty Ltd GeEnd Enhanced Network Device END VxWorks software driver arch Host for which the binary is built e X86 e 18x Dy4 181 182 183 e Mv5100 Motorola MVME 5100 vxworks version VxWorks version e 62 VxWorks 6 2 e blank VxWorks 5 5 1 e g ccGeEnd18x 62 a for Gigabit Ethernet VxWorks Software Driver built for a DY4 SVME DMV 181 PowerPC host for VxWorks 6 2 Readme txt General information and installation notes Release txt Release notes and revision history Please check this file for information on the latest updates sysCcGeEnd c PCI initialisation for X86 BSPs See Annexure A CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 3 of 12 4 1
12. eed is negotiated between the two channels during link establishment If this fails a channel can be forced to a specific setting with this parameter AutoNeg A The Sense mode automatically detects whether the link partner AutoNeg B supports auto negotiation or not DupCap A This parameters is only relevant if auto negotiation for this channel DupCap B is not set to Sense If auto negotiation is set to On all three values are possible If it is set to Off only Full and Half are allowed This parameter is useful if your link partner does not support all possible combinations CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 5 of 12 Parameter Description Permitted Default Value Values FlowCtrl_A This parameter can be used to set the flow control capabilities the Sym SymOrRem FlowCtrl_B channel reports during auto negotiation It can be set for each SymOrRem channel individually LocSend None Sym Symmetric both link partners are allowed to send PAUSE frames SymOrRem SymmetricOrRemote both or only remote partner are allowed to send PAUSE frames LocSend LocalSend only local link partner is allowed to send PAUSE frames None Mo link partner is allowed to send PAUSE frames This parameter is only valid for the copper adapters For two Auto 1 000 Base T adapters to communicate one must take the role of the master providing timing information while the other must be the slave Usua
13. esses them When queued interrupts are to be served is determined by the IntsPerSec parameter which is explained later below None Nointerrupt moderation is applied on the adapter Therefore each transmit or receive interrupt is served immediately as soon as it appears on the interrupt line of the adapter Static Interrupt moderation is applied on the adapter All transmit and receive interrupts are queued until a complete moderation interval ends If such a moderation interval ends all queued interrupts are processed in one big bunch without any delay The term static reflects the fact that interrupt moderation is always enabled regardless how much network load is currently passing via a particular interface In addition the duration of the moderation interval has a fixed length that never changes while the driver is operational Dynamic Interrupt moderation might be applied on the adapter depending on the load of the system If the driver detects that the system load is too high the driver tries to shield the system against too much network load by enabling interrupt moderation If at a later time the CPU utilisation decreases again or if the network load is negligible the interrupt moderation will automatically be disabled Interrupt moderation should be used when the driver has to handle one or more interfaces with a high network load which as a consequence leads also to a high CPU utilisation When
14. lly this is negotiated between the two adapters during link establishment If this fails an adapter can be forced to a specific setting with this parameter ConType The parameter ConType is a combination of all five per channel Auto parameters within one single parameter This simplifies the configuration of both channels of an adapter The different values of this variable reflect the most meaningful combinations of channel parameters The following table shows the values of ConType and the corresponding combinations of the per channel parameters ConType DupCap AutoNeg FlowCtrl Role Speed Auto Both On SymOrRem Auto Auto 1000FD Full Off None Auto ignored 1000 100FD Full Off None Auto ignored 100 100HD Half Off None Auto ignored 100 10FD Full Off None Auto ignored 10 10HD Half Off None Auto ignored 10 Stating any other channel parameter together with this ConType variable will result in a merged configuration of those settings This due to the fact that the per channel parameters e g Speed have a higher priority than the combined variable ConType Note This parameter is always used on both channels of the adapter PrefPort This is used to force the preferred channel to A or B on dual channel network adapters The preferred channel is the one that is used if both are detected as fully functional CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 6 of 12 Parameter Description Permi
15. moderation is applied in such high network load situations CPU load might be reduced by 20 30 Note The drawback of using interrupt moderation is an increase of the round trip time RTT due to the queueing and serving of interrupts at dedicated moderation times LowLatency This is used to reduce the packet latency time of the adapter Setting the LowLatency parameter to On forces the adapter to pass any received packet immediately to upper network layers and to send out any transmit packet as fast as possible Note 1 The system load increases if LowLatency is set to On and a lot of data packets are transmitted and received Note2 This parameter is only used on adapters which are based on PCI Express compatible chipsets BroadcastPrio This parameter specifies whether received broadcast packets have the highest priority for the channel switch decision Off or not On Pampa murem eres fe wee mures ny seems murem emos CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 8 of 12 Parameter Description Permitted Default Value Values RimtSegToVal RLMT Network Segmentation Reporting Interval in us i see el 900 000 000 Note If DualNet mode is used the parameters for both channels must be provided in the first call to muxDevLoad Parameters provided in the second call will be ignored CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 9 of 12 6 Contact Details 6 1
16. pport routines include sysGei82543End c gei82543End support routines include sysLn97xEnd c ln97xEnd support routines A include sysNe2000End c ne2000End support routines J include sysUltraEnd c ultraEnd support routines include sysCcGeEnd c CCII GE END driver support routines endif INCLUDE END Amendment 2 LOCAL VEND ID DESC vendorIdEnet if defined INCLUDE DEC21X40 END DEC PCI VENDOR ID sysDec21x40PciInit endif INCLUDE DEC21X40 END I O if defined INCL AMD PCI VENDOR endif INCLUD DE LN 97X END sysLan97xPciInit NN 97X END 1 E c J if defined INCLUDE EL 3C90X END U ECOM PCI VENDOR ID sys THRE El3c90xPcilnit endif INCLUDE EL 3C90X END if defined INCLUDE GEI8254X END defined INCLUDE GEI HEND INTEL PCI VENDOR ID sys543PcilInit endif INCLUDE GEI8254X END if defined INCLUDE_FEI_END INTEL PCI VENDOR ID sys557Pcilnit endif INCLUDE FEI END 0x1148 sysCcGePciInit Oxffffffff NULL last entry Now remake your VxWorks image CCII GE 6 MAN 002 2009 08 20 Issue 1 1 CGEMANO02 WPD Page 11 of 12 Annexure B Making Changes to usrNetLib c for Large
17. those indicated in Annexure B A new VxWorks target image has to be built for these changes to take effect Procedure for VxWorks 6 x if building target images using the Workbench IDE The Network Stack Memory Configuration can be reconfigured in the Workbench IDE for your VxWorks 6 x target images Under the Project Navigator tab double click on Kernel Configuration for the current VXWorks image project In the Component configuration window expand and select the Network Components gt Network Core Components Network Stack Memory Pool Configuration branch and change the relevant Property Values to include additional larger than 2 048 bytes clusters A new VxWorks target image has to be built for these changes to take effect To Build the Gigabit Ethernet VxWorks Software Driver into the VxWorks Kernel Assume the BSP directory is given as BSP DIR tornado target config dy4181 e Copy ccGeEnd18x a to your BSP_DIR lib directory as ccGeEnd a e Inthe Builds section of the Project Workspace change the Kernel properties to include the ccGeEnd a library file in the Macros LIBs option e Rebuild all VxWorks images To Load the 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 ccGeEnd18x a to your present working directory as ccGeEnd a e From the VxWorks shell type d ccGeEnd a
18. tted Default Value Values RimtMode RLMT monitors the status of the channel If the link of the active CheckLinkState DualNet channel fails RLMT switches immediately to the standby link The CheckLocalPort virtual link is maintained as long as at least one physical linkis up CheckSeg DualNet CheckLinkState Checklink state only RLMT uses the link state reported by the adapter hardware for each individual channel to determine whether a channel can be used for all network traffic or not CheckLocalPort Inthis mode RLMT monitors the network path between the two channels of an adapter by regularly exchanging packets between them This mode requires a network configuration in which the two channels are able to see each other i e there must not be any router between the channels CheckSeg Check local channel and segmentation This mode supports the same functions as the CheckLocalPort mode and additionally checks network segmentation between the channels Therefore this mode is only to be used if Gigabit Ethernet switches are installed on the network that have been configured to use the Spanning Tree protocol DualNet In this mode channels A and B are used as separate devices If you have a dual channel adapter channel A will be configured as ethO and channel B as eth Both channels can be used independently with distinct IP addresses The preferred channel setting is not used RLMT is turned off Note
Download Pdf Manuals
Related Search