blob: 2926e9e248eb81558d8db602420a6d5384688c4f (
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
|
/** @file
Null implementation of SpiHcPlatformLib
Copyright (C) 2024 Advanced Micro Devices, Inc. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <PiDxe.h>
#include <Protocol/DevicePath.h>
#include <Protocol/SpiHc.h>
#include <Library/SpiHcPlatformLib.h>
/**
This function reports the details of the SPI Host Controller to the SpiHc driver.
@param[out] Attributes The suported attributes of the SPI host controller
@param[out] FrameSizeSupportMask The suported FrameSizeSupportMask of the SPI host controller
@param[out] MaximumTransferBytes The suported MaximumTransferBytes of the SPI host controller
@retval EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
GetPlatformSpiHcDetails (
OUT UINT32 *Attributes,
OUT UINT32 *FrameSizeSupportMask,
OUT UINT32 *MaximumTransferBytes
)
{
return EFI_UNSUPPORTED;
}
/**
This function reports the device path of SPI host controller. This is needed in order for the SpiBus
to match the correct SPI_BUS to the SPI host controller
@param[out] DevicePath The device path for this SPI HC is returned in this variable
@retval EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
GetSpiHcDevicePath (
OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath
)
{
return EFI_UNSUPPORTED;
}
/**
This is the platform specific Spi Chip select function.
Assert or deassert the SPI chip select.
This routine is called at TPL_NOTIFY.
Update the value of the chip select line for a SPI peripheral. The SPI bus
layer calls this routine either in the board layer or in the SPI controller
to manipulate the chip select pin at the start and end of a SPI transaction.
@param[in] This Pointer to an EFI_SPI_HC_PROTOCOL structure.
@param[in] SpiPeripheral The address of an EFI_SPI_PERIPHERAL data structure
describing the SPI peripheral whose chip select pin
is to be manipulated. The routine may access the
ChipSelectParameter field to gain sufficient
context to complete the operati on.
@param[in] PinValue The value to be applied to the chip select line of
the SPI peripheral.
@retval EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
PlatformSpiHcChipSelect (
IN CONST EFI_SPI_HC_PROTOCOL *This,
IN CONST EFI_SPI_PERIPHERAL *SpiPeripheral,
IN BOOLEAN PinValue
)
{
return EFI_UNSUPPORTED;
}
/**
This function is the platform specific SPI clock function.
Set up the clock generator to produce the correct clock frequency, phase and
polarity for a SPI chip.
This routine is called at TPL_NOTIFY.
This routine updates the clock generator to generate the correct frequency
and polarity for the SPI clock.
@param[in] This Pointer to an EFI_SPI_HC_PROTOCOL structure.
@param[in] SpiPeripheral Pointer to a EFI_SPI_PERIPHERAL data structure from
which the routine can access the ClockParameter,
ClockPhase and ClockPolarity fields. The routine
also has access to the names for the SPI bus and
chip which can be used during debugging.
@param[in] ClockHz Pointer to the requested clock frequency. The SPI
host controller will choose a supported clock
frequency which is less then or equal to this
value. Specify zero to turn the clock generator
off. The actual clock frequency supported by the
SPI host controller will be returned.
@retval EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
PlatformSpiHcClock (
IN CONST EFI_SPI_HC_PROTOCOL *This,
IN CONST EFI_SPI_PERIPHERAL *SpiPeripheral,
IN UINT32 *ClockHz
)
{
return EFI_UNSUPPORTED;
}
/**
This function is the platform specific SPI transaction function
Perform the SPI transaction on the SPI peripheral using the SPI host
controller.
This routine is called at TPL_NOTIFY.
This routine synchronously returns EFI_SUCCESS indicating that the
asynchronous SPI transaction was started. The routine then waits for
completion of the SPI transaction prior to returning the final transaction
status.
@param[in] This Pointer to an EFI_SPI_HC_PROTOCOL structure.
@param[in] BusTransaction Pointer to a EFI_SPI_BUS_ TRANSACTION containing
the description of the SPI transaction to perform.
@retval EFI_UNSUPPORTED
**/
EFI_STATUS
EFIAPI
PlatformSpiHcTransaction (
IN CONST EFI_SPI_HC_PROTOCOL *This,
IN EFI_SPI_BUS_TRANSACTION *BusTransaction
)
{
return EFI_UNSUPPORTED;
}
|
