APPLICATION NOTE - Goepel Electronic

APPLICATION NOTE
File name AN00HE02 Revision 4.0.0
Author Heiko Ehrenberg Date January 29, 2008
eMail h.ehrenberg@goepelusa.com
Title
BSDL file verification with GOEPEL’s BSDL SyntaxChecker V4.0.0
Topic:
This application note explains how to use GOEPEL electronic's BSDL
SyntaxChecker software to verify BSDL files. The verification is just a
compilation of the BSDL file – that means the software does not access
the Boundary Scan device to physically check its BScan resources.
(Note: Physical verification of Boundary Scan resources on devices can
be achieved with GOEPEL electronic's CASCON GALAXY software and
one of GOEPEL’s Boundary Scan controllers, for example.)
Basic knowledge of Boundary Scan and BSDL syntax is helpful when
using the BSDL Syntax Checker.
GOEPEL Electronics ©2008 – 1 –

Table of contents
1 Introduction .....................................................................................................................3
2 Installation .......................................................................................................................3
3 How to use BSDL SyntaxChecker 3.1.2 .........................................................................3
3.1 Using the BSDL SyntaxChecker 3.1.2 – GUI version ..............................................3
3.2 Using the BSDL SyntaxChecker 3.1.2 – non-GUI version .....................................13
3.3 Verification of several BSDL files in a DOS batch sequence ................................13
4 Verification log file .........................................................................................................14
5 Exit Codes and Error File ..............................................................................................14
List of Tables
Table 1: valid Exit Codes.................................................................................................14
List of References
Boundary Scan Description Language (BSDL) Standard .…….. IEEE-Std. 1149.1-2001
BSDL Extension for ISC Description .................................…….. IEEE-Std. 1532-2002
BSDL Extension for Advanced I/O descriptions ................…….. IEEE-Std. 1149.6-2003
BSDL Extension for Mixed-Signal Test Features ..............…….. IEEE-Std. 1149.4-2007
GOEPEL Electronics ©2008 – 2 –

1 Introduction
BSDL SyntaxChecker V4.0.0 is provided as an application with a graphical user interface for
Microsoft Windows and as a Windows command line application.
This software checks the syntax of a BSDL file and returns a PASS/FAIL message.
The GUI based version provides any syntax error messages in a message panel.
The command line based version allows the verification of a single BSDL file as well as the
verification of several BSDL files in a batch mode, while a log file records the BSDL files verified
and the result (PASS/FAIL). An error report file lists BSDL syntax errors.
2 Installation
To install BSDL SyntaxChecker V4.0.0, simply unpack the ZIP file in the target directory. By
default, the files will be unpacked into a new directory structure inside the directory the ZIP file
resides in.
The ZIP file contains various files:
Bin\BSDLCheckerGoepel.exe
Bin\BSDLCheckerGoepelGUI.exe
Bin\RunBSDLChecker.bat
BSDL\*.bsd files
Packages\.all files
AN00HE02v4.0.0.pdf
the command line version of the BSDL SyntaxChecker
the GUI version of the BSDL SyntaxChecker
example DOS batch sequence
(utilizing command line version of BSDL SyntaxChecker)
example BSDL files
BSDL Package files
this document
3 How to use BSDL SyntaxChecker 4.0.0
The BSDL SyntaxChecker can be used either as a GUI based application, providing a simple and
intuitive user interface, or as a command line tool. Latter allows both the verification of a single
BSDL file and the verification of several BSDL files in a batch mode.
3.1 Using the BSDL SyntaxChecker 4.0.0 – GUI version
In the Windows Explorer, navigate to the directory where the BSDL SyntaxChecker is located and
then start BSDLCheckerGoepelGUI.EXE:
GOEPEL Electronics ©2008 – 3 –

The application starts and a blank work space appears:
Select (or press Ctrl+O) to open a BSDL file:
GOEPEL Electronics ©2008 – 4 –

A file selection box opens:
Select the BSDL file for which you want to check the syntax and press OPEN.
The BSDL file appears in the BSDL SyntaxChecker work space:
GOEPEL Electronics ©2008 – 5 –

If the BSDL file requires so called user package files (package files other than standard package
files STD_1149_1_1990, STD_1149_1_1994, STD_1149_1_2001, STD_1149_6_2003,
STD_1149_4_2007, STD_1532_2001, and STD_1532_2002), then one or more directories
containing such user package files can be specified. To do so, select menu :
A new dialog box appears, in which the package file directories can be added. The order of such
directories can be changed as well (to establish a hierarchical search order):
GOEPEL Electronics ©2008 – 6 –

