hwreset.h revision 308324
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 * $FreeBSD: stable/11/sys/dev/extres/hwreset/hwreset.h 308324 2016-11-05 04:17:32Z mmel $
26 */
27
28#ifndef DEV_EXTRES_HWRESET_HWRESET_H
29#define DEV_EXTRES_HWRESET_HWRESET_H
30
31#include "opt_platform.h"
32#include <sys/types.h>
33#ifdef FDT
34#include <dev/ofw/ofw_bus.h>
35#endif
36
37typedef struct hwreset *hwreset_t;
38
39/*
40 * Provider interface
41 */
42#ifdef FDT
43int hwreset_default_ofw_map(device_t provider_dev, phandle_t xref, int ncells,
44    pcell_t *cells, intptr_t *id);
45void hwreset_register_ofw_provider(device_t provider_dev);
46void hwreset_unregister_ofw_provider(device_t provider_dev);
47#endif
48
49/*
50 * Consumer interface
51 */
52int hwreset_get_by_id(device_t consumer_dev, device_t provider_dev, intptr_t id,
53    hwreset_t *rst);
54void hwreset_release(hwreset_t rst);
55
56int hwreset_assert(hwreset_t rst);
57int hwreset_deassert(hwreset_t rst);
58int hwreset_is_asserted(hwreset_t rst, bool *value);
59
60#ifdef FDT
61int hwreset_get_by_ofw_name(device_t consumer_dev, phandle_t node, char *name,
62    hwreset_t *rst);
63int hwreset_get_by_ofw_idx(device_t consumer_dev, phandle_t node, int idx,
64    hwreset_t *rst);
65#endif
66
67
68
69#endif /* DEV_EXTRES_HWRESET_HWRESET_H */
70