sfra_f32.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 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.
 */
//###########################################################################
//
// FILE:   sfra_f32.h
//
//#############################################################################
 
 
#ifndef SFRA_F32_H
#define SFRA_F32_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
//
// the includes & defines
//
 
#ifndef IEEE754_TYPES
#define IEEE754_TYPES
 
typedef float float32_t;
typedef double float64_t;
 
#endif //IEEE754_TYPES
 
#include <stdint.h>
#include <stdlib.h>
#include <stddef.h>
#include <math.h>
 
 
 
typedef struct{
    float32_t *h_magVect;     
    float32_t *h_phaseVect;   
    float32_t *gh_magVect;    
    float32_t *gh_phaseVect;  
    float32_t *cl_magVect;    
    float32_t *cl_phaseVect;  
    float32_t *freqVect;      
    float32_t amplitude;      
    float32_t isrFreq;        
    float32_t freqStart;      
    float32_t freqStep;       
    int16_t start;            
    int16_t state;            
    int16_t status;           
    int16_t vecLength;        
    int16_t freqIndex;        
    int16_t storeH;           
    int16_t storeGH;          
    int16_t storeCL;          
    int16_t speed;            
}SFRA_F32;
 
extern void SFRA_F32_reset(SFRA_F32 *SFRA_F_obj);
 
extern void SFRA_F32_config(SFRA_F32 *SFRA_F_obj,
                     float32_t isrFrequency,
                     float32_t injectionAmplitude,
                     int16_t noFreqPoints,
                     float32_t fraSweepStartFreq,
                     float32_t freqStep,
                     float32_t *h_magVect,
                     float32_t *h_phaseVect,
                     float32_t *gh_magVect,
                     float32_t *gh_phaseVect,
                     float32_t *cl_magVect,
                     float32_t *cl_phaseVect,
                     float32_t *freqVect,
                     int16_t speed);
 
extern void SFRA_F32_initFreqArrayWithLogSteps(SFRA_F32 *SFRA_F_obj,
                                        float32_t fra_sweep_start_freq,
                                        float32_t freqStep);
 
extern void SFRA_F32_resetFreqRespArray(SFRA_F32 *SFRA_F_obj);
 
extern void SFRA_F32_updateInjectionAmplitude(SFRA_F32 *SFRA_F_obj,
                                       float32_t new_injection_amplitude);
 
extern float SFRA_F32_inject(float ref);
 
extern void SFRA_F32_collect(float *control_output, float *feedback);
 
extern void SFRA_F32_runBackgroundTask(SFRA_F32 *SFRA_F_obj);
 
// Close the Doxygen group.
#ifdef __cplusplus
}
#endif // extern "C"
 
#endif // end of SFRA_F32_H definition