Advanced LAN Bypass Manuel utilisateur

User Manual

Advantech

Advanced LAN Bypass

Advanced LAN Bypass User Manual ii

The documentation and the software included with this product are copyrighted 2018

by Advantech Co., Ltd. All rights are reserved. Advantech Co., Ltd. reserves the right

to make improvements in the products described in this manual at any time without

notice. No part of this manual may be reproduced, copied, translated or transmitted

in any form or by any means without the prior written permission of Advantech Co.,

Ltd. Information provided in this manual is intended to be accurate and reliable. How-

ever, Advantech Co., Ltd. assumes no responsibility for its use, nor for any infringe-

ments of the rights of third parties, which may result from its use.

Product Warranty (2 years)

Advantech warrants to you, the original purchaser, that each of its products will be

free from defects in materials and workmanship for two years from the date of pur-

chase.

This warranty does not apply to any products which have been repaired or altered by

persons other than repair personnel authorized by Advantech, or which have been

subject to misuse, abuse, accident or improper installation. Advantech assumes no

liability under the terms of this warranty as a consequence of such events.

Because of Advantech’s high quality-control standards and rigorous testing, most of

our customers never need to use our repair service. If an Advantech product is defec-

tive, it will be repaired or replaced at no charge during the warranty period. For out-

of-warranty repairs, you will be billed according to the cost of replacement materials,

service time and freight. Please consult your dealer for more details.

If you think you have a defective product, follow these steps:

1. Collect all the information about the problem encountered. (For example, CPU

speed, Advantech products used, other hardware and software used, etc.) Note

anything abnormal and list any onscreen messages you get when the problem

occurs.

2. Call your dealer and describe the problem. Please have your manual, product,

and any helpful information readily available.

3. If your product is diagnosed as defective, obtain an RMA (return merchandize

authorization) number from your dealer. This allows us to process your return

more quickly.

4. Carefully pack the defective product, a fully-completed Repair and Replacement

Order Card and a photocopy proof of purchase date (such as your sales receipt)

in a shippable container. A product returned without proof of the purchase date

is not eligible for warranty service.

5. Write the RMA number visibly on the outside of the package and ship it prepaid

to your dealer.

Part No. 2002ALBP00 Edition 1

Printed in Taiwan September 2018

iii Advanced LAN Bypass User Manual

Declaration of Conformity

The Advantech Node Explorer has been successfully tested for compliance to the

regulations below. Should you need a signed copy of the declaration of conformity or

the related test reports, please contact your Advantech representative.

This product has passed the CE test for environmental specifications when shielded

cables are used for external wiring.

FCC Class A

Note: This equipment has been tested and found to comply with the limits for a Class

A digital device, pursuant to part 15 of the FCC Rules. These limits are designed to

provide reasonable protection against harmful interference when the equipment is

operated in a commercial environment. This equipment generates, uses, and can

radiate radio frequency energy and, if not installed and used in accordance with the

instruction manual, may cause harmful interference to radio communications. Opera-

tion of this equipment in a residential area is likely to cause harmful interference in

which case the user will be required to correct the interference at his or her own

expense.

Warnings, Cautions and Notes

We Appreciate Your Input

Please let us know of any aspect of this product, including the manual, which could

benefit from improvements or corrections. We appreciate your valuable input in help-

ing make our products better.

Please send all such - in writing to: ncg@advantech.com

Warning! Warnings indicate conditions, which if not observed, can cause personal

injury!

Caution! Cautions are included to help you avoid damaging hardware or losing

data. e.g.

There is a danger of a new battery exploding if it is incorrectly installed.

Do not attempt to recharge, force open, or heat the battery. Replace the

battery only with the same or equivalent type recommended by the man-

ufacturer. Discard used batteries according to the manufacturer's

instructions.

Note! Notes provide optional additional information.

Advanced LAN Bypass User Manual iv

v Advanced LAN Bypass User Manual

Contents

Chapter 1 ADVANCED LAN BYPASS..................1

1.1 Scope........................................................................................................2

Table 1.1: Scope .........................................................................2

