summaryrefslogtreecommitdiff
path: root/ReferenceCode/Chipset/LynxPoint/Library/PchPlatformLib/IobpAccess.c
blob: d21a1815181826252c3e0c1714c97b2e1b86e1e2 (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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/** @file
  Program IOBP register.

@copyright
  Copyright (c) 2009 - 2013 Intel Corporation. All rights reserved
  This software and associated documentation (if any) is furnished
  under a license and may only be used or copied in accordance
  with the terms of the license. Except as permitted by such
  license, no part of this software or documentation may be
  reproduced, stored in a retrieval system, or transmitted in any
  form or by any means without the express written consent of
  Intel Corporation.

  This file contains an 'Intel Peripheral Driver' and uniquely
  identified as "Intel Reference Module" and is
  licensed for Intel CPUs and chipsets under the terms of your
  license agreement with Intel or your vendor.  This file may
  be modified by the user, subject to additional terms of the
  license agreement
**/
#include "PchPlatformLibrary.h"

/**
  Configures PCH IOBP

  @param[in] RootComplexBar       RootComplexBar value of this PCH device
  @param[in] Address              Address of the IOBP register block
  @param[in] AndMask              Mask to AND with the register
  @param[in] OrMask               Mask to OR with the register

  @retval EFI_SUCCESS             Successfully completed.
  @retval EFI_DEVICE_ERROR        Transaction fail
**/
EFI_STATUS
EFIAPI
ProgramIobp (
  IN UINT32                              RootComplexBar,
  IN UINT32                              Address,
  IN UINT32                              AndMask,
  IN UINT32                              OrMask
  )
{
  UINT32      Data32;
  UINT8       ResponseStatus;
  EFI_STATUS  Status;

  ///
  /// PCH BIOS Spec Rev 0.5.0, Section 7.1.4 IOSF SBI Programming
  /// Step 1 to Step 8
  ///
  Status = ReadIobp (RootComplexBar, Address, &Data32);
  if (EFI_ERROR (Status)) {
    return Status;
  }
  ///
  /// Step 9
  /// Update the SBI data accordingly
  ///
  Data32 &= AndMask;
  Data32 |= OrMask;
  ///
  /// Step 10
  /// Set RCBA + 2338h[15:8] = 00000111b
  ///
  MmioAndThenOr16 (
    (RootComplexBar + R_PCH_RCRB_IOBPS),
    (UINT16) (~B_PCH_RCRB_IOBPS_IOBPIA),
    (UINT16) V_PCH_RCRB_IOBPS_IOBPIA_W
    );
  ///
  /// Step 11
  /// Write RCBA + 2334h[31:0] with updated SBI data
  ///
  MmioWrite32 ((RootComplexBar + R_PCH_RCRB_IOBPD), Data32);

  ///
  /// Step 12
  /// Set RCBA + 233Ah[15:0] = F000h
  ///
  MmioWrite16 (
    (RootComplexBar + 0x233A),
    0xF000
    );

  ///
  /// Step 13
  /// Set RCBA + 2338h[0] = 1b
  ///
  MmioOr16 (
    (RootComplexBar + R_PCH_RCRB_IOBPS),
    (UINT16) BIT0
    );

  ///
  /// Step 14
  /// Poll RCBA + Offset 2338h[0] = 0b
  ///
  while (MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS_BUSY);

  ///
  /// Step 15
  /// Check if RCBA + 2338h[2:1] = 00b for successful transaction
  ///
  ResponseStatus = MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS;
  if (ResponseStatus == V_PCH_RCRB_IOBPS_SUCCESS) {
    return EFI_SUCCESS;
  } else {
    return EFI_DEVICE_ERROR;
  }
}

/**
  Read data from PCH IOBP register block

  @param[in] RootComplexBar       RootComplexBar value of this PCH device
  @param[in] Address              Address of the IOBP register block
  @param[out] Data                Data contain in the IOBP register block

  @retval EFI_SUCCESS             Successfully completed.
  @retval EFI_DEVICE_ERROR        Transaction fail
**/
EFI_STATUS
EFIAPI
ReadIobp (
  IN UINT32                              RootComplexBar,
  IN UINT32                              Address,
  OUT UINT32                             *Data
  )
{
  UINT8 ResponseStatus;

  ///
  /// Step 1 Poll RCBA + 2338[0] = 0b
  ///
  while (MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS_BUSY);

  ///
  /// Step 2
  /// Write RCBA + Offset 2330h[31:0] with IOBP register address
  ///
  MmioWrite32 ((RootComplexBar + R_PCH_RCRB_IOBPIRI), Address);
  ///
  /// Step 3
  /// Set RCBA + 2338h[15:8] = 00000110b
  ///
  MmioAndThenOr16 (
    (RootComplexBar + R_PCH_RCRB_IOBPS),
    (UINT16) (~B_PCH_RCRB_IOBPS_IOBPIA),
    (UINT16) V_PCH_RCRB_IOBPS_IOBPIA_R
    );
  ///
  /// Step 4
  /// Set RCBA + 233Ah[15:0] = F000h
  ///
  MmioWrite16 (
    (RootComplexBar + 0x233A),
    0xF000
    );
  ///
  /// Step 5
  /// Set RCBA + 2338h[0] = 1b
  ///
  MmioOr16 (
    (RootComplexBar + R_PCH_RCRB_IOBPS),
    (UINT16) BIT0
    );

  ///
  /// Step 6
  /// Poll RCBA + Offset 2338h[0] = 0b, Polling for Busy bit
  ///
  while (MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS_BUSY);

  ///
  /// Step 7
  /// Check if RCBA + 2338h[2:1] = 00b for successful transaction
  ///
  ResponseStatus = MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS;
  if (ResponseStatus == V_PCH_RCRB_IOBPS_SUCCESS) {
    ///
    /// Step 8
    /// Read RCBA + 2334h[31:0] for IOBP data
    ///
    *Data = MmioRead32 (RootComplexBar + R_PCH_RCRB_IOBPD);
    return EFI_SUCCESS;
  } else {
    return EFI_DEVICE_ERROR;
  }
}

/**
  Configures PCH IOBP

  @param[in] RootComplexBar       RootComplexBar value of this PCH device
  @param[in] Address              Address of the IOBP register block
  @param[in] Opcode               Iobp Opcode
  @param[in] RouteId              Route Id
  @param[in, out] Data32          Read/Write data
  @param[out] Response            Response
  
  @retval EFI_SUCCESS             Successfully completed.
  @retval EFI_DEVICE_ERROR        Transaction fail
**/
EFI_STATUS
EFIAPI
PchIobpExecution (
  IN UINT32                              RootComplexBar,
  IN UINT32                              Address,
  IN PCH_IOBP_OPCODE                     Opcode,
  IN UINT8                               RouteId,
  IN OUT UINT32                          *Data32,
  OUT UINT8                              *Response
  )
{
  ///
  /// Step 1 Poll RCBA + 2338[0] = 0b
  ///
  while (MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS_BUSY);
  ///
  /// Step 2
  /// Write RCBA + Offset 2330h[31:0] with IOBP register address
  ///
  MmioWrite32 ((RootComplexBar + R_PCH_RCRB_IOBPIRI), Address);
  ///
  /// Step 3
  /// Set RCBA + 2338h[15:8] to the opcode passed in
  ///
  MmioAndThenOr16 (
    (RootComplexBar + R_PCH_RCRB_IOBPS),
    (UINT16) (~B_PCH_RCRB_IOBPS_IOBPIA),
    (UINT16) (Opcode << 8)
    );
  ///
  /// Step 4
  /// Set RCBA + 233Ah[15:8] = F0h
  /// Set RCBA + 233Ah[7:0] = Route Id passed in
  ///
  MmioWrite16 (
    (RootComplexBar + 0x233A),
    (0xF000 | RouteId)
    );
  switch (Opcode) {
  case MemoryMapWrite:
  case IoMapWrite:
  case PciConfigWrite:
  case PrivateControlWrite:
    ///
    /// Step 5
    /// Write RCBA + 2334h[31:0] with updated SBI data
    ///
    MmioWrite32 ((RootComplexBar + R_PCH_RCRB_IOBPD), *Data32);
    break;
  default:
    break;
  }
  ///
  /// Step 6
  /// Set RCBA + 2338h[0] = 1b
  ///
  MmioOr16 (
    (RootComplexBar + R_PCH_RCRB_IOBPS),
    (UINT16) BIT0
    );

  ///
  /// Step 7
  /// Poll RCBA + Offset 2338h[0] = 0b, Polling for Busy bit
  ///
  while (MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS_BUSY);

  ///
  /// Step 8
  /// Check if RCBA + 2338h[2:1] = 00b for successful transaction
  ///
  *Response = MmioRead8 (RootComplexBar + R_PCH_RCRB_IOBPS) & B_PCH_RCRB_IOBPS;
  if (*Response == V_PCH_RCRB_IOBPS_SUCCESS) {
    switch (Opcode) {
    case MemoryMapRead:
    case IoMapRead:
    case PciConfigRead:
    case PrivateControlRead:
      ///
      /// Step 9
      /// Read RCBA + 2334h[31:0] for IOBP data
      ///
      *Data32 = MmioRead32 (RootComplexBar + R_PCH_RCRB_IOBPD);
      break;
    default:
      break;
    }

    return EFI_SUCCESS;
  }
  return EFI_DEVICE_ERROR;
}