summaryrefslogtreecommitdiffstats
path: root/drivers/pci/pci-efi.h
blob: 1dba0b9906f917cee9783a45ec2b069d7ef8c0ff (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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
// SPDX-License-Identifier: GPL-2.0-only
#ifndef __PCI_EFI_H_
#define __PCI_EFI_H_

#include <efi.h>

struct efi_pci_root_bridge_io_protocol;
struct efi_pci_io_protocol;

enum efi_pci_protocol_width {
	EFI_PCI_WIDTH_U8,
	EFI_PCI_WIDTH_U16,
	EFI_PCI_WIDTH_U32,
	EFI_PCI_WIDTH_U64,
	EFI_PCI_WIDTH_FIFO_U8,
	EFI_PCI_WIDTH_FIFO_U16,
	EFI_PCI_WIDTH_FIFO_U32,
	EFI_PCI_WIDTH_FIFO_U64,
	EFI_PCI_WIDTH_FILL_U8,
	EFI_PCI_WIDTH_FILL_U16,
	EFI_PCI_WIDTH_FILL_U32,
	EFI_PCI_WIDTH_FILL_U64,
	EFI_PCI_WIDTH_MAX
};

#define EFI_PCI_IO_PASS_THROUGH_BAR	0xff

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_io_mem) (
	struct efi_pci_root_bridge_io_protocol *this,
	enum efi_pci_protocol_width width,
	u64 addr,
	size_t count,
	void *buf
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_io_mem) (
	struct efi_pci_io_protocol *this,
	enum efi_pci_protocol_width width,
	u8 bar,
	u64 offset,
	size_t count,
	void *buf
);

struct efi_pci_root_bridge_io_protocol_access {
	efi_pci_root_bridge_io_protocol_io_mem read;
	efi_pci_root_bridge_io_protocol_io_mem write;
};

struct efi_pci_io_protocol_access {
	efi_pci_io_protocol_io_mem read;
	efi_pci_io_protocol_io_mem write;
};

#define EFI_PCI_ATTRIBUTE_ISA_MOTHERBOARD_IO   0x0001
#define EFI_PCI_ATTRIBUTE_ISA_IO               0x0002
#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO       0x0004
#define EFI_PCI_ATTRIBUTE_VGA_MEMORY           0x0008
#define EFI_PCI_ATTRIBUTE_VGA_IO               0x0010
#define EFI_PCI_ATTRIBUTE_IDE_PRIMARY_IO       0x0020
#define EFI_PCI_ATTRIBUTE_IDE_SECONDARY_IO     0x0040
#define EFI_PCI_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
#define EFI_PCI_ATTRIBUTE_IO                   0x0100
#define EFI_PCI_ATTRIBUTE_MEMORY               0x0200
#define EFI_PCI_ATTRIBUTE_BUS_MASTER           0x0400
#define EFI_PCI_ATTRIBUTE_MEMORY_CACHED        0x0800
#define EFI_PCI_ATTRIBUTE_MEMORY_DISABLE       0x1000
#define EFI_PCI_ATTRIBUTE_EMBEDDED_DEVICE      0x2000
#define EFI_PCI_ATTRIBUTE_EMBEDDED_ROM         0x4000
#define EFI_PCI_ATTRIBUTE_DUAL_ADDRESS_CYCLE   0x8000
#define EFI_PCI_ATTRIBUTE_ISA_IO_16            0x10000
#define EFI_PCI_ATTRIBUTE_VGA_PALETTE_IO_16    0x20000
#define EFI_PCI_ATTRIBUTE_VGA_IO_16            0x40000

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_poll_io_mem) (
	struct efi_pci_root_bridge_io_protocol	*this,
	enum efi_pci_protocol_width width,
	u64 address,
	u64 mask,
	u64 value,
	u64 delay,
	u64 *result
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_poll_io_mem) (
	struct efi_pci_io_protocol	*this,
	enum efi_pci_protocol_width width,
	u8 bar,
	u64 offset,
	u64 mask,
	u64 value,
	u64 delay,
	u64 *result
);

