summaryrefslogtreecommitdiff
path: root/Platform/Marvell/Include/Library/MvHwDescLib.h
blob: 6ad1bc231eac4ebe85b2cf9833cc33d72474cbd5 (plain)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/********************************************************************************
Copyright (C) 2017 Marvell International Ltd.

Marvell BSD License Option

If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File under the following licensing terms.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.

* 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.

* Neither the name of Marvell nor the names of its contributors may be
  used to endorse or promote products derived from this software without
  specific prior written permission.

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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.

*******************************************************************************/

#ifndef __MVHWDESCLIB_H__
#define __MVHWDESCLIB_H__

#include <Library/MvComPhyLib.h>
#include <Library/NonDiscoverableDeviceRegistrationLib.h>

//
// Helper macros
//

// Check if device is enabled - it expects PCD to be read to '<type>DeviceTable' array
#define MVHW_DEV_ENABLED(type, index) (type ## DeviceTable[index])

//
// CommonPhy devices description template definition
//
#define MVHW_MAX_COMPHY_DEVS       4

typedef struct {
  UINT8 ComPhyDevCount;
  UINTN ComPhyBaseAddresses[MVHW_MAX_COMPHY_DEVS];
  UINTN ComPhyHpipe3BaseAddresses[MVHW_MAX_COMPHY_DEVS];
  UINTN ComPhyLaneCount[MVHW_MAX_COMPHY_DEVS];
  UINTN ComPhyMuxBitCount[MVHW_MAX_COMPHY_DEVS];
  MV_COMPHY_CHIP_TYPE ComPhyChipType[MVHW_MAX_COMPHY_DEVS];
} MVHW_COMPHY_DESC;

//
// I2C devices description template definition
//
#define MVHW_MAX_I2C_DEVS         4

typedef struct {
  UINT8 I2cDevCount;
  UINTN I2cBaseAddresses[MVHW_MAX_I2C_DEVS];
} MVHW_I2C_DESC;

//
// NonDiscoverable devices description template definition
//
#define MVHW_MAX_XHCI_DEVS         4
#define MVHW_MAX_AHCI_DEVS         4
#define MVHW_MAX_SDHCI_DEVS        4

typedef struct {
  // XHCI
  UINT8 XhciDevCount;
  UINTN XhciBaseAddresses[MVHW_MAX_XHCI_DEVS];
  UINTN XhciMemSize[MVHW_MAX_XHCI_DEVS];
  NON_DISCOVERABLE_DEVICE_DMA_TYPE XhciDmaType[MVHW_MAX_XHCI_DEVS];
  // AHCI
  UINT8 AhciDevCount;
  UINTN AhciBaseAddresses[MVHW_MAX_AHCI_DEVS];
  UINTN AhciMemSize[MVHW_MAX_AHCI_DEVS];
  NON_DISCOVERABLE_DEVICE_DMA_TYPE AhciDmaType[MVHW_MAX_AHCI_DEVS];
  // SDHCI
  UINT8 SdhciDevCount;
  UINTN SdhciBaseAddresses[MVHW_MAX_SDHCI_DEVS];
  UINTN SdhciMemSize[MVHW_MAX_SDHCI_DEVS];
  NON_DISCOVERABLE_DEVICE_DMA_TYPE SdhciDmaType[MVHW_MAX_SDHCI_DEVS];
} MVHW_NONDISCOVERABLE_DESC;

//
// PP2 NIC devices description template definition
//
#define MVHW_MAX_PP2_DEVS         4

typedef struct {
  UINT8 Pp2DevCount;
  UINTN Pp2BaseAddresses[MVHW_MAX_PP2_DEVS];
  UINTN Pp2ClockFrequency[MVHW_MAX_PP2_DEVS];
} MVHW_PP2_DESC;

//
// RealTimeClock devices description template definition
//
#define MVHW_MAX_RTC_DEVS         2

typedef struct {
  UINT8 RtcDevCount;
  UINTN RtcBaseAddresses[MVHW_MAX_RTC_DEVS];
  UINTN RtcMemSize[MVHW_MAX_RTC_DEVS];
} MVHW_RTC_DESC;

//
// UTMI PHY's description template definition
//