1.2 Terminology ..............................................................................................2

Table 1.2: Terminology................................................................2

1.3 Advanced LAN Bypass Hardware Architecture Overview.........................3

Figure 1.1 LAN Bypass Hardware Overview...............................3

Chapter 2 OVERVIEW ...........................................5

2.1 Host Interface............................................................................................6

2.2 Segment Control.......................................................................................6

2.3 Event and Action.......................................................................................6

Figure 2.1 Bypass Actions and Related Port Connectivity ..........7

Table 2.1: Mapping between Events and Actions (Example 1)...7

Table 2.2: Mapping between Events and Actions (Example 2)...8

Table 2.3: Mapping between Events and Actions (Example 3)...8

Table 2.4: Mapping between Events and Actions (Example 4)...9

2.4 Manual Bypass Control.............................................................................9

2.5 Watchdog Timer........................................................................................9

2.5.1 Standard Watchdog Mechanism...................................................9

2.5.2 Toggle Pin Mechanism ...............................................................10

2.5.3 Global Watchdog Trigger Mechanism.........................................11

2.6 Bypass Master/Slave Mode with Button and LED Control......................12

2.6.1 Master Segment..........................................................................12

2.6.2 Master/Slave Mode LED.............................................................12

2.6.3 Master/Slave Mode Button..........................................................12

2.7 LED Indication.........................................................................................13

Table 2.5: Activity LED Behavior...............................................13

Table 2.6: Link Speed LED Behavior .......................................13

2.7.1 Adjustable Blinking Frequency for Bypass/Disconnect States....13

Figure 2.2 Adjustable Blinking Frequency.................................14

2.8 Error Codes.............................................................................................14

Table 2.7: Error Code................................................................14

Chapter 3 LIBLBPCU -ADVANCED LAN BYPASS

LIBRARY.............................................17

3.1 Supported Distributions...........................................................................18

3.2 The lbpcu.cfg File....................................................................................18

Figure 3.1 Sample lbpcu.cfg for Two Segments........................19

3.3 Segment Control for PCIe-based Devices ..............................................19

3.4 Header File..............................................................................................20

3.5 API Command List ..................................................................................22

Table 3.1: Supported API Functions..........................................22

3.6 How to Use the API.................................................................................23

3.7 API Functions..........................................................................................23

3.7.1 LBPCU Open/Close....................................................................23

Table 3.2: API Function "lbp_check_conf_file" Error Codes .....23

Table 3.3: API Function "lbp_open" Error Codes ......................24

Table 3.4: API Function "lbp_close" Error Codes......................24

3.7.2 LBP Information..........................................................................24

Advanced LAN Bypass User Manual vi

Table 3.5: API Function "lbp_get_version" Error Codes ........... 24

Table 3.6: API Function "lbp_get_num_segments" Error Codes ..

Table 3.7: API Function "lbp_get_fw_version" Error Codes...... 25

Table 3.8: API Function "lbp_get_protocol_version" Error Codes.

Table 3.9: API Function "lbp_get_bl_fw_version" Error Codes. 25

3.7.3 LBP Event/Action........................................................................ 26

Table 3.10:API Function "lbp_get_action" Error Codes ............. 26

Table 3.11:API Function "lbp_set_action" Error Codes.............. 27

Table 3.12:API Function "get_last_event_action" Error Codes.. 27

Table 3.13:API Function "lbp_set_current_action" Error Codes 27

3.7.4 LBP Watchdog............................................................................ 28

Table 3.14:API Function "lbp_set_wdt_counter" Error Codes.... 28

Table 3.15:API Function "lbp_get_wdt_status" Error Codes...... 28

Table 3.16:API Function "lbp_reset_start_wdt" Error Codes ..... 28

Table 3.17:API Function "lbp_stop_wdt" Error Codes................ 29

Table 3.18:API Function "lbp_set_ext_wdt" Error Codes........... 29

Table 3.19:Parameter ext_wdt_mode........................................ 29

3.7.5 LBP Toggle................................................................................. 30

Table 3.20:API function "lbp_set_toggle_pin_mode" Error Codes.

