ADLINK Technology PCIe-GIE7 Series Reference Manual Download

Page: 1 / 51

Leading

EDGE COMPUTING

PCIe-GIE7x Series

Function Library Reference

Manual Rev.:

1.0

Revision Date:

July 14, 2017

Part No:

50-11178-2000

Summary of Contents for PCIe-GIE7 Series

Page 1: ...Leading EDGE COMPUTING PCIe GIE7x Series Function Library Reference Manual Rev 1 0 Revision Date July 14 2017 Part No 50 11178 2000 ...

Page 2: ...ii Leading EDGE COMPUTING Revision History Revision Release Date Description of Change s 2 00 July 14 2017 Initial Release ...

Page 3: ...even if advised of the possibility of such damages Environmental Responsibility ADLINK is committed to fulfill its social responsibility to global environmental preservation through compliance with the Euro pean Union s Restriction of Hazardous Substances RoHS direc tive and Waste Electrical and Electronic Equipment WEEE directive Environmental protection is a top priority for ADLINK We have enfor...

Page 4: ...ns properly NOTE NOTE Additional information aids and tips that help users perform tasks CAUTION Information to prevent minor physical injury component dam age data loss and or program corruption when trying to com plete a task WARNING Information to prevent serious physical injury component damage data loss and or program corruption when trying to complete a specific task ...

Page 5: ... Setting Up the Build Environment 1 2 Function Library 3 2 1 List of Functions 3 2 2 Function Library 4 2 2 1 Device Control Functions 4 2 2 2 Power Management Functions 8 2 2 3 License Management Functions 22 2 2 4 Trigger over Ethernet Functions 28 Important Safety Instructions 41 Getting Service 45 ...

Page 6: ...vi Table of Contents Leading EDGE COMPUTING This page intentionally left blank ...

Page 7: ...sted in the ADLINK Smart GigE Utility as shown 1 1 Setting Up the Build Environment All files are located in the directory ADLINK PCIe GIE7X Include File Type File Description Required by Include SmartPoE h Header file required for all C C applications All applications using APIs SmartPoE vb Function definitions required for all VB Net applications SmartPoE cs Function definitions required for all...

Page 8: ... Introduction Leading EDGE COMPUTING Library SmartPoE lib Exports API function definitions required for all Visual C C applications All C C applications using APIs File Type File Description Required by ...

Page 9: ...et_PoEstate SmartPoE_Get_PoEPortLaststate SmartPoE_Get_Temperature SmartPoE_Get_HighTemperature SmartPoE_Get_LowTemperature SmartPoE_Set_HighTemperature SmartPoE_Set_LowTemperature SmartPoE_Get_PortStatus SmartPoE_Get_PSEPortCurrent SmartPoE_Get_PSEPortVoltage SmartPoE_Get_PoEConsPowbudget SmartPoE_Get_PoELeftPowbudget SmartPoE_Get_PowerBudgetControl SmartPoE_Set_PowerBudgetControl License Managem...

Page 10: ...ates the number of devices beginning at 0 for the num ber of the first card with the second card 1 and so on Trigger over Ethernet GIE_Set_ActionCommand PCIe GIE7X PRO GIE_Get_ActionCommand GIE_Send_ActionCommand GIE_Send_AllActionCommand GIE_GetTriggerSource GIE_SetTriggerSource GIE_GetTriggerMode GIE_SetTriggerMode GIE_GetTriggerActivation GIE_SetTriggerActivation GIE_GetTriggerType GIE_SetTrigg...

Page 11: ...e returned from calling SmartPoE_Register_Card Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 4 Call SmartPoE_Register_Card before other functions SmartPoE_Get_ID Initializes the hardware and software states of a PCI bus data acquisition card then returns a numeric card ID that corresponds to the initial...

Page 12: ...uired from the return value of SmartPoE_Register_Card wID Indicates card ID set by S1 switch a value from 0 to 15 Card ID and S1 switch settings correlate as shown Card ID S1 switch 4 3 2 1 0 off off off off 1 off off off on 2 off off on off 3 off off on on 4 off on off off 5 off on off on 6 off on on off 7 off on on on 8 on off off off 9 on off off on 10 on off on off 11 on off on on 12 on on off...

