Linduino  1.3.0
Linear Technology Arduino-Compatible Demonstration Board

LTC6954: Low Phase Noise, Triple Output Clock Distribution Divider/Driver. More...

Detailed Description

LTC6954: Low Phase Noise, Triple Output Clock Distribution Divider/Driver.

 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/LTC6954

http://www.linear.com/product/LTC6954#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 LTC6954: Low Phase Noise, Triple Output Clock Distribution Divider/Driver

Definition in file LTC6954.h.

Go to the source code of this file.

Functions

uint8_t LTC6954_read (uint8_t cs, int8_t address)
 LTC6954 Read Single Address reads 8 bit Data field to LTC6954. More...
 
long LTC6954_read_field (uint8_t cs, uint8_t address, uint8_t MSB_loc, uint8_t numbits)
 LTC6954 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_LTC6954_SPI_FIELD (uint8_t cs, uint8_t f)
 Gets the LTC6954 SPI field value calls function LTC6954_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 LTC6954_write (uint8_t cs, uint8_t address, uint8_t Data)
 LTC6954 Write Single Address writes 8 bit Data field to LTC6954. More...
 
uint8_t LTC6954_write_field (uint8_t cs, long field_data, uint8_t address, uint8_t MSB_loc, uint8_t numbits)
 LTC6954 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_LTC6954_SPI_FIELD (uint8_t cs, uint8_t f, long field_data)
 Sets the LTC6954 SPI field value calls function LTC6954_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_LTC6954_ALLREGS (uint8_t cs, uint8_t reg00, uint8_t reg01, uint8_t reg02, uint8_t reg03, uint8_t reg04, uint8_t reg05, uint8_t reg06)
 Writes values to ALL LTC6954 RW address. More...
 
void LTC6954_init ()
 Initializes the SPI MAP arrays The values set in initialization are used all the LTC6954 SPI/WRITE and read functions (set_LTC6954_SPI_FIELD, get_LTC6954_SPI_FIELD, LTC6954_read, LTC6954_write, etc, etc) More...
 
uint8_t get_LTC6954_REGSIZE ()
 returns # of addresses in parts register map (array size) More...
 
uint8_t get_LTC6954_SPI_FIELD_NUMBITS (uint8_t f)
 returns the number of bits for a given field name in the SPI map More...
 
uint8_t get_LTC6954_SPI_FIELD_RW (uint8_t f)
 returns if the given field name is (0)read/write or (1)read_only field More...
 

Macros

#define LTC6954_CS   QUIKEVAL_CS
 Define the SPI CS pin. More...
 
LTC6954 Registers Fields in Alphabetical Order
#define LTC6954_CMSINV0   1
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_CMSINV1   2
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_CMSINV2   3
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_DEL0   4
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_DEL1   5
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_DEL2   6
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_LVCS0   7
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_LVCS1   8
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_LVCS2   9
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_M0   10
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_M1   11
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_M2   12
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PART   13
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PDALL   14
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PD_DIV0   15
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PD_DIV1   16
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PD_DIV2   17
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PD_OUT0   18
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PD_OUT1   19
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_PD_OUT2   20
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_REV   21
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_SYNC_EN0   22
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_SYNC_EN1   23
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_SYNC_EN2   24
 for spi_map array, defines location for field specific information used to create the spi map More...
 
#define LTC6954_NUM_REGADDR   8
 Defines number of LTC6954 SPI registers, used in spi_map array. More...
 
#define LTC6954_NUM_REGFIELD   24
 Defines number of LTC6954 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...
 

Function Documentation

◆ get_LTC6954_REGSIZE()

uint8_t get_LTC6954_REGSIZE ( )

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

Returns
# of addresses in parts register map

Definition at line 239 of file LTC6954.cpp.

◆ get_LTC6954_SPI_FIELD()

long get_LTC6954_SPI_FIELD ( uint8_t  cs,
uint8_t  f 
)

Gets the LTC6954 SPI field value calls function LTC6954_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 161 of file LTC6954.cpp.

◆ get_LTC6954_SPI_FIELD_NUMBITS()

uint8_t get_LTC6954_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 249 of file LTC6954.cpp.

◆ get_LTC6954_SPI_FIELD_RW()

uint8_t get_LTC6954_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 259 of file LTC6954.cpp.

◆ LTC6954_init()

void LTC6954_init ( )

Initializes the SPI MAP arrays The values set in initialization are used all the LTC6954 SPI/WRITE and read functions (set_LTC6954_SPI_FIELD, get_LTC6954_SPI_FIELD, LTC6954_read, LTC6954_write, etc, etc)

Returns
void

Definition at line 304 of file LTC6954.cpp.

◆ LTC6954_read()

uint8_t LTC6954_read ( uint8_t  cs,
int8_t  address 
)

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

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 LTC6954.

Definition at line 105 of file LTC6954.cpp.

◆ LTC6954_read_field()

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

LTC6954 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 LTC6954.
MSB_locMSB bit location of field
numbitslength of field (i.e. number of bits in field)

Definition at line 125 of file LTC6954.cpp.

◆ LTC6954_write()

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

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

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

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

Definition at line 172 of file LTC6954.cpp.

◆ LTC6954_write_field()

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

