calibrate.h

00001 /* Copyright (c) 2021 Analog Devices, Inc.  All rights reserved.
00002 
00003 Redistribution and use in source and binary forms, with or without modification,
00004 are permitted provided that the following conditions are met:
00005   - Redistributions of source code must retain the above copyright notice,
00006   this list of conditions and the following disclaimer.
00007   - Redistributions in binary form must reproduce the above copyright notice,
00008   this list of conditions and the following disclaimer in the documentation
00009   and/or other materials provided with the distribution.
00010   - Modified versions of the software must be conspicuously marked as such.
00011   - This software is licensed solely and exclusively for use with processors/products
00012   manufactured by or for Analog Devices, Inc.
00013   - This software may not be combined or merged with other code in any manner
00014   that would cause the software to become subject to terms and conditions which
00015   differ from those listed here.
00016   - Neither the name of Analog Devices, Inc. nor the names of its contributors
00017   may be used to endorse or promote products derived from this software without
00018   specific prior written permission.
00019   - The use of this software may or may not infringe the patent rights of one or
00020   more patent holders.  This license does not release you from the requirement
00021   that you obtain separate licenses from these patent holders to use this software.
00022 
00023 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND
00024 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00025 TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00026 NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
00027 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
00028 (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
00029 PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00030 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00031 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00032 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00033 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034 
00035 2021-01-10-7CBSD SLA
00036 */
00037 
00038 
00039 /**
00040  * @file:    calibrate.h
00041  * @brief:   This file contains  type definitions and function prototype
00042  *           for calibrate.cpp
00043  */
00044 
00045 #ifndef __CALIBRATE_H__
00046 #define __CALIBRATE_H__
00047 
00048 /*============= I N C L U D E S =============*/
00049 
00050 #include <stdint.h>
00051 
00052 /*============= D E F I N E S =============*/
00053 
00054 /**
00055  * @brief enumeration  for all calibration coeffs
00056  *
00057  */
00058 typedef enum
00059 {
00060     CAL_TYPE_NO_CAL = 0, /**< No Calibration */
00061     CAL_TYPE_OPEN,       /**< OPEN Calibration*/
00062     CAL_TYPE_SHORT,      /**< SHORT Calibration */
00063     CAL_TYPE_LOAD,       /**< LOAD Calibration  */
00064 } CAL_TYPE;
00065 
00066 
00067 /*============= F U N C T I O N  P R O T O T Y P E S =============*/
00068 
00069 /**
00070  * @details perform specified cal type calibration .
00071  * @param [in] calType - type of calibration
00072  * @param [in] stdR - load value for Rt/Load calibration
00073  * @param [in] stdX - load value for Xt/Load calibration
00074  * @return ADMX_LCR_STATUS_SUCCESS - Success
00075  *
00076  */
00077 int32_t Calibrate(CAL_TYPE calType, float stdR, float stdX);
00078 
00079 #endif /* __CALIBRATE_H__ */