typedef struct {
  UINT8 UtmiDevCount;
  UINT32 UtmiPhyId[MVHW_MAX_XHCI_DEVS];
  UINTN UtmiBaseAddresses[MVHW_MAX_XHCI_DEVS];
  UINTN UtmiConfigAddresses[MVHW_MAX_XHCI_DEVS];
  UINTN UtmiUsbConfigAddresses[MVHW_MAX_XHCI_DEVS];
  UINTN UtmiMuxBitCount[MVHW_MAX_XHCI_DEVS];
} MVHW_UTMI_DESC;

//
// Platform description of CommonPhy devices
//
#define MVHW_CP0_COMPHY_BASE       0xF2441000
#define MVHW_CP0_HPIPE3_BASE       0xF2120000
#define MVHW_CP0_COMPHY_LANES      6
#define MVHW_CP0_COMPHY_MUX_BITS   4
#define MVHW_CP1_COMPHY_BASE       0xF4441000
#define MVHW_CP1_HPIPE3_BASE       0xF4120000
#define MVHW_CP1_COMPHY_LANES      6
#define MVHW_CP1_COMPHY_MUX_BITS   4

#define DECLARE_A7K8K_COMPHY_TEMPLATE \
STATIC \
MVHW_COMPHY_DESC mA7k8kComPhyDescTemplate = {\
  2,\
  { MVHW_CP0_COMPHY_BASE, MVHW_CP1_COMPHY_BASE },\
  { MVHW_CP0_HPIPE3_BASE, MVHW_CP1_HPIPE3_BASE },\
  { MVHW_CP0_COMPHY_LANES, MVHW_CP1_COMPHY_LANES },\
  { MVHW_CP0_COMPHY_MUX_BITS, MVHW_CP1_COMPHY_MUX_BITS },\
  { MvComPhyTypeCp110, MvComPhyTypeCp110 }\
}

//
// Platform description of I2C devices
//
#define MVHW_CP0_I2C0_BASE       0xF2701000
#define MVHW_CP0_I2C1_BASE       0xF2701100
#define MVHW_CP1_I2C0_BASE       0xF4701000
#define MVHW_CP1_I2C1_BASE       0xF4701100

#define DECLARE_A7K8K_I2C_TEMPLATE \
STATIC \
MVHW_I2C_DESC mA7k8kI2cDescTemplate = {\
  4,\
  { MVHW_CP0_I2C0_BASE, MVHW_CP0_I2C1_BASE, MVHW_CP1_I2C0_BASE, MVHW_CP1_I2C1_BASE }\
}

//
// Platform description of NonDiscoverable devices
//
#define MVHW_CP0_XHCI0_BASE        0xF2500000
#define MVHW_CP0_XHCI1_BASE        0xF2510000
#define MVHW_CP1_XHCI0_BASE        0xF4500000
#define MVHW_CP1_XHCI1_BASE        0xF4510000

#define MVHW_CP0_AHCI0_BASE        0xF2540000
#define MVHW_CP0_AHCI0_ID          0
#define MVHW_CP1_AHCI0_BASE        0xF4540000
#define MVHW_CP1_AHCI0_ID          1

#define MVHW_AP0_SDHCI0_BASE       0xF06E0000
#define MVHW_CP0_SDHCI0_BASE       0xF2780000

#define DECLARE_A7K8K_NONDISCOVERABLE_TEMPLATE   \
STATIC \
MVHW_NONDISCOVERABLE_DESC mA7k8kNonDiscoverableDescTemplate = {\
  4, /* XHCI */\
  { MVHW_CP0_XHCI0_BASE, MVHW_CP0_XHCI1_BASE, MVHW_CP1_XHCI0_BASE, MVHW_CP1_XHCI1_BASE },\
  { SIZE_16KB, SIZE_16KB, SIZE_16KB, SIZE_16KB },\
  { NonDiscoverableDeviceDmaTypeCoherent, NonDiscoverableDeviceDmaTypeCoherent,\
    NonDiscoverableDeviceDmaTypeCoherent, NonDiscoverableDeviceDmaTypeCoherent },\
  2, /* AHCI */\
  { MVHW_CP0_AHCI0_BASE, MVHW_CP1_AHCI0_BASE },\
  { SIZE_8KB, SIZE_8KB },\
  { NonDiscoverableDeviceDmaTypeCoherent, NonDiscoverableDeviceDmaTypeCoherent },\
  2, /* SDHCI */\
  { MVHW_AP0_SDHCI0_BASE, MVHW_CP0_SDHCI0_BASE },\
  { SIZE_1KB, SIZE_1KB },\
  { NonDiscoverableDeviceDmaTypeCoherent, NonDiscoverableDeviceDmaTypeCoherent }\
}

