Anritsu MT8852B User manual

Operation Manual
CombiTest
MT8852B Plug-In
DUT Control API Reference
Anritsu Company
490 Jarvis Drive
Morgan Hill, CA 95037-2809
USA
P/N: 13000-00368
Revision: A
Created: August 2011
Copyright 2011 Anritsu Company

WARRANTY
The Anritsu product(s) listed on the title page is warranted against defects in materials and
workmanship for one year from the date of shipment.
Anritsu’s obligation covers repairing or replacing products which prove to be defective during the
warranty period. Buyers shall prepay transportation charges for equipment returned to Anritsu
for warranty repairs. Obligation is limited to the original purchaser. Anritsu is not liable for
consequential damages.
LIMITATION OF WARRANTY
The foregoing warranty does not apply to Anritsu connectors that have failed due to normal wear.
Also, the warranty does not apply to defects resulting from improper or inadequate maintenance
by the Buyer, unauthorized modification or misuse, or operation outside of the environmental
specifications of the product. No other warranty is expressed or implied, and the remedies
provided herein are the Buyer’s sole and exclusive remedies.
DISCLAIMER OF WARRANTY
DISCLAIMER OF WARRANTIES. TO THE MAXIMUM EXTENT PERMITTED BY
APPLICABLE LAW, ANRITSU COMPANY AND ITS SUPPLIERS DISCLAIM ALL
WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE, WITH REGARD TO THE SOFTWARE PRODUCT. THE USER ASSUMES THE
ENTIRE RISK OF USING THE PROGRAM. ANY LIABILITY OF PROVIDER OR
MANUFACTURER WILL BE LIMITED EXCLUSIVELY TO PRODUCT REPLACEMENT.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL ANRITSU COMPANY OR ITS
SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR
CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF
BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE
USE OF OR INABILITY TO USE THE SOFTWARE PRODUCTS, EVEN IF ANRITSU
COMPANY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE
SOME STATES AND JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION
OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE
LIMITATION MAY NOT APPLY TO YOU.
TRADEMARK ACKNOWLEDGMENTS
Windows and Windows XP are registered trademarks of Microsoft Corporation.
Acrobat Reader is a registered trademark of Adobe Corporation.
NOTICE
Anritsu Company has prepared this manual for use by Anritsu Company personnel and customers
as a guide for the proper installation, operation and maintenance of Anritsu Company equipment
and computer programs. The drawings, specifications, and information contained herein are the
property of Anritsu Company, and any unauthorized use or disclosure of these drawings,
specifications, and information is prohibited; they shall not be reproduced, copied, or used in whole
or in part as the basis for manufacture or sale of the equipment or software programs without the
prior written consent of Anritsu Company.
UPDATES
Updates, if any, can be downloaded from the Documents area of the Anritsu web site at:
http://www.us.anritsu.com

CombiTest (API Reference) PN: 13000-00368 Rev. A Contents-1
Table of Contents
Chapter 1—Introduction
Chapter 2—API Reference
2-1 General. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
DLL_Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
DUT_BT_Support_Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
DUT_BT_Open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
DUT_BT_Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
DUT_Settings_File_Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
2-2 Calibration Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
DUT_BT_Cal_Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
DUT_BT_Cal_Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
DUT_BT_Get_Custom_Cal_Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
DUT_BT_Get_Custom_Cal_Config. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
DUT_BT_Custom_Cal_Result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Chapter 3—Bluetooth Calibration Sequence
3-1 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
3-2 Calibration Sequence Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Contents-2 PN: 13000-00368 Rev. A CombiTest (API Reference)
Table of Contents (Continued)

CombiTest (API Reference) PN: 13000-00368 Rev. A 1-1
Chapter 1 — Introduction
CombiTest with the MT8852B Plug-in facilitates production line testing of Bluetooth devices
using the MT8852B Bluetooth test set.
During calibration sequences the MT8852B Plug-in controls the DUT via an interface
supported through the DUT Control DLL.
This document details the API calls which must be supported by the DUT Control DLL in
order for the MT8852B Plug-in to fully control the DUT.
Figure 1-1. DUT Control Interface Structure

Introduction
1-2 PN: 13000-00368 Rev. A CombiTest (API Reference)

