Linduino  1.3.0
Linear Technology Arduino-Compatible Demonstration Board

LTC6948: Ultralow Noise and Spurious 0.37GHz to 6.39GHz FracN Synthesizer with Integrated VCO. More...

Detailed Description

LTC6948: Ultralow Noise and Spurious 0.37GHz to 6.39GHz FracN Synthesizer with Integrated VCO.

 SPI DATA FORMAT (MSB First):

 Write Sequence:
       Byte #1                    Byte #2
 MOSI: A6 A5 A4 A3 A2 A1 A0 W   D7 D6 D5 D4 D3 D2 D1 D0
 MISO: X  X  X  X  X  X  X  X   X  X  X  X  X  X  X  X

 Read Sequence:
       Byte #1                    Byte #2
 MOSI: A6 A5 A4 A3 A2 A1 A0 R   X  X  X  X  X  X  X  X
 MISO: X  X  X  X  X  X  X  X   D7 D6 D5 D4 D3 D2 D1 D0

 W    : SPI Write (0)
 R    : SPI Read  (1)
 Ax   : Address
 Dx   : Data Bits
 X    : Don't care

http://www.linear.com/product/LTC6948

http://www.linear.com/product/LTC6948#demoboards

Copyright 2018(c) 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.

Header for LTC6948: Ultralow Noise and Spurious 0.37GHz to 6.39GHz FracN Synthesizer with Integrated VCO

Definition in file LTC6948.h.

Go to the source code of this file.

Functions

uint8_t LTC6948_read (uint8_t cs, int8_t address)
 LTC6948 Read Single Address reads 8 bit Data field to LTC6948. More...
 
long LTC6948_read_field (uint8_t cs, uint8_t address, uint8_t MSB_loc, uint8_t numbits)
 LTC6948 Read Single Field For SPI FIELDS located in 1 or multiple address locations reads specific address locations identifies and returns specific field in question can handle SPI fields in multiple addresses, if MSB bit is in the lower number address. More...
 
long get_LTC6948_SPI_FIELD (uint8_t cs, uint8_t f)
 Gets the LTC6948 SPI field value calls function LTC6948_read_field, which reads specific address locations identifies and returns specific field in question can handle SPI fields in multiple addresses, if MSB bit is in the lower number address. More...
 
void LTC6948_write (uint8_t cs, uint8_t address, uint8_t Data)
 LTC6948 Write Single Address writes 8 bit Data field to LTC6948. More...
 
uint8_t LTC6948_write_field (uint8_t cs, long field_data, uint8_t address, uint8_t MSB_loc, uint8_t numbits)
 LTC6948 Write Single Field For SPI FIELDS in 1 or multiple address locations reads specific address/field location then writes to specific field can handle SPI fields in multiple addresses, if MSB bit is in the lower number address. More...
 
void set_LTC6948_SPI_FIELD (uint8_t cs, uint8_t f, long field_data)
 Sets the LTC6948 SPI field value calls function LTC6948_read_field, which reads specific address/field location then writes to specific field can handle SPI fields in multiple addresses, if MSB bit is in the lower number address. More...
 
void set_LTC6948_ALLREGS (uint8_t cs, uint8_t reg01, uint8_t reg02, uint8_t reg03, uint8_t reg04, uint8_t reg05, uint8_t reg06, uint8_t reg07, uint8_t reg08, uint8_t reg09, uint8_t reg0A, uint8_t reg0B, uint8_t reg0C, uint8_t reg0D)
 Writes values to ALL LTC6948 RW address. More...
 
void LTC6948_init ()
 Initializes the SPI MAP arrays The values set in initialization are used all the LTC6948 SPI/WRITE and read functions (set_LTC6948_SPI_FIELD, get_LTC6948_SPI_FIELD, LTC6948_read, LTC6948_write, etc, etc) More...
 
uint8_t get_LTC6948_REGSIZE ()
 returns # of addresses in parts register map (array size) More...
 
uint8_t get_LTC6948_SPI_FIELD_NUMBITS (uint8_t f)
 returns the number of bits for a given field name in the SPI map More...
 
uint8_t get_LTC6948_SPI_FIELD_RW (uint8_t f)
 returns if the given field name is (0)read/write or (1)read_only field More...
 
