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