2 # Copyright (c) 2016 Landon Fuller <landon@landonf.org>
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
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.
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 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
18 # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
23 # USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/types.h>
30 #include <dev/bhnd/bhnd.h>
35 # bhnd(4) ChipCommon interface.
39 /* forward declarations */
44 static struct chipc_caps *
45 bhnd_chipc_null_get_caps(device_t dev)
47 panic("bhnd_chipc_generic_get_caps unimplemented");
53 * Return the current value of the chipstatus register.
55 * @param dev A bhnd(4) ChipCommon device.
57 * Drivers should only use function for functionality that is not
58 * available via another bhnd_chipc() function.
60 * @returns The chipstatus register value, or 0 if undefined by this
61 * hardware (e.g. if @p dev is an EXTIF core).
63 METHOD uint32_t read_chipst {
68 * Write @p value with @p mask directly to the chipctrl register.
70 * @param dev A bhnd(4) ChipCommon device.
71 * @param value The value to write.
72 * @param mask The mask of bits to be written from @p value.
74 * Drivers should only use function for functionality that is not
75 * available via another bhnd_chipc() function.
77 * Currently, the only known valid use-case is in implementing a hardware
78 * work-around for the BCM4321 PCIe rev7 core revision.
80 METHOD void write_chipctrl {
87 * Return a borrowed reference to ChipCommon's capability
90 * @param dev A bhnd(4) ChipCommon device
92 METHOD struct chipc_caps * get_caps {
94 } DEFAULT bhnd_chipc_null_get_caps;
97 * Enable hardware access to the SPROM/OTP source.
99 * @param sc chipc driver state.
102 * @retval EBUSY If enabling the hardware may conflict with
103 * other active devices.
105 METHOD int enable_sprom {
110 * Release hardware access to the SPROM/OTP source.
112 * @param sc chipc driver state.
114 METHOD void disable_sprom {