Table 3.21:Parameter toggle_mode Error Codes ...................... 30

Table 3.22:API function "lbp_start_wdt_by_toggle" Error Codes31

Table 3.23:API function "lbp_nic_wdt_toggle"............................ 31

3.7.6 LBP FW Upgrade........................................................................ 31

Table 3.24:API function "lbp_check_upgrade_image" Error Codes

Table 3.25:API function "lbp_get_fw_mode" Error Codes.......... 31

Table 3.26:API Function "lbp_upgrade_fw" Error Codes ........... 32

3.7.7 LBP Reset Monitoring................................................................. 32

Table 3.27:API Function "lbp_start_reset_monitoring" Error Codes

Table 3.28:API Function "lbp_get_reset_monitoring_state" Error

Codes....................................................................... 33

Table 3.29:Parameter rm_mode ................................................ 34

Table 3.30:API Function "lbp_set_rmt_counter" Error Codes.... 34

Table 3.31:API Function "lbp_get_rmt_status" Error Codes ...... 35

3.7.8 LBP Message Output Level........................................................ 35

Table 3.32:API Function "lbp_set_message_level" Error Codes35

3.7.9 LBP Bypass Control Type........................................................... 35

Table 3.33:API Function "lbp_set_bypass_ctrl_type" Error Codes

Table 3.34:API Function "lbp_get_bypass_ctrl_type" Error Codes

3.7.10 LBP Bypass LED........................................................................ 36

Table 3.35:Parameter Duty........................................................ 36

Table 3.36:Parameter Period..................................................... 36

Table 3.37:API Function "lbp_set_bypass_led" Error Codes..... 36

Table 3.38:API Function "lbp_get_bypass_led" Error Codes..... 37

Table 3.39:Parameter Duty........................................................ 37

Table 3.40:Parameter Period..................................................... 37

Table 3.41:API Function "lbp_set_disconnect_led" Error Codes37

Table 3.42:API Function "lbp_get_disconnect_led" Error Codes38

3.7.11 Master/Slave Mode..................................................................... 38

Table 3.43:Parameter master_slave_config............................... 38

Table 3.44: API Function "lbp_set_master_slave_mode" Error

Codes....................................................................... 38

Table 3.45: API Function "lbp_get_master_slave_mode" Error

Codes....................................................................... 39

vii Advanced LAN Bypass User Manual

Table 3.46: Parameter Duty .......................................................39

Table 3.47: Parameter Duty .......................................................39

Table 3.48: Parameter Period ....................................................39

Table 3.49: API Function "lbp_set_master_led" Error Codes.....39

Table 3.50: API Function "lbp_get_master_led" Error Codes ....40

3.7.12 Scan event thread init/detach .....................................................40

Chapter 4 LBPCU ................................................41

4.1 ./lbpcu......................................................................................................43

Figure 4.1 Usage of the "lbpcu" Command ...............................43

4.2 ./lbpcu -V.................................................................................................44

Figure 4.2 Usage of the "lbpcu -V" Command...........................44

4.3 ./lbpcu -VF...............................................................................................44

Figure 4.3 Usage of the "lbpcu -VF" Command.........................44

Figure 4.4 Retrieve the MCU FW Version for Segment 1..........44

4.4 ./lbpcu -VP...............................................................................................44

Figure 4.5 Usage of the "lbpcu -VP" Command ........................44

Figure 4.6 Retrieve the Protocol Versions on Segment 1..........44

4.5 ./lbpcu -n .................................................................................................45

Figure 4.7 Usage of the "lbpcu -n" Command ...........................45

4.6 ./lbpcu -GA..............................................................................................45

Figure 4.8 Usage of the "lbpcu -GA" Command........................45

Figure 4.9 Return the Current Action for the POWER_OFF Event

on Segment 1...........................................................45

4.7 ./lbpcu -SA...............................................................................................46

Figure 4.10Usage of the "lbpcu -SA" Command ........................46

Figure 4.11Set BYPASS Action for the POWER_OFF Event on

Segment 1................................................................46

