diff options
Diffstat (limited to 'firmware/si5351c.h')
| -rw-r--r-- | firmware/si5351c.h | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/firmware/si5351c.h b/firmware/si5351c.h new file mode 100644 index 0000000..533c583 --- /dev/null +++ b/firmware/si5351c.h @@ -0,0 +1,98 @@ +/* + * Copyright 2012 Michael Ossmann <mike@ossmann.com> + * Copyright 2012 Jared Boone <jared@sharebrained.com> + * + * This file is part of HackRF. + * + * 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 2, 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; see the file COPYING. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, + * Boston, MA 02110-1301, USA. + */ + +#ifndef __SI5351C_H +#define __SI5351C_H + +#ifdef __cplusplus +extern "C" +{ +#endif + +#include <stdint.h> + +#include "i2c_bus.h" + +#define SI_INTDIV(x) (x*128-512) + +#define SI5351C_CLK_POWERDOWN (1<<7) +#define SI5351C_CLK_INT_MODE (1<<6) +#define SI5351C_CLK_FRAC_MODE (0<<6) + +#define SI5351C_CLK_PLL_SRC(x) (x<<5) +#define SI5351C_CLK_PLL_SRC_A 0 +#define SI5351C_CLK_PLL_SRC_B 1 + +#define SI5351C_CLK_INV (1<<4) + +#define SI5351C_CLK_SRC(x) (x<<2) +#define SI5351C_CLK_SRC_XTAL 0 +#define SI5351C_CLK_SRC_CLKIN 1 +#define SI5351C_CLK_SRC_MULTISYNTH_0_4 2 +#define SI5351C_CLK_SRC_MULTISYNTH_SELF 3 + +#define SI5351C_CLK_IDRV(x) (x<<0) +#define SI5351C_CLK_IDRV_2MA 0 +#define SI5351C_CLK_IDRV_4MA 1 +#define SI5351C_CLK_IDRV_6MA 2 +#define SI5351C_CLK_IDRV_8MA 3 + +#define SI5351C_LOS (1<<4) + +enum pll_sources { + PLL_SOURCE_XTAL = 0, + PLL_SOURCE_CLKIN = 1, +}; + +typedef struct { + i2c_bus_t* const bus; + uint8_t i2c_address; +} si5351c_driver_t; + +void si5351c_disable_all_outputs(si5351c_driver_t* const drv); +void si5351c_disable_oeb_pin_control(si5351c_driver_t* const drv); +void si5351c_power_down_all_clocks(si5351c_driver_t* const drv); +void si5351c_set_crystal_configuration(si5351c_driver_t* const drv); +void si5351c_enable_xo_and_ms_fanout(si5351c_driver_t* const drv); +void si5351c_configure_pll_sources(si5351c_driver_t* const drv); +void si5351c_configure_pll_multisynth(si5351c_driver_t* const drv); +void si5351c_reset_pll(si5351c_driver_t* const drv); +void si5351c_configure_multisynth(si5351c_driver_t* const drv, + const uint_fast8_t ms_number, + const uint32_t p1, const uint32_t p2, const uint32_t p3, + const uint_fast8_t r_div); +void si5351c_configure_clock_control(si5351c_driver_t* const drv, const enum pll_sources source); +void si5351c_enable_clock_outputs(si5351c_driver_t* const drv); +void si5351c_set_int_mode(si5351c_driver_t* const drv, const uint_fast8_t ms_number, const uint_fast8_t on); +void si5351c_set_clock_source(si5351c_driver_t* const drv, const enum pll_sources source); +void si5351c_activate_best_clock_source(si5351c_driver_t* const drv); + +void si5351c_write_single(si5351c_driver_t* const drv, uint8_t reg, uint8_t val); +uint8_t si5351c_read_single(si5351c_driver_t* const drv, uint8_t reg); +void si5351c_write(si5351c_driver_t* const drv, const uint8_t* const data, const size_t data_count); +void si5351c_clkout_enable(si5351c_driver_t* const drv, uint8_t enable); + +#ifdef __cplusplus +} +#endif + +#endif /* __SI5351C_H */ |