ADLINK Technology PCIe-U30 Series User manual

Leading EDGE COMPUTING
PCIe-U30x Series
4/8/12-ch PCI Express® x4 Gen3
USB3 Vision Top Performing Frame Grabbers
Function Library Reference
Manual Rev.: .0
Revision ate: Oct. 22, 20 9
Part No: 50- 269- 000

ii Revision History
Leading EDGE COMPUTING
Revision History
Revision Release ate escription of Change(s)
.00 Oct. 22, 20 9 Initial release

Preface iii
PCIe-U30x Series
Preface
Copyright © 2019 A LINK Technology Inc.
This document contains proprietary information protected by copy-
right. All rights are reserved. No part of this manual may be repro-
duced by any mechanical, electronic, or other means in any form
without prior written permission of the manufacturer.
isclaimer
The information in this document is subject to change without prior
notice in order to improve reliability, design, and function and does
not represent a commitment on the part of the manufacturer.
In no event will the manufacturer be liable for direct, indirect,
special, incidental, or consequential damages arising out of the
use or inability to use the product or documentation, even if
advised of the possibility of such damages.
ADLINK is committed to fulfill its social responsi-
bility to global environmental preservation
through compliance with the European Union's
Restriction of Hazardous Substances (RoHS)
directive and Waste Electrical and Electronic
Equipment (WEEE) directive. Environmental
protection is a top priority for ADLINK. We have
enforced measures to ensure that our products,
manufacturing processes, components, and raw
materials have as little impact on the environment as possible.
When products are at their end of life, our customers are encour-
aged to dispose of them in accordance with the product disposal
and/or recovery programs prescribed by their nation or company.
Battery Labels (for products with battery)
ᘄ㟁ụㄳᅇᨲ

iv Preface
Leading EDGE COMPUTING
California Proposition 65 Warning
WARNING: This product can expose you to chemicals
including acrylamide, arsenic, benzene, cadmium, Tris
( ,3-dichloro-2-propyl)phosphate (TDCPP), ,4-Dioxane,
formaldehyde, lead, DEHP, styrene, DINP, BBP, PVC, and vinyl
materials, which are known to the State of California to cause can-
cer, and acrylamide, benzene, cadmium, lead, mercury, phthal-
ates, toluene, DEHP, DIDP, DnHP, DBP, BBP, PVC, and vinyl
materials, which are known to the State of California to cause birth
defects or other reproductive harm. For more information go to
www.P65Warnings.ca.gov.
Trademarks
Product names mentioned herein are used for identification pur-
poses only and may be trademarks and/or registered trademarks
of their respective companies.
Conventions
Take note of the following conventions used throughout this
manual to make sure that users perform certain tasks and
instructions 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.

Table of Contents v
PCIe-U30x Series
Table of Contents
Revision History...................................................................... ii
Preface.................................................................................... iii
1 Introduction ........................................................................ 1
. Setting Up the Build Environment........................................
2 Function Library................................................................. 3
2. List of Functions................................................................... 3
2.2 Function Library ................................................................... 3
2.2. Device Control Functions ........................................... 3
2.2.2 Power Management Functions ................................... 9
Important Safety Instructions .............................................. 13
Getting Service...................................................................... 15

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

Introduction 1
PCIe-U30x Series
1 Introduction
The PCIe-U30x series Function Library Reference provides nec-
essary API details, where developers can develop power control
applications and get product information in C/C++, C#/VB.Net.
1.1 Setting Up the Build Environment
All header files, DLL and library filesare located in:
\A LINK\U3 Series\Include
Type File escription Required by
Include
SmartU3.h Header file required for all C/C++
applications
All applications
using APIs
SmartU3.vb Function definitions required for all
VB.Net applications
SmartU3.cs Function definitions required for all
C# applications
DLL SmartU3.dll Dynamic link library files required
for all applications
Library SmartU3.lib
SmartU3x64.lib
Exports API function definitions,
required for all Visual C/C++
applications

2 Introduction
Leading EDGE COMPUTING
This page intentionally left blank.

unction Library 3
PCIe-U30x Series
2 Function Library
2.1 List of Functions
2.2 Function Library
2.2.1 evice Control Functions
SmartU3_Register_Card
Initializes a specified device.This function should be called before
other functions except those with no Number parameter.
Syntax
C/C++
short SmartU3_Register_Card (unsigned short
card_num)
Parameter(s)
Card_num:
Indicates the number of devices with the first card num-
bered 0, the second card numbered , etc.
Category Function
Device
Control
SmartU3_Register_Card
SmartU3_Release_Card
SmartU3_Get_ID
SmartU3_Get_MCUVersion
SmartU3_Get_Ports
SmartU3_Get_ProductPN
SmartU3_Get_ProductSN
Power
Management
SmartU3_Power_Enable
SmartU3_Get_Power_Enable