4.8 ./lbpcu -SW..............................................................................................47

Figure 4.12Usage of the "lbpcu -SW" Command .......................47

Figure 4.13Set the WDT Timeout to 100 s on Segment 1..........47

4.9 ./lbpcu -GW .............................................................................................47

Figure 4.14Usage of the "lbpcu -GW" Command.......................47

Figure 4.15Get the WDT Status on Segment 1..........................48

4.10 ./lbpcu -RW .............................................................................................48

Figure 4.16Usage of the "lbpcu -RW" Command .......................48

Figure 4.17Start WDT on Segment 1 .........................................48

4.11 ./lbpcu -StopW.........................................................................................49

Figure 4.18Stop the WDT on Segment 1....................................49

4.12 ./lbpcu -ST...............................................................................................49

Figure 4.19Usage of the "lbpcu -ST" Command.........................49

Figure 4.20Set Toggle Pin Mode on Segment 1.........................49

4.13 ./lbpcu -SEW...........................................................................................50

Figure 4.21Usage of the "lbpcu -SEW" Command.....................50

Figure 4.22Enable External WDT on Segment 1........................50

4.14 ./lbpcu -WT..............................................................................................51

Figure 4.23Strobe the WDT through the Toggle Pin Interface on

Segment 1................................................................51

4.15 ./lbpcu -GLEA..........................................................................................51

Figure 4.24Usage of the "lbpcu -GLEA" Command....................51

Figure 4.25Get the Last Event and Last Action on Segment 1...51

4.16 ./lbpcu -SCA............................................................................................52

Figure 4.26Usage of the "lbpcu -SCA" Command......................52

Figure 4.27Set a Manual BYPASS Action on Segment 1...........52

4.17 ./lbpcu -CUI.............................................................................................52

Figure 4.28Usage of the "lbpcu -CUI" Command.......................52

Figure 4.29Check Upgraded FW Image File..............................52

4.18 ./lbpcu -GFM ...........................................................................................53

Advanced LAN Bypass User Manual viii

Figure 4.30Usage of the "lbpcu -GFM" Command..................... 53

Figure 4.31MCU FW is in Application Mode............................... 53

Figure 4.32MCU FW is in Upgrade Mode .................................. 53

Figure 4.33MCU FW Upgrade Process Commenced ................ 53

4.19 ./lbpcu -UG.............................................................................................. 53

Figure 4.34Usage of the "lbpcu -UG" Command........................ 53

Figure 4.35Upgrade the MCU FW on Segment 1 ...................... 54

4.20 ./lbpcu -SRM ........................................................................................... 54

Figure 4.36Start Monitoring Reset Signal on Segment 1 ........... 54

4.21 ./lbpcu -GRMS ........................................................................................ 54

Figure 4.37Get Reset the Monitoring State on Segment 1......... 54

4.22 ./lbpcu -SRMT......................................................................................... 55

Figure 4.38Set the Countdown Value of Reset Monitoring on Seg-

ment 1 ...................................................................... 55

4.23 ./lbpcu -GRMT......................................................................................... 55

Figure 4.39Get Related Countdown Values on Segment 1........ 55

4.24 ./lbpcu -SWT ........................................................................................... 56

Figure 4.40Send the WDT Start Sequence on Segment 1......... 56

4.25 ./lbpcu -ML .............................................................................................. 56

Figure 4.41Set the Debug Message Output Level ..................... 58

4.26 ./lbpcu -SBCT.......................................................................................... 58

Figure 4.42Set the Bypass Control Type on Segment 1............ 58

4.27 ./lbpcu -GBCT......................................................................................... 59

Figure 4.43Get the Bypass Control Type on Segment 1............ 59

4.28 ./lbpcu -SBL ............................................................................................ 59

Figure 4.44Set the LED ON/OFF Settings for a BYPASS Action on

Segment 1................................................................ 59

4.29 ./lbpcu -GBL............................................................................................ 60

Figure 4.45Get the LED ON/OFF Settings for a BYPASS Action on

Segment 1................................................................ 60

4.30 ./lbpcu -SDL ............................................................................................ 60

