waveform4 2.0.0.0
Waveform 4 Registers Settings

Settings for registers of Waveform 4 Click driver. More...

Macros

#define WAVEFORM4_WAV_CFG_PRESTORE_CST   0x00
 Waveform 4 wave config macros.
 
#define WAVEFORM4_WAV_CFG_PRESTORE_SAWTOOTH   0x10
 
#define WAVEFORM4_WAV_CFG_PRESTORE_PSEUDO   0x20
 
#define WAVEFORM4_WAV_CFG_PRESTORE_DDS   0x30
 
#define WAVEFORM4_WAV_CFG_WAVE_FROM_RAM   0x00
 
#define WAVEFORM4_WAV_CFG_WAVE_PRESTORED   0x01
 
#define WAVEFORM4_WAV_CFG_WAVE_PRESTORED_DELAY   0x02
 
#define WAVEFORM4_WAV_CFG_WAVE_PRESTORED_RAM   0x03
 
#define WAVEFORM4_DDSX_CFG_ENABLE_COSINE   0x08
 
#define WAVEFORM4_SAW_CFG_RAMP_UP   0x00
 
#define WAVEFORM4_SAW_CFG_RAMP_DOWN   0x01
 
#define WAVEFORM4_SAW_CFG_TRIANGLE   0x02
 
#define WAVEFORM4_SAW_CFG_NO_WAVE   0x03
 
#define WAVEFORM4_SAW_CFG_STEP_1   0x04
 
#define WAVEFORM4_DEFAULT_GAIN   0.5
 Waveform 4 default settings macros.
 
#define WAVEFORM4_DEFAULT_FREQUENCY   100000
 
#define WAVEFORM4_UPDATE_SETTINGS   0x01
 Waveform 4 ram update and pat status register macros.
 
#define WAVEFORM4_MEM_ACCESS_ENABLE   0x04
 
#define WAVEFORM4_MEM_ACCESS_DISABLE   0x00
 
#define WAVEFORM4_BUF_READ   0x08
 
#define WAVEFORM4_START_PATTERN   0x01
 
#define WAVEFORM4_STOP_PATTERN   0x00
 
#define WAVEFORM4_CHANNEL_1   0x00
 Waveform 4 channel selection macros.
 
#define WAVEFORM4_CHANNEL_2   0x01
 
#define WAVEFORM4_CHANNEL_3   0x02
 
#define WAVEFORM4_CHANNEL_4   0x03
 
#define WAVEFORM4_WAVE_SINE   0x00
 Waveform 4 wave output selection macros.
 
#define WAVEFORM4_WAVE_COSINE   0x01
 
#define WAVEFORM4_WAVE_TRIANGLE   0x02
 
#define WAVEFORM4_WAVE_POSITIVE_SAWTOOTH   0x03
 
#define WAVEFORM4_WAVE_NEGATIVE_SAWTOOTH   0x04
 
#define WAVEFORM4_GAIN_MAX   2.0
 Waveform 4 gain calculation macros.
 
#define WAVEFORM4_GAIN_MIN   (-2.0)
 
#define WAVEFORM4_GAIN_RESOLUTION   1024
 
#define WAVEFORM4_MASTER_CLOCK   125000000
 Waveform 4 frequency calculation constants.
 
#define WAVEFORM4_FREQ_RESOLUTION   0x1000000
 
#define WAVEFORM4_SPI_READ_MASK   0x80
 Waveform 4 SPI read/write setting.
 
#define WAVEFORM4_SPI_WRITE_MASK   0x7F
 
#define WAVEFORM4_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define WAVEFORM4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 

Detailed Description

Settings for registers of Waveform 4 Click driver.

Macro Definition Documentation

◆ WAVEFORM4_BUF_READ

#define WAVEFORM4_BUF_READ   0x08

◆ WAVEFORM4_CHANNEL_1

#define WAVEFORM4_CHANNEL_1   0x00

Waveform 4 channel selection macros.

Specified macros for channel selection of Waveform 4 Click driver.

◆ WAVEFORM4_CHANNEL_2

#define WAVEFORM4_CHANNEL_2   0x01

◆ WAVEFORM4_CHANNEL_3

#define WAVEFORM4_CHANNEL_3   0x02

◆ WAVEFORM4_CHANNEL_4

#define WAVEFORM4_CHANNEL_4   0x03

◆ WAVEFORM4_DDSX_CFG_ENABLE_COSINE

#define WAVEFORM4_DDSX_CFG_ENABLE_COSINE   0x08

◆ WAVEFORM4_DEFAULT_FREQUENCY

#define WAVEFORM4_DEFAULT_FREQUENCY   100000

◆ WAVEFORM4_DEFAULT_GAIN

#define WAVEFORM4_DEFAULT_GAIN   0.5

Waveform 4 default settings macros.

Specified macros for default settings of Waveform 4 Click driver.

◆ WAVEFORM4_FREQ_RESOLUTION

#define WAVEFORM4_FREQ_RESOLUTION   0x1000000

◆ WAVEFORM4_GAIN_MAX

