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 * $FreeBSD$ 29 */ 30 31 #ifndef _BHND_PWRCTL_BHND_PWRCTL_H_ 32 #define _BHND_PWRCTL_BHND_PWRCTL_H_ 33 34 #include <sys/param.h> 35 #include <sys/bus.h> 36 37 #include "bhnd_pwrctl_if.h" 38 39 /** 40 * Request that @p clock (or a faster clock) be enabled on behalf of 41 * @p child. 42 * 43 * @param dev PWRCTL device. 44 * @param child The requesting bhnd(4) device. 45 * @param clock Clock requested. 46 * 47 * @retval 0 success 48 * @retval ENODEV If an unsupported clock was requested. 49 */ 50 static inline int 51 bhnd_pwrctl_request_clock(device_t dev, device_t child, bhnd_clock clock) 52 { 53 return (BHND_PWRCTL_REQUEST_CLOCK(dev, child, clock)); 54 } 55 56 /** 57 * Return the transition latency required for @p clock in microseconds, if 58 * known. 59 * 60 * The BHND_CLOCK_HT latency value is suitable for use as the D11 core's 61 * 'fastpwrup_dly' value. 62 * 63 * @param dev PWRCTL device. 64 * @param clock The clock to be queried for transition latency. 65 * @param[out] latency On success, the transition latency of @p clock in 66 * microseconds. 67 * 68 * @retval 0 success 69 * @retval ENODEV If the transition latency for @p clock is not available. 70 */ 71 static inline int 72 bhnd_pwrctl_get_clock_latency(device_t dev, bhnd_clock clock, u_int *latency) 73 { 74 return (BHND_PWRCTL_GET_CLOCK_LATENCY(dev, clock, latency)); 75 } 76 77 /** 78 * Return the frequency for @p clock in Hz, if known. 79 * 80 * @param dev PWRCTL device. 81 * @param clock The clock to be queried. 82 * @param[out] freq On success, the frequency of @p clock in Hz. 83 * 84 * @retval 0 success 85 * @retval ENODEV If the frequency for @p clock is not available. 86 */ 87 static inline int 88 bhnd_pwrctl_get_clock_freq(device_t dev, bhnd_clock clock, u_int *freq) 89 { 90 return (BHND_PWRCTL_GET_CLOCK_FREQ(dev, clock, freq)); 91 } 92 93 #endif /* _BHND_PWRCTL_BHND_PWRCTL_H_ */ 94