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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2015-2016 Landon Fuller <landon@landonf.org>
* Copyright (c) 2017 The FreeBSD Foundation
* All rights reserved.
*
* Portions of this software were developed by Landon Fuller
* under sponsorship from the FreeBSD Foundation.
*
* 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,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
* redistribution must be conditioned upon including a substantially
* similar Disclaimer requirement for further binary redistribution.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.
*
*/
#ifndef _BHND_CORES_CHIPC_CHIPCVAR_H_
#define _BHND_CORES_CHIPC_CHIPCVAR_H_
#include <sys/types.h>
#include <sys/rman.h>
#include <dev/bhnd/nvram/bhnd_spromvar.h>
#include "chipc.h"
DECLARE_CLASS(bhnd_chipc_driver);
struct chipc_region;
const char *chipc_flash_name(chipc_flash type);
const char *chipc_flash_bus_name(chipc_flash type);
const char *chipc_sflash_device_name(chipc_flash type);
/*
* ChipCommon device quirks / features
*/
enum {
/** No quirks */
CHIPC_QUIRK_NONE = 0,
/**
* ChipCommon-controlled SPROM/OTP is supported, along with the
* CHIPC_CAP_SPROM capability flag.
*/
CHIPC_QUIRK_SUPPORTS_SPROM = (1<<1),
/**
* The BCM4706 NAND flash interface is supported, along with the
* CHIPC_CAP_4706_NFLASH capability flag.
*/
CHIPC_QUIRK_4706_NFLASH = (1<<2),
/**
* The SPROM is attached via muxed pins. The pins must be switched
* to allow reading/writing.
*/
CHIPC_QUIRK_MUX_SPROM = (1<<3),
/**
* Access to the SPROM uses pins shared with the 802.11a external PA.
*
* On modules using these 4331 packages, the CCTRL4331_EXTPA_EN flag
* must be cleared to allow SPROM access.
*/
CHIPC_QUIRK_4331_EXTPA_MUX_SPROM = (1<<4) |
CHIPC_QUIRK_MUX_SPROM,
/**
* Access to the SPROM uses pins shared with the 802.11a external PA.
*
* On modules using these 4331 chip packages, the external PA is
* attached via GPIO 2, 5, and sprom_dout pins.
*
* When enabling and disabling EXTPA to allow SPROM access, the
* CCTRL4331_EXTPA_ON_GPIO2_5 flag must also be set or cleared,
* respectively.
*/
CHIPC_QUIRK_4331_GPIO2_5_MUX_SPROM = (1<<5) |
CHIPC_QUIRK_4331_EXTPA_MUX_SPROM,
/**
* Access to the SPROM uses pins shared with two 802.11a external PAs.
*
* When enabling and disabling EXTPA, the CCTRL4331_EXTPA_EN2 must also
* be cleared to allow SPROM access.
*/
CHIPC_QUIRK_4331_EXTPA2_MUX_SPROM = (1<<6) |
CHIPC_QUIRK_4331_EXTPA_MUX_SPROM,
/**
* SPROM pins are muxed with the FEM control lines on this 4360-family
* device. The muxed pins must be switched to allow reading/writing
* the SPROM.
*/
CHIPC_QUIRK_4360_FEM_MUX_SPROM = (1<<5) |
CHIPC_QUIRK_MUX_SPROM,
/** Supports CHIPC_CAPABILITIES_EXT register */
CHIPC_QUIRK_SUPPORTS_CAP_EXT = (1<<6),
/** Supports HND or IPX OTP registers (CHIPC_OTPST, CHIPC_OTPCTRL,
* CHIPC_OTPPROG) */
CHIPC_QUIRK_SUPPORTS_OTP = (1<<7),
/** Supports HND OTP registers. */
CHIPC_QUIRK_OTP_HND = (1<<8) |
CHIPC_QUIRK_SUPPORTS_OTP,
/** Supports IPX OTP registers. */
CHIPC_QUIRK_OTP_IPX = (1<<9) |
CHIPC_QUIRK_SUPPORTS_OTP,
/** OTP size is defined via CHIPC_OTPLAYOUT register in later
* ChipCommon revisions using the 'IPX' OTP controller. */
CHIPC_QUIRK_IPX_OTPL_SIZE = (1<<10)
};
/**
* chipc child device info.
*/
struct chipc_devinfo {
struct resource_list resources; /**< child resources */
rman_res_t irq; /**< child IRQ, if mapped */
bool irq_mapped; /**< true if IRQ mapped, false otherwise */
};
/**
* chipc driver instance state.
*/
struct chipc_softc {
device_t dev;
struct bhnd_resource *core; /**< core registers. */
struct chipc_region *core_region; /**< region containing core registers */
uint32_t quirks; /**< chipc quirk flags */
struct chipc_caps caps; /**< chipc capabilities */
struct mtx mtx; /**< state mutex. */
size_t sprom_refcnt; /**< SPROM pin enable refcount */
struct rman mem_rman; /**< port memory manager */
STAILQ_HEAD(, chipc_region) mem_regions;/**< memory allocation records */
};
#define CHIPC_LOCK_INIT(sc) \
mtx_init(&(sc)->mtx, device_get_nameunit((sc)->dev), \
"BHND chipc driver lock", MTX_DEF)
#define CHIPC_LOCK(sc) mtx_lock(&(sc)->mtx)
#define CHIPC_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
#define CHIPC_LOCK_ASSERT(sc, what) mtx_assert(&(sc)->mtx, what)
#define CHIPC_LOCK_DESTROY(sc) mtx_destroy(&(sc)->mtx)
#endif /* _BHND_CORES_CHIPC_CHIPCVAR_H_ */
|
