xref: /freebsd/sys/dev/hwreset/hwreset_if.m (revision e0c4386e) 
1#-
2# Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
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 "opt_platform.h"
29
30#ifdef FDT
31#include <sys/types.h>
32#include <dev/ofw/ofw_bus.h>
33#endif
34
35INTERFACE hwreset;
36
37#ifdef FDT
38HEADER {
39int hwreset_default_ofw_map(device_t , phandle_t, int, pcell_t *, intptr_t *);
40}
41
42#
43# map fdt property cells to reset id
44# Returns 0 on success or a standard errno value.
45#
46METHOD int map {
47	device_t	provider_dev;
48	phandle_t	xref;
49	int		ncells;
50	pcell_t		*cells;
51	intptr_t	*id;
52} DEFAULT hwreset_default_ofw_map;
53#endif
54
55#
56# Assert/deassert given reset.
57# Returns 0 on success or a standard errno value.
58#
59METHOD int assert {
60	device_t	provider_dev;
61	intptr_t	id;
62	bool		value;
63};
64
65#
66# Get actual status of given reset.
67# Returns 0 on success or a standard errno value.
68#
69METHOD int is_asserted {
70	device_t	provider_dev;
71	intptr_t	id;
72	bool		*value;
73};
74