LTC6954 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 LTC6954.
MSB_locMSB bit location of field
numbitslength of field (i.e. number of bits in field)

Definition at line 188 of file LTC6954.cpp.

◆ set_LTC6954_ALLREGS()

void set_LTC6954_ALLREGS ( uint8_t  cs,
uint8_t  reg00,
uint8_t  reg01,
uint8_t  reg02,
uint8_t  reg03,
uint8_t  reg04,
uint8_t  reg05,
uint8_t  reg06 
)

Writes values to ALL LTC6954 RW address.

Returns
void
Parameters
csChip Select Pin
reg00LTC6954 register 0
reg01LTC6954 register 1
reg02LTC6954 register 2
reg03LTC6954 register 3
reg04LTC6954 register 4
reg05LTC6954 register 5
reg06LTC6954 register 6

Definition at line 282 of file LTC6954.cpp.

◆ set_LTC6954_SPI_FIELD()

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

Sets the LTC6954 SPI field value calls function LTC6954_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 272 of file LTC6954.cpp.

Macro Definition Documentation

◆ ADDRx

#define ADDRx   0

used for 2nd dim of 2d spi_map array

Definition at line 109 of file LTC6954.h.

◆ DxMSB

#define DxMSB   1

used for 2nd dim of 2d spi_map array

Definition at line 110 of file LTC6954.h.

◆ LTC6954_CMSINV0

#define LTC6954_CMSINV0   1

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

Definition at line 81 of file LTC6954.h.

◆ LTC6954_CMSINV1

#define LTC6954_CMSINV1   2

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

Definition at line 82 of file LTC6954.h.

◆ LTC6954_CMSINV2

#define LTC6954_CMSINV2   3

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

Definition at line 83 of file LTC6954.h.

◆ LTC6954_CS

#define LTC6954_CS   QUIKEVAL_CS

Define the SPI CS pin.

Definition at line 76 of file LTC6954.h.

◆ LTC6954_DEL0

#define LTC6954_DEL0   4

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

Definition at line 84 of file LTC6954.h.

◆ LTC6954_DEL1

#define LTC6954_DEL1   5

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

Definition at line 85 of file LTC6954.h.

◆ LTC6954_DEL2

#define LTC6954_DEL2   6

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

Definition at line 86 of file LTC6954.h.

◆ LTC6954_LVCS0

#define LTC6954_LVCS0   7

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

Definition at line 87 of file LTC6954.h.

◆ LTC6954_LVCS1

#define LTC6954_LVCS1   8

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

Definition at line 88 of file LTC6954.h.

◆ LTC6954_LVCS2

#define LTC6954_LVCS2   9

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

Definition at line 89 of file LTC6954.h.

◆ LTC6954_M0

#define LTC6954_M0   10

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

Definition at line 90 of file LTC6954.h.

◆ LTC6954_M1

#define LTC6954_M1   11

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

Definition at line 91 of file LTC6954.h.

◆ LTC6954_M2

#define LTC6954_M2   12

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

Definition at line 92 of file LTC6954.h.

◆ LTC6954_NUM_REGADDR

#define LTC6954_NUM_REGADDR   8

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

Definition at line 106 of file LTC6954.h.

◆ LTC6954_NUM_REGFIELD

#define LTC6954_NUM_REGFIELD   24

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

Definition at line 107 of file LTC6954.h.

◆ LTC6954_PART

#define LTC6954_PART   13

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

Definition at line 93 of file LTC6954.h.

◆ LTC6954_PD_DIV0

#define LTC6954_PD_DIV0   15

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

Definition at line 95 of file LTC6954.h.

◆ LTC6954_PD_DIV1

#define LTC6954_PD_DIV1   16

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

Definition at line 96 of file LTC6954.h.

◆ LTC6954_PD_DIV2

#define LTC6954_PD_DIV2   17

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

Definition at line 97 of file LTC6954.h.

◆ LTC6954_PD_OUT0

#define LTC6954_PD_OUT0   18

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

Definition at line 98 of file LTC6954.h.

◆ LTC6954_PD_OUT1

#define LTC6954_PD_OUT1   19

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

Definition at line 99 of file LTC6954.h.

◆ LTC6954_PD_OUT2

#define LTC6954_PD_OUT2   20

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

Definition at line 100 of file LTC6954.h.

◆ LTC6954_PDALL

#define LTC6954_PDALL   14

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

Definition at line 94 of file LTC6954.h.

◆ LTC6954_REV

#define LTC6954_REV   21

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

Definition at line 101 of file LTC6954.h.

◆ LTC6954_SYNC_EN0

#define LTC6954_SYNC_EN0   22

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

Definition at line 102 of file LTC6954.h.

◆ LTC6954_SYNC_EN1

#define LTC6954_SYNC_EN1   23

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

Definition at line 103 of file LTC6954.h.

◆ LTC6954_SYNC_EN2

#define LTC6954_SYNC_EN2   24

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

Definition at line 104 of file LTC6954.h.

◆ NUMBITS

#define NUMBITS   2

used for 2nd dim of 2d spi_map array

Definition at line 111 of file LTC6954.h.

◆ R_ONLY

#define R_ONLY   3

used for 2nd dim of 2d spi_map array

Definition at line 112 of file LTC6954.h.