/*
 * Copyright (c) 2018, Linz Center of Mechatronics GmbH (LCM), web: www.lcm.at
 * All rights reserved.
 */
/*
 * This file is licensed according to the BSD 3-clause license as follows:
 * 
 * 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 the "Linz Center of Mechatronics GmbH" and "LCM" 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 "Linz Center of Mechatronics GmbH" 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.
 */
/*
 * This file is part of X2C. web: x2c.lcm.at
 * $LastChangedRevision: 3674 $
 * $LastChangedDate:: 2025-03-07 12:00:30 +0100#$
 */
/* USERCODE-BEGIN:Description                                                                                         */
/* Description: */
/* USERCODE-END:Description                                                                                           */
#include <string.h>
#include "ConvFnc_AdaptiveNotch_FiP16.h"

/* USERCODE-BEGIN:PreProcessor                                                                                        */
#include <math.h>
/* USERCODE-END:PreProcessor                                                                                          */

extern uint8 MaskParamBuffer[];
extern uint8 ImplParamBuffer[];
extern uint8 SaveFncDataBuffer[];

/** Implementation parameter data structure */
typedef struct {
    int16 n_thresh;
    int16 a_fact;
    int16 b_fact;
    int16 c_fact;
    uint8 sfrA;
} ADAPTIVENOTCH_FIP16_IMPL_PARAM;

/** method enumeration */
typedef enum {
    METHOD_MATCHED_ZMTRANSFORM = 0
} tmethod;

/** Private prototypes */
static uint8 convertM2I(const ADAPTIVENOTCH_FIP16_MASK_PARAM *maskParam, ADAPTIVENOTCH_FIP16_IMPL_PARAM *impParam, float_CoT ts);

/**
 * @brief Converts Mask parameters to Implementation parameters.
 *
 * @param[in] maskParam Mask parameters
 * @param[out] impParam Implementation parameters
 * @param[in] ts Block sample time
 *
 * @return Error: zero on success, not zero in case of conversion error
 */
static uint8 convertM2I(const ADAPTIVENOTCH_FIP16_MASK_PARAM *maskParam, ADAPTIVENOTCH_FIP16_IMPL_PARAM *impParam, float_CoT ts)
{
    uint8 error = 0u;
/* USERCODE-BEGIN:Conversion                                                                                          */
    #define BITS 16

    /* get mask parameter values */
    float_CoT n_thresh = maskParam->n_thresh;           /* speed threshold */
    float_CoT p = maskParam->p;                         /* number of pole pairs */
    float_CoT Q = maskParam->Q;                         /* Q-factor */
    float_CoT n_max = getAbsValR64(maskParam->n_max);   /* speed scaling */

    /* validation */
    if (p < 1) {
        error += 1; /* Number of pole pairs must not be smaller than one! */
    }
    if (n_thresh <= 0) {
        error += 2; /* Speed threshold must be greater than zero! */
    }
    if (Q < (float_CoT)0.5) {
        error += 4; /* Q-factor must not be smaller than 0.5! (to prevent complex multiplication factors) */
    }
    if ((((2 * n_max) / 60) * p) > (1 / ts)) {
        error += 8; /* Nyquist criteria is violated -> decrease n_max or Ts*ts_fact! */
    }
    
    /* calculate multiplication factors for filter coefficients */
    if (error == 0)
    {    
        float_CoT a_fact = ((((-2 * (float_CoT)PI_R64) / 60) * p) / 2 / Q) * ts;
        float_CoT b_fact = ((((-2 * (float_CoT)PI_R64) / 60) * p) / 2 / Q) * ts * sqrt((4 * Q * Q) - 1);
        float_CoT c_fact = ((2 * (float_CoT)PI_R64) / 60) * p * ts;

        int8 sfrA = getQFormat(a_fact, BITS);
        /* B and C factors are always smaller than 1 -> no shift factor calculation needed */
        
        /* set implementation parameter values */
        impParam->n_thresh = getQx16Value(n_thresh / n_max, BITS - 1);
        impParam->sfrA = sfrA;
        impParam->a_fact = getQx16Value(a_fact, sfrA);
        impParam->b_fact = getQx16Value(b_fact, BITS - 1);
        impParam->c_fact = getQx16Value(c_fact, BITS - 1);
    }
/* USERCODE-END:Conversion                                                                                            */
    return (error);
}

