afe_config.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   afe_config.h
 *   @brief  Analog frontend header file
 *   @author Robert Budai (robert.budai@analog.com)
 ********************************************************************************
 * Copyright (c) 2024 Analog Devices, Inc.
 *
 * All rights reserved.
 *
 * 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 Analog Devices, Inc. nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *  - The use of this software may or may not infringe the patent rights
 *    of one or more patent holders.  This license does not release you
 *    from the requirement that you obtain separate licenses from these
 *    patent holders to use this software.
 *  - Use of the software either in source or binary form, must be run
 *    on or directly connected to an Analog Devices Inc. component.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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 __AFE_CONFIG_H__
#define __AFE_CONFIG_H__
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include "ade9430.h"
#include "adi_pqlib.h"
#include "common_data.h"
#include "no_os_util.h"
#include "status.h"
#include <stdint.h>
#include <string.h>
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define BITM_WFB_CFG_BURST_ALL_CHAN 0x00000000
 
#define BITM_WFB_CFG_WF_CAP_RESAMPLED_SEL 0x00000000
 
#define REG_WAVEFORM_FIRST_HALF_ADDRESS 0x801
 
#define REG_WAVEFORM_SECOND_HALF_ADDRESS 0xC01
 
#define BITM_ACCMODE_SELFREQ_50HZ 0x0
 
#define BITM_ACCMODE_SELFREQ_60HZ 0x0100
 
#define BITM_FREQ_VCONSEL_ICONSEL 0xFE0F
 
#define BITM_CONFIG0_PERIOD_AVG_CFG_AV8 0x00010000
 
#define BITM_CONFIG0_PERIOD_AVG_CFG_AV16 0x00020000
 
#define LP_SEL_APERIOD 0x0000
 
#define LP_SEL_BPERIOD 0x0008
 
#define LP_SEL_CPERIOD 0x0010
 
#define ZX_SEL_ZXVA 0x0000
 
#define ZX_SEL_ZXVB 0x0002
 
#define ZX_SEL_ZXVC 0x0004
 
#define SPI_TIMEOUT 100
 
typedef uint32_t AFE_OUTPUT_STATUS;
#define SPI_HEADER_SIZE 2
 
#define MAX_SPI_DATA_SIZE 4
 
#define SPI_16BIT_DATA_SIZE 2
 
#define SPI_32BIT_DATA_SIZE 4
 
#define MAX_SPI_BUFFER_SIZE SPI_HEADER_SIZE + MAX_SPI_DATA_SIZE
 
typedef enum {
    AFE_SPI_STATUS_DMA_IDLE,
    AFE_SPI_STATUS_DMA_RUNNING,
    AFE_SPI_STATUS_DMA_COMPLETED
} AFE_SPI_STATUS;
 
/******************************************************************************/
/************************ Functions Definitions *******************************/
/******************************************************************************/
 
int spi_device_init(void);
 
int config_wfb(void);
 
int reset_afe(void);
 
int afe_start(void);
 
int afe_init(void);
 
int afe_read_waveform(uint16_t *pData, uint16_t numSamples);
 
int afe_read_period(uint32_t *pPeriod, uint16_t numPeriods);
 
int afe_read_rms_one(uint32_t *pRMS, uint16_t numRMS);
 
int afe_read_rms_1012(uint32_t *pRMS, uint16_t numRMS);
 
int afe_read_angle(uint16_t *pAngle, uint16_t numAngles,
           uint16_t angleVolCur);
 
int afe_read_status_1(uint32_t *pSTATUS1);
 
int afe_read_status0(uint32_t *pSTATUS0);
 
void afe_wait_settling(uint32_t cycles);
 
int afe_read_version(uint32_t *pVersion);
 
int config_afe_irq(void);
 
int afe_set_acc_mode(uint16_t frequency, uint16_t vconsel,
             uint16_t iconsel);
 
int afe_set_ref_channel(uint16_t refChannel);
int afe_read_32bit_buff(uint16_t addr, uint16_t numSamples,
            uint32_t *pData);
 
int afe_read_16bit_buff(uint16_t addr, uint16_t numSamples,
            uint16_t *pData);
int afe_write_32bit_reg(uint16_t addr, uint32_t *pData);
 
int afe_write_16bit_reg(uint16_t addr, uint16_t *pData);
 
#endif /* __AFE_CONFIG_H__ */