unsigned long LTC6948_calc_odiv (char part_version[], unsigned long frf[2])
 calculates the output divider setting based on the frf and version of LTC6948 More...
 
void LTC6948_set_frf (char part_version[])
 FUNCTION: LTC6948_set_frf Calculates the integer (N), fractional (NUM) and output divider (OD) SPI values using self created 64bit math functions. More...
 
void set_LTC6948_global_fref (unsigned long fref_MHz, unsigned long fref_Hz)
 sets globals LTC6948_Fref_MHz and LTC6948_Fref_Hz More...
 
void set_LTC6948_global_frf (unsigned long frf_MHz, unsigned long frf_Hz)
 sets globals LTC6948_Frf_MHz and LTC6948_Frf_Hz More...
 
unsigned long get_LTC6948_global_fref_MHz ()
 returns global LTC6948_Fref_MHz More...
 
unsigned long get_LTC6948_global_fref_Hz ()
 returns global LTC6948_Fref_Hz More...
 
unsigned long get_LTC6948_global_frf_MHz ()
 returns global LTC6948_Frf_MHz More...
 
unsigned long get_LTC6948_global_frf_Hz ()
 returns global LTC6948_Frf_Hz More...
 
void HZto64 (unsigned long an[], unsigned long MHzPart, unsigned long HzPart)
 create a 64 bit Hz number from 32 bit xxxx MHz number and 32 bit yyy yyy Hz number. More...
 
void init64 (unsigned long an[], unsigned long bigPart, unsigned long littlePart)
 Creates a equivalent 64 bit number from 2 32 bit numbers. More...
 
void shl64 (unsigned long an[])
 Single Bit shift left of equivalent 64 bit number (an[] = an[]<<1) More...
 
void shl64by (unsigned long an[], uint8_t shiftnum)
 Multi Bit shift left of equivalent 64 bit number (an[] = an[]<<shiftnum) More...
 
void shr64 (unsigned long an[])
 Single Bit shift right of equivalent 64 bit number (an[] = an[]<<1) More...
 
void shr64by (unsigned long an[], uint8_t shiftnum)
 Multi Bit shift right of equivalent 64 bit number (an[] = an[]>>shiftnum) More...
 
void add64 (unsigned long an[], unsigned long ann[])
 64 bit Add ann to an (an[] = an[] + ann[]) More...
 
void sub64 (unsigned long an[], unsigned long ann[])
 64 bit Subtract ann from an (an[] = an[] - ann[]) More...
 
boolean eq64 (unsigned long an[], unsigned long ann[])
 64 bit, if an == ann, then true More...
 
boolean lt64 (unsigned long an[], unsigned long ann[])
 64 bit, if an < ann, then true More...
 
void div64 (unsigned long num[], unsigned long den[])
 64 bit Divide, num=num/div More...
 
void mul64 (unsigned long an[], unsigned long ann[])
 64 bit multiply, an=an*ann More...
 
void prt (unsigned long an[])
 Prints HEX representation of 64 bit an. More...
 

Macros

#define LTC6948_CS   QUIKEVAL_CS
 Define the SPI CS pin. More...
 
LTC6948 Registers Fields in Alphabetical Order
#define LTC6948_ALCCAL   1
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_ALCEN   2
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_ALCHI   3
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_ALCLO   4
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_ALCMON   5
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_ALCULOK   6
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_AUTOCAL   7
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_AUTORST   8
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_BD   9
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_BST   10
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CAL   11
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CP   12
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPCHI   13
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPCLO   14
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPDN   15
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPINV   16
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPLE   17
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPMID   18
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPRST   19
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPUP   20
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_CPWIDE   21
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_DITHEN   22
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_FILT   23
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_INTN   24
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_LDOEN   25
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_LDOV   26
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_LKCT   27
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_LKWIN   28
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_LOCK   29
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_MTCAL   30
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_ND   31
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_NUM   32
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_OD   33
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_OMUTE   34
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_PART   35
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_PDALL   36
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_PDFN   37
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_PDOUT   38
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_PDPLL   39
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_PDVCO   40
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_POR   41
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_RD   42
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_REV   43
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_RFO   44
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_RSTFN   45
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_SEED   46
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_THI   47
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_TLO   48
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_UNLOK   49
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_x   50
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6948_NUM_REGADDR   15
 Defines number of LTC6948 SPI registers, used in spi_map array. More...
 
