1 // SPDX-License-Identifier: GPL-2.0
3 * Enable PCIe link L0s/L1 state and Clock Power Management
5 * Copyright (C) 2007 Intel
10 #include <linux/bitfield.h>
11 #include <linux/bits.h>
12 #include <linux/build_bug.h>
13 #include <linux/kernel.h>
14 #include <linux/limits.h>
15 #include <linux/math.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/pci.h>
19 #include <linux/pci_regs.h>
20 #include <linux/errno.h>
22 #include <linux/init.h>
23 #include <linux/printk.h>
24 #include <linux/slab.h>
25 #include <linux/time.h>
29 void pci_save_ltr_state(struct pci_dev *dev)
32 struct pci_cap_saved_state *save_state;
35 if (!pci_is_pcie(dev))
38 ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
42 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
44 pci_err(dev, "no suspend buffer for LTR; ASPM issues possible after resume\n");
48 /* Some broken devices only support dword access to LTR */
49 cap = &save_state->cap.data[0];
50 pci_read_config_dword(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, cap);
53 void pci_restore_ltr_state(struct pci_dev *dev)
55 struct pci_cap_saved_state *save_state;
59 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
60 ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
61 if (!save_state || !ltr)
64 /* Some broken devices only support dword access to LTR */
65 cap = &save_state->cap.data[0];
66 pci_write_config_dword(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, *cap);
69 void pci_configure_aspm_l1ss(struct pci_dev *pdev)
73 pdev->l1ss = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_L1SS);
75 rc = pci_add_ext_cap_save_buffer(pdev, PCI_EXT_CAP_ID_L1SS,
78 pci_err(pdev, "unable to allocate ASPM L1SS save buffer (%pe)\n",
82 void pci_save_aspm_l1ss_state(struct pci_dev *pdev)
84 struct pci_cap_saved_state *save_state;
85 u16 l1ss = pdev->l1ss;
89 * Save L1 substate configuration. The ASPM L0s/L1 configuration
90 * in PCI_EXP_LNKCTL_ASPMC is saved by pci_save_pcie_state().
95 save_state = pci_find_saved_ext_cap(pdev, PCI_EXT_CAP_ID_L1SS);
99 cap = &save_state->cap.data[0];
100 pci_read_config_dword(pdev, l1ss + PCI_L1SS_CTL2, cap++);
101 pci_read_config_dword(pdev, l1ss + PCI_L1SS_CTL1, cap++);
104 void pci_restore_aspm_l1ss_state(struct pci_dev *pdev)
106 struct pci_cap_saved_state *pl_save_state, *cl_save_state;
107 struct pci_dev *parent = pdev->bus->self;
108 u32 *cap, pl_ctl1, pl_ctl2, pl_l1_2_enable;
109 u32 cl_ctl1, cl_ctl2, cl_l1_2_enable;
110 u16 clnkctl, plnkctl;
113 * In case BIOS enabled L1.2 when resuming, we need to disable it first
114 * on the downstream component before the upstream. So, don't attempt to
115 * restore either until we are at the downstream component.
117 if (pcie_downstream_port(pdev) || !parent)
120 if (!pdev->l1ss || !parent->l1ss)
123 cl_save_state = pci_find_saved_ext_cap(pdev, PCI_EXT_CAP_ID_L1SS);
124 pl_save_state = pci_find_saved_ext_cap(parent, PCI_EXT_CAP_ID_L1SS);
125 if (!cl_save_state || !pl_save_state)
128 cap = &cl_save_state->cap.data[0];
131 cap = &pl_save_state->cap.data[0];
135 /* Make sure L0s/L1 are disabled before updating L1SS config */
136 pcie_capability_read_word(pdev, PCI_EXP_LNKCTL, &clnkctl);
137 pcie_capability_read_word(parent, PCI_EXP_LNKCTL, &plnkctl);
138 if (FIELD_GET(PCI_EXP_LNKCTL_ASPMC, clnkctl) ||
139 FIELD_GET(PCI_EXP_LNKCTL_ASPMC, plnkctl)) {
140 pcie_capability_write_word(pdev, PCI_EXP_LNKCTL,
141 clnkctl & ~PCI_EXP_LNKCTL_ASPMC);
142 pcie_capability_write_word(parent, PCI_EXP_LNKCTL,
143 plnkctl & ~PCI_EXP_LNKCTL_ASPMC);
147 * Disable L1.2 on this downstream endpoint device first, followed
150 pci_clear_and_set_config_dword(pdev, pdev->l1ss + PCI_L1SS_CTL1,
151 PCI_L1SS_CTL1_L1_2_MASK, 0);
152 pci_clear_and_set_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
153 PCI_L1SS_CTL1_L1_2_MASK, 0);
156 * In addition, Common_Mode_Restore_Time and LTR_L1.2_THRESHOLD
157 * in PCI_L1SS_CTL1 must be programmed *before* setting the L1.2
158 * enable bits, even though they're all in PCI_L1SS_CTL1.
160 pl_l1_2_enable = pl_ctl1 & PCI_L1SS_CTL1_L1_2_MASK;
161 pl_ctl1 &= ~PCI_L1SS_CTL1_L1_2_MASK;
162 cl_l1_2_enable = cl_ctl1 & PCI_L1SS_CTL1_L1_2_MASK;
163 cl_ctl1 &= ~PCI_L1SS_CTL1_L1_2_MASK;
165 /* Write back without enables first (above we cleared them in ctl1) */
166 pci_write_config_dword(parent, parent->l1ss + PCI_L1SS_CTL2, pl_ctl2);
167 pci_write_config_dword(pdev, pdev->l1ss + PCI_L1SS_CTL2, cl_ctl2);
168 pci_write_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1, pl_ctl1);
169 pci_write_config_dword(pdev, pdev->l1ss + PCI_L1SS_CTL1, cl_ctl1);
171 /* Then write back the enables */
172 if (pl_l1_2_enable || cl_l1_2_enable) {
173 pci_write_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
174 pl_ctl1 | pl_l1_2_enable);
175 pci_write_config_dword(pdev, pdev->l1ss + PCI_L1SS_CTL1,
176 cl_ctl1 | cl_l1_2_enable);
179 /* Restore L0s/L1 if they were enabled */
180 if (FIELD_GET(PCI_EXP_LNKCTL_ASPMC, clnkctl) ||
181 FIELD_GET(PCI_EXP_LNKCTL_ASPMC, plnkctl)) {
182 pcie_capability_write_word(parent, PCI_EXP_LNKCTL, plnkctl);
183 pcie_capability_write_word(pdev, PCI_EXP_LNKCTL, clnkctl);
187 #ifdef CONFIG_PCIEASPM
189 #ifdef MODULE_PARAM_PREFIX
190 #undef MODULE_PARAM_PREFIX
192 #define MODULE_PARAM_PREFIX "pcie_aspm."
194 /* Note: these are not register definitions */
195 #define PCIE_LINK_STATE_L0S_UP BIT(0) /* Upstream direction L0s state */
196 #define PCIE_LINK_STATE_L0S_DW BIT(1) /* Downstream direction L0s state */
197 static_assert(PCIE_LINK_STATE_L0S == (PCIE_LINK_STATE_L0S_UP | PCIE_LINK_STATE_L0S_DW));
199 #define PCIE_LINK_STATE_L1_SS_PCIPM (PCIE_LINK_STATE_L1_1_PCIPM |\
200 PCIE_LINK_STATE_L1_2_PCIPM)
201 #define PCIE_LINK_STATE_L1_2_MASK (PCIE_LINK_STATE_L1_2 |\
202 PCIE_LINK_STATE_L1_2_PCIPM)
203 #define PCIE_LINK_STATE_L1SS (PCIE_LINK_STATE_L1_1 |\
204 PCIE_LINK_STATE_L1_1_PCIPM |\
205 PCIE_LINK_STATE_L1_2_MASK)
207 struct pcie_link_state {
208 struct pci_dev *pdev; /* Upstream component of the Link */
209 struct pci_dev *downstream; /* Downstream component, function 0 */
210 struct pcie_link_state *root; /* pointer to the root port link */
211 struct pcie_link_state *parent; /* pointer to the parent Link state */
212 struct list_head sibling; /* node in link_list */
215 u32 aspm_support:7; /* Supported ASPM state */
216 u32 aspm_enabled:7; /* Enabled ASPM state */
217 u32 aspm_capable:7; /* Capable ASPM state with latency */
218 u32 aspm_default:7; /* Default ASPM state by BIOS */
219 u32 aspm_disable:7; /* Disabled ASPM state */
222 u32 clkpm_capable:1; /* Clock PM capable? */
223 u32 clkpm_enabled:1; /* Current Clock PM state */
224 u32 clkpm_default:1; /* Default Clock PM state by BIOS */
225 u32 clkpm_disable:1; /* Clock PM disabled */
228 static int aspm_disabled, aspm_force;
229 static bool aspm_support_enabled = true;
230 static DEFINE_MUTEX(aspm_lock);
231 static LIST_HEAD(link_list);
233 #define POLICY_DEFAULT 0 /* BIOS default setting */
234 #define POLICY_PERFORMANCE 1 /* high performance */
235 #define POLICY_POWERSAVE 2 /* high power saving */
236 #define POLICY_POWER_SUPERSAVE 3 /* possibly even more power saving */
238 #ifdef CONFIG_PCIEASPM_PERFORMANCE
239 static int aspm_policy = POLICY_PERFORMANCE;
240 #elif defined CONFIG_PCIEASPM_POWERSAVE
241 static int aspm_policy = POLICY_POWERSAVE;
242 #elif defined CONFIG_PCIEASPM_POWER_SUPERSAVE
243 static int aspm_policy = POLICY_POWER_SUPERSAVE;
245 static int aspm_policy;
248 static const char *policy_str[] = {
249 [POLICY_DEFAULT] = "default",
250 [POLICY_PERFORMANCE] = "performance",
251 [POLICY_POWERSAVE] = "powersave",
252 [POLICY_POWER_SUPERSAVE] = "powersupersave"
256 * The L1 PM substate capability is only implemented in function 0 in a
257 * multi function device.
259 static struct pci_dev *pci_function_0(struct pci_bus *linkbus)
261 struct pci_dev *child;
263 list_for_each_entry(child, &linkbus->devices, bus_list)
264 if (PCI_FUNC(child->devfn) == 0)
269 static int policy_to_aspm_state(struct pcie_link_state *link)
271 switch (aspm_policy) {
272 case POLICY_PERFORMANCE:
273 /* Disable ASPM and Clock PM */
275 case POLICY_POWERSAVE:
276 /* Enable ASPM L0s/L1 */
277 return PCIE_LINK_STATE_L0S | PCIE_LINK_STATE_L1;
278 case POLICY_POWER_SUPERSAVE:
279 /* Enable Everything */
280 return PCIE_LINK_STATE_ASPM_ALL;
282 return link->aspm_default;
287 static int policy_to_clkpm_state(struct pcie_link_state *link)
289 switch (aspm_policy) {
290 case POLICY_PERFORMANCE:
291 /* Disable ASPM and Clock PM */
293 case POLICY_POWERSAVE:
294 case POLICY_POWER_SUPERSAVE:
295 /* Enable Clock PM */
298 return link->clkpm_default;
303 static void pci_update_aspm_saved_state(struct pci_dev *dev)
305 struct pci_cap_saved_state *save_state;
306 u16 *cap, lnkctl, aspm_ctl;
308 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
312 pcie_capability_read_word(dev, PCI_EXP_LNKCTL, &lnkctl);
315 * Update ASPM and CLKREQ bits of LNKCTL in save_state. We only
316 * write PCI_EXP_LNKCTL_CCC during enumeration, so it shouldn't
317 * change after being captured in save_state.
319 aspm_ctl = lnkctl & (PCI_EXP_LNKCTL_ASPMC | PCI_EXP_LNKCTL_CLKREQ_EN);
320 lnkctl &= ~(PCI_EXP_LNKCTL_ASPMC | PCI_EXP_LNKCTL_CLKREQ_EN);
322 /* Depends on pci_save_pcie_state(): cap[1] is LNKCTL */
323 cap = (u16 *)&save_state->cap.data[0];
324 cap[1] = lnkctl | aspm_ctl;
327 static void pcie_set_clkpm_nocheck(struct pcie_link_state *link, int enable)
329 struct pci_dev *child;
330 struct pci_bus *linkbus = link->pdev->subordinate;
331 u32 val = enable ? PCI_EXP_LNKCTL_CLKREQ_EN : 0;
333 list_for_each_entry(child, &linkbus->devices, bus_list) {
334 pcie_capability_clear_and_set_word(child, PCI_EXP_LNKCTL,
335 PCI_EXP_LNKCTL_CLKREQ_EN,
337 pci_update_aspm_saved_state(child);
339 link->clkpm_enabled = !!enable;
342 static void pcie_set_clkpm(struct pcie_link_state *link, int enable)
345 * Don't enable Clock PM if the link is not Clock PM capable
346 * or Clock PM is disabled
348 if (!link->clkpm_capable || link->clkpm_disable)
350 /* Need nothing if the specified equals to current state */
351 if (link->clkpm_enabled == enable)
353 pcie_set_clkpm_nocheck(link, enable);
356 static void pcie_clkpm_cap_init(struct pcie_link_state *link, int blacklist)
358 int capable = 1, enabled = 1;
361 struct pci_dev *child;
362 struct pci_bus *linkbus = link->pdev->subordinate;
364 /* All functions should have the same cap and state, take the worst */
365 list_for_each_entry(child, &linkbus->devices, bus_list) {
366 pcie_capability_read_dword(child, PCI_EXP_LNKCAP, ®32);
367 if (!(reg32 & PCI_EXP_LNKCAP_CLKPM)) {
372 pcie_capability_read_word(child, PCI_EXP_LNKCTL, ®16);
373 if (!(reg16 & PCI_EXP_LNKCTL_CLKREQ_EN))
376 link->clkpm_enabled = enabled;
377 link->clkpm_default = enabled;
378 link->clkpm_capable = capable;
379 link->clkpm_disable = blacklist ? 1 : 0;
383 * pcie_aspm_configure_common_clock: check if the 2 ends of a link
384 * could use common clock. If they are, configure them to use the
385 * common clock. That will reduce the ASPM state exit latency.
387 static void pcie_aspm_configure_common_clock(struct pcie_link_state *link)
390 u16 reg16, ccc, parent_old_ccc, child_old_ccc[8];
391 struct pci_dev *child, *parent = link->pdev;
392 struct pci_bus *linkbus = parent->subordinate;
394 * All functions of a slot should have the same Slot Clock
395 * Configuration, so just check one function
397 child = list_entry(linkbus->devices.next, struct pci_dev, bus_list);
398 BUG_ON(!pci_is_pcie(child));
400 /* Check downstream component if bit Slot Clock Configuration is 1 */
401 pcie_capability_read_word(child, PCI_EXP_LNKSTA, ®16);
402 if (!(reg16 & PCI_EXP_LNKSTA_SLC))
405 /* Check upstream component if bit Slot Clock Configuration is 1 */
406 pcie_capability_read_word(parent, PCI_EXP_LNKSTA, ®16);
407 if (!(reg16 & PCI_EXP_LNKSTA_SLC))
410 /* Port might be already in common clock mode */
411 pcie_capability_read_word(parent, PCI_EXP_LNKCTL, ®16);
412 parent_old_ccc = reg16 & PCI_EXP_LNKCTL_CCC;
413 if (same_clock && (reg16 & PCI_EXP_LNKCTL_CCC)) {
414 bool consistent = true;
416 list_for_each_entry(child, &linkbus->devices, bus_list) {
417 pcie_capability_read_word(child, PCI_EXP_LNKCTL,
419 if (!(reg16 & PCI_EXP_LNKCTL_CCC)) {
426 pci_info(parent, "ASPM: current common clock configuration is inconsistent, reconfiguring\n");
429 ccc = same_clock ? PCI_EXP_LNKCTL_CCC : 0;
430 /* Configure downstream component, all functions */
431 list_for_each_entry(child, &linkbus->devices, bus_list) {
432 pcie_capability_read_word(child, PCI_EXP_LNKCTL, ®16);
433 child_old_ccc[PCI_FUNC(child->devfn)] = reg16 & PCI_EXP_LNKCTL_CCC;
434 pcie_capability_clear_and_set_word(child, PCI_EXP_LNKCTL,
435 PCI_EXP_LNKCTL_CCC, ccc);
438 /* Configure upstream component */
439 pcie_capability_clear_and_set_word(parent, PCI_EXP_LNKCTL,
440 PCI_EXP_LNKCTL_CCC, ccc);
442 if (pcie_retrain_link(link->pdev, true)) {
444 /* Training failed. Restore common clock configurations */
445 pci_err(parent, "ASPM: Could not configure common clock\n");
446 list_for_each_entry(child, &linkbus->devices, bus_list)
447 pcie_capability_clear_and_set_word(child, PCI_EXP_LNKCTL,
449 child_old_ccc[PCI_FUNC(child->devfn)]);
450 pcie_capability_clear_and_set_word(parent, PCI_EXP_LNKCTL,
451 PCI_EXP_LNKCTL_CCC, parent_old_ccc);
455 /* Convert L0s latency encoding to ns */
456 static u32 calc_l0s_latency(u32 lnkcap)
458 u32 encoding = FIELD_GET(PCI_EXP_LNKCAP_L0SEL, lnkcap);
461 return 5 * NSEC_PER_USEC; /* > 4us */
462 return (64 << encoding);
465 /* Convert L0s acceptable latency encoding to ns */
466 static u32 calc_l0s_acceptable(u32 encoding)
470 return (64 << encoding);
473 /* Convert L1 latency encoding to ns */
474 static u32 calc_l1_latency(u32 lnkcap)
476 u32 encoding = FIELD_GET(PCI_EXP_LNKCAP_L1EL, lnkcap);
479 return 65 * NSEC_PER_USEC; /* > 64us */
480 return NSEC_PER_USEC << encoding;
483 /* Convert L1 acceptable latency encoding to ns */
484 static u32 calc_l1_acceptable(u32 encoding)
488 return NSEC_PER_USEC << encoding;
491 /* Convert L1SS T_pwr encoding to usec */
492 static u32 calc_l12_pwron(struct pci_dev *pdev, u32 scale, u32 val)
502 pci_err(pdev, "%s: Invalid T_PwrOn scale: %u\n", __func__, scale);
507 * Encode an LTR_L1.2_THRESHOLD value for the L1 PM Substates Control 1
508 * register. Ports enter L1.2 when the most recent LTR value is greater
509 * than or equal to LTR_L1.2_THRESHOLD, so we round up to make sure we
510 * don't enter L1.2 too aggressively.
512 * See PCIe r6.0, sec 5.5.1, 6.18, 7.8.3.3.
514 static void encode_l12_threshold(u32 threshold_us, u32 *scale, u32 *value)
516 u64 threshold_ns = (u64)threshold_us * NSEC_PER_USEC;
519 * LTR_L1.2_THRESHOLD_Value ("value") is a 10-bit field with max
522 if (threshold_ns <= 1 * FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE)) {
523 *scale = 0; /* Value times 1ns */
524 *value = threshold_ns;
525 } else if (threshold_ns <= 32 * FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE)) {
526 *scale = 1; /* Value times 32ns */
527 *value = roundup(threshold_ns, 32) / 32;
528 } else if (threshold_ns <= 1024 * FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE)) {
529 *scale = 2; /* Value times 1024ns */
530 *value = roundup(threshold_ns, 1024) / 1024;
531 } else if (threshold_ns <= 32768 * FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE)) {
532 *scale = 3; /* Value times 32768ns */
533 *value = roundup(threshold_ns, 32768) / 32768;
534 } else if (threshold_ns <= 1048576 * FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE)) {
535 *scale = 4; /* Value times 1048576ns */
536 *value = roundup(threshold_ns, 1048576) / 1048576;
537 } else if (threshold_ns <= (u64)33554432 * FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE)) {
538 *scale = 5; /* Value times 33554432ns */
539 *value = roundup(threshold_ns, 33554432) / 33554432;
542 *value = FIELD_MAX(PCI_L1SS_CTL1_LTR_L12_TH_VALUE);
546 static void pcie_aspm_check_latency(struct pci_dev *endpoint)
548 u32 latency, encoding, lnkcap_up, lnkcap_dw;
549 u32 l1_switch_latency = 0, latency_up_l0s;
550 u32 latency_up_l1, latency_dw_l0s, latency_dw_l1;
551 u32 acceptable_l0s, acceptable_l1;
552 struct pcie_link_state *link;
554 /* Device not in D0 doesn't need latency check */
555 if ((endpoint->current_state != PCI_D0) &&
556 (endpoint->current_state != PCI_UNKNOWN))
559 link = endpoint->bus->self->link_state;
561 /* Calculate endpoint L0s acceptable latency */
562 encoding = FIELD_GET(PCI_EXP_DEVCAP_L0S, endpoint->devcap);
563 acceptable_l0s = calc_l0s_acceptable(encoding);
565 /* Calculate endpoint L1 acceptable latency */
566 encoding = FIELD_GET(PCI_EXP_DEVCAP_L1, endpoint->devcap);
567 acceptable_l1 = calc_l1_acceptable(encoding);
570 struct pci_dev *dev = pci_function_0(link->pdev->subordinate);
572 /* Read direction exit latencies */
573 pcie_capability_read_dword(link->pdev, PCI_EXP_LNKCAP,
575 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP,
577 latency_up_l0s = calc_l0s_latency(lnkcap_up);
578 latency_up_l1 = calc_l1_latency(lnkcap_up);
579 latency_dw_l0s = calc_l0s_latency(lnkcap_dw);
580 latency_dw_l1 = calc_l1_latency(lnkcap_dw);
582 /* Check upstream direction L0s latency */
583 if ((link->aspm_capable & PCIE_LINK_STATE_L0S_UP) &&
584 (latency_up_l0s > acceptable_l0s))
585 link->aspm_capable &= ~PCIE_LINK_STATE_L0S_UP;
587 /* Check downstream direction L0s latency */
588 if ((link->aspm_capable & PCIE_LINK_STATE_L0S_DW) &&
589 (latency_dw_l0s > acceptable_l0s))
590 link->aspm_capable &= ~PCIE_LINK_STATE_L0S_DW;
593 * Every switch on the path to root complex need 1
594 * more microsecond for L1. Spec doesn't mention L0s.
596 * The exit latencies for L1 substates are not advertised
597 * by a device. Since the spec also doesn't mention a way
598 * to determine max latencies introduced by enabling L1
599 * substates on the components, it is not clear how to do
600 * a L1 substate exit latency check. We assume that the
601 * L1 exit latencies advertised by a device include L1
602 * substate latencies (and hence do not do any check).
604 latency = max_t(u32, latency_up_l1, latency_dw_l1);
605 if ((link->aspm_capable & PCIE_LINK_STATE_L1) &&
606 (latency + l1_switch_latency > acceptable_l1))
607 link->aspm_capable &= ~PCIE_LINK_STATE_L1;
608 l1_switch_latency += NSEC_PER_USEC;
614 /* Calculate L1.2 PM substate timing parameters */
615 static void aspm_calc_l12_info(struct pcie_link_state *link,
616 u32 parent_l1ss_cap, u32 child_l1ss_cap)
618 struct pci_dev *child = link->downstream, *parent = link->pdev;
619 u32 val1, val2, scale1, scale2;
620 u32 t_common_mode, t_power_on, l1_2_threshold, scale, value;
621 u32 ctl1 = 0, ctl2 = 0;
622 u32 pctl1, pctl2, cctl1, cctl2;
623 u32 pl1_2_enables, cl1_2_enables;
625 /* Choose the greater of the two Port Common_Mode_Restore_Times */
626 val1 = FIELD_GET(PCI_L1SS_CAP_CM_RESTORE_TIME, parent_l1ss_cap);
627 val2 = FIELD_GET(PCI_L1SS_CAP_CM_RESTORE_TIME, child_l1ss_cap);
628 t_common_mode = max(val1, val2);
630 /* Choose the greater of the two Port T_POWER_ON times */
631 val1 = FIELD_GET(PCI_L1SS_CAP_P_PWR_ON_VALUE, parent_l1ss_cap);
632 scale1 = FIELD_GET(PCI_L1SS_CAP_P_PWR_ON_SCALE, parent_l1ss_cap);
633 val2 = FIELD_GET(PCI_L1SS_CAP_P_PWR_ON_VALUE, child_l1ss_cap);
634 scale2 = FIELD_GET(PCI_L1SS_CAP_P_PWR_ON_SCALE, child_l1ss_cap);
636 if (calc_l12_pwron(parent, scale1, val1) >
637 calc_l12_pwron(child, scale2, val2)) {
638 ctl2 |= FIELD_PREP(PCI_L1SS_CTL2_T_PWR_ON_SCALE, scale1) |
639 FIELD_PREP(PCI_L1SS_CTL2_T_PWR_ON_VALUE, val1);
640 t_power_on = calc_l12_pwron(parent, scale1, val1);
642 ctl2 |= FIELD_PREP(PCI_L1SS_CTL2_T_PWR_ON_SCALE, scale2) |
643 FIELD_PREP(PCI_L1SS_CTL2_T_PWR_ON_VALUE, val2);
644 t_power_on = calc_l12_pwron(child, scale2, val2);
648 * Set LTR_L1.2_THRESHOLD to the time required to transition the
649 * Link from L0 to L1.2 and back to L0 so we enter L1.2 only if
650 * downstream devices report (via LTR) that they can tolerate at
651 * least that much latency.
653 * Based on PCIe r3.1, sec 5.5.3.3.1, Figures 5-16 and 5-17, and
654 * Table 5-11. T(POWER_OFF) is at most 2us and T(L1.2) is at
657 l1_2_threshold = 2 + 4 + t_common_mode + t_power_on;
658 encode_l12_threshold(l1_2_threshold, &scale, &value);
659 ctl1 |= FIELD_PREP(PCI_L1SS_CTL1_CM_RESTORE_TIME, t_common_mode) |
660 FIELD_PREP(PCI_L1SS_CTL1_LTR_L12_TH_VALUE, value) |
661 FIELD_PREP(PCI_L1SS_CTL1_LTR_L12_TH_SCALE, scale);
663 /* Some broken devices only support dword access to L1 SS */
664 pci_read_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1, &pctl1);
665 pci_read_config_dword(parent, parent->l1ss + PCI_L1SS_CTL2, &pctl2);
666 pci_read_config_dword(child, child->l1ss + PCI_L1SS_CTL1, &cctl1);
667 pci_read_config_dword(child, child->l1ss + PCI_L1SS_CTL2, &cctl2);
669 if (ctl1 == pctl1 && ctl1 == cctl1 &&
670 ctl2 == pctl2 && ctl2 == cctl2)
673 /* Disable L1.2 while updating. See PCIe r5.0, sec 5.5.4, 7.8.3.3 */
674 pl1_2_enables = pctl1 & PCI_L1SS_CTL1_L1_2_MASK;
675 cl1_2_enables = cctl1 & PCI_L1SS_CTL1_L1_2_MASK;
677 if (pl1_2_enables || cl1_2_enables) {
678 pci_clear_and_set_config_dword(child,
679 child->l1ss + PCI_L1SS_CTL1,
680 PCI_L1SS_CTL1_L1_2_MASK, 0);
681 pci_clear_and_set_config_dword(parent,
682 parent->l1ss + PCI_L1SS_CTL1,
683 PCI_L1SS_CTL1_L1_2_MASK, 0);
686 /* Program T_POWER_ON times in both ports */
687 pci_write_config_dword(parent, parent->l1ss + PCI_L1SS_CTL2, ctl2);
688 pci_write_config_dword(child, child->l1ss + PCI_L1SS_CTL2, ctl2);
690 /* Program Common_Mode_Restore_Time in upstream device */
691 pci_clear_and_set_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
692 PCI_L1SS_CTL1_CM_RESTORE_TIME, ctl1);
694 /* Program LTR_L1.2_THRESHOLD time in both ports */
695 pci_clear_and_set_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
696 PCI_L1SS_CTL1_LTR_L12_TH_VALUE |
697 PCI_L1SS_CTL1_LTR_L12_TH_SCALE,
699 pci_clear_and_set_config_dword(child, child->l1ss + PCI_L1SS_CTL1,
700 PCI_L1SS_CTL1_LTR_L12_TH_VALUE |
701 PCI_L1SS_CTL1_LTR_L12_TH_SCALE,
704 if (pl1_2_enables || cl1_2_enables) {
705 pci_clear_and_set_config_dword(parent,
706 parent->l1ss + PCI_L1SS_CTL1, 0,
708 pci_clear_and_set_config_dword(child,
709 child->l1ss + PCI_L1SS_CTL1, 0,
714 static void aspm_l1ss_init(struct pcie_link_state *link)
716 struct pci_dev *child = link->downstream, *parent = link->pdev;
717 u32 parent_l1ss_cap, child_l1ss_cap;
718 u32 parent_l1ss_ctl1 = 0, child_l1ss_ctl1 = 0;
720 if (!parent->l1ss || !child->l1ss)
723 /* Setup L1 substate */
724 pci_read_config_dword(parent, parent->l1ss + PCI_L1SS_CAP,
726 pci_read_config_dword(child, child->l1ss + PCI_L1SS_CAP,
729 if (!(parent_l1ss_cap & PCI_L1SS_CAP_L1_PM_SS))
731 if (!(child_l1ss_cap & PCI_L1SS_CAP_L1_PM_SS))
735 * If we don't have LTR for the entire path from the Root Complex
736 * to this device, we can't use ASPM L1.2 because it relies on the
737 * LTR_L1.2_THRESHOLD. See PCIe r4.0, secs 5.5.4, 6.18.
739 if (!child->ltr_path)
740 child_l1ss_cap &= ~PCI_L1SS_CAP_ASPM_L1_2;
742 if (parent_l1ss_cap & child_l1ss_cap & PCI_L1SS_CAP_ASPM_L1_1)
743 link->aspm_support |= PCIE_LINK_STATE_L1_1;
744 if (parent_l1ss_cap & child_l1ss_cap & PCI_L1SS_CAP_ASPM_L1_2)
745 link->aspm_support |= PCIE_LINK_STATE_L1_2;
746 if (parent_l1ss_cap & child_l1ss_cap & PCI_L1SS_CAP_PCIPM_L1_1)
747 link->aspm_support |= PCIE_LINK_STATE_L1_1_PCIPM;
748 if (parent_l1ss_cap & child_l1ss_cap & PCI_L1SS_CAP_PCIPM_L1_2)
749 link->aspm_support |= PCIE_LINK_STATE_L1_2_PCIPM;
752 pci_read_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
755 pci_read_config_dword(child, child->l1ss + PCI_L1SS_CTL1,
758 if (parent_l1ss_ctl1 & child_l1ss_ctl1 & PCI_L1SS_CTL1_ASPM_L1_1)
759 link->aspm_enabled |= PCIE_LINK_STATE_L1_1;
760 if (parent_l1ss_ctl1 & child_l1ss_ctl1 & PCI_L1SS_CTL1_ASPM_L1_2)
761 link->aspm_enabled |= PCIE_LINK_STATE_L1_2;
762 if (parent_l1ss_ctl1 & child_l1ss_ctl1 & PCI_L1SS_CTL1_PCIPM_L1_1)
763 link->aspm_enabled |= PCIE_LINK_STATE_L1_1_PCIPM;
764 if (parent_l1ss_ctl1 & child_l1ss_ctl1 & PCI_L1SS_CTL1_PCIPM_L1_2)
765 link->aspm_enabled |= PCIE_LINK_STATE_L1_2_PCIPM;
767 if (link->aspm_support & PCIE_LINK_STATE_L1_2_MASK)
768 aspm_calc_l12_info(link, parent_l1ss_cap, child_l1ss_cap);
771 static void pcie_aspm_cap_init(struct pcie_link_state *link, int blacklist)
773 struct pci_dev *child = link->downstream, *parent = link->pdev;
774 u32 parent_lnkcap, child_lnkcap;
775 u16 parent_lnkctl, child_lnkctl;
776 struct pci_bus *linkbus = parent->subordinate;
779 /* Set enabled/disable so that we will disable ASPM later */
780 link->aspm_enabled = PCIE_LINK_STATE_ASPM_ALL;
781 link->aspm_disable = PCIE_LINK_STATE_ASPM_ALL;
786 * If ASPM not supported, don't mess with the clocks and link,
789 pcie_capability_read_dword(parent, PCI_EXP_LNKCAP, &parent_lnkcap);
790 pcie_capability_read_dword(child, PCI_EXP_LNKCAP, &child_lnkcap);
791 if (!(parent_lnkcap & child_lnkcap & PCI_EXP_LNKCAP_ASPMS))
794 /* Configure common clock before checking latencies */
795 pcie_aspm_configure_common_clock(link);
798 * Re-read upstream/downstream components' register state after
799 * clock configuration. L0s & L1 exit latencies in the otherwise
800 * read-only Link Capabilities may change depending on common clock
801 * configuration (PCIe r5.0, sec 7.5.3.6).
803 pcie_capability_read_dword(parent, PCI_EXP_LNKCAP, &parent_lnkcap);
804 pcie_capability_read_dword(child, PCI_EXP_LNKCAP, &child_lnkcap);
805 pcie_capability_read_word(parent, PCI_EXP_LNKCTL, &parent_lnkctl);
806 pcie_capability_read_word(child, PCI_EXP_LNKCTL, &child_lnkctl);
811 * Note that we must not enable L0s in either direction on a
812 * given link unless components on both sides of the link each
815 if (parent_lnkcap & child_lnkcap & PCI_EXP_LNKCAP_ASPM_L0S)
816 link->aspm_support |= PCIE_LINK_STATE_L0S;
818 if (child_lnkctl & PCI_EXP_LNKCTL_ASPM_L0S)
819 link->aspm_enabled |= PCIE_LINK_STATE_L0S_UP;
820 if (parent_lnkctl & PCI_EXP_LNKCTL_ASPM_L0S)
821 link->aspm_enabled |= PCIE_LINK_STATE_L0S_DW;
824 if (parent_lnkcap & child_lnkcap & PCI_EXP_LNKCAP_ASPM_L1)
825 link->aspm_support |= PCIE_LINK_STATE_L1;
827 if (parent_lnkctl & child_lnkctl & PCI_EXP_LNKCTL_ASPM_L1)
828 link->aspm_enabled |= PCIE_LINK_STATE_L1;
830 aspm_l1ss_init(link);
832 /* Save default state */
833 link->aspm_default = link->aspm_enabled;
835 /* Setup initial capable state. Will be updated later */
836 link->aspm_capable = link->aspm_support;
838 /* Get and check endpoint acceptable latencies */
839 list_for_each_entry(child, &linkbus->devices, bus_list) {
840 if (pci_pcie_type(child) != PCI_EXP_TYPE_ENDPOINT &&
841 pci_pcie_type(child) != PCI_EXP_TYPE_LEG_END)
844 pcie_aspm_check_latency(child);
848 /* Configure the ASPM L1 substates */
849 static void pcie_config_aspm_l1ss(struct pcie_link_state *link, u32 state)
852 struct pci_dev *child = link->downstream, *parent = link->pdev;
854 enable_req = (link->aspm_enabled ^ state) & state;
857 * Here are the rules specified in the PCIe spec for enabling L1SS:
858 * - When enabling L1.x, enable bit at parent first, then at child
859 * - When disabling L1.x, disable bit at child first, then at parent
860 * - When enabling ASPM L1.x, need to disable L1
861 * (at child followed by parent).
862 * - The ASPM/PCIPM L1.2 must be disabled while programming timing
865 * To keep it simple, disable all L1SS bits first, and later enable
869 /* Disable all L1 substates */
870 pci_clear_and_set_config_dword(child, child->l1ss + PCI_L1SS_CTL1,
871 PCI_L1SS_CTL1_L1SS_MASK, 0);
872 pci_clear_and_set_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
873 PCI_L1SS_CTL1_L1SS_MASK, 0);
875 * If needed, disable L1, and it gets enabled later
876 * in pcie_config_aspm_link().
878 if (enable_req & (PCIE_LINK_STATE_L1_1 | PCIE_LINK_STATE_L1_2)) {
879 pcie_capability_clear_word(child, PCI_EXP_LNKCTL,
880 PCI_EXP_LNKCTL_ASPM_L1);
881 pcie_capability_clear_word(parent, PCI_EXP_LNKCTL,
882 PCI_EXP_LNKCTL_ASPM_L1);
886 if (state & PCIE_LINK_STATE_L1_1)
887 val |= PCI_L1SS_CTL1_ASPM_L1_1;
888 if (state & PCIE_LINK_STATE_L1_2)
889 val |= PCI_L1SS_CTL1_ASPM_L1_2;
890 if (state & PCIE_LINK_STATE_L1_1_PCIPM)
891 val |= PCI_L1SS_CTL1_PCIPM_L1_1;
892 if (state & PCIE_LINK_STATE_L1_2_PCIPM)
893 val |= PCI_L1SS_CTL1_PCIPM_L1_2;
895 /* Enable what we need to enable */
896 pci_clear_and_set_config_dword(parent, parent->l1ss + PCI_L1SS_CTL1,
897 PCI_L1SS_CTL1_L1SS_MASK, val);
898 pci_clear_and_set_config_dword(child, child->l1ss + PCI_L1SS_CTL1,
899 PCI_L1SS_CTL1_L1SS_MASK, val);
902 static void pcie_config_aspm_dev(struct pci_dev *pdev, u32 val)
904 pcie_capability_clear_and_set_word(pdev, PCI_EXP_LNKCTL,
905 PCI_EXP_LNKCTL_ASPMC, val);
908 static void pcie_config_aspm_link(struct pcie_link_state *link, u32 state)
910 u32 upstream = 0, dwstream = 0;
911 struct pci_dev *child = link->downstream, *parent = link->pdev;
912 struct pci_bus *linkbus = parent->subordinate;
914 /* Enable only the states that were not explicitly disabled */
915 state &= (link->aspm_capable & ~link->aspm_disable);
917 /* Can't enable any substates if L1 is not enabled */
918 if (!(state & PCIE_LINK_STATE_L1))
919 state &= ~PCIE_LINK_STATE_L1SS;
921 /* Spec says both ports must be in D0 before enabling PCI PM substates*/
922 if (parent->current_state != PCI_D0 || child->current_state != PCI_D0) {
923 state &= ~PCIE_LINK_STATE_L1_SS_PCIPM;
924 state |= (link->aspm_enabled & PCIE_LINK_STATE_L1_SS_PCIPM);
927 /* Nothing to do if the link is already in the requested state */
928 if (link->aspm_enabled == state)
930 /* Convert ASPM state to upstream/downstream ASPM register state */
931 if (state & PCIE_LINK_STATE_L0S_UP)
932 dwstream |= PCI_EXP_LNKCTL_ASPM_L0S;
933 if (state & PCIE_LINK_STATE_L0S_DW)
934 upstream |= PCI_EXP_LNKCTL_ASPM_L0S;
935 if (state & PCIE_LINK_STATE_L1) {
936 upstream |= PCI_EXP_LNKCTL_ASPM_L1;
937 dwstream |= PCI_EXP_LNKCTL_ASPM_L1;
940 if (link->aspm_capable & PCIE_LINK_STATE_L1SS)
941 pcie_config_aspm_l1ss(link, state);
944 * Spec 2.0 suggests all functions should be configured the
945 * same setting for ASPM. Enabling ASPM L1 should be done in
946 * upstream component first and then downstream, and vice
947 * versa for disabling ASPM L1. Spec doesn't mention L0S.
949 if (state & PCIE_LINK_STATE_L1)
950 pcie_config_aspm_dev(parent, upstream);
951 list_for_each_entry(child, &linkbus->devices, bus_list)
952 pcie_config_aspm_dev(child, dwstream);
953 if (!(state & PCIE_LINK_STATE_L1))
954 pcie_config_aspm_dev(parent, upstream);
956 link->aspm_enabled = state;
958 /* Update latest ASPM configuration in saved context */
959 pci_save_aspm_l1ss_state(link->downstream);
960 pci_update_aspm_saved_state(link->downstream);
961 pci_save_aspm_l1ss_state(parent);
962 pci_update_aspm_saved_state(parent);
965 static void pcie_config_aspm_path(struct pcie_link_state *link)
968 pcie_config_aspm_link(link, policy_to_aspm_state(link));
973 static void free_link_state(struct pcie_link_state *link)
975 link->pdev->link_state = NULL;
979 static int pcie_aspm_sanity_check(struct pci_dev *pdev)
981 struct pci_dev *child;
985 * Some functions in a slot might not all be PCIe functions,
986 * very strange. Disable ASPM for the whole slot
988 list_for_each_entry(child, &pdev->subordinate->devices, bus_list) {
989 if (!pci_is_pcie(child))
993 * If ASPM is disabled then we're not going to change
994 * the BIOS state. It's safe to continue even if it's a
1002 * Disable ASPM for pre-1.1 PCIe device, we follow MS to use
1003 * RBER bit to determine if a function is 1.1 version device
1005 pcie_capability_read_dword(child, PCI_EXP_DEVCAP, ®32);
1006 if (!(reg32 & PCI_EXP_DEVCAP_RBER) && !aspm_force) {
1007 pci_info(child, "disabling ASPM on pre-1.1 PCIe device. You can enable it with 'pcie_aspm=force'\n");
1014 static struct pcie_link_state *alloc_pcie_link_state(struct pci_dev *pdev)
1016 struct pcie_link_state *link;
1018 link = kzalloc(sizeof(*link), GFP_KERNEL);
1022 INIT_LIST_HEAD(&link->sibling);
1024 link->downstream = pci_function_0(pdev->subordinate);
1027 * Root Ports and PCI/PCI-X to PCIe Bridges are roots of PCIe
1028 * hierarchies. Note that some PCIe host implementations omit
1029 * the root ports entirely, in which case a downstream port on
1030 * a switch may become the root of the link state chain for all
1031 * its subordinate endpoints.
1033 if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT ||
1034 pci_pcie_type(pdev) == PCI_EXP_TYPE_PCIE_BRIDGE ||
1035 !pdev->bus->parent->self) {
1038 struct pcie_link_state *parent;
1040 parent = pdev->bus->parent->self->link_state;
1046 link->parent = parent;
1047 link->root = link->parent->root;
1050 list_add(&link->sibling, &link_list);
1051 pdev->link_state = link;
1055 static void pcie_aspm_update_sysfs_visibility(struct pci_dev *pdev)
1057 struct pci_dev *child;
1059 list_for_each_entry(child, &pdev->subordinate->devices, bus_list)
1060 sysfs_update_group(&child->dev.kobj, &aspm_ctrl_attr_group);
1064 * pcie_aspm_init_link_state: Initiate PCI express link state.
1065 * It is called after the pcie and its children devices are scanned.
1066 * @pdev: the root port or switch downstream port
1068 void pcie_aspm_init_link_state(struct pci_dev *pdev)
1070 struct pcie_link_state *link;
1071 int blacklist = !!pcie_aspm_sanity_check(pdev);
1073 if (!aspm_support_enabled)
1076 if (pdev->link_state)
1080 * We allocate pcie_link_state for the component on the upstream
1081 * end of a Link, so there's nothing to do unless this device is
1084 if (!pcie_downstream_port(pdev))
1087 /* VIA has a strange chipset, root port is under a bridge */
1088 if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT &&
1092 down_read(&pci_bus_sem);
1093 if (list_empty(&pdev->subordinate->devices))
1096 mutex_lock(&aspm_lock);
1097 link = alloc_pcie_link_state(pdev);
1101 * Setup initial ASPM state. Note that we need to configure
1102 * upstream links also because capable state of them can be
1103 * update through pcie_aspm_cap_init().
1105 pcie_aspm_cap_init(link, blacklist);
1107 /* Setup initial Clock PM state */
1108 pcie_clkpm_cap_init(link, blacklist);
1111 * At this stage drivers haven't had an opportunity to change the
1112 * link policy setting. Enabling ASPM on broken hardware can cripple
1113 * it even before the driver has had a chance to disable ASPM, so
1114 * default to a safe level right now. If we're enabling ASPM beyond
1115 * the BIOS's expectation, we'll do so once pci_enable_device() is
1118 if (aspm_policy != POLICY_POWERSAVE &&
1119 aspm_policy != POLICY_POWER_SUPERSAVE) {
1120 pcie_config_aspm_path(link);
1121 pcie_set_clkpm(link, policy_to_clkpm_state(link));
1124 pcie_aspm_update_sysfs_visibility(pdev);
1127 mutex_unlock(&aspm_lock);
1129 up_read(&pci_bus_sem);
1132 void pci_bridge_reconfigure_ltr(struct pci_dev *pdev)
1134 struct pci_dev *bridge;
1137 bridge = pci_upstream_bridge(pdev);
1138 if (bridge && bridge->ltr_path) {
1139 pcie_capability_read_dword(bridge, PCI_EXP_DEVCTL2, &ctl);
1140 if (!(ctl & PCI_EXP_DEVCTL2_LTR_EN)) {
1141 pci_dbg(bridge, "re-enabling LTR\n");
1142 pcie_capability_set_word(bridge, PCI_EXP_DEVCTL2,
1143 PCI_EXP_DEVCTL2_LTR_EN);
1148 void pci_configure_ltr(struct pci_dev *pdev)
1150 struct pci_host_bridge *host = pci_find_host_bridge(pdev->bus);
1151 struct pci_dev *bridge;
1154 if (!pci_is_pcie(pdev))
1157 pcie_capability_read_dword(pdev, PCI_EXP_DEVCAP2, &cap);
1158 if (!(cap & PCI_EXP_DEVCAP2_LTR))
1161 pcie_capability_read_dword(pdev, PCI_EXP_DEVCTL2, &ctl);
1162 if (ctl & PCI_EXP_DEVCTL2_LTR_EN) {
1163 if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT) {
1168 bridge = pci_upstream_bridge(pdev);
1169 if (bridge && bridge->ltr_path)
1175 if (!host->native_ltr)
1179 * Software must not enable LTR in an Endpoint unless the Root
1180 * Complex and all intermediate Switches indicate support for LTR.
1181 * PCIe r4.0, sec 6.18.
1183 if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT) {
1184 pcie_capability_set_word(pdev, PCI_EXP_DEVCTL2,
1185 PCI_EXP_DEVCTL2_LTR_EN);
1191 * If we're configuring a hot-added device, LTR was likely
1192 * disabled in the upstream bridge, so re-enable it before enabling
1193 * it in the new device.
1195 bridge = pci_upstream_bridge(pdev);
1196 if (bridge && bridge->ltr_path) {
1197 pci_bridge_reconfigure_ltr(pdev);
1198 pcie_capability_set_word(pdev, PCI_EXP_DEVCTL2,
1199 PCI_EXP_DEVCTL2_LTR_EN);
1204 /* Recheck latencies and update aspm_capable for links under the root */
1205 static void pcie_update_aspm_capable(struct pcie_link_state *root)
1207 struct pcie_link_state *link;
1208 BUG_ON(root->parent);
1209 list_for_each_entry(link, &link_list, sibling) {
1210 if (link->root != root)
1212 link->aspm_capable = link->aspm_support;
1214 list_for_each_entry(link, &link_list, sibling) {
1215 struct pci_dev *child;
1216 struct pci_bus *linkbus = link->pdev->subordinate;
1217 if (link->root != root)
1219 list_for_each_entry(child, &linkbus->devices, bus_list) {
1220 if ((pci_pcie_type(child) != PCI_EXP_TYPE_ENDPOINT) &&
1221 (pci_pcie_type(child) != PCI_EXP_TYPE_LEG_END))
1223 pcie_aspm_check_latency(child);
1228 /* @pdev: the endpoint device */
1229 void pcie_aspm_exit_link_state(struct pci_dev *pdev)
1231 struct pci_dev *parent = pdev->bus->self;
1232 struct pcie_link_state *link, *root, *parent_link;
1234 if (!parent || !parent->link_state)
1237 down_read(&pci_bus_sem);
1238 mutex_lock(&aspm_lock);
1240 link = parent->link_state;
1242 parent_link = link->parent;
1245 * link->downstream is a pointer to the pci_dev of function 0. If
1246 * we remove that function, the pci_dev is about to be deallocated,
1247 * so we can't use link->downstream again. Free the link state to
1250 * If we're removing a non-0 function, it's possible we could
1251 * retain the link state, but PCIe r6.0, sec 7.5.3.7, recommends
1252 * programming the same ASPM Control value for all functions of
1253 * multi-function devices, so disable ASPM for all of them.
1255 pcie_config_aspm_link(link, 0);
1256 list_del(&link->sibling);
1257 free_link_state(link);
1259 /* Recheck latencies and configure upstream links */
1261 pcie_update_aspm_capable(root);
1262 pcie_config_aspm_path(parent_link);
1265 mutex_unlock(&aspm_lock);
1266 up_read(&pci_bus_sem);
1270 * @pdev: the root port or switch downstream port
1271 * @locked: whether pci_bus_sem is held
1273 void pcie_aspm_pm_state_change(struct pci_dev *pdev, bool locked)
1275 struct pcie_link_state *link = pdev->link_state;
1277 if (aspm_disabled || !link)
1280 * Devices changed PM state, we should recheck if latency
1281 * meets all functions' requirement
1284 down_read(&pci_bus_sem);
1285 mutex_lock(&aspm_lock);
1286 pcie_update_aspm_capable(link->root);
1287 pcie_config_aspm_path(link);
1288 mutex_unlock(&aspm_lock);
1290 up_read(&pci_bus_sem);
1293 void pcie_aspm_powersave_config_link(struct pci_dev *pdev)
1295 struct pcie_link_state *link = pdev->link_state;
1297 if (aspm_disabled || !link)
1300 if (aspm_policy != POLICY_POWERSAVE &&
1301 aspm_policy != POLICY_POWER_SUPERSAVE)
1304 down_read(&pci_bus_sem);
1305 mutex_lock(&aspm_lock);
1306 pcie_config_aspm_path(link);
1307 pcie_set_clkpm(link, policy_to_clkpm_state(link));
1308 mutex_unlock(&aspm_lock);
1309 up_read(&pci_bus_sem);
1312 static struct pcie_link_state *pcie_aspm_get_link(struct pci_dev *pdev)
1314 struct pci_dev *bridge;
1316 if (!pci_is_pcie(pdev))
1319 bridge = pci_upstream_bridge(pdev);
1320 if (!bridge || !pci_is_pcie(bridge))
1323 return bridge->link_state;
1326 static u8 pci_calc_aspm_disable_mask(int state)
1328 state &= ~PCIE_LINK_STATE_CLKPM;
1330 /* L1 PM substates require L1 */
1331 if (state & PCIE_LINK_STATE_L1)
1332 state |= PCIE_LINK_STATE_L1SS;
1337 static u8 pci_calc_aspm_enable_mask(int state)
1339 state &= ~PCIE_LINK_STATE_CLKPM;
1341 /* L1 PM substates require L1 */
1342 if (state & PCIE_LINK_STATE_L1SS)
1343 state |= PCIE_LINK_STATE_L1;
1348 static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool locked)
1350 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1355 * A driver requested that ASPM be disabled on this device, but
1356 * if we don't have permission to manage ASPM (e.g., on ACPI
1357 * systems we have to observe the FADT ACPI_FADT_NO_ASPM bit and
1358 * the _OSC method), we can't honor that request. Windows has
1359 * a similar mechanism using "PciASPMOptOut", which is also
1360 * ignored in this situation.
1362 if (aspm_disabled) {
1363 pci_warn(pdev, "can't disable ASPM; OS doesn't have ASPM control\n");
1368 down_read(&pci_bus_sem);
1369 mutex_lock(&aspm_lock);
1370 link->aspm_disable |= pci_calc_aspm_disable_mask(state);
1371 pcie_config_aspm_link(link, policy_to_aspm_state(link));
1373 if (state & PCIE_LINK_STATE_CLKPM)
1374 link->clkpm_disable = 1;
1375 pcie_set_clkpm(link, policy_to_clkpm_state(link));
1376 mutex_unlock(&aspm_lock);
1378 up_read(&pci_bus_sem);
1383 int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
1385 lockdep_assert_held_read(&pci_bus_sem);
1387 return __pci_disable_link_state(pdev, state, true);
1389 EXPORT_SYMBOL(pci_disable_link_state_locked);
1392 * pci_disable_link_state - Disable device's link state, so the link will
1393 * never enter specific states. Note that if the BIOS didn't grant ASPM
1394 * control to the OS, this does nothing because we can't touch the LNKCTL
1395 * register. Returns 0 or a negative errno.
1398 * @state: ASPM link state to disable
1400 int pci_disable_link_state(struct pci_dev *pdev, int state)
1402 return __pci_disable_link_state(pdev, state, false);
1404 EXPORT_SYMBOL(pci_disable_link_state);
1406 static int __pci_enable_link_state(struct pci_dev *pdev, int state, bool locked)
1408 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1413 * A driver requested that ASPM be enabled on this device, but
1414 * if we don't have permission to manage ASPM (e.g., on ACPI
1415 * systems we have to observe the FADT ACPI_FADT_NO_ASPM bit and
1416 * the _OSC method), we can't honor that request.
1418 if (aspm_disabled) {
1419 pci_warn(pdev, "can't override BIOS ASPM; OS doesn't have ASPM control\n");
1424 down_read(&pci_bus_sem);
1425 mutex_lock(&aspm_lock);
1426 link->aspm_default = pci_calc_aspm_enable_mask(state);
1427 pcie_config_aspm_link(link, policy_to_aspm_state(link));
1429 link->clkpm_default = (state & PCIE_LINK_STATE_CLKPM) ? 1 : 0;
1430 pcie_set_clkpm(link, policy_to_clkpm_state(link));
1431 mutex_unlock(&aspm_lock);
1433 up_read(&pci_bus_sem);
1439 * pci_enable_link_state - Clear and set the default device link state so that
1440 * the link may be allowed to enter the specified states. Note that if the
1441 * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
1442 * touch the LNKCTL register. Also note that this does not enable states
1443 * disabled by pci_disable_link_state(). Return 0 or a negative errno.
1446 * @state: Mask of ASPM link states to enable
1448 int pci_enable_link_state(struct pci_dev *pdev, int state)
1450 return __pci_enable_link_state(pdev, state, false);
1452 EXPORT_SYMBOL(pci_enable_link_state);
1455 * pci_enable_link_state_locked - Clear and set the default device link state
1456 * so that the link may be allowed to enter the specified states. Note that if
1457 * the BIOS didn't grant ASPM control to the OS, this does nothing because we
1458 * can't touch the LNKCTL register. Also note that this does not enable states
1459 * disabled by pci_disable_link_state(). Return 0 or a negative errno.
1462 * @state: Mask of ASPM link states to enable
1464 * Context: Caller holds pci_bus_sem read lock.
1466 int pci_enable_link_state_locked(struct pci_dev *pdev, int state)
1468 lockdep_assert_held_read(&pci_bus_sem);
1470 return __pci_enable_link_state(pdev, state, true);
1472 EXPORT_SYMBOL(pci_enable_link_state_locked);
1474 static int pcie_aspm_set_policy(const char *val,
1475 const struct kernel_param *kp)
1478 struct pcie_link_state *link;
1482 i = sysfs_match_string(policy_str, val);
1485 if (i == aspm_policy)
1488 down_read(&pci_bus_sem);
1489 mutex_lock(&aspm_lock);
1491 list_for_each_entry(link, &link_list, sibling) {
1492 pcie_config_aspm_link(link, policy_to_aspm_state(link));
1493 pcie_set_clkpm(link, policy_to_clkpm_state(link));
1495 mutex_unlock(&aspm_lock);
1496 up_read(&pci_bus_sem);
1500 static int pcie_aspm_get_policy(char *buffer, const struct kernel_param *kp)
1503 for (i = 0; i < ARRAY_SIZE(policy_str); i++)
1504 if (i == aspm_policy)
1505 cnt += sprintf(buffer + cnt, "[%s] ", policy_str[i]);
1507 cnt += sprintf(buffer + cnt, "%s ", policy_str[i]);
1508 cnt += sprintf(buffer + cnt, "\n");
1512 module_param_call(policy, pcie_aspm_set_policy, pcie_aspm_get_policy,
1516 * pcie_aspm_enabled - Check if PCIe ASPM has been enabled for a device.
1517 * @pdev: Target device.
1519 * Relies on the upstream bridge's link_state being valid. The link_state
1520 * is deallocated only when the last child of the bridge (i.e., @pdev or a
1521 * sibling) is removed, and the caller should be holding a reference to
1522 * @pdev, so this should be safe.
1524 bool pcie_aspm_enabled(struct pci_dev *pdev)
1526 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1531 return link->aspm_enabled;
1533 EXPORT_SYMBOL_GPL(pcie_aspm_enabled);
1535 static ssize_t aspm_attr_show_common(struct device *dev,
1536 struct device_attribute *attr,
1537 char *buf, u8 state)
1539 struct pci_dev *pdev = to_pci_dev(dev);
1540 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1542 return sysfs_emit(buf, "%d\n", (link->aspm_enabled & state) ? 1 : 0);
1545 static ssize_t aspm_attr_store_common(struct device *dev,
1546 struct device_attribute *attr,
1547 const char *buf, size_t len, u8 state)
1549 struct pci_dev *pdev = to_pci_dev(dev);
1550 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1553 if (kstrtobool(buf, &state_enable) < 0)
1556 down_read(&pci_bus_sem);
1557 mutex_lock(&aspm_lock);
1560 link->aspm_disable &= ~state;
1561 /* need to enable L1 for substates */
1562 if (state & PCIE_LINK_STATE_L1SS)
1563 link->aspm_disable &= ~PCIE_LINK_STATE_L1;
1565 link->aspm_disable |= state;
1566 if (state & PCIE_LINK_STATE_L1)
1567 link->aspm_disable |= PCIE_LINK_STATE_L1SS;
1570 pcie_config_aspm_link(link, policy_to_aspm_state(link));
1572 mutex_unlock(&aspm_lock);
1573 up_read(&pci_bus_sem);
1578 #define ASPM_ATTR(_f, _s) \
1579 static ssize_t _f##_show(struct device *dev, \
1580 struct device_attribute *attr, char *buf) \
1581 { return aspm_attr_show_common(dev, attr, buf, PCIE_LINK_STATE_##_s); } \
1583 static ssize_t _f##_store(struct device *dev, \
1584 struct device_attribute *attr, \
1585 const char *buf, size_t len) \
1586 { return aspm_attr_store_common(dev, attr, buf, len, PCIE_LINK_STATE_##_s); }
1588 ASPM_ATTR(l0s_aspm, L0S)
1589 ASPM_ATTR(l1_aspm, L1)
1590 ASPM_ATTR(l1_1_aspm, L1_1)
1591 ASPM_ATTR(l1_2_aspm, L1_2)
1592 ASPM_ATTR(l1_1_pcipm, L1_1_PCIPM)
1593 ASPM_ATTR(l1_2_pcipm, L1_2_PCIPM)
1595 static ssize_t clkpm_show(struct device *dev,
1596 struct device_attribute *attr, char *buf)
1598 struct pci_dev *pdev = to_pci_dev(dev);
1599 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1601 return sysfs_emit(buf, "%d\n", link->clkpm_enabled);
1604 static ssize_t clkpm_store(struct device *dev,
1605 struct device_attribute *attr,
1606 const char *buf, size_t len)
1608 struct pci_dev *pdev = to_pci_dev(dev);
1609 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1612 if (kstrtobool(buf, &state_enable) < 0)
1615 down_read(&pci_bus_sem);
1616 mutex_lock(&aspm_lock);
1618 link->clkpm_disable = !state_enable;
1619 pcie_set_clkpm(link, policy_to_clkpm_state(link));
1621 mutex_unlock(&aspm_lock);
1622 up_read(&pci_bus_sem);
1627 static DEVICE_ATTR_RW(clkpm);
1628 static DEVICE_ATTR_RW(l0s_aspm);
1629 static DEVICE_ATTR_RW(l1_aspm);
1630 static DEVICE_ATTR_RW(l1_1_aspm);
1631 static DEVICE_ATTR_RW(l1_2_aspm);
1632 static DEVICE_ATTR_RW(l1_1_pcipm);
1633 static DEVICE_ATTR_RW(l1_2_pcipm);
1635 static struct attribute *aspm_ctrl_attrs[] = {
1636 &dev_attr_clkpm.attr,
1637 &dev_attr_l0s_aspm.attr,
1638 &dev_attr_l1_aspm.attr,
1639 &dev_attr_l1_1_aspm.attr,
1640 &dev_attr_l1_2_aspm.attr,
1641 &dev_attr_l1_1_pcipm.attr,
1642 &dev_attr_l1_2_pcipm.attr,
1646 static umode_t aspm_ctrl_attrs_are_visible(struct kobject *kobj,
1647 struct attribute *a, int n)
1649 struct device *dev = kobj_to_dev(kobj);
1650 struct pci_dev *pdev = to_pci_dev(dev);
1651 struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1652 static const u8 aspm_state_map[] = {
1653 PCIE_LINK_STATE_L0S,
1655 PCIE_LINK_STATE_L1_1,
1656 PCIE_LINK_STATE_L1_2,
1657 PCIE_LINK_STATE_L1_1_PCIPM,
1658 PCIE_LINK_STATE_L1_2_PCIPM,
1661 if (aspm_disabled || !link)
1665 return link->clkpm_capable ? a->mode : 0;
1667 return link->aspm_capable & aspm_state_map[n - 1] ? a->mode : 0;
1670 const struct attribute_group aspm_ctrl_attr_group = {
1672 .attrs = aspm_ctrl_attrs,
1673 .is_visible = aspm_ctrl_attrs_are_visible,
1676 static int __init pcie_aspm_disable(char *str)
1678 if (!strcmp(str, "off")) {
1679 aspm_policy = POLICY_DEFAULT;
1681 aspm_support_enabled = false;
1682 pr_info("PCIe ASPM is disabled\n");
1683 } else if (!strcmp(str, "force")) {
1685 pr_info("PCIe ASPM is forcibly enabled\n");
1690 __setup("pcie_aspm=", pcie_aspm_disable);
1692 void pcie_no_aspm(void)
1695 * Disabling ASPM is intended to prevent the kernel from modifying
1696 * existing hardware state, not to clear existing state. To that end:
1697 * (a) set policy to POLICY_DEFAULT in order to avoid changing state
1698 * (b) prevent userspace from changing policy
1701 aspm_policy = POLICY_DEFAULT;
1706 bool pcie_aspm_support_enabled(void)
1708 return aspm_support_enabled;
1711 #endif /* CONFIG_PCIEASPM */