sdfm_drv.h

Go to the documentation of this file.

/*
 * Copyright (C) 2023 Texas Instruments Incorporated - https://www.ti.com/
 *
 *
 * 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 _SDFM_DRV_H_
#define _SDFM_DRV_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <drivers/soc.h>
#include <drivers/pruicss.h>
#include <pruicss_pwm/include/pruicss_pwm.h>
#include  <math.h>
 
 
/* ========================================================================== */
/*                           Macros                                           */
/* ========================================================================== */
 
 
#define DEF_SD_CH_CTRL_CH_EN        ( 0 )       /* default all chs disabled */
#define BF_CH_EN_MASK               ( 0x1 )
#define SDFM_CH_CTRL_CH_EN_BF_CH0_EN_SHIFT   ( 0 )
#define SDFM_CH_CTRL_CH_EN_BF_CH0_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH0_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH1_EN_SHIFT   ( 1 )
#define SDFM_CH_CTRL_CH_EN_BF_CH1_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH1_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH2_EN_SHIFT   ( 2 )
#define SDFM_CH_CTRL_CH_EN_BF_CH2_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH2_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH3_EN_SHIFT   ( 3 )
#define SDFM_CH_CTRL_CH_EN_BF_CH3_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH3_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH4_EN_SHIFT   ( 4 )
#define SDFM_CH_CTRL_CH_EN_BF_CH4_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH4_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH5_EN_SHIFT   ( 5 )
#define SDFM_CH_CTRL_CH_EN_BF_CH5_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH5_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH6_EN_SHIFT   ( 6 )
#define SDFM_CH_CTRL_CH_EN_BF_CH6_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH6_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH7_EN_SHIFT   ( 7 )
#define SDFM_CH_CTRL_CH_EN_BF_CH7_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH7_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH8_EN_SHIFT   ( 8 )
#define SDFM_CH_CTRL_CH_EN_BF_CH8_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH8_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_BF_CH9_EN_SHIFT   ( 9 )
#define SDFM_CH_CTRL_CH_EN_BF_CH9_EN_MASK    ( BF_CH_EN_MASK << SDFM_CH_CTRL_CH_EN_BF_CH9_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_SHIFT             ( SDFM_CH_CTRL_CH_EN_BF_CH0_EN_SHIFT )
#define SDFM_CH_CTRL_CH_EN_MASK \
    ( SDFM_CH_CTRL_CH_EN_BF_CH0_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH1_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH2_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH3_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH4_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH5_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH6_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH7_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH8_EN_MASK | \
      SDFM_CH_CTRL_CH_EN_BF_CH9_EN_MASK )
 
#define SDFM_MAIN_FILTER_MASK    ( 1 )
#define SDFM_MAIN_FILTER_SHIFT          ( 0 )
 
#define SDFM_MAIN_INTERRUPT_MASK     ( 1 )
#define SDFM_MAIN_INTERRUPT_SHIFT           ( 1 )
 
#define SDFM_RECFG_REINIT               ( SDFM_RECFG_BF_RECFG_REINIT_MASK )
 
#define SDFM_RECFG_CLK                  ( SDFM_RECFG_BF_RECFG_CLK_MASK )
 
#define SDFM_RECFG_OSR                  ( SDFM_RECFG_BF_RECFG_OSR_MASK )
 
#define SDFM_RECFG_TRIG_SAMP_TIME       ( SDFM_RECFG_BF_RECFG_TRIG_SAMPLE_TIME_MASK )
 
#define SDFM_RECFG_TRIG_SAMP_CNT        ( SDFM_RECFG_BF_RECFG_TRIG_SAMPLE_CNT_MASK )
 
#define SDFM_RECFG_CH_EN                ( 1<<6 )
 
#define SDFM_RECFG_FD                   ( SDFM_RECFG_BF_RECFG_FD_MASK )
 
#define SDFM_RECFG_TRIG_OUT_SAMP_BUF    ( SDFM_RECFG_BF_RECFG_TRIG_OUT_SAMP_BUF_MASK )
 
#define IEP_DEFAULT_INC                 0x1
 
 
 
/* SDFM output buffer size in 32-bit words */
#define ICSSG_SD_SAMP_CH_BUF_SZ          ( 128 )
#define NUM_CH_SUPPORTED_PER_AXIS        ( 3 )
#define SDFM_NINE_CH_MASK                ( 0x1FF )
#define SDFM_CH_MASK_FOR_CH0_CH3_CH6     ( 0x49 )
#define SDFM_CH_MASK_FOR_CH1_CH4_CH7     ( 0x92 )
#define SDFM_CH_MASK_FOR_CH2_CH5_CH8     ( 0x124 )
 
/*SDFM Channel IDs*/
#define SDFM_CHANNEL0    (0)
#define SDFM_CHANNEL1    (1)
#define SDFM_CHANNEL2    (2)
#define SDFM_CHANNEL3    (3)
#define SDFM_CHANNEL4    (4)
#define SDFM_CHANNEL5    (5)
#define SDFM_CHANNEL6    (6)
#define SDFM_CHANNEL7    (7)
#define SDFM_CHANNEL8    (8)
 
