MAXREFDES71# Code Documentation  V01.00
MAXREFDES71# 2-Channel Analog Input/Analog Output
 All Data Structures Files Functions Variables Macros Pages
axi_millbrae.c File Reference
#include "axi_millbrae.h"

Go to the source code of this file.

Functions

void AXI_MILLBRAE_Config_ADC (u32 BaseAddress, u32 Value)
 Config ADC.
 
void AXI_MILLBRAE_Config_DAC (u32 BaseAddress, u32 Value)
 Config DAC.
 
void AXI_MILLBRAE_Start_Conversion (u32 BaseAddress)
 Start ADC Conversion.
 
void AXI_MILLBRAE_Stop_Operation (u32 BaseAddress)
 Stop operation.
 
void AXI_MILLBRAE_Start_Replication (u32 BaseAddress)
 Start signal replication.
 
void AXI_MILLBRAE_Write_Timer_Reg (u32 BaseAddress, u32 Value)
 Write Value to the Timer register.
 
void AXI_MILLBRAE_Interrupt_Enable (u32 BaseAddress)
 Enable the interrupt.
 
void AXI_MILLBRAE_Interrupt_Disable (u32 BaseAddress)
 Disable the interrupt.
 
u32 AXI_MILLBRAE_Read_Data (u32 BaseAddress, u8 Channel)
 Read sampled data.
 
u32 AXI_MILLBRAE_Read_Interrupt_Status (u32 BaseAddress)
 Read interrupt status.
 
void AXI_MILLBRAE_Single_Convert (u32 BaseAddress, u8 Channel, u16 *uSample)
 Read one ADC sample.
 

Detailed Description


      Project: MAXREFDES71#
     Filename: axi_millbrae.c
  Description: This file contains the software API definition of the
                 axi_millbrae custom IP core.

Revision History:
12-17-13 Rev 01.00 GL Initial Release


This code follows the following naming conventions:


char chPmodValue
char (array) sPmodString[16]
float fPmodValue
int nPmodValue
int (array) anPmodValue[16]
u16 uPmodValue
u16 (array) auPmodValue[16]
u8 uchPmodValue
u8 (array) auchPmodBuffer[16]
unsigned int unPmodValue
int * punPmodValue



      Project: MAXREFDES61#
     Filename: axi_millbrae.h
  Description: This header file contains the software API prototypes of the
                 axi_millbrae custom IP core.

Revision History:
12-17-13 Rev 01.00 GL Initial Release


This code follows the following naming conventions:


char chPmodValue
char (array) sPmodString[16]
float fPmodValue
int nPmodValue
int (array) anPmodValue[16]
u16 uPmodValue
u16 (array) auPmodValue[16]
u8 uchPmodValue
u8 (array) auchPmodBuffer[16]
unsigned int unPmodValue
int * punPmodValue


Definition in file axi_millbrae.c.

Function Documentation

void AXI_MILLBRAE_Config_ADC ( u32  BaseAddress,
u32  Value 
)

Config ADC.

Details
This function write a value to the config register of the ADC
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 66 of file axi_millbrae.c.

void AXI_MILLBRAE_Config_DAC ( u32  BaseAddress,
u32  Value 
)

Config DAC.

Details
This function write a value to the config register of the DAC
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 81 of file axi_millbrae.c.

void AXI_MILLBRAE_Interrupt_Disable ( u32  BaseAddress)

Disable the interrupt.

Details
This function writes a 0 to the interrupt enable register to disable the interrupt
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 183 of file axi_millbrae.c.

void AXI_MILLBRAE_Interrupt_Enable ( u32  BaseAddress)

Enable the interrupt.

Details
This function writes a 1 to the interrupt enable register to enable the interrupt. When the interrupt is enabled, the AXI_MILLBRAE IP core will raise an interrupt when the sampled data is available.
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 166 of file axi_millbrae.c.

u32 AXI_MILLBRAE_Read_Data ( u32  BaseAddress,
u8  Channel 
)

Read sampled data.

Details
This function reads the ADC sampled data register. The data register will be overwritten when the new sampled data is available.
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
ADCsampled data

Definition at line 198 of file axi_millbrae.c.

u32 AXI_MILLBRAE_Read_Interrupt_Status ( u32  BaseAddress)

Read interrupt status.

Details
This function reads the interrupt status register. When the value is one, sampled data is available in the data register. Interrupt status register is a clear-on-read register
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
Interruptstatus

Definition at line 214 of file axi_millbrae.c.

void AXI_MILLBRAE_Single_Convert ( u32  BaseAddress,
u8  Channel,
u16 *  uSample 
)

Read one ADC sample.

Details
This function starts an ADC conversion and returns one ADC sample.
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
OneADC sample

Definition at line 231 of file axi_millbrae.c.

void AXI_MILLBRAE_Start_Conversion ( u32  BaseAddress)

Start ADC Conversion.

Details
This function writes a 0 to the Mode register of the AXI_MILLBRAE ip core to set the operation mode to ADC conversion mode This function also write a 1 to the start operation register of the AXI_MILLBRAE ip core to start the conversion
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 96 of file axi_millbrae.c.

void AXI_MILLBRAE_Start_Replication ( u32  BaseAddress)

Start signal replication.

Details
This function writes a 1 to the Mode register of the AXI_MILLBRAE ip core to set the operation mode to signal replication mode This function also write a 1 to the start operation register of the AXI_MILLBRAE ip core to start the signal replication
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 129 of file axi_millbrae.c.

void AXI_MILLBRAE_Stop_Operation ( u32  BaseAddress)

Stop operation.

Details
This function writes a 0 to the start operation register of the AXI_MILLBRAE ip core to stop the operation
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
Return values
None

Definition at line 114 of file axi_millbrae.c.

void AXI_MILLBRAE_Write_Timer_Reg ( u32  BaseAddress,
u32  Value 
)

Write Value to the Timer register.

Details
This function writes a value to the timer register. The timer register is used to control the sampling rate Sampling rate = 50000000/(Value+1)
Parameters
[in]BaseAddress- Base address of the AXI_MILLBRAE IP core
[in]Value- a value to be written to the timer register
Return values
None

Definition at line 149 of file axi_millbrae.c.