Page 13: ...sion Syntax C C short SmartPoE_Get_CPLDVersion unsigned short wCardNumber unsigned long wVersion1 unsigned long wVersion2 Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card wVersion1 7 0 Date 15 8 Month 31 16 Year wVersion2 7 0 Minute 15 8 Hour Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumbe...

Page 14: ...nor number Bit 4 to 7 major number For example V1 3 Bit 0 to 3 minor number in this case 3 Bit 4 to 7 major number in this case 1 Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card 2 2 2 Power Management Functions SmartPoE_Power_Enable Controls power auto off Synt...

Page 15: ...urn value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_Power_Enable Retrieves power auto off Syntax C C short SmartPoE_Get_Power_Enable unsigned short wCardNumber unsigned short wEnPort1 unsigned short wEnPort2 unsigned short wEnPort3 unsigned short wEnPort4 Parameter s wCardNumber Retrie...

Page 16: ...short wCardNumber unsigned char bPoEstatePA0 unsigned char bPoEstatePA1 unsigned char bPoEstatePowerBudget unsigned char bPoEstatePA4 unsigned char bPoEstatePA3 unsigned char bPoEstatePF0 Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card wPoEstate bPoEstatePA0 PA0 0 PoE PSE HW setting disabled 1 PoE PSE HW setting enabled bPoEstatePA1 PA1 0 PoE PSE should be turned ...

Page 17: ...No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion SmartPoE_Get_PoEPortLaststate Retrieves the PoEPort Last State MCU recovers POE PSE Port Last State when PSE is off on Syntax C C Short SmartPoE_Get_POEPortLaststate unsigned short wCardNumber unsigned...

Page 18: ...4 power not enabled or there are only 2 POE ports 1 port 4 power enabled Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion SmartPoE_Get_Temperature Retrieves thermal temperature Syntax C C short SmartPoE_Get_Temperature unsigned short wCar...

Page 19: ...he High Temperature setting Syntax C C short SmartPoE_Get_HighTemperature unsigned short wCardNumber unsigned short wTempera ture Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card wHighTemperature High Temperature setting not exceeding 150 C 1 byte data in 1 C unit Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumbe...

Page 20: ...ue of SmartPoE_Register_Card wLowTemperature Low Temperature setting cannot exceed High Temperature setting Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion SmartPoE_Set_HighTemperature High Temperature setting Syntax C C short SmartPoE_S...

Page 21: ... An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion 11 The input argument s exceed the allowed range SmartPoE_Set_LowTemperature Low Temperature setting Syntax C C short SmartPoE_Set_LowTemperature unsigned short wCardNumber unsigned short wLowTempera ture Parameter s wCardNumber Retrieved from the return value of Smart...

Page 22: ...nt s exceed the allowed range SmartPoE_Get_PortStatus Retrieves Port Status Syntax C C short SmartPoE_Get_PortStatus unsigned short wCardNumber unsigned short PortNumber unsigned char bstateClass unsigned char bstatePowerGood Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card PortNumber Indicates port number from 1 to 4 wstate bstateClass 0 Unknow 1 Class 1 NOTE NOTE...

Page 23: ...ror occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion SmartPoE_Get_PSEPortCurrent Retrieves port current Syntax C C bstateClass PoE CLASS 000 Unknown 001 1 010 2 011 3 100 4 101 5 110 0 111 Current limit ...

Page 24: ...urn Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion SmartPoE_Get_PSEPortVoltage Retrieves port voltage Syntax C C short SmartPoE_Get_PSEPortVoltage unsigned short wCardNumber unsigned short PortNumber double wVoltage Parameter s wCardNumber Ret...

Page 25: ...s the Consumed Power budget Syntax C C short SmartPoE_Get_POEConsPowbudget unsigned short wCardNumber double wPower Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card wPower Consumed Power budget in W Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supp...