/**
 * @brief Load block mask parameter data.
 *
 * @param[in] maskParam Mask parameter data structure
 * @param[out] data Data
 * @param[out] dataLen Data length
 * @param[in] maxSize Maximum Service data length
 *
 * @return Error: zero on success, not zero in case of load- or conversion error
 */
uint8 AdaptiveNotch_FiP16_LoadMP(const ADAPTIVENOTCH_FIP16_MASK_PARAM *maskParam, uint8 data[], uint16* dataLen, uint16 maxSize)
{
    uint8 error = 0u;
    if (maxSize < 41u)
    {
        error = 1u;
    }
    else
    {
        data[0] = (uint8)((*(uint64*)&(maskParam->Q)) & 0xFFu);
        data[1] = (uint8)((*(uint64*)&(maskParam->Q) >> 8) & 0xFFu);
        data[2] = (uint8)((*(uint64*)&(maskParam->Q) >> 16) & 0xFFu);
        data[3] = (uint8)((*(uint64*)&(maskParam->Q) >> 24) & 0xFFu);
        data[4] = (uint8)((*(uint64*)&(maskParam->Q) >> 32) & 0xFFu);
        data[5] = (uint8)((*(uint64*)&(maskParam->Q) >> 40) & 0xFFu);
        data[6] = (uint8)((*(uint64*)&(maskParam->Q) >> 48) & 0xFFu);
        data[7] = (uint8)((*(uint64*)&(maskParam->Q) >> 56) & 0xFFu);
        data[8] = (uint8)((*(uint64*)&(maskParam->n_thresh)) & 0xFFu);
        data[9] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 8) & 0xFFu);
        data[10] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 16) & 0xFFu);
        data[11] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 24) & 0xFFu);
        data[12] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 32) & 0xFFu);
        data[13] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 40) & 0xFFu);
        data[14] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 48) & 0xFFu);
        data[15] = (uint8)((*(uint64*)&(maskParam->n_thresh) >> 56) & 0xFFu);
        data[16] = (uint8)((*(uint64*)&(maskParam->n_max)) & 0xFFu);
        data[17] = (uint8)((*(uint64*)&(maskParam->n_max) >> 8) & 0xFFu);
        data[18] = (uint8)((*(uint64*)&(maskParam->n_max) >> 16) & 0xFFu);
        data[19] = (uint8)((*(uint64*)&(maskParam->n_max) >> 24) & 0xFFu);
        data[20] = (uint8)((*(uint64*)&(maskParam->n_max) >> 32) & 0xFFu);
        data[21] = (uint8)((*(uint64*)&(maskParam->n_max) >> 40) & 0xFFu);
        data[22] = (uint8)((*(uint64*)&(maskParam->n_max) >> 48) & 0xFFu);
        data[23] = (uint8)((*(uint64*)&(maskParam->n_max) >> 56) & 0xFFu);
        data[24] = (uint8)((*(uint64*)&(maskParam->p)) & 0xFFu);
        data[25] = (uint8)((*(uint64*)&(maskParam->p) >> 8) & 0xFFu);
        data[26] = (uint8)((*(uint64*)&(maskParam->p) >> 16) & 0xFFu);
        data[27] = (uint8)((*(uint64*)&(maskParam->p) >> 24) & 0xFFu);
        data[28] = (uint8)((*(uint64*)&(maskParam->p) >> 32) & 0xFFu);
        data[29] = (uint8)((*(uint64*)&(maskParam->p) >> 40) & 0xFFu);
        data[30] = (uint8)((*(uint64*)&(maskParam->p) >> 48) & 0xFFu);
        data[31] = (uint8)((*(uint64*)&(maskParam->p) >> 56) & 0xFFu);
        data[32] = (uint8)((*(uint64*)&(maskParam->ts_fact)) & 0xFFu);
        data[33] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 8) & 0xFFu);
        data[34] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 16) & 0xFFu);
        data[35] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 24) & 0xFFu);
        data[36] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 32) & 0xFFu);
        data[37] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 40) & 0xFFu);
        data[38] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 48) & 0xFFu);
        data[39] = (uint8)((*(uint64*)&(maskParam->ts_fact) >> 56) & 0xFFu);
        data[40] = (uint8)(maskParam->method);
        *dataLen = 41u;
    }
    return (error);
}

