hc
2024-03-25 edb30157bad0c0001c32b854271ace01d3b9a16a
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
/** @file
  PCH Serial IO Lib implementation Cannon Lake specific.
  All function in this library is available for PEI, DXE, and SMM,
  But do not support UEFI RUNTIME environment call.
 
  Copyright (c) 2019 Intel Corporation. All rights reserved. <BR>
 
  SPDX-License-Identifier: BSD-2-Clause-Patent
**/
 
#include <Base.h>
#include <Uefi/UefiBaseType.h>
#include <Library/IoLib.h>
#include <Library/BaseLib.h>
#include <IndustryStandard/Pci30.h>
#include <Library/PchPcrLib.h>
#include <Library/PchInfoLib.h>
#include <Library/PciSegmentLib.h>
#include <Library/PcdLib.h>
#include <Private/Library/GpioPrivateLib.h>
#include <Library/PchSerialIoLib.h>
#include <Private/Library/PchPsfPrivateLib.h>
 
#include <PchLimits.h>
#include <Register/PchRegsSerialIoCnl.h>
#include "PchSerialIoLibInternal.h"
 
GLOBAL_REMOVE_IF_UNREFERENCED CHAR8 mCnlAcpiHid[PCH_MAX_SERIALIO_CONTROLLERS][SERIALIO_HID_LENGTH] =
{
  "INT34B2",
  "INT34B3",
  "INT34B4",
  "INT34B5",
  "INT34B6",
  "INT34B7",
  "INT34B0",
  "INT34B1",
  "INT34BC",
  "INT34B8",
  "INT34B9",
  "INT34BA"
};
 
GLOBAL_REMOVE_IF_UNREFERENCED UINT16 mCnlPchLpSerialIoId [PCH_MAX_SERIALIO_CONTROLLERS] =
{
  V_CNL_PCH_LP_SERIAL_IO_CFG_I2C0_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_I2C1_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_I2C2_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_I2C3_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_I2C4_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_I2C5_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_SPI0_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_SPI1_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_UART0_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_UART1_DEVICE_ID,
  V_CNL_PCH_LP_SERIAL_IO_CFG_UART2_DEVICE_ID
};
 
GLOBAL_REMOVE_IF_UNREFERENCED UINT16 mCnlPchHSerialIoId [PCH_MAX_SERIALIO_CONTROLLERS] =
{
  V_CNL_PCH_H_SERIAL_IO_CFG_I2C0_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_I2C1_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_I2C2_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_I2C3_DEVICE_ID,
                                         0,
                                         0,
  V_CNL_PCH_H_SERIAL_IO_CFG_SPI0_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_SPI1_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_UART0_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_UART1_DEVICE_ID,
  V_CNL_PCH_H_SERIAL_IO_CFG_UART2_DEVICE_ID
};
 
GLOBAL_REMOVE_IF_UNREFERENCED SERIAL_IO_BDF_NUMBERS mSerialIoBdf [PCH_MAX_SERIALIO_CONTROLLERS] =
{
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_I2C0,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_I2C0},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_I2C1,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_I2C1},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_I2C2,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_I2C2},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_I2C3,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_I2C3},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_I2C4,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_I2C4},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_I2C5,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_I2C5},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_SPI0,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_SPI0},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_SPI1,  PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_SPI1},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_UART0, PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_UART0},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_UART1, PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_UART1},
  {PCI_DEVICE_NUMBER_PCH_SERIAL_IO_UART2, PCI_FUNCTION_NUMBER_PCH_SERIAL_IO_UART2}
};
 
 
/**
  Returns index of the last i2c controller
 
  @param[in] Number                     Number of SerialIo controller
 
  @retval                               Index of I2C controller
**/
PCH_SERIAL_IO_CONTROLLER
GetMaxI2cNumber (
  VOID
  )
{
  if (IsPchH ()) {
    return PchSerialIoIndexI2C3;
  } else {
    return PchSerialIoIndexI2C5;
  }
}
 
/**
  Checks if Device with given PciDeviceId is one of SerialIo controllers
  If yes, its number is returned through Number parameter, otherwise Number is not updated
 
  @param[in]  PciDevId                  Device ID
  @param[out] Number                    Number of SerialIo controller
 
  @retval TRUE                          Yes it is a SerialIo controller
  @retval FALSE                         No it isn't a SerialIo controller
**/
BOOLEAN
IsSerialIoPciDevId (
  IN  UINT16                    PciDevId,
  OUT PCH_SERIAL_IO_CONTROLLER  *Number
  )
{
  PCH_SERIAL_IO_CONTROLLER Controller;
 
  for (Controller = 0; Controller < GetPchMaxSerialIoControllersNum (); Controller++) {
    if ((IsPchLp () && (PciDevId == mCnlPchLpSerialIoId[Controller])) ||
        (IsPchH () && (PciDevId == mCnlPchHSerialIoId[Controller])))
    {
      *Number = Controller;
      return TRUE;
    }
  }
  return FALSE;
}
 
/**
  Finds PCI Device Number of SerialIo devices.
 
  @param[in] SerialIoNumber             Serial IO device
 
  @retval                               SerialIo device number
**/
UINT8
GetSerialIoDeviceNumber (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoNumber
  )
{
  return mSerialIoBdf[SerialIoNumber].DevNum;
}
 
/**
  Finds PCI Function Number of SerialIo devices.
 
  @param[in] SerialIoNumber             Serial IO device
 
  @retval                               SerialIo funciton number
**/
UINT8
GetSerialIoFunctionNumber (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoNumber
  )
{
  return mSerialIoBdf[SerialIoNumber].FuncNum;
}
 
/**
  Returns string with AcpiHid assigned to selected SerialIo controller
 
  @param[in] Number                     Number of SerialIo controller
 
  @retval                               pointer to 8-byte string
**/
CHAR8*
GetSerialIoAcpiHid (
  IN PCH_SERIAL_IO_CONTROLLER Number
  )
{
  return mCnlAcpiHid[Number];
}