| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

Functions | Macros
LTC6946.h File Reference
RF, Silicon Oscillators, PLL Synthesizers, and VCOs » LTC6946: Ultralow Noise and Spurious 0.37GHz to 6.39GHz IntegerN Synthesizer with Integrated VCO

LTC6946: Ultralow Noise and Spurious 0.37GHz to 6.39GHz Integer-N Synthesizer with Integrated VCO. More...

## Detailed Description

LTC6946: Ultralow Noise and Spurious 0.37GHz to 6.39GHz Integer-N 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/LTC6946

http://www.linear.com/product/LTC6946#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 LTC6946: Ultralow Noise and Spurious 0.37GHz to 6.39GHz IntegerN Synthesizer with Integrated VCO

Definition in file LTC6946.h.

Go to the source code of this file.

## Functions
uint8_t | LTC6946_read (uint8_t cs, int8_t address)
| LTC6946 Read Single Address reads 8 bit Data field to LTC6946. More...
long | LTC6946_read_field (uint8_t cs, uint8_t address, uint8_t MSB_loc, uint8_t numbits)
| LTC6946 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_LTC6946_SPI_FIELD (uint8_t cs, uint8_t f)
| Gets the LTC6946 SPI field value calls function LTC6946_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 | LTC6946_write (uint8_t cs, uint8_t address, uint8_t Data)
| LTC6946 Write Single Address writes 8 bit Data field to LTC6946. More...
uint8_t | LTC6946_write_field (uint8_t cs, long field_data, uint8_t address, uint8_t MSB_loc, uint8_t numbits)
| LTC6946 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_LTC6946_SPI_FIELD (uint8_t cs, uint8_t f, long field_data)
| Sets the LTC6946 SPI field value calls function LTC6946_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_LTC6946_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)
| Writes values to ALL LTC6946 RW address. More...
void | LTC6946_init ()
| Initializes the SPI MAP arrays The values set in initialization are used all the LTC6946 SPI/WRITE and read functions (set_LTC6946_SPI_FIELD, get_LTC6946_SPI_FIELD, LTC6946_read, LTC6946_write, etc, etc) More...
uint8_t | get_LTC6946_REGSIZE ()
| returns # of addresses in parts register map (array size) More...
uint8_t | get_LTC6946_SPI_FIELD_NUMBITS (uint8_t f)
| returns the number of bits for a given field name in the SPI map More...
uint8_t | get_LTC6946_SPI_FIELD_RW (uint8_t f)
| returns if the given field name is (0)read/write or (1)read_only field More...
unsigned long | LTC6946_calc_odiv (char part_version[], unsigned long frf[2])
| calculates the output divider setting based on the frf and version of LTC6946 More...
void | LTC6946_set_frf (char part_version[])
| FUNCTION: LTC6946_set_frf Calculates the integer (N), fractional (NUM) and output divider (OD) SPI values using self created 64bit math functions. More...
void | set_LTC6946_global_fref (unsigned long fref_MHz, unsigned long fref_Hz)
| sets globals LTC6946_Fref_MHz and LTC6946_Fref_Hz More...
void | set_LTC6946_global_frf (unsigned long frf_MHz, unsigned long frf_Hz)
| sets globals LTC6946_Frf_MHz and LTC6946_Frf_Hz More...
unsigned long | get_LTC6946_global_fref_MHz ()
| returns global LTC6946_Fref_MHz More...
unsigned long | get_LTC6946_global_fref_Hz ()
| returns global LTC6946_Fref_Hz More...
unsigned long | get_LTC6946_global_frf_MHz ()
| returns global LTC6946_Frf_MHz More...
unsigned long | get_LTC6946_global_frf_Hz ()
| returns global LTC6946_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 | LTC6946_CS QUIKEVAL_CS
| Define the SPI CS pin. More...
LTC6946 Registers Fields in Alphabetical Order
#define | LTC6946_ALCCAL 1
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_ALCEN 2
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_ALCHI 3
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_ALCLO 4
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_ALCMON 5
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_ALCULOK 6
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_BD 7
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_BST 8
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CAL 9
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CP 10
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPCHI 11
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPCLO 12
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPDN 13
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPINV 14
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPMID 15
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPRST 16
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPUP 17
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_CPWIDE 18
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_FILT 19
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_LKCT 20
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_LKEN 21
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_LKWIN 22
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_LOCK 23
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_MTCAL 24
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_ND 25
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_OD 26
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_OMUTE 27
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_PART 28
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_PDALL 29
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_PDOUT 30
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_PDPLL 31
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_PDREFO 32
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_PDVCO 33
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_POR 34
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_RD 35
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_REV 36
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_RFO 37
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_THI 38
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_TLO 39
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_UNLOK 40
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_x 41
| for spi_map array, defines location for field specific information used to create the spi map More...
#define | LTC6946_NUM_REGADDR 12
| Defines number of LTC6946 SPI registers, used in spi_map array. More...
#define | LTC6946_NUM_REGFIELD 41
| Defines number of LTC6946 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 | LTC6946_1_MAXFREQ 3740
| LTC6946-1 upper freq limit. More...
#define | LTC6946_2_MAXFREQ 4910
| LTC6946-2 upper freq limit. More...
#define | LTC6946_3_MAXFREQ 5790
| LTC6946-3 upper freq limit. More...
#define | LTC6946_4_MAXFREQ 6390
| LTC6946-4 upper freq limit. More...
#define | LTC6946_1_MINFREQ 2240
| LTC6946-1 lower freq limit. More...
#define | LTC6946_2_MINFREQ 3080
| LTC6946-2 lower freq limit. More...
#define | LTC6946_3_MINFREQ 3840
| LTC6946-3 lower freq limit. More...
#define | LTC6946_4_MINFREQ 4200
| LTC6946-4 lower freq limit. More...
#define | LTC6946_MIN_REF_FREQ 10
| LTC6946 lower reference frequency limit. More...
#define | LTC6946_MAX_REF_FREQ 250
| LTC6946 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

  an | 64 bit number, in 1x2 32bit array
  ann | 64 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

  num | numerator: 64 bit number, in 1x2 32bit array
  den | denominator: 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

  an | 64 bit number, in 1x2 32bit array
  ann | 64 bit number, in 1x2 32bit array

