1/*-
2 * Copyright (c) 2017 The FreeBSD Foundation
3 *
4 * This software was developed by Landon Fuller under sponsorship from
5 * the FreeBSD Foundation.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _BHND_PWRCTL_BHND_PWRCTL_H_
30#define _BHND_PWRCTL_BHND_PWRCTL_H_
31
32#include <sys/param.h>
33#include <sys/bus.h>
34
35#include "bhnd_pwrctl_if.h"
36
37/**
38 * Request that @p clock (or a faster clock) be enabled on behalf of
39 * @p child.
40 *
41 * @param dev PWRCTL device.
42 * @param child The requesting bhnd(4) device.
43 * @param clock Clock requested.
44 *
45 * @retval 0 success
46 * @retval ENODEV If an unsupported clock was requested.
47 */
48static inline int
49bhnd_pwrctl_request_clock(device_t dev, device_t child, bhnd_clock clock)
50{
51	return (BHND_PWRCTL_REQUEST_CLOCK(dev, child, clock));
52}
53
54/**
55 * Return the transition latency required for @p clock in microseconds, if
56 * known.
57 *
58 * The BHND_CLOCK_HT latency value is suitable for use as the D11 core's
59 * 'fastpwrup_dly' value.
60 *
61 * @param	dev	PWRCTL device.
62 * @param	clock	The clock to be queried for transition latency.
63 * @param[out]	latency	On success, the transition latency of @p clock in
64 *			microseconds.
65 *
66 * @retval 0 success
67 * @retval ENODEV If the transition latency for @p clock is not available.
68 */
69static inline int
70bhnd_pwrctl_get_clock_latency(device_t dev, bhnd_clock clock, u_int *latency)
71{
72	return (BHND_PWRCTL_GET_CLOCK_LATENCY(dev, clock, latency));
73}
74
75/**
76 * Return the frequency for @p clock in Hz, if known.
77 *
78 * @param	dev	PWRCTL device.
79 * @param	clock	The clock to be queried.
80 * @param[out]	freq	On success, the frequency of @p clock in Hz.
81 *
82 * @retval 0 success
83 * @retval ENODEV If the frequency for @p clock is not available.
84 */
85static inline int
86bhnd_pwrctl_get_clock_freq(device_t dev, bhnd_clock clock, u_int *freq)
87{
88	return (BHND_PWRCTL_GET_CLOCK_FREQ(dev, clock, freq));
89}
90
91#endif /* _BHND_PWRCTL_BHND_PWRCTL_H_ */
92