/**
 * @brief Save block mask parameter data.
 *
 * @param[in] block Pointer to block structure
 * @param[out] maskParam Mask parameter data structure
 * @param[in] data Data
 * @param dataLen Length of mask parameter data stream
 *
 * @return Error: zero on success, not zero in case of save- or conversion error
 */
uint8 AdaptiveNotch_FiP16_SaveMP(ADAPTIVENOTCH_FIP16 *block, ADAPTIVENOTCH_FIP16_MASK_PARAM *maskParam, const uint8 data[], uint16 dataLen)
{
    uint8 error = 0u;

    if (dataLen != 41u)
    {
        error = 1u;
    }
    else
    {
        uint64 tmp64;
        /** - Cache old mask parameters */
        AdaptiveNotch_FiP16_BackupMP(maskParam);

        /** - Save new mask parameters */
        tmp64 = (uint64)data[0] + \
            ((uint64)data[1] << 8) + ((uint64)data[2] << 16) + \
            ((uint64)data[3] << 24) + ((uint64)data[4] << 32) + \
            ((uint64)data[5] << 40) + ((uint64)data[6] << 48) + \
            ((uint64)data[7] << 56);
        maskParam->Q = (float64)(*(float64*)&tmp64);
        tmp64 = (uint64)data[8] + \
            ((uint64)data[9] << 8) + ((uint64)data[10] << 16) + \
            ((uint64)data[11] << 24) + ((uint64)data[12] << 32) + \
            ((uint64)data[13] << 40) + ((uint64)data[14] << 48) + \
            ((uint64)data[15] << 56);
        maskParam->n_thresh = (float64)(*(float64*)&tmp64);
        tmp64 = (uint64)data[16] + \
            ((uint64)data[17] << 8) + ((uint64)data[18] << 16) + \
            ((uint64)data[19] << 24) + ((uint64)data[20] << 32) + \
            ((uint64)data[21] << 40) + ((uint64)data[22] << 48) + \
            ((uint64)data[23] << 56);
        maskParam->n_max = (float64)(*(float64*)&tmp64);
        tmp64 = (uint64)data[24] + \
            ((uint64)data[25] << 8) + ((uint64)data[26] << 16) + \
            ((uint64)data[27] << 24) + ((uint64)data[28] << 32) + \
            ((uint64)data[29] << 40) + ((uint64)data[30] << 48) + \
            ((uint64)data[31] << 56);
        maskParam->p = (float64)(*(float64*)&tmp64);
        tmp64 = (uint64)data[32] + \
            ((uint64)data[33] << 8) + ((uint64)data[34] << 16) + \
            ((uint64)data[35] << 24) + ((uint64)data[36] << 32) + \
            ((uint64)data[37] << 40) + ((uint64)data[38] << 48) + \
            ((uint64)data[39] << 56);
        maskParam->ts_fact = (float64)(*(float64*)&tmp64);
        maskParam->method = data[40];

        error = AdaptiveNotch_FiP16_ConvertMP(block, maskParam);

        /** - Check for errors during execution of save function */
        if (error != 0u)
        {
            /* Restore old mask parameter */
            AdaptiveNotch_FiP16_RestoreMP(maskParam);
        }

    }
    return (error);
}

/**
 * @brief Initializes Implementation parameters from Mask parameters.
 *
 * @param[out] block Block
 * @param[in] maskParam Mask parameters
 *
 * @return Error: zero on success, not zero in case of initialization error
 */