Page 26: ...nd if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion SmartPoE_Get_PowerBudgetControl Retrieves power budget control status Syntax C C short SmartPoE_Get_PowerBudgetControl unsigned short wCardNumber unsigned short wMode Parameter s wCardNumber Retrieved from the return value of SmartPoE_R...

Page 27: ...dget control status Syntax C C short SmartPoE_Set_PowerBudgetControl unsigned short wCardNumber unsigned short wMode Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card wMode Mode 0 Turn off power budget control Mode 1 Turn on power budget control Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNum...

Page 28: ...martPoE_Register_Card MasterSecret 32 byte buffer with new secret or partial LockBit Allows secret to be write protected where it is read as pro tected by hardware design Once set secret protection can not be reset Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this car...

Page 29: ...r parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion 12 An invalid secret SetMastSecret error AD_EncryptReadSegment Performs an encrypted read DS28C22 on an encrypted segment of memory starting on the specified page at the specified segment offset Syntax C C short AD_EncryptReadSegment unsigned short wCardNumber unsigned char data unsigned ch...

Page 30: ... No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card SmartPoE_Get_MCUVersion 12 An invalid secret SetMastSecret error AD_EncryptComputeEnc Computes encode data Syntax C C short AD_EncryptComputeEnc_ex2 unsigned short wCardNumber unsigned char new_data unsigned char romid unsig...

Page 31: ...OM ID used in encryption manid Buffer for 2 byte manufacturer ID used in encryption calcu lation check_mac Buffer containing 32 bytes of check_mac read_challenge Buffer containing 8 bytes of challenge lockdata Once set data protection mode cannot be reset Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 ...

Page 32: ...chk_mac unsigned char challenge bool lockdata Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card numBytesTot Total bytes to be written to page enc_data Buffer containing 32 bytes of data to be written old_data Buffer containing 32 bytes of data currently in that segment required for authentication calc romid Buffer containing device 8 byte ROM ID used in encryption m...

Page 33: ..._Get_MCUVersion 11 An error in lock function 70 An error in encryption authentication AD_ReadInstallSecretStatus Retrieves how each individual user memory page can be protected Syntax C C short AD_ReadInstallSecretStatus unsigned short wCardNumber byte InstallBit byte LockDataBit Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card InstallBit 0 Non burned card 1 Burned...

Page 34: ...d Sets an ACTION command over the selected port Syntax C C short GIE_Set_ActionCommand U16 wCardNumber U16 PortNumber U32 gActionDeviceKey U32 gAc tionGroupKey U32 gActionGroupMask Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card PortNumber Indicates port number from 1 to 4 gActionDeviceKey Device Key of the command gActionGroupKey Group Key of the command gActionG...

Page 35: ... U32 gActionDeviceKey U32 gActionGroupKey U32 gActionGroupMask Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card PortNumber Indicates port number from 1 to 4 gActionDeviceKey Device Key of the command gActionGroupKey Group Key of the command gActionGroupMask Group Mask of the command Return Code No error occurs if return value 0 and if negative value as follows 2 An...

Page 36: ..._Register_Card PortNumber Indicates port number from 1 to 4 Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card GIE_Send_AllActionCommand Sends a software ACTION command over all ports Syntax C C short GIE_Send_AllSoftwareActionCommand U16 wCardNumber Parameter s w...

Page 37: ...rce Syntax C C short GIE_GetTriggerSource U16 wCardNumber U16 Source Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card State 0 Software trigger source 1 External hardware trigger source Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this ...

Page 38: ...ccurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card 11 An invalid state parameter GIE_GetTriggerMode Acquires Trigger over Ethernet function status Syntax C C short GIE_GetTriggerMode U16 wCardNumber U16 Mode Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_C...

Page 39: ...quires Trigger over Ethernet function status Syntax C C short GIE_GetTriggerMode U16 wCardNumber U16 Mode Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card Mode 0 Software trigger source 1 External hardware trigger source Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 Th...