4 unction Library
Leading EDGE COMPUTING
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-3 The count of calling SmartU3_Register_Card
must be less than 32
-13 Dri er is not found or there is no card
SmartU3_Release_Card
Closes the device and releases all allocated resources. This func-
tion should be called before terminating the application.
Syntax
C/C++
short SmartU3_Release_Card (unsigned short
wCardNumber)
Parameter(s)
wCardNumber:
Indicates the value returned from calling
SmartU3_Register_Card.
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wCardNumber parameter. wCardNumber
is less than 32
SmartU3_Get_I
Initializes the hardware and software states of a PCI-bus data
acquisition card, then returns a numeric card ID that corresponds
to the initialized card. Register_Card must be called before any
other functions can be called for a particular card. The function ini-
tializes the card and variables internal to the library. Because PCI-
bus data acquisition cards meet plug-and-play specifications, the

unction Library 5
PCIe-U30x Series
base address (pass-through address) and IRQ level are assigned
directly by the system BIOS
Syntax
C/C++
short SmartU3_Get_ID (unsigned short wCardNum-
ber, unsigned short *wID)
Parameter(s)
wCardNumber:
Acquired from the return value of SmartU3_Register_Card
wID:
Indicates the card ID set by SW switch, a value from 0 to
5. Card ID and SW switch settings correlate as shown
Card I
SW1 switch
4321
0 off off off off
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
0 on off on off
on off on on
2 on on off off
3 on on off on
4 on on on off
5 on on on on

6 unction Library
Leading EDGE COMPUTING
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wcardnumber parameter. wcardnumber
is less than 32
-11 In alid wID
SmartU3_Get_MCUVersion
Retrieves the PoE MCU version.
Syntax
C/C++
short SmartU3_Get_MCUVersion (unsigned short
wCardNumber, char* sVersion, long lSize)
Parameter(s)
wCardNumber:
Retrieved from the return value of SmartU3_Register_Card.
sVersion:
Pointer of an allocated character buffer. The suggested buf-
fer size is 6.
The buffer will retrieve the version string after executing this
function.
The version format is [Major number].[Minor number]. e.g. .3
lSize:
The size of the sVersion buffer.
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wcardnumber parameter. wcardnumber
is less than 32
-11 In alid sVersion

unction Library 7
PCIe-U30x Series
SmartU3_Get_Ports
Retrieves the number of ports.
Syntax
C/C++
short SmartU3_Get_Ports(unsigned short wCard-
Number, unsigned short *wPort)
Parameter(s)
wCardNumber:
Indicates the value returned from calling
SmartU3_Register_Card.
wPort:
Indicates the number of ports.
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wCardNumber parameter. wCardNumber
is less than 32
SmartU3_Get_ProductPN
Retrieves the the product P/N (Part Number).
Syntax
C/C++
short SmartU3_Get_ProductPN (unsigned short
wCardNumber, char* sVersion, long lSize)
Parameter(s)
wCardNumber:
Retrieved from the return value of SmartU3_Register_Card.

8 unction Library
Leading EDGE COMPUTING
sVersion:
Pointer of an allocated character buffer. The suggested buf-
fer size is 6.
The buffer will retrieve the ADLINK product P/N (Part Num-
ber) string after executing this function.
lSize:
The size of the sVersion buffer.
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wcardnumber parameter. wcardnumber
is less than 32
SmartU3_Get_ProductSN
Retrieves the the product Serial Number.
Syntax
C/C++
short SmartU3_Get_ProductSN (unsigned short
wCardNumber, char* sVersion, long lSize)
Parameter(s)
wCardNumber:
Retrieved from the return value of SmartU3_Register_Card.
sVersion:
Pointer of an allocated character buffer. The suggested buf-
fer size is 6.
The buffer will retrieve the product serial number string after
executing this function.
lSize:
The size of the sVersion buffer.

