1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2017 Kyle Evans <kevans@FreeBSD.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28
29#ifndef DEV_SYSCON_H
30#define DEV_SYSCON_H
31
32#include "opt_platform.h"
33
34#include <sys/types.h>
35#include <sys/kobj.h>
36#ifdef FDT
37#include <dev/ofw/ofw_bus.h>
38#endif
39
40struct syscon {
41	KOBJ_FIELDS;
42
43	TAILQ_ENTRY(syscon)	syscon_link;   /* Global list entry */
44
45	device_t		pdev;		/* provider device */
46#ifdef FDT
47	phandle_t		ofw_node;	/* OFW node for syscon */
48#endif
49	void			*softc;		/* provider softc */
50};
51
52/*
53 * Shorthands for constructing method tables.
54 */
55#define	SYSCONMETHOD		KOBJMETHOD
56#define	SYSCONMETHOD_END	KOBJMETHOD_END
57#define	syscon_method_t		kobj_method_t
58#define	syscon_class_t		kobj_class_t
59DECLARE_CLASS(syscon_class);
60
61void *syscon_get_softc(struct syscon *syscon);
62
63/*
64 * Provider interface
65 */
66struct syscon *syscon_create(device_t pdev, syscon_class_t syscon_class);
67struct syscon *syscon_register(struct syscon *syscon);
68int syscon_unregister(struct syscon *syscon);
69
70#ifdef FDT
71struct syscon *syscon_create_ofw_node(device_t pdev,
72    syscon_class_t syscon_class, phandle_t node);
73phandle_t syscon_get_ofw_node(struct syscon *syscon);
74int syscon_get_by_ofw_property(device_t consumer, phandle_t node, char *name,
75    struct syscon **syscon);
76#endif
77
78#endif /* DEV_SYSCON_H */
79