Page 40: ...ved from the return value of SmartPoE_Register_Card Activation 1 Rising edge 2 Falling edge Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card GIE_SetTriggerActivation Sets Trigger activation mode for ToE specifying that the source trigger is considered valid on t...

Page 41: ...n 32 5 The function is not supported by this card 11 This is an invalid state parameter GIE_GetTriggerType Acquires Trigger type where 4 to 4 mode indicates that each pin of the DI performs corresponding port action com mand to active and 1 to 4 mode indicates that DI_0 per forms all port action commands to active Syntax C C short GIE_GetTriggerType U16 wCardNumber U16 Type Parameter s wCardNumber...

Page 42: ...rforms corresponding port action command to active and 1 to 4 mode indicates that DI_0 performs all port action commands to active Syntax C C short GIE_SetTriggerType U16 wCardNumber U16 Type Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card Type 0 4 to 4 mode 1 1 to 4 mode Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid w...

Page 43: ...alue 0 and if negative value as follows 2 An invalid wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card GIE_SetTriggerDebounce Sets trigger denounce time for filtering the external trigger Syntax C C NOTE NOTE When the board connects with different trigger source types voltage and frequency photocouplers onboard experience slightly different rising and f...

Page 44: ... wCardNumber is less than 32 5 The function is not supported by this card 11 An invalid state parameter GIE_GetTriggerCount Acquires Trigger count directing 16 bit counter to count trig gers originating from hardware or software and ToE com mands sent from the PCIe GIE7x PRO Syntax C C short GIE_GetTriggerCount U16 wCardNumber U16 PortNumber U16 TriggerCount U16 Trig gerSentCount Parameter s wCard...

Page 45: ...wCardNumber parameter wCardNumber is less than 32 5 The function is not supported by this card GIE_ResetTriggerCount Resets Trigger count with trigger counters reset to 0 Syntax C C short GIE_ResetTriggerCount U16 wCardNumber Parameter s wCardNumber Retrieved from the return value of SmartPoE_Register_Card Return Code No error occurs if return value 0 and if negative value as follows 2 An invalid ...

Page 46: ...40 Function Library Leading EDGE COMPUTING ...

Page 47: ...pply and 50ºC with adapter supply When installing mounting or uninstalling removing device or when removal of a chassis cover is required for user ser vicing See Function Library on page 3 Turn off power and unplug any power cords cables Reinstall all chassis covers before restoring power To avoid electrical shock and or damage to device Keep device away from water or liquid sources Keep device aw...

Page 48: ...en the thumbscrews with a screwdriver before starting the system up It is recommended that the device be installed only in a server room or computer room where access is Restricted to qualified service personnel or users familiar with restrictions applied to the location reasons therefor and any precautions required Only afforded by the use of a tool or lock and key or other means of security and ...

Page 49: ...ing this surface could result in bodily injury To reduce risk allow the surface to cool before touching RISQUE DE BRÛLURES Ne touchez pas cette surface cela pourrait entraîner des blessures Pour éviter tout danger laissez la surface refroidir avant de la toucher ...

Page 50: ...44 Important Safety Instructions Leading EDGE COMPUTING This page intentionally left blank ...

Page 51: ... 360 0200 Toll Free 1 800 966 5200 USA only Fax 1 408 360 0222 Email info adlinktech com ADLINK Technology China Co Ltd 300 Fang Chun Rd Zhangjiang Hi Tech Park Pudong New Area Shanghai 201203 China Tel 86 21 5132 8988 Fax 86 21 5132 3588 Email market adlinktech com LiPPERT ADLINK Technology GmbH Hans Thoma Strasse 11 D 68163 Mannheim Germany Tel 49 621 43214 0 Fax 49 621 43214 30 Email emea adlin...

Search results

Summary of Contents for PCIe-GIE7 Series

Reviews:

Related manuals for PCIe-GIE7 Series

Brands by name

Popular brands

ADLINK Technology PCIe-GIE7 Series, Reference Manual

Search results

Summary of Contents for PCIe-GIE7 Series

Reviews:

Related manuals for PCIe-GIE7 Series

Brands by name

Popular brands