sdfm_api.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_API_H_
#define _SDFM_API_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include "../firmware/icssg_sdfm.h"
#include <current_sense/sdfm/include/sdfm_drv.h>
#include <drivers/pruicss.h>
 
/* Number of ICSSG PRUs */
#define NUM_PRU     ( 2 )
 
/* PRU IDs */
#define PRU_ID_0    ( 0 )   /* PRU 0 ID */
#define PRU_ID_1    ( 1 )   /* PRU 1 ID */
 
#define PRUx_DMEM_BASE_ADD     (0x00)
#define RTUx_DMEM_BASE_ADD     (0x200)
#define TXPRUx_DMEM_BASE_ADD   (0x400)
/* Number of SD channels */
#define NUM_SD_CH   ( ICSSG_NUM_SD_CH )
/* ICSSG INTC event */
#define SDFM_EVT    ( TRIGGER_HOST_SDFM_EVT )
 
/* SDFM handle */
typedef SDFM *sdfm_handle;
 
sdfm_handle SDFM_init(uint8_t pru_id, uint8_t coreId);
 
void SDFM_configIepCount(sdfm_handle h_sdfm, uint32_t epwm_out_freq);
 
void SDFM_configEcap(sdfm_handle h_sdfm, uint8_t ecap_divider);
 
void SDFM_setEnableChannel(sdfm_handle h_sdfm, uint8_t channel_number);
 
void SDFM_setCompFilterOverSamplingRatio(sdfm_handle h_sdfm, uint8_t ch_id, uint16_t osr);
 
void SDFM_enable(sdfm_handle h_sdfm);
 
void SDFM_setCompFilterThresholds(sdfm_handle h_sdfm, uint8_t ch_id, SDFM_ThresholdParms thresholdParms);
 
void SDFM_setSampleTriggerTime(sdfm_handle h_sdfm, float samp_trig_time);
 
void SDFM_enableDoubleSampling(sdfm_handle h_sdfm, float samp_trig_time);
 
void SDFM_disableDoubleSampling(sdfm_handle h_sdfm);
 
 
void SDFM_configDataFilter(sdfm_handle h_sdfm, uint8_t ch_id, uint8_t filter);
 
void SDFM_selectClockSource(sdfm_handle h_sdfm, uint8_t ch_id, SDFM_ClkSourceParms clkPrams);
 
void SDFM_enableComparator(sdfm_handle h_sdfm, uint8_t ch);
 
void SDFM_disableComparator(sdfm_handle h_sdfm, uint8_t ch);
 
void SDFM_configComparatorGpioPins(sdfm_handle h_sdfm, uint8_t ch,uint32_t gpio_base_addr, uint32_t pin_number);
 
uint32_t SDFM_getFilterData(sdfm_handle h_sdfm,uint8_t ch);
void SDFM_setFilterOverSamplingRatio(sdfm_handle h_sdfm, uint16_t nc_osr);
uint32_t SDFM_getFirmwareVersion(sdfm_handle h_sdfm);
 
void SDFM_configFastDetect(sdfm_handle h_sdfm, uint8_t ch, uint8_t *fdParms);
 
int32_t SDFM_getFastDetectErrorStatus(sdfm_handle h_sdfm, uint8_t chNum);
 
int32_t SDFM_clearPwmTripStatus(sdfm_handle h_sdfm, uint8_t chNum);
 
void SDFM_enableContinuousNormalCurrent(sdfm_handle h_sdfm);
 
void SDFM_enableLoadShareMode(sdfm_handle h_sdfm, uint8_t sliceId);
 
void SDFM_measureClockPhaseDelay(sdfm_handle h_sdfm, uint16_t clEdg);
 
float SDFM_getClockPhaseDelay(sdfm_handle h_sdfm);
uint8_t SDFM_getLowThresholdStatus(sdfm_handle h_sdfm, uint8_t chNum);
 
uint8_t SDFM_getHighThresholdStatus(sdfm_handle h_sdfm, uint8_t chNum);
 
int32_t SDFM_clearOverCurrentError(sdfm_handle h_sdfm, uint8_t chNum);
 
void SDFM_enableZeroCrossDetection(sdfm_handle h_sdfm, uint8_t chNum, uint32_t zcThr);
 
uint8_t SDFM_getZeroCrossThresholdStatus(sdfm_handle h_sdfm, uint8_t chNum);
 
void SDFM_disableZeroCrossDetection(sdfm_handle h_sdfm, uint8_t chNum);
#ifdef __cplusplus
}
#endif
 
#endif