Definition at line 838 of file LTC6945.cpp.

## ◆ get_LTC6946_global_fref_Hz()

unsigned long get_LTC6946_global_fref_Hz | ( |  | ) |

returns global LTC6946_Fref_Hz

Returns
  LTC6946_Fref_Hz

Definition at line 489 of file LTC6946.cpp.

## ◆ get_LTC6946_global_fref_MHz()

unsigned long get_LTC6946_global_fref_MHz | ( |  | ) |

returns global LTC6946_Fref_MHz

Returns
  LTC6946_Fref_MHz

Definition at line 484 of file LTC6946.cpp.

## ◆ get_LTC6946_global_frf_Hz()

unsigned long get_LTC6946_global_frf_Hz | ( |  | ) |

returns global LTC6946_Frf_Hz

Returns
  LTC6946_Frf_Hz

Definition at line 499 of file LTC6946.cpp.

## ◆ get_LTC6946_global_frf_MHz()

unsigned long get_LTC6946_global_frf_MHz | ( |  | ) |

returns global LTC6946_Frf_MHz

Returns
  LTC6946_Frf_MHz

Definition at line 494 of file LTC6946.cpp.

## ◆ get_LTC6946_REGSIZE()

uint8_t get_LTC6946_REGSIZE | ( |  | ) |

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

Returns
  # of addresses in parts register map

Definition at line 232 of file LTC6946.cpp.

## ◆ get_LTC6946_SPI_FIELD()

long get_LTC6946_SPI_FIELD | ( | uint8_t | cs,
|  | uint8_t | f
| ) |  |

Gets the LTC6946 SPI field value calls function LTC6946_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

  cs | Chip Select Pin
  f | SPI field number

Definition at line 154 of file LTC6946.cpp.

## ◆ get_LTC6946_SPI_FIELD_NUMBITS()

uint8_t get_LTC6946_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

  f | SPI field number

Definition at line 242 of file LTC6946.cpp.

## ◆ get_LTC6946_SPI_FIELD_RW()

uint8_t get_LTC6946_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

  f | SPI field number

Definition at line 252 of file LTC6946.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

  an | 64 bit number, 1x2 32 bit array
  MHzPart | integer in MHZ
  HzPart | integer 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

  an | 64 bit number, 1x2 32 bit array
  bigPart | upper 32 bits
  littlePart | lower 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

  an | 64 bit number, in 1x2 32bit array
  ann | 64 bit number, in 1x2 32bit array

Definition at line 848 of file LTC6945.cpp.

## ◆ LTC6946_calc_odiv()

unsigned long LTC6946_calc_odiv | ( | char | part_version[],
|  | unsigned long | frf[2]
| ) |  |

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

Returns
  odiv = 1-6 divider setting for valid frequency, or 999 for invalid frequency

Parameters

  part_version | LTC6946 part number LTC6946-x
  frf | output frequency

Definition at line 510 of file LTC6946.cpp.

