Files
@ 779c7da65f38
Branch filter:
Location: FeatherHAB/wsprhab/lib/si5351/si5351.c
779c7da65f38
28.8 KiB
text/plain
Fix deinitting things that aren't initted
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 | /*
* si5351.cpp - Si5351 library for Arduino
*
* Copyright (C) 2015 Jason Milldrum <milldrum@gmail.com>
* Dana H. Myers <k6jq@comcast.net>
*
* Some tuning algorithms derived from clk-si5351.c in the Linux kernel.
* Sebastian Hesselbarth <sebastian.hesselbarth@gmail.com>
* Rabeeh Khoury <rabeeh@solid-run.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 <stdint.h>
#include "stm32f0xx_hal.h"
#include "si5351.h"
#include "gpio.h"
// Private prototypes
uint64_t si5351_pll_calc(uint64_t, struct Si5351RegSet *, int32_t);
uint64_t si5351_multisynth_calc(uint64_t, uint64_t, struct Si5351RegSet *);
void si5351_update_sys_status(struct Si5351Status *);
void si5351_update_int_status(struct Si5351IntStatus *);
void si5351_ms_div(enum si5351_clock, uint8_t, uint8_t);
uint8_t si5351_select_r_div(uint64_t *);
// Globals
int32_t ref_correction;
uint8_t lock_plla, lock_pllb;
uint32_t xtal_freq;
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;
struct Si5351Status dev_status;
struct Si5351IntStatus dev_int_status;
I2C_HandleTypeDef* si5351_i2cport;
/********************/
/* Public functions */
/********************/
/*
* 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(I2C_HandleTypeDef* i2cport, uint8_t xtal_load_c, uint32_t ref_osc_freq)
{
si5351_i2cport = i2cport;
lock_plla = SI5351_CLKNONE;
lock_pllb = SI5351_CLKNONE;
clk0_int_mode = 0;
clk1_int_mode = 0;
clk2_int_mode = 0;
plla_freq = 0ULL;
pllb_freq = 0ULL;
clk0_freq = 0ULL;
clk1_freq = 0ULL;
clk2_freq = 0ULL;
xtal_freq = SI5351_XTAL_FREQ;
// Set crystal load capacitance
si5351_write(SI5351_CRYSTAL_LOAD, xtal_load_c);
// Change the ref osc freq if different from default
if (ref_osc_freq != 0)
{
xtal_freq = ref_osc_freq;
}
// Initialize the CLK outputs according to flowchart in datasheet
// First, turn them off
si5351_write(16, 0x80);
si5351_write(17, 0x80);
si5351_write(18, 0x80);
// Turn the clocks back on...
si5351_write(16, 0x0c);
si5351_write(17, 0x0c);
si5351_write(18, 0x0c);
// Then reset the PLLs
si5351_pll_reset(SI5351_PLLA);
si5351_pll_reset(SI5351_PLLB);
}
/*
* 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)
{
struct Si5351RegSet ms_reg, pll_reg;
enum si5351_pll target_pll;
uint8_t write_pll = 0;
uint8_t reg_val;
uint8_t r_div = SI5351_OUTPUT_CLK_DIV_1;
uint8_t int_mode = 0;
uint8_t div_by_4 = 0;
// PLL bounds checking
if(pll_freq != 0)
{
if ((pll_freq < SI5351_PLL_VCO_MIN * SI5351_FREQ_MULT) || (pll_freq > SI5351_PLL_VCO_MAX * SI5351_FREQ_MULT))
{
return 1;
}
}
// Lower bounds check
if(freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT)
{
freq = SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT;
}
// Upper bounds check
if(freq > SI5351_MULTISYNTH_MAX_FREQ * SI5351_FREQ_MULT)
{
freq = SI5351_MULTISYNTH_MAX_FREQ * SI5351_FREQ_MULT;
}
// Select the proper R div value
r_div = si5351_select_r_div(&freq);
// Calculate the synth parameters
// If pll_freq is 0 and freq < 150 MHz, let the algorithm pick a PLL frequency
if((pll_freq) && (freq < SI5351_MULTISYNTH_DIVBY4_FREQ * SI5351_FREQ_MULT))
{
si5351_multisynth_calc(freq, pll_freq, &ms_reg);
write_pll = 0;
div_by_4 = 0;
int_mode = 0;
switch(clk)
{
case SI5351_CLK0:
clk0_freq = freq;
break;
case SI5351_CLK1:
clk1_freq = freq;
break;
case SI5351_CLK2:
clk2_freq = freq;
break;
default:
break;
}
}
else
{
// The PLL must be calculated and set by firmware when 150 MHz <= freq <= 160 MHz
if(freq >= SI5351_MULTISYNTH_DIVBY4_FREQ * SI5351_FREQ_MULT)
{
pll_freq = si5351_multisynth_calc(freq, 0, &ms_reg);
write_pll = 1;
div_by_4 = 1;
int_mode = 1;
}
// Determine which PLL to use
// CLK0 gets PLLA, CLK1 gets PLLB
// CLK2 gets PLLB if necessary
// Only good for Si5351A3 variant at the moment
switch(clk)
{
case SI5351_CLK0:
pll_freq = si5351_multisynth_calc(freq, 0, &ms_reg);
target_pll = SI5351_PLLA;
write_pll = 1;
si5351_set_ms_source(SI5351_CLK0, SI5351_PLLA);
plla_freq = pll_freq;
clk0_freq = freq;
break;
case SI5351_CLK1:
// Check to see if PLLB is locked due to other output being < 1.024 MHz or >= 112.5 MHz
if(lock_pllb == SI5351_CLK2)
{
// We can't have a 2nd output < 1.024 MHz or >= 112.5 MHz on the same PLL unless exact same freq, so exit
if((freq >= SI5351_MULTISYNTH_SHARE_MAX * SI5351_FREQ_MULT
|| freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 128) && freq != clk2_freq)
{
clk1_freq = 0;
return 1;
}
// Else, set multisynth to same PLL freq as CLK2
else
{
pll_freq = pllb_freq;
si5351_multisynth_calc(freq, pll_freq, &ms_reg);
write_pll = 0;
si5351_set_ms_source(SI5351_CLK1, SI5351_PLLB);
}
}
else
{
pllb_freq = pll_freq;
pll_freq = si5351_multisynth_calc(freq, 0, &ms_reg);
write_pll = 1;
si5351_set_ms_source(SI5351_CLK1, SI5351_PLLB);
}
if(freq >= SI5351_MULTISYNTH_SHARE_MAX * SI5351_FREQ_MULT || freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 128)
{
lock_pllb = SI5351_CLK1;
// Recalc and rewrite the multisynth parameters on CLK2
if(clk2_freq != 0)
{
struct Si5351RegSet ms_temp_reg;
r_div = si5351_select_r_div(&clk2_freq);
si5351_multisynth_calc(clk2_freq, pllb_freq, &ms_temp_reg);
si5351_set_ms(SI5351_CLK2, ms_temp_reg, 0, r_div, 0);
}
}
else
{
lock_pllb = SI5351_CLKNONE;
}
target_pll = SI5351_PLLB;
clk1_freq = freq;
break;
case SI5351_CLK2:
// Check to see if PLLB is locked due to other output being < 1.024 MHz or >= 112.5 MHz
if(lock_pllb == SI5351_CLK1)
{
// We can't have a 2nd output < 1.024 MHz or >= 112.5 MHz on the same PLL unless exact same freq, so exit
if((freq >= SI5351_MULTISYNTH_SHARE_MAX * SI5351_FREQ_MULT
|| freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 128) && freq != clk2_freq)
{
clk2_freq = 0;
return 1;
}
// Else, set multisynth to same PLL freq as CLK1
else
{
pll_freq = pllb_freq;
si5351_multisynth_calc(freq, pll_freq, &ms_reg);
write_pll = 0;
si5351_set_ms_source(SI5351_CLK2, SI5351_PLLB);
}
}
// need to account for CLK2 set before CLK1
else
{
pllb_freq = pll_freq;
pll_freq = si5351_multisynth_calc(freq, 0, &ms_reg);
write_pll = 1;
si5351_set_ms_source(SI5351_CLK2, SI5351_PLLB);
}
if(freq >= SI5351_MULTISYNTH_SHARE_MAX * SI5351_FREQ_MULT || freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 128)
{
lock_pllb = SI5351_CLK2;
if(clk1_freq != 0)
{
// Recalc and rewrite the multisynth parameters on CLK1
struct Si5351RegSet ms_temp_reg;
r_div = si5351_select_r_div(&clk1_freq);
si5351_multisynth_calc(clk1_freq, pllb_freq, &ms_temp_reg);
si5351_set_ms(SI5351_CLK1, ms_temp_reg, 0, r_div, 0);
}
}
else
{
lock_pllb = SI5351_CLKNONE;
}
target_pll = SI5351_PLLB;
clk2_freq = freq;
break;
default:
return 1;
}
}
// Set multisynth registers (MS must be set before PLL)
si5351_set_ms(clk, ms_reg, int_mode, r_div, div_by_4);
// Set PLL if necessary
if(write_pll == 1)
{
si5351_set_pll(pll_freq, target_pll);
}
return 0;
}
/*
* 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)
*/
uint8_t params[20];
void si5351_set_pll(uint64_t pll_freq, enum si5351_pll target_pll)
{
struct Si5351RegSet pll_reg;
si5351_pll_calc(pll_freq, &pll_reg, ref_correction);
// Derive the register values to write
// Prepare an array for parameters to be written to
// uint8_t *params = new uint8_t[20];
uint8_t i = 0;
uint8_t temp;
// Registers 26-27
temp = ((pll_reg.p3 >> 8) & 0xFF);
params[i++] = temp;
temp = (uint8_t)(pll_reg.p3 & 0xFF);
params[i++] = temp;
// Register 28
temp = (uint8_t)((pll_reg.p1 >> 16) & 0x03);
params[i++] = temp;
// Registers 29-30
temp = (uint8_t)((pll_reg.p1 >> 8) & 0xFF);
params[i++] = temp;
temp = (uint8_t)(pll_reg.p1 & 0xFF);
params[i++] = temp;
// Register 31
temp = (uint8_t)((pll_reg.p3 >> 12) & 0xF0);
temp += (uint8_t)((pll_reg.p2 >> 16) & 0x0F);
params[i++] = temp;
// Registers 32-33
temp = (uint8_t)((pll_reg.p2 >> 8) & 0xFF);
params[i++] = temp;
temp = (uint8_t)(pll_reg.p2 & 0xFF);
params[i++] = temp;
// Write the parameters
if(target_pll == SI5351_PLLA)
{
si5351_write_bulk(SI5351_PLLA_PARAMETERS, i, params);
}
else if(target_pll == SI5351_PLLB)
{
si5351_write_bulk(SI5351_PLLB_PARAMETERS, i, params);
}
// delete params;
}
/*
* 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)
{
// uint8_t *params = new uint8_t[20];
uint8_t i = 0;
uint8_t temp;
uint8_t reg_val;
// Registers 42-43 for CLK0
temp = (uint8_t)((ms_reg.p3 >> 8) & 0xFF);
params[i++] = temp;
temp = (uint8_t)(ms_reg.p3 & 0xFF);
params[i++] = temp;
// Register 44 for CLK0
reg_val = si5351_read((SI5351_CLK0_PARAMETERS + 2) + (clk * 8));
reg_val &= ~(0x03);
temp = reg_val | ((uint8_t)((ms_reg.p1 >> 16) & 0x03));
params[i++] = temp;
// Registers 45-46 for CLK0
temp = (uint8_t)((ms_reg.p1 >> 8) & 0xFF);
params[i++] = temp;
temp = (uint8_t)(ms_reg.p1 & 0xFF);
params[i++] = temp;
// Register 47 for CLK0
temp = (uint8_t)((ms_reg.p3 >> 12) & 0xF0);
temp += (uint8_t)((ms_reg.p2 >> 16) & 0x0F);
params[i++] = temp;
// Registers 48-49 for CLK0
temp = (uint8_t)((ms_reg.p2 >> 8) & 0xFF);
params[i++] = temp;
temp = (uint8_t)(ms_reg.p2 & 0xFF);
params[i++] = temp;
// Write the parameters
switch(clk)
{
case SI5351_CLK0:
si5351_write_bulk(SI5351_CLK0_PARAMETERS, i, params);
break;
case SI5351_CLK1:
si5351_write_bulk(SI5351_CLK1_PARAMETERS, i, params);
break;
case SI5351_CLK2:
si5351_write_bulk(SI5351_CLK2_PARAMETERS, i, params);
break;
case SI5351_CLK3:
si5351_write_bulk(SI5351_CLK3_PARAMETERS, i, params);
break;
case SI5351_CLK4:
si5351_write_bulk(SI5351_CLK4_PARAMETERS, i, params);
break;
case SI5351_CLK5:
si5351_write_bulk(SI5351_CLK5_PARAMETERS, i, params);
break;
case SI5351_CLK6:
si5351_write_bulk(SI5351_CLK6_PARAMETERS, i, params);
break;
case SI5351_CLK7:
si5351_write_bulk(SI5351_CLK7_PARAMETERS, i, params);
break;
}
si5351_set_int(clk, int_mode);
si5351_ms_div(clk, r_div, div_by_4);
//delete params;
}
/*
* 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)
{
uint8_t reg_val;
reg_val = si5351_read(SI5351_OUTPUT_ENABLE_CTRL);
if(enable == 1)
{
reg_val &= ~(1<<(uint8_t)clk);
}
else
{
reg_val |= (1<<(uint8_t)clk);
}
si5351_write(SI5351_OUTPUT_ENABLE_CTRL, reg_val);
}
/*
* 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)
{
uint8_t reg_val;
const uint8_t mask = 0x03;
reg_val = si5351_read(SI5351_CLK0_CTRL + (uint8_t)clk);
reg_val &= ~(mask);
switch(drive)
{
case SI5351_DRIVE_2MA:
reg_val |= 0x00;
break;
case SI5351_DRIVE_4MA:
reg_val |= 0x01;
break;
case SI5351_DRIVE_6MA:
reg_val |= 0x02;
break;
case SI5351_DRIVE_8MA:
reg_val |= 0x03;
break;
default:
break;
}
si5351_write(SI5351_CLK0_CTRL + (uint8_t)clk, reg_val);
}
/*
* 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)
{
si5351_update_sys_status(&dev_status);
si5351_update_int_status(&dev_int_status);
}
/*
* 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)
{
ref_correction = corr;
}
/*
* 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)
{
// Mask off the upper bit since it is reserved
phase = phase & 0b01111111;
si5351_write(SI5351_CLK0_PHASE_OFFSET + (uint8_t)clk, phase);
}
/*
* get_correction(void)
*
* Returns the oscillator correction factor stored
* in RAM.
*/
int32_t si5351_get_correction(void)
{
return ref_correction;
}
/*
* 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)
{
if(target_pll == SI5351_PLLA)
{
si5351_write(SI5351_PLL_RESET, SI5351_PLL_RESET_A);
}
else if(target_pll == SI5351_PLLB)
{
si5351_write(SI5351_PLL_RESET, SI5351_PLL_RESET_B);
}
}
/*
* 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)
{
uint8_t reg_val;
reg_val = si5351_read(SI5351_CLK0_CTRL + (uint8_t)clk);
if(pll == SI5351_PLLA)
{
reg_val &= ~(SI5351_CLK_PLL_SELECT);
}
else if(pll == SI5351_PLLB)
{
reg_val |= SI5351_CLK_PLL_SELECT;
}
si5351_write(SI5351_CLK0_CTRL + (uint8_t)clk, reg_val);
}
/*
* 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)
{
uint8_t reg_val;
reg_val = si5351_read(SI5351_CLK0_CTRL + (uint8_t)clk);
if(enable == 1)
{
reg_val |= (SI5351_CLK_INTEGER_MODE);
}
else
{
reg_val &= ~(SI5351_CLK_INTEGER_MODE);
}
si5351_write(SI5351_CLK0_CTRL + (uint8_t)clk, reg_val);
// Integer mode indication
switch(clk)
{
case SI5351_CLK0:
clk0_int_mode = enable;
break;
case SI5351_CLK1:
clk1_int_mode = enable;
break;
case SI5351_CLK2:
clk2_int_mode = enable;
break;
default:
break;
}
}
/*
* 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)
{
uint8_t reg_val, reg;
reg_val = si5351_read(SI5351_CLK0_CTRL + (uint8_t)clk);
if(pwr == 1)
{
reg_val &= 0b01111111;
}
else
{
reg_val |= 0b10000000;
}
si5351_write(SI5351_CLK0_CTRL + (uint8_t)clk, reg_val);
}
/*
* 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)
{
uint8_t reg_val;
reg_val = si5351_read(SI5351_CLK0_CTRL + (uint8_t)clk);
if(inv == 1)
{
reg_val |= (SI5351_CLK_INVERT);
}
else
{
reg_val &= ~(SI5351_CLK_INVERT);
}
si5351_write(SI5351_CLK0_CTRL + (uint8_t)clk, reg_val);
}
/*
* 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)
{
uint8_t reg_val;
reg_val = si5351_read(SI5351_CLK0_CTRL + (uint8_t)clk);
// Clear the bits first
reg_val &= ~(SI5351_CLK_INPUT_MASK);
switch(src)
{
case SI5351_CLK_SRC_XTAL:
reg_val |= (SI5351_CLK_INPUT_XTAL);
break;
case SI5351_CLK_SRC_CLKIN:
reg_val |= (SI5351_CLK_INPUT_CLKIN);
break;
case SI5351_CLK_SRC_MS0:
if(clk == SI5351_CLK0)
{
return;
}
reg_val |= (SI5351_CLK_INPUT_MULTISYNTH_0_4);
break;
case SI5351_CLK_SRC_MS:
reg_val |= (SI5351_CLK_INPUT_MULTISYNTH_N);
break;
default:
return;
}
si5351_write(SI5351_CLK0_CTRL + (uint8_t)clk, reg_val);
}
/*
* 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)
{
uint8_t reg_val, reg;
if (clk >= SI5351_CLK0 && clk <= SI5351_CLK3)
{
reg = SI5351_CLK3_0_DISABLE_STATE;
}
else if (clk >= SI5351_CLK0 && clk <= SI5351_CLK3)
{
reg = SI5351_CLK7_4_DISABLE_STATE;
}
reg_val = si5351_read(reg);
if (clk >= SI5351_CLK0 && clk <= SI5351_CLK3)
{
reg_val &= ~(0b11 << (clk * 2));
reg_val |= dis_state << (clk * 2);
}
else if (clk >= SI5351_CLK0 && clk <= SI5351_CLK3)
{
reg_val &= ~(0b11 << ((clk - 4) * 2));
reg_val |= dis_state << ((clk - 4) * 2);
}
si5351_write(reg, reg_val);
}
/*
* 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)
{
uint8_t reg_val;
reg_val = si5351_read(SI5351_FANOUT_ENABLE);
switch(fanout)
{
case SI5351_FANOUT_CLKIN:
if(enable)
{
reg_val |= SI5351_CLKIN_ENABLE;
}
else
{
reg_val &= ~(SI5351_CLKIN_ENABLE);
}
break;
case SI5351_FANOUT_XO:
if(enable)
{
reg_val |= SI5351_XTAL_ENABLE;
}
else
{
reg_val &= ~(SI5351_XTAL_ENABLE);
}
break;
case SI5351_FANOUT_MS:
if(enable)
{
reg_val |= SI5351_MULTISYNTH_ENABLE;
}
else
{
reg_val &= ~(SI5351_MULTISYNTH_ENABLE);
}
break;
}
si5351_write(SI5351_FANOUT_ENABLE, reg_val);
}
uint8_t si5351_write_bulk(uint8_t addr, uint8_t bytes, uint8_t *data)
{
uint32_t res = HAL_I2C_Mem_Write(si5351_i2cport, SI5351_BUS_BASE_ADDR, addr, 1, data, bytes, 100);
led_blink(res);
/*
Wire.beginTransmission(SI5351_BUS_BASE_ADDR);
Wire.write(addr);
for(int i = 0; i < bytes; i++)
{
Wire.write(data[i]);
}
Wire.endTransmission();
*/
}
uint8_t si5351_write(uint8_t addr, uint8_t data)
{
uint8_t data_arr[1] = {data};
volatile uint8_t res = HAL_I2C_Mem_Write(si5351_i2cport, SI5351_BUS_BASE_ADDR, addr, 1, data_arr, 1, 100);
led_blink(res);
/*
Wire.beginTransmission(SI5351_BUS_BASE_ADDR);
Wire.write(addr);
Wire.write(data);
Wire.endTransmission();
*/
}
uint8_t si5351_read(uint8_t addr)
{
uint8_t data_arr[1] = {0};
uint8_t res = HAL_I2C_Mem_Read(si5351_i2cport, SI5351_BUS_BASE_ADDR, addr, 1, data_arr, 1, 100);
led_blink(res);
/*
Wire.beginTransmission(SI5351_BUS_BASE_ADDR);
Wire.write(addr);
Wire.endTransmission();
Wire.requestFrom(SI5351_BUS_BASE_ADDR, 1, false);
while(Wire.available())
{
reg_val = Wire.read();
}
*/
return data_arr[0];
}
/*********************/
/* Private functions */
/*********************/
uint64_t si5351_pll_calc(uint64_t freq, struct Si5351RegSet *reg, int32_t correction)
{
uint64_t ref_freq = xtal_freq * SI5351_FREQ_MULT;
uint32_t a, b, c, p1, p2, p3;
uint64_t lltmp, rfrac, denom;
int64_t ref_temp;
// Factor calibration value into nominal crystal frequency
// Measured in parts-per-billion
ref_freq = ref_freq + (int32_t)((((((int64_t)correction) << 31) / 1000000000LL) * ref_freq) >> 31);
// PLL bounds checking
if (freq < SI5351_PLL_VCO_MIN * SI5351_FREQ_MULT)
{
freq = SI5351_PLL_VCO_MIN * SI5351_FREQ_MULT;
}
if (freq > SI5351_PLL_VCO_MAX * SI5351_FREQ_MULT)
{
freq = SI5351_PLL_VCO_MAX * SI5351_FREQ_MULT;
}
// Determine integer part of feedback equation
a = freq / ref_freq;
if (a < SI5351_PLL_A_MIN)
{
freq = ref_freq * SI5351_PLL_A_MIN;
}
if (a > SI5351_PLL_A_MAX)
{
freq = ref_freq * SI5351_PLL_A_MAX;
}
// Find best approximation for b/c = fVCO mod fIN
denom = 1000ULL * 1000ULL;
lltmp = freq % ref_freq;
lltmp *= denom;
si5351_do_div(lltmp, ref_freq);
rfrac = lltmp;
b = (((uint64_t)(freq % ref_freq)) * RFRAC_DENOM) / ref_freq;
c = b ? RFRAC_DENOM : 1;
// Calculate parameters
p1 = 128 * a + ((128 * b) / c) - 512;
p2 = 128 * b - c * ((128 * b) / c);
p3 = c;
// Recalculate frequency as fIN * (a + b/c)
lltmp = ref_freq;
lltmp *= b;
si5351_do_div(lltmp, c);
freq = lltmp;
freq += ref_freq * a;
reg->p1 = p1;
reg->p2 = p2;
reg->p3 = p3;
return freq;
}
uint64_t si5351_multisynth_calc(uint64_t freq, uint64_t pll_freq, struct Si5351RegSet *reg)
{
uint64_t lltmp;
uint32_t a, b, c, p1, p2, p3;
uint8_t divby4;
uint8_t ret_val = 0;
// Multisynth bounds checking
if (freq > SI5351_MULTISYNTH_MAX_FREQ * SI5351_FREQ_MULT)
{
freq = SI5351_MULTISYNTH_MAX_FREQ * SI5351_FREQ_MULT;
}
if (freq < SI5351_MULTISYNTH_MIN_FREQ * SI5351_FREQ_MULT)
{
freq = SI5351_MULTISYNTH_MIN_FREQ * SI5351_FREQ_MULT;
}
divby4 = 0;
if (freq >= SI5351_MULTISYNTH_DIVBY4_FREQ * SI5351_FREQ_MULT)
{
divby4 = 1;
}
if(pll_freq == 0)
{
// Find largest integer divider for max
// VCO frequency and given target frequency
if(divby4 == 0)
{
lltmp = SI5351_PLL_VCO_MAX * SI5351_FREQ_MULT;
si5351_do_div(lltmp, freq);
a = (uint32_t)lltmp;
}
else
{
a = 4;
}
b = 0;
c = 1;
pll_freq = a * freq;
}
else
{
// Preset PLL, so return the actual freq for these params instead of PLL freq
ret_val = 1;
// Determine integer part of feedback equation
a = pll_freq / freq;
if (a < SI5351_MULTISYNTH_A_MIN)
{
freq = pll_freq / SI5351_MULTISYNTH_A_MIN;
}
if (a > SI5351_MULTISYNTH_A_MAX)
{
freq = pll_freq / SI5351_MULTISYNTH_A_MAX;
}
b = (pll_freq % freq * RFRAC_DENOM) / freq;
c = b ? RFRAC_DENOM : 1;
}
// Calculate parameters
if (divby4 == 1)
{
p3 = 1;
p2 = 0;
p1 = 0;
}
else
{
p1 = 128 * a + ((128 * b) / c) - 512;
p2 = 128 * b - c * ((128 * b) / c);
p3 = c;
}
reg->p1 = p1;
reg->p2 = p2;
reg->p3 = p3;
if(ret_val == 0)
{
return pll_freq;
}
else
{
return freq;
}
}
void si5351_update_sys_status(struct Si5351Status *status)
{
uint8_t reg_val = 0;
reg_val = si5351_read(SI5351_DEVICE_STATUS);
// Parse the register
status->SYS_INIT = (reg_val >> 7) & 0x01;
status->LOL_B = (reg_val >> 6) & 0x01;
status->LOL_A = (reg_val >> 5) & 0x01;
status->LOS = (reg_val >> 4) & 0x01;
status->REVID = reg_val & 0x03;
}
void si5351_update_int_status(struct Si5351IntStatus *int_status)
{
uint8_t reg_val = 0;
reg_val = si5351_read(SI5351_DEVICE_STATUS);
// Parse the register
int_status->SYS_INIT_STKY = (reg_val >> 7) & 0x01;
int_status->LOL_B_STKY = (reg_val >> 6) & 0x01;
int_status->LOL_A_STKY = (reg_val >> 5) & 0x01;
int_status->LOS_STKY = (reg_val >> 4) & 0x01;
}
void si5351_ms_div(enum si5351_clock clk, uint8_t r_div, uint8_t div_by_4)
{
uint8_t reg_val, reg_addr;
switch(clk)
{
case SI5351_CLK0:
reg_addr = SI5351_CLK0_PARAMETERS + 2;
break;
case SI5351_CLK1:
reg_addr = SI5351_CLK1_PARAMETERS + 2;
break;
case SI5351_CLK2:
reg_addr = SI5351_CLK2_PARAMETERS + 2;
break;
case SI5351_CLK3:
reg_addr = SI5351_CLK3_PARAMETERS + 2;
break;
case SI5351_CLK4:
reg_addr = SI5351_CLK4_PARAMETERS + 2;
break;
case SI5351_CLK5:
reg_addr = SI5351_CLK5_PARAMETERS + 2;
break;
case SI5351_CLK6:
return;
case SI5351_CLK7:
return;
}
reg_val = si5351_read(reg_addr);
// Clear the relevant bits
reg_val &= ~(0x7c);
if(div_by_4 == 0)
{
reg_val &= ~(SI5351_OUTPUT_CLK_DIVBY4);
}
else
{
reg_val |= (SI5351_OUTPUT_CLK_DIVBY4);
}
reg_val |= (r_div << SI5351_OUTPUT_CLK_DIV_SHIFT);
si5351_write(reg_addr, reg_val);
}
uint8_t si5351_select_r_div(uint64_t *freq)
{
uint8_t r_div = SI5351_OUTPUT_CLK_DIV_1;
// Choose the correct R divider
if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 2))
{
r_div = SI5351_OUTPUT_CLK_DIV_128;
*freq *= 128ULL;
}
else if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 2) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 4))
{
r_div = SI5351_OUTPUT_CLK_DIV_64;
*freq *= 64ULL;
}
else if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 4) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 8))
{
r_div = SI5351_OUTPUT_CLK_DIV_32;
*freq *= 32ULL;
}
else if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 8) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 16))
{
r_div = SI5351_OUTPUT_CLK_DIV_16;
*freq *= 16ULL;
}
else if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 16) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 32))
{
r_div = SI5351_OUTPUT_CLK_DIV_8;
*freq *= 8ULL;
}
else if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 32) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 64))
{
r_div = SI5351_OUTPUT_CLK_DIV_4;
*freq *= 4ULL;
}
else if((*freq >= SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 64) && (*freq < SI5351_CLKOUT_MIN_FREQ * SI5351_FREQ_MULT * 128))
{
r_div = SI5351_OUTPUT_CLK_DIV_2;
*freq *= 2ULL;
}
return r_div;
}
|