1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
#-
# Copyright (c) 2016 Landon Fuller <landon@landonf.org>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
# IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# $FreeBSD$
#include <sys/types.h>
#include <sys/bus.h>
#include <dev/bhnd/bhnd.h>
#include <dev/bhnd/nvram/bhnd_nvram.h>
INTERFACE bhnd_chipc;
#
# bhnd(4) ChipCommon interface.
#
HEADER {
/* forward declarations */
struct chipc_caps;
}
/**
* Return the preferred NVRAM data source.
*
* @param dev A bhnd(4) ChipCommon device.
*/
METHOD bhnd_nvram_src_t nvram_src {
device_t dev;
}
/**
* Write @p value with @p mask directly to the chipctrl register.
*
* @param dev A bhnd(4) ChipCommon device.
* @param value The value to write.
* @param mask The mask of bits to be written from @p value.
*
* Drivers should only use function for functionality that is not
* available via another bhnd_chipc() function.
*
* Currently, the only known valid use-case is in implementing a hardware
* work-around for the BCM4321 PCIe rev7 core revision.
*/
METHOD void write_chipctrl {
device_t dev;
uint32_t value;
uint32_t mask;
}
/**
* Return a borrowed reference to ChipCommon's capability
* table.
*
* @param dev A bhnd(4) ChipCommon device
*/
METHOD struct chipc_caps * get_caps {
device_t dev;
}
/**
* Enable hardware access to the SPROM.
*
* @param sc chipc driver state.
*
* @retval 0 success
* @retval EBUSY If enabling the hardware may conflict with
* other active devices.
*/
METHOD int enable_sprom {
device_t dev;
}
/**
* Release hardware access to the SPROM.
*
* @param sc chipc driver state.
*/
METHOD void disable_sprom {
device_t dev;
}
|
