OPT3101Calibration.cpp

00001 /*!
00002 * \file OPT3101Calibration.cpp
00003 * \author  Karthik Rajagopal <krthik@ti.com>
00004 * \version 0.9.1
00005 *
00006 * \section COPYRIGHT
00007 * TEXAS INSTRUMENTS TEXT FILE LICENSE
00008 * Copyright (c) 2018 Texas Instruments Incorporated
00009 * All rights reserved not granted herein.
00010 * Limited License.
00011 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive license under copyrights and patents it now or hereafter owns or controls to make, have made, use, import, offer to sell and sell ("Utilize") this software subject to the terms herein.  With respect to the foregoing patent license, such license is granted  solely to the extent that any such patent is necessary to Utilize the software alone.  The patent license shall not apply to any combinations which include this software, other than combinations with devices manufactured by or for TI ("TI Devices").  No hardware patent is licensed hereunder.
00012 * Redistributions must preserve existing copyright notices and reproduce this license (including the above copyright notice and the disclaimer and (if applicable) source code license limitations below) in the documentation and/or other materials provided with the distribution
00013 * Redistribution and use in binary form, without modification, are permitted provided that the following conditions are met:
00014 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any software provided in binary form.
00015 * * any redistribution and use are licensed by TI for use only with TI Devices.
00016 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
00017 * If software source code is provided to you, modification and redistribution of the source code are permitted provided that the following conditions are met:
00018 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by TI for use only with TI Devices.
00019 * * any redistribution and use of any object code compiled from the source code and any resulting derivative works, are licensed by TI for use only with TI Devices.
00020 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or promote products derived from this software without specific prior written permission.
00021 * DISCLAIMER.
00022 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00023 *
00024 * \section DESCRIPTION
00025 * This file contains the method definitions for class OPT3101::calibrationC
00026 */
00027 
00028 #include "OPT3101Calibration.h "
00029 #include <stdlib.h>
00030 
00031 void OPT3101::calibrationC::findCrosstalkTempRegisterValues(OPT3101::crosstalkTempCoffC *illumXtalkCoff, bool *txActiveList,bool *registerSetActiveList, OPT3101::crosstalkC *illumXtalk) {
00032     uint8_t c0,c1,scaleCoff;
00033     double maxCoff = -1;
00034     double magnitude[3][2];
00035 
00036     for (c0 = 0; c0 < 3; c0++) {
00037         for (c1 = 0; c1 < 2; c1++) {
00038             if(txActiveList[c0] && registerSetActiveList[c1]){
00039                 magnitude[c0][c1] = illumXtalk[(c0<<1)+c1].magnitude();
00040                 maxCoff = abs(illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1]) > maxCoff ? abs(illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1]) : maxCoff;
00041                 maxCoff = abs(illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1]) > maxCoff ? abs(illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1]) : maxCoff;
00042             }
00043         }
00044     }
00045     scaleCoff = 7;
00046     for (c0 = 12; c0 >= 5; c0--)
00047         scaleCoff = maxCoff < (1 << (c0)) ? (12 - c0) : scaleCoff;
00048 
00049     for (c0 = 0; c0 < 3; c0++) {
00050         for (c1 = 0; c1 < 2; c1++) {
00051             if(txActiveList[c0] && registerSetActiveList[c1]){
00052                 if (scaleCoff >= 5) {
00053                     illumXtalkCoff[(c0<<1)+c1].coffIReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1])*(1 << (scaleCoff - 5)));
00054                     illumXtalkCoff[(c0<<1)+c1].coffQReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1])*(1 << (scaleCoff - 5)));
00055                 }
00056                 else {
00057                     illumXtalkCoff[(c0<<1)+c1].coffIReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffI*magnitude[c0][c1]) / (1 << (5 - scaleCoff)));
00058                     illumXtalkCoff[(c0<<1)+c1].coffQReg = (uint8_t)((illumXtalkCoff[(c0<<1)+c1].coffQ*magnitude[c0][c1]) / (1 << (5 - scaleCoff)));
00059                 }
00060                 illumXtalkCoff[(c0<<1)+c1].commonScale = scaleCoff;
00061             }
00062         }
00063     }
00064 }
00065 
00066 void OPT3101::calibrationC::findPhaseTempRegisterValues(OPT3101::phaseTempCoffC* phaseTempCoff, bool *txActiveList,bool *registerSetActiveList, uint16_t freqCount) {
00067     uint8_t scaleCoff;
00068     uint8_t c1;
00069     int8_t c0;
00070     double maxCoff = -1;
00071     /// <b>Algorithm of the method is as follows</b>
00072     for (c0 = 0; c0 < 3; c0++) {
00073         for (c1 = 0; c1 < 2; c1++) {
00074             if(txActiveList[c0] && registerSetActiveList[c1])
00075                 maxCoff = abs(phaseTempCoff[(c0<<1)+c1].coff) > maxCoff ? abs(phaseTempCoff[(c0<<1)+c1].coff) : maxCoff; ///* Identifies max of absolute of OPT3101::phaseTempCoffC::coff values
00076         }
00077     }
00078     maxCoff *= 16384.0 / freqCount; ///* scales the max coefficient with input frequencyCount
00079                                   // 3200 
00080     scaleCoff = 0;
00081     for (c0 = 7; c0 >= 0; c0--)
00082         scaleCoff = (maxCoff*(1 << (10 - c0))) < (1 << 11) ? c0 : scaleCoff; ///* Finds a OPT3101::phaseTempCoffC::commonScale which can fit the OPT3101::phaseTempCoffC::coff to 12 bit registers
00083     for (c0 = 0; c0 < 3; c0++) {
00084         for (c1 = 0; c1 < 2; c1++) {
00085             if(txActiveList[c0] && registerSetActiveList[c1]){
00086                 phaseTempCoff[(c0<<1)+c1].coffReg = ((int16_t)(16384.0 / freqCount * phaseTempCoff[(c0<<1)+c1].coff*(1 << (10 - scaleCoff)))) & 0xFFF;///* Finds OPT3101::phaseTempCoffC::coffReg values (12 bit register values) based on OPT3101::phaseTempCoffC::coff and OPT3101::phaseTempCoffC::commonScale
00087                 phaseTempCoff[(c0<<1)+c1].commonScale = scaleCoff;
00088             }
00089         }
00090     }
00091 }
00092 
00093 void OPT3101::calibrationC::report()
00094 {
00095     /// <b>Algorithm of the method is as follows</b>
00096     host.printf("------------------------\r\n");
00097     host.printf("Calibration Class Report\r\n");
00098     host.printf("------------------------\r\n"); ///* Prints all the members and values of members on screen.
00099     this->internalCrosstalk[0].report();
00100     host.printf("EEPROM_connected=%d\r\n", this->EEPROM_connected);
00101     host.printf("extTempSensor_connected=%d\r\n", this->extTempSensor_connected);
00102     host.printf("------------------------\r\n");
00103 }
00104