Once all needed directories are listed (you may not need any, if the BSDL file does not refer to
any user package file), close the dialog box with OK.
The BSDL syntax check can be initiated with function key F9, with the respective task button (see
below), or by selecting the menu :
GOEPEL Electronics ©2008 – 7 –

When the check is complete (usually in less than a second), a PASS or FAIL flag appears at the
bottom of the window and, in the case of a fail, error messages are displayed in the message
panel below the BSDL file.
GOEPEL Electronics ©2008 – 8 –

The next screenshot shows a PASS result of a BSDL syntax check:
GOEPEL Electronics ©2008 – 9 –

In case of a FAIL result, a double-click on an error message jumps to the respective line in the
BSDL file and puts the cursor on the syntax error (as accurate as possible):
GOEPEL Electronics ©2008 – 10 –

GOEPEL Electronics ©2008 – 11 –

Sometimes more errors are detected once the first error(s) is(are) fixed:
Step by step fix the detected syntax errors and run the syntax check again.
For help with BSDL syntax problems, please feel free to contact bscan_support@goepel.com.
GOEPEL Electronics ©2008 – 12 –

3.2 Using the BSDL SyntaxChecker 4.0.0 – command line version
In a DOS Window (accessible through START | Programs | MS-DOS Prompt) or through
parameter call (START | Run…) BSDLCheckerGoepel.EXE needs to be started with certain
parameters:
BSDLCheckerGoepel opt
Parameters:
Opt -h print help in log file
-a append information in Log-File
Name of BSDL-File to be verified
Directory of Standard and User-Packages
Example 1 (see also chapter 4):
Directory structure:
C:\BSDL Checker\
C:\BSDL Checker\BSDL_IN\
C:\BSDL Checker\Packages\
Installation directory
contains BSDL files to be verified
contains package files
Application call (incl. parameters):
C:\BSDL Checker\BSDLCheckerGoepel –a BSDL_IN\8636g192.BSD Packages\
Success of the verification is stated in a log file (see chapter 4). BSDL syntax errors are listed in
an error file (see chapter 5).
3.3 Verification of several BSDL files in a DOS batch sequence
Using a DOS batch file several BSDL files can be checked with only one call. An example to
verify all BSDL files with extension “.BSD” in directory BSDL_IN is shown below. Each BSDL file
verification is stated in a log file (see chapter 4). BSDL syntax errors are listed in an error file (see
chapter 5).
Example 2 (see also chapter 4):
Directory structure:
C:\BSDL Checker\
C:\BSDL Checker\BSDL_IN\
C:\BSDL Checker\Packages\
Installation directory
contains BSDL files to be verified
contains package files
Application call in DOS batch (incl. parameters):
CD C:\BSDL Checker\
FOR %%f IN (BSDL_IN\*.BSD) DO BSDLCheckerGoepel -a %%f %1 Packages\
GOEPEL Electronics ©2008 – 13 –

4 Verification log file
A log file reports the BSDL files verified and the result (PASS/FAIL). The log file has the name
BSDCHGOE.LOG and is located in the same directory BSDL SyntaxChecker has been installed in.
For each verified BSDL file a separate entry is made. Each entry encompasses four (4) lines,
including a time stamp, software version and copyright, and information about which BSDL file
has been verified and did it pass or not.
In example 1 (see 3.2) the report file would be appended with following text:
…
Date: 03/11/02, Time: 10:44:42 - Running BSDL-Compiler
BSDL-Syntax Checker Version 2.02
Goepel Electronic GmbH
Compile BSDL_IN\8636g192.bsd OK
…
In example 2 (see 3.3) the report file would be appended with two entries:
…
Date: 03/11/02, Time: 10:45:52 - Running BSDL-Compiler
BSDL-Syntax Checker Version 2.02
Goepel Electronic GmbH
Compile BSDL_IN\8636g192.bsd OK
Date: 03/11/02, Time: 10:45:58 - Running BSDL-Compiler
BSDL-Syntax Checker Version 2.02
Goepel Electronic GmbH
Compile BSDL_IN\8636g192.bsd OK
…
5 Exit Codes and Error File
BSDLCHECKERGOEPEL.EXE returns an exit code for the BSDL verification task. Valid exit codes are
listed in Table 1 below.
Table 1: valid Exit Codes
Exit code
Description
0 Verification passed (BSDL syntax OK)
1 Verification failed (BSDL syntax error)
System error (no files selected, BSDL file missing, package file missing)
BSDL syntax errors are listed in a separate file named BSDERRGO.LOG, written into BSDL
SyntaxChecker installation directory.
GOEPEL Electronics ©2008 – 14 –