/*SDFM firmware version mask*/
#define SDFM_FW_VERSION_BIT_SHIFT       (32)
 
/*Fast detect ERROR mask*/
#define SDFM_FD_ERROR_MASK_FOR_TRIP_VEC      ( 0x3800000 )
 
#define SDFM_PHASE_DELAY_ACK_BIT_MASK   (1)
#define SDFM_PHASE_DELAY_CAL_LOOP_SIZE  (8)
 
#define SDFM_IEP_CMP1_EN_SHIFT     (2)
#define SDFM_IEP_CMP2_EN_SHIFT     (3)
 
/* ========================================================================== */
/*                         Structures                                         */
/* ========================================================================== */
 
typedef struct SDFM_CfgSdClk_s
{
    volatile uint8_t  sd_prd_clocks;
    volatile uint8_t  sd_clk_inv;
} SDFM_CfgSdClk;
 
typedef struct SDFM_CfgTrigger_s
{
    volatile  uint8_t  en_continuous_mode;
    volatile uint8_t    en_double_nc_sampling;
    volatile uint32_t first_samp_trig_time;
    volatile uint32_t second_samp_trig_time;
    volatile uint32_t nc_prd_iep_cnt;
} SDFM_CfgTrigger;
 
typedef struct SDFM_CfgIep_s
{
    volatile uint8_t iep_inc_value;
 
    volatile  uint32_t  cnt_epwm_prd;
 
}SDFM_CfgIep;
 
 
typedef struct SDFM_GpioParams_s{
    volatile uint32_t write_val;
    volatile uint32_t set_val_addr;
    volatile uint32_t clr_val_addr;
} SDFM_GpioParams;
 
typedef struct SDFM_ChCtrl_s
{
    volatile uint32_t    sdfm_ch_id;
    volatile uint16_t    enable_comparator;
    volatile uint8_t    enFastDetect;
    volatile uint8_t    en_phase_delay;
     volatile uint16_t   clock_phase_delay;
    volatile uint16_t    clock_edge;
 
} SDFM_ChCtrl;
 
typedef struct SDFM_ClkSourceParms_s
{
    volatile uint32_t clk_source;
    volatile uint8_t  clk_inv;
}SDFM_ClkSourceParms;
 
typedef struct SDFM_ThresholdParms_s
{
    volatile uint32_t    high_threshold;
    volatile uint32_t    low_threshold;
    volatile uint8_t     highThStatus;
    volatile uint8_t     lowThStatus;
    volatile uint8_t    zeroCrossEn;
    volatile uint8_t    zeroCrossThstatus;
    volatile uint32_t    zeroCrossTh;
}SDFM_ThresholdParms;
 
typedef struct SDFM_Cfg_s
{
    volatile uint8_t   ch_id;
    volatile uint8_t    filter_type;
    volatile uint8_t    osr;
    SDFM_ThresholdParms  sdfm_threshold_parms;
    volatile uint8_t   fd_window;
    volatile uint8_t   fd_zero_max;
    volatile uint8_t   fd_zero_min;
    volatile uint8_t   fd_one_max;
    volatile uint8_t   fd_one_min;
    SDFM_ClkSourceParms  sdfm_clk_parms;
    SDFM_GpioParams        sdfm_gpio_params;
} SDFM_Cfg;
 
typedef struct SDFM_Ctrl_s
{
    volatile uint8_t sdfm_en;
    volatile uint8_t  sdfm_en_ack;
    volatile uint8_t  sdfm_pru_id;
} SDFM_Ctrl;
 
typedef struct SDFM_Interface_s{
    SDFM_Ctrl       sdfm_ctrl;
    SDFM_CfgIep    sdfm_cfg_iep_ptr;
    SDFM_CfgSdClk     sd_clk;
    SDFM_ChCtrl    sdfm_ch_ctrl;
    SDFM_Cfg        sdfm_cfg_ptr[NUM_CH_SUPPORTED_PER_AXIS];
    /*<sdfm time sampling interface pointer */
    SDFM_CfgTrigger    sdfm_cfg_trigger;
    volatile uint32_t   sampleBufferBaseAdd;
    volatile uint64_t  firmwareVersion;
}SDFM_Interface;
 
typedef struct SDFM_SampleOutInterface_s
{
   uint32_t sampleOutput[NUM_CH_SUPPORTED_PER_AXIS];
}SDFM_SampleOutInterface;
typedef struct SDFM_s {
    PRUICSS_Handle gPruIcssHandle;
    PRUICSS_PWM_Handle gPruPwmHandle;
    uint8_t pruId;
    uint32_t sdfmClock;
    uint32_t iepClock;
    uint32_t pruCoreClk;
    uint8_t  iepInc;
    SDFM_Interface * pSdfmInterface;
    SDFM_SampleOutInterface *sampleOutputInterface;
    void *pruicssCfg;
    void *pruicssIep;
    void *pruicssEcap;
} SDFM;
 
 
#include "sdfm_api.h"
 
#ifdef __cplusplus
}
#endif
 
#endif