clk: clk-si5341: Add support for the Si5345 series

Binding for Silicon Labs Si5341 and Si5340 programmable i2c clock generator.

Binding for Silicon Labs Si5340, Si5341 Si5342, Si5344 and Si5345 programmable

i2c clock generator.

Reference

[1] Si5341 Data Sheet

    https://www.silabs.com/documents/public/data-sheets/Si5341-40-D-DataSheet.pdf

[2] Si5341 Reference Manual

    https://www.silabs.com/documents/public/reference-manuals/Si5341-40-D-RM.pdf

[3] Si5345 Reference Manual

    https://www.silabs.com/documents/public/reference-manuals/Si5345-44-42-D-RM.pdf

The Si5341 and Si5340 are programmable i2c clock generators with up to 10 output

clocks. The chip contains a PLL that sources 5 (or 4) multisynth clocks, which

in turn can be directed to any of the 10 (or 4) outputs through a divider.

The internal structure of the clock generators can be found in [2].

The Si5345 is similar to the Si5341 with the addition of fractional input

dividers and automatic input selection, as described in [3].

The Si5342 and Si5344 are smaller versions of the Si5345, with 2 or 4 outputs.

The driver can be used in "as is" mode, reading the current settings from the

chip at boot, in case you have a (pre-)programmed device. If the PLL is not

- compatible: shall be one of the following:

	"silabs,si5340" - Si5340 A/B/C/D

	"silabs,si5341" - Si5341 A/B/C/D

	"silabs,si5342" - Si5342 A/B/C/D

	"silabs,si5344" - Si5344 A/B/C/D

	"silabs,si5345" - Si5345 A/B/C/D

- reg: i2c device address, usually 0x74

- #clock-cells: from common clock binding; shall be set to 2.

	The first value is "0" for outputs, "1" for synthesizers.

// SPDX-License-Identifier: GPL-2.0

/*

 * Driver for Silicon Labs Si5341/Si5340 Clock generator

 * Driver for Silicon Labs Si5340, Si5341, Si5342, Si5344 and Si5345

 * Copyright (C) 2019 Topic Embedded Products

 * Author: Mike Looijmans <mike.looijmans@topic.nl>

 *

 * The Si5341 has 10 outputs and 5 synthesizers.

 * The Si5340 is a smaller version of the Si5341 with only 4 outputs.

 * The Si5345 is similar to the Si5341, with the addition of fractional input

 * dividers and automatic input selection.

 * The Si5342 and Si5344 are smaller versions of the Si5345.

 */

#include <linux/clk.h>

#define SI5341_NUM_INPUTS 4

#define SI5341_MAX_NUM_OUTPUTS 10

#define SI5340_MAX_NUM_OUTPUTS 4

#define SI5341_MAX_NUM_OUTPUTS 10

#define SI5342_MAX_NUM_OUTPUTS 2

#define SI5344_MAX_NUM_OUTPUTS 4

#define SI5345_MAX_NUM_OUTPUTS 10

#define SI5341_NUM_SYNTH 5

#define SI5340_NUM_SYNTH 4

#define SI5341_NUM_SYNTH 5

#define SI5342_NUM_SYNTH 2

#define SI5344_NUM_SYNTH 4

#define SI5345_NUM_SYNTH 5

/* Range of the synthesizer fractional divider */

#define SI5341_SYNTH_N_MIN	10

	u64 freq_vco; /* 13500–14256 MHz */

	u8 num_outputs;

	u8 num_synth;

	u16 chip_id;

};

#define to_clk_si5341(_hw)	container_of(_hw, struct clk_si5341, hw)

};

/* Output configuration registers 0..9 are not quite logically organized */

/* Also for si5345 */

static const u16 si5341_reg_output_offset[] = {

	0x0108,

	0x010D,

	0x013A,

};

/* for si5340, si5342 and si5344 */

static const u16 si5340_reg_output_offset[] = {

	0x0112,

	0x0117,

		data->reg_output_offset = si5341_reg_output_offset;

		data->reg_rdiv_offset = si5341_reg_rdiv_offset;

		break;

	case 0x5342:

		data->num_outputs = SI5342_MAX_NUM_OUTPUTS;

		data->num_synth = SI5342_NUM_SYNTH;

		data->reg_output_offset = si5340_reg_output_offset;

		data->reg_rdiv_offset = si5340_reg_rdiv_offset;

		break;

	case 0x5344:

		data->num_outputs = SI5344_MAX_NUM_OUTPUTS;

		data->num_synth = SI5344_NUM_SYNTH;

		data->reg_output_offset = si5340_reg_output_offset;

		data->reg_rdiv_offset = si5340_reg_rdiv_offset;

		break;

	case 0x5345:

		data->num_outputs = SI5345_MAX_NUM_OUTPUTS;

		data->num_synth = SI5345_NUM_SYNTH;

		data->reg_output_offset = si5341_reg_output_offset;

		data->reg_rdiv_offset = si5341_reg_rdiv_offset;

		break;

	default:

		dev_err(&data->i2c_client->dev, "Model '%x' not supported\n",

			model);

		return -EINVAL;

	}

	data->chip_id = model;

	return 0;

}

	{ 0x0B4E, 0x1A },

};

static const struct si5341_reg_default si5345_preamble[] = {

	{ 0x0B25, 0x00 },

	{ 0x0540, 0x01 },

};

static int si5341_send_preamble(struct clk_si5341 *data)

{

	int res;

	res = regmap_write(data->regmap, 0xB24, revision < 2 ? 0xD8 : 0xC0);

	if (res < 0)

		return res;

	/* The si5342..si5345 require a different preamble */

	if (data->chip_id > 0x5341)

		res = si5341_write_multiple(data,

			si5345_preamble, ARRAY_SIZE(si5345_preamble));

	else

		res = si5341_write_multiple(data,

			si5341_preamble, ARRAY_SIZE(si5341_preamble));

	if (res < 0)

	if (res < 0)

		return res;

	/* The si5342..si5345 have an additional post-amble */

	if (data->chip_id > 0x5341) {

		res = regmap_write(data->regmap, 0x540, 0x0);

		if (res < 0)

			return res;

	}

	/* Datasheet does not explain these nameless registers */

	res = regmap_write(data->regmap, 0xB24, revision < 2 ? 0xDB : 0xC3);

	if (res < 0)

static const struct i2c_device_id si5341_id[] = {

	{ "si5340", 0 },

	{ "si5341", 1 },

	{ "si5342", 2 },

	{ "si5344", 4 },

	{ "si5345", 5 },

	{ }

};

MODULE_DEVICE_TABLE(i2c, si5341_id);

static const struct of_device_id clk_si5341_of_match[] = {

	{ .compatible = "silabs,si5340" },

	{ .compatible = "silabs,si5341" },

	{ .compatible = "silabs,si5342" },

	{ .compatible = "silabs,si5344" },

	{ .compatible = "silabs,si5345" },

	{ }

};

MODULE_DEVICE_TABLE(of, clk_si5341_of_match);