Commit | Line | Data |
---|---|---|
543be3d8 WH |
1 | /* SPDX-License-Identifier: GPL-2.0 */ |
2 | /* | |
3 | * Driver Header File for FPGA Device Feature List (DFL) Support | |
4 | * | |
5 | * Copyright (C) 2017-2018 Intel Corporation, Inc. | |
6 | * | |
7 | * Authors: | |
8 | * Kang Luwei <luwei.kang@intel.com> | |
9 | * Zhang Yi <yi.z.zhang@intel.com> | |
10 | * Wu Hao <hao.wu@intel.com> | |
11 | * Xiao Guangrong <guangrong.xiao@linux.intel.com> | |
12 | */ | |
13 | ||
14 | #ifndef __FPGA_DFL_H | |
15 | #define __FPGA_DFL_H | |
16 | ||
17 | #include <linux/bitfield.h> | |
b16c5147 | 18 | #include <linux/cdev.h> |
543be3d8 | 19 | #include <linux/delay.h> |
322b598b | 20 | #include <linux/eventfd.h> |
543be3d8 | 21 | #include <linux/fs.h> |
8d021039 | 22 | #include <linux/interrupt.h> |
543be3d8 WH |
23 | #include <linux/iopoll.h> |
24 | #include <linux/io-64-nonatomic-lo-hi.h> | |
9326eecd | 25 | #include <linux/mod_devicetable.h> |
543be3d8 WH |
26 | #include <linux/platform_device.h> |
27 | #include <linux/slab.h> | |
28 | #include <linux/uuid.h> | |
29 | #include <linux/fpga/fpga-region.h> | |
30 | ||
31 | /* maximum supported number of ports */ | |
32 | #define MAX_DFL_FPGA_PORT_NUM 4 | |
33 | /* plus one for fme device */ | |
34 | #define MAX_DFL_FEATURE_DEV_NUM (MAX_DFL_FPGA_PORT_NUM + 1) | |
35 | ||
15bbb300 WH |
36 | /* Reserved 0xfe for Header Group Register and 0xff for AFU */ |
37 | #define FEATURE_ID_FIU_HEADER 0xfe | |
543be3d8 WH |
38 | #define FEATURE_ID_AFU 0xff |
39 | ||
40 | #define FME_FEATURE_ID_HEADER FEATURE_ID_FIU_HEADER | |
41 | #define FME_FEATURE_ID_THERMAL_MGMT 0x1 | |
42 | #define FME_FEATURE_ID_POWER_MGMT 0x2 | |
43 | #define FME_FEATURE_ID_GLOBAL_IPERF 0x3 | |
44 | #define FME_FEATURE_ID_GLOBAL_ERR 0x4 | |
45 | #define FME_FEATURE_ID_PR_MGMT 0x5 | |
46 | #define FME_FEATURE_ID_HSSI 0x6 | |
47 | #define FME_FEATURE_ID_GLOBAL_DPERF 0x7 | |
48 | ||
49 | #define PORT_FEATURE_ID_HEADER FEATURE_ID_FIU_HEADER | |
50 | #define PORT_FEATURE_ID_AFU FEATURE_ID_AFU | |
51 | #define PORT_FEATURE_ID_ERROR 0x10 | |
52 | #define PORT_FEATURE_ID_UMSG 0x11 | |
53 | #define PORT_FEATURE_ID_UINT 0x12 | |
54 | #define PORT_FEATURE_ID_STP 0x13 | |
55 | ||
56 | /* | |
57 | * Device Feature Header Register Set | |
58 | * | |
59 | * For FIUs, they all have DFH + GUID + NEXT_AFU as common header registers. | |
60 | * For AFUs, they have DFH + GUID as common header registers. | |
61 | * For private features, they only have DFH register as common header. | |
62 | */ | |
63 | #define DFH 0x0 | |
64 | #define GUID_L 0x8 | |
65 | #define GUID_H 0x10 | |
66 | #define NEXT_AFU 0x18 | |
67 | ||
68 | #define DFH_SIZE 0x8 | |
69 | ||
70 | /* Device Feature Header Register Bitfield */ | |
71 | #define DFH_ID GENMASK_ULL(11, 0) /* Feature ID */ | |
72 | #define DFH_ID_FIU_FME 0 | |
73 | #define DFH_ID_FIU_PORT 1 | |
74 | #define DFH_REVISION GENMASK_ULL(15, 12) /* Feature revision */ | |
75 | #define DFH_NEXT_HDR_OFST GENMASK_ULL(39, 16) /* Offset to next DFH */ | |
76 | #define DFH_EOL BIT_ULL(40) /* End of list */ | |
0926d8d5 | 77 | #define DFH_VERSION GENMASK_ULL(59, 52) /* DFH version */ |
543be3d8 WH |
78 | #define DFH_TYPE GENMASK_ULL(63, 60) /* Feature type */ |
79 | #define DFH_TYPE_AFU 1 | |
80 | #define DFH_TYPE_PRIVATE 3 | |
81 | #define DFH_TYPE_FIU 4 | |
82 | ||
0926d8d5 BAM |
83 | /* |
84 | * DFHv1 Register Offset definitons | |
85 | * In DHFv1, DFH + GUID + CSR_START + CSR_SIZE_GROUP + PARAM_HDR + PARAM_DATA | |
86 | * as common header registers | |
87 | */ | |
88 | #define DFHv1_CSR_ADDR 0x18 /* CSR Register start address */ | |
89 | #define DFHv1_CSR_SIZE_GRP 0x20 /* Size of Reg Block and Group/tag */ | |
90 | #define DFHv1_PARAM_HDR 0x28 /* Optional First Param header */ | |
91 | ||
92 | /* | |
93 | * CSR Rel Bit, 1'b0 = relative (offset from feature DFH start), | |
94 | * 1'b1 = absolute (ARM or other non-PCIe use) | |
95 | */ | |
96 | #define DFHv1_CSR_ADDR_REL BIT_ULL(0) | |
97 | ||
98 | /* CSR Header Register Bit Definitions */ | |
99 | #define DFHv1_CSR_ADDR_MASK GENMASK_ULL(63, 1) /* 63:1 of CSR address */ | |
100 | ||
101 | /* CSR SIZE Goup Register Bit Definitions */ | |
102 | #define DFHv1_CSR_SIZE_GRP_INSTANCE_ID GENMASK_ULL(15, 0) /* Enumeration instantiated IP */ | |
103 | #define DFHv1_CSR_SIZE_GRP_GROUPING_ID GENMASK_ULL(30, 16) /* Group Features/interfaces */ | |
104 | #define DFHv1_CSR_SIZE_GRP_HAS_PARAMS BIT_ULL(31) /* Presence of Parameters */ | |
105 | #define DFHv1_CSR_SIZE_GRP_SIZE GENMASK_ULL(63, 32) /* Size of CSR Block in bytes */ | |
106 | ||
107 | /* PARAM Header Register Bit Definitions */ | |
108 | #define DFHv1_PARAM_HDR_ID GENMASK_ULL(15, 0) /* Id of this Param */ | |
109 | #define DFHv1_PARAM_HDR_VER GENMASK_ULL(31, 16) /* Version Param */ | |
110 | #define DFHv1_PARAM_HDR_NEXT_OFFSET GENMASK_ULL(63, 35) /* Offset of next Param */ | |
111 | #define DFHv1_PARAM_HDR_NEXT_EOP BIT_ULL(32) | |
112 | #define DFHv1_PARAM_DATA 0x08 /* Offset of Param data from Param header */ | |
113 | ||
4747ab89 MG |
114 | #define DFHv1_PARAM_ID_MSI_X 0x1 |
115 | #define DFHv1_PARAM_MSI_X_NUMV GENMASK_ULL(63, 32) | |
116 | #define DFHv1_PARAM_MSI_X_STARTV GENMASK_ULL(31, 0) | |
117 | ||
543be3d8 WH |
118 | /* Next AFU Register Bitfield */ |
119 | #define NEXT_AFU_NEXT_DFH_OFST GENMASK_ULL(23, 0) /* Offset to next AFU */ | |
120 | ||
121 | /* FME Header Register Set */ | |
122 | #define FME_HDR_DFH DFH | |
123 | #define FME_HDR_GUID_L GUID_L | |
124 | #define FME_HDR_GUID_H GUID_H | |
125 | #define FME_HDR_NEXT_AFU NEXT_AFU | |
126 | #define FME_HDR_CAP 0x30 | |
127 | #define FME_HDR_PORT_OFST(n) (0x38 + ((n) * 0x8)) | |
ae23f746 | 128 | #define FME_PORT_OFST_BAR_SKIP 7 |
543be3d8 WH |
129 | #define FME_HDR_BITSTREAM_ID 0x60 |
130 | #define FME_HDR_BITSTREAM_MD 0x68 | |
131 | ||
132 | /* FME Fab Capability Register Bitfield */ | |
133 | #define FME_CAP_FABRIC_VERID GENMASK_ULL(7, 0) /* Fabric version ID */ | |
134 | #define FME_CAP_SOCKET_ID BIT_ULL(8) /* Socket ID */ | |
135 | #define FME_CAP_PCIE0_LINK_AVL BIT_ULL(12) /* PCIE0 Link */ | |
136 | #define FME_CAP_PCIE1_LINK_AVL BIT_ULL(13) /* PCIE1 Link */ | |
137 | #define FME_CAP_COHR_LINK_AVL BIT_ULL(14) /* Coherent Link */ | |
138 | #define FME_CAP_IOMMU_AVL BIT_ULL(16) /* IOMMU available */ | |
139 | #define FME_CAP_NUM_PORTS GENMASK_ULL(19, 17) /* Number of ports */ | |
140 | #define FME_CAP_ADDR_WIDTH GENMASK_ULL(29, 24) /* Address bus width */ | |
141 | #define FME_CAP_CACHE_SIZE GENMASK_ULL(43, 32) /* cache size in KB */ | |
142 | #define FME_CAP_CACHE_ASSOC GENMASK_ULL(47, 44) /* Associativity */ | |
143 | ||
144 | /* FME Port Offset Register Bitfield */ | |
145 | /* Offset to port device feature header */ | |
146 | #define FME_PORT_OFST_DFH_OFST GENMASK_ULL(23, 0) | |
147 | /* PCI Bar ID for this port */ | |
148 | #define FME_PORT_OFST_BAR_ID GENMASK_ULL(34, 32) | |
149 | /* AFU MMIO access permission. 1 - VF, 0 - PF. */ | |
150 | #define FME_PORT_OFST_ACC_CTRL BIT_ULL(55) | |
151 | #define FME_PORT_OFST_ACC_PF 0 | |
152 | #define FME_PORT_OFST_ACC_VF 1 | |
153 | #define FME_PORT_OFST_IMP BIT_ULL(60) | |
154 | ||
8d021039 XY |
155 | /* FME Error Capability Register */ |
156 | #define FME_ERROR_CAP 0x70 | |
157 | ||
158 | /* FME Error Capability Register Bitfield */ | |
159 | #define FME_ERROR_CAP_SUPP_INT BIT_ULL(0) /* Interrupt Support */ | |
160 | #define FME_ERROR_CAP_INT_VECT GENMASK_ULL(12, 1) /* Interrupt vector */ | |
161 | ||
543be3d8 WH |
162 | /* PORT Header Register Set */ |
163 | #define PORT_HDR_DFH DFH | |
164 | #define PORT_HDR_GUID_L GUID_L | |
165 | #define PORT_HDR_GUID_H GUID_H | |
166 | #define PORT_HDR_NEXT_AFU NEXT_AFU | |
167 | #define PORT_HDR_CAP 0x30 | |
168 | #define PORT_HDR_CTRL 0x38 | |
d2ad5ac1 | 169 | #define PORT_HDR_STS 0x40 |
f09991ad WH |
170 | #define PORT_HDR_USRCLK_CMD0 0x50 |
171 | #define PORT_HDR_USRCLK_CMD1 0x58 | |
172 | #define PORT_HDR_USRCLK_STS0 0x60 | |
173 | #define PORT_HDR_USRCLK_STS1 0x68 | |
543be3d8 WH |
174 | |
175 | /* Port Capability Register Bitfield */ | |
176 | #define PORT_CAP_PORT_NUM GENMASK_ULL(1, 0) /* ID of this port */ | |
177 | #define PORT_CAP_MMIO_SIZE GENMASK_ULL(23, 8) /* MMIO size in KB */ | |
178 | #define PORT_CAP_SUPP_INT_NUM GENMASK_ULL(35, 32) /* Interrupts num */ | |
179 | ||
180 | /* Port Control Register Bitfield */ | |
181 | #define PORT_CTRL_SFTRST BIT_ULL(0) /* Port soft reset */ | |
182 | /* Latency tolerance reporting. '1' >= 40us, '0' < 40us.*/ | |
183 | #define PORT_CTRL_LATENCY BIT_ULL(2) | |
184 | #define PORT_CTRL_SFTRST_ACK BIT_ULL(4) /* HW ack for reset */ | |
d2ad5ac1 WH |
185 | |
186 | /* Port Status Register Bitfield */ | |
187 | #define PORT_STS_AP2_EVT BIT_ULL(13) /* AP2 event detected */ | |
188 | #define PORT_STS_AP1_EVT BIT_ULL(12) /* AP1 event detected */ | |
189 | #define PORT_STS_PWR_STATE GENMASK_ULL(11, 8) /* AFU power states */ | |
190 | #define PORT_STS_PWR_STATE_NORM 0 | |
191 | #define PORT_STS_PWR_STATE_AP1 1 /* 50% throttling */ | |
192 | #define PORT_STS_PWR_STATE_AP2 2 /* 90% throttling */ | |
193 | #define PORT_STS_PWR_STATE_AP6 6 /* 100% throttling */ | |
194 | ||
8d021039 XY |
195 | /* Port Error Capability Register */ |
196 | #define PORT_ERROR_CAP 0x38 | |
197 | ||
198 | /* Port Error Capability Register Bitfield */ | |
199 | #define PORT_ERROR_CAP_SUPP_INT BIT_ULL(0) /* Interrupt Support */ | |
200 | #define PORT_ERROR_CAP_INT_VECT GENMASK_ULL(12, 1) /* Interrupt vector */ | |
201 | ||
202 | /* Port Uint Capability Register */ | |
203 | #define PORT_UINT_CAP 0x8 | |
204 | ||
205 | /* Port Uint Capability Register Bitfield */ | |
206 | #define PORT_UINT_CAP_INT_NUM GENMASK_ULL(11, 0) /* Interrupts num */ | |
207 | #define PORT_UINT_CAP_FST_VECT GENMASK_ULL(23, 12) /* First Vector */ | |
208 | ||
6e8fd6e4 WH |
209 | /** |
210 | * struct dfl_fpga_port_ops - port ops | |
211 | * | |
212 | * @name: name of this port ops, to match with port platform device. | |
213 | * @owner: pointer to the module which owns this port ops. | |
214 | * @node: node to link port ops to global list. | |
215 | * @get_id: get port id from hardware. | |
216 | * @enable_set: enable/disable the port. | |
217 | */ | |
218 | struct dfl_fpga_port_ops { | |
219 | const char *name; | |
220 | struct module *owner; | |
221 | struct list_head node; | |
222 | int (*get_id)(struct platform_device *pdev); | |
223 | int (*enable_set)(struct platform_device *pdev, bool enable); | |
224 | }; | |
225 | ||
226 | void dfl_fpga_port_ops_add(struct dfl_fpga_port_ops *ops); | |
227 | void dfl_fpga_port_ops_del(struct dfl_fpga_port_ops *ops); | |
228 | struct dfl_fpga_port_ops *dfl_fpga_port_ops_get(struct platform_device *pdev); | |
229 | void dfl_fpga_port_ops_put(struct dfl_fpga_port_ops *ops); | |
d06b004b | 230 | int dfl_fpga_check_port_id(struct platform_device *pdev, void *pport_id); |
543be3d8 | 231 | |
5b57d02a | 232 | /** |
15bbb300 | 233 | * struct dfl_feature_id - dfl private feature id |
5b57d02a | 234 | * |
15bbb300 | 235 | * @id: unique dfl private feature id. |
5b57d02a | 236 | */ |
15bbb300 | 237 | struct dfl_feature_id { |
8a5de2de | 238 | u16 id; |
15bbb300 WH |
239 | }; |
240 | ||
241 | /** | |
242 | * struct dfl_feature_driver - dfl private feature driver | |
243 | * | |
244 | * @id_table: id_table for dfl private features supported by this driver. | |
245 | * @ops: ops of this dfl private feature driver. | |
246 | */ | |
247 | struct dfl_feature_driver { | |
248 | const struct dfl_feature_id *id_table; | |
5b57d02a XG |
249 | const struct dfl_feature_ops *ops; |
250 | }; | |
251 | ||
8d021039 XY |
252 | /** |
253 | * struct dfl_feature_irq_ctx - dfl private feature interrupt context | |
254 | * | |
255 | * @irq: Linux IRQ number of this interrupt. | |
322b598b XY |
256 | * @trigger: eventfd context to signal when interrupt happens. |
257 | * @name: irq name needed when requesting irq. | |
8d021039 XY |
258 | */ |
259 | struct dfl_feature_irq_ctx { | |
260 | int irq; | |
322b598b XY |
261 | struct eventfd_ctx *trigger; |
262 | char *name; | |
8d021039 XY |
263 | }; |
264 | ||
543be3d8 WH |
265 | /** |
266 | * struct dfl_feature - sub feature of the feature devices | |
267 | * | |
322b598b | 268 | * @dev: ptr to pdev of the feature device which has the sub feature. |
543be3d8 | 269 | * @id: sub feature id. |
4747ab89 | 270 | * @revision: revisition of the instance of a feature. |
543be3d8 WH |
271 | * @resource_index: each sub feature has one mmio resource for its registers. |
272 | * this index is used to find its mmio resource from the | |
580e3137 | 273 | * feature dev (platform device)'s resources. |
543be3d8 | 274 | * @ioaddr: mapped mmio resource address. |
8d021039 XY |
275 | * @irq_ctx: interrupt context list. |
276 | * @nr_irqs: number of interrupt contexts. | |
5b57d02a | 277 | * @ops: ops of this sub feature. |
9ba3a0aa | 278 | * @ddev: ptr to the dfl device of this sub feature. |
724142f8 | 279 | * @priv: priv data of this feature. |
4747ab89 MG |
280 | * @dfh_version: version of the DFH |
281 | * @param_size: size of dfh parameters | |
282 | * @params: point to memory copy of dfh parameters | |
543be3d8 WH |
283 | */ |
284 | struct dfl_feature { | |
322b598b | 285 | struct platform_device *dev; |
8a5de2de | 286 | u16 id; |
1604986c | 287 | u8 revision; |
543be3d8 WH |
288 | int resource_index; |
289 | void __iomem *ioaddr; | |
8d021039 XY |
290 | struct dfl_feature_irq_ctx *irq_ctx; |
291 | unsigned int nr_irqs; | |
5b57d02a | 292 | const struct dfl_feature_ops *ops; |
9ba3a0aa | 293 | struct dfl_device *ddev; |
724142f8 | 294 | void *priv; |
4747ab89 MG |
295 | u8 dfh_version; |
296 | unsigned int param_size; | |
297 | void *params; | |
543be3d8 WH |
298 | }; |
299 | ||
69bb18dd WH |
300 | #define FEATURE_DEV_ID_UNUSED (-1) |
301 | ||
543be3d8 WH |
302 | /** |
303 | * struct dfl_feature_platform_data - platform data for feature devices | |
304 | * | |
305 | * @node: node to link feature devs to container device's port_dev_list. | |
306 | * @lock: mutex to protect platform data. | |
b16c5147 | 307 | * @cdev: cdev of feature dev. |
543be3d8 WH |
308 | * @dev: ptr to platform device linked with this platform data. |
309 | * @dfl_cdev: ptr to container device. | |
69bb18dd | 310 | * @id: id used for this feature device. |
543be3d8 | 311 | * @disable_count: count for port disable. |
b6862193 XY |
312 | * @excl_open: set on feature device exclusive open. |
313 | * @open_count: count for feature device open. | |
543be3d8 | 314 | * @num: number for sub features. |
5b57d02a | 315 | * @private: ptr to feature dev private data. |
543be3d8 WH |
316 | * @features: sub features of this feature dev. |
317 | */ | |
318 | struct dfl_feature_platform_data { | |
319 | struct list_head node; | |
320 | struct mutex lock; | |
b16c5147 | 321 | struct cdev cdev; |
543be3d8 WH |
322 | struct platform_device *dev; |
323 | struct dfl_fpga_cdev *dfl_cdev; | |
69bb18dd | 324 | int id; |
543be3d8 | 325 | unsigned int disable_count; |
b6862193 XY |
326 | bool excl_open; |
327 | int open_count; | |
5b57d02a | 328 | void *private; |
543be3d8 | 329 | int num; |
5a538815 | 330 | struct dfl_feature features[]; |
543be3d8 WH |
331 | }; |
332 | ||
5b57d02a | 333 | static inline |
b6862193 XY |
334 | int dfl_feature_dev_use_begin(struct dfl_feature_platform_data *pdata, |
335 | bool excl) | |
5b57d02a | 336 | { |
b6862193 | 337 | if (pdata->excl_open) |
5b57d02a XG |
338 | return -EBUSY; |
339 | ||
b6862193 XY |
340 | if (excl) { |
341 | if (pdata->open_count) | |
342 | return -EBUSY; | |
343 | ||
344 | pdata->excl_open = true; | |
345 | } | |
346 | pdata->open_count++; | |
347 | ||
5b57d02a XG |
348 | return 0; |
349 | } | |
350 | ||
351 | static inline | |
352 | void dfl_feature_dev_use_end(struct dfl_feature_platform_data *pdata) | |
353 | { | |
b6862193 XY |
354 | pdata->excl_open = false; |
355 | ||
356 | if (WARN_ON(pdata->open_count <= 0)) | |
357 | return; | |
358 | ||
359 | pdata->open_count--; | |
360 | } | |
361 | ||
362 | static inline | |
363 | int dfl_feature_dev_use_count(struct dfl_feature_platform_data *pdata) | |
364 | { | |
365 | return pdata->open_count; | |
5b57d02a XG |
366 | } |
367 | ||
368 | static inline | |
369 | void dfl_fpga_pdata_set_private(struct dfl_feature_platform_data *pdata, | |
370 | void *private) | |
371 | { | |
372 | pdata->private = private; | |
373 | } | |
374 | ||
375 | static inline | |
376 | void *dfl_fpga_pdata_get_private(struct dfl_feature_platform_data *pdata) | |
377 | { | |
378 | return pdata->private; | |
379 | } | |
380 | ||
381 | struct dfl_feature_ops { | |
382 | int (*init)(struct platform_device *pdev, struct dfl_feature *feature); | |
383 | void (*uinit)(struct platform_device *pdev, | |
384 | struct dfl_feature *feature); | |
385 | long (*ioctl)(struct platform_device *pdev, struct dfl_feature *feature, | |
386 | unsigned int cmd, unsigned long arg); | |
387 | }; | |
388 | ||
543be3d8 WH |
389 | #define DFL_FPGA_FEATURE_DEV_FME "dfl-fme" |
390 | #define DFL_FPGA_FEATURE_DEV_PORT "dfl-port" | |
391 | ||
5b57d02a XG |
392 | void dfl_fpga_dev_feature_uinit(struct platform_device *pdev); |
393 | int dfl_fpga_dev_feature_init(struct platform_device *pdev, | |
394 | struct dfl_feature_driver *feature_drvs); | |
395 | ||
b16c5147 WH |
396 | int dfl_fpga_dev_ops_register(struct platform_device *pdev, |
397 | const struct file_operations *fops, | |
398 | struct module *owner); | |
399 | void dfl_fpga_dev_ops_unregister(struct platform_device *pdev); | |
400 | ||
5b57d02a XG |
401 | static inline |
402 | struct platform_device *dfl_fpga_inode_to_feature_dev(struct inode *inode) | |
403 | { | |
404 | struct dfl_feature_platform_data *pdata; | |
405 | ||
406 | pdata = container_of(inode->i_cdev, struct dfl_feature_platform_data, | |
407 | cdev); | |
408 | return pdata->dev; | |
409 | } | |
410 | ||
543be3d8 WH |
411 | #define dfl_fpga_dev_for_each_feature(pdata, feature) \ |
412 | for ((feature) = (pdata)->features; \ | |
413 | (feature) < (pdata)->features + (pdata)->num; (feature)++) | |
414 | ||
415 | static inline | |
8a5de2de | 416 | struct dfl_feature *dfl_get_feature_by_id(struct device *dev, u16 id) |
543be3d8 WH |
417 | { |
418 | struct dfl_feature_platform_data *pdata = dev_get_platdata(dev); | |
419 | struct dfl_feature *feature; | |
420 | ||
421 | dfl_fpga_dev_for_each_feature(pdata, feature) | |
422 | if (feature->id == id) | |
423 | return feature; | |
424 | ||
425 | return NULL; | |
426 | } | |
427 | ||
428 | static inline | |
8a5de2de | 429 | void __iomem *dfl_get_feature_ioaddr_by_id(struct device *dev, u16 id) |
543be3d8 WH |
430 | { |
431 | struct dfl_feature *feature = dfl_get_feature_by_id(dev, id); | |
432 | ||
433 | if (feature && feature->ioaddr) | |
434 | return feature->ioaddr; | |
435 | ||
436 | WARN_ON(1); | |
437 | return NULL; | |
438 | } | |
439 | ||
8a5de2de | 440 | static inline bool is_dfl_feature_present(struct device *dev, u16 id) |
5b57d02a XG |
441 | { |
442 | return !!dfl_get_feature_ioaddr_by_id(dev, id); | |
443 | } | |
444 | ||
445 | static inline | |
446 | struct device *dfl_fpga_pdata_to_parent(struct dfl_feature_platform_data *pdata) | |
447 | { | |
448 | return pdata->dev->dev.parent->parent; | |
449 | } | |
450 | ||
543be3d8 WH |
451 | static inline bool dfl_feature_is_fme(void __iomem *base) |
452 | { | |
453 | u64 v = readq(base + DFH); | |
454 | ||
455 | return (FIELD_GET(DFH_TYPE, v) == DFH_TYPE_FIU) && | |
456 | (FIELD_GET(DFH_ID, v) == DFH_ID_FIU_FME); | |
457 | } | |
458 | ||
459 | static inline bool dfl_feature_is_port(void __iomem *base) | |
460 | { | |
461 | u64 v = readq(base + DFH); | |
462 | ||
463 | return (FIELD_GET(DFH_TYPE, v) == DFH_TYPE_FIU) && | |
464 | (FIELD_GET(DFH_ID, v) == DFH_ID_FIU_PORT); | |
465 | } | |
466 | ||
f09991ad WH |
467 | static inline u8 dfl_feature_revision(void __iomem *base) |
468 | { | |
469 | return (u8)FIELD_GET(DFH_REVISION, readq(base + DFH)); | |
470 | } | |
471 | ||
543be3d8 WH |
472 | /** |
473 | * struct dfl_fpga_enum_info - DFL FPGA enumeration information | |
474 | * | |
475 | * @dev: parent device. | |
476 | * @dfls: list of device feature lists. | |
8d021039 XY |
477 | * @nr_irqs: number of irqs for all feature devices. |
478 | * @irq_table: Linux IRQ numbers for all irqs, indexed by hw irq numbers. | |
543be3d8 WH |
479 | */ |
480 | struct dfl_fpga_enum_info { | |
481 | struct device *dev; | |
482 | struct list_head dfls; | |
8d021039 XY |
483 | unsigned int nr_irqs; |
484 | int *irq_table; | |
543be3d8 WH |
485 | }; |
486 | ||
487 | /** | |
488 | * struct dfl_fpga_enum_dfl - DFL FPGA enumeration device feature list info | |
489 | * | |
490 | * @start: base address of this device feature list. | |
491 | * @len: size of this device feature list. | |
543be3d8 WH |
492 | * @node: node in list of device feature lists. |
493 | */ | |
494 | struct dfl_fpga_enum_dfl { | |
495 | resource_size_t start; | |
496 | resource_size_t len; | |
543be3d8 WH |
497 | struct list_head node; |
498 | }; | |
499 | ||
500 | struct dfl_fpga_enum_info *dfl_fpga_enum_info_alloc(struct device *dev); | |
501 | int dfl_fpga_enum_info_add_dfl(struct dfl_fpga_enum_info *info, | |
89eb35e8 | 502 | resource_size_t start, resource_size_t len); |
8d021039 XY |
503 | int dfl_fpga_enum_info_add_irq(struct dfl_fpga_enum_info *info, |
504 | unsigned int nr_irqs, int *irq_table); | |
543be3d8 WH |
505 | void dfl_fpga_enum_info_free(struct dfl_fpga_enum_info *info); |
506 | ||
507 | /** | |
508 | * struct dfl_fpga_cdev - container device of DFL based FPGA | |
509 | * | |
510 | * @parent: parent device of this container device. | |
511 | * @region: base fpga region. | |
512 | * @fme_dev: FME feature device under this container device. | |
513 | * @lock: mutex lock to protect the port device list. | |
514 | * @port_dev_list: list of all port feature devices under this container device. | |
69bb18dd | 515 | * @released_port_num: released port number under this container device. |
543be3d8 WH |
516 | */ |
517 | struct dfl_fpga_cdev { | |
518 | struct device *parent; | |
519 | struct fpga_region *region; | |
520 | struct device *fme_dev; | |
521 | struct mutex lock; | |
522 | struct list_head port_dev_list; | |
69bb18dd | 523 | int released_port_num; |
543be3d8 WH |
524 | }; |
525 | ||
526 | struct dfl_fpga_cdev * | |
527 | dfl_fpga_feature_devs_enumerate(struct dfl_fpga_enum_info *info); | |
528 | void dfl_fpga_feature_devs_remove(struct dfl_fpga_cdev *cdev); | |
529 | ||
5d56e117 WH |
530 | /* |
531 | * need to drop the device reference with put_device() after use port platform | |
532 | * device returned by __dfl_fpga_cdev_find_port and dfl_fpga_cdev_find_port | |
533 | * functions. | |
534 | */ | |
535 | struct platform_device * | |
536 | __dfl_fpga_cdev_find_port(struct dfl_fpga_cdev *cdev, void *data, | |
537 | int (*match)(struct platform_device *, void *)); | |
538 | ||
539 | static inline struct platform_device * | |
540 | dfl_fpga_cdev_find_port(struct dfl_fpga_cdev *cdev, void *data, | |
541 | int (*match)(struct platform_device *, void *)) | |
542 | { | |
543 | struct platform_device *pdev; | |
544 | ||
545 | mutex_lock(&cdev->lock); | |
546 | pdev = __dfl_fpga_cdev_find_port(cdev, data, match); | |
547 | mutex_unlock(&cdev->lock); | |
548 | ||
549 | return pdev; | |
550 | } | |
69bb18dd WH |
551 | |
552 | int dfl_fpga_cdev_release_port(struct dfl_fpga_cdev *cdev, int port_id); | |
553 | int dfl_fpga_cdev_assign_port(struct dfl_fpga_cdev *cdev, int port_id); | |
bdd4f307 WH |
554 | void dfl_fpga_cdev_config_ports_pf(struct dfl_fpga_cdev *cdev); |
555 | int dfl_fpga_cdev_config_ports_vf(struct dfl_fpga_cdev *cdev, int num_vf); | |
322b598b XY |
556 | int dfl_fpga_set_irq_triggers(struct dfl_feature *feature, unsigned int start, |
557 | unsigned int count, int32_t *fds); | |
558 | long dfl_feature_ioctl_get_num_irqs(struct platform_device *pdev, | |
559 | struct dfl_feature *feature, | |
560 | unsigned long arg); | |
561 | long dfl_feature_ioctl_set_irq(struct platform_device *pdev, | |
562 | struct dfl_feature *feature, | |
563 | unsigned long arg); | |
564 | ||
543be3d8 | 565 | #endif /* __FPGA_DFL_H */ |