calcratio.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2025 Texas Instruments Incorporated
 *
 *  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.
 */
 
#ifndef CALCRATIO_H
#define CALCRATIO_H
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <kernel/dpl/AddrTranslateP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
 #define CALCRATIO_MA1_LENGTH   (1024U)
 
 #define CALCRATIO_MA2_LENGTH   (128U)
 
/* ========================================================================== */
/*                             Structure Definitions                          */
/* ========================================================================== */
 
typedef struct
{
    float     fsi;
    float     fso;
    double  target_ratio;
    double  actual_ratio;
    double  movingAvg1Sum;
    double  capture_history[CALCRATIO_MA1_LENGTH];
    double *P2_capture_hist;
    double  movingAvg2Sum;
    double  capture2_history[CALCRATIO_MA2_LENGTH];
    double *P2_capture2_hist;
    uint32_t  movingAvg2Count;
    uint16_t  one_shot;
} CalcRatio_t;
 
/* ========================================================================== */
/*                      API Function Declarations                             */
/* ========================================================================== */
 
int32_t calcRatio_init(
    CalcRatio_t *calcRatioInstance,
    float sampleRateIn,
    float sampleRateOut
);
 
 
int32_t calcRatio_exec(CalcRatio_t *calcRatioInstance,double *Tx_Counter,double *Rx_Counter);
 
 
double calcRatio_getActualratio(CalcRatio_t *calcRatioInstance);
 
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef CALCRATIO_H_ */