## ◆ LTC6946_init()

void LTC6946_init | ( |  | ) |

Initializes the SPI MAP arrays The values set in initialization are used all the LTC6946 SPI/WRITE and read functions (set_LTC6946_SPI_FIELD, get_LTC6946_SPI_FIELD, LTC6946_read, LTC6946_write, etc, etc)

Returns
  void

Definition at line 299 of file LTC6946.cpp.

## ◆ LTC6946_read()

uint8_t LTC6946_read | ( | uint8_t | cs,
|  | int8_t | address
| ) |  |

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

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

Returns
  data that was read from address

Parameters

  cs | Chip Select Pin
  address | Register address for the LTC6946.

Definition at line 98 of file LTC6946.cpp.

## ◆ LTC6946_read_field()

long LTC6946_read_field | ( | uint8_t | cs,
|  | uint8_t | address,
|  | uint8_t | MSB_loc,
|  | uint8_t | numbits
| ) |  |

LTC6946 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

  cs | Chip Select Pin
  address | Register address for the LTC6946.
  MSB_loc | MSB bit location of field
  numbits | length of field (i.e. number of bits in field)

Definition at line 118 of file LTC6946.cpp.

## ◆ LTC6946_set_frf()

void LTC6946_set_frf | ( | char | part_version[] | ) |

FUNCTION: LTC6946_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

  can be modified to the following equations:

  - N = (int) (fvco/fpfd) = (int) frf*O*R/fref

  where:

  - N = ndiv, O= odiv 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) LTC6946-4 max frf/fvco = 6.4GHZ, which is 33 bit number (2^33 = 8.59G)
  - fref (23 bits) LTC6946 min fref = 10MHz, which is a 23 bit number (2^23 = 8.3M)
  - O (3 bits)
  - R (10 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+10b= 46b

  step 5: calculate N(16b), using value from step 1

  - N = (int) frf*O*R/fref
  - max bit count/resolution: 46b-23b = 23b
    Returns
      void

Parameters

  part_version | LTC6946 part number LTC6946-x

Definition at line 609 of file LTC6946.cpp.

## ◆ LTC6946_write()

void LTC6946_write | ( | uint8_t | cs,
|  | uint8_t | address,
|  | uint8_t | Data
| ) |  |

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

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

Returns
  void

Parameters

  cs | Chip Select Pin
  address | Register address for the LTC6946.
  Data | 8-bit data to be written to register

Definition at line 165 of file LTC6946.cpp.

## ◆ LTC6946_write_field()

uint8_t LTC6946_write_field | ( | uint8_t | cs,
|  | long | field_data,
|  | uint8_t | address,
|  | uint8_t | MSB_loc,
|  | uint8_t | numbits
| ) |  |

LTC6946 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

  cs | Chip Select Pin
  field_data | Value field value to be set to
  address | Register address for the LTC6946.
  MSB_loc | MSB bit location of field
  numbits | length of field (i.e. number of bits in field)

Definition at line 181 of file LTC6946.cpp.

## ◆ mul64()

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

64 bit multiply, an=an*ann

Returns
  void

Parameters

  an | 64 bit number, in 1x2 32bit array
  ann | 64 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

  an | 64 bit number, in 1x2 32bit array

Definition at line 698 of file LTC6945.cpp.

## ◆ set_LTC6946_ALLREGS()

void set_LTC6946_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
| ) |  |

Writes values to ALL LTC6946 RW address.

Returns
  void

Parameters

  cs | Chip Select Pin
  reg01 | LTC6946 register 1
  reg02 | LTC6946 register 2
  reg03 | LTC6946 register 3
  reg04 | LTC6946 register 4
  reg05 | LTC6946 register 5
  reg06 | LTC6946 register 6
  reg07 | LTC6946 register 7
  reg08 | LTC6946 register 8
  reg09 | LTC6946 register 9
  reg0A | LTC6946 register 10

Definition at line 275 of file LTC6946.cpp.

## ◆ set_LTC6946_global_fref()

void set_LTC6946_global_fref | ( | unsigned long | fref_MHz,
|  | unsigned long | fref_Hz
| ) |  |

sets globals LTC6946_Fref_MHz and LTC6946_Fref_Hz

Returns
  void

Definition at line 472 of file LTC6946.cpp.

## ◆ set_LTC6946_global_frf()

void set_LTC6946_global_frf | ( | unsigned long | frf_MHz,
|  | unsigned long | frf_Hz
| ) |  |

sets globals LTC6946_Frf_MHz and LTC6946_Frf_Hz

Returns
  void

Definition at line 478 of file LTC6946.cpp.