#define LTC6948_NUM_REGFIELD   50
 Defines number of LTC6948 SPI fields, used in spi_map array. More...
 
#define ADDRx   0
 used for 2nd dim of 2d spi_map array More...
 
#define DxMSB   1
 used for 2nd dim of 2d spi_map array More...
 
#define NUMBITS   2
 used for 2nd dim of 2d spi_map array More...
 
#define R_ONLY   3
 used for 2nd dim of 2d spi_map array More...
 
#define OneMHz   1000000L
 1MHz in long format, used in 64 bit math More...
 
#define LTC6948_1_MAXFREQ   3740
 LTC6948-1 upper freq limit. More...
 
#define LTC6948_2_MAXFREQ   4910
 LTC6948-2 upper freq limit. More...
 
#define LTC6948_3_MAXFREQ   5790
 LTC6948-3 upper freq limit. More...
 
#define LTC6948_4_MAXFREQ   6390
 LTC6948-4 upper freq limit. More...
 
#define LTC6948_1_MINFREQ   2240
 LTC6948-1 lower freq limit. More...
 
#define LTC6948_2_MINFREQ   3080
 LTC6948-2 lower freq limit. More...
 
#define LTC6948_3_MINFREQ   3840
 LTC6948-3 lower freq limit. More...
 
#define LTC6948_4_MINFREQ   4200
 LTC6948-4 lower freq limit. More...
 
#define LTC6948_MIN_REF_FREQ   10
 LTC6948 lower reference frequency limit. More...
 
#define LTC6948_MAX_REF_FREQ   425
 LTC6948 upper reference frequency limit. More...
 

Function Documentation

◆ add64()

void add64 ( unsigned long  an[],
unsigned long  ann[] 
)

64 bit Add ann to an (an[] = an[] + ann[])

Returns
void
Parameters
an64 bit number, in 1x2 32bit array
ann64 bit number, in 1x2 32bit array

Definition at line 810 of file LTC6945.cpp.

◆ div64()

void div64 ( unsigned long  num[],
unsigned long  den[] 
)

64 bit Divide, num=num/div

Returns
void
Parameters
numnumerator: 64 bit number, in 1x2 32bit array
dendenominator: 64 bit number, in 1x2 32bit array

Definition at line 859 of file LTC6945.cpp.

◆ eq64()

boolean eq64 ( unsigned long  an[],
unsigned long  ann[] 
)

64 bit, if an == ann, then true

Returns
true, if an==ann; false, if an<>ann
Parameters
an64 bit number, in 1x2 32bit array
ann64 bit number, in 1x2 32bit array

Definition at line 838 of file LTC6945.cpp.

◆ get_LTC6948_global_fref_Hz()

unsigned long get_LTC6948_global_fref_Hz ( )

returns global LTC6948_Fref_Hz

Returns
LTC6948_Fref_Hz

Definition at line 524 of file LTC6948.cpp.

◆ get_LTC6948_global_fref_MHz()

unsigned long get_LTC6948_global_fref_MHz ( )

returns global LTC6948_Fref_MHz

Returns
LTC6948_Fref_MHz

Definition at line 519 of file LTC6948.cpp.

◆ get_LTC6948_global_frf_Hz()

unsigned long get_LTC6948_global_frf_Hz ( )

returns global LTC6948_Frf_Hz

Returns
LTC6948_Frf_Hz

Definition at line 534 of file LTC6948.cpp.

◆ get_LTC6948_global_frf_MHz()

unsigned long get_LTC6948_global_frf_MHz ( )

returns global LTC6948_Frf_MHz

Returns
LTC6948_Frf_MHz

Definition at line 529 of file LTC6948.cpp.

◆ get_LTC6948_REGSIZE()

uint8_t get_LTC6948_REGSIZE ( )

returns # of addresses in parts register map (array size)

Returns
# of addresses in parts register map

Definition at line 229 of file LTC6948.cpp.

◆ get_LTC6948_SPI_FIELD()

long get_LTC6948_SPI_FIELD ( uint8_t  cs,
uint8_t  f 
)

Gets the LTC6948 SPI field value calls function LTC6948_read_field, which reads specific address locations identifies and returns specific field in question can handle SPI fields in multiple addresses, if MSB bit is in the lower number address.