uint8 AdaptiveNotch_FiP16_InitMP(ADAPTIVENOTCH_FIP16 *block, const ADAPTIVENOTCH_FIP16_MASK_PARAM *maskParam)
{
    uint8 error = 0u;
    float_CoT block_ts;

    ADAPTIVENOTCH_FIP16_IMPL_PARAM *implParam = (ADAPTIVENOTCH_FIP16_IMPL_PARAM*)ImplParamBuffer;

    /** - Get Block Sample Time */
    block_ts = maskParam->ts_fact * getModelSampleTime();
    /** - Convert mask parameters to implementation parameters */
    error = convertM2I(maskParam, implParam, block_ts);

    /** - Prepare implementation parameters for save function */
    SaveFncDataBuffer[0] = (uint8)((uint16)implParam->n_thresh & 0xFFu);
    SaveFncDataBuffer[1] = (uint8)(((uint16)implParam->n_thresh >> 8) & 0xFFu);
    SaveFncDataBuffer[2] = (uint8)((uint16)implParam->a_fact & 0xFFu);
    SaveFncDataBuffer[3] = (uint8)(((uint16)implParam->a_fact >> 8) & 0xFFu);
    SaveFncDataBuffer[4] = (uint8)((uint16)implParam->b_fact & 0xFFu);
    SaveFncDataBuffer[5] = (uint8)(((uint16)implParam->b_fact >> 8) & 0xFFu);
    SaveFncDataBuffer[6] = (uint8)((uint16)implParam->c_fact & 0xFFu);
    SaveFncDataBuffer[7] = (uint8)(((uint16)implParam->c_fact >> 8) & 0xFFu);
    SaveFncDataBuffer[8] = (uint8)(implParam->sfrA & 0xFFu);

    /** - Execute save function of block */
    error = AdaptiveNotch_FiP16_Save(block, SaveFncDataBuffer, 9);

    return (error);
}

/**
 * @brief Converts Mask parameters into Implementation parameters and executes Block Save function.
 *
 * @param[out] block Block Implementation
 * @param[in] maskParam Mask Parameters
 *
 * @return 0 if successful, greater than 0 if conversion failed
 */
uint8 AdaptiveNotch_FiP16_ConvertMP(ADAPTIVENOTCH_FIP16 *block, ADAPTIVENOTCH_FIP16_MASK_PARAM *maskParam)
{
    uint8 error;
    float_CoT block_ts;
    ADAPTIVENOTCH_FIP16_IMPL_PARAM *implParam = (ADAPTIVENOTCH_FIP16_IMPL_PARAM*)ImplParamBuffer;

    /** - Get Block Sample Time */
    block_ts = maskParam->ts_fact * getModelSampleTime();
    /** - Convert mask parameters to implementation parameters */
    error = convertM2I(maskParam, implParam, block_ts);
    if (error != 0u)
    {
        return (error);
    }

    /** - Prepare implementation parameters for save function */
    SaveFncDataBuffer[0] = (uint8)((uint16)implParam->n_thresh & 0xFFu);
    SaveFncDataBuffer[1] = (uint8)(((uint16)implParam->n_thresh >> 8) & 0xFFu);
    SaveFncDataBuffer[2] = (uint8)((uint16)implParam->a_fact & 0xFFu);
    SaveFncDataBuffer[3] = (uint8)(((uint16)implParam->a_fact >> 8) & 0xFFu);
    SaveFncDataBuffer[4] = (uint8)((uint16)implParam->b_fact & 0xFFu);
    SaveFncDataBuffer[5] = (uint8)(((uint16)implParam->b_fact >> 8) & 0xFFu);
    SaveFncDataBuffer[6] = (uint8)((uint16)implParam->c_fact & 0xFFu);
    SaveFncDataBuffer[7] = (uint8)(((uint16)implParam->c_fact >> 8) & 0xFFu);
    SaveFncDataBuffer[8] = (uint8)(implParam->sfrA & 0xFFu);

    /** - Execute save function of block */
    error = AdaptiveNotch_FiP16_Save(block, SaveFncDataBuffer, 9);

    return (error);
}

/**
 * @brief Backups current Mask parameters into global Mask parameter backup array.
 *
 * @param[in] maskParam Mask parameters
 *
 * @return Nothing
 */
void AdaptiveNotch_FiP16_BackupMP(ADAPTIVENOTCH_FIP16_MASK_PARAM* maskParam)
{
    memcpy(MaskParamBuffer, maskParam, sizeof(*maskParam));
}

/**
 * @brief Restores Mask parameters from global Mask parameter backup array.
 *
 * @param[out] maskParam Mask parameters
 *
 * @return Nothing
 */
void AdaptiveNotch_FiP16_RestoreMP(ADAPTIVENOTCH_FIP16_MASK_PARAM* maskParam)
{
    memcpy(maskParam, MaskParamBuffer, sizeof(*maskParam));
}