unction Library 9
PCIe-U30x Series
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wcardnumber parameter. wcardnumber
is less than 32
2.2.2 Power Management Functions
SmartU3_Power_Enable
Controls power auto/off for each USB port.
Syntax
C/C++
short SmartU3_Power_Enable (unsigned short
wCardNumber, unsigned short wEnPort1, unsigned
short wEnPort2, unsigned short wEnPort3,
unsigned short wEnPort4, unsigned short
wEnPort5, unsigned short wEnPort6, unsigned
short wEnPort7, unsigned short wEnPort8)
Parameter(s)
wCardNumber:
Retrieved from the return value of SmartU3_Register_Card.
wEnPort1, wEnPort2, wEnPort3, wEnPort4, wEnPort ,
wEnPort6, wEnPort7, wEnPort8:
Indicates the power mode of the smart U3 port with the fol-
lowing values:
0: power off
: auto mode (enables the port to auto-detect the device
and power output)

10 unction Library
Leading EDGE COMPUTING
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wcardnumber parameter. wcardnumber
is less than 32
Notes:
For the PCIe-U304, the last 4 parameters (wEnPort5,
wEnPort6, wEnPort7, wEnPort8) must be assigned a “0” value
to avoid a function error.
For the PCIe-U308e, ports 9- 2 are always configured as auto
mode and cannot be powered off.
SmartU3_Get_Power_Enable
Retrieves the power auto/off status.
Syntax
C/C++
short SmartU3_Get_Power_Enable (unsigned short
wCardNumber, unsigned short *wEnPort1,
unsigned short *wEnPort2, unsigned short
*wEnPort3, unsigned short *wEnPort4, unsigned
short *wEnPort5, unsigned short *wEnPort6,
unsigned short *wEnPort7, unsigned short
*wEnPort8)
Parameter(s)
wCardNumber:
Retrieved from the return value of SmartU3_Register_Card.
wEnPort1, wEnPort2, wEnPort3, wEnPort4, wEnPort ,
wEnPort6, wEnPort7, wEnPort8:
Indicates the power mode of the selected USB port with the
following values:
0: power off

unction Library 11
PCIe-U30x Series
: auto mode (enables the port to auto-detect the device
and power output)
Return Code
No error occurs if the return value >= 0, and if a negative value,
as follows
-2 In alid wcardnumber parameter. wcardnumber
is less than 32
Note: For the PCIe-U304, the value returned for the last 4
parameters (wEnPort5, wEnPort6, wEnPort7, wEnPort8)
should be “0”.

12 unction Library
Leading EDGE COMPUTING
This page intentionally left blank.

Important Safety Instructions 13
PCIe-U30x Series
Important Safety Instructions
For user safety, please read and follow all instructions, Warnings,
Cautions, and Notes marked in this manual and on the associated
device before handling/operating the device, to avoid injury or
damage.
S'il vous plaît prêter attention stricte à tous les avertissements et
mises en garde figurant sur l'appareil , pour éviter des blessures
ou des dommages.
Read these safety instructions carefully.
Keep the User’s Manual for future reference.
Read the Specifications section of this manual for detailed
information on the recommended operating environment.
The device can be operated at an ambient temperature of
55ºC.
When installing/mounting or uninstalling/removing device,
or when removal of a chassis cover is required for user ser-
vicing:
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 away from high heat or humidity.
Keep device properly ventilated (do not block or cover
ventilation openings).
Always use recommended voltage and power source
settings.
Always install and operate device near an easily acces-
sible electrical outlet.
Secure the power cord (do not place any object on/over
the power cord).
Only install/attach and operate device on stable surfaces
and/or recommended mountings.
If the device will not be used for long periods of time, turn off
and unplug it from its power source
Never attempt to repair the device, which should only be
serviced by qualified technical personnel using suitable
tools

14 Important Safety Instructions
Leading EDGE COMPUTING
A Lithium-type battery may be provided for uninterrupted
backup or emergency power.
The device must be serviced by authorized technicians
when:
The power cord or plug is damaged.
Liquid has entered the device interior.
The device has been exposed to high humidity and/or
moisture.
The device is not functioning or does not function
according to the User’s Manual.
The device has been dropped and/or damaged and/or
shows obvious signs of breakage.
Disconnect the power supply cord before loosening the
thumbscrews and always fasten 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 controlled by the authority
responsible for the location.
CAUTION:
Risk of explosion if battery is replaced with one of an incorrect
type; please dispose of used batteries appropriately.
Risque d’explosion si la pile est remplacée par une autre de
type incorrect. Veuillez jeter les piles usagées de façon appro-
priée.
BURN HAZAR
Touching 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.