]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Protocol/SpiConfiguration.h
MdePkg FirmwareManagement.h: Fix typo EFI_SECURITY_VIOLATIO
[mirror_edk2.git] / MdePkg / Include / Protocol / SpiConfiguration.h
CommitLineData
db04b706
MH
1/** @file\r
2 This file defines the SPI Configuration Protocol.\r
3\r
4 Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD\r
7 License which accompanies this distribution. The full text of the license may\r
8 be found at http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13 @par Revision Reference:\r
14 This Protocol was introduced in UEFI PI Specification 1.6.\r
15\r
16**/\r
17\r
18#ifndef __SPI_CONFIGURATION_PROTOCOL_H__\r
19#define __SPI_CONFIGURATION_PROTOCOL_H__\r
20\r
21///\r
22/// Global ID for the SPI Configuration Protocol\r
23///\r
24#define EFI_SPI_CONFIGURATION_GUID \\r
25 { 0x85a6d3e6, 0xb65b, 0x4afc, \\r
26 { 0xb3, 0x8f, 0xc6, 0xd5, 0x4a, 0xf6, 0xdd, 0xc8 }}\r
27\r
28///\r
29/// Macros to easily specify frequencies in hertz, kilohertz and megahertz.\r
30///\r
31#define Hz(Frequency) (Frequency)\r
32#define KHz(Frequency) (1000 * Hz (Frequency))\r
33#define MHz(Frequency) (1000 * KHz (Frequency))\r
34\r
35typedef struct _EFI_SPI_PERIPHERAL EFI_SPI_PERIPHERAL;\r
36\r
37/**\r
38 Manipulate the chip select for a SPI device.\r
39\r
40 This routine must be called at or below TPL_NOTIFY.\r
41 Update the value of the chip select line for a SPI peripheral.\r
42 The SPI bus layer calls this routine either in the board layer or in the SPI\r
43 controller to manipulate the chip select pin at the start and end of a SPI\r
44 transaction.\r
45\r
46 @param[in] SpiPeripheral The address of an EFI_SPI_PERIPHERAL data structure\r
47 describing the SPI peripheral whose chip select pin\r
48 is to be manipulated. The routine may access the\r
49 ChipSelectParameter field to gain sufficient\r
50 context to complete the operation.\r
51 @param[in] PinValue The value to be applied to the chip select line of\r
52 the SPI peripheral.\r
53\r
54 @retval EFI_SUCCESS The chip select was set successfully\r
55 @retval EFI_NOT_READY Support for the chip select is not properly\r
56 initialized\r
57 @retval EFI_INVALID_PARAMETER The SpiPeripheral->ChipSelectParameter value\r
58 is invalid\r
59\r
60**/\r
61typedef\r
62EFI_STATUS\r
63(EFIAPI *EFI_SPI_CHIP_SELECT) (\r
64 IN CONST EFI_SPI_PERIPHERAL *SpiPeripheral,\r
65 IN BOOLEAN PinValue\r
66 );\r
67\r
68/**\r
69 Set up the clock generator to produce the correct clock frequency, phase and\r
70 polarity for a SPI chip.\r
71\r
72 This routine must be called at or below TPL_NOTIFY.\r
73 This routine updates the clock generator to generate the correct frequency\r
74 and polarity for the SPI clock.\r
75\r
76 @param[in] SpiPeripheral Pointer to a EFI_SPI_PERIPHERAL data structure from\r
77 which the routine can access the ClockParameter,\r
78 ClockPhase and ClockPolarity fields. The routine\r
79 also has access to the names for the SPI bus and\r
80 chip which can be used during debugging.\r
81 @param[in] ClockHz Pointer to the requested clock frequency. The clock\r
82 generator will choose a supported clock frequency\r
83 which is less then or equal to this value.\r
84 Specify zero to turn the clock generator off.\r
85 The actual clock frequency supported by the clock\r
86 generator will be returned.\r
87\r
88 @retval EFI_SUCCESS The clock was set up successfully\r
89 @retval EFI_UNSUPPORTED The SPI controller was not able to support the\r
90 frequency requested by CLockHz\r
91\r
92**/\r
93typedef EFI_STATUS\r
94(EFIAPI *EFI_SPI_CLOCK) (\r
95 IN CONST EFI_SPI_PERIPHERAL *SpiPeripheral,\r
96 IN UINT32 *ClockHz\r
97 );\r
98\r
99///\r
100/// The EFI_SPI_PART data structure provides a description of a SPI part which\r
101/// is independent of the use on the board. This data is available directly\r
102/// from the part's datasheet and may be provided by the vendor.\r
103///\r
104typedef struct _EFI_SPI_PART {\r
105 ///\r
106 /// A Unicode string specifying the SPI chip vendor.\r
107 ///\r
108 CONST CHAR16 *Vendor;\r
109\r
110 ///\r
111 /// A Unicode string specifying the SPI chip part number.\r
112 ///\r
113 CONST CHAR16 *PartNumber;\r
114\r
115 ///\r
116 /// The minimum SPI bus clock frequency used to access this chip. This value\r
117 /// may be specified in the chip's datasheet. If not, use the value of zero.\r
118 ///\r
119 UINT32 MinClockHz;\r
120\r
121 ///\r
122 /// The maximum SPI bus clock frequency used to access this chip. This value\r
123 /// is found in the chip's datasheet.\r
124 ///\r
125 UINT32 MaxClockHz;\r
126\r
127 ///\r
128 /// Specify the polarity of the chip select pin. This value can be found in\r
129 /// the SPI chip's datasheet. Specify TRUE when a one asserts the chip select\r
130 ///and FALSE when a zero asserts the chip select.\r
131 ///\r
132 BOOLEAN ChipSelectPolarity;\r
133} EFI_SPI_PART;\r
134\r
135///\r
136/// The EFI_SPI_BUS data structure provides the connection details between the\r
137/// physical SPI bus and the EFI_SPI_HC_PROTOCOL instance which controls that\r
138/// SPI bus. This data structure also describes the details of how the clock is\r
139/// generated for that SPI bus. Finally this data structure provides the list\r
140/// of physical SPI devices which are attached to the SPI bus.\r
141///\r
142typedef struct _EFI_SPI_BUS {\r
143 ///\r
144 /// A Unicode string describing the SPI bus\r
145 ///\r
146 CONST CHAR16 *FriendlyName;\r
147\r
148 ///\r
149 /// Address of the first EFI_SPI_PERIPHERAL data structure connected to this\r
150 /// bus. Specify NULL if there are no SPI peripherals connected to this bus.\r
151 ///\r
152 CONST EFI_SPI_PERIPHERAL *Peripherallist;\r
153\r
154 ///\r
155 /// Address of an EFI_DEVICE_PATH_PROTOCOL data structure which uniquely\r
156 /// describes the SPI controller.\r
157 ///\r
158 CONST EFI_DEVICE_PATH_PROTOCOL *ControllerPath;\r
159\r
160 ///\r
161 /// Address of the routine which controls the clock used by the SPI bus for\r
162 /// this SPI peripheral. The SPI host co ntroller's clock routine is called\r
163 /// when this value is set to NULL.\r
164 ///\r
165 EFI_SPI_CLOCK Clock;\r
166\r
167 ///\r
168 /// Address of a data structure containing the additional values which\r
169 /// describe the necessary control for the clock. When Clock is NULL,\r
170 /// the declaration for this data structure is provided by the vendor of the\r
171 /// host's SPI controller driver. When Clock is not NULL, the declaration for\r
172 /// this data structure is provided by the board layer.\r
173 ///\r
174 VOID *ClockParameter;\r
175} EFI_SPI_BUS;\r
176\r
177///\r
178/// The EFI_SPI_PERIPHERAL data structure describes how a specific block of\r
179/// logic which is connected to the SPI bus. This data structure also selects\r
180/// which upper level driver is used to manipulate this SPI device.\r
181/// The SpiPeripheraLDriverGuid is available from the vendor of the SPI\r
182/// peripheral driver.\r
183///\r
184struct _EFI_SPI_PERIPHERAL {\r
185 ///\r
186 /// Address of the next EFI_SPI_PERIPHERAL data structure. Specify NULL if\r
187 /// the current data structure is the last one on the SPI bus.\r
188 ///\r
189 CONST EFI_SPI_PERIPHERAL *NextSpiPeripheral;\r
190\r
191 ///\r
192 /// A unicode string describing the function of the SPI part.\r
193 ///\r
194 CONST CHAR16 *FriendlyName;\r
195\r
196 ///\r
197 /// Address of a GUID provided by the vendor of the SPI peripheral driver.\r
198 /// Instead of using a " EFI_SPI_IO_PROTOCOL" GUID, the SPI bus driver uses\r
199 /// this GUID to identify an EFI_SPI_IO_PROTOCOL data structure and to\r
200 /// provide the connection points for the SPI peripheral drivers.\r
201 /// This reduces the comparison logic in the SPI peripheral driver's\r
202 /// Supported routine.\r
203 ///\r
204 CONST GUID *SpiPeripheralDriverGuid;\r
205\r
206 ///\r
207 /// The address of an EFI_SPI_PART data structure which describes this chip.\r
208 ///\r
209 CONST EFI_SPI_PART *SpiPart;\r
210\r
211 ///\r
212 /// The maximum clock frequency is specified in the EFI_SPI_P ART. When this\r
213 /// this value is non-zero and less than the value in the EFI_SPI_PART then\r
214 /// this value is used for the maximum clock frequency for the SPI part.\r
215 ///\r
216 UINT32 MaxClockHz;\r
217\r
218 ///\r
219 /// Specify the idle value of the clock as found in the datasheet.\r
220 /// Use zero (0) if the clock'S idle value is low or one (1) if the the\r
221 /// clock's idle value is high.\r
222 ///\r
223 BOOLEAN ClockPolarity;\r
224\r
225 ///\r
226 /// Specify the clock delay after chip select. Specify zero (0) to delay an\r
227 /// entire clock cycle or one (1) to delay only half a clock cycle.\r
228 ///\r
229 BOOLEAN ClockPhase;\r
230\r
231 ///\r
232 /// SPI peripheral attributes, select zero or more of:\r
233 /// * SPI_PART_SUPPORTS_2_B1T_DATA_BUS_W1DTH - The SPI peripheral is wired to\r
234 /// support a 2-bit data bus\r
235 /// * SPI_PART_SUPPORTS_4_B1T_DATA_BUS_W1DTH - The SPI peripheral is wired to\r
236 /// support a 4-bit data bus\r
237 ///\r
238 UINT32 Attributes;\r
239\r
240 ///\r
241 /// Address of a vendor specific data structure containing additional board\r
242 /// configuration details related to the SPI chip. The SPI peripheral layer\r
243 /// uses this data structure when configuring the chip.\r
244 ///\r
245 CONST VOID *ConfigurationData;\r
246\r
247 ///\r
248 /// The address of an EFI_SPI_BUS data structure which describes the SPI bus\r
249 /// to which this chip is connected.\r
250 ///\r
251 CONST EFI_SPI_BUS *SpiBus;\r
252\r
253 ///\r
254 /// Address of the routine which controls the chip select pin for this SPI\r
255 /// peripheral. Call the SPI host controller's chip select routine when this\r
256 /// value is set to NULL.\r
257 ///\r
258 EFI_SPI_CHIP_SELECT ChipSelect;\r
259\r
260 ///\r
261 /// Address of a data structure containing the additional values which\r
262 /// describe the necessary control for the chip select. When ChipSelect is\r
263 /// NULL, the declaration for this data structure is provided by the vendor\r
264 /// of the host's SPI controller driver. The vendor's documentation specifies\r
265 /// the necessary values to use for the chip select pin selection and\r
266 /// control. When Chipselect is not NULL, the declaration for this data\r
267 /// structure is provided by the board layer.\r
268 ///\r
269 VOID *ChipSelectParameter;\r
270};\r
271\r
272///\r
273/// Describe the details of the board's SPI busses to the SPI driver stack.\r
274/// The board layer uses the EFI_SPI_CONFIGURATION_PROTOCOL to expose the data\r
275/// tables which describe the board's SPI busses, The SPI bus layer uses these\r
276/// tables to configure the clock, chip select and manage the SPI transactions\r
277/// on the SPI controllers.\r
278///\r
279typedef struct _EFI_SPI_CONFIGURATION_PROTOCOL {\r
280 ///\r
281 /// The number of SPI busses on the board.\r
282 ///\r
283 UINT32 BusCount;\r
284\r
285 ///\r
286 /// The address of an array of EFI_SPI_BUS data structure addresses.\r
287 ///\r
288 CONST EFI_SPI_BUS *CONST *CONST Buslist;\r
289} EFI_SPI_CONFIGURATION_PROTOCOL;\r
290\r
291extern EFI_GUID gEfiSpiConfigurationProtocolGuid;\r
292\r
293#endif // __SPI_CONFIGURATION_PROTOCOL_H__\r