Returns
data that was read from field
Parameters
csChip Select Pin
fSPI field number

Definition at line 151 of file LTC6948.cpp.

◆ get_LTC6948_SPI_FIELD_NUMBITS()

uint8_t get_LTC6948_SPI_FIELD_NUMBITS ( uint8_t  f)

returns the number of bits for a given field name in the SPI map

Returns
the number of bits for a given field name in the SPI map
Parameters
fSPI field number

Definition at line 239 of file LTC6948.cpp.

◆ get_LTC6948_SPI_FIELD_RW()

uint8_t get_LTC6948_SPI_FIELD_RW ( uint8_t  f)

returns if the given field name is (0)read/write or (1)read_only field

Returns
if the given field is a (0)read/write or (1)read_only field
Parameters
fSPI field number

Definition at line 249 of file LTC6948.cpp.

◆ HZto64()

void HZto64 ( unsigned long  an[],
unsigned long  MHzPart,
unsigned long  HzPart 
)

create a 64 bit Hz number from 32 bit xxxx MHz number and 32 bit yyy yyy Hz number.

A) if an < 2^32 bits:

  • an(upper 32b) = 0;
  • an(lower 32b) = MHzPart(32b)*1MHz + HzPart (32b)

B) if an > 2^32 bits (4,294,967,296):

  • an(upper 32b) = 1
  • an(lower 32b) = ((MHzPart-4294)*1MHz+HzPart)-967296
    Returns
    void
Parameters
an64 bit number, 1x2 32 bit array
MHzPartinteger in MHZ
HzPartinteger in Hz

Definition at line 729 of file LTC6945.cpp.

◆ init64()

void init64 ( unsigned long  an[],
unsigned long  bigPart,
unsigned long  littlePart 
)

Creates a equivalent 64 bit number from 2 32 bit numbers.

  • an[0]=bigPart //upper 32 bits
  • an[1]=littlePart //lower 32 bits
    Returns
    void
  • an[0]=bigPart upper 32 bits
  • an[1]=littlePart lower 32 bits
    Returns
    void
Parameters
an64 bit number, 1x2 32 bit array
bigPartupper 32 bits
littlePartlower 32 bits

Definition at line 712 of file LTC6945.cpp.

◆ lt64()

boolean lt64 ( unsigned long  an[],
unsigned long  ann[] 
)

64 bit, if an < ann, then true

Returns
true, if an<ann; false, if an=>ann
Parameters
an64 bit number, in 1x2 32bit array
ann64 bit number, in 1x2 32bit array

Definition at line 848 of file LTC6945.cpp.

◆ LTC6948_calc_odiv()

unsigned long LTC6948_calc_odiv ( char  part_version[],
unsigned long  frf[2] 
)

calculates the output divider setting based on the frf and version of LTC6948

Returns
odiv = 1-6 divider setting for valid frequency, or 999 for invalid frequency
Parameters
part_versionLTC6948 part number LTC6948-x
frfoutput frequency

Definition at line 545 of file LTC6948.cpp.

◆ LTC6948_init()

void LTC6948_init ( )

Initializes the SPI MAP arrays The values set in initialization are used all the LTC6948 SPI/WRITE and read functions (set_LTC6948_SPI_FIELD, get_LTC6948_SPI_FIELD, LTC6948_read, LTC6948_write, etc, etc)

Returns
void

Definition at line 299 of file LTC6948.cpp.

◆ LTC6948_read()

uint8_t LTC6948_read ( uint8_t  cs,
int8_t  address 
)

LTC6948 Read Single Address reads 8 bit Data field to LTC6948.

has to shift data by one bit to account for RW bit

Returns
data that was read from address
Parameters
csChip Select Pin
addressRegister address for the LTC6948.

Definition at line 95 of file LTC6948.cpp.

◆ LTC6948_read_field()

long LTC6948_read_field ( uint8_t  cs,
uint8_t  address,
uint8_t  MSB_loc,
uint8_t  numbits 
)

LTC6948 Read Single Field For SPI FIELDS located in 1 or multiple address locations reads specific address locations identifies and returns specific field in question can handle SPI fields in multiple addresses, if MSB bit is in the lower number address.