## ◆ set_LTC6946_SPI_FIELD()

void set_LTC6946_SPI_FIELD | ( | uint8_t | cs,
|  | uint8_t | f,
|  | long | field_data
| ) |  |

Sets the LTC6946 SPI field value calls function LTC6946_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

  cs | Chip Select Pin
  f | SPI field number
  field_data | Value field value to be set to

Definition at line 265 of file LTC6946.cpp.

## ◆ shl64()

void shl64 | ( | unsigned long | an[] | ) |

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

Returns
  void

Parameters

  an | an[] = 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

  an | an[] = an[]<<shiftnum
  shiftnum | number 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

  an | an[] = 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

  an | an[] = an[]>>shiftnum
  shiftnum | number 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

  an | 64 bit number, in 1x2 32bit array
  ann | 64 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 127 of file LTC6946.h.

## ◆ DxMSB

#define DxMSB 1

used for 2nd dim of 2d spi_map array

Definition at line 128 of file LTC6946.h.

## ◆ LTC6946_1_MAXFREQ

#define LTC6946_1_MAXFREQ 3740

LTC6946-1 upper freq limit.

Definition at line 134 of file LTC6946.h.

## ◆ LTC6946_1_MINFREQ

#define LTC6946_1_MINFREQ 2240

LTC6946-1 lower freq limit.

Definition at line 139 of file LTC6946.h.

## ◆ LTC6946_2_MAXFREQ

#define LTC6946_2_MAXFREQ 4910

LTC6946-2 upper freq limit.

Definition at line 135 of file LTC6946.h.

## ◆ LTC6946_2_MINFREQ

#define LTC6946_2_MINFREQ 3080

LTC6946-2 lower freq limit.

Definition at line 140 of file LTC6946.h.

## ◆ LTC6946_3_MAXFREQ

#define LTC6946_3_MAXFREQ 5790

LTC6946-3 upper freq limit.

Definition at line 136 of file LTC6946.h.

## ◆ LTC6946_3_MINFREQ

#define LTC6946_3_MINFREQ 3840

LTC6946-3 lower freq limit.

Definition at line 141 of file LTC6946.h.

## ◆ LTC6946_4_MAXFREQ

#define LTC6946_4_MAXFREQ 6390

LTC6946-4 upper freq limit.

Definition at line 137 of file LTC6946.h.

## ◆ LTC6946_4_MINFREQ

#define LTC6946_4_MINFREQ 4200

LTC6946-4 lower freq limit.

Definition at line 142 of file LTC6946.h.

## ◆ LTC6946_ALCCAL

#define LTC6946_ALCCAL 1

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

Definition at line 81 of file LTC6946.h.

## ◆ LTC6946_ALCEN

#define LTC6946_ALCEN 2

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

Definition at line 82 of file LTC6946.h.

## ◆ LTC6946_ALCHI

#define LTC6946_ALCHI 3

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

Definition at line 83 of file LTC6946.h.

## ◆ LTC6946_ALCLO

#define LTC6946_ALCLO 4

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

Definition at line 84 of file LTC6946.h.

## ◆ LTC6946_ALCMON

#define LTC6946_ALCMON 5

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

Definition at line 85 of file LTC6946.h.

## ◆ LTC6946_ALCULOK

#define LTC6946_ALCULOK 6

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

Definition at line 86 of file LTC6946.h.

## ◆ LTC6946_BD

#define LTC6946_BD 7

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

Definition at line 87 of file LTC6946.h.

## ◆ LTC6946_BST

#define LTC6946_BST 8

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

Definition at line 88 of file LTC6946.h.

## ◆ LTC6946_CAL

#define LTC6946_CAL 9

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

Definition at line 89 of file LTC6946.h.

## ◆ LTC6946_CP

#define LTC6946_CP 10

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

Definition at line 90 of file LTC6946.h.

## ◆ LTC6946_CPCHI

#define LTC6946_CPCHI 11

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

Definition at line 91 of file LTC6946.h.

## ◆ LTC6946_CPCLO

#define LTC6946_CPCLO 12

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

Definition at line 92 of file LTC6946.h.

## ◆ LTC6946_CPDN

#define LTC6946_CPDN 13

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

Definition at line 93 of file LTC6946.h.

## ◆ LTC6946_CPINV

#define LTC6946_CPINV 14

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

Definition at line 94 of file LTC6946.h.

## ◆ LTC6946_CPMID

#define LTC6946_CPMID 15

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

Definition at line 95 of file LTC6946.h.

## ◆ LTC6946_CPRST

#define LTC6946_CPRST 16

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

