xref: /freebsd/sys/arm/arm/platform_pl310_if.m (revision d93a896e)
1#-
2# Copyright (c) 2017 Andrew Turner
3# All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26# $FreeBSD$
27#
28
29#include <sys/bus.h>
30#include <sys/lock.h>
31#include <sys/mutex.h>
32#include <sys/rman.h>
33
34#include <machine/bus.h>
35#include <machine/pl310.h>
36#include <machine/platformvar.h>
37
38INTERFACE platform_pl310;
39
40HEADER {
41	struct pl310_softc;
42};
43
44CODE {
45	static void platform_pl310_default_write_ctrl(platform_t plat,
46	    struct pl310_softc *sc, uint32_t val)
47	{
48		pl310_write4(sc, PL310_CTRL, val);
49	}
50
51	static void platform_pl310_default_write_debug(platform_t plat,
52	    struct pl310_softc *sc, uint32_t val)
53	{
54		pl310_write4(sc, PL310_DEBUG_CTRL, val);
55	}
56};
57
58/**
59 * Initialize the pl310, e.g. to configure the prefetch control. The following
60 * write functions may have already been called so they must not rely on
61 * this function.
62 */
63METHOD void init {
64	platform_t	_plat;
65	struct pl310_softc *sc;
66};
67
68/**
69 * Write to the Control Register.
70 */
71METHOD void write_ctrl {
72	platform_t	_plat;
73	struct pl310_softc *sc;
74	uint32_t	val;
75} DEFAULT platform_pl310_default_write_ctrl;
76
77/**
78 * Write to the Debug Control Register.
79 */
80METHOD void write_debug {
81	platform_t	_plat;
82	struct pl310_softc *sc;
83	uint32_t	val;
84} DEFAULT platform_pl310_default_write_debug;
85