Returns
data that was read from field
Parameters
csChip Select Pin
addressRegister address for the LTC6948.
MSB_locMSB bit location of field
numbitslength of field (i.e. number of bits in field)

Definition at line 115 of file LTC6948.cpp.

◆ LTC6948_set_frf()

void LTC6948_set_frf ( char  part_version[])

FUNCTION: LTC6948_set_frf Calculates the integer (N), fractional (NUM) and output divider (OD) SPI values using self created 64bit math functions.

Datasheet equations:

  • fvco = fpfd*(N + F)
  • frf = fvco/O
  • fpfd = fref/R

    • F=NUM/2^18 = NUM/262144

    can be modified to the following equations:

    • N = (int) (fvco/fpfd) = (int) frf*O*R/fref
    • NUM = (int) [262144 * (frf*O*R/fref -N)]

    where:

    • N = ndiv, O= odiv, NUM=fracN_num in the code below

    Linduino One (Arduino Uno) is limited to 32 bit floats/double/long. 32 bit math functions will create rounding errors with the above equations, that can result in frequency errors. Therefore, the following code uses self created 64bit functions for 64bit integer math.

    • frf (33 bits) LTC6948-4 max frf/fvco = 6.4GHZ, which is 33 bit number (2^33 = 8.59G)
    • fref (23 bits) LTC6948 min fref = 10MHz, which is a 23 bit number (2^23 = 8.3M)
    • O (3 bits)
  • R (5 bits)

    step 1: create 64 bit frf and fref numbers

    step 2: calculate O (output divider)

    step 3: get current R-divider setting

    step 4: calculate frf*O*R max bit count/resolution: 33b+3b+5b= 41b

    step 5: calculate N(10b), using value from step 1 N = (int) frf*O*R/fref max bit count/resolution: 41b-23b = 18b

    step 6: calculate NUM (18b)

  • NUM = (int) [262144 * (frf*O*R/fref -N)]
  • NUM = (int) [2^18 * (frf*O*R/fref -N)]

    to get the correct value the above calculation are performed like this

  • NUM =((int)((frf*O*R/fref)<<23) - N<<23 + rounding) >> 5, where << & >> are bit shift left, right
  • note 1: << 23b was chosen, because step one use 41b, 41b +23b = 64b (max number for 64 bit math)
    • note 2: >> 5 was chosen because 23-5 = 2^18, which is the same as multiplying by 262144
    • note 3: the rounding variable is equivalent to adding 0.5 to the NUM number. the integer operation always rounds down, so adding a 0.5 to the number before rounding down ensures the closest value is selected. In this function the lower 5 bits of (frf*O*R/fref)<<23) - N<<23 (possible variable 0-31) are check to see if they are >=16. If they are then 16 is added to this number before performing the int and >>5 functions.
      Returns
      void
Parameters
part_versionLTC6948 part number LTC6948-x

Definition at line 659 of file LTC6948.cpp.

◆ LTC6948_write()

void LTC6948_write ( uint8_t  cs,
uint8_t  address,
uint8_t  Data 
)

LTC6948 Write Single Address writes 8 bit Data field to LTC6948.

has to shift data by one bit to account for RW bit

Returns
void
Parameters
csChip Select Pin
addressRegister address for the LTC6948.
Data8-bit data to be written to register

Definition at line 162 of file LTC6948.cpp.

◆ LTC6948_write_field()

uint8_t LTC6948_write_field ( uint8_t  cs,
long  field_data,
uint8_t  address,
uint8_t  MSB_loc,
uint8_t  numbits 
)

LTC6948 Write Single Field For SPI FIELDS in 1 or multiple address locations reads specific address/field location then writes to specific field can handle SPI fields in multiple addresses, if MSB bit is in the lower number address.

Returns
void
Parameters
csChip Select Pin
field_dataValue field value to be set to
addressRegister address for the LTC6948.
MSB_locMSB bit location of field
numbitslength of field (i.e. number of bits in field)

Definition at line 178 of file LTC6948.cpp.

◆ mul64()

void mul64 ( unsigned long  an[],
unsigned long  ann[] 
)

64 bit multiply, an=an*ann

Returns
void
Parameters
an64 bit number, in 1x2 32bit array
ann64 bit number, in 1x2 32bit array

Definition at line 906 of file LTC6945.cpp.