enum efi_pci_root_bridge_io_protocol_operation {
	EFI_PCI_ROOT_BRIGE_IO_OP_BUS_MASTER_READ,
	EFI_PCI_ROOT_BRIGE_IO_OP_BUS_MASTER_WRITE,
	EFI_PCI_ROOT_BRIGE_IO_OP_BUS_MASTER_COMMON_BUFFER,
	EFI_PCI_ROOT_BRIGE_IO_OP_BUS_MASTER_READ64,
	EFI_PCI_ROOT_BRIGE_IO_OP_BUS_MASTER_WRITE64,
	EFI_PCI_ROOT_BRIGE_IO_OP_BUS_MASTER_COMMON_BUFFER64,
	EFI_PCI_ROOT_BRIGE_IO_OP_MAX
};

enum efi_pci_io_protocol_operation {
	EFI_PCI_IO_OP_BUS_MASTER_READ,
	EFI_PCI_IO_OP_BUS_MASTER_WRITE,
	EFI_PCI_IO_OP_BUS_MASTER_COMMON_BUFFER,
	EFI_PCI_IO_OP_MAX
};

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_copy_mem) (
	struct efi_pci_root_bridge_io_protocol *this,
	enum efi_pci_protocol_width width,
	u64 dst,
	u64 src,
	size_t count
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_copy_mem) (
	struct efi_pci_io_protocol *this,
	enum efi_pci_protocol_width width,
	u8 dst_bar,
	u64 dst_offset,
	u8 src_bar,
	u64 src_offset,
	size_t count
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_map) (
	struct efi_pci_root_bridge_io_protocol *this,
	enum efi_pci_root_bridge_io_protocol_operation operation,
	void *hostaddr,
	size_t *nbytes,
	efi_physical_addr_t *devaddr,
	void **mapping
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_map) (
	struct efi_pci_io_protocol *this,
	enum efi_pci_io_protocol_operation operation,
	void *hostaddr,
	size_t *nbytes,
	efi_physical_addr_t *devaddr,
	void **mapping
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_unmap) (
	struct efi_pci_root_bridge_io_protocol *this,
	void *mapping
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_unmap) (
	struct efi_pci_io_protocol *this,
	void *mapping
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_allocate_buffer) (
	struct efi_pci_root_bridge_io_protocol *this,
	enum efi_allocate_type alloctype,
	enum efi_memory_type memtype,
	size_t npages,
	void **hostaddr,
	u64 attrs
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_allocate_buffer) (
	struct efi_pci_io_protocol *this,
	enum efi_allocate_type alloctype,
	enum efi_memory_type memtype,
	size_t npages,
	void **hostaddr,
	u64 attrs
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_free_buffer) (
	struct efi_pci_root_bridge_io_protocol *this,
	size_t npages,
	void *hostaddr
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_free_buffer) (
	struct efi_pci_io_protocol *this,
	size_t npages,
	void *hostaddr
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_flush) (
	struct efi_pci_root_bridge_io_protocol *this
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_flush) (
	struct efi_pci_io_protocol *this
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_get_location) (
	struct efi_pci_io_protocol *this,
	size_t *segmentno,
	size_t *busno,
	size_t *deveno,
	size_t *funcno
);

enum efi_io_protocol_attribute_operation {
	PCI_IO_ATTR_OP_GET,
	PCI_IO_ATTR_OP_SET,
	PCI_IO_ATTR_OP_ENABLE,
	PCI_IO_ATTR_OP_DISABLE,
	PCI_IO_ATTR_OP_SUPPORTED,
	PCI_IO_ATTR_OP_MAX,
};

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_attributes) (
	struct efi_pci_io_protocol *this,
	enum efi_io_protocol_attribute_operation operation,
	u64 attrs,
	u64 *result
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_get_attributes) (
	struct efi_pci_root_bridge_io_protocol *this,
	u64 *supports,
	u64 *attrs
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_get_bar_attributes) (
	struct efi_pci_io_protocol *this,
	u8 bar,
	u64 *supports,
	void **resources
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_set_attributes) (
	struct efi_pci_root_bridge_io_protocol *this,
	u64 attrs,
	u64 *resource_base,
	u64 *resource_len
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_set_bar_attributes) (
	struct efi_pci_io_protocol *this,
	u64 attrs,
	u8 bar,
	u64 *offset,
	u64 *len
);

typedef efi_status_t (EFIAPI *efi_pci_root_bridge_io_protocol_configuration) (
	struct efi_pci_root_bridge_io_protocol *this,
	void **resources
);

typedef efi_status_t (EFIAPI *efi_pci_io_protocol_config) (
	struct efi_pci_io_protocol *this,
	enum efi_pci_protocol_width width,
	u32 offset,
	size_t count,
	void *buffer
);

