xref: /freebsd/sys/dev/hwreset/hwreset.h (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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 ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 
26 #ifndef _DEV_HWRESET_HWRESET_H_
27 #define	_DEV_HWRESET_HWRESET_H_
28 
29 #include "opt_platform.h"
30 #include <sys/types.h>
31 #ifdef FDT
32 #include <dev/ofw/ofw_bus.h>
33 #endif
34 
35 typedef struct hwreset *hwreset_t;
36 typedef struct hwreset_array *hwreset_array_t;
37 
38 /*
39  * Provider interface
40  */
41 #ifdef FDT
42 void hwreset_register_ofw_provider(device_t provider_dev);
43 void hwreset_unregister_ofw_provider(device_t provider_dev);
44 #endif
45 
46 /*
47  * Consumer interface
48  */
49 int hwreset_get_by_id(device_t consumer_dev, device_t provider_dev, intptr_t id,
50     hwreset_t *rst);
51 void hwreset_release(hwreset_t rst);
52 
53 int hwreset_assert(hwreset_t rst);
54 int hwreset_deassert(hwreset_t rst);
55 int hwreset_is_asserted(hwreset_t rst, bool *value);
56 
57 #ifdef FDT
58 int hwreset_get_by_ofw_name(device_t consumer_dev, phandle_t node, char *name,
59     hwreset_t *rst);
60 int hwreset_get_by_ofw_idx(device_t consumer_dev, phandle_t node, int idx,
61     hwreset_t *rst);
62 #endif
63 
64 void hwreset_array_release(hwreset_array_t rsts);
65 int hwreset_array_assert(hwreset_array_t rsts);
66 int hwreset_array_deassert(hwreset_array_t rsts);
67 #ifdef FDT
68 int hwreset_array_get_ofw(device_t consumer_dev, phandle_t cnode,
69     hwreset_array_t *rsts);
70 #endif
71 
72 
73 #endif /* _DEV_HWRESET_HWRESET_H_ */
74