Definition at line 96 of file LTC6946.h.

## ◆ LTC6946_CPUP

#define LTC6946_CPUP 17

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

Definition at line 97 of file LTC6946.h.

## ◆ LTC6946_CPWIDE

#define LTC6946_CPWIDE 18

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

Definition at line 98 of file LTC6946.h.

## ◆ LTC6946_CS

#define LTC6946_CS QUIKEVAL_CS

Define the SPI CS pin.

Definition at line 76 of file LTC6946.h.

## ◆ LTC6946_FILT

#define LTC6946_FILT 19

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

Definition at line 99 of file LTC6946.h.

## ◆ LTC6946_LKCT

#define LTC6946_LKCT 20

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

Definition at line 100 of file LTC6946.h.

## ◆ LTC6946_LKEN

#define LTC6946_LKEN 21

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

Definition at line 101 of file LTC6946.h.

## ◆ LTC6946_LKWIN

#define LTC6946_LKWIN 22

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

Definition at line 102 of file LTC6946.h.

## ◆ LTC6946_LOCK

#define LTC6946_LOCK 23

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

Definition at line 103 of file LTC6946.h.

## ◆ LTC6946_MAX_REF_FREQ

#define LTC6946_MAX_REF_FREQ 250

LTC6946 upper reference frequency limit.

Definition at line 145 of file LTC6946.h.

## ◆ LTC6946_MIN_REF_FREQ

#define LTC6946_MIN_REF_FREQ 10

LTC6946 lower reference frequency limit.

Definition at line 144 of file LTC6946.h.

## ◆ LTC6946_MTCAL

#define LTC6946_MTCAL 24

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

Definition at line 104 of file LTC6946.h.

## ◆ LTC6946_ND

#define LTC6946_ND 25

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

Definition at line 105 of file LTC6946.h.

## ◆ LTC6946_NUM_REGADDR

#define LTC6946_NUM_REGADDR 12

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

Definition at line 124 of file LTC6946.h.

## ◆ LTC6946_NUM_REGFIELD

#define LTC6946_NUM_REGFIELD 41

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

Definition at line 125 of file LTC6946.h.

## ◆ LTC6946_OD

#define LTC6946_OD 26

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

Definition at line 106 of file LTC6946.h.

## ◆ LTC6946_OMUTE

#define LTC6946_OMUTE 27

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

Definition at line 107 of file LTC6946.h.

## ◆ LTC6946_PART

#define LTC6946_PART 28

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

Definition at line 108 of file LTC6946.h.

## ◆ LTC6946_PDALL

#define LTC6946_PDALL 29

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

Definition at line 109 of file LTC6946.h.

## ◆ LTC6946_PDOUT

#define LTC6946_PDOUT 30

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

Definition at line 110 of file LTC6946.h.

## ◆ LTC6946_PDPLL

#define LTC6946_PDPLL 31

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

Definition at line 111 of file LTC6946.h.

## ◆ LTC6946_PDREFO

#define LTC6946_PDREFO 32

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

Definition at line 112 of file LTC6946.h.

## ◆ LTC6946_PDVCO

#define LTC6946_PDVCO 33

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

Definition at line 113 of file LTC6946.h.

## ◆ LTC6946_POR

#define LTC6946_POR 34

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

Definition at line 114 of file LTC6946.h.

## ◆ LTC6946_RD

#define LTC6946_RD 35

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

Definition at line 115 of file LTC6946.h.

## ◆ LTC6946_REV

#define LTC6946_REV 36

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

Definition at line 116 of file LTC6946.h.

## ◆ LTC6946_RFO

#define LTC6946_RFO 37

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

Definition at line 117 of file LTC6946.h.

## ◆ LTC6946_THI

#define LTC6946_THI 38

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

Definition at line 118 of file LTC6946.h.

## ◆ LTC6946_TLO

#define LTC6946_TLO 39

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

Definition at line 119 of file LTC6946.h.

## ◆ LTC6946_UNLOK

#define LTC6946_UNLOK 40

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

Definition at line 120 of file LTC6946.h.

## ◆ LTC6946_x

#define LTC6946_x 41

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

Definition at line 121 of file LTC6946.h.

## ◆ NUMBITS

#define NUMBITS 2

used for 2nd dim of 2d spi_map array

Definition at line 129 of file LTC6946.h.

## ◆ OneMHz

#define OneMHz 1000000L

1MHz in long format, used in 64 bit math

Definition at line 132 of file LTC6946.h.

## ◆ R_ONLY

#define R_ONLY 3

used for 2nd dim of 2d spi_map array

Definition at line 130 of file LTC6946.h.