//
// Platform description of Pp2 NIC devices
//
#define MVHW_CP0_PP2_BASE       0xF2000000
#define MVHW_CP1_PP2_BASE       0xF4000000
#define MVHW_PP2_CLK_FREQ       333333333

#define DECLARE_A7K8K_PP2_TEMPLATE \
STATIC \
MVHW_PP2_DESC mA7k8kPp2DescTemplate = {\
  2,\
  { MVHW_CP0_PP2_BASE, MVHW_CP1_PP2_BASE },\
  { MVHW_PP2_CLK_FREQ, MVHW_PP2_CLK_FREQ } \
}

//
// Platform description of RealTimeClock devices
//
#define MVHW_CP0_RTC0_BASE       0xF2284000
#define MVHW_CP1_RTC0_BASE       0xF4284000

#define DECLARE_A7K8K_RTC_TEMPLATE \
STATIC \
MVHW_RTC_DESC mA7k8kRtcDescTemplate = {\
  2,\
  { MVHW_CP0_RTC0_BASE, MVHW_CP1_RTC0_BASE },\
  { SIZE_4KB, SIZE_4KB }\
}

//
// Platform description of UTMI PHY's
//
#define MVHW_CP0_UTMI0_BASE            0xF2580000
#define MVHW_CP0_UTMI0_CFG_BASE        0xF2440440
#define MVHW_CP0_UTMI0_USB_CFG_BASE    0xF2440420
#define MVHW_CP0_UTMI0_ID              0x0
#define MVHW_CP0_UTMI1_BASE            0xF2581000
#define MVHW_CP0_UTMI1_CFG_BASE        0xF2440444
#define MVHW_CP0_UTMI1_USB_CFG_BASE    0xF2440420
#define MVHW_CP0_UTMI1_ID              0x1
#define MVHW_CP1_UTMI0_BASE            0xF4580000
#define MVHW_CP1_UTMI0_CFG_BASE        0xF4440440
#define MVHW_CP1_UTMI0_USB_CFG_BASE    0xF4440420
#define MVHW_CP1_UTMI0_ID              0x0
#define MVHW_CP1_UTMI1_BASE            0xF4581000
#define MVHW_CP1_UTMI1_CFG_BASE        0xF4440444
#define MVHW_CP1_UTMI1_USB_CFG_BASE    0xF4440420
#define MVHW_CP1_UTMI1_ID              0x1

#define DECLARE_A7K8K_UTMI_TEMPLATE \
STATIC \
MVHW_UTMI_DESC mA7k8kUtmiDescTemplate = {\
  4,\
  { MVHW_CP0_UTMI0_ID, MVHW_CP0_UTMI1_ID,\
    MVHW_CP1_UTMI0_ID, MVHW_CP1_UTMI1_ID },\
  { MVHW_CP0_UTMI0_BASE, MVHW_CP0_UTMI1_BASE,\
    MVHW_CP1_UTMI0_BASE, MVHW_CP1_UTMI1_BASE },\
  { MVHW_CP0_UTMI0_CFG_BASE, MVHW_CP0_UTMI1_CFG_BASE,\
    MVHW_CP1_UTMI0_CFG_BASE, MVHW_CP1_UTMI1_CFG_BASE },\
  { MVHW_CP0_UTMI0_USB_CFG_BASE, MVHW_CP0_UTMI1_USB_CFG_BASE,\
    MVHW_CP1_UTMI0_USB_CFG_BASE, MVHW_CP1_UTMI1_USB_CFG_BASE }\
}

#endif /* __MVHWDESCLIB_H__ */