◆ prt()

void prt ( unsigned long  an[])

Prints HEX representation of 64 bit an.

Returns
void
Parameters
an64 bit number, in 1x2 32bit array

Definition at line 698 of file LTC6945.cpp.

◆ set_LTC6948_ALLREGS()

void set_LTC6948_ALLREGS ( uint8_t  cs,
uint8_t  reg01,
uint8_t  reg02,
uint8_t  reg03,
uint8_t  reg04,
uint8_t  reg05,
uint8_t  reg06,
uint8_t  reg07,
uint8_t  reg08,
uint8_t  reg09,
uint8_t  reg0A,
uint8_t  reg0B,
uint8_t  reg0C,
uint8_t  reg0D 
)

Writes values to ALL LTC6948 RW address.

Returns
void
Parameters
csChip Select Pin
reg01LTC6948 register 1
reg02LTC6948 register 2
reg03LTC6948 register 3
reg04LTC6948 register 4
reg05LTC6948 register 5
reg06LTC6948 register 6
reg07LTC6948 register 7
reg08LTC6948 register 8
reg09LTC6948 register 9
reg0ALTC6948 register 10
reg0BLTC6948 register 11
reg0CLTC6948 register 12
reg0DLTC6948 register 13

Definition at line 272 of file LTC6948.cpp.

◆ set_LTC6948_global_fref()

void set_LTC6948_global_fref ( unsigned long  fref_MHz,
unsigned long  fref_Hz 
)

sets globals LTC6948_Fref_MHz and LTC6948_Fref_Hz

Returns
void

Definition at line 507 of file LTC6948.cpp.

◆ set_LTC6948_global_frf()

void set_LTC6948_global_frf ( unsigned long  frf_MHz,
unsigned long  frf_Hz 
)

sets globals LTC6948_Frf_MHz and LTC6948_Frf_Hz

Returns
void

Definition at line 513 of file LTC6948.cpp.

◆ set_LTC6948_SPI_FIELD()

void set_LTC6948_SPI_FIELD ( uint8_t  cs,
uint8_t  f,
long  field_data 
)

Sets the LTC6948 SPI field value calls function LTC6948_read_field, which reads specific address/field location then writes to specific field can handle SPI fields in multiple addresses, if MSB bit is in the lower number address.

Returns
void
Parameters
csChip Select Pin
fSPI field number
field_dataValue field value to be set to

Definition at line 262 of file LTC6948.cpp.

◆ shl64()

void shl64 ( unsigned long  an[])

Single Bit shift left of equivalent 64 bit number (an[] = an[]<<1)

Returns
void
Parameters
anan[] = an[]<<1

Definition at line 748 of file LTC6945.cpp.

◆ shl64by()

void shl64by ( unsigned long  an[],
uint8_t  shiftnum 
)

Multi Bit shift left of equivalent 64 bit number (an[] = an[]<<shiftnum)

Returns
void
Parameters
anan[] = an[]<<shiftnum
shiftnumnumber of bits to shift left

Definition at line 774 of file LTC6945.cpp.

◆ shr64()

void shr64 ( unsigned long  an[])

Single Bit shift right of equivalent 64 bit number (an[] = an[]<<1)

Returns
void
Parameters
anan[] = an[]>>shiftnum

Definition at line 761 of file LTC6945.cpp.

◆ shr64by()

void shr64by ( unsigned long  an[],
uint8_t  shiftnum 
)

Multi Bit shift right of equivalent 64 bit number (an[] = an[]>>shiftnum)

Returns
void
Parameters
anan[] = an[]>>shiftnum
shiftnumnumber of bits to shift right

Definition at line 792 of file LTC6945.cpp.

◆ sub64()

void sub64 ( unsigned long  an[],
unsigned long  ann[] 
)

64 bit Subtract ann from an (an[] = an[] - ann[])

Returns
void
Parameters
an64 bit number, in 1x2 32bit array
ann64 bit number, in 1x2 32bit array

Definition at line 823 of file LTC6945.cpp.

Macro Definition Documentation

◆ ADDRx

#define ADDRx   0

used for 2nd dim of 2d spi_map array

Definition at line 136 of file LTC6948.h.

◆ DxMSB

#define DxMSB   1

used for 2nd dim of 2d spi_map array

