ARINC429 Windows SDK Getting Started Manual Getting Started Manual February 2013 V01.00.00 Rev. A
ARINC429 Windows SDK Getting Started Manual Getting Started Manual V01.00.00 Rev. A February 2013
Table of Contents...1 Section 1 INTRODUCTION 1.1 About this... 1 Manual 1.2 How this... 3 Manual is Organized 1.3 General... 3 Documentation Conventions 1.4 Applicable... 4 Documents Section 2 NEW SDK AND HARDWARE INSTALLATION...5 PROCEDURE 2.1 SDK Installation... 5 2.2 Hardware... 10 Installation 2.2.1 Installing the... AIT Hardware 11 2.2.2 Installing the... Windows XP/7 Driver 11...17 Section 3 SDK UPGRADE PROCEDURE 3.1 Removing... 17 Previously Installed Drivers and SDK 3.2 Install... 19 the New SDK 3.3 Update... 19 the Onboard Firmware/FPGA 3.3.1 Update Firmware... on 429 Modules 19 3.4 Installing... 21 the New Windows Driver Section 4 AIT FLIGHT...22 SIMULYZER Section 5 ARINC-429...24 SOFT FRONT PANEL Section 6 COMPILING...27 AND RUNNING A SAMPLE PROJECT...29 Section 7 DOWNLOADING THE SDK FROM AVIFTECH.COM II
1 INTRODUCTION 1.1 About this Manual This Getting Started Manual has been developed to assist first time users of AIT ARINC429 interface modules with software installation, hardware setup, and starting a sample project. Step by step instructions cover PMC/XMC/PCI/PCIe/PXI/USB/PC104p-429 Software Development Kit (SDK) installation, board installation, and driver configuration. The SDK provides users with current documentation, board drivers, and sample development projects. Additionally, the SDK provides utility files that are used to upgrade the 429 board and the onboard firmware, which is also described in this manual. The current version of all SDKs are available from the DOWNLOAD AREA of the AIT website at http://www.aviftech.com. AIT is also a leading designer and manufacturer of other high performance test and simulation modules, databus analyzer software, and systems for MIL-STD-1553 A/B, ARINC664/AFDX, MIL-STD-1760E, Fibre Channel, Time-Triggered Ethernet, and Time-Triggered Protocol. Supported hardware platforms include PMC, XMC, PCI/PCI-X, PCIe, PXI/PXIe, cpci, PC104+, USB, VME, and VXI. Information about all AIT products can be found at http://www.aviftech.com. 1
DOCUMENT HISTORY Cover Date V01.00.00 Rev. February A 2013 Version 2 Created by T. Fleissner Description Screenshot updates and content corrections
1.2 How this Manual is Organized This manual is organized as follows: Section 1, INTRODUCTION, contains an overview of this manual. Section 2, NEW SDK INSTALLATION PROCEDURE, describes the procedure used to install the SDK software and the PMC/XMC/PCI/PCIe/PXI/PC104p-429 hardware on a system that does not have a previous SDK installed. Section 3, SDK UPGRADE PROCEDURE, describes the procedure used to upgrade the SDK software and the onboard flash firmware on a system that has a previous SDK installed. Section 4, AIT FLIGHT SIMULYZER, contains a description and diagrams of AIT's 429 Full Function Analyzer. Section 5, ARINC-429 SOFT FRONT PANEL, contains a description and AIT's Soft Front Panel GUI application. Section 6, COMPILING AND RUNNING A SAMPLE PROJECT, contains the procedure used to open, build, and run a sample project included in the SDK. Microsoft Visual C++ is used. Section 7, DOWNLOADING THE SDK FROM AVIFTECH.COM, provides the steps to download a new SDK from AIT's full service technical website, www.aviftech.com. 1.3 General Documentation Conventions We use a number of different styles of text and layout in this document to help differentiate between the different kinds of information. Here are some examples of the styles we use and an explanation of what they mean: Italics - used as a placeholder for the actual name, filename, or version of the software in use Bold text - a function, or parameter, or used to highlight important information Bold Blue - will be used to show reference documentation Bold italics - caution, warning or note 3
1.4 Applicable Documents AIT has developed several documents that may be used to aid the user with other aspects of our ARINC429 bus interface cards. These documents and a summary of their contents are listed below: Software Library Reference Manual for AIT 429 Windows Applications, provides the 429 application developer with detailed programming information including library function call and header file details and specific troubleshooting information. This guide is to be used in conjunction with the 429 Programmer's Guide. PMC429 Hardware Manual - for the PMC429 PMC modules. Provides hardware installation instructions, board connections, technical data, and a general description of the hardware architecture. PCI-C429 Hardware Manual - for the PCI-C429 PCIbus modules. Provides hardware installation instructions, board connections, technical data, and a general description of the hardware architecture. PCIe-C429 Hardware Manual - for the PCIe-C429 PCIebus modules. Provides hardware installation instructions, board connections, technical data, and a general description of the hardware architecture. PXI-C429 Hardware Manual - for the PXI-C429 PXI/PXIe/cPCI modules. Provides hardware installation instructions, board connections, technical data, and a general description of the hardware architecture. PC104p-429 Hardware Manual - for the PC104p-429 PC104+ modules. Provides hardware installation instructions, board connections, technical data, and a general description of the hardware architecture. USB-429 Hardware Manual - for the USB-429 modules. Provides hardware installation instructions, board connections, technical data, and a general description of the hardware architecture. 4
2 NEW SDK AND HARDWARE INSTALLATION PROCEDURE This section contains the procedure used to install the SDK software and the 429 hardware on a system that does not have a previous 429 SDK installed. If installing on a system that has a previous version of the SDK installed, the SDK upgrade procedure described in Section 3 should be used. The 429 SDK contains reference documentation, board drivers, sample development projects, and firmware upgrade utility files. These files are automatically loaded onto the system by installing the SDK software package. The software is available on CD from AIT or via a download from www.aviftech.com. 2.1 SDK Installation To properly install the AIT 429 SDK and hardware: a. Complete the procedure described in SDK Software Installation. b. Perform the procedure described in Hardware Installation. Note: In order to ensure proper installation, it is important that the SDK Software installation is completed before the 429 hardware is installed. The 429 SDK includes the following resources which will be installed on your computer upon completion of the steps described in this section: Software Library Reference Manual SDK Release Notes Windows System Drivers Onboard firmware update utilities Sample project To install the SDK software from the AIT-provided CD or a download from www.aviftech.com: 1. If using the AIT provided CD, insert the CD into the CD ROM drive. The Setup Application will automatically start after a few seconds. If the Setup Application does not start after a few seconds, or if the SDK is being installed from an aviftech.com download, the Setup Application must be manually started. 5
2. To Start the application manually, navigate to the CD ROM drive or the download directory and double click the Setup.exe icon, or start it with the Start Run... command. 3. Once the Setup Application has started, step through the install wizard to complete the installation. You will be given the opportunity to choose the directory where the SDK is to be installed. Default locations can also be used. 6 4. Follow the onscreen instructions, to begin installation, press Next 5. You will be prompted to select the components to install. The table below describes each of these components. after selecting all components that you wish to install, press Next.
Component A429 C-Api Description ARINC-429 High Level C API providing a standard C interface to the high level functions of the ARINC-429 modules. OWL C/C++ API (PCI) ARINC-429 Object Wrapper Layer API Library including all required include files, link library, and dynamic link library. Also includes sample applications and utilities. OWL.NET Assembly ARINC429 Object Wrapper Layer API Library for. NET applications. Provides support for C#, VB. NET, and VC++ Flight Simulyzer ARINC-429 Analyzer and Configuration Tool GUI Application PCI Device Drivers and ARINC-429 Hardware module device drivers and Firmware on-board firmware. This component is needed on systems where the ARINC-429 hardware modules will be installed. Visual C++ 2005 SP1 Runtime The Microsoft Visual C++ 2005 Service Pack1 runtime. This component may be required on systems that do not have the latest Visual Studio runtime installed. Visual C++ 2008 SP1 Runtime The Microsoft Visual C++ 2008 Service Pack1 runtime. This component may be required on systems that do not have the latest Visual Studio runtime installed. Visual C++ 2010 SP1 Runtime The Microsoft Visual C++ 2010 Service Pack1 runtime. This component may be required on systems that do not have the latest Visual Studio runtime installed. 7
8 6. Review the installation tasks and, when ready, press Install to begin copying files to disk. 7. When prompted, choose whether or not the computer should be restarted after the installer exits. If you have installed the VISA drivers and firmware then you must restart the computer in order for the ARINC-429 hardware modules to be restarted with the new drivers. (See the next section for Hardware installation instructions)
The SDK installation will result in the creation of the following Program Folder icons which can be located by going to Start All Programs Avionics Interface Technologies ARINC-429 SDK vx.x.x: The SDK installation will also result in the creation of the directory structure shown below. The AIT directory will be located in x:\program Files\AIT. The Program Files directory will be located on the drive that was chosen during the SDK install 9
The folder contents are: C++ API C API Front Panel Hardware Utils NET API 2.2 High Level OWL C/C++ Object Oriented API, including libraries, reference manuals, sample projects, etc High Level ANSI C API, including libraries, reference manuals, sample projects, etc The Soft Front Panel provides a simple and easy to use Graphical User's Interface to the AIT ARINC-429 hardware modules. Update utilities that are used to update onboard firmware.net API,, including libraries, reference manuals, sample projects, etc Hardware Installation Once you have installed the SDK as described in SDK Installation, you can now begin installation of the hardware and associated driver. The 429 board features full 'plug-and-play' capability. There are no jumpers or switches to modify before installation. The hardware installation is completed by performing the steps as described below: a. 10 Install the 429 board as described in Installing the AIT Hardware.
b. 2.2.1 Install and verify the Windows driver using Driver installation for a Windows XP/7 system. Installing the AIT Hardware ESD Warning!!! The 429 boards are typical electronic devices that are sensitive to electrostatic discharge. It is important to observe normal precautions when handling the board to prevent damage. 2.2.2 To install the PCI/PCIx/PCIe/PXI-C429 board: 1. Power off the PC. 2. Insert the board into an available PCI slot. 3. Reboot the PC. Windows will recognize the new hardware as a PCI/PCIe-C429 board or a PCI Bridge Device and start the Found New Hardware Wizard. To install the PMC429 board: 1. Power off the PC. 2. Insert the PMC429 board into an available PCI slot via a PMC-Adapter or insert the PMC429 board into an available cpci slot via a PMC carrier board. 3. Reboot the PC. Windows will recognize the new hardware as a PMC429 board or a PCI Memory Controller and start the Found New Hardware Wizard. Installing the Windows XP/7 Driver The following procedures perform installation and verification of the Windows XP/7 driver. The Hardware Wizard will be directed to obtain the Windows XP/7 driver for the 429 board from: C:\Program Files\AIT\Drivers\UAPI PCI Drivers vx.x.x To install the Windows XP/7 driver: 1. When the computer starts up, the Found New Hardware Wizard will start. Follow the wizard, choosing the illustrated options. Install from a list or specific location (Advanced) 11
Then select the Next button. (You do not need the installation CD inserted into the CD drive.) 2. 12 Install the software automatically.
13
14 3. The wizard will find the appropriate driver files. 4. Press Finish to complete the installation.
To verify proper installation of Windows XP/7 driver: 1. Go to Start Control Panel and select System, then click on the Hardware tab and select the Device Manager button. For Windows XP users it may be necessary to first select Start Control Panel Switch to Classic View in order to find the System icon. 2. In the Device Manager window, expand the AIT Components entry by clicking on it. 15
AITUAPI : AIT's Lower Level Driver Node USB-A429 : The ARINC-429 Hardware Module (depends on board type) NOTE: Both of these nodes need to be present in order for the module to be installed correctly 16 3. If the Device Manager appears with both nodes as shown above, installation is complete. If not, continue to Step 4. 4. If the AITUAPI node is not present, the lower level AITUAPI driver was not correctly installed on the system. To fix this, go to the directory: C:\Program Files\AIT\Drivers\UAPI PCI Drivers vx.x.x and run DriverInstall.bat. After this completes, check Device Manager and verify the AIT 429 node appears. 5. If the AIT 429 node now appears, Scan for Hardware Changes by right clicking in the Device Manager window, and repeat Steps 1-3.
3 SDK UPGRADE PROCEDURE This section contains the procedures used to upgrade the SDK for the 429 module on a system which has a previous version of the 429 SDK installed. This procedure describes the steps which must be taken to upgrade both the host PC driver software and the onboard target driver software. The SDK is available on CD from AIT or via a download from www.aviftech.com. Appendix A contains instructions for performing the download. 3.1 To properly update the 429 SDK: 1. Remove the old driver and SDK. 2. Install the new SDK. 3. Update the onboard flash firmware. 4. Complete the upgrade by installing the new AIT device driver. Removing Previously Installed Drivers and SDK Before installing the new 429 SDK, it is recommended that the previously installed drivers and SDK are removed from the system. To remove the previously installed Windows XP/7 driver: 1. Go to Start Settings Control Panel System. Then select the Hardware Tab. In the Hardware Tab select the Device Manager button. (For Windows XP users it may be necessary to first select Start Control Panel Switch to Classic View in order to find the System icon) 17
2. In the Device Manager window, right click over the AITUAPI and the USB-A429 entry and select Uninstall. 3. Confirm the device removal by selecting the OK button. 4. Next, delete the following files if they exist: x:\windows\system32\drivers\aituapi.sys 18
x:\windows\system32\drivers\kpuapi.sys x:\windows\inf\oemxx.inf (where xx = number) INF is a hidden folder, to find this folder you may first need to select Tools FolderOptions View tab Show hidden files and folders in Windows Explorer. Note: Windows creates the oemxx.inf installation files (where xx = number) when installing new drivers. Therefore, it will be necessary to determine the actual name that Windows has assigned to the AIT 429 driver.inf file (for example, oem0.inf or oem11.inf). To find the actual name of the.inf file, search the INF folder for the text "AIT" and verify the contents are related to the AIT driver using a text editor such as Notepad or Wordpad prior to deletion. 5. 3.2 Now, remove the SDK by going to C:\Program Files\AIT\ARINC-429 SDK vx.x.x and selecting unins000.exe Install the New SDK Once the old SDK and drivers have been removed, the upgrade may continue with the installation of the new SDK. The new SDK may be obtained via a download from www.aviftech.com, or from an AIT-provided CD. To install the new SDK from the AIT-provided CD or a download from www.aviftech.com, see Section 2.1. 3.3 Update the Onboard Firmware/FPGA This section contains the procedures used to update the onboard firmware on the ARINC-429 module when upgrading to a newer version of the Software Development Kit. By installing the SDK, all the files necessary to update the onboard Flash firmware are also installed. AIT recommends updating the onboard firmware to guarantee proper operation. 3.3.1 Update Firmware on 429 Modules A typical installation of the Windows SDK will contain an assortment of files within C:\Program Files\AIT\ARINC-429 vx.x.x. The directory for updating the firmware is located here: C:\Program Files\AIT\ ARINC-429 SDK vx.x.x\hardwareutils\uapi\utils 1) Run update_firmware.bat and select option (a) Show Devices. 19
The Hw Build ID is the firmware version that is currently loaded on the board and the File Build ID is the firmware version that was shipped with the SDK. You always want these to be the same. If they are different, you need to continue and update the firmware. 2) To Update the Firmware, select option (b) Program Devices You will see stars across the bottom of the window as the firmware update takes place. This process takes about 15 minutes. 20
NOTE: Do not turn off the computer or stop the application in the middle of the update 3) Once this process completes, you will see the message below. 4) Then completely cycle power to your machine. A restart is NOT sufficient. 5) Once your machine is on, you can repeat Step 1 to verify that the Hw Build ID and the File Build ID are the same. 3.4 Installing the New Windows Driver Once the PC is rebooted, Windows will recognize the new hardware. To Install and verify the new Windows driver use Driver installation for a Windows XP/7 system as described in New SDK and Hardware Installation Procedure. 21
4 AIT FLIGHT SIMULYZER The Flight Simulyzer 429 Analyzer Software is used in conjunction with AIT s family of 429 interface boards to provide a powerful Windows-based 429 Analyzer tool. An easy-to-use GUI allows complete visual programming that enables users to troubleshoot, optimize, plan and configure ARINC-429 databuses. Low-level and highlevel protocol analysis features work by capturing, filtering, time stamping and interpreting ARINC-429 databus traffic and then generating advanced statistics for the users. Flight Simulyzer s Transmit and Receive Channel configurations are based on a common data format (XML) which allows simulation setups created and used within the Flight Simulyzer application to also be loaded and executed from within the AIT ARINC-429 LabView instrument driver, high-level C++ and C# application interface libraries. This allows configurations generated by Flight Simulyzer to be utilized from within user applications developed using LabView, C/C++, or C#. The operation of the Flight Simulyzer application is documented in the Flight Simulyzer User's Guide. The Flight Simulyzer User's Guide can be found at: Start All Programs Avionics Interface Technologies Flight Simulyzer User's Guide 22
23
5 ARINC-429 SOFT FRONT PANEL This section specifies the use of the ARINC-429 Soft Front Panel (SFP) GUI application. The SFP provides a simple and easy to use GUI interface to the ARINC429 Instruments. The 429 Soft Front Panel application is started from the Start Avionics Interface Technologies ARINC-429 SDK vx.x.x Front Panel... Start menu item. When launched, the Main tab of the SFP is displayed. Board Information is display as wells as the ability to configure a transmit and receive channel and the channel speed. NOTE: The transmit and receive channel have to be different. Transmit Operations The 429 Transmitting Tab is used to define a 32-bit 429 data transfers on the transmit channel. The + and - buttons allow the user to add or delete transfers. The data can be changed by double clicking on the data value in the table. The configuration properties allow the user to specify a rate and whether the transfers will be sent continuously or a specific number of times. 24
Receive Operations The 429 Receiving Tab is used to view the data the is being received by the channel. It displays the Timetag and the 32 bit data word. It also displays a count of the total number of words captured by the channel. NOTE: In order to view data on the receive channel, the user has to properly connect the transmit and receive channels externally. 25
26
6 COMPILING AND RUNNING A SAMPLE PROJECT The 429 SDK includes a Microsoft Visual C++ sample workspace that consists of several 429 application sample programs. This section contains the procedure which can be used to compile and run any of the sample programs included in the sample workspace (once the SDK has been installed). For further information regarding development of a 429 application software program to interface to the 429 module see the 429 Software Library Reference Manual. Note: The procedures in this section assume the use of Microsoft Visual C++ 2005, 2008, or 2010. The processes involved in compiling and running a sample program for the OWL429 C/C++ Object Oriented API include: Opening the sample Project Building and executing the sample program To Open the sample Project, double click on the Samples.sln located in C:\Program Files\AIT\ARINC-429 SDK vx.x.x\c++ API\samples\projects\vs20xxsp1 27
To Build and Execute a Sample Program: 1. Using File View, right click on any sample program (ex. Samples) and select Set as StartUp Project. 2. Select Build Build Samples. 3. The program can now be executed by selecting Debug Start Debugging or go to the Output directory and run the Samples.exe. Similarily, samples for the High Level ANSI C API and.net API are located in C:\Program Files\AIT\ARINC-429 SDK vx.x.x\c-api\samples and C:\Program Files\AIT\ARINC-429 SDK vx.x.x\net API\samples, respectively. 28
7 DOWNLOADING THE SDK FROM AVIFTECH.COM The AIT DOWNLOAD AREA consists of current manuals, SDKs, and documentation categorized by product. To obtain the 429 SDK, Product Guides, Datasheets, and Hardware Manuals from the Download Area: 1. The SDK can be downloaded directly from the Download Area of the AIT Website. The Download Area is accessible via the Download Area link located at the top of the AIT Home page - www.aviftech.com. 2. Once in the Download Area, login using your Customer (User) ID and Password. If you do not already have a user account for Aviftech.com, you can register to create one. 29
3. The software is accessible from within the 429 429 Windows software product page as shown below. 30
31