1/*-
2 * Copyright (c) 2005 Peter Grehan
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: stable/11/sys/arm/include/platformvar.h 331907 2018-04-03 06:06:39Z gonzo $
27 */
28
29#ifndef _MACHINE_PLATFORMVAR_H_
30#define _MACHINE_PLATFORMVAR_H_
31
32/*
33 * An ARM platform implementation is declared with a kernel object and
34 * an associated method table, similar to a device driver.
35 *
36 * e.g.
37 *
38 * static platform_method_t bcm2835_methods[] = {
39 *	PLATFORMMETHOD(platform_probe,		bcm2835_probe),
40 *  ...
41 *	PLATFORMMETHOD_END
42 * };
43 *
44 * static platform_def_t bcm3835_platform = {
45 * 	"bcm2835",
46 *	bcm2835_methods,
47 *	sizeof(bcm2835_platform_softc),	// or 0 if no softc
48 * };
49 *
50 * PLATFORM_DEF(bcm2835_platform);
51 */
52
53#include <sys/kobj.h>
54#include <sys/linker_set.h>
55
56struct platform_class {
57	KOBJ_CLASS_FIELDS;
58
59	/* How many times to loop to delay approximately 1us */
60	int delay_count;
61};
62
63struct platform_kobj {
64	/*
65	 * A platform instance is a kernel object
66	 */
67	KOBJ_FIELDS;
68
69	/* Platform class, for access to class specific data */
70	struct platform_class *cls;
71};
72
73struct platform_data {
74	int delay_count;
75};
76
77typedef struct platform_kobj	*platform_t;
78typedef struct platform_class	platform_def_t;
79#define platform_method_t	kobj_method_t
80
81#define PLATFORMMETHOD		KOBJMETHOD
82#define	PLATFORMMETHOD_END	KOBJMETHOD_END
83
84#define PLATFORM_DEF(name)	DATA_SET(platform_set, name)
85
86#ifdef FDT
87struct fdt_platform_class {
88	KOBJ_CLASS_FIELDS;
89
90	const char *fdt_compatible;
91};
92
93typedef struct fdt_platform_class fdt_platform_def_t;
94
95extern platform_method_t fdt_platform_methods[];
96
97#ifdef MULTIDELAY
98#define	FDT_PLATFORM_CTASSERT(delay)	CTASSERT(delay > 0)
99#else
100#define	FDT_PLATFORM_CTASSERT(delay)
101#endif
102
103#define	PLATFORM_DATA(NAME, delay)					\
104static struct platform_data NAME ## _platc = {				\
105	.delay_count = delay;						\
106};
107
108#define FDT_PLATFORM_DEF2(NAME, VAR_NAME, NAME_STR, size, compatible,	\
109    delay)								\
110FDT_PLATFORM_CTASSERT(delay);						\
111static fdt_platform_def_t VAR_NAME ## _fdt_platform = {			\
112	.name = NAME_STR,						\
113	.methods = fdt_platform_methods,				\
114	.fdt_compatible = compatible,					\
115};									\
116static kobj_class_t VAR_NAME ## _baseclasses[] =			\
117	{ (kobj_class_t)&VAR_NAME ## _fdt_platform, NULL };		\
118static platform_def_t VAR_NAME ## _platform = {				\
119	NAME_STR,							\
120	NAME ## _methods,						\
121	size,								\
122	VAR_NAME ## _baseclasses,					\
123	delay,								\
124};									\
125DATA_SET(platform_set, VAR_NAME ## _platform)
126
127#define	FDT_PLATFORM_DEF(NAME, NAME_STR, size, compatible, delay)	\
128    FDT_PLATFORM_DEF2(NAME, NAME, NAME_STR, size, compatible, delay)
129
130#endif
131
132bool arm_tmr_timed_wait(platform_t, int);
133
134#endif /* _MACHINE_PLATFORMVAR_H_ */
135