/* --COPYRIGHT--,BSD
 * Copyright (c) 2012, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR
 * CONTRIBUTORS 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.
 * --/COPYRIGHT--*/
//! \file   ~/sw/modules/angle_comp/src/float/angle_comp.c
//! \brief  Contains the public interface to the angle compensation
//! \brief  generator (ANGLE_COMP)
//!         module routines
//!
//! (C) Copyright 2015, Texas Instruments, Inc.


// **************************************************************************
// the includes
#include "sw/modules/angle_comp/src/32b/angle_comp.h"


extern ANGLE_COMP_Handle ANGLE_COMP_init(void *pMemory,const size_t numBytes)
{
  ANGLE_COMP_Handle handle;

  if(numBytes < sizeof(ANGLE_COMP_Obj))
    return((ANGLE_COMP_Handle)NULL);

  // assign the handle
  handle = (ANGLE_COMP_Handle)pMemory;

  return(handle);
} // end of ANGLE_COMP_init() function


extern void ANGLE_COMP_setParams(ANGLE_COMP_Handle handle,
                            float_t iqFullScaleFreq_Hz,
                            float_t pwmPeriod_usec,
                            uint_least16_t numPwmTicksPerIsrTick)
{
  ANGLE_COMP_Obj *obj = (ANGLE_COMP_Obj *)handle;
  float_t pwmPeriod_s = 1.0e-6 * pwmPeriod_usec;
  
  
  obj->angleDeltaFactor = _IQ(iqFullScaleFreq_Hz * pwmPeriod_s);
  obj->angleCompFactor = _IQ(1.0 + (float_t)numPwmTicksPerIsrTick * 0.5);

  return;
} // end of ANGLE_COMP_setParams() function