#define WAVEFORM4_GAIN_MAX   2.0

Waveform 4 gain calculation macros.

Specified macros for gain calculation of Waveform 4 Click driver.

◆ WAVEFORM4_GAIN_MIN

#define WAVEFORM4_GAIN_MIN   (-2.0)

◆ WAVEFORM4_GAIN_RESOLUTION

#define WAVEFORM4_GAIN_RESOLUTION   1024

◆ WAVEFORM4_MASTER_CLOCK

#define WAVEFORM4_MASTER_CLOCK   125000000

Waveform 4 frequency calculation constants.

Specified constants for frequency calculation of Waveform 4 Click driver.

◆ WAVEFORM4_MEM_ACCESS_DISABLE

#define WAVEFORM4_MEM_ACCESS_DISABLE   0x00

◆ WAVEFORM4_MEM_ACCESS_ENABLE

#define WAVEFORM4_MEM_ACCESS_ENABLE   0x04

◆ WAVEFORM4_SAW_CFG_NO_WAVE

#define WAVEFORM4_SAW_CFG_NO_WAVE   0x03

◆ WAVEFORM4_SAW_CFG_RAMP_DOWN

#define WAVEFORM4_SAW_CFG_RAMP_DOWN   0x01

◆ WAVEFORM4_SAW_CFG_RAMP_UP

#define WAVEFORM4_SAW_CFG_RAMP_UP   0x00

◆ WAVEFORM4_SAW_CFG_STEP_1

#define WAVEFORM4_SAW_CFG_STEP_1   0x04

◆ WAVEFORM4_SAW_CFG_TRIANGLE

#define WAVEFORM4_SAW_CFG_TRIANGLE   0x02

◆ WAVEFORM4_SET_DATA_SAMPLE_EDGE

#define WAVEFORM4_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note
Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with waveform4_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ WAVEFORM4_SET_DATA_SAMPLE_MIDDLE

#define WAVEFORM4_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE

◆ WAVEFORM4_SPI_READ_MASK

#define WAVEFORM4_SPI_READ_MASK   0x80

Waveform 4 SPI read/write setting.

Specified setting for SPI read/write of Waveform 4 Click driver.

◆ WAVEFORM4_SPI_WRITE_MASK

#define WAVEFORM4_SPI_WRITE_MASK   0x7F

◆ WAVEFORM4_START_PATTERN

#define WAVEFORM4_START_PATTERN   0x01

◆ WAVEFORM4_STOP_PATTERN

#define WAVEFORM4_STOP_PATTERN   0x00

◆ WAVEFORM4_UPDATE_SETTINGS

#define WAVEFORM4_UPDATE_SETTINGS   0x01

Waveform 4 ram update and pat status register macros.

Specified macros for ram update and pat status registers of Waveform 4 Click driver.

◆ WAVEFORM4_WAV_CFG_PRESTORE_CST

#define WAVEFORM4_WAV_CFG_PRESTORE_CST   0x00

Waveform 4 wave config macros.

Specified macros for wave config of Waveform 4 Click driver.

◆ WAVEFORM4_WAV_CFG_PRESTORE_DDS

#define WAVEFORM4_WAV_CFG_PRESTORE_DDS   0x30

◆ WAVEFORM4_WAV_CFG_PRESTORE_PSEUDO

#define WAVEFORM4_WAV_CFG_PRESTORE_PSEUDO   0x20

◆ WAVEFORM4_WAV_CFG_PRESTORE_SAWTOOTH

#define WAVEFORM4_WAV_CFG_PRESTORE_SAWTOOTH   0x10

◆ WAVEFORM4_WAV_CFG_WAVE_FROM_RAM

#define WAVEFORM4_WAV_CFG_WAVE_FROM_RAM   0x00

◆ WAVEFORM4_WAV_CFG_WAVE_PRESTORED

#define WAVEFORM4_WAV_CFG_WAVE_PRESTORED   0x01

◆ WAVEFORM4_WAV_CFG_WAVE_PRESTORED_DELAY

#define WAVEFORM4_WAV_CFG_WAVE_PRESTORED_DELAY   0x02

◆ WAVEFORM4_WAV_CFG_WAVE_PRESTORED_RAM

#define WAVEFORM4_WAV_CFG_WAVE_PRESTORED_RAM   0x03

◆ WAVEFORM4_WAVE_COSINE

#define WAVEFORM4_WAVE_COSINE   0x01

◆ WAVEFORM4_WAVE_NEGATIVE_SAWTOOTH

#define WAVEFORM4_WAVE_NEGATIVE_SAWTOOTH   0x04

◆ WAVEFORM4_WAVE_POSITIVE_SAWTOOTH

#define WAVEFORM4_WAVE_POSITIVE_SAWTOOTH   0x03

◆ WAVEFORM4_WAVE_SINE

#define WAVEFORM4_WAVE_SINE   0x00

Waveform 4 wave output selection macros.

Specified macros for wave output selection of Waveform 4 Click driver.

◆ WAVEFORM4_WAVE_TRIANGLE

#define WAVEFORM4_WAVE_TRIANGLE   0x02