]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/pci/ats.c
clk: renesas: Add CPG core wrapper for RZ/G2L SoC
[mirror_ubuntu-jammy-kernel.git] / drivers / pci / ats.c
CommitLineData
7328c8f4 1// SPDX-License-Identifier: GPL-2.0
db3c33c6 2/*
df62ab5e 3 * PCI Express I/O Virtualization (IOV) support
db3c33c6 4 * Address Translation Service 1.0
c320b976 5 * Page Request Interface added by Joerg Roedel <joerg.roedel@amd.com>
086ac11f 6 * PASID support added by Joerg Roedel <joerg.roedel@amd.com>
df62ab5e
BH
7 *
8 * Copyright (C) 2009 Intel Corporation, Yu Zhao <yu.zhao@intel.com>
9 * Copyright (C) 2011 Advanced Micro Devices,
db3c33c6
JR
10 */
11
363c75db 12#include <linux/export.h>
db3c33c6
JR
13#include <linux/pci-ats.h>
14#include <linux/pci.h>
8c451945 15#include <linux/slab.h>
db3c33c6
JR
16
17#include "pci.h"
18
afdd596c 19void pci_ats_init(struct pci_dev *dev)
db3c33c6
JR
20{
21 int pos;
db3c33c6 22
cef74409
GK
23 if (pci_ats_disabled())
24 return;
25
db3c33c6
JR
26 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ATS);
27 if (!pos)
edc90fee 28 return;
db3c33c6 29
d544d75a 30 dev->ats_cap = pos;
db3c33c6
JR
31}
32
52137674
JPB
33/**
34 * pci_ats_supported - check if the device can use ATS
35 * @dev: the PCI device
36 *
37 * Returns true if the device supports ATS and is allowed to use it, false
38 * otherwise.
39 */
40bool pci_ats_supported(struct pci_dev *dev)
41{
42 if (!dev->ats_cap)
43 return false;
44
45 return (dev->untrusted == 0);
46}
47EXPORT_SYMBOL_GPL(pci_ats_supported);
48
db3c33c6
JR
49/**
50 * pci_enable_ats - enable the ATS capability
51 * @dev: the PCI device
52 * @ps: the IOMMU page shift
53 *
54 * Returns 0 on success, or negative on failure.
55 */
56int pci_enable_ats(struct pci_dev *dev, int ps)
57{
db3c33c6 58 u16 ctrl;
c39127db 59 struct pci_dev *pdev;
db3c33c6 60
52137674 61 if (!pci_ats_supported(dev))
edc90fee
BH
62 return -EINVAL;
63
f7ef1340 64 if (WARN_ON(dev->ats_enabled))
a021f301
BH
65 return -EBUSY;
66
db3c33c6
JR
67 if (ps < PCI_ATS_MIN_STU)
68 return -EINVAL;
69
edc90fee
BH
70 /*
71 * Note that enabling ATS on a VF fails unless it's already enabled
72 * with the same STU on the PF.
73 */
74 ctrl = PCI_ATS_CTRL_ENABLE;
75 if (dev->is_virtfn) {
c39127db 76 pdev = pci_physfn(dev);
d544d75a 77 if (pdev->ats_stu != ps)
edc90fee 78 return -EINVAL;
edc90fee 79 } else {
d544d75a
BH
80 dev->ats_stu = ps;
81 ctrl |= PCI_ATS_CTRL_STU(dev->ats_stu - PCI_ATS_MIN_STU);
db3c33c6 82 }
d544d75a 83 pci_write_config_word(dev, dev->ats_cap + PCI_ATS_CTRL, ctrl);
db3c33c6 84
d544d75a 85 dev->ats_enabled = 1;
db3c33c6
JR
86 return 0;
87}
bb950bca 88EXPORT_SYMBOL_GPL(pci_enable_ats);
db3c33c6
JR
89
90/**
91 * pci_disable_ats - disable the ATS capability
92 * @dev: the PCI device
93 */
94void pci_disable_ats(struct pci_dev *dev)
95{
96 u16 ctrl;
97
f7ef1340 98 if (WARN_ON(!dev->ats_enabled))
a021f301 99 return;
db3c33c6 100
d544d75a 101 pci_read_config_word(dev, dev->ats_cap + PCI_ATS_CTRL, &ctrl);
db3c33c6 102 ctrl &= ~PCI_ATS_CTRL_ENABLE;
d544d75a 103 pci_write_config_word(dev, dev->ats_cap + PCI_ATS_CTRL, ctrl);
db3c33c6 104
d544d75a 105 dev->ats_enabled = 0;
db3c33c6 106}
bb950bca 107EXPORT_SYMBOL_GPL(pci_disable_ats);
db3c33c6 108
1900ca13
HX
109void pci_restore_ats_state(struct pci_dev *dev)
110{
111 u16 ctrl;
112
f7ef1340 113 if (!dev->ats_enabled)
1900ca13 114 return;
1900ca13
HX
115
116 ctrl = PCI_ATS_CTRL_ENABLE;
117 if (!dev->is_virtfn)
d544d75a
BH
118 ctrl |= PCI_ATS_CTRL_STU(dev->ats_stu - PCI_ATS_MIN_STU);
119 pci_write_config_word(dev, dev->ats_cap + PCI_ATS_CTRL, ctrl);
1900ca13 120}
1900ca13 121
db3c33c6
JR
122/**
123 * pci_ats_queue_depth - query the ATS Invalidate Queue Depth
124 * @dev: the PCI device
125 *
126 * Returns the queue depth on success, or negative on failure.
127 *
128 * The ATS spec uses 0 in the Invalidate Queue Depth field to
129 * indicate that the function can accept 32 Invalidate Request.
130 * But here we use the `real' values (i.e. 1~32) for the Queue
131 * Depth; and 0 indicates the function shares the Queue with
132 * other functions (doesn't exclusively own a Queue).
133 */
134int pci_ats_queue_depth(struct pci_dev *dev)
135{
a71f938f
BH
136 u16 cap;
137
3c765399
BH
138 if (!dev->ats_cap)
139 return -EINVAL;
140
db3c33c6
JR
141 if (dev->is_virtfn)
142 return 0;
143
a71f938f
BH
144 pci_read_config_word(dev, dev->ats_cap + PCI_ATS_CAP, &cap);
145 return PCI_ATS_CAP_QDEP(cap) ? PCI_ATS_CAP_QDEP(cap) : PCI_ATS_MAX_QDEP;
db3c33c6 146}
c320b976 147
8c938ddc
KS
148/**
149 * pci_ats_page_aligned - Return Page Aligned Request bit status.
150 * @pdev: the PCI device
151 *
152 * Returns 1, if the Untranslated Addresses generated by the device
153 * are always aligned or 0 otherwise.
154 *
155 * Per PCIe spec r4.0, sec 10.5.1.2, if the Page Aligned Request bit
156 * is set, it indicates the Untranslated Addresses generated by the
157 * device are always aligned to a 4096 byte boundary.
158 */
159int pci_ats_page_aligned(struct pci_dev *pdev)
160{
161 u16 cap;
162
163 if (!pdev->ats_cap)
164 return 0;
165
166 pci_read_config_word(pdev, pdev->ats_cap + PCI_ATS_CAP, &cap);
167
168 if (cap & PCI_ATS_CAP_PAGE_ALIGNED)
169 return 1;
170
171 return 0;
172}
8c938ddc 173
c320b976 174#ifdef CONFIG_PCI_PRI
c065190b
KS
175void pci_pri_init(struct pci_dev *pdev)
176{
e5adf79a
BH
177 u16 status;
178
c065190b 179 pdev->pri_cap = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_PRI);
e5adf79a
BH
180
181 if (!pdev->pri_cap)
182 return;
183
184 pci_read_config_word(pdev, pdev->pri_cap + PCI_PRI_STATUS, &status);
185 if (status & PCI_PRI_STATUS_PASID)
186 pdev->pasid_required = 1;
c065190b
KS
187}
188
c320b976
JR
189/**
190 * pci_enable_pri - Enable PRI capability
9b41d19a
KK
191 * @pdev: PCI device structure
192 * @reqs: outstanding requests
c320b976
JR
193 *
194 * Returns 0 on success, negative value on error
195 */
196int pci_enable_pri(struct pci_dev *pdev, u32 reqs)
197{
198 u16 control, status;
199 u32 max_requests;
c065190b 200 int pri = pdev->pri_cap;
c320b976 201
9bf49e36
KS
202 /*
203 * VFs must not implement the PRI Capability. If their PF
204 * implements PRI, it is shared by the VFs, so if the PF PRI is
205 * enabled, it is also enabled for the VF.
206 */
207 if (pdev->is_virtfn) {
208 if (pci_physfn(pdev)->pri_enabled)
209 return 0;
210 return -EINVAL;
211 }
212
a4f4fa68
JPB
213 if (WARN_ON(pdev->pri_enabled))
214 return -EBUSY;
215
c065190b 216 if (!pri)
c320b976
JR
217 return -EINVAL;
218
c065190b 219 pci_read_config_word(pdev, pri + PCI_PRI_STATUS, &status);
4ebeb1ec 220 if (!(status & PCI_PRI_STATUS_STOPPED))
c320b976
JR
221 return -EBUSY;
222
c065190b 223 pci_read_config_dword(pdev, pri + PCI_PRI_MAX_REQ, &max_requests);
c320b976 224 reqs = min(max_requests, reqs);
4ebeb1ec 225 pdev->pri_reqs_alloc = reqs;
c065190b 226 pci_write_config_dword(pdev, pri + PCI_PRI_ALLOC_REQ, reqs);
c320b976 227
4ebeb1ec 228 control = PCI_PRI_CTRL_ENABLE;
c065190b 229 pci_write_config_word(pdev, pri + PCI_PRI_CTRL, control);
c320b976 230
a4f4fa68
JPB
231 pdev->pri_enabled = 1;
232
c320b976
JR
233 return 0;
234}
c320b976
JR
235
236/**
237 * pci_disable_pri - Disable PRI capability
238 * @pdev: PCI device structure
239 *
240 * Only clears the enabled-bit, regardless of its former value
241 */
242void pci_disable_pri(struct pci_dev *pdev)
243{
244 u16 control;
c065190b 245 int pri = pdev->pri_cap;
c320b976 246
9bf49e36
KS
247 /* VFs share the PF PRI */
248 if (pdev->is_virtfn)
249 return;
250
a4f4fa68
JPB
251 if (WARN_ON(!pdev->pri_enabled))
252 return;
253
c065190b 254 if (!pri)
c320b976
JR
255 return;
256
c065190b 257 pci_read_config_word(pdev, pri + PCI_PRI_CTRL, &control);
91f57d5e 258 control &= ~PCI_PRI_CTRL_ENABLE;
c065190b 259 pci_write_config_word(pdev, pri + PCI_PRI_CTRL, control);
a4f4fa68
JPB
260
261 pdev->pri_enabled = 0;
c320b976
JR
262}
263EXPORT_SYMBOL_GPL(pci_disable_pri);
264
4ebeb1ec
CT
265/**
266 * pci_restore_pri_state - Restore PRI
267 * @pdev: PCI device structure
268 */
269void pci_restore_pri_state(struct pci_dev *pdev)
270{
271 u16 control = PCI_PRI_CTRL_ENABLE;
272 u32 reqs = pdev->pri_reqs_alloc;
c065190b 273 int pri = pdev->pri_cap;
4ebeb1ec 274
9bf49e36
KS
275 if (pdev->is_virtfn)
276 return;
277
4ebeb1ec
CT
278 if (!pdev->pri_enabled)
279 return;
280
c065190b 281 if (!pri)
4ebeb1ec
CT
282 return;
283
c065190b
KS
284 pci_write_config_dword(pdev, pri + PCI_PRI_ALLOC_REQ, reqs);
285 pci_write_config_word(pdev, pri + PCI_PRI_CTRL, control);
4ebeb1ec 286}
4ebeb1ec 287
c320b976
JR
288/**
289 * pci_reset_pri - Resets device's PRI state
290 * @pdev: PCI device structure
291 *
292 * The PRI capability must be disabled before this function is called.
293 * Returns 0 on success, negative value on error.
294 */
295int pci_reset_pri(struct pci_dev *pdev)
296{
297 u16 control;
c065190b 298 int pri = pdev->pri_cap;
c320b976 299
9bf49e36
KS
300 if (pdev->is_virtfn)
301 return 0;
302
a4f4fa68
JPB
303 if (WARN_ON(pdev->pri_enabled))
304 return -EBUSY;
305
c065190b 306 if (!pri)
c320b976
JR
307 return -EINVAL;
308
4ebeb1ec 309 control = PCI_PRI_CTRL_RESET;
c065190b 310 pci_write_config_word(pdev, pri + PCI_PRI_CTRL, control);
c320b976
JR
311
312 return 0;
313}
8cbb8a93
BH
314
315/**
316 * pci_prg_resp_pasid_required - Return PRG Response PASID Required bit
317 * status.
318 * @pdev: PCI device structure
319 *
320 * Returns 1 if PASID is required in PRG Response Message, 0 otherwise.
321 */
322int pci_prg_resp_pasid_required(struct pci_dev *pdev)
323{
9bf49e36
KS
324 if (pdev->is_virtfn)
325 pdev = pci_physfn(pdev);
326
e5adf79a 327 return pdev->pasid_required;
8cbb8a93 328}
3f9a7a13
AR
329
330/**
331 * pci_pri_supported - Check if PRI is supported.
332 * @pdev: PCI device structure
333 *
334 * Returns true if PRI capability is present, false otherwise.
335 */
336bool pci_pri_supported(struct pci_dev *pdev)
337{
338 /* VFs share the PF PRI */
339 if (pci_physfn(pdev)->pri_cap)
340 return true;
341 return false;
342}
343EXPORT_SYMBOL_GPL(pci_pri_supported);
c320b976 344#endif /* CONFIG_PCI_PRI */
086ac11f
JR
345
346#ifdef CONFIG_PCI_PASID
751035b8
KS
347void pci_pasid_init(struct pci_dev *pdev)
348{
349 pdev->pasid_cap = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_PASID);
350}
351
086ac11f
JR
352/**
353 * pci_enable_pasid - Enable the PASID capability
354 * @pdev: PCI device structure
355 * @features: Features to enable
356 *
357 * Returns 0 on success, negative value on error. This function checks
358 * whether the features are actually supported by the device and returns
359 * an error if not.
360 */
361int pci_enable_pasid(struct pci_dev *pdev, int features)
362{
363 u16 control, supported;
751035b8 364 int pasid = pdev->pasid_cap;
086ac11f 365
2b0ae7cc
KS
366 /*
367 * VFs must not implement the PASID Capability, but if a PF
368 * supports PASID, its VFs share the PF PASID configuration.
369 */
370 if (pdev->is_virtfn) {
371 if (pci_physfn(pdev)->pasid_enabled)
372 return 0;
373 return -EINVAL;
374 }
375
a4f4fa68
JPB
376 if (WARN_ON(pdev->pasid_enabled))
377 return -EBUSY;
378
7ce3f912
SK
379 if (!pdev->eetlp_prefix_path)
380 return -EINVAL;
381
751035b8 382 if (!pasid)
086ac11f
JR
383 return -EINVAL;
384
751035b8 385 pci_read_config_word(pdev, pasid + PCI_PASID_CAP, &supported);
91f57d5e 386 supported &= PCI_PASID_CAP_EXEC | PCI_PASID_CAP_PRIV;
086ac11f
JR
387
388 /* User wants to enable anything unsupported? */
389 if ((supported & features) != features)
390 return -EINVAL;
391
91f57d5e 392 control = PCI_PASID_CTRL_ENABLE | features;
4ebeb1ec 393 pdev->pasid_features = features;
086ac11f 394
751035b8 395 pci_write_config_word(pdev, pasid + PCI_PASID_CTRL, control);
086ac11f 396
a4f4fa68
JPB
397 pdev->pasid_enabled = 1;
398
086ac11f
JR
399 return 0;
400}
7682ce2b 401EXPORT_SYMBOL_GPL(pci_enable_pasid);
086ac11f
JR
402
403/**
404 * pci_disable_pasid - Disable the PASID capability
405 * @pdev: PCI device structure
086ac11f
JR
406 */
407void pci_disable_pasid(struct pci_dev *pdev)
408{
409 u16 control = 0;
751035b8 410 int pasid = pdev->pasid_cap;
086ac11f 411
2b0ae7cc
KS
412 /* VFs share the PF PASID configuration */
413 if (pdev->is_virtfn)
414 return;
415
a4f4fa68
JPB
416 if (WARN_ON(!pdev->pasid_enabled))
417 return;
418
751035b8 419 if (!pasid)
086ac11f
JR
420 return;
421
751035b8 422 pci_write_config_word(pdev, pasid + PCI_PASID_CTRL, control);
a4f4fa68
JPB
423
424 pdev->pasid_enabled = 0;
086ac11f 425}
7682ce2b 426EXPORT_SYMBOL_GPL(pci_disable_pasid);
086ac11f 427
4ebeb1ec
CT
428/**
429 * pci_restore_pasid_state - Restore PASID capabilities
430 * @pdev: PCI device structure
431 */
432void pci_restore_pasid_state(struct pci_dev *pdev)
433{
434 u16 control;
751035b8 435 int pasid = pdev->pasid_cap;
4ebeb1ec 436
2b0ae7cc
KS
437 if (pdev->is_virtfn)
438 return;
439
4ebeb1ec
CT
440 if (!pdev->pasid_enabled)
441 return;
442
751035b8 443 if (!pasid)
4ebeb1ec
CT
444 return;
445
446 control = PCI_PASID_CTRL_ENABLE | pdev->pasid_features;
751035b8 447 pci_write_config_word(pdev, pasid + PCI_PASID_CTRL, control);
4ebeb1ec 448}
4ebeb1ec 449
086ac11f
JR
450/**
451 * pci_pasid_features - Check which PASID features are supported
452 * @pdev: PCI device structure
453 *
454 * Returns a negative value when no PASI capability is present.
455 * Otherwise is returns a bitmask with supported features. Current
456 * features reported are:
91f57d5e 457 * PCI_PASID_CAP_EXEC - Execute permission supported
f7625980 458 * PCI_PASID_CAP_PRIV - Privileged mode supported
086ac11f
JR
459 */
460int pci_pasid_features(struct pci_dev *pdev)
461{
462 u16 supported;
2e34673b 463 int pasid;
086ac11f 464
2b0ae7cc
KS
465 if (pdev->is_virtfn)
466 pdev = pci_physfn(pdev);
467
2e34673b 468 pasid = pdev->pasid_cap;
751035b8 469 if (!pasid)
086ac11f
JR
470 return -EINVAL;
471
751035b8 472 pci_read_config_word(pdev, pasid + PCI_PASID_CAP, &supported);
086ac11f 473
91f57d5e 474 supported &= PCI_PASID_CAP_EXEC | PCI_PASID_CAP_PRIV;
086ac11f
JR
475
476 return supported;
477}
7682ce2b 478EXPORT_SYMBOL_GPL(pci_pasid_features);
086ac11f
JR
479
480#define PASID_NUMBER_SHIFT 8
481#define PASID_NUMBER_MASK (0x1f << PASID_NUMBER_SHIFT)
482/**
43395d9e 483 * pci_max_pasids - Get maximum number of PASIDs supported by device
086ac11f
JR
484 * @pdev: PCI device structure
485 *
486 * Returns negative value when PASID capability is not present.
f6b6aefe 487 * Otherwise it returns the number of supported PASIDs.
086ac11f
JR
488 */
489int pci_max_pasids(struct pci_dev *pdev)
490{
491 u16 supported;
2e34673b 492 int pasid;
086ac11f 493
2b0ae7cc
KS
494 if (pdev->is_virtfn)
495 pdev = pci_physfn(pdev);
496
2e34673b 497 pasid = pdev->pasid_cap;
751035b8 498 if (!pasid)
086ac11f
JR
499 return -EINVAL;
500
751035b8 501 pci_read_config_word(pdev, pasid + PCI_PASID_CAP, &supported);
086ac11f
JR
502
503 supported = (supported & PASID_NUMBER_MASK) >> PASID_NUMBER_SHIFT;
504
505 return (1 << supported);
506}
7682ce2b 507EXPORT_SYMBOL_GPL(pci_max_pasids);
086ac11f 508#endif /* CONFIG_PCI_PASID */