CombiTest (API Reference) PN: 13000-00368 Rev. A 2-1
Chapter 2 — API Reference
2-1 General
DLL_Info
DUT_BT_Support_Info
Description: The DLL_Info function is used to retrieve information about the DUT
Control DLL.
Prototype: Bool DLL_Info(char* Description, char* Part Number, char* Version
Number);
Parameters: Description: [out] pointer to the description string
Part Number: [out] pointer to the part number string
Version Number: [out] pointer to the version number string
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: None
Description: The DUT_BT_Support_Info function is used to retrieve information
about the supported direct mode Bluetooth capabilities of the DUT.
Prototype: Bool DUT_BT_Support_Info(unsigned long* SupportInfo);
Parameters: SupportInfo [out] bitmask where:
0 = No direct mode capabilities are supported.
1 = Vendor specific calibration is supported.
21- 231 = Reserved for future use.
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: The bitmask should be hard-coded within the control DLL according to
the capabilities of the chipset under control.

General API Reference
2-2 PN: 13000-00368 Rev. A CombiTest (API Reference)
DUT_BT_Open
DUT_BT_Close
DUT_Settings_File_Path
Description: The DUT_BT_Open function opens the control interface, performing
the required initialisation for Bluetooth testing.
Prototype: Bool DUT_BT_Open(void);
Parameters: None
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: This is the first function to be called before attempting any DUT
control for Bluetooth.
Description: The DUT_BT_Close function closes the control interface to the DUT,
performing the required clean-up and taking the DUT out of Bluetooth
test mode, if required.
Prototype: Bool DUT_BT_Close(void);
Parameters: None
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: This function should be called when Bluetooth testing is complete and
the DUT interface is no longer required.
Description: The DUT_Settings_File_Path function sets the file path to the external
Control Settings file before the device is initialized.
Prototype: Bool DUT_Settings_File_Path(char* FilePath, bool Set_nGet);
Parameters: FilePath: [in/out] Pointer specifying the full path to a settings file or a
location in memory to store the default path.
Set_nGet: [in] Determines whether a path is being set, or the default
path is being retrieved.
Return values: True
Remarks: The FilePath is limited to 200 bytes (ASCII Encoding).

API Reference Calibration Configuration
CombiTest (API Reference) PN: 13000-00368 Rev. A 2-3
2-2 Calibration Configuration
DUT_BT_Cal_Start
DUT_BT_Cal_Stop
DUT_BT_Get_Custom_Cal_Status
Description: This function starts the overall calibration process for Bluetooth.
Prototype: Bool DUT_BT_Cal_Start (void);
Parameters: None
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: None
Description: This function stops the overall calibration process allowing any de-
initialisation or cleaning up to be performed.
Prototype: Bool DUT_BT_Cal_Stop(void);
Parameters: None
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: None
Description: This function returns the current custom calibration status and status
message.
Prototype: Bool DUT_BT_Get_Custom_Cal_Status(unsigned long* calStatus,
char* statusMessage);
Parameters: calStatus: [out] Calibration status where:
0 = Running
1 = Stopped
2 = Error
3 = Complete
statusMessage: [out] Message for describing the current calibration
status to the user.
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: None

Calibration Configuration API Reference
2-4 PN: 13000-00368 Rev. A CombiTest (API Reference)
DUT_BT_Get_Custom_Cal_Config
DUT_BT_Custom_Cal_Result
Description: This function returns the custom calibration configuration used to
configure the MT8852B to take the required measurements.
Prototype: Bool DUT_BT_Get_Custom_Cal_Config(unsigned long* calType, int*
channel, unsigned long* modulationScheme, float *gateWidth);
Parameters: calType: [out] Calibration type where:
0 = No Measurement (e.g. internal calibration method)
1 = Power
2 = Frequency
channel: [out] Channel number (-2 - 98).
modulationScheme: [out] Modulation scheme where:
0 = Not applicable.
1 = PI/4.
2 = 8DPSK.
gateWidth: [out] Capture gate width in milliseconds (0.1 - 3.0).
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: The modulation scheme parameter is not currently used and is
reserved for future use.
Description: This function passes the measurement result back to the custom
calibration algorithms.
Prototype: Bool DUT_BT_Custom_Cal_Result(const float result);
Parameters: result: [in] Measurement result. This is dependant on the calibration
type.
Return values: If the function succeeds the return value is true.
If the function fails the return value is false.
Remarks: None