xref: /optee_os/core/drivers/clk/sam/at91_peripheral.c (revision 5e6f824b0640ede149e5a4353b0ab47a7297fd18)

// SPDX-License-Identifier: GPL-2.0+ or BSD-3-Clause
/*
 *  Copyright (C) 2013 Boris BREZILLON <b.brezillon@overkiz.com>
 *  Copyright (C) 2021 Microchip
 */

#include <io.h>
#include <kernel/delay.h>
#include <kernel/panic.h>
#include <mm/core_memprot.h>
#include <types_ext.h>

#include "at91_clk.h"

#define PERIPHERAL_ID_MIN	2
#define PERIPHERAL_ID_MASK	31
#define PERIPHERAL_MASK(id)	BIT((id) & PERIPHERAL_ID_MASK)

#define PERIPHERAL_MAX_SHIFT	3

struct clk_sam9x5_peripheral {
	vaddr_t base;
	struct clk_range range;
	uint32_t id;
	uint32_t div;
	const struct clk_pcr_layout *layout;
	bool auto_div;
};

static void clk_sam9x5_peripheral_autodiv(struct clk *clk)
{
	struct clk *parent = NULL;
	struct clk_sam9x5_peripheral *periph = clk->priv;
	unsigned long parent_rate = 0;
	int shift = 0;

	if (!periph->auto_div)
		return;

	if (periph->range.max) {
		parent = clk_get_parent_by_index(clk, 0);
		parent_rate = clk_get_rate(parent);
		if (!parent_rate)
			return;

		for (shift = 0; shift < PERIPHERAL_MAX_SHIFT; shift++) {
			if (parent_rate >> shift <= periph->range.max)
				break;
		}
	}

	periph->auto_div = false;
	periph->div = shift;
}

static TEE_Result clk_sam9x5_peripheral_enable(struct clk *clk)
{
	struct clk_sam9x5_peripheral *periph = clk->priv;

	if (periph->id < PERIPHERAL_ID_MIN)
		return TEE_SUCCESS;

	io_write32(periph->base + periph->layout->offset,
		   (periph->id & periph->layout->pid_mask));
	io_clrsetbits32(periph->base + periph->layout->offset,
			periph->layout->div_mask | periph->layout->cmd |
			AT91_PMC_PCR_EN,
			field_prep(periph->layout->div_mask, periph->div) |
			periph->layout->cmd |
			AT91_PMC_PCR_EN);

	return TEE_SUCCESS;
}

static void clk_sam9x5_peripheral_disable(struct clk *clk)
{
	struct clk_sam9x5_peripheral *periph = clk->priv;

	if (periph->id < PERIPHERAL_ID_MIN)
		return;

	io_write32(periph->base + periph->layout->offset,
		   (periph->id & periph->layout->pid_mask));
	io_clrsetbits32(periph->base + periph->layout->offset,
			AT91_PMC_PCR_EN | periph->layout->cmd,
			periph->layout->cmd);
}

static unsigned long
clk_sam9x5_peripheral_get_rate(struct clk *clk,
			       unsigned long parent_rate)
{
	struct clk_sam9x5_peripheral *periph = clk->priv;
	uint32_t status = 0;

	if (periph->id < PERIPHERAL_ID_MIN)
		return parent_rate;

	io_write32(periph->base + periph->layout->offset,
		   periph->id & periph->layout->pid_mask);
	status = io_read32(periph->base + periph->layout->offset);

	if (status & AT91_PMC_PCR_EN) {
		periph->div = field_get(periph->layout->div_mask, status);
		periph->auto_div = false;
	} else {
		clk_sam9x5_peripheral_autodiv(clk);
	}

	return parent_rate >> periph->div;
}

static TEE_Result clk_sam9x5_peripheral_set_rate(struct clk *clk,
						 unsigned long rate,
						 unsigned long parent_rate)
{
	unsigned int shift = 0;
	struct clk_sam9x5_peripheral *periph = clk->priv;

	if (periph->id < PERIPHERAL_ID_MIN || !periph->range.max) {
		if (parent_rate == rate)
			return TEE_SUCCESS;
		else
			return TEE_ERROR_GENERIC;
	}

	if (periph->range.max && rate > periph->range.max)
		return TEE_ERROR_GENERIC;

	for (shift = 0; shift <= PERIPHERAL_MAX_SHIFT; shift++) {
		if (parent_rate >> shift == rate) {
			periph->auto_div = false;
			periph->div = shift;
			return TEE_SUCCESS;
		}
	}

	return TEE_ERROR_GENERIC;
}

static const struct clk_ops sam9x5_peripheral_ops = {
	.enable = clk_sam9x5_peripheral_enable,
	.disable = clk_sam9x5_peripheral_disable,
	.get_rate = clk_sam9x5_peripheral_get_rate,
	.set_rate = clk_sam9x5_peripheral_set_rate,
};

struct clk *
at91_clk_register_sam9x5_periph(struct pmc_data *pmc,
				const struct clk_pcr_layout *layout,
				const char *name, struct clk *parent,
				uint32_t id, const struct clk_range *range)
{
	struct clk_sam9x5_peripheral *periph = NULL;
	struct clk *clk = NULL;

	if (!name || !parent)
		return NULL;

	clk = clk_alloc(name, &sam9x5_peripheral_ops, &parent, 1);
	if (!clk)
		return NULL;

	periph = calloc(1, sizeof(*periph));
	if (!periph) {
		clk_free(clk);
		return NULL;
	}

	periph->id = id;
	periph->div = 0;
	periph->base = pmc->base;
	if (layout->div_mask)
		periph->auto_div = true;
	periph->layout = layout;
	periph->range = *range;

	clk->priv = periph;

	if (clk_register(clk)) {
		clk_free(clk);
		free(periph);
		return 0;
	}

	clk_sam9x5_peripheral_autodiv(clk);
	pmc_register_id(id);

	return clk;
}