struct efi_pci_io_protocol_config_access {
	efi_pci_io_protocol_config read;
	efi_pci_io_protocol_config write;
};

struct __packed efi_acpi_resource {
#define	ACPI_RESOURCE_DESC_TAG	0x8A
#define	ACPI_RESOURCE_END_TAG	0x79
	u8 asd; /* 0x8A */
	u16 len; /* 0x2B */
#define	ACPI_RESOURCE_TYPE_MEM		0
#define	ACPI_RESOURCE_TYPE_IO		1
#define	ACPI_RESOURCE_TYPE_BUSNO	2
	u8 restype;
	u8 genflags;
#define	ACPI_RESOURCE_TYPFLAG_TTP_MASK	0b00100000
#define	ACPI_RESOURCE_TYPFLAG_MTP_MASK	0b00011000
#define		ACPI_RESOURCE_TYPFLAG_MTP_MEM		0
#define		ACPI_RESOURCE_TYPFLAG_MTP_RESERVED	1
#define		ACPI_RESOURCE_TYPFLAG_MTP_ACPI		2
#define		ACPI_RESOURCE_TYPFLAG_MTP_NVS		3
#define	ACPI_RESOURCE_TYPFLAG_MEM_MASK	0b00000110
#define		ACPI_RESOURCE_TYPFLAG_MEM_NONCACHEABLE	0
#define		ACPI_RESOURCE_TYPFLAG_MEM_CACHEABLE	1
#define		ACPI_RESOURCE_TYPFLAG_MEM_WC		2
#define		ACPI_RESOURCE_TYPFLAG_MEM_PREF		3
#define	ACPI_RESOURCE_TYPFLAG_RW_MASK	0b00000001
	u8 typflags;
	u64 addr_granularity;
	u64 addr_min;
	u64 addr_max;
	u64 addr_xlate_off;
	u64 addr_len;
};

struct efi_pci_root_bridge_io_protocol {
	efi_handle_t					parent_handle;
	efi_pci_root_bridge_io_protocol_poll_io_mem	poll_mem;
	efi_pci_root_bridge_io_protocol_poll_io_mem	poll_io;
	struct efi_pci_root_bridge_io_protocol_access	mem;
	struct efi_pci_root_bridge_io_protocol_access	io;
	struct efi_pci_root_bridge_io_protocol_access	pci;
	efi_pci_root_bridge_io_protocol_copy_mem	copy_mem;
	efi_pci_root_bridge_io_protocol_map		map;
	efi_pci_root_bridge_io_protocol_unmap		unmap;
	efi_pci_root_bridge_io_protocol_allocate_buffer	allocate_buffer;
	efi_pci_root_bridge_io_protocol_free_buffer	free_buffer;
	efi_pci_root_bridge_io_protocol_flush		flush;
	efi_pci_root_bridge_io_protocol_get_attributes	get_attributes;
	efi_pci_root_bridge_io_protocol_set_attributes	set_attributes;
	efi_pci_root_bridge_io_protocol_configuration	configuration;
	u32						segmentno;
};

struct efi_pci_io_protocol {
	efi_pci_io_protocol_poll_io_mem		poll_mem;
	efi_pci_io_protocol_poll_io_mem		poll_io;
	struct efi_pci_io_protocol_access	mem;
	struct efi_pci_io_protocol_access	io;
	struct efi_pci_io_protocol_access	pci;
	efi_pci_io_protocol_copy_mem		copy_mem;
	efi_pci_io_protocol_map			map;
	efi_pci_io_protocol_unmap		unmap;
	efi_pci_io_protocol_allocate_buffer	allocate_buffer;
	efi_pci_io_protocol_free_buffer		free_buffer;
	efi_pci_io_protocol_flush		flush;
	efi_pci_io_protocol_get_location	get_location;
	efi_pci_io_protocol_attributes		attributes;
	efi_pci_io_protocol_get_bar_attributes	get_bar_attributes;
	efi_pci_io_protocol_set_bar_attributes	set_bar_attributes;
	u64					rom_size;
	void					*rom_image;
};

#define EFI_PCI_ADDRESS(bus, dev, func, reg) \
  (u64) ( \
  (((size_t) bus) << 24) | \
  (((size_t) dev) << 16) | \
  (((size_t) func) << 8) | \
  (((size_t) (reg)) < 256 ? ((size_t) (reg)) : ((u64)(reg)) << 32))

#endif