Definition at line 137 of file LTC6948.h.

◆ LTC6948_1_MAXFREQ

#define LTC6948_1_MAXFREQ   3740

LTC6948-1 upper freq limit.

Definition at line 143 of file LTC6948.h.

◆ LTC6948_1_MINFREQ

#define LTC6948_1_MINFREQ   2240

LTC6948-1 lower freq limit.

Definition at line 148 of file LTC6948.h.

◆ LTC6948_2_MAXFREQ

#define LTC6948_2_MAXFREQ   4910

LTC6948-2 upper freq limit.

Definition at line 144 of file LTC6948.h.

◆ LTC6948_2_MINFREQ

#define LTC6948_2_MINFREQ   3080

LTC6948-2 lower freq limit.

Definition at line 149 of file LTC6948.h.

◆ LTC6948_3_MAXFREQ

#define LTC6948_3_MAXFREQ   5790

LTC6948-3 upper freq limit.

Definition at line 145 of file LTC6948.h.

◆ LTC6948_3_MINFREQ

#define LTC6948_3_MINFREQ   3840

LTC6948-3 lower freq limit.

Definition at line 150 of file LTC6948.h.

◆ LTC6948_4_MAXFREQ

#define LTC6948_4_MAXFREQ   6390

LTC6948-4 upper freq limit.

Definition at line 146 of file LTC6948.h.

◆ LTC6948_4_MINFREQ

#define LTC6948_4_MINFREQ   4200

LTC6948-4 lower freq limit.

Definition at line 151 of file LTC6948.h.

◆ LTC6948_ALCCAL

#define LTC6948_ALCCAL   1

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 81 of file LTC6948.h.

◆ LTC6948_ALCEN

#define LTC6948_ALCEN   2

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 82 of file LTC6948.h.

◆ LTC6948_ALCHI

#define LTC6948_ALCHI   3

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 83 of file LTC6948.h.

◆ LTC6948_ALCLO

#define LTC6948_ALCLO   4

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 84 of file LTC6948.h.

◆ LTC6948_ALCMON

#define LTC6948_ALCMON   5

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 85 of file LTC6948.h.

◆ LTC6948_ALCULOK

#define LTC6948_ALCULOK   6

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 86 of file LTC6948.h.

◆ LTC6948_AUTOCAL

#define LTC6948_AUTOCAL   7

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 87 of file LTC6948.h.

◆ LTC6948_AUTORST

#define LTC6948_AUTORST   8

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 88 of file LTC6948.h.

◆ LTC6948_BD

#define LTC6948_BD   9

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 89 of file LTC6948.h.

◆ LTC6948_BST

#define LTC6948_BST   10

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 90 of file LTC6948.h.

◆ LTC6948_CAL

#define LTC6948_CAL   11

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 91 of file LTC6948.h.

◆ LTC6948_CP

#define LTC6948_CP   12

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 92 of file LTC6948.h.

◆ LTC6948_CPCHI

#define LTC6948_CPCHI   13

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 93 of file LTC6948.h.

◆ LTC6948_CPCLO

#define LTC6948_CPCLO   14

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 94 of file LTC6948.h.

◆ LTC6948_CPDN

#define LTC6948_CPDN   15

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 95 of file LTC6948.h.

◆ LTC6948_CPINV

#define LTC6948_CPINV   16

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 96 of file LTC6948.h.

◆ LTC6948_CPLE

#define LTC6948_CPLE   17

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 97 of file LTC6948.h.

◆ LTC6948_CPMID

#define LTC6948_CPMID   18

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 98 of file LTC6948.h.

◆ LTC6948_CPRST

#define LTC6948_CPRST   19

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 99 of file LTC6948.h.

◆ LTC6948_CPUP

#define LTC6948_CPUP   20

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 100 of file LTC6948.h.

◆ LTC6948_CPWIDE

#define LTC6948_CPWIDE   21

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 101 of file LTC6948.h.

◆ LTC6948_CS

#define LTC6948_CS   QUIKEVAL_CS

Define the SPI CS pin.

Definition at line 76 of file LTC6948.h.

◆ LTC6948_DITHEN

#define LTC6948_DITHEN   22

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 102 of file LTC6948.h.

◆ LTC6948_FILT

#define LTC6948_FILT   23

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 103 of file LTC6948.h.