Figure 4.46Set the LED ON/OFF Settings for a DISCONNECT Ac-

tion on Segment 1.................................................... 60

4.31 ./lbpcu -GDL............................................................................................ 61

Figure 4.47GetLEDON/OFFSettingsforDISCONNECTActionon

Segment 1................................................................ 61

4.32 ./lbpcu -SMSM ........................................................................................ 61

Figure 4.48EnableMaster/SlaveMode,SetasMaster,andDisable

the Toggle Pin on Segment 1................................... 61

4.33 /lbpcu -GMSM......................................................................................... 62

Figure 4.49Get Master/Slave Mode, Set as Master, and Disable

the Toggle Pin on Segment 1................................... 62

4.34 /lbpcu -SML............................................................................................. 62

Figure 4.50Set the Master/Slave Mode LED Behavior, XXX on

Segment 1................................................................ 62

4.35 /lbpcu -GML ............................................................................................ 63

Figure 4.51Get the Master/Slave Mode LED Behavior for a BY-

PASS Action on Segment 1 ..................................... 63

4.36 ./lbpcu -RAW........................................................................................... 63

Figure 4.52Usage of the "lbpcu -RAW" Command..................... 63

Figure 4.53Start WDT on All Segments ..................................... 63

4.37 ./lbpcu -StopAW...................................................................................... 64

Figure 4.54Stop WDT on All Segments...................................... 64

4.38 ./lbpcu -SAWT......................................................................................... 64

Figure 4.55Send the WDT Start Sequence on All Segments..... 64

4.39 ./lbpcu -WAT ........................................................................................... 65

Figure 4.56Strobethe WDT through the Toggle Pin Interface on All

Segments................................................................. 65

4.40 ./lbpcu -SACA ......................................................................................... 65

Figure 4.57Usage of the "lbpcu -SACA" Command ................... 65

ix Advanced LAN Bypass User Manual

Figure 4.58Set the Manual BYPASS Action on All Segments....65

4.41 ./lbpcu -CBTEST.....................................................................................66

Figure 4.59Enable the Event Change Detect Thread.................66

4.42 ./lbpcu -i...................................................................................................67

Figure 4.60Get all Info of a Segment..........................................68

Appendix A OS limitation ......................................69

A.1 OS limitation............................................................................................70

A.1.1 Segmentation Fault with Two Linux Distributions .......................70

Table A.1: Linux Distribution Compatibility ...............................70

Advanced LAN Bypass User Manual x

Table des matières

Autres manuels Advanced Unité de contrôle

Advanced

Advanced Axis AX-ASW-16 Manuel utilisateur

Advanced

Advanced Axis AX-PSU-6 Manuel utilisateur

Advanced

Advanced Axis AX Series Manuel utilisateur

Advanced

Advanced Axis AX-CTY Manuel utilisateur

Manuels Unité de contrôle populaires d'autres marques

Festo

Festo Compact Performance CP-FB6-E Manuel de la liste des pièces

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Manuel utilisateur

JS Automation

JS Automation MPC3034A Manuel utilisateur

JAUDT

JAUDT SW GII 6406 Series Guide rapide

Spektrum

Spektrum Air Module System Manuel utilisateur

BOC Edwards

BOC Edwards Q Series Manuel utilisateur

KHADAS

KHADAS BT Magic Manuel utilisateur

Etherma

Etherma eNEXHO-IL Manuel utilisateur

PMFoundations

PMFoundations Attenuverter Manuel utilisateur

GEA

GEA VARIVENT Manuel utilisateur

Walther Systemtechnik

Walther Systemtechnik VMS-05 Manuel utilisateur

Altronix

Altronix LINQ8PD Instructions de montage

Eaton

Eaton Powerware Series Manuel utilisateur

WAGO

WAGO 750-407/040-000 Manuel utilisateur

Sony

Sony CCU-590 Manuel utilisateur

Graco

Graco 25D614 Manuel utilisateur

Task Force Tips

Task Force Tips YE-RF-900 Manuel de programmation

Shini

Shini SPV-U Series Manuel utilisateur