universal_drivers/si5351_driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a01bd85b6fc4faee724427b3d27d1ffcdfa63d23
si5351_driver/si5351_driver.h

307 lines
8.1 KiB
C
Raw Blame History

/*
* si5351_driver.h
*
* Created on: 16. aug. 2024
* Author: Christian L. V. Madsen (OZ1CM)
*/
#ifndef SI5351_DRIVER_INCLUDE_SI5351_DRIVER_H_
#define SI5351_DRIVER_INCLUDE_SI5351_DRIVER_H_
#include "stdio.h"
#include "stdint.h"
typedef enum {
SI5351_DRIVE_STRENGTH_2MA = 0,
SI5351_DRIVE_STRENGTH_4MA = 1,
SI5351_DRIVE_STRENGTH_6MA = 2,
SI5351_DRIVE_STRENGTH_8MA = 3,
}si5351_DriveStrengthControl;
typedef enum {
SI5351_DIS_STATE_LOW = 0,
SI5351_DIS_STATE_HIGH = 1,
SI5351_DIS_STATE_HIGH_IMPEDANCE = 2,
SI5351_DIS_STATE_NEVER_DISABLED = 3,
}si5351_CLK_Disable_State;
typedef enum {
SI5351_OUTPUT_DIVBY_1 = 0,
SI5351_OUTPUT_DIVBY_2 = 1,
SI5351_OUTPUT_DIVBY_4 = 2,
SI5351_OUTPUT_DIVBY_8 = 3,
SI5351_OUTPUT_DIVBY_16 = 4,
SI5351_OUTPUT_DIVBY_32 = 5,
SI5351_OUTPUT_DIVBY_64 = 6,
SI5351_OUTPUT_DIVBY_128 = 7,
}si5351_OutputDivide;
typedef enum {
SI5351_CLK_SOURCE_XTAL = 0,
SI5351_CLK_SOURCE_CLOCKSOURCE = 1,
}si5351_ClkSource;
typedef enum {
SI5351_CRYSTAL_LOAD_6PF = (1 << 6),
SI5351_CRYSTAL_LOAD_8PF = (2 << 6),
SI5351_CRYSTAL_LOAD_10PF = (3 << 6)
}si5351_Xtal_Cload;
typedef enum {
SI5351_PLL_A = 0,
SI5351_PLL_B = 1,
}si5351_PLLs;
typedef enum {
SI5351_OUTPUT_0 = 0,
SI5351_OUTPUT_1 = 1,
SI5351_OUTPUT_2 = 2,
SI5351_OUTPUT_3 = 3,
SI5351_OUTPUT_4 = 4,
SI5351_OUTPUT_5 = 5,
SI5351_OUTPUT_6 = 6,
SI5351_OUTPUT_7 = 7,
}si5351_Outputs;
typedef enum {
SI5351_OUTPUT_ENABLE = 0,
SI5351_OUTPUT_DISABLE = 1,
}si5351_Outputs_state;
typedef enum {
SI5351_CLK_POWER_UP = 0,
SI5351_CLK_POWER_DWN = 1,
}si5351_CLK_PDN;
typedef enum {
SI5351_REG_OUTPUT_ENABLE_CONTROL = 3,
SI5351_REG_PLL_INPUT_SOURCE = 0xf0, // Reg 15
SI5351_REG_CLK_0_CONTROL = 16,
SI5351_REG_CLK_1_CONTROL = 17,
SI5351_REG_CLK_2_CONTROL = 18,
SI5351_REG_CLK_3_CONTROL = 19,
SI5351_REG_CLK_4_CONTROL = 20,
SI5351_REG_CLK_5_CONTROL = 21,
SI5351_REG_CLK_6_CONTROL = 22,
SI5351_REG_CLK_7_CONTROL = 23,
SI5351_REG_MULTISYNTH_NA_0 = 26,
SI5351_REG_MULTISYNTH_NB_0 = 34,
SI5351_REG_MULTISYNTH_OUT_0 = 42,
SI5351_REG_MULTISYNTH_OUT_1 = 50,
SI5351_REG_MULTISYNTH_OUT_2 = 58,
SI5351_REG_PLL_RESET = 177,
SI5351_REG_CRYSTAL_LOAD_CAPACITANCE = 183,
SI5351_REG_FANOUT_ENABLE = 187,
}si5351_Registers;
typedef int (*setGet_I2C_Event_fpt)(void *inst, uint8_t *data, uint32_t len, uint8_t set_get);
typedef struct{
uint8_t REVID : 2; // Revision number of the device.
uint8_t RESERVED : 1;
uint8_t LOS_XTAL : 1; // Crystal Loss of Signal
uint8_t LOS_CLKIN : 1; // CLKIN Loss Of Signal (Si5351C Only).
uint8_t LOL_B : 1; // PLL A Loss Of Lock Status.
uint8_t LOL_A : 1; // PLLB Loss Of Lock Status.
uint8_t SYS_INIT : 1; // System Initialization Status
}__attribute__((packed)) si5351_deviceStat_t;
typedef struct{
uint8_t RESERVED : 3;
uint8_t LOS_XTAL_STKY : 1; // Crystal Loss of Signal Sticky Bit.
uint8_t LOS_CLKIN_STKY : 1; // CLKIN Loss Of Signal (Si5351C Only) Sticky Bit.
uint8_t LOL_A_STKY : 1; // PLLB Loss Of Lock Status Sticky Bit
uint8_t LOL_B_STKY : 1; // PLL A Loss Of Lock Status Sticky Bit.
uint8_t SYS_INIT_STKY : 1; // System Calibration Status Sticky Bit
}__attribute__((packed)) si5351_interruptStatusSticky_t;
typedef struct{
uint8_t RESERVED : 3;
uint8_t LOS_XTAL_MASK : 1; // Crystal Loss of Signal Sticky Bit.
uint8_t LOS_CLKIN_MASK : 1; // CLKIN Loss Of Signal (Si5351C Only) Sticky Bit.
uint8_t LOL_A_MASK : 1; // PLLB Loss Of Lock Status Sticky Bit
uint8_t LOL_B_MASK : 1; // PLL A Loss Of Lock Status Sticky Bit.
uint8_t SYS_INIT_MASK : 1; // System Calibration Status Sticky Bit
}__attribute__((packed)) si5351_interruptStatusMask_t;
typedef struct{
uint8_t CLK0_OEB : 1;
uint8_t CLK1_OEB : 1;
uint8_t CLK2_OEB : 1;
uint8_t CLK3_OEB : 1;
uint8_t CLK4_OEB : 1;
uint8_t CLK5_OEB : 1;
uint8_t CLK6_OEB : 1;
uint8_t CLK7_OEB : 1;
}__attribute__((packed)) si5351_outputEnableControl_t;
typedef struct{
uint8_t CLK0_OEB_MSK : 1;
uint8_t CLK1_OEB_MSK : 1;
uint8_t CLK2_OEB_MSK : 1;
uint8_t CLK3_OEB_MSK : 1;
uint8_t CLK4_OEB_MSK : 1;
uint8_t CLK5_OEB_MSK : 1;
uint8_t CLK6_OEB_MSK : 1;
uint8_t CLK7_OEB_MSK : 1;
}__attribute__((packed)) si5351_outputEnableControlMask_t;
typedef struct{
uint8_t RESERVED_0 : 2;
uint8_t PLLA_SRC : 1; // Input Source Select for PLLA.
uint8_t PLLB_SRC : 1; // Input Source Select for PLLB.
uint8_t RESERVED_1 : 2;
uint8_t CLKIN_DIV : 2; // ClKIN Input Divider
}__attribute__((packed)) si5351_PLLInputSource_t;
typedef struct{
si5351_DriveStrengthControl CLK_IDRV : 2; // CLK0 Output Rise and Fall time / Drive Strength Control
uint8_t CLK_SRC : 2; // Output Clock x Input Source.
uint8_t CLK_INV : 1; // Output Clock x Invert.
uint8_t MSx_SRC : 1; // MultiSynth Source Select for CLK0.
uint8_t MSx_INT : 1; // MultiSynth x Integer Mode
uint8_t CLK_PDN: 1; // Clock x Power Down.
}__attribute__((packed)) si5351_CLK_Control_t;
typedef struct{
si5351_CLK_Disable_State CLK0_DIS_STATE : 2;
si5351_CLK_Disable_State CLK1_DIS_STATE : 2;
si5351_CLK_Disable_State CLK2_DIS_STATE : 2;
si5351_CLK_Disable_State CLK3_DIS_STATE : 2; // Clock x Disable State
}__attribute__((packed)) si5351_CLK_Dis_Control_t;
typedef struct{
uint8_t MSNx_P3_15_8; // register 26 & 34
uint8_t MSNx_P3_7_0; // 27 & 35
uint8_t MSNx_P1_17_16 : 2; // (first) 28 & 36
uint8_t Reserved : 6; // (rest of) 28 & 36
uint8_t MSNx_P1_15_8; // 29 & 37
uint8_t MSNx_P1_7_0; // 30 & 38
uint8_t MSNx_P2_19_16 : 4; // (first) 31 & 39
uint8_t MSNx_P3_19_16 : 4; // (rest of) 31 & 40
uint8_t MSNx_P2_15_8; // 32 & 41
uint8_t MSNx_P2_7_0; // 33 & 41
}__attribute__((packed)) si5351_multiSynthNxParameters_t;
typedef struct{
uint8_t MSx_P3_15_8; // register 42
uint8_t MSx_P3_7_0; // 43
uint8_t MSx_P1_17_16 : 2; // (first) 44
uint8_t MSx_DIVBY4 : 2; // (rest of) 44
si5351_OutputDivide Rx_DIV : 3; // (rest of) 44
uint8_t Reserved_0 : 1;
uint8_t MSx_P1_15_8; // 46
uint8_t MSx_P1_7_0; // 30
uint8_t MSx_P2_19_16 : 4; // (first) 31
uint8_t MSx_P3_19_16 : 4; // (rest of) 31
uint8_t MSx_P2_15_8; // 32
uint8_t MSx_P2_7_0; // 33
}__attribute__((packed)) si5351_multiSynthxParameters_t;
typedef struct {
uint8_t MSx_P1;
} __attribute__((packed))si5351_multiSynth67Parameters_t;
typedef struct {
uint8_t Reserved_0 : 5;
uint8_t PLLA_RST : 1;
uint8_t Reserved_1 : 1;
uint8_t PLLB_RST : 1;
} __attribute__((packed))si5351_PLL_Reset_t;
typedef struct{
si5351_deviceStat_t deviceStatus; // 0x00
si5351_interruptStatusSticky_t ISR_StatusSticky; // 0x01
si5351_interruptStatusMask_t ISR_StatusMask; // 0x02
si5351_outputEnableControl_t outputEnableControl; // 0x03
si5351_outputEnableControlMask_t outputEnableControlMask; // 0x09
si5351_PLLInputSource_t pllInputSource; // 0x0F
si5351_CLK_Control_t CLKx_control; // 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17
si5351_CLK_Dis_Control_t clk_DisableState;
si5351_multiSynthNxParameters_t multiSynthNxParam;
si5351_multiSynthxParameters_t multiSynthxParam;
si5351_multiSynth67Parameters_t multiSynth67Param;
si5351_OutputDivide Rx_DIV : 3; // R6 & R7
si5351_PLL_Reset_t PLL_Reset;
}__attribute__((packed)) si5351_data;
typedef struct{
void *i2c_transfer_inst;
setGet_I2C_Event_fpt i2c_transfer_evt;
si5351_data device_data;
}__attribute__((packed)) si5351_driver;
int cm_si5351_init(si5351_driver *inst, void *i2c_transfer_inst, setGet_I2C_Event_fpt i2c_transfer_evt);
uint8_t cm_si5351_getRevisionNumber(si5351_driver *inst);
int cm_setInputSource(si5351_driver *inst, si5351_ClkSource clk_source);
int cm_setPLLParameters(si5351_driver *inst,si5351_PLLs sel_pll, uint32_t a, uint32_t b, uint32_t c);
int cm_setOutputMultiSynth(si5351_driver *inst,si5351_Outputs clk_output, uint32_t d, uint32_t e, uint32_t f);
int cm_setOutputMultiSynthRaw(si5351_driver *inst,si5351_Outputs clk_output, uint32_t MSx_P1, uint32_t MSx_P2, uint32_t MSx_P3);
int cm_setOutputEnable(si5351_driver *inst,si5351_Outputs clk_output, si5351_Outputs_state outputState);
int cm_setCLKControl(si5351_driver *inst, si5351_Outputs clk_output, si5351_CLK_PDN clk_pdn);
int cm_resetPLLs(si5351_driver *inst, uint8_t reset_PLLA, uint8_t reset_PLLB);
int cm_setPllParamRaw(si5351_driver *inst, si5351_PLLs sel_pll, uint32_t MSNx_P1, uint32_t MSNx_P2, uint32_t MSNx_P3);
#endif /* SI5351_DRIVER_INCLUDE_SI5351_DRIVER_H_ */
Reference in New Issue View Git Blame Copy Permalink