xref: /freebsd/sys/arm/arm/platform_pl310_if.m (revision e0c4386e)
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#
27
28#include <sys/bus.h>
29#include <sys/lock.h>
30#include <sys/mutex.h>
31#include <sys/rman.h>
32
33#include <machine/bus.h>
34#include <machine/pl310.h>
35#include <machine/platformvar.h>
36
37INTERFACE platform_pl310;
38
39HEADER {
40	struct pl310_softc;
41};
42
43CODE {
44	static void platform_pl310_default_write_ctrl(platform_t plat,
45	    struct pl310_softc *sc, uint32_t val)
46	{
47		pl310_write4(sc, PL310_CTRL, val);
48	}
49
50	static void platform_pl310_default_write_debug(platform_t plat,
51	    struct pl310_softc *sc, uint32_t val)
52	{
53		pl310_write4(sc, PL310_DEBUG_CTRL, val);
54	}
55};
56
57/**
58 * Initialize the pl310, e.g. to configure the prefetch control. The following
59 * write functions may have already been called so they must not rely on
60 * this function.
61 */
62METHOD void init {
63	platform_t	_plat;
64	struct pl310_softc *sc;
65};
66
67/**
68 * Write to the Control Register.
69 */
70METHOD void write_ctrl {
71	platform_t	_plat;
72	struct pl310_softc *sc;
73	uint32_t	val;
74} DEFAULT platform_pl310_default_write_ctrl;
75
76/**
77 * Write to the Debug Control Register.
78 */
79METHOD void write_debug {
80	platform_t	_plat;
81	struct pl310_softc *sc;
82	uint32_t	val;
83} DEFAULT platform_pl310_default_write_debug;
84