mirror of
https://github.com/JeffersGlass/DDS_VFO.git
synced 2024-11-26 18:27:36 -06:00
Added support libraries
Uploaded Si5351 library and encoder library
This commit is contained in:
JeffersGlass
parent
e126029540
commit
810a91b366
10
Encoder/Encoder.cpp
Normal file
10
Encoder/Encoder.cpp
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
|
||||
#include "Encoder.h"
|
||||
|
||||
// Yes, all the code is in the header file, to provide the user
|
||||
// configure options with #define (before they include it), and
|
||||
// to facilitate some crafty optimizations!
|
||||
|
||||
Encoder_internal_state_t * Encoder::interruptArgs[];
|
||||
|
||||
|
||||
942
Encoder/Encoder.h
Normal file
942
Encoder/Encoder.h
Normal file
|
|
@ -0,0 +1,942 @@
|
|||
/* Encoder Library, for measuring quadrature encoded signals
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
* Copyright (c) 2011,2013 PJRC.COM, LLC - Paul Stoffregen <paul@pjrc.com>
|
||||
*
|
||||
* Version 1.2 - fix -2 bug in C-only code
|
||||
* Version 1.1 - expand to support boards with up to 60 interrupts
|
||||
* Version 1.0 - initial release
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
|
||||
|
||||
#ifndef Encoder_h_
|
||||
#define Encoder_h_
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
#include "Arduino.h"
|
||||
#elif defined(WIRING)
|
||||
#include "Wiring.h"
|
||||
#else
|
||||
#include "WProgram.h"
|
||||
#include "pins_arduino.h"
|
||||
#endif
|
||||
|
||||
#include "utility/direct_pin_read.h"
|
||||
|
||||
#if defined(ENCODER_USE_INTERRUPTS) || !defined(ENCODER_DO_NOT_USE_INTERRUPTS)
|
||||
#define ENCODER_USE_INTERRUPTS
|
||||
#define ENCODER_ARGLIST_SIZE CORE_NUM_INTERRUPT
|
||||
#include "utility/interrupt_pins.h"
|
||||
#ifdef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#include "utility/interrupt_config.h"
|
||||
#endif
|
||||
#else
|
||||
#define ENCODER_ARGLIST_SIZE 0
|
||||
#endif
|
||||
|
||||
|
||||
|
||||
// All the data needed by interrupts is consolidated into this ugly struct
|
||||
// to facilitate assembly language optimizing of the speed critical update.
|
||||
// The assembly code uses auto-incrementing addressing modes, so the struct
|
||||
// must remain in exactly this order.
|
||||
typedef struct {
|
||||
volatile IO_REG_TYPE * pin1_register;
|
||||
volatile IO_REG_TYPE * pin2_register;
|
||||
IO_REG_TYPE pin1_bitmask;
|
||||
IO_REG_TYPE pin2_bitmask;
|
||||
uint8_t state;
|
||||
int32_t position;
|
||||
} Encoder_internal_state_t;
|
||||
|
||||
class Encoder
|
||||
{
|
||||
public:
|
||||
Encoder(uint8_t pin1, uint8_t pin2) {
|
||||
#ifdef INPUT_PULLUP
|
||||
pinMode(pin1, INPUT_PULLUP);
|
||||
pinMode(pin2, INPUT_PULLUP);
|
||||
#else
|
||||
pinMode(pin1, INPUT);
|
||||
digitalWrite(pin1, HIGH);
|
||||
pinMode(pin2, INPUT);
|
||||
digitalWrite(pin2, HIGH);
|
||||
#endif
|
||||
encoder.pin1_register = PIN_TO_BASEREG(pin1);
|
||||
encoder.pin1_bitmask = PIN_TO_BITMASK(pin1);
|
||||
encoder.pin2_register = PIN_TO_BASEREG(pin2);
|
||||
encoder.pin2_bitmask = PIN_TO_BITMASK(pin2);
|
||||
encoder.position = 0;
|
||||
// allow time for a passive R-C filter to charge
|
||||
// through the pullup resistors, before reading
|
||||
// the initial state
|
||||
delayMicroseconds(2000);
|
||||
uint8_t s = 0;
|
||||
if (DIRECT_PIN_READ(encoder.pin1_register, encoder.pin1_bitmask)) s |= 1;
|
||||
if (DIRECT_PIN_READ(encoder.pin2_register, encoder.pin2_bitmask)) s |= 2;
|
||||
encoder.state = s;
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
interrupts_in_use = attach_interrupt(pin1, &encoder);
|
||||
interrupts_in_use += attach_interrupt(pin2, &encoder);
|
||||
#endif
|
||||
//update_finishup(); // to force linker to include the code (does not work)
|
||||
}
|
||||
|
||||
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
inline int32_t read() {
|
||||
if (interrupts_in_use < 2) {
|
||||
noInterrupts();
|
||||
update(&encoder);
|
||||
} else {
|
||||
noInterrupts();
|
||||
}
|
||||
int32_t ret = encoder.position;
|
||||
interrupts();
|
||||
return ret;
|
||||
}
|
||||
inline void write(int32_t p) {
|
||||
noInterrupts();
|
||||
encoder.position = p;
|
||||
interrupts();
|
||||
}
|
||||
#else
|
||||
inline int32_t read() {
|
||||
update(&encoder);
|
||||
return encoder.position;
|
||||
}
|
||||
inline void write(int32_t p) {
|
||||
encoder.position = p;
|
||||
}
|
||||
#endif
|
||||
private:
|
||||
Encoder_internal_state_t encoder;
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
uint8_t interrupts_in_use;
|
||||
#endif
|
||||
public:
|
||||
static Encoder_internal_state_t * interruptArgs[ENCODER_ARGLIST_SIZE];
|
||||
|
||||
// _______ _______
|
||||
// Pin1 ______| |_______| |______ Pin1
|
||||
// negative <--- _______ _______ __ --> positive
|
||||
// Pin2 __| |_______| |_______| Pin2
|
||||
|
||||
// new new old old
|
||||
// pin2 pin1 pin2 pin1 Result
|
||||
// ---- ---- ---- ---- ------
|
||||
// 0 0 0 0 no movement
|
||||
// 0 0 0 1 +1
|
||||
// 0 0 1 0 -1
|
||||
// 0 0 1 1 +2 (assume pin1 edges only)
|
||||
// 0 1 0 0 -1
|
||||
// 0 1 0 1 no movement
|
||||
// 0 1 1 0 -2 (assume pin1 edges only)
|
||||
// 0 1 1 1 +1
|
||||
// 1 0 0 0 +1
|
||||
// 1 0 0 1 -2 (assume pin1 edges only)
|
||||
// 1 0 1 0 no movement
|
||||
// 1 0 1 1 -1
|
||||
// 1 1 0 0 +2 (assume pin1 edges only)
|
||||
// 1 1 0 1 -1
|
||||
// 1 1 1 0 +1
|
||||
// 1 1 1 1 no movement
|
||||
/*
|
||||
// Simple, easy-to-read "documentation" version :-)
|
||||
//
|
||||
void update(void) {
|
||||
uint8_t s = state & 3;
|
||||
if (digitalRead(pin1)) s |= 4;
|
||||
if (digitalRead(pin2)) s |= 8;
|
||||
switch (s) {
|
||||
case 0: case 5: case 10: case 15:
|
||||
break;
|
||||
case 1: case 7: case 8: case 14:
|
||||
position++; break;
|
||||
case 2: case 4: case 11: case 13:
|
||||
position--; break;
|
||||
case 3: case 12:
|
||||
position += 2; break;
|
||||
default:
|
||||
position -= 2; break;
|
||||
}
|
||||
state = (s >> 2);
|
||||
}
|
||||
*/
|
||||
|
||||
private:
|
||||
static void update(Encoder_internal_state_t *arg) {
|
||||
#if defined(__AVR__)
|
||||
// The compiler believes this is just 1 line of code, so
|
||||
// it will inline this function into each interrupt
|
||||
// handler. That's a tiny bit faster, but grows the code.
|
||||
// Especially when used with ENCODER_OPTIMIZE_INTERRUPTS,
|
||||
// the inline nature allows the ISR prologue and epilogue
|
||||
// to only save/restore necessary registers, for very nice
|
||||
// speed increase.
|
||||
asm volatile (
|
||||
"ld r30, X+" "\n\t"
|
||||
"ld r31, X+" "\n\t"
|
||||
"ld r24, Z" "\n\t" // r24 = pin1 input
|
||||
"ld r30, X+" "\n\t"
|
||||
"ld r31, X+" "\n\t"
|
||||
"ld r25, Z" "\n\t" // r25 = pin2 input
|
||||
"ld r30, X+" "\n\t" // r30 = pin1 mask
|
||||
"ld r31, X+" "\n\t" // r31 = pin2 mask
|
||||
"ld r22, X" "\n\t" // r22 = state
|
||||
"andi r22, 3" "\n\t"
|
||||
"and r24, r30" "\n\t"
|
||||
"breq L%=1" "\n\t" // if (pin1)
|
||||
"ori r22, 4" "\n\t" // state |= 4
|
||||
"L%=1:" "and r25, r31" "\n\t"
|
||||
"breq L%=2" "\n\t" // if (pin2)
|
||||
"ori r22, 8" "\n\t" // state |= 8
|
||||
"L%=2:" "ldi r30, lo8(pm(L%=table))" "\n\t"
|
||||
"ldi r31, hi8(pm(L%=table))" "\n\t"
|
||||
"add r30, r22" "\n\t"
|
||||
"adc r31, __zero_reg__" "\n\t"
|
||||
"asr r22" "\n\t"
|
||||
"asr r22" "\n\t"
|
||||
"st X+, r22" "\n\t" // store new state
|
||||
"ld r22, X+" "\n\t"
|
||||
"ld r23, X+" "\n\t"
|
||||
"ld r24, X+" "\n\t"
|
||||
"ld r25, X+" "\n\t"
|
||||
"ijmp" "\n\t" // jumps to update_finishup()
|
||||
// TODO move this table to another static function,
|
||||
// so it doesn't get needlessly duplicated. Easier
|
||||
// said than done, due to linker issues and inlining
|
||||
"L%=table:" "\n\t"
|
||||
"rjmp L%=end" "\n\t" // 0
|
||||
"rjmp L%=plus1" "\n\t" // 1
|
||||
"rjmp L%=minus1" "\n\t" // 2
|
||||
"rjmp L%=plus2" "\n\t" // 3
|
||||
"rjmp L%=minus1" "\n\t" // 4
|
||||
"rjmp L%=end" "\n\t" // 5
|
||||
"rjmp L%=minus2" "\n\t" // 6
|
||||
"rjmp L%=plus1" "\n\t" // 7
|
||||
"rjmp L%=plus1" "\n\t" // 8
|
||||
"rjmp L%=minus2" "\n\t" // 9
|
||||
"rjmp L%=end" "\n\t" // 10
|
||||
"rjmp L%=minus1" "\n\t" // 11
|
||||
"rjmp L%=plus2" "\n\t" // 12
|
||||
"rjmp L%=minus1" "\n\t" // 13
|
||||
"rjmp L%=plus1" "\n\t" // 14
|
||||
"rjmp L%=end" "\n\t" // 15
|
||||
"L%=minus2:" "\n\t"
|
||||
"subi r22, 2" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=minus1:" "\n\t"
|
||||
"subi r22, 1" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=plus2:" "\n\t"
|
||||
"subi r22, 254" "\n\t"
|
||||
"rjmp L%=z" "\n\t"
|
||||
"L%=plus1:" "\n\t"
|
||||
"subi r22, 255" "\n\t"
|
||||
"L%=z:" "sbci r23, 255" "\n\t"
|
||||
"sbci r24, 255" "\n\t"
|
||||
"sbci r25, 255" "\n\t"
|
||||
"L%=store:" "\n\t"
|
||||
"st -X, r25" "\n\t"
|
||||
"st -X, r24" "\n\t"
|
||||
"st -X, r23" "\n\t"
|
||||
"st -X, r22" "\n\t"
|
||||
"L%=end:" "\n"
|
||||
: : "x" (arg) : "r22", "r23", "r24", "r25", "r30", "r31");
|
||||
#else
|
||||
uint8_t p1val = DIRECT_PIN_READ(arg->pin1_register, arg->pin1_bitmask);
|
||||
uint8_t p2val = DIRECT_PIN_READ(arg->pin2_register, arg->pin2_bitmask);
|
||||
uint8_t state = arg->state & 3;
|
||||
if (p1val) state |= 4;
|
||||
if (p2val) state |= 8;
|
||||
arg->state = (state >> 2);
|
||||
switch (state) {
|
||||
case 1: case 7: case 8: case 14:
|
||||
arg->position++;
|
||||
return;
|
||||
case 2: case 4: case 11: case 13:
|
||||
arg->position--;
|
||||
return;
|
||||
case 3: case 12:
|
||||
arg->position += 2;
|
||||
return;
|
||||
case 6: case 9:
|
||||
arg->position -= 2;
|
||||
return;
|
||||
}
|
||||
#endif
|
||||
}
|
||||
/*
|
||||
#if defined(__AVR__)
|
||||
// TODO: this must be a no inline function
|
||||
// even noinline does not seem to solve difficult
|
||||
// problems with this. Oh well, it was only meant
|
||||
// to shrink code size - there's no performance
|
||||
// improvement in this, only code size reduction.
|
||||
__attribute__((noinline)) void update_finishup(void) {
|
||||
asm volatile (
|
||||
"ldi r30, lo8(pm(Ltable))" "\n\t"
|
||||
"ldi r31, hi8(pm(Ltable))" "\n\t"
|
||||
"Ltable:" "\n\t"
|
||||
"rjmp L%=end" "\n\t" // 0
|
||||
"rjmp L%=plus1" "\n\t" // 1
|
||||
"rjmp L%=minus1" "\n\t" // 2
|
||||
"rjmp L%=plus2" "\n\t" // 3
|
||||
"rjmp L%=minus1" "\n\t" // 4
|
||||
"rjmp L%=end" "\n\t" // 5
|
||||
"rjmp L%=minus2" "\n\t" // 6
|
||||
"rjmp L%=plus1" "\n\t" // 7
|
||||
"rjmp L%=plus1" "\n\t" // 8
|
||||
"rjmp L%=minus2" "\n\t" // 9
|
||||
"rjmp L%=end" "\n\t" // 10
|
||||
"rjmp L%=minus1" "\n\t" // 11
|
||||
"rjmp L%=plus2" "\n\t" // 12
|
||||
"rjmp L%=minus1" "\n\t" // 13
|
||||
"rjmp L%=plus1" "\n\t" // 14
|
||||
"rjmp L%=end" "\n\t" // 15
|
||||
"L%=minus2:" "\n\t"
|
||||
"subi r22, 2" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=minus1:" "\n\t"
|
||||
"subi r22, 1" "\n\t"
|
||||
"sbci r23, 0" "\n\t"
|
||||
"sbci r24, 0" "\n\t"
|
||||
"sbci r25, 0" "\n\t"
|
||||
"rjmp L%=store" "\n\t"
|
||||
"L%=plus2:" "\n\t"
|
||||
"subi r22, 254" "\n\t"
|
||||
"rjmp L%=z" "\n\t"
|
||||
"L%=plus1:" "\n\t"
|
||||
"subi r22, 255" "\n\t"
|
||||
"L%=z:" "sbci r23, 255" "\n\t"
|
||||
"sbci r24, 255" "\n\t"
|
||||
"sbci r25, 255" "\n\t"
|
||||
"L%=store:" "\n\t"
|
||||
"st -X, r25" "\n\t"
|
||||
"st -X, r24" "\n\t"
|
||||
"st -X, r23" "\n\t"
|
||||
"st -X, r22" "\n\t"
|
||||
"L%=end:" "\n"
|
||||
: : : "r22", "r23", "r24", "r25", "r30", "r31");
|
||||
}
|
||||
#endif
|
||||
*/
|
||||
|
||||
|
||||
#ifdef ENCODER_USE_INTERRUPTS
|
||||
// this giant function is an unfortunate consequence of Arduino's
|
||||
// attachInterrupt function not supporting any way to pass a pointer
|
||||
// or other context to the attached function.
|
||||
static uint8_t attach_interrupt(uint8_t pin, Encoder_internal_state_t *state) {
|
||||
switch (pin) {
|
||||
#ifdef CORE_INT0_PIN
|
||||
case CORE_INT0_PIN:
|
||||
interruptArgs[0] = state;
|
||||
attachInterrupt(0, isr0, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT1_PIN
|
||||
case CORE_INT1_PIN:
|
||||
interruptArgs[1] = state;
|
||||
attachInterrupt(1, isr1, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT2_PIN
|
||||
case CORE_INT2_PIN:
|
||||
interruptArgs[2] = state;
|
||||
attachInterrupt(2, isr2, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT3_PIN
|
||||
case CORE_INT3_PIN:
|
||||
interruptArgs[3] = state;
|
||||
attachInterrupt(3, isr3, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT4_PIN
|
||||
case CORE_INT4_PIN:
|
||||
interruptArgs[4] = state;
|
||||
attachInterrupt(4, isr4, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT5_PIN
|
||||
case CORE_INT5_PIN:
|
||||
interruptArgs[5] = state;
|
||||
attachInterrupt(5, isr5, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT6_PIN
|
||||
case CORE_INT6_PIN:
|
||||
interruptArgs[6] = state;
|
||||
attachInterrupt(6, isr6, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT7_PIN
|
||||
case CORE_INT7_PIN:
|
||||
interruptArgs[7] = state;
|
||||
attachInterrupt(7, isr7, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT8_PIN
|
||||
case CORE_INT8_PIN:
|
||||
interruptArgs[8] = state;
|
||||
attachInterrupt(8, isr8, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT9_PIN
|
||||
case CORE_INT9_PIN:
|
||||
interruptArgs[9] = state;
|
||||
attachInterrupt(9, isr9, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT10_PIN
|
||||
case CORE_INT10_PIN:
|
||||
interruptArgs[10] = state;
|
||||
attachInterrupt(10, isr10, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT11_PIN
|
||||
case CORE_INT11_PIN:
|
||||
interruptArgs[11] = state;
|
||||
attachInterrupt(11, isr11, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT12_PIN
|
||||
case CORE_INT12_PIN:
|
||||
interruptArgs[12] = state;
|
||||
attachInterrupt(12, isr12, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT13_PIN
|
||||
case CORE_INT13_PIN:
|
||||
interruptArgs[13] = state;
|
||||
attachInterrupt(13, isr13, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT14_PIN
|
||||
case CORE_INT14_PIN:
|
||||
interruptArgs[14] = state;
|
||||
attachInterrupt(14, isr14, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT15_PIN
|
||||
case CORE_INT15_PIN:
|
||||
interruptArgs[15] = state;
|
||||
attachInterrupt(15, isr15, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT16_PIN
|
||||
case CORE_INT16_PIN:
|
||||
interruptArgs[16] = state;
|
||||
attachInterrupt(16, isr16, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT17_PIN
|
||||
case CORE_INT17_PIN:
|
||||
interruptArgs[17] = state;
|
||||
attachInterrupt(17, isr17, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT18_PIN
|
||||
case CORE_INT18_PIN:
|
||||
interruptArgs[18] = state;
|
||||
attachInterrupt(18, isr18, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT19_PIN
|
||||
case CORE_INT19_PIN:
|
||||
interruptArgs[19] = state;
|
||||
attachInterrupt(19, isr19, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT20_PIN
|
||||
case CORE_INT20_PIN:
|
||||
interruptArgs[20] = state;
|
||||
attachInterrupt(20, isr20, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT21_PIN
|
||||
case CORE_INT21_PIN:
|
||||
interruptArgs[21] = state;
|
||||
attachInterrupt(21, isr21, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT22_PIN
|
||||
case CORE_INT22_PIN:
|
||||
interruptArgs[22] = state;
|
||||
attachInterrupt(22, isr22, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT23_PIN
|
||||
case CORE_INT23_PIN:
|
||||
interruptArgs[23] = state;
|
||||
attachInterrupt(23, isr23, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT24_PIN
|
||||
case CORE_INT24_PIN:
|
||||
interruptArgs[24] = state;
|
||||
attachInterrupt(24, isr24, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT25_PIN
|
||||
case CORE_INT25_PIN:
|
||||
interruptArgs[25] = state;
|
||||
attachInterrupt(25, isr25, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT26_PIN
|
||||
case CORE_INT26_PIN:
|
||||
interruptArgs[26] = state;
|
||||
attachInterrupt(26, isr26, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT27_PIN
|
||||
case CORE_INT27_PIN:
|
||||
interruptArgs[27] = state;
|
||||
attachInterrupt(27, isr27, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT28_PIN
|
||||
case CORE_INT28_PIN:
|
||||
interruptArgs[28] = state;
|
||||
attachInterrupt(28, isr28, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT29_PIN
|
||||
case CORE_INT29_PIN:
|
||||
interruptArgs[29] = state;
|
||||
attachInterrupt(29, isr29, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
|
||||
#ifdef CORE_INT30_PIN
|
||||
case CORE_INT30_PIN:
|
||||
interruptArgs[30] = state;
|
||||
attachInterrupt(30, isr30, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT31_PIN
|
||||
case CORE_INT31_PIN:
|
||||
interruptArgs[31] = state;
|
||||
attachInterrupt(31, isr31, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT32_PIN
|
||||
case CORE_INT32_PIN:
|
||||
interruptArgs[32] = state;
|
||||
attachInterrupt(32, isr32, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT33_PIN
|
||||
case CORE_INT33_PIN:
|
||||
interruptArgs[33] = state;
|
||||
attachInterrupt(33, isr33, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT34_PIN
|
||||
case CORE_INT34_PIN:
|
||||
interruptArgs[34] = state;
|
||||
attachInterrupt(34, isr34, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT35_PIN
|
||||
case CORE_INT35_PIN:
|
||||
interruptArgs[35] = state;
|
||||
attachInterrupt(35, isr35, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT36_PIN
|
||||
case CORE_INT36_PIN:
|
||||
interruptArgs[36] = state;
|
||||
attachInterrupt(36, isr36, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT37_PIN
|
||||
case CORE_INT37_PIN:
|
||||
interruptArgs[37] = state;
|
||||
attachInterrupt(37, isr37, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT38_PIN
|
||||
case CORE_INT38_PIN:
|
||||
interruptArgs[38] = state;
|
||||
attachInterrupt(38, isr38, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT39_PIN
|
||||
case CORE_INT39_PIN:
|
||||
interruptArgs[39] = state;
|
||||
attachInterrupt(39, isr39, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT40_PIN
|
||||
case CORE_INT40_PIN:
|
||||
interruptArgs[40] = state;
|
||||
attachInterrupt(40, isr40, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT41_PIN
|
||||
case CORE_INT41_PIN:
|
||||
interruptArgs[41] = state;
|
||||
attachInterrupt(41, isr41, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT42_PIN
|
||||
case CORE_INT42_PIN:
|
||||
interruptArgs[42] = state;
|
||||
attachInterrupt(42, isr42, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT43_PIN
|
||||
case CORE_INT43_PIN:
|
||||
interruptArgs[43] = state;
|
||||
attachInterrupt(43, isr43, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT44_PIN
|
||||
case CORE_INT44_PIN:
|
||||
interruptArgs[44] = state;
|
||||
attachInterrupt(44, isr44, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT45_PIN
|
||||
case CORE_INT45_PIN:
|
||||
interruptArgs[45] = state;
|
||||
attachInterrupt(45, isr45, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT46_PIN
|
||||
case CORE_INT46_PIN:
|
||||
interruptArgs[46] = state;
|
||||
attachInterrupt(46, isr46, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT47_PIN
|
||||
case CORE_INT47_PIN:
|
||||
interruptArgs[47] = state;
|
||||
attachInterrupt(47, isr47, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT48_PIN
|
||||
case CORE_INT48_PIN:
|
||||
interruptArgs[48] = state;
|
||||
attachInterrupt(48, isr48, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT49_PIN
|
||||
case CORE_INT49_PIN:
|
||||
interruptArgs[49] = state;
|
||||
attachInterrupt(49, isr49, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT50_PIN
|
||||
case CORE_INT50_PIN:
|
||||
interruptArgs[50] = state;
|
||||
attachInterrupt(50, isr50, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT51_PIN
|
||||
case CORE_INT51_PIN:
|
||||
interruptArgs[51] = state;
|
||||
attachInterrupt(51, isr51, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT52_PIN
|
||||
case CORE_INT52_PIN:
|
||||
interruptArgs[52] = state;
|
||||
attachInterrupt(52, isr52, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT53_PIN
|
||||
case CORE_INT53_PIN:
|
||||
interruptArgs[53] = state;
|
||||
attachInterrupt(53, isr53, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT54_PIN
|
||||
case CORE_INT54_PIN:
|
||||
interruptArgs[54] = state;
|
||||
attachInterrupt(54, isr54, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT55_PIN
|
||||
case CORE_INT55_PIN:
|
||||
interruptArgs[55] = state;
|
||||
attachInterrupt(55, isr55, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT56_PIN
|
||||
case CORE_INT56_PIN:
|
||||
interruptArgs[56] = state;
|
||||
attachInterrupt(56, isr56, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT57_PIN
|
||||
case CORE_INT57_PIN:
|
||||
interruptArgs[57] = state;
|
||||
attachInterrupt(57, isr57, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT58_PIN
|
||||
case CORE_INT58_PIN:
|
||||
interruptArgs[58] = state;
|
||||
attachInterrupt(58, isr58, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
#ifdef CORE_INT59_PIN
|
||||
case CORE_INT59_PIN:
|
||||
interruptArgs[59] = state;
|
||||
attachInterrupt(59, isr59, CHANGE);
|
||||
break;
|
||||
#endif
|
||||
default:
|
||||
return 0;
|
||||
}
|
||||
return 1;
|
||||
}
|
||||
#endif // ENCODER_USE_INTERRUPTS
|
||||
|
||||
|
||||
#if defined(ENCODER_USE_INTERRUPTS) && !defined(ENCODER_OPTIMIZE_INTERRUPTS)
|
||||
#ifdef CORE_INT0_PIN
|
||||
static void isr0(void) { update(interruptArgs[0]); }
|
||||
#endif
|
||||
#ifdef CORE_INT1_PIN
|
||||
static void isr1(void) { update(interruptArgs[1]); }
|
||||
#endif
|
||||
#ifdef CORE_INT2_PIN
|
||||
static void isr2(void) { update(interruptArgs[2]); }
|
||||
#endif
|
||||
#ifdef CORE_INT3_PIN
|
||||
static void isr3(void) { update(interruptArgs[3]); }
|
||||
#endif
|
||||
#ifdef CORE_INT4_PIN
|
||||
static void isr4(void) { update(interruptArgs[4]); }
|
||||
#endif
|
||||
#ifdef CORE_INT5_PIN
|
||||
static void isr5(void) { update(interruptArgs[5]); }
|
||||
#endif
|
||||
#ifdef CORE_INT6_PIN
|
||||
static void isr6(void) { update(interruptArgs[6]); }
|
||||
#endif
|
||||
#ifdef CORE_INT7_PIN
|
||||
static void isr7(void) { update(interruptArgs[7]); }
|
||||
#endif
|
||||
#ifdef CORE_INT8_PIN
|
||||
static void isr8(void) { update(interruptArgs[8]); }
|
||||
#endif
|
||||
#ifdef CORE_INT9_PIN
|
||||
static void isr9(void) { update(interruptArgs[9]); }
|
||||
#endif
|
||||
#ifdef CORE_INT10_PIN
|
||||
static void isr10(void) { update(interruptArgs[10]); }
|
||||
#endif
|
||||
#ifdef CORE_INT11_PIN
|
||||
static void isr11(void) { update(interruptArgs[11]); }
|
||||
#endif
|
||||
#ifdef CORE_INT12_PIN
|
||||
static void isr12(void) { update(interruptArgs[12]); }
|
||||
#endif
|
||||
#ifdef CORE_INT13_PIN
|
||||
static void isr13(void) { update(interruptArgs[13]); }
|
||||
#endif
|
||||
#ifdef CORE_INT14_PIN
|
||||
static void isr14(void) { update(interruptArgs[14]); }
|
||||
#endif
|
||||
#ifdef CORE_INT15_PIN
|
||||
static void isr15(void) { update(interruptArgs[15]); }
|
||||
#endif
|
||||
#ifdef CORE_INT16_PIN
|
||||
static void isr16(void) { update(interruptArgs[16]); }
|
||||
#endif
|
||||
#ifdef CORE_INT17_PIN
|
||||
static void isr17(void) { update(interruptArgs[17]); }
|
||||
#endif
|
||||
#ifdef CORE_INT18_PIN
|
||||
static void isr18(void) { update(interruptArgs[18]); }
|
||||
#endif
|
||||
#ifdef CORE_INT19_PIN
|
||||
static void isr19(void) { update(interruptArgs[19]); }
|
||||
#endif
|
||||
#ifdef CORE_INT20_PIN
|
||||
static void isr20(void) { update(interruptArgs[20]); }
|
||||
#endif
|
||||
#ifdef CORE_INT21_PIN
|
||||
static void isr21(void) { update(interruptArgs[21]); }
|
||||
#endif
|
||||
#ifdef CORE_INT22_PIN
|
||||
static void isr22(void) { update(interruptArgs[22]); }
|
||||
#endif
|
||||
#ifdef CORE_INT23_PIN
|
||||
static void isr23(void) { update(interruptArgs[23]); }
|
||||
#endif
|
||||
#ifdef CORE_INT24_PIN
|
||||
static void isr24(void) { update(interruptArgs[24]); }
|
||||
#endif
|
||||
#ifdef CORE_INT25_PIN
|
||||
static void isr25(void) { update(interruptArgs[25]); }
|
||||
#endif
|
||||
#ifdef CORE_INT26_PIN
|
||||
static void isr26(void) { update(interruptArgs[26]); }
|
||||
#endif
|
||||
#ifdef CORE_INT27_PIN
|
||||
static void isr27(void) { update(interruptArgs[27]); }
|
||||
#endif
|
||||
#ifdef CORE_INT28_PIN
|
||||
static void isr28(void) { update(interruptArgs[28]); }
|
||||
#endif
|
||||
#ifdef CORE_INT29_PIN
|
||||
static void isr29(void) { update(interruptArgs[29]); }
|
||||
#endif
|
||||
#ifdef CORE_INT30_PIN
|
||||
static void isr30(void) { update(interruptArgs[30]); }
|
||||
#endif
|
||||
#ifdef CORE_INT31_PIN
|
||||
static void isr31(void) { update(interruptArgs[31]); }
|
||||
#endif
|
||||
#ifdef CORE_INT32_PIN
|
||||
static void isr32(void) { update(interruptArgs[32]); }
|
||||
#endif
|
||||
#ifdef CORE_INT33_PIN
|
||||
static void isr33(void) { update(interruptArgs[33]); }
|
||||
#endif
|
||||
#ifdef CORE_INT34_PIN
|
||||
static void isr34(void) { update(interruptArgs[34]); }
|
||||
#endif
|
||||
#ifdef CORE_INT35_PIN
|
||||
static void isr35(void) { update(interruptArgs[35]); }
|
||||
#endif
|
||||
#ifdef CORE_INT36_PIN
|
||||
static void isr36(void) { update(interruptArgs[36]); }
|
||||
#endif
|
||||
#ifdef CORE_INT37_PIN
|
||||
static void isr37(void) { update(interruptArgs[37]); }
|
||||
#endif
|
||||
#ifdef CORE_INT38_PIN
|
||||
static void isr38(void) { update(interruptArgs[38]); }
|
||||
#endif
|
||||
#ifdef CORE_INT39_PIN
|
||||
static void isr39(void) { update(interruptArgs[39]); }
|
||||
#endif
|
||||
#ifdef CORE_INT40_PIN
|
||||
static void isr40(void) { update(interruptArgs[40]); }
|
||||
#endif
|
||||
#ifdef CORE_INT41_PIN
|
||||
static void isr41(void) { update(interruptArgs[41]); }
|
||||
#endif
|
||||
#ifdef CORE_INT42_PIN
|
||||
static void isr42(void) { update(interruptArgs[42]); }
|
||||
#endif
|
||||
#ifdef CORE_INT43_PIN
|
||||
static void isr43(void) { update(interruptArgs[43]); }
|
||||
#endif
|
||||
#ifdef CORE_INT44_PIN
|
||||
static void isr44(void) { update(interruptArgs[44]); }
|
||||
#endif
|
||||
#ifdef CORE_INT45_PIN
|
||||
static void isr45(void) { update(interruptArgs[45]); }
|
||||
#endif
|
||||
#ifdef CORE_INT46_PIN
|
||||
static void isr46(void) { update(interruptArgs[46]); }
|
||||
#endif
|
||||
#ifdef CORE_INT47_PIN
|
||||
static void isr47(void) { update(interruptArgs[47]); }
|
||||
#endif
|
||||
#ifdef CORE_INT48_PIN
|
||||
static void isr48(void) { update(interruptArgs[48]); }
|
||||
#endif
|
||||
#ifdef CORE_INT49_PIN
|
||||
static void isr49(void) { update(interruptArgs[49]); }
|
||||
#endif
|
||||
#ifdef CORE_INT50_PIN
|
||||
static void isr50(void) { update(interruptArgs[50]); }
|
||||
#endif
|
||||
#ifdef CORE_INT51_PIN
|
||||
static void isr51(void) { update(interruptArgs[51]); }
|
||||
#endif
|
||||
#ifdef CORE_INT52_PIN
|
||||
static void isr52(void) { update(interruptArgs[52]); }
|
||||
#endif
|
||||
#ifdef CORE_INT53_PIN
|
||||
static void isr53(void) { update(interruptArgs[53]); }
|
||||
#endif
|
||||
#ifdef CORE_INT54_PIN
|
||||
static void isr54(void) { update(interruptArgs[54]); }
|
||||
#endif
|
||||
#ifdef CORE_INT55_PIN
|
||||
static void isr55(void) { update(interruptArgs[55]); }
|
||||
#endif
|
||||
#ifdef CORE_INT56_PIN
|
||||
static void isr56(void) { update(interruptArgs[56]); }
|
||||
#endif
|
||||
#ifdef CORE_INT57_PIN
|
||||
static void isr57(void) { update(interruptArgs[57]); }
|
||||
#endif
|
||||
#ifdef CORE_INT58_PIN
|
||||
static void isr58(void) { update(interruptArgs[58]); }
|
||||
#endif
|
||||
#ifdef CORE_INT59_PIN
|
||||
static void isr59(void) { update(interruptArgs[59]); }
|
||||
#endif
|
||||
#endif
|
||||
};
|
||||
|
||||
#if defined(ENCODER_USE_INTERRUPTS) && defined(ENCODER_OPTIMIZE_INTERRUPTS)
|
||||
#if defined(__AVR__)
|
||||
#if defined(INT0_vect) && CORE_NUM_INTERRUPT > 0
|
||||
ISR(INT0_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(0)]); }
|
||||
#endif
|
||||
#if defined(INT1_vect) && CORE_NUM_INTERRUPT > 1
|
||||
ISR(INT1_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(1)]); }
|
||||
#endif
|
||||
#if defined(INT2_vect) && CORE_NUM_INTERRUPT > 2
|
||||
ISR(INT2_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(2)]); }
|
||||
#endif
|
||||
#if defined(INT3_vect) && CORE_NUM_INTERRUPT > 3
|
||||
ISR(INT3_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(3)]); }
|
||||
#endif
|
||||
#if defined(INT4_vect) && CORE_NUM_INTERRUPT > 4
|
||||
ISR(INT4_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(4)]); }
|
||||
#endif
|
||||
#if defined(INT5_vect) && CORE_NUM_INTERRUPT > 5
|
||||
ISR(INT5_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(5)]); }
|
||||
#endif
|
||||
#if defined(INT6_vect) && CORE_NUM_INTERRUPT > 6
|
||||
ISR(INT6_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(6)]); }
|
||||
#endif
|
||||
#if defined(INT7_vect) && CORE_NUM_INTERRUPT > 7
|
||||
ISR(INT7_vect) { Encoder::update(Encoder::interruptArgs[SCRAMBLE_INT_ORDER(7)]); }
|
||||
#endif
|
||||
#endif // AVR
|
||||
#endif // ENCODER_OPTIMIZE_INTERRUPTS
|
||||
|
||||
|
||||
#endif
|
||||
29
Encoder/examples/Basic/Basic.pde
Normal file
29
Encoder/examples/Basic/Basic.pde
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
/* Encoder Library - Basic Example
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
#include <Encoder.h>
|
||||
|
||||
// Change these two numbers to the pins connected to your encoder.
|
||||
// Best Performance: both pins have interrupt capability
|
||||
// Good Performance: only the first pin has interrupt capability
|
||||
// Low Performance: neither pin has interrupt capability
|
||||
Encoder myEnc(5, 6);
|
||||
// avoid using pins with LEDs attached
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
Serial.println("Basic Encoder Test:");
|
||||
}
|
||||
|
||||
long oldPosition = -999;
|
||||
|
||||
void loop() {
|
||||
long newPosition = myEnc.read();
|
||||
if (newPosition != oldPosition) {
|
||||
oldPosition = newPosition;
|
||||
Serial.println(newPosition);
|
||||
}
|
||||
}
|
||||
46
Encoder/examples/NoInterrupts/NoInterrupts.pde
Normal file
46
Encoder/examples/NoInterrupts/NoInterrupts.pde
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/* Encoder Library - NoInterrupts Example
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
// If you define ENCODER_DO_NOT_USE_INTERRUPTS *before* including
|
||||
// Encoder, the library will never use interrupts. This is mainly
|
||||
// useful to reduce the size of the library when you are using it
|
||||
// with pins that do not support interrupts. Without interrupts,
|
||||
// your program must call the read() function rapidly, or risk
|
||||
// missing changes in position.
|
||||
#define ENCODER_DO_NOT_USE_INTERRUPTS
|
||||
#include <Encoder.h>
|
||||
|
||||
// Beware of Serial.print() speed. Without interrupts, if you
|
||||
// transmit too much data with Serial.print() it can slow your
|
||||
// reading from Encoder. Arduino 1.0 has improved transmit code.
|
||||
// Using the fastest baud rate also helps. Teensy has USB packet
|
||||
// buffering. But all boards can experience problems if you print
|
||||
// too much and fill up buffers.
|
||||
|
||||
// Change these two numbers to the pins connected to your encoder.
|
||||
// With ENCODER_DO_NOT_USE_INTERRUPTS, no interrupts are ever
|
||||
// used, even if the pin has interrupt capability
|
||||
Encoder myEnc(5, 6);
|
||||
// avoid using pins with LEDs attached
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
Serial.println("Basic NoInterrupts Test:");
|
||||
}
|
||||
|
||||
long position = -999;
|
||||
|
||||
void loop() {
|
||||
long newPos = myEnc.read();
|
||||
if (newPos != position) {
|
||||
position = newPos;
|
||||
Serial.println(position);
|
||||
}
|
||||
// With any substantial delay added, Encoder can only track
|
||||
// very slow motion. You may uncomment this line to see
|
||||
// how badly a delay affects your encoder.
|
||||
//delay(50);
|
||||
}
|
||||
113
Encoder/examples/SpeedTest/SpeedTest.pde
Normal file
113
Encoder/examples/SpeedTest/SpeedTest.pde
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
/* Encoder Library - SpeedTest - for measuring maximum Encoder speed
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
|
||||
// This SpeedTest example provides a simple way to verify how much
|
||||
// CPU time Encoder is consuming. Connect a DC voltmeter to the
|
||||
// output pin and measure the voltage while the encoder is stopped
|
||||
// or running at a very slow speed. Even though the pin is rapidly
|
||||
// pulsing, a DC voltmeter will show the average voltage. Due to
|
||||
// software timing, it will read a number much less than a steady
|
||||
// logic high, but this number will give you a baseline reading
|
||||
// for output with minimal interrupt overhead. Then increase the
|
||||
// encoder speed. The voltage will decrease as the processor spends
|
||||
// more time in Encoder's interrupt routines counting the pulses
|
||||
// and less time pulsing the output pin. When the voltage is
|
||||
// close to zero and will not decrease any farther, you have reached
|
||||
// the absolute speed limit. Or, if using a mechanical system where
|
||||
// you reach a speed limit imposed by your motors or other hardware,
|
||||
// the amount this voltage has decreased, compared to the baseline,
|
||||
// should give you a good approximation of the portion of available
|
||||
// CPU time Encoder is consuming at your maximum speed.
|
||||
|
||||
// Encoder requires low latency interrupt response. Available CPU
|
||||
// time does NOT necessarily prove or guarantee correct performance.
|
||||
// If another library, like NewSoftSerial, is disabling interrupts
|
||||
// for lengthy periods of time, Encoder can be prevented from
|
||||
// properly counting the intput signals while interrupt are disabled.
|
||||
|
||||
|
||||
// This optional setting causes Encoder to use more optimized code,
|
||||
// but the downside is a conflict if any other part of your sketch
|
||||
// or any other library you're using requires attachInterrupt().
|
||||
// It must be defined before Encoder.h is included.
|
||||
//#define ENCODER_OPTIMIZE_INTERRUPTS
|
||||
|
||||
#include <Encoder.h>
|
||||
#include "pins_arduino.h"
|
||||
|
||||
// Change these two numbers to the pins connected to your encoder
|
||||
// or shift register circuit which emulates a quadrature encoder
|
||||
// case 1: both pins are interrupts
|
||||
// case 2: only first pin used as interrupt
|
||||
Encoder myEnc(5, 6);
|
||||
|
||||
// Connect a DC voltmeter to this pin.
|
||||
const int outputPin = 12;
|
||||
|
||||
/* This simple circuit, using a Dual Flip-Flop chip, can emulate
|
||||
quadrature encoder signals. The clock can come from a fancy
|
||||
function generator or a cheap 555 timer chip. The clock
|
||||
frequency can be measured with another board running FreqCount
|
||||
http://www.pjrc.com/teensy/td_libs_FreqCount.html
|
||||
|
||||
+5V
|
||||
| Quadrature Encoder Signal Emulator
|
||||
Clock |
|
||||
Input o----*-------------------------- ---------------------------o Output1
|
||||
| |14 | |
|
||||
| _______|_______ | | _______________
|
||||
| | CD4013 | | | | CD4013 |
|
||||
| 5 | | 1 | | 9 | | 13
|
||||
---------| D Q |-----|----*----| D Q |------o Output2
|
||||
| | | | | | |
|
||||
| | 3 | | | 11 | |
|
||||
| ----|> Clk | ---------|> Clk |
|
||||
| | | | |
|
||||
| 6 | | 8 | |
|
||||
| ----| S | ----| S |
|
||||
| | | | | | |
|
||||
| | 4 | _ | 2 | 10 | _ | 12
|
||||
| *----| R Q |--- *----| R Q |----
|
||||
| | | | | | | |
|
||||
| | |_______________| | |_______________| |
|
||||
| | | | |
|
||||
| | | 7 | |
|
||||
| | | | |
|
||||
--------------------------------------------------------------
|
||||
| | |
|
||||
| | |
|
||||
----- ----- -----
|
||||
--- --- ---
|
||||
- - -
|
||||
*/
|
||||
|
||||
|
||||
void setup() {
|
||||
pinMode(outputPin, OUTPUT);
|
||||
}
|
||||
|
||||
#if defined(__AVR__)
|
||||
#define REGTYPE unsigned char
|
||||
#elif defined(__PIC32MX__)
|
||||
#define REGTYPE unsigned long
|
||||
#endif
|
||||
|
||||
void loop() {
|
||||
volatile int count = 0;
|
||||
volatile REGTYPE *reg = portOutputRegister(digitalPinToPort(outputPin));
|
||||
REGTYPE mask = digitalPinToBitMask(outputPin);
|
||||
|
||||
while (1) {
|
||||
myEnc.read(); // Read the encoder while interrupts are enabled.
|
||||
noInterrupts();
|
||||
*reg |= mask; // Pulse the pin high, while interrupts are disabled.
|
||||
count = count + 1;
|
||||
*reg &= ~mask;
|
||||
interrupts();
|
||||
}
|
||||
}
|
||||
|
||||
46
Encoder/examples/TwoKnobs/TwoKnobs.pde
Normal file
46
Encoder/examples/TwoKnobs/TwoKnobs.pde
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
/* Encoder Library - TwoKnobs Example
|
||||
* http://www.pjrc.com/teensy/td_libs_Encoder.html
|
||||
*
|
||||
* This example code is in the public domain.
|
||||
*/
|
||||
|
||||
#include <Encoder.h>
|
||||
|
||||
// Change these pin numbers to the pins connected to your encoder.
|
||||
// Best Performance: both pins have interrupt capability
|
||||
// Good Performance: only the first pin has interrupt capability
|
||||
// Low Performance: neither pin has interrupt capability
|
||||
Encoder knobLeft(5, 6);
|
||||
Encoder knobRight(7, 8);
|
||||
// avoid using pins with LEDs attached
|
||||
|
||||
void setup() {
|
||||
Serial.begin(9600);
|
||||
Serial.println("TwoKnobs Encoder Test:");
|
||||
}
|
||||
|
||||
long positionLeft = -999;
|
||||
long positionRight = -999;
|
||||
|
||||
void loop() {
|
||||
long newLeft, newRight;
|
||||
newLeft = knobLeft.read();
|
||||
newRight = knobRight.read();
|
||||
if (newLeft != positionLeft || newRight != positionRight) {
|
||||
Serial.print("Left = ");
|
||||
Serial.print(newLeft);
|
||||
Serial.print(", Right = ");
|
||||
Serial.print(newRight);
|
||||
Serial.println();
|
||||
positionLeft = newLeft;
|
||||
positionRight = newRight;
|
||||
}
|
||||
// if a character is sent from the serial monitor,
|
||||
// reset both back to zero.
|
||||
if (Serial.available()) {
|
||||
Serial.read();
|
||||
Serial.println("Reset both knobs to zero");
|
||||
knobLeft.write(0);
|
||||
knobRight.write(0);
|
||||
}
|
||||
}
|
||||
4
Encoder/keywords.txt
Normal file
4
Encoder/keywords.txt
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
ENCODER_USE_INTERRUPTS LITERAL1
|
||||
ENCODER_OPTIMIZE_INTERRUPTS LITERAL1
|
||||
ENCODER_DO_NOT_USE_INTERRUPTS LITERAL1
|
||||
Encoder KEYWORD1
|
||||
27
Encoder/utility/direct_pin_read.h
Normal file
27
Encoder/utility/direct_pin_read.h
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
#ifndef direct_pin_read_h_
|
||||
#define direct_pin_read_h_
|
||||
|
||||
#if defined(__AVR__) || defined(__MK20DX128__) || defined(__MK20DX256__)
|
||||
|
||||
#define IO_REG_TYPE uint8_t
|
||||
#define PIN_TO_BASEREG(pin) (portInputRegister(digitalPinToPort(pin)))
|
||||
#define PIN_TO_BITMASK(pin) (digitalPinToBitMask(pin))
|
||||
#define DIRECT_PIN_READ(base, mask) (((*(base)) & (mask)) ? 1 : 0)
|
||||
|
||||
#elif defined(__SAM3X8E__)
|
||||
|
||||
#define IO_REG_TYPE uint32_t
|
||||
#define PIN_TO_BASEREG(pin) (portInputRegister(digitalPinToPort(pin)))
|
||||
#define PIN_TO_BITMASK(pin) (digitalPinToBitMask(pin))
|
||||
#define DIRECT_PIN_READ(base, mask) (((*(base)) & (mask)) ? 1 : 0)
|
||||
|
||||
#elif defined(__PIC32MX__)
|
||||
|
||||
#define IO_REG_TYPE uint32_t
|
||||
#define PIN_TO_BASEREG(pin) (portModeRegister(digitalPinToPort(pin)))
|
||||
#define PIN_TO_BITMASK(pin) (digitalPinToBitMask(pin))
|
||||
#define DIRECT_PIN_READ(base, mask) (((*(base+4)) & (mask)) ? 1 : 0)
|
||||
|
||||
#endif
|
||||
|
||||
#endif
|
||||
87
Encoder/utility/interrupt_config.h
Normal file
87
Encoder/utility/interrupt_config.h
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
#if defined(__AVR__)
|
||||
|
||||
#include <avr/io.h>
|
||||
#include <avr/interrupt.h>
|
||||
|
||||
#define attachInterrupt(num, func, mode) enableInterrupt(num)
|
||||
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
#define SCRAMBLE_INT_ORDER(num) ((num < 4) ? num + 2 : ((num < 6) ? num - 4 : num))
|
||||
#define DESCRAMBLE_INT_ORDER(num) ((num < 2) ? num + 4 : ((num < 6) ? num - 2 : num))
|
||||
#else
|
||||
#define SCRAMBLE_INT_ORDER(num) (num)
|
||||
#define DESCRAMBLE_INT_ORDER(num) (num)
|
||||
#endif
|
||||
|
||||
static void enableInterrupt(uint8_t num)
|
||||
{
|
||||
switch (DESCRAMBLE_INT_ORDER(num)) {
|
||||
#if defined(EICRA) && defined(EIMSK)
|
||||
case 0:
|
||||
EICRA = (EICRA & 0xFC) | 0x01;
|
||||
EIMSK |= 0x01;
|
||||
return;
|
||||
case 1:
|
||||
EICRA = (EICRA & 0xF3) | 0x04;
|
||||
EIMSK |= 0x02;
|
||||
return;
|
||||
case 2:
|
||||
EICRA = (EICRA & 0xCF) | 0x10;
|
||||
EIMSK |= 0x04;
|
||||
return;
|
||||
case 3:
|
||||
EICRA = (EICRA & 0x3F) | 0x40;
|
||||
EIMSK |= 0x08;
|
||||
return;
|
||||
#elif defined(MCUCR) && defined(GICR)
|
||||
case 0:
|
||||
MCUCR = (MCUCR & ~((1 << ISC00) | (1 << ISC01))) | (mode << ISC00);
|
||||
GICR |= (1 << INT0);
|
||||
return;
|
||||
case 1:
|
||||
MCUCR = (MCUCR & ~((1 << ISC10) | (1 << ISC11))) | (mode << ISC10);
|
||||
GICR |= (1 << INT1);
|
||||
return;
|
||||
#elif defined(MCUCR) && defined(GIMSK)
|
||||
case 0:
|
||||
MCUCR = (MCUCR & ~((1 << ISC00) | (1 << ISC01))) | (mode << ISC00);
|
||||
GIMSK |= (1 << INT0);
|
||||
return;
|
||||
case 1:
|
||||
MCUCR = (MCUCR & ~((1 << ISC10) | (1 << ISC11))) | (mode << ISC10);
|
||||
GIMSK |= (1 << INT1);
|
||||
return;
|
||||
#endif
|
||||
#if defined(EICRB) && defined(EIMSK)
|
||||
case 4:
|
||||
EICRB = (EICRB & 0xFC) | 0x01;
|
||||
EIMSK |= 0x10;
|
||||
return;
|
||||
case 5:
|
||||
EICRB = (EICRB & 0xF3) | 0x04;
|
||||
EIMSK |= 0x20;
|
||||
return;
|
||||
case 6:
|
||||
EICRB = (EICRB & 0xCF) | 0x10;
|
||||
EIMSK |= 0x40;
|
||||
return;
|
||||
case 7:
|
||||
EICRB = (EICRB & 0x3F) | 0x40;
|
||||
EIMSK |= 0x80;
|
||||
return;
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
#elif defined(__PIC32MX__)
|
||||
|
||||
#ifdef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#undef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#endif
|
||||
|
||||
#else
|
||||
|
||||
#ifdef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#undef ENCODER_OPTIMIZE_INTERRUPTS
|
||||
#endif
|
||||
|
||||
#endif
|
||||
156
Encoder/utility/interrupt_pins.h
Normal file
156
Encoder/utility/interrupt_pins.h
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
// interrupt pins for known boards
|
||||
|
||||
// Teensy (and maybe others) define these automatically
|
||||
#if !defined(CORE_NUM_INTERRUPT)
|
||||
|
||||
// Wiring boards
|
||||
#if defined(WIRING)
|
||||
#define CORE_NUM_INTERRUPT NUM_EXTERNAL_INTERRUPTS
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 0
|
||||
#define CORE_INT0_PIN EI0
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 1
|
||||
#define CORE_INT1_PIN EI1
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 2
|
||||
#define CORE_INT2_PIN EI2
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 3
|
||||
#define CORE_INT3_PIN EI3
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 4
|
||||
#define CORE_INT4_PIN EI4
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 5
|
||||
#define CORE_INT5_PIN EI5
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 6
|
||||
#define CORE_INT6_PIN EI6
|
||||
#endif
|
||||
#if NUM_EXTERNAL_INTERRUPTS > 7
|
||||
#define CORE_INT7_PIN EI7
|
||||
#endif
|
||||
|
||||
// Arduino Uno, Duemilanove, Diecimila, LilyPad, Mini, Fio, etc...
|
||||
#elif defined(__AVR_ATmega328P__) || defined(__AVR_ATmega168__) || defined(__AVR_ATmega8__)
|
||||
#define CORE_NUM_INTERRUPT 2
|
||||
#define CORE_INT0_PIN 2
|
||||
#define CORE_INT1_PIN 3
|
||||
|
||||
// Arduino Mega
|
||||
#elif defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__)
|
||||
#define CORE_NUM_INTERRUPT 6
|
||||
#define CORE_INT0_PIN 2
|
||||
#define CORE_INT1_PIN 3
|
||||
#define CORE_INT2_PIN 21
|
||||
#define CORE_INT3_PIN 20
|
||||
#define CORE_INT4_PIN 19
|
||||
#define CORE_INT5_PIN 18
|
||||
|
||||
// Arduino Leonardo (untested)
|
||||
#elif defined(__AVR_ATmega32U4__) && !defined(CORE_TEENSY)
|
||||
#define CORE_NUM_INTERRUPT 4
|
||||
#define CORE_INT0_PIN 3
|
||||
#define CORE_INT1_PIN 2
|
||||
#define CORE_INT2_PIN 0
|
||||
#define CORE_INT3_PIN 1
|
||||
|
||||
// Sanguino (untested)
|
||||
#elif defined(__AVR_ATmega644P__) || defined(__AVR_ATmega644__)
|
||||
#define CORE_NUM_INTERRUPT 3
|
||||
#define CORE_INT0_PIN 10
|
||||
#define CORE_INT1_PIN 11
|
||||
#define CORE_INT2_PIN 2
|
||||
|
||||
// Chipkit Uno32 - attachInterrupt may not support CHANGE option
|
||||
#elif defined(__PIC32MX__) && defined(_BOARD_UNO_)
|
||||
#define CORE_NUM_INTERRUPT 5
|
||||
#define CORE_INT0_PIN 38
|
||||
#define CORE_INT1_PIN 2
|
||||
#define CORE_INT2_PIN 7
|
||||
#define CORE_INT3_PIN 8
|
||||
#define CORE_INT4_PIN 35
|
||||
|
||||
// Chipkit Uno32 - attachInterrupt may not support CHANGE option
|
||||
#elif defined(__PIC32MX__) && defined(_BOARD_MEGA_)
|
||||
#define CORE_NUM_INTERRUPT 5
|
||||
#define CORE_INT0_PIN 3
|
||||
#define CORE_INT1_PIN 2
|
||||
#define CORE_INT2_PIN 7
|
||||
#define CORE_INT3_PIN 21
|
||||
#define CORE_INT4_PIN 20
|
||||
|
||||
// http://hlt.media.mit.edu/?p=1229
|
||||
#elif defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
|
||||
#define CORE_NUM_INTERRUPT 1
|
||||
#define CORE_INT0_PIN 2
|
||||
|
||||
// Arduino Due (untested)
|
||||
#elif defined(__SAM3X8E__)
|
||||
#define CORE_NUM_INTERRUPT 54
|
||||
#define CORE_INT0_PIN 0
|
||||
#define CORE_INT1_PIN 1
|
||||
#define CORE_INT2_PIN 2
|
||||
#define CORE_INT3_PIN 3
|
||||
#define CORE_INT4_PIN 4
|
||||
#define CORE_INT5_PIN 5
|
||||
#define CORE_INT6_PIN 6
|
||||
#define CORE_INT7_PIN 7
|
||||
#define CORE_INT8_PIN 8
|
||||
#define CORE_INT9_PIN 9
|
||||
#define CORE_INT10_PIN 10
|
||||
#define CORE_INT11_PIN 11
|
||||
#define CORE_INT12_PIN 12
|
||||
#define CORE_INT13_PIN 13
|
||||
#define CORE_INT14_PIN 14
|
||||
#define CORE_INT15_PIN 15
|
||||
#define CORE_INT16_PIN 16
|
||||
#define CORE_INT17_PIN 17
|
||||
#define CORE_INT18_PIN 18
|
||||
#define CORE_INT19_PIN 19
|
||||
#define CORE_INT20_PIN 20
|
||||
#define CORE_INT21_PIN 21
|
||||
#define CORE_INT22_PIN 22
|
||||
#define CORE_INT23_PIN 23
|
||||
#define CORE_INT24_PIN 24
|
||||
#define CORE_INT25_PIN 25
|
||||
#define CORE_INT26_PIN 26
|
||||
#define CORE_INT27_PIN 27
|
||||
#define CORE_INT28_PIN 28
|
||||
#define CORE_INT29_PIN 29
|
||||
#define CORE_INT30_PIN 30
|
||||
#define CORE_INT31_PIN 31
|
||||
#define CORE_INT32_PIN 32
|
||||
#define CORE_INT33_PIN 33
|
||||
#define CORE_INT34_PIN 34
|
||||
#define CORE_INT35_PIN 35
|
||||
#define CORE_INT36_PIN 36
|
||||
#define CORE_INT37_PIN 37
|
||||
#define CORE_INT38_PIN 38
|
||||
#define CORE_INT39_PIN 39
|
||||
#define CORE_INT40_PIN 40
|
||||
#define CORE_INT41_PIN 41
|
||||
#define CORE_INT42_PIN 42
|
||||
#define CORE_INT43_PIN 43
|
||||
#define CORE_INT44_PIN 44
|
||||
#define CORE_INT45_PIN 45
|
||||
#define CORE_INT46_PIN 46
|
||||
#define CORE_INT47_PIN 47
|
||||
#define CORE_INT48_PIN 48
|
||||
#define CORE_INT49_PIN 49
|
||||
#define CORE_INT50_PIN 50
|
||||
#define CORE_INT51_PIN 51
|
||||
#define CORE_INT52_PIN 52
|
||||
#define CORE_INT53_PIN 53
|
||||
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if !defined(CORE_NUM_INTERRUPT)
|
||||
#error "Interrupts are unknown for this board, please add to this code"
|
||||
#endif
|
||||
#if CORE_NUM_INTERRUPT <= 0
|
||||
#error "Encoder requires interrupt pins, but this board does not have any :("
|
||||
#error "You could try defining ENCODER_DO_NOT_USE_INTERRUPTS as a kludge."
|
||||
#endif
|
||||
|
||||
531
si5351/README.md
Normal file
531
si5351/README.md
Normal file
|
|
@ -0,0 +1,531 @@
|
|||
Si5351 Library for Arduino
|
||||
==========================
|
||||
This is a basic library for the Si5351 series of clock generator ICs from [Silicon Labs](http://www.silabs.com) for the Arduino development environment. It will allow you to control the Si5351 with an Arduino, and without depending on the proprietary ClockBuilder software from Silicon Labs.
|
||||
|
||||
This library is focused towards usage in RF/amateur radio applications, but it may be useful in other cases. However, keep in mind that coding decisions are and will be made with those applications in mind first, so if you need something a bit different, please do fork this repository. Also, since the Si5351A3 version is the one which seems most useful in amateur radio applications, this is where the current development will be focused. Once the Si5351A3 has a decent and mature feature set, hopefully we will be able to turn to the 8-output version, and perhaps even the B and C variants.
|
||||
|
||||
Please feel free to use the issues feature of GitHub if you run into problems or have suggestions for important features to implement.
|
||||
|
||||
Thanks For Your Support!
|
||||
------------------------
|
||||
If you would like to support my library development efforts, I would ask that you please consider purchasing a Si5351A Breakout Board from my [online store at etherkit.com](https://www.etherkit.com). Thank you!
|
||||
|
||||
Hardware Requirements and Setup
|
||||
-------------------------------
|
||||
This library has been written for the Arduino platform and has been successfully tested on the Arduino Uno and an Uno clone. There should be no reason that it would not work on any other Arduino hardware with I2C support.
|
||||
|
||||
The Si5351 is a +3.3 V only part, so if you are not using a +3.3 V microcontroller, be sure you have some kind of level conversion strategy.
|
||||
|
||||
Wire the SDA and SCL pins of the Si5351 to the corresponding pins on the Arduino. Use the pin assignments posted on the [Arduino Wire library page](http://arduino.cc/en/Reference/Wire). Since the I2C interface is set to 100 kHz, use 1 to 10 kΩ pullup resistors from +3.3 V to the SDA and SCL lines.
|
||||
|
||||
Connect a 25 MHz or 27 MHz crystal with a load capacitance of 6, 8, or 10 pF to the Si5351 XA and XB pins. Locate the crystal as close to the Si5351 as possible and keep the traces as short as possible. Please use a SMT crystal. A crystal with leads will have too much stray capacitance.
|
||||
|
||||
Example
|
||||
-------
|
||||
Include the Si5351Arduino library into your instance of the Arduino IDE. Download a ZIP file of the library from the GitHub repository by using the "Download ZIP" button at the right of the main repository page. Extract the ZIP file, then rename the unzipped folder as "Si5351". Finally, open the Arduino IDE, select menu Sketch > Import Library... > Add Library..., and select the renamed folder that you just downloaded. Restart the IDE and you should have access to the new library.
|
||||
|
||||
(Yes, the Arduino IDE can import a ZIP file, but it doesn't like filenames with characters such as dashes, as GitHub does when it appends the branch name with a dash. Perhaps there's an elegant way around this, we'll see.)
|
||||
|
||||
There is a simple example that is placed in your examples menu under Si5351Arduino. Open this to see how to initialize the Si5351 and set a couple of the outputs to different frequencies. The commentary below will analyze the sample sketch.
|
||||
|
||||
Before you do anything with the Si5351, you will need to include the "si5351.h" and "Wire.h" header files and instantiate the Si5351 class.
|
||||
|
||||
#include "si5351.h"
|
||||
#include "Wire.h"
|
||||
|
||||
Si5351 si5351;
|
||||
|
||||
Now in the Setup() function, let's initialize communications with the Si5351, specify the load capacitance of the reference crystal, and to use the default reference oscillator frequency of 25 MHz:
|
||||
|
||||
si5351.init(SI5351_CRYSTAL_LOAD_8PF, 0);
|
||||
|
||||
Next, let's set the CLK0 output to 14 MHz and use a fixed PLL reference frequency (this allows for glitch-free tuning):
|
||||
|
||||
si5351.set_pll(SI5351_PLL_FIXED, SI5351_PLLA);
|
||||
si5351.set_freq(1400000000ULL, SI5351_PLL_FIXED, SI5351_CLK0);
|
||||
|
||||
Frequencies are indicated in units of 0.01 Hz. Therefore, if you prefer to work in 1 Hz increments in your own code, simply multiply each frequency passed to the library by 100ULL (better yet, use the define called SI5351_FREQ_MULT in the header file for this multiplication).
|
||||
The second value passed in the above method is the desired driving PLL frequency. Entering a 0 will have the method choose a PLL frequency for you. If you would like to use a fixed PLL frequency to drive a multisynth (in order to ensure glitch-free tuning), set the desired PLL frequency first using the method below, then specify that frequency in the set_freq() method. The PLL frequency only needs to be set once. Any additional frequency changes only need to use the set_freq() method as long as you are using the same PLL frequency as before.
|
||||
|
||||
Now let's set the CLK1 output to 20 MHz output, and let the Si5351 class pick a PLL frequency:
|
||||
|
||||
si5351.set_freq(2000000000ULL, 0ULL, SI5351_CLK1);
|
||||
|
||||
In the main Loop(), we use the Serial port to monitor the status of the Si5351, using a method to update a public struct which holds the status bits:
|
||||
|
||||
si5351.update_status();
|
||||
Serial.print("SYS_INIT: ");
|
||||
Serial.print(si5351.dev_status.SYS_INIT);
|
||||
Serial.print(" LOL_A: ");
|
||||
Serial.print(si5351.dev_status.LOL_A);
|
||||
Serial.print(" LOL_B: ");
|
||||
Serial.print(si5351.dev_status.LOL_B);
|
||||
Serial.print(" LOS: ");
|
||||
Serial.print(si5351.dev_status.LOS);
|
||||
Serial.print(" REVID: ");
|
||||
Serial.println(si5351.dev_status.REVID);
|
||||
|
||||
Setting the Output Frequency
|
||||
----------------------------
|
||||
As indicated above, the library accepts and indicates clock and PLL frequencies in units of 0.01 Hz, as an _unsigned long long_ variable type (or _uint64_t_). When entering literal values, append "ULL" to make an explicit unsigned long long number to ensure proper tuning. Since many applications won't require sub-Hertz tuning, you may wish to use an _unsigned long_ (or _uint32_t_) variable to hold your tune frequency, then scale it up by multiplying by 100ULL before passing it to the set_freq() method.
|
||||
|
||||
The most simple way to set the output frequency is to let the library pick a PLL assignment for you. You do this by passing a 0 to the set_freq() method in the 2nd parameter:
|
||||
|
||||
si5351.set_freq(1014000000ULL, 0ULL, SI5351_CLK0);
|
||||
|
||||
If you let the library make PLL assignments, it will assign CLK0 to PLLA and both CLK1 and CLK2 to PLLB.
|
||||
|
||||
If that is not suitable, such as when you need glitch-free tuning or you are counting on multiple clocks being locked to the same reference, you may set the PLL frequency manually then make clock reference assignments to either of the PLLs.
|
||||
|
||||
Manually Selecting a PLL Frequency
|
||||
----------------------------------
|
||||
The Si5351 consists of two main stages: two PLLs which are locked to the 25 or 27 MHz reference oscillator and which can be set from 600 to 900 MHz, and the output (multisynth) clocks which are locked to a PLL and can be set from 1 to 160 MHz. Instead of letting the library choose a PLL frequency for your chosen output frequency, you can choose it yourself by using the set_pll() method, and then using the same frequency in the second parameter in the call to set_freq() (as is shown in the example above).
|
||||
|
||||
Keep in mind when you are setting the PLL manually, that you need to be mindful of the limits of the IC. The multisynth is a fractional PLL, with limits described in AN619 as:
|
||||
|
||||
>Valid Multisynth divider ratios are 4, 6, 8, and any fractional value between 8 + 1/1,048,575 and 900 + 0/1.
|
||||
This means that if any output is greater than 112.5 MHz (900 MHz/8), then this output frequency sets one
|
||||
of the VCO frequencies.
|
||||
|
||||
To put this in other words, if you want to manually set the PLL and wish to have an output frequency greater than 112.5 MHz, then the choice of PLL frequency is dictated by the choice of output frequency, and will need to be an even multiple of 4, 6, or 8.
|
||||
|
||||
Further Details
|
||||
---------------
|
||||
If we like we can adjust the output drive power:
|
||||
|
||||
si5351.drive_strength(SI5351_CLK0, SI5351_DRIVE_4MA);
|
||||
|
||||
The drive strength is the amount of current into a 50Ω load. 2 mA roughly corresponds to 7 dBm output and 8 mA is approximately 14 dBm output.
|
||||
|
||||
Individual outputs can be turned on and off. In the second argument, use a 0 to disable and 1 to enable:
|
||||
|
||||
si5351.output_enable(SI5351_CLK0, 0);
|
||||
|
||||
You may invert a clock output signal by using this command:
|
||||
|
||||
set_clock_invert(SI5351_CLK0, 1);
|
||||
|
||||
Calibration
|
||||
-----------
|
||||
There will be some inherent error in the reference oscillator's actual frequency, so we can account for this by measuring the difference between the uncalibrated actual and nominal output frequencies, then using that difference as a correction factor in the library. The set_correction() method uses a signed integer calibration constant measured in parts-per-billion. The easist way to determine this correction factor is to measure a 10 MHz signal from one of the clock outputs (in Hz, or better resolution if you can measure it), scale it to parts-per-billion, then use it in the set_correction() method in future use of this particular reference oscillator. Once this correction factor is determined, it should not need to be measured again for the same reference oscillator/Si5351 pair unless you want to redo the calibration. With an accurate measurement at one frequency, this calibration should be good across the entire tuning range.
|
||||
|
||||
The calibration method is called like this:
|
||||
|
||||
si5351.set_correction(-6190);
|
||||
|
||||
A handy calibration program is provided with the library in the example folder named _si5351calibration_. To use it, simply hook up your Arduino to your Si5351, then connect it to a PC with the Arduino IDE. Connect the CLK0 output of the Si5351 to a frequency counter capable of measuring at 10 MHz (the more resolution, the better). Load the sketch then open the serial terminal window. Follow the prompts in the serial terminal to change the output frequency until your frequency counter reads exactly 10.000 000 00 MHz. The output from the Arduino on your serial terminal will tell you the correction factor you will need for future use of that reference oscillator/Si5351 combination.
|
||||
|
||||
One thing to note: the library is set for a 25 MHz reference crystal. If you are using a 27 MHz crystal, use the second parameter in the init() function to specify that as the reference oscillator frequency.
|
||||
|
||||
Phase
|
||||
------
|
||||
The phase of the output clock signal can be changed by using the set_phase() method. Phase is in relation to (and measured against the period of) the PLL that the output multisynth is referencing. When you change the phase register from its default of 0, you will need to keep a few considerations in mind.
|
||||
|
||||
Setting the phase of a clock requires that you manually set the PLL and take the PLL frequency into account when calculation the value to place in the phase register. As shown on page 10 of Silicon Labs Application Note 619 (AN619), the phase register is a 7-bit register, where a bit represents a phase difference of 1/4 the PLL period. Therefore, the best way to get an accurate phase setting is to make the PLL an even multiple of the clock frequency, depending on what phase you need.
|
||||
|
||||
If you need a 90 degree phase shift (as in many RF applications), then it is quite easy to determine your parameters. Pick a PLL frequency that is an even multiple of your clock frequency (remember that the PLL needs to be in the range of 600 to 900 MHz). Then to set a 90 degree phase shift, you simply enter that multiple into the phase register. Remember when setting multiple outputs to be phase-related to each other, they each need to be referenced to the same PLL.
|
||||
|
||||
You can see this in action in a sketch in the examples folder called _si5351phase_. It shows how one would set up an I/Q pair of signals at 14.1 MHz.
|
||||
|
||||
// We will output 14.1 MHz on CLK0 and CLK1.
|
||||
// A PLLA frequency of 705 MHz was chosen to give an even
|
||||
// divisor by 14.1 MHz.
|
||||
unsigned long long freq = 1410000000ULL;
|
||||
unsigned long long pll_freq = 70500000000ULL;
|
||||
|
||||
// Set PLLA to the chosen frequency
|
||||
si5351.set_pll(pll_freq, SI5351_PLLA);
|
||||
|
||||
// Set CLK0 and CLK1 to use PLLA as the MS source
|
||||
si5351.set_ms_source(SI5351_CLK0, SI5351_PLLA);
|
||||
si5351.set_ms_source(SI5351_CLK1, SI5351_PLLA);
|
||||
|
||||
// Set CLK0 and CLK1 to output 14.1 MHz with a fixed PLL frequency
|
||||
si5351.set_freq(freq, pll_freq, SI5351_CLK0);
|
||||
si5351.set_freq(freq, pll_freq, SI5351_CLK1);
|
||||
|
||||
// Now we can set CLK1 to have a 90 deg phase shift by entering
|
||||
// 50 in the CLK1 phase register, since the ratio of the PLL to
|
||||
// the clock frequency is 50.
|
||||
si5351.set_phase(SI5351_CLK0, 0);
|
||||
si5351.set_phase(SI5351_CLK1, 50);
|
||||
|
||||
// We need to reset the PLL before they will be in phase alignment
|
||||
si5351.pll_reset(SI5351_PLLA);
|
||||
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
* Two multisynths cannot share a PLL with when both outputs are < 1.024 MHz or >= 112.5 MHz. The library will refuse to set another multisynth to a frequency in that range if another multisynth sharing the same PLL is already within that frequency range.
|
||||
|
||||
* Setting phase will be limited in the extreme edges of the output tuning ranges. Because the phase register is 7-bits in size and is denominated in units representing 1/4 the PLL period, not all phases can be set for all output frequencies. For example, if you need a 90° phase shift, the lowest frequency you can set it at is 4.6875 MHz (600 MHz PLL/128).
|
||||
|
||||
Public Methods
|
||||
--------------
|
||||
###init()
|
||||
```
|
||||
/*
|
||||
* init(uint8_t xtal_load_c, uint32_t ref_osc_freq)
|
||||
*
|
||||
* Setup communications to the Si5351 and set the crystal
|
||||
* load capacitance.
|
||||
*
|
||||
* xtal_load_c - Crystal load capacitance. Use the SI5351_CRYSTAL_LOAD_*PF
|
||||
* defines in the header file
|
||||
* ref_osc_freq - Crystal/reference oscillator frequency in 1 Hz increments.
|
||||
* Defaults to 25000000 if a 0 is used here.
|
||||
*
|
||||
*/
|
||||
void Si5351::init(uint8_t xtal_load_c, uint32_t ref_osc_freq)
|
||||
```
|
||||
###set_freq()
|
||||
```
|
||||
/*
|
||||
* set_freq(uint64_t freq, uint64_t pll_freq, enum si5351_clock output)
|
||||
*
|
||||
* Sets the clock frequency of the specified CLK output
|
||||
*
|
||||
* freq - Output frequency in Hz
|
||||
* pll_freq - Frequency of the PLL driving the Multisynth
|
||||
* Use a 0 to have the function choose a PLL frequency
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
*/
|
||||
uint8_t Si5351::set_freq(uint64_t freq, uint64_t pll_freq, enum si5351_clock clk)
|
||||
```
|
||||
###set_pll()
|
||||
```
|
||||
/*
|
||||
* set_pll(uint64_t pll_freq, enum si5351_pll target_pll)
|
||||
*
|
||||
* Set the specified PLL to a specific oscillation frequency
|
||||
*
|
||||
* pll_freq - Desired PLL frequency
|
||||
* target_pll - Which PLL to set
|
||||
* (use the si5351_pll enum)
|
||||
*/
|
||||
void Si5351::set_pll(uint64_t pll_freq, enum si5351_pll target_pll)
|
||||
```
|
||||
###set_ms()
|
||||
```
|
||||
/*
|
||||
* set_ms(enum si5351_clock clk, struct Si5351RegSet ms_reg, uint8_t int_mode, uint8_t r_div, uint8_t div_by_4)
|
||||
*
|
||||
* Set the specified multisynth parameters. Not normally needed, but public for advanced users.
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* int_mode - Set integer mode
|
||||
* Set to 1 to enable, 0 to disable
|
||||
* r_div - Desired r_div ratio
|
||||
* div_by_4 - Set Divide By 4 mode
|
||||
* Set to 1 to enable, 0 to disable
|
||||
*/
|
||||
void Si5351::set_ms(enum si5351_clock clk, struct Si5351RegSet ms_reg, uint8_t int_mode, uint8_t r_div, uint8_t div_by_4)
|
||||
```
|
||||
###output_enable()
|
||||
```
|
||||
/*
|
||||
* output_enable(enum si5351_clock clk, uint8_t enable)
|
||||
*
|
||||
* Enable or disable a chosen output
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* enable - Set to 1 to enable, 0 to disable
|
||||
*/
|
||||
void Si5351::output_enable(enum si5351_clock clk, uint8_t enable)
|
||||
```
|
||||
###drive_strength()
|
||||
```
|
||||
/*
|
||||
* drive_strength(enum si5351_clock clk, enum si5351_drive drive)
|
||||
*
|
||||
* Sets the drive strength of the specified clock output
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* drive - Desired drive level
|
||||
* (use the si5351_drive enum)
|
||||
*/
|
||||
void Si5351::drive_strength(enum si5351_clock clk, enum si5351_drive drive)
|
||||
```
|
||||
###update_status()
|
||||
```
|
||||
/*
|
||||
* update_status(void)
|
||||
*
|
||||
* Call this to update the status structs, then access them
|
||||
* via the dev_status and dev_int_status global variables.
|
||||
*
|
||||
* See the header file for the struct definitions. These
|
||||
* correspond to the flag names for registers 0 and 1 in
|
||||
* the Si5351 datasheet.
|
||||
*/
|
||||
void Si5351::update_status(void)
|
||||
```
|
||||
###set_correction()
|
||||
```
|
||||
/*
|
||||
* set_correction(int32_t corr)
|
||||
*
|
||||
* Use this to set the oscillator correction factor to
|
||||
* EEPROM. This value is a signed 32-bit integer of the
|
||||
* parts-per-billion value that the actual oscillation
|
||||
* frequency deviates from the specified frequency.
|
||||
*
|
||||
* The frequency calibration is done as a one-time procedure.
|
||||
* Any desired test frequency within the normal range of the
|
||||
* Si5351 should be set, then the actual output frequency
|
||||
* should be measured as accurately as possible. The
|
||||
* difference between the measured and specified frequencies
|
||||
* should be calculated in Hertz, then multiplied by 10 in
|
||||
* order to get the parts-per-billion value.
|
||||
*
|
||||
* Since the Si5351 itself has an intrinsic 0 PPM error, this
|
||||
* correction factor is good across the entire tuning range of
|
||||
* the Si5351. Once this calibration is done accurately, it
|
||||
* should not have to be done again for the same Si5351 and
|
||||
* crystal. The library will read the correction factor from
|
||||
* EEPROM during initialization for use by the tuning
|
||||
* algorithms.
|
||||
*/
|
||||
void Si5351::set_correction(int32_t corr)
|
||||
```
|
||||
###set_phase()
|
||||
```
|
||||
/*
|
||||
* set_phase(enum si5351_clock clk, uint8_t phase)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* phase - 7-bit phase word
|
||||
* (in units of VCO/4 period)
|
||||
*
|
||||
* Write the 7-bit phase register. This must be used
|
||||
* with a user-set PLL frequency so that the user can
|
||||
* calculate the proper tuning word based on the PLL period.
|
||||
*/
|
||||
void Si5351::set_phase(enum si5351_clock clk, uint8_t phase)
|
||||
```
|
||||
###get_correction()
|
||||
```
|
||||
/*
|
||||
* get_correction(void)
|
||||
*
|
||||
* Returns the oscillator correction factor stored
|
||||
* in RAM.
|
||||
*/
|
||||
int32_t Si5351::get_correction(void)
|
||||
```
|
||||
###pll_reset()
|
||||
```
|
||||
/*
|
||||
* pll_reset(enum si5351_pll target_pll)
|
||||
*
|
||||
* target_pll - Which PLL to reset
|
||||
* (use the si5351_pll enum)
|
||||
*
|
||||
* Apply a reset to the indicated PLL.
|
||||
*/
|
||||
void Si5351::pll_reset(enum si5351_pll target_pll)
|
||||
```
|
||||
###set_ms_source()
|
||||
```
|
||||
/*
|
||||
* set_ms_source(enum si5351_clock clk, enum si5351_pll pll)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* pll - Which PLL to use as the source
|
||||
* (use the si5351_pll enum)
|
||||
*
|
||||
* Set the desired PLL source for a multisynth.
|
||||
*/
|
||||
void Si5351::set_ms_source(enum si5351_clock clk, enum si5351_pll pll)
|
||||
```
|
||||
###set_int()
|
||||
```
|
||||
/*
|
||||
* set_int(enum si5351_clock clk, uint8_t int_mode)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* enable - Set to 1 to enable, 0 to disable
|
||||
*
|
||||
* Set the indicated multisynth into integer mode.
|
||||
*/
|
||||
void Si5351::set_int(enum si5351_clock clk, uint8_t enable)
|
||||
```
|
||||
###set_clock_pwr()
|
||||
```
|
||||
/*
|
||||
* set_clock_pwr(enum si5351_clock clk, uint8_t pwr)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* pwr - Set to 1 to enable, 0 to disable
|
||||
*
|
||||
* Enable or disable power to a clock output (a power
|
||||
* saving feature).
|
||||
*/
|
||||
void Si5351::set_clock_pwr(enum si5351_clock clk, uint8_t pwr)
|
||||
```
|
||||
###set_clock_invert()
|
||||
```
|
||||
/*
|
||||
* set_clock_invert(enum si5351_clock clk, uint8_t inv)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* inv - Set to 1 to enable, 0 to disable
|
||||
*
|
||||
* Enable to invert the clock output waveform.
|
||||
*/
|
||||
void Si5351::set_clock_invert(enum si5351_clock clk, uint8_t inv)
|
||||
```
|
||||
###set_clock_source()
|
||||
```
|
||||
/*
|
||||
* set_clock_source(enum si5351_clock clk, enum si5351_clock_source src)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* src - Which clock source to use for the multisynth
|
||||
* (use the si5351_clock_source enum)
|
||||
*
|
||||
* Set the clock source for a multisynth (based on the options
|
||||
* presented for Registers 16-23 in the Silicon Labs AN619 document).
|
||||
* Choices are XTAL, CLKIN, MS0, or the multisynth associated with
|
||||
* the clock output.
|
||||
*/
|
||||
void Si5351::set_clock_source(enum si5351_clock clk, enum si5351_clock_source src)
|
||||
```
|
||||
###set_clock_disable()
|
||||
```
|
||||
/*
|
||||
* set_clock_disable(enum si5351_clock clk, enum si5351_clock_disable dis_state)
|
||||
*
|
||||
* clk - Clock output
|
||||
* (use the si5351_clock enum)
|
||||
* dis_state - Desired state of the output upon disable
|
||||
* (use the si5351_clock_disable enum)
|
||||
*
|
||||
* Set the state of the clock output when it is disabled. Per page 27
|
||||
* of AN619 (Registers 24 and 25), there are four possible values: low,
|
||||
* high, high impedance, and never disabled.
|
||||
*/
|
||||
void Si5351::set_clock_disable(enum si5351_clock clk, enum si5351_clock_disable dis_state)
|
||||
```
|
||||
###set_clock_fanout()
|
||||
```
|
||||
/*
|
||||
* set_clock_fanout(enum si5351_clock_fanout fanout, uint8_t enable)
|
||||
*
|
||||
* fanout - Desired clock fanout
|
||||
* (use the si5351_clock_fanout enum)
|
||||
* enable - Set to 1 to enable, 0 to disable
|
||||
*
|
||||
* Use this function to enable or disable the clock fanout options
|
||||
* for individual clock outputs. If you intend to output the XO or
|
||||
* CLKIN on the clock outputs, enable this first.
|
||||
*
|
||||
* By default, only the Multisynth fanout is enabled at startup.
|
||||
*/
|
||||
void Si5351::set_clock_fanout(enum si5351_clock_fanout fanout, uint8_t enable)
|
||||
```
|
||||
###si5351_write_bulk()
|
||||
```
|
||||
uint8_t Si5351::si5351_write_bulk(uint8_t addr, uint8_t bytes, uint8_t *data)
|
||||
```
|
||||
###si5351_write()
|
||||
```
|
||||
uint8_t Si5351::si5351_write(uint8_t addr, uint8_t data)
|
||||
```
|
||||
###si5351_read()
|
||||
```
|
||||
uint8_t Si5351::si5351_read(uint8_t addr)
|
||||
```
|
||||
|
||||
Tokens
|
||||
------
|
||||
Here are the defines, structs, and enumerations you will find handy to use with the library.
|
||||
|
||||
Crystal load capacitance:
|
||||
|
||||
SI5351_CRYSTAL_LOAD_6PF
|
||||
SI5351_CRYSTAL_LOAD_8PF
|
||||
SI5351_CRYSTAL_LOAD_10PF
|
||||
|
||||
Clock outputs:
|
||||
|
||||
enum si5351_clock {SI5351_CLK0, SI5351_CLK1, SI5351_CLK2, SI5351_CLK3,
|
||||
SI5351_CLK4, SI5351_CLK5, SI5351_CLK6, SI5351_CLK7};
|
||||
|
||||
PLL sources:
|
||||
|
||||
enum si5351_pll {SI5351_PLLA, SI5351_PLLB};
|
||||
|
||||
Drive levels:
|
||||
|
||||
enum si5351_drive {SI5351_DRIVE_2MA, SI5351_DRIVE_4MA, SI5351_DRIVE_6MA, SI5351_DRIVE_8MA};
|
||||
|
||||
Clock sources:
|
||||
|
||||
enum si5351_clock_source {SI5351_CLK_SRC_XTAL, SI5351_CLK_SRC_CLKIN, SI5351_CLK_SRC_MS0, SI5351_CLK_SRC_MS};
|
||||
|
||||
Clock disable states:
|
||||
|
||||
enum si5351_clock_disable {SI5351_CLK_DISABLE_LOW, SI5351_CLK_DISABLE_HIGH, SI5351_CLK_DISABLE_HI_Z, SI5351_CLK_DISABLE_NEVER};
|
||||
|
||||
Clock fanout:
|
||||
|
||||
enum si5351_clock_fanout {SI5351_FANOUT_CLKIN, SI5351_FANOUT_XO, SI5351_FANOUT_MS};
|
||||
|
||||
Status register:
|
||||
|
||||
struct Si5351Status
|
||||
{
|
||||
uint8_t SYS_INIT;
|
||||
uint8_t LOL_B;
|
||||
uint8_t LOL_A;
|
||||
uint8_t LOS;
|
||||
uint8_t REVID;
|
||||
};
|
||||
|
||||
Interrupt register:
|
||||
|
||||
struct Si5351IntStatus
|
||||
{
|
||||
uint8_t SYS_INIT_STKY;
|
||||
uint8_t LOL_B_STKY;
|
||||
uint8_t LOL_A_STKY;
|
||||
uint8_t LOS_STKY;
|
||||
};
|
||||
|
||||
Raw Commands
|
||||
------------
|
||||
If you need to read and write raw data to the Si5351, there is public access to the library's read(), write(), and write_bulk() methods.
|
||||
|
||||
Changes from alpha version
|
||||
--------------------------
|
||||
* Added reference oscillator frequency parameter to init()
|
||||
* Changed the correction factor from parts-per-ten million to parts-per-billion
|
||||
|
||||
Oddities
|
||||
--------
|
||||
Right now, this code is focused solely on the 3-output 10-MSOP variant (Si5351A3). Since some of the code was derived from the Si5351 driver in the Linux kernel, it may be useable on with the other variants, but certainly many features won't work yet. With any luck, we will get the library to work with the other variants as well, or even better, maybe someone will take the initiative, write the code, and send me a pull request.
|
||||
|
||||
TODO
|
||||
----
|
||||
- [x] Create an interface to the ref osc frequency
|
||||
- [x] Implement clock disable state
|
||||
- [x] Implement invert
|
||||
- [x] Implement power up/down
|
||||
- [x] Implement phase register access
|
||||
- [x] Implement tuning above 150 MHz
|
||||
- [x] Implement tuning below 1 MHz
|
||||
- [x] Implement sub-Hz tuning
|
||||
- [x] Implement PLL reset
|
||||
|
||||
[1]: http://www.silabs.com
|
||||
[2]: https://www.etherkit.com
|
||||
115
si5351/examples/si5351calibration/si5351calibration.ino
Normal file
115
si5351/examples/si5351calibration/si5351calibration.ino
Normal file
|
|
@ -0,0 +1,115 @@
|
|||
/* Simple calibration routine for the Si5351 breakout board.
|
||||
*
|
||||
* Copyright 2015 Paul Warren <pwarren@pwarren.id.au>
|
||||
*
|
||||
* Uses code from https://github.com/darksidelemm/open_radio_miniconf_2015
|
||||
* and the old version of the calibration sketch
|
||||
*
|
||||
* This sketch is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
* Foobar is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
* You should have received a copy of the GNU General Public License.
|
||||
* If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "si5351.h"
|
||||
#include "Wire.h"
|
||||
|
||||
Si5351 si5351;
|
||||
|
||||
int32_t cal_factor;
|
||||
int32_t old_cal;
|
||||
|
||||
uint64_t rx_freq;
|
||||
uint64_t target_freq = 1000000000ULL; // 10 MHz, in hundredths of hertz
|
||||
|
||||
void setup()
|
||||
{
|
||||
// Start serial and initialize the Si5351
|
||||
Serial.begin(57600);
|
||||
si5351.init(SI5351_CRYSTAL_LOAD_8PF, 0);
|
||||
|
||||
// get old cal factor
|
||||
//old_cal = si5351.get_correction();
|
||||
si5351.set_correction(0);
|
||||
// start on target frequency
|
||||
si5351.set_pll(SI5351_PLL_FIXED, SI5351_PLLA);
|
||||
si5351.set_freq(target_freq, SI5351_PLL_FIXED, SI5351_CLK0);
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
si5351.update_status();
|
||||
if (si5351.dev_status.SYS_INIT == 1) {
|
||||
Serial.println("Initialising Si5351, you shouldn't see many of these!");
|
||||
delay(500);
|
||||
} else {
|
||||
cal_factor = 0;
|
||||
// Serial.print("Old cal factor was: ");
|
||||
// Serial.println(old_cal);
|
||||
// Serial.println("Cal factor now set to 0");
|
||||
// si5351.set_correction(0);
|
||||
Serial.println();
|
||||
Serial.println(F("Adjust until your frequency counter reads as close to 10 MHz as possible"));
|
||||
vfo_interface();
|
||||
Serial.print(F("Calibration factor is "));
|
||||
Serial.println(cal_factor);
|
||||
Serial.println("Setting calibration factor");
|
||||
si5351.set_correction(cal_factor);
|
||||
Serial.println("Resetting target frequency");
|
||||
si5351.set_freq(target_freq, SI5351_PLL_FIXED, SI5351_CLK0);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
static void flush_input(void)
|
||||
{
|
||||
while (Serial.available() > 0)
|
||||
Serial.read();
|
||||
}
|
||||
|
||||
static void vfo_interface(void)
|
||||
{
|
||||
rx_freq = target_freq;
|
||||
Serial.println(F(" Up: r t y u i o p"));
|
||||
Serial.println(F(" Down: f g h j k l ;"));
|
||||
Serial.println(F(" Hz: 0.01 0.1 1 10 100 1K 10k"));
|
||||
while (1) {
|
||||
if (Serial.available() > 0) {
|
||||
char c = Serial.read();
|
||||
switch (c) {
|
||||
case 'q':
|
||||
flush_input();
|
||||
return;
|
||||
case 'r': rx_freq += 1; break;
|
||||
case 'f': rx_freq -= 1; break;
|
||||
case 't': rx_freq += 10; break;
|
||||
case 'g': rx_freq -= 10; break;
|
||||
case 'y': rx_freq += 100; break;
|
||||
case 'h': rx_freq -= 100; break;
|
||||
case 'u': rx_freq += 1000; break;
|
||||
case 'j': rx_freq -= 1000; break;
|
||||
case 'i': rx_freq += 10000; break;
|
||||
case 'k': rx_freq -= 10000; break;
|
||||
case 'o': rx_freq += 100000; break;
|
||||
case 'l': rx_freq -= 100000; break;
|
||||
case 'p': rx_freq += 1000000; break;
|
||||
case ';': rx_freq -= 1000000; break;
|
||||
default:
|
||||
// Do nothing
|
||||
continue;
|
||||
}
|
||||
si5351.set_freq(rx_freq,SI5351_PLL_FIXED,SI5351_CLK0);
|
||||
cal_factor = (int32_t)(target_freq - rx_freq);
|
||||
Serial.print("Current difference:");
|
||||
Serial.println(cal_factor);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
56
si5351/examples/si5351example/si5351example.ino
Normal file
56
si5351/examples/si5351example/si5351example.ino
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
/*
|
||||
* si5351example.ino - Simple example of using Si5351Arduino library
|
||||
*
|
||||
* Copyright (C) 2015 Jason Milldrum <milldrum@gmail.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
|
||||
#include "si5351.h"
|
||||
#include "Wire.h"
|
||||
|
||||
Si5351 si5351;
|
||||
|
||||
void setup()
|
||||
{
|
||||
// Start serial and initialize the Si5351
|
||||
Serial.begin(57600);
|
||||
si5351.init(SI5351_CRYSTAL_LOAD_8PF, 0);
|
||||
|
||||
// Set CLK0 to output 14 MHz with a fixed PLL frequency
|
||||
si5351.set_pll(SI5351_PLL_FIXED, SI5351_PLLA);
|
||||
si5351.set_freq(1400000000ULL, SI5351_PLL_FIXED, SI5351_CLK0);
|
||||
|
||||
// Set CLK1 to output 20 MHz
|
||||
si5351.set_freq(2000000000ULL, 0ULL, SI5351_CLK1);
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
// Read the Status Register and print it every 10 seconds
|
||||
si5351.update_status();
|
||||
Serial.print("SYS_INIT: ");
|
||||
Serial.print(si5351.dev_status.SYS_INIT);
|
||||
Serial.print(" LOL_A: ");
|
||||
Serial.print(si5351.dev_status.LOL_A);
|
||||
Serial.print(" LOL_B: ");
|
||||
Serial.print(si5351.dev_status.LOL_B);
|
||||
Serial.print(" LOS: ");
|
||||
Serial.print(si5351.dev_status.LOS);
|
||||
Serial.print(" REVID: ");
|
||||
Serial.println(si5351.dev_status.REVID);
|
||||
|
||||
delay(10000);
|
||||
}
|
||||
92
si5351/examples/si5351phase/si5351phase.ino
Normal file
92
si5351/examples/si5351phase/si5351phase.ino
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
/*
|
||||
* si5351phase.ino - Example for setting phase with Si5351Arduino library
|
||||
*
|
||||
* Copyright (C) 2015 Jason Milldrum <milldrum@gmail.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Setting the phase of a clock requires that you manually set the PLL and
|
||||
* take the PLL frequency into account when calculation the value to place
|
||||
* in the phase register. As shown on page 10 of Silicon Labs Application
|
||||
* Note 619 (AN619), the phase register is a 7-bit register, where a bit
|
||||
* represents a phase difference of 1/4 the PLL period. Therefore, the best
|
||||
* way to get an accurate phase setting is to make the PLL an even multiple
|
||||
* of the clock frequency, depending on what phase you need.
|
||||
*
|
||||
* If you need a 90 degree phase shift (as in many RF applications), then
|
||||
* it is quite easy to determine your parameters. Pick a PLL frequency that
|
||||
* is an even multiple of your clock frequency (remember that the PLL needs
|
||||
* to be in the range of 600 to 900 MHz). Then to set a 90 degree phase shift,
|
||||
* you simply enter that multiple into the phase register. Remember when
|
||||
* setting multiple outputs to be phase-related to each other, they each need
|
||||
* to be referenced to the same PLL.
|
||||
*/
|
||||
|
||||
#include "si5351.h"
|
||||
#include "Wire.h"
|
||||
|
||||
Si5351 si5351;
|
||||
|
||||
void setup()
|
||||
{
|
||||
// Start serial and initialize the Si5351
|
||||
Serial.begin(57600);
|
||||
si5351.init(SI5351_CRYSTAL_LOAD_8PF, 0);
|
||||
|
||||
// We will output 14.1 MHz on CLK0 and CLK1.
|
||||
// A PLLA frequency of 705 MHz was chosen to give an even
|
||||
// divisor by 14.1 MHz.
|
||||
unsigned long long freq = 1410000000ULL;
|
||||
unsigned long long pll_freq = 70500000000ULL;
|
||||
|
||||
// Set PLLA to the chosen frequency
|
||||
si5351.set_pll(pll_freq, SI5351_PLLA);
|
||||
|
||||
// Set CLK0 and CLK1 to use PLLA as the MS source
|
||||
si5351.set_ms_source(SI5351_CLK0, SI5351_PLLA);
|
||||
si5351.set_ms_source(SI5351_CLK1, SI5351_PLLA);
|
||||
|
||||
// Set CLK0 and CLK1 to output 14.1 MHz with a fixed PLL frequency
|
||||
si5351.set_freq(freq, pll_freq, SI5351_CLK0);
|
||||
si5351.set_freq(freq, pll_freq, SI5351_CLK1);
|
||||
|
||||
// Now we can set CLK1 to have a 90 deg phase shift by entering
|
||||
// 50 in the CLK1 phase register, since the ratio of the PLL to
|
||||
// the clock frequency is 50.
|
||||
si5351.set_phase(SI5351_CLK0, 0);
|
||||
si5351.set_phase(SI5351_CLK1, 50);
|
||||
|
||||
// We need to reset the PLL before they will be in phase alignment
|
||||
si5351.pll_reset(SI5351_PLLA);
|
||||
}
|
||||
|
||||
void loop()
|
||||
{
|
||||
// Read the Status Register and print it every 10 seconds
|
||||
si5351.update_status();
|
||||
Serial.print("SYS_INIT: ");
|
||||
Serial.print(si5351.dev_status.SYS_INIT);
|
||||
Serial.print(" LOL_A: ");
|
||||
Serial.print(si5351.dev_status.LOL_A);
|
||||
Serial.print(" LOL_B: ");
|
||||
Serial.print(si5351.dev_status.LOL_B);
|
||||
Serial.print(" LOS: ");
|
||||
Serial.print(si5351.dev_status.LOS);
|
||||
Serial.print(" REVID: ");
|
||||
Serial.println(si5351.dev_status.REVID);
|
||||
|
||||
delay(10000);
|
||||
}
|
||||
28
si5351/keywords.txt
Normal file
28
si5351/keywords.txt
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
Si5351 KEYWORD1
|
||||
|
||||
set_freq KEYWORD2
|
||||
set_pll KEYWORD2
|
||||
clock_enable KEYWORD2
|
||||
drive_strength KEYWORD2
|
||||
update_status KEYWORD2
|
||||
set_correction KEYWORD2
|
||||
get_correction KEYWORD2
|
||||
|
||||
SI5351_PLL_FIXED LITERAL1
|
||||
SI5351_CRYSTAL_LOAD_6PF LITERAL1
|
||||
SI5351_CRYSTAL_LOAD_8PF LITERAL1
|
||||
SI5351_CRYSTAL_LOAD_10PF LITERAL1
|
||||
SI5351_CLK0 LITERAL1
|
||||
SI5351_CLK1 LITERAL1
|
||||
SI5351_CLK2 LITERAL1
|
||||
SI5351_CLK3 LITERAL1
|
||||
SI5351_CLK4 LITERAL1
|
||||
SI5351_CLK5 LITERAL1
|
||||
SI5351_CLK6 LITERAL1
|
||||
SI5351_CLK7 LITERAL1
|
||||
SI5351_PLLA LITERAL1
|
||||
SI5351_PLLB LITERAL1
|
||||
SI5351_DRIVE_2MA LITERAL1
|
||||
SI5351_DRIVE_4MA LITERAL1
|
||||
SI5351_DRIVE_6MA LITERAL1
|
||||
SI5351_DRIVE_8MA LITERAL1
|
||||
674
si5351/licence.txt
Normal file
674
si5351/licence.txt
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
1196
si5351/si5351.cpp
Normal file
1196
si5351/si5351.cpp
Normal file
File diff suppressed because it is too large
Load Diff
312
si5351/si5351.h
Normal file
312
si5351/si5351.h
Normal file
|
|
@ -0,0 +1,312 @@
|
|||
/*
|
||||
* si5351.h - Si5351 library for Arduino
|
||||
*
|
||||
* Copyright (C) 2015 Jason Milldrum <milldrum@gmail.com>
|
||||
* Dana H. Myers <k6jq@comcast.net>
|
||||
*
|
||||
* Many defines derived from clk-si5351.h in the Linux kernel.
|
||||
* Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>
|
||||
* Rabeeh Khoury <rabeeh@solid-run.com>
|
||||
*
|
||||
* do_div() macro derived from /include/asm-generic/div64.h in
|
||||
* the Linux kernel.
|
||||
* Copyright (C) 2003 Bernardo Innocenti <bernie@develer.com>
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#ifndef SI5351_H_
|
||||
#define SI5351_H_
|
||||
|
||||
#include "Arduino.h"
|
||||
#include "Wire.h"
|
||||
#include <stdint.h>
|
||||
|
||||
/* Define definitions */
|
||||
|
||||
#define SI5351_BUS_BASE_ADDR 0x60
|
||||
#define SI5351_XTAL_FREQ 25000000
|
||||
#define SI5351_PLL_FIXED 90000000000ULL
|
||||
#define SI5351_FREQ_MULT 100ULL
|
||||
#define SI5351_DEFAULT_CLK 1000000000ULL
|
||||
|
||||
#define SI5351_PLL_VCO_MIN 600000000
|
||||
#define SI5351_PLL_VCO_MAX 900000000
|
||||
#define SI5351_MULTISYNTH_MIN_FREQ 1000000
|
||||
#define SI5351_MULTISYNTH_DIVBY4_FREQ 150000000
|
||||
#define SI5351_MULTISYNTH_MAX_FREQ 160000000
|
||||
#define SI5351_MULTISYNTH_SHARE_MAX 112500000
|
||||
#define SI5351_MULTISYNTH67_MAX_FREQ SI5351_MULTISYNTH_DIVBY4_FREQ
|
||||
#define SI5351_CLKOUT_MIN_FREQ 8000
|
||||
#define SI5351_CLKOUT_MAX_FREQ SI5351_MULTISYNTH_MAX_FREQ
|
||||
#define SI5351_CLKOUT67_MAX_FREQ SI5351_MULTISYNTH67_MAX_FREQ
|
||||
|
||||
#define SI5351_PLL_A_MIN 15
|
||||
#define SI5351_PLL_A_MAX 90
|
||||
#define SI5351_PLL_B_MAX (SI5351_PLL_C_MAX-1)
|
||||
#define SI5351_PLL_C_MAX 1048575
|
||||
#define SI5351_MULTISYNTH_A_MIN 6
|
||||
#define SI5351_MULTISYNTH_A_MAX 1800
|
||||
#define SI5351_MULTISYNTH67_A_MAX 254
|
||||
#define SI5351_MULTISYNTH_B_MAX (SI5351_MULTISYNTH_C_MAX-1)
|
||||
#define SI5351_MULTISYNTH_C_MAX 1048575
|
||||
#define SI5351_MULTISYNTH_P1_MAX ((1<<18)-1)
|
||||
#define SI5351_MULTISYNTH_P2_MAX ((1<<20)-1)
|
||||
#define SI5351_MULTISYNTH_P3_MAX ((1<<20)-1)
|
||||
|
||||
#define SI5351_DEVICE_STATUS 0
|
||||
#define SI5351_INTERRUPT_STATUS 1
|
||||
#define SI5351_INTERRUPT_MASK 2
|
||||
#define SI5351_STATUS_SYS_INIT (1<<7)
|
||||
#define SI5351_STATUS_LOL_B (1<<6)
|
||||
#define SI5351_STATUS_LOL_A (1<<5)
|
||||
#define SI5351_STATUS_LOS (1<<4)
|
||||
#define SI5351_OUTPUT_ENABLE_CTRL 3
|
||||
#define SI5351_OEB_PIN_ENABLE_CTRL 9
|
||||
#define SI5351_PLL_INPUT_SOURCE 15
|
||||
#define SI5351_CLKIN_DIV_MASK (3<<6)
|
||||
#define SI5351_CLKIN_DIV_1 (0<<6)
|
||||
#define SI5351_CLKIN_DIV_2 (1<<6)
|
||||
#define SI5351_CLKIN_DIV_4 (2<<6)
|
||||
#define SI5351_CLKIN_DIV_8 (3<<6)
|
||||
#define SI5351_PLLB_SOURCE (1<<3)
|
||||
#define SI5351_PLLA_SOURCE (1<<2)
|
||||
|
||||
#define SI5351_CLK0_CTRL 16
|
||||
#define SI5351_CLK1_CTRL 17
|
||||
#define SI5351_CLK2_CTRL 18
|
||||
#define SI5351_CLK3_CTRL 19
|
||||
#define SI5351_CLK4_CTRL 20
|
||||
#define SI5351_CLK5_CTRL 21
|
||||
#define SI5351_CLK6_CTRL 22
|
||||
#define SI5351_CLK7_CTRL 23
|
||||
#define SI5351_CLK_POWERDOWN (1<<7)
|
||||
#define SI5351_CLK_INTEGER_MODE (1<<6)
|
||||
#define SI5351_CLK_PLL_SELECT (1<<5)
|
||||
#define SI5351_CLK_INVERT (1<<4)
|
||||
#define SI5351_CLK_INPUT_MASK (3<<2)
|
||||
#define SI5351_CLK_INPUT_XTAL (0<<2)
|
||||
#define SI5351_CLK_INPUT_CLKIN (1<<2)
|
||||
#define SI5351_CLK_INPUT_MULTISYNTH_0_4 (2<<2)
|
||||
#define SI5351_CLK_INPUT_MULTISYNTH_N (3<<2)
|
||||
#define SI5351_CLK_DRIVE_STRENGTH_MASK (3<<0)
|
||||
#define SI5351_CLK_DRIVE_STRENGTH_2MA (0<<0)
|
||||
#define SI5351_CLK_DRIVE_STRENGTH_4MA (1<<0)
|
||||
#define SI5351_CLK_DRIVE_STRENGTH_6MA (2<<0)
|
||||
#define SI5351_CLK_DRIVE_STRENGTH_8MA (3<<0)
|
||||
|
||||
#define SI5351_CLK3_0_DISABLE_STATE 24
|
||||
#define SI5351_CLK7_4_DISABLE_STATE 25
|
||||
#define SI5351_CLK_DISABLE_STATE_MASK 3
|
||||
#define SI5351_CLK_DISABLE_STATE_LOW 0
|
||||
#define SI5351_CLK_DISABLE_STATE_HIGH 1
|
||||
#define SI5351_CLK_DISABLE_STATE_FLOAT 2
|
||||
#define SI5351_CLK_DISABLE_STATE_NEVER 3
|
||||
|
||||
#define SI5351_PARAMETERS_LENGTH 8
|
||||
#define SI5351_PLLA_PARAMETERS 26
|
||||
#define SI5351_PLLB_PARAMETERS 34
|
||||
#define SI5351_CLK0_PARAMETERS 42
|
||||
#define SI5351_CLK1_PARAMETERS 50
|
||||
#define SI5351_CLK2_PARAMETERS 58
|
||||
#define SI5351_CLK3_PARAMETERS 66
|
||||
#define SI5351_CLK4_PARAMETERS 74
|
||||
#define SI5351_CLK5_PARAMETERS 82
|
||||
#define SI5351_CLK6_PARAMETERS 90
|
||||
#define SI5351_CLK7_PARAMETERS 91
|
||||
#define SI5351_CLK6_7_OUTPUT_DIVIDER 92
|
||||
#define SI5351_OUTPUT_CLK_DIV_MASK (7 << 4)
|
||||
#define SI5351_OUTPUT_CLK6_DIV_MASK (7 << 0)
|
||||
#define SI5351_OUTPUT_CLK_DIV_SHIFT 4
|
||||
#define SI5351_OUTPUT_CLK_DIV6_SHIFT 0
|
||||
#define SI5351_OUTPUT_CLK_DIV_1 0
|
||||
#define SI5351_OUTPUT_CLK_DIV_2 1
|
||||
#define SI5351_OUTPUT_CLK_DIV_4 2
|
||||
#define SI5351_OUTPUT_CLK_DIV_8 3
|
||||
#define SI5351_OUTPUT_CLK_DIV_16 4
|
||||
#define SI5351_OUTPUT_CLK_DIV_32 5
|
||||
#define SI5351_OUTPUT_CLK_DIV_64 6
|
||||
#define SI5351_OUTPUT_CLK_DIV_128 7
|
||||
#define SI5351_OUTPUT_CLK_DIVBY4 (3<<2)
|
||||
|
||||
#define SI5351_SSC_PARAM0 149
|
||||
#define SI5351_SSC_PARAM1 150
|
||||
#define SI5351_SSC_PARAM2 151
|
||||
#define SI5351_SSC_PARAM3 152
|
||||
#define SI5351_SSC_PARAM4 153
|
||||
#define SI5351_SSC_PARAM5 154
|
||||
#define SI5351_SSC_PARAM6 155
|
||||
#define SI5351_SSC_PARAM7 156
|
||||
#define SI5351_SSC_PARAM8 157
|
||||
#define SI5351_SSC_PARAM9 158
|
||||
#define SI5351_SSC_PARAM10 159
|
||||
#define SI5351_SSC_PARAM11 160
|
||||
#define SI5351_SSC_PARAM12 161
|
||||
|
||||
#define SI5351_VXCO_PARAMETERS_LOW 162
|
||||
#define SI5351_VXCO_PARAMETERS_MID 163
|
||||
#define SI5351_VXCO_PARAMETERS_HIGH 164
|
||||
|
||||
#define SI5351_CLK0_PHASE_OFFSET 165
|
||||
#define SI5351_CLK1_PHASE_OFFSET 166
|
||||
#define SI5351_CLK2_PHASE_OFFSET 167
|
||||
#define SI5351_CLK3_PHASE_OFFSET 168
|
||||
#define SI5351_CLK4_PHASE_OFFSET 169
|
||||
#define SI5351_CLK5_PHASE_OFFSET 170
|
||||
|
||||
#define SI5351_PLL_RESET 177
|
||||
#define SI5351_PLL_RESET_B (1<<7)
|
||||
#define SI5351_PLL_RESET_A (1<<5)
|
||||
|
||||
#define SI5351_CRYSTAL_LOAD 183
|
||||
#define SI5351_CRYSTAL_LOAD_MASK (3<<6)
|
||||
#define SI5351_CRYSTAL_LOAD_6PF (1<<6)
|
||||
#define SI5351_CRYSTAL_LOAD_8PF (2<<6)
|
||||
#define SI5351_CRYSTAL_LOAD_10PF (3<<6)
|
||||
|
||||
#define SI5351_FANOUT_ENABLE 187
|
||||
#define SI5351_CLKIN_ENABLE (1<<7)
|
||||
#define SI5351_XTAL_ENABLE (1<<6)
|
||||
#define SI5351_MULTISYNTH_ENABLE (1<<4)
|
||||
|
||||
|
||||
/* Macro definitions */
|
||||
|
||||
#define RFRAC_DENOM ((1L << 20) - 1)
|
||||
|
||||
/*
|
||||
* Based on former asm-ppc/div64.h and asm-m68knommu/div64.h
|
||||
*
|
||||
* The semantics of do_div() are:
|
||||
*
|
||||
* uint32_t do_div(uint64_t *n, uint32_t base)
|
||||
* {
|
||||
* uint32_t remainder = *n % base;
|
||||
* *n = *n / base;
|
||||
* return remainder;
|
||||
* }
|
||||
*
|
||||
* NOTE: macro parameter n is evaluated multiple times,
|
||||
* beware of side effects!
|
||||
*/
|
||||
|
||||
# define do_div(n,base) ({ \
|
||||
uint64_t __base = (base); \
|
||||
uint64_t __rem; \
|
||||
__rem = ((uint64_t)(n)) % __base; \
|
||||
(n) = ((uint64_t)(n)) / __base; \
|
||||
__rem; \
|
||||
})
|
||||
|
||||
/* Enum definitions */
|
||||
|
||||
/*
|
||||
* enum si5351_variant - SiLabs Si5351 chip variant
|
||||
* @SI5351_VARIANT_A: Si5351A (8 output clocks, XTAL input)
|
||||
* @SI5351_VARIANT_A3: Si5351A MSOP10 (3 output clocks, XTAL input)
|
||||
* @SI5351_VARIANT_B: Si5351B (8 output clocks, XTAL/VXCO input)
|
||||
* @SI5351_VARIANT_C: Si5351C (8 output clocks, XTAL/CLKIN input)
|
||||
*/
|
||||
enum si5351_variant {
|
||||
SI5351_VARIANT_A = 1,
|
||||
SI5351_VARIANT_A3 = 2,
|
||||
SI5351_VARIANT_B = 3,
|
||||
SI5351_VARIANT_C = 4,
|
||||
};
|
||||
|
||||
enum si5351_clock {SI5351_CLK0, SI5351_CLK1, SI5351_CLK2, SI5351_CLK3,
|
||||
SI5351_CLK4, SI5351_CLK5, SI5351_CLK6, SI5351_CLK7, SI5351_CLKNONE};
|
||||
|
||||
enum si5351_pll {SI5351_PLLA, SI5351_PLLB};
|
||||
|
||||
enum si5351_drive {SI5351_DRIVE_2MA, SI5351_DRIVE_4MA, SI5351_DRIVE_6MA, SI5351_DRIVE_8MA};
|
||||
|
||||
enum si5351_clock_source {SI5351_CLK_SRC_XTAL, SI5351_CLK_SRC_CLKIN, SI5351_CLK_SRC_MS0, SI5351_CLK_SRC_MS};
|
||||
|
||||
enum si5351_clock_disable {SI5351_CLK_DISABLE_LOW, SI5351_CLK_DISABLE_HIGH, SI5351_CLK_DISABLE_HI_Z, SI5351_CLK_DISABLE_NEVER};
|
||||
|
||||
enum si5351_clock_fanout {SI5351_FANOUT_CLKIN, SI5351_FANOUT_XO, SI5351_FANOUT_MS};
|
||||
|
||||
/* Struct definitions */
|
||||
|
||||
struct Si5351RegSet
|
||||
{
|
||||
uint32_t p1;
|
||||
uint32_t p2;
|
||||
uint32_t p3;
|
||||
};
|
||||
|
||||
struct Si5351Status
|
||||
{
|
||||
uint8_t SYS_INIT;
|
||||
uint8_t LOL_B;
|
||||
uint8_t LOL_A;
|
||||
uint8_t LOS;
|
||||
uint8_t REVID;
|
||||
};
|
||||
|
||||
struct Si5351IntStatus
|
||||
{
|
||||
uint8_t SYS_INIT_STKY;
|
||||
uint8_t LOL_B_STKY;
|
||||
uint8_t LOL_A_STKY;
|
||||
uint8_t LOS_STKY;
|
||||
};
|
||||
|
||||
class Si5351
|
||||
{
|
||||
public:
|
||||
Si5351(void);
|
||||
void init(uint8_t, uint32_t);
|
||||
uint8_t set_freq(uint64_t, uint64_t, enum si5351_clock);
|
||||
void set_pll(uint64_t, enum si5351_pll);
|
||||
void set_ms(enum si5351_clock, struct Si5351RegSet, uint8_t, uint8_t, uint8_t);
|
||||
void output_enable(enum si5351_clock, uint8_t);
|
||||
void drive_strength(enum si5351_clock, enum si5351_drive);
|
||||
void update_status(void);
|
||||
void set_correction(int32_t);
|
||||
void set_phase(enum si5351_clock, uint8_t);
|
||||
int32_t get_correction(void);
|
||||
void pll_reset(enum si5351_pll);
|
||||
void set_ms_source(enum si5351_clock, enum si5351_pll);
|
||||
void set_int(enum si5351_clock, uint8_t);
|
||||
void set_clock_pwr(enum si5351_clock, uint8_t);
|
||||
void set_clock_invert(enum si5351_clock, uint8_t);
|
||||
void set_clock_source(enum si5351_clock, enum si5351_clock_source);
|
||||
void set_clock_disable(enum si5351_clock, enum si5351_clock_disable);
|
||||
void set_clock_fanout(enum si5351_clock_fanout, uint8_t);
|
||||
uint8_t si5351_write_bulk(uint8_t, uint8_t, uint8_t *);
|
||||
uint8_t si5351_write(uint8_t, uint8_t);
|
||||
uint8_t si5351_read(uint8_t);
|
||||
struct Si5351Status dev_status;
|
||||
struct Si5351IntStatus dev_int_status;
|
||||
uint64_t plla_freq;
|
||||
uint64_t pllb_freq;
|
||||
uint64_t clk0_freq;
|
||||
uint64_t clk1_freq;
|
||||
uint64_t clk2_freq;
|
||||
uint8_t clk0_int_mode, clk1_int_mode, clk2_int_mode;
|
||||
private:
|
||||
uint64_t pll_calc(uint64_t, struct Si5351RegSet *, int32_t);
|
||||
uint64_t multisynth_calc(uint64_t, uint64_t, struct Si5351RegSet *);
|
||||
void update_sys_status(struct Si5351Status *);
|
||||
void update_int_status(struct Si5351IntStatus *);
|
||||
void ms_div(enum si5351_clock, uint8_t, uint8_t);
|
||||
uint8_t select_r_div(uint64_t *);
|
||||
int32_t ref_correction;
|
||||
uint8_t lock_plla, lock_pllb;
|
||||
uint32_t xtal_freq;
|
||||
};
|
||||
|
||||
#endif /* SI5351_H_ */
|
||||
Loading…
Reference in New Issue
Block a user