periph_clk_mux_gate.c

/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2021 Semihalf.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/param.h>
#include <sys/bus.h>
#include <sys/kernel.h>
#include <sys/module.h>
#include <sys/mutex.h>
#include <sys/rman.h>
#include <machine/bus.h>

#include <dev/fdt/simplebus.h>

#include <dev/clk/clk.h>
#include <dev/clk/clk_div.h>
#include <dev/clk/clk_fixed.h>
#include <dev/clk/clk_gate.h>
#include <dev/clk/clk_mux.h>

#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>

#include "clkdev_if.h"
#include "periph.h"

#define PARENT_CNT		2
#define TBG_A_S_OFW_INDEX	0

/*
 * Register chain: fixed (freq/2) -> mux (choose fixed or parent frequency) ->
 * gate (enable or disable clock).
 */

int
a37x0_periph_register_mux_gate(struct clkdom *clkdom,
    struct a37x0_periph_clknode_def *device_def)
{
	const char *parent_names[PARENT_CNT];
	struct clk_fixed_def fixed;
	struct clk_gate_def *gate;
	struct clk_mux_def *mux;
	int error, dev_id;

	dev_id = device_def->common_def.device_id;
	mux = &device_def->clk_def.mux_gate.mux;
	gate = &device_def->clk_def.mux_gate.gate;
	fixed = device_def->clk_def.fixed.fixed;

	fixed.clkdef.id = A37x0_INTERNAL_CLK_ID(dev_id, FIXED1_POS);
	fixed.clkdef.parent_names = &device_def->common_def.pname;
	fixed.clkdef.parent_cnt = 1;
	fixed.clkdef.flags = 0x0;
	fixed.mult = 1;
	fixed.div = 2;
	fixed.freq = 0;

	error = clknode_fixed_register(clkdom, &fixed);
	if (error)
		goto fail;

	parent_names[0] = device_def->common_def.pname;
	parent_names[1] = fixed.clkdef.name;

	a37x0_periph_set_props(&mux->clkdef, parent_names, PARENT_CNT);
	error = a37x0_periph_create_mux(clkdom, mux,
	    A37x0_INTERNAL_CLK_ID(dev_id, MUX_POS));
	if (error)
		goto fail;

	a37x0_periph_set_props(&gate->clkdef, &mux->clkdef.name, 1);
	error = a37x0_periph_create_gate(clkdom, gate,
	    dev_id);
	if (error)
		goto fail;

fail:

	return (error);
}

/*
 * Register chain: fixed1 (freq/2) -> mux (fixed1 or TBG-A-S frequency) ->
 * gate -> fixed2 (freq/2).
 */

int
a37x0_periph_register_mux_gate_fixed(struct clkdom * clkdom,
    struct a37x0_periph_clknode_def *device_def)
{
	struct clk_fixed_def *fixed1, *fixed2;
	const char *parent_names[PARENT_CNT];
	struct clk_gate_def *gate;
	struct clk_mux_def *mux;
	int error, dev_id;

	dev_id = device_def->common_def.device_id;
	mux = &device_def->clk_def.mux_gate_fixed.mux;
	gate = &device_def->clk_def.mux_gate_fixed.gate;
	fixed1 = &device_def->clk_def.mux_gate_fixed.fixed1;
	fixed2 = &device_def->clk_def.mux_gate_fixed.fixed2;

	fixed1->clkdef.parent_names = &device_def->common_def.pname;
	fixed1->clkdef.id = A37x0_INTERNAL_CLK_ID(dev_id, FIXED1_POS);
	fixed1->clkdef.flags = 0x0;
	fixed1->mult = 1;
	fixed1->div = 2;
	fixed1->freq = 0;

	error = clknode_fixed_register(clkdom, fixed1);
	if (error)
		goto fail;

	parent_names[0] = device_def->common_def.tbgs[TBG_A_S_OFW_INDEX];
	parent_names[1] = fixed1->clkdef.name;

	a37x0_periph_set_props(&mux->clkdef, parent_names, PARENT_CNT);
	error = a37x0_periph_create_mux(clkdom, mux,
	    A37x0_INTERNAL_CLK_ID(dev_id, MUX_POS));
	if (error)
		goto fail;

	a37x0_periph_set_props(&gate->clkdef, &mux->clkdef.name, 1);
	error = a37x0_periph_create_gate(clkdom, gate,
	    A37x0_INTERNAL_CLK_ID(dev_id, GATE_POS));
	if (error)
		goto fail;

	fixed2->clkdef.parent_names = &gate->clkdef.name;
	fixed2->clkdef.parent_cnt = 1;
	fixed2->clkdef.id = dev_id;

	error = clknode_fixed_register(clkdom, fixed2);
	if (error)
		goto fail;

fail:

	return (error);
}