platformvar.h revision 266333 
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: head/sys/arm/include/platformvar.h 266333 2014-05-17 18:02:46Z andrew $
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_kobj {
57	/*
58	 * A platform instance is a kernel object
59	 */
60	KOBJ_FIELDS;
61
62	/* Platform class, for access to class specific data */
63	struct kobj_class *cls;
64};
65
66typedef struct platform_kobj	*platform_t;
67typedef struct kobj_class	platform_def_t;
68#define platform_method_t	kobj_method_t
69
70#define PLATFORMMETHOD		KOBJMETHOD
71#define	PLATFORMMETHOD_END	KOBJMETHOD_END
72
73#define PLATFORM_DEF(name)	DATA_SET(platform_set, name)
74
75#ifdef FDT
76struct fdt_platform_class {
77	KOBJ_CLASS_FIELDS;
78
79	const char *fdt_compatible;
80};
81
82typedef struct fdt_platform_class fdt_platform_def_t;
83
84extern platform_method_t fdt_platform_methods[];
85
86#define FDT_PLATFORM_DEF2(NAME, VAR_NAME, NAME_STR, size, compatible)	\
87static fdt_platform_def_t VAR_NAME ## _fdt_platform = {			\
88	.name = NAME_STR,						\
89	.methods = fdt_platform_methods,				\
90	.fdt_compatible = compatible,					\
91};									\
92static kobj_class_t VAR_NAME ## _baseclasses[] =			\
93	{ (kobj_class_t)&VAR_NAME ## _fdt_platform, NULL };		\
94static platform_def_t VAR_NAME ## _platform = {				\
95	NAME_STR,							\
96	NAME ## _methods,						\
97	size,								\
98	VAR_NAME ## _baseclasses,					\
99};									\
100DATA_SET(platform_set, VAR_NAME ## _platform)
101
102#define	FDT_PLATFORM_DEF(NAME, NAME_STR, size, compatible)		\
103    FDT_PLATFORM_DEF2(NAME, NAME, NAME_STR, size, compatible)
104
105#endif
106
107#endif /* _MACHINE_PLATFORMVAR_H_ */
108