init

hc

2024-03-22 a0752693d998599af469473b8dc239ef973a012f

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
/** @file 
  Header file for PchEspiLib. 
  All function in this library is available for PEI, DXE, and SMM, 
 
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR> 
SPDX-License-Identifier: BSD-2-Clause-Patent 
 
**/ 
 
#ifndef _PCH_ESPI_LIB_H_ 
#define _PCH_ESPI_LIB_H_ 
 
/** 
  Is eSPI enabled in strap. 
 
  @retval TRUE          Espi is enabled in strap 
  @retval FALSE         Espi is disabled in strap 
**/ 
BOOLEAN 
IsEspiEnabled ( 
  VOID 
  ); 
 
/** 
  Get configuration from eSPI slave 
 
  @param[in]  SlaveId       eSPI slave ID 
  @param[in]  SlaveAddress  Slave Configuration Register Address 
  @param[out] OutData       Configuration data read 
 
  @retval EFI_SUCCESS           Operation succeed 
  @retval EFI_INVALID_PARAMETER Slave ID is not supported 
  @retval EFI_INVALID_PARAMETER Slave ID is not supported or SlaveId 1 is used in PchLp 
  @retval EFI_INVALID_PARAMETER Slave configuration register address exceed maximum allowed 
  @retval EFI_INVALID_PARAMETER Slave configuration register address is not DWord aligned 
  @retval EFI_DEVICE_ERROR      Error in SCRS during polling stage of operation 
**/ 
EFI_STATUS 
PchEspiSlaveGetConfig ( 
  IN  UINT32 SlaveId, 
  IN  UINT32 SlaveAddress, 
  OUT UINT32 *OutData 
  ); 
 
/** 
  Set eSPI slave configuration 
 
  @param[in]  SlaveId       eSPI slave ID 
  @param[in]  SlaveAddress  Slave Configuration Register Address 
  @param[in]  InData        Configuration data to write 
 
  @retval EFI_SUCCESS           Operation succeed 
  @retval EFI_INVALID_PARAMETER Slave ID is not supported or SlaveId 1 is used in PchLp 
  @retval EFI_INVALID_PARAMETER Slave configuration register address exceed maximum allowed 
  @retval EFI_INVALID_PARAMETER Slave configuration register address is not DWord aligned 
  @retval EFI_ACCESS_DENIED     eSPI Slave write to address range 0 to 0x7FF has been locked 
  @retval EFI_DEVICE_ERROR      Error in SCRS during polling stage of operation 
**/ 
EFI_STATUS 
PchEspiSlaveSetConfig ( 
  IN  UINT32 SlaveId, 
  IN  UINT32 SlaveAddress, 
  IN  UINT32 InData 
  ); 
 
/** 
  Get status from eSPI slave 
 
  @param[in]  SlaveId       eSPI slave ID 
  @param[out] OutData       Configuration data read 
 
  @retval EFI_SUCCESS           Operation succeed 
  @retval EFI_INVALID_PARAMETER Slave ID is not supported or SlaveId 1 is used in PchLp 
  @retval EFI_DEVICE_ERROR      Error in SCRS during polling stage of operation 
**/ 
EFI_STATUS 
PchEspiSlaveGetStatus ( 
  IN  UINT32 SlaveId, 
  OUT UINT16 *OutData 
  ); 
 
/** 
  eSPI slave in-band reset 
 
  @param[in]  SlaveId       eSPI slave ID 
 
  @retval EFI_SUCCESS           Operation succeed 
  @retval EFI_INVALID_PARAMETER Slave ID is not supported or SlaveId 1 is used in PchLp 
  @retval EFI_DEVICE_ERROR      Error in SCRS during polling stage of operation 
**/ 
EFI_STATUS 
PchEspiSlaveInBandReset ( 
  IN  UINT32 SlaveId 
  ); 
 
#endif // _PEI_DXE_SMM_PCH_ESPI_LIB_H_