◆ LTC6948_INTN

#define LTC6948_INTN   24

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 104 of file LTC6948.h.

◆ LTC6948_LDOEN

#define LTC6948_LDOEN   25

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 105 of file LTC6948.h.

◆ LTC6948_LDOV

#define LTC6948_LDOV   26

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 106 of file LTC6948.h.

◆ LTC6948_LKCT

#define LTC6948_LKCT   27

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 107 of file LTC6948.h.

◆ LTC6948_LKWIN

#define LTC6948_LKWIN   28

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 108 of file LTC6948.h.

◆ LTC6948_LOCK

#define LTC6948_LOCK   29

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 109 of file LTC6948.h.

◆ LTC6948_MAX_REF_FREQ

#define LTC6948_MAX_REF_FREQ   425

LTC6948 upper reference frequency limit.

Definition at line 154 of file LTC6948.h.

◆ LTC6948_MIN_REF_FREQ

#define LTC6948_MIN_REF_FREQ   10

LTC6948 lower reference frequency limit.

Definition at line 153 of file LTC6948.h.

◆ LTC6948_MTCAL

#define LTC6948_MTCAL   30

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 110 of file LTC6948.h.

◆ LTC6948_ND

#define LTC6948_ND   31

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 111 of file LTC6948.h.

◆ LTC6948_NUM

#define LTC6948_NUM   32

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 112 of file LTC6948.h.

◆ LTC6948_NUM_REGADDR

#define LTC6948_NUM_REGADDR   15

Defines number of LTC6948 SPI registers, used in spi_map array.

Definition at line 133 of file LTC6948.h.

◆ LTC6948_NUM_REGFIELD

#define LTC6948_NUM_REGFIELD   50

Defines number of LTC6948 SPI fields, used in spi_map array.

Definition at line 134 of file LTC6948.h.

◆ LTC6948_OD

#define LTC6948_OD   33

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 113 of file LTC6948.h.

◆ LTC6948_OMUTE

#define LTC6948_OMUTE   34

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 114 of file LTC6948.h.

◆ LTC6948_PART

#define LTC6948_PART   35

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 115 of file LTC6948.h.

◆ LTC6948_PDALL

#define LTC6948_PDALL   36

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 116 of file LTC6948.h.

◆ LTC6948_PDFN

#define LTC6948_PDFN   37

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 117 of file LTC6948.h.

◆ LTC6948_PDOUT

#define LTC6948_PDOUT   38

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 118 of file LTC6948.h.

◆ LTC6948_PDPLL

#define LTC6948_PDPLL   39

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 119 of file LTC6948.h.

◆ LTC6948_PDVCO

#define LTC6948_PDVCO   40

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 120 of file LTC6948.h.

◆ LTC6948_POR

#define LTC6948_POR   41

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 121 of file LTC6948.h.

◆ LTC6948_RD

#define LTC6948_RD   42

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 122 of file LTC6948.h.

◆ LTC6948_REV

#define LTC6948_REV   43

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 123 of file LTC6948.h.

◆ LTC6948_RFO

#define LTC6948_RFO   44

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 124 of file LTC6948.h.

◆ LTC6948_RSTFN

#define LTC6948_RSTFN   45

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 125 of file LTC6948.h.

◆ LTC6948_SEED

#define LTC6948_SEED   46

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 126 of file LTC6948.h.

◆ LTC6948_THI

#define LTC6948_THI   47

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 127 of file LTC6948.h.

◆ LTC6948_TLO

#define LTC6948_TLO   48

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 128 of file LTC6948.h.

◆ LTC6948_UNLOK

#define LTC6948_UNLOK   49

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 129 of file LTC6948.h.

◆ LTC6948_x

#define LTC6948_x   50

for spi_map array, defines location for field specific information used to create the spi map

Definition at line 130 of file LTC6948.h.

◆ NUMBITS

#define NUMBITS   2

used for 2nd dim of 2d spi_map array

Definition at line 138 of file LTC6948.h.

◆ OneMHz

#define OneMHz   1000000L

1MHz in long format, used in 64 bit math

Definition at line 141 of file LTC6948.h.

◆ R_ONLY

#define R_ONLY   3

used for 2nd dim of 2d spi_map array

Definition at line 139 of file LTC6948.h.