xref: /openbmc/linux/drivers/pci/pcie/aspm.c (revision 002dff36)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Enable PCIe link L0s/L1 state and Clock Power Management
4  *
5  * Copyright (C) 2007 Intel
6  * Copyright (C) Zhang Yanmin (yanmin.zhang@intel.com)
7  * Copyright (C) Shaohua Li (shaohua.li@intel.com)
8  */
9 
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/pci.h>
14 #include <linux/pci_regs.h>
15 #include <linux/errno.h>
16 #include <linux/pm.h>
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/jiffies.h>
20 #include <linux/delay.h>
21 #include "../pci.h"
22 
23 #ifdef MODULE_PARAM_PREFIX
24 #undef MODULE_PARAM_PREFIX
25 #endif
26 #define MODULE_PARAM_PREFIX "pcie_aspm."
27 
28 /* Note: those are not register definitions */
29 #define ASPM_STATE_L0S_UP	(1)	/* Upstream direction L0s state */
30 #define ASPM_STATE_L0S_DW	(2)	/* Downstream direction L0s state */
31 #define ASPM_STATE_L1		(4)	/* L1 state */
32 #define ASPM_STATE_L1_1		(8)	/* ASPM L1.1 state */
33 #define ASPM_STATE_L1_2		(0x10)	/* ASPM L1.2 state */
34 #define ASPM_STATE_L1_1_PCIPM	(0x20)	/* PCI PM L1.1 state */
35 #define ASPM_STATE_L1_2_PCIPM	(0x40)	/* PCI PM L1.2 state */
36 #define ASPM_STATE_L1_SS_PCIPM	(ASPM_STATE_L1_1_PCIPM | ASPM_STATE_L1_2_PCIPM)
37 #define ASPM_STATE_L1_2_MASK	(ASPM_STATE_L1_2 | ASPM_STATE_L1_2_PCIPM)
38 #define ASPM_STATE_L1SS		(ASPM_STATE_L1_1 | ASPM_STATE_L1_1_PCIPM |\
39 				 ASPM_STATE_L1_2_MASK)
40 #define ASPM_STATE_L0S		(ASPM_STATE_L0S_UP | ASPM_STATE_L0S_DW)
41 #define ASPM_STATE_ALL		(ASPM_STATE_L0S | ASPM_STATE_L1 |	\
42 				 ASPM_STATE_L1SS)
43 
44 struct aspm_latency {
45 	u32 l0s;			/* L0s latency (nsec) */
46 	u32 l1;				/* L1 latency (nsec) */
47 };
48 
49 struct pcie_link_state {
50 	struct pci_dev *pdev;		/* Upstream component of the Link */
51 	struct pci_dev *downstream;	/* Downstream component, function 0 */
52 	struct pcie_link_state *root;	/* pointer to the root port link */
53 	struct pcie_link_state *parent;	/* pointer to the parent Link state */
54 	struct list_head sibling;	/* node in link_list */
55 
56 	/* ASPM state */
57 	u32 aspm_support:7;		/* Supported ASPM state */
58 	u32 aspm_enabled:7;		/* Enabled ASPM state */
59 	u32 aspm_capable:7;		/* Capable ASPM state with latency */
60 	u32 aspm_default:7;		/* Default ASPM state by BIOS */
61 	u32 aspm_disable:7;		/* Disabled ASPM state */
62 
63 	/* Clock PM state */
64 	u32 clkpm_capable:1;		/* Clock PM capable? */
65 	u32 clkpm_enabled:1;		/* Current Clock PM state */
66 	u32 clkpm_default:1;		/* Default Clock PM state by BIOS */
67 	u32 clkpm_disable:1;		/* Clock PM disabled */
68 
69 	/* Exit latencies */
70 	struct aspm_latency latency_up;	/* Upstream direction exit latency */
71 	struct aspm_latency latency_dw;	/* Downstream direction exit latency */
72 	/*
73 	 * Endpoint acceptable latencies. A pcie downstream port only
74 	 * has one slot under it, so at most there are 8 functions.
75 	 */
76 	struct aspm_latency acceptable[8];
77 
78 	/* L1 PM Substate info */
79 	struct {
80 		u32 up_cap_ptr;		/* L1SS cap ptr in upstream dev */
81 		u32 dw_cap_ptr;		/* L1SS cap ptr in downstream dev */
82 		u32 ctl1;		/* value to be programmed in ctl1 */
83 		u32 ctl2;		/* value to be programmed in ctl2 */
84 	} l1ss;
85 };
86 
87 static int aspm_disabled, aspm_force;
88 static bool aspm_support_enabled = true;
89 static DEFINE_MUTEX(aspm_lock);
90 static LIST_HEAD(link_list);
91 
92 #define POLICY_DEFAULT 0	/* BIOS default setting */
93 #define POLICY_PERFORMANCE 1	/* high performance */
94 #define POLICY_POWERSAVE 2	/* high power saving */
95 #define POLICY_POWER_SUPERSAVE 3 /* possibly even more power saving */
96 
97 #ifdef CONFIG_PCIEASPM_PERFORMANCE
98 static int aspm_policy = POLICY_PERFORMANCE;
99 #elif defined CONFIG_PCIEASPM_POWERSAVE
100 static int aspm_policy = POLICY_POWERSAVE;
101 #elif defined CONFIG_PCIEASPM_POWER_SUPERSAVE
102 static int aspm_policy = POLICY_POWER_SUPERSAVE;
103 #else
104 static int aspm_policy;
105 #endif
106 
107 static const char *policy_str[] = {
108 	[POLICY_DEFAULT] = "default",
109 	[POLICY_PERFORMANCE] = "performance",
110 	[POLICY_POWERSAVE] = "powersave",
111 	[POLICY_POWER_SUPERSAVE] = "powersupersave"
112 };
113 
114 #define LINK_RETRAIN_TIMEOUT HZ
115 
116 static int policy_to_aspm_state(struct pcie_link_state *link)
117 {
118 	switch (aspm_policy) {
119 	case POLICY_PERFORMANCE:
120 		/* Disable ASPM and Clock PM */
121 		return 0;
122 	case POLICY_POWERSAVE:
123 		/* Enable ASPM L0s/L1 */
124 		return (ASPM_STATE_L0S | ASPM_STATE_L1);
125 	case POLICY_POWER_SUPERSAVE:
126 		/* Enable Everything */
127 		return ASPM_STATE_ALL;
128 	case POLICY_DEFAULT:
129 		return link->aspm_default;
130 	}
131 	return 0;
132 }
133 
134 static int policy_to_clkpm_state(struct pcie_link_state *link)
135 {
136 	switch (aspm_policy) {
137 	case POLICY_PERFORMANCE:
138 		/* Disable ASPM and Clock PM */
139 		return 0;
140 	case POLICY_POWERSAVE:
141 	case POLICY_POWER_SUPERSAVE:
142 		/* Enable Clock PM */
143 		return 1;
144 	case POLICY_DEFAULT:
145 		return link->clkpm_default;
146 	}
147 	return 0;
148 }
149 
150 static void pcie_set_clkpm_nocheck(struct pcie_link_state *link, int enable)
151 {
152 	struct pci_dev *child;
153 	struct pci_bus *linkbus = link->pdev->subordinate;
154 	u32 val = enable ? PCI_EXP_LNKCTL_CLKREQ_EN : 0;
155 
156 	list_for_each_entry(child, &linkbus->devices, bus_list)
157 		pcie_capability_clear_and_set_word(child, PCI_EXP_LNKCTL,
158 						   PCI_EXP_LNKCTL_CLKREQ_EN,
159 						   val);
160 	link->clkpm_enabled = !!enable;
161 }
162 
163 static void pcie_set_clkpm(struct pcie_link_state *link, int enable)
164 {
165 	/*
166 	 * Don't enable Clock PM if the link is not Clock PM capable
167 	 * or Clock PM is disabled
168 	 */
169 	if (!link->clkpm_capable || link->clkpm_disable)
170 		enable = 0;
171 	/* Need nothing if the specified equals to current state */
172 	if (link->clkpm_enabled == enable)
173 		return;
174 	pcie_set_clkpm_nocheck(link, enable);
175 }
176 
177 static void pcie_clkpm_cap_init(struct pcie_link_state *link, int blacklist)
178 {
179 	int capable = 1, enabled = 1;
180 	u32 reg32;
181 	u16 reg16;
182 	struct pci_dev *child;
183 	struct pci_bus *linkbus = link->pdev->subordinate;
184 
185 	/* All functions should have the same cap and state, take the worst */
186 	list_for_each_entry(child, &linkbus->devices, bus_list) {
187 		pcie_capability_read_dword(child, PCI_EXP_LNKCAP, &reg32);
188 		if (!(reg32 & PCI_EXP_LNKCAP_CLKPM)) {
189 			capable = 0;
190 			enabled = 0;
191 			break;
192 		}
193 		pcie_capability_read_word(child, PCI_EXP_LNKCTL, &reg16);
194 		if (!(reg16 & PCI_EXP_LNKCTL_CLKREQ_EN))
195 			enabled = 0;
196 	}
197 	link->clkpm_enabled = enabled;
198 	link->clkpm_default = enabled;
199 	link->clkpm_capable = capable;
200 	link->clkpm_disable = blacklist ? 1 : 0;
201 }
202 
203 static bool pcie_retrain_link(struct pcie_link_state *link)
204 {
205 	struct pci_dev *parent = link->pdev;
206 	unsigned long end_jiffies;
207 	u16 reg16;
208 
209 	pcie_capability_read_word(parent, PCI_EXP_LNKCTL, &reg16);
210 	reg16 |= PCI_EXP_LNKCTL_RL;
211 	pcie_capability_write_word(parent, PCI_EXP_LNKCTL, reg16);
212 	if (parent->clear_retrain_link) {
213 		/*
214 		 * Due to an erratum in some devices the Retrain Link bit
215 		 * needs to be cleared again manually to allow the link
216 		 * training to succeed.
217 		 */
218 		reg16 &= ~PCI_EXP_LNKCTL_RL;
219 		pcie_capability_write_word(parent, PCI_EXP_LNKCTL, reg16);
220 	}
221 
222 	/* Wait for link training end. Break out after waiting for timeout */
223 	end_jiffies = jiffies + LINK_RETRAIN_TIMEOUT;
224 	do {
225 		pcie_capability_read_word(parent, PCI_EXP_LNKSTA, &reg16);
226 		if (!(reg16 & PCI_EXP_LNKSTA_LT))
227 			break;
228 		msleep(1);
229 	} while (time_before(jiffies, end_jiffies));
230 	return !(reg16 & PCI_EXP_LNKSTA_LT);
231 }
232 
233 /*
234  * pcie_aspm_configure_common_clock: check if the 2 ends of a link
235  *   could use common clock. If they are, configure them to use the
236  *   common clock. That will reduce the ASPM state exit latency.
237  */
238 static void pcie_aspm_configure_common_clock(struct pcie_link_state *link)
239 {
240 	int same_clock = 1;
241 	u16 reg16, parent_reg, child_reg[8];
242 	struct pci_dev *child, *parent = link->pdev;
243 	struct pci_bus *linkbus = parent->subordinate;
244 	/*
245 	 * All functions of a slot should have the same Slot Clock
246 	 * Configuration, so just check one function
247 	 */
248 	child = list_entry(linkbus->devices.next, struct pci_dev, bus_list);
249 	BUG_ON(!pci_is_pcie(child));
250 
251 	/* Check downstream component if bit Slot Clock Configuration is 1 */
252 	pcie_capability_read_word(child, PCI_EXP_LNKSTA, &reg16);
253 	if (!(reg16 & PCI_EXP_LNKSTA_SLC))
254 		same_clock = 0;
255 
256 	/* Check upstream component if bit Slot Clock Configuration is 1 */
257 	pcie_capability_read_word(parent, PCI_EXP_LNKSTA, &reg16);
258 	if (!(reg16 & PCI_EXP_LNKSTA_SLC))
259 		same_clock = 0;
260 
261 	/* Port might be already in common clock mode */
262 	pcie_capability_read_word(parent, PCI_EXP_LNKCTL, &reg16);
263 	if (same_clock && (reg16 & PCI_EXP_LNKCTL_CCC)) {
264 		bool consistent = true;
265 
266 		list_for_each_entry(child, &linkbus->devices, bus_list) {
267 			pcie_capability_read_word(child, PCI_EXP_LNKCTL,
268 						  &reg16);
269 			if (!(reg16 & PCI_EXP_LNKCTL_CCC)) {
270 				consistent = false;
271 				break;
272 			}
273 		}
274 		if (consistent)
275 			return;
276 		pci_info(parent, "ASPM: current common clock configuration is inconsistent, reconfiguring\n");
277 	}
278 
279 	/* Configure downstream component, all functions */
280 	list_for_each_entry(child, &linkbus->devices, bus_list) {
281 		pcie_capability_read_word(child, PCI_EXP_LNKCTL, &reg16);
282 		child_reg[PCI_FUNC(child->devfn)] = reg16;
283 		if (same_clock)
284 			reg16 |= PCI_EXP_LNKCTL_CCC;
285 		else
286 			reg16 &= ~PCI_EXP_LNKCTL_CCC;
287 		pcie_capability_write_word(child, PCI_EXP_LNKCTL, reg16);
288 	}
289 
290 	/* Configure upstream component */
291 	pcie_capability_read_word(parent, PCI_EXP_LNKCTL, &reg16);
292 	parent_reg = reg16;
293 	if (same_clock)
294 		reg16 |= PCI_EXP_LNKCTL_CCC;
295 	else
296 		reg16 &= ~PCI_EXP_LNKCTL_CCC;
297 	pcie_capability_write_word(parent, PCI_EXP_LNKCTL, reg16);
298 
299 	if (pcie_retrain_link(link))
300 		return;
301 
302 	/* Training failed. Restore common clock configurations */
303 	pci_err(parent, "ASPM: Could not configure common clock\n");
304 	list_for_each_entry(child, &linkbus->devices, bus_list)
305 		pcie_capability_write_word(child, PCI_EXP_LNKCTL,
306 					   child_reg[PCI_FUNC(child->devfn)]);
307 	pcie_capability_write_word(parent, PCI_EXP_LNKCTL, parent_reg);
308 }
309 
310 /* Convert L0s latency encoding to ns */
311 static u32 calc_l0s_latency(u32 encoding)
312 {
313 	if (encoding == 0x7)
314 		return (5 * 1000);	/* > 4us */
315 	return (64 << encoding);
316 }
317 
318 /* Convert L0s acceptable latency encoding to ns */
319 static u32 calc_l0s_acceptable(u32 encoding)
320 {
321 	if (encoding == 0x7)
322 		return -1U;
323 	return (64 << encoding);
324 }
325 
326 /* Convert L1 latency encoding to ns */
327 static u32 calc_l1_latency(u32 encoding)
328 {
329 	if (encoding == 0x7)
330 		return (65 * 1000);	/* > 64us */
331 	return (1000 << encoding);
332 }
333 
334 /* Convert L1 acceptable latency encoding to ns */
335 static u32 calc_l1_acceptable(u32 encoding)
336 {
337 	if (encoding == 0x7)
338 		return -1U;
339 	return (1000 << encoding);
340 }
341 
342 /* Convert L1SS T_pwr encoding to usec */
343 static u32 calc_l1ss_pwron(struct pci_dev *pdev, u32 scale, u32 val)
344 {
345 	switch (scale) {
346 	case 0:
347 		return val * 2;
348 	case 1:
349 		return val * 10;
350 	case 2:
351 		return val * 100;
352 	}
353 	pci_err(pdev, "%s: Invalid T_PwrOn scale: %u\n", __func__, scale);
354 	return 0;
355 }
356 
357 static void encode_l12_threshold(u32 threshold_us, u32 *scale, u32 *value)
358 {
359 	u32 threshold_ns = threshold_us * 1000;
360 
361 	/* See PCIe r3.1, sec 7.33.3 and sec 6.18 */
362 	if (threshold_ns < 32) {
363 		*scale = 0;
364 		*value = threshold_ns;
365 	} else if (threshold_ns < 1024) {
366 		*scale = 1;
367 		*value = threshold_ns >> 5;
368 	} else if (threshold_ns < 32768) {
369 		*scale = 2;
370 		*value = threshold_ns >> 10;
371 	} else if (threshold_ns < 1048576) {
372 		*scale = 3;
373 		*value = threshold_ns >> 15;
374 	} else if (threshold_ns < 33554432) {
375 		*scale = 4;
376 		*value = threshold_ns >> 20;
377 	} else {
378 		*scale = 5;
379 		*value = threshold_ns >> 25;
380 	}
381 }
382 
383 struct aspm_register_info {
384 	u32 support:2;
385 	u32 enabled:2;
386 	u32 latency_encoding_l0s;
387 	u32 latency_encoding_l1;
388 
389 	/* L1 substates */
390 	u32 l1ss_cap_ptr;
391 	u32 l1ss_cap;
392 	u32 l1ss_ctl1;
393 	u32 l1ss_ctl2;
394 };
395 
396 static void pcie_get_aspm_reg(struct pci_dev *pdev,
397 			      struct aspm_register_info *info)
398 {
399 	u16 reg16;
400 	u32 reg32;
401 
402 	pcie_capability_read_dword(pdev, PCI_EXP_LNKCAP, &reg32);
403 	info->support = (reg32 & PCI_EXP_LNKCAP_ASPMS) >> 10;
404 	info->latency_encoding_l0s = (reg32 & PCI_EXP_LNKCAP_L0SEL) >> 12;
405 	info->latency_encoding_l1  = (reg32 & PCI_EXP_LNKCAP_L1EL) >> 15;
406 	pcie_capability_read_word(pdev, PCI_EXP_LNKCTL, &reg16);
407 	info->enabled = reg16 & PCI_EXP_LNKCTL_ASPMC;
408 
409 	/* Read L1 PM substate capabilities */
410 	info->l1ss_cap = info->l1ss_ctl1 = info->l1ss_ctl2 = 0;
411 	info->l1ss_cap_ptr = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_L1SS);
412 	if (!info->l1ss_cap_ptr)
413 		return;
414 	pci_read_config_dword(pdev, info->l1ss_cap_ptr + PCI_L1SS_CAP,
415 			      &info->l1ss_cap);
416 	if (!(info->l1ss_cap & PCI_L1SS_CAP_L1_PM_SS)) {
417 		info->l1ss_cap = 0;
418 		return;
419 	}
420 
421 	/*
422 	 * If we don't have LTR for the entire path from the Root Complex
423 	 * to this device, we can't use ASPM L1.2 because it relies on the
424 	 * LTR_L1.2_THRESHOLD.  See PCIe r4.0, secs 5.5.4, 6.18.
425 	 */
426 	if (!pdev->ltr_path)
427 		info->l1ss_cap &= ~PCI_L1SS_CAP_ASPM_L1_2;
428 
429 	pci_read_config_dword(pdev, info->l1ss_cap_ptr + PCI_L1SS_CTL1,
430 			      &info->l1ss_ctl1);
431 	pci_read_config_dword(pdev, info->l1ss_cap_ptr + PCI_L1SS_CTL2,
432 			      &info->l1ss_ctl2);
433 }
434 
435 static void pcie_aspm_check_latency(struct pci_dev *endpoint)
436 {
437 	u32 latency, l1_switch_latency = 0;
438 	struct aspm_latency *acceptable;
439 	struct pcie_link_state *link;
440 
441 	/* Device not in D0 doesn't need latency check */
442 	if ((endpoint->current_state != PCI_D0) &&
443 	    (endpoint->current_state != PCI_UNKNOWN))
444 		return;
445 
446 	link = endpoint->bus->self->link_state;
447 	acceptable = &link->acceptable[PCI_FUNC(endpoint->devfn)];
448 
449 	while (link) {
450 		/* Check upstream direction L0s latency */
451 		if ((link->aspm_capable & ASPM_STATE_L0S_UP) &&
452 		    (link->latency_up.l0s > acceptable->l0s))
453 			link->aspm_capable &= ~ASPM_STATE_L0S_UP;
454 
455 		/* Check downstream direction L0s latency */
456 		if ((link->aspm_capable & ASPM_STATE_L0S_DW) &&
457 		    (link->latency_dw.l0s > acceptable->l0s))
458 			link->aspm_capable &= ~ASPM_STATE_L0S_DW;
459 		/*
460 		 * Check L1 latency.
461 		 * Every switch on the path to root complex need 1
462 		 * more microsecond for L1. Spec doesn't mention L0s.
463 		 *
464 		 * The exit latencies for L1 substates are not advertised
465 		 * by a device.  Since the spec also doesn't mention a way
466 		 * to determine max latencies introduced by enabling L1
467 		 * substates on the components, it is not clear how to do
468 		 * a L1 substate exit latency check.  We assume that the
469 		 * L1 exit latencies advertised by a device include L1
470 		 * substate latencies (and hence do not do any check).
471 		 */
472 		latency = max_t(u32, link->latency_up.l1, link->latency_dw.l1);
473 		if ((link->aspm_capable & ASPM_STATE_L1) &&
474 		    (latency + l1_switch_latency > acceptable->l1))
475 			link->aspm_capable &= ~ASPM_STATE_L1;
476 		l1_switch_latency += 1000;
477 
478 		link = link->parent;
479 	}
480 }
481 
482 /*
483  * The L1 PM substate capability is only implemented in function 0 in a
484  * multi function device.
485  */
486 static struct pci_dev *pci_function_0(struct pci_bus *linkbus)
487 {
488 	struct pci_dev *child;
489 
490 	list_for_each_entry(child, &linkbus->devices, bus_list)
491 		if (PCI_FUNC(child->devfn) == 0)
492 			return child;
493 	return NULL;
494 }
495 
496 /* Calculate L1.2 PM substate timing parameters */
497 static void aspm_calc_l1ss_info(struct pcie_link_state *link,
498 				struct aspm_register_info *upreg,
499 				struct aspm_register_info *dwreg)
500 {
501 	u32 val1, val2, scale1, scale2;
502 	u32 t_common_mode, t_power_on, l1_2_threshold, scale, value;
503 
504 	link->l1ss.up_cap_ptr = upreg->l1ss_cap_ptr;
505 	link->l1ss.dw_cap_ptr = dwreg->l1ss_cap_ptr;
506 	link->l1ss.ctl1 = link->l1ss.ctl2 = 0;
507 
508 	if (!(link->aspm_support & ASPM_STATE_L1_2_MASK))
509 		return;
510 
511 	/* Choose the greater of the two Port Common_Mode_Restore_Times */
512 	val1 = (upreg->l1ss_cap & PCI_L1SS_CAP_CM_RESTORE_TIME) >> 8;
513 	val2 = (dwreg->l1ss_cap & PCI_L1SS_CAP_CM_RESTORE_TIME) >> 8;
514 	t_common_mode = max(val1, val2);
515 
516 	/* Choose the greater of the two Port T_POWER_ON times */
517 	val1   = (upreg->l1ss_cap & PCI_L1SS_CAP_P_PWR_ON_VALUE) >> 19;
518 	scale1 = (upreg->l1ss_cap & PCI_L1SS_CAP_P_PWR_ON_SCALE) >> 16;
519 	val2   = (dwreg->l1ss_cap & PCI_L1SS_CAP_P_PWR_ON_VALUE) >> 19;
520 	scale2 = (dwreg->l1ss_cap & PCI_L1SS_CAP_P_PWR_ON_SCALE) >> 16;
521 
522 	if (calc_l1ss_pwron(link->pdev, scale1, val1) >
523 	    calc_l1ss_pwron(link->downstream, scale2, val2)) {
524 		link->l1ss.ctl2 |= scale1 | (val1 << 3);
525 		t_power_on = calc_l1ss_pwron(link->pdev, scale1, val1);
526 	} else {
527 		link->l1ss.ctl2 |= scale2 | (val2 << 3);
528 		t_power_on = calc_l1ss_pwron(link->downstream, scale2, val2);
529 	}
530 
531 	/*
532 	 * Set LTR_L1.2_THRESHOLD to the time required to transition the
533 	 * Link from L0 to L1.2 and back to L0 so we enter L1.2 only if
534 	 * downstream devices report (via LTR) that they can tolerate at
535 	 * least that much latency.
536 	 *
537 	 * Based on PCIe r3.1, sec 5.5.3.3.1, Figures 5-16 and 5-17, and
538 	 * Table 5-11.  T(POWER_OFF) is at most 2us and T(L1.2) is at
539 	 * least 4us.
540 	 */
541 	l1_2_threshold = 2 + 4 + t_common_mode + t_power_on;
542 	encode_l12_threshold(l1_2_threshold, &scale, &value);
543 	link->l1ss.ctl1 |= t_common_mode << 8 | scale << 29 | value << 16;
544 }
545 
546 static void pcie_aspm_cap_init(struct pcie_link_state *link, int blacklist)
547 {
548 	struct pci_dev *child = link->downstream, *parent = link->pdev;
549 	struct pci_bus *linkbus = parent->subordinate;
550 	struct aspm_register_info upreg, dwreg;
551 
552 	if (blacklist) {
553 		/* Set enabled/disable so that we will disable ASPM later */
554 		link->aspm_enabled = ASPM_STATE_ALL;
555 		link->aspm_disable = ASPM_STATE_ALL;
556 		return;
557 	}
558 
559 	/* Get upstream/downstream components' register state */
560 	pcie_get_aspm_reg(parent, &upreg);
561 	pcie_get_aspm_reg(child, &dwreg);
562 
563 	/*
564 	 * If ASPM not supported, don't mess with the clocks and link,
565 	 * bail out now.
566 	 */
567 	if (!(upreg.support & dwreg.support))
568 		return;
569 
570 	/* Configure common clock before checking latencies */
571 	pcie_aspm_configure_common_clock(link);
572 
573 	/*
574 	 * Re-read upstream/downstream components' register state
575 	 * after clock configuration
576 	 */
577 	pcie_get_aspm_reg(parent, &upreg);
578 	pcie_get_aspm_reg(child, &dwreg);
579 
580 	/*
581 	 * Setup L0s state
582 	 *
583 	 * Note that we must not enable L0s in either direction on a
584 	 * given link unless components on both sides of the link each
585 	 * support L0s.
586 	 */
587 	if (dwreg.support & upreg.support & PCIE_LINK_STATE_L0S)
588 		link->aspm_support |= ASPM_STATE_L0S;
589 	if (dwreg.enabled & PCIE_LINK_STATE_L0S)
590 		link->aspm_enabled |= ASPM_STATE_L0S_UP;
591 	if (upreg.enabled & PCIE_LINK_STATE_L0S)
592 		link->aspm_enabled |= ASPM_STATE_L0S_DW;
593 	link->latency_up.l0s = calc_l0s_latency(upreg.latency_encoding_l0s);
594 	link->latency_dw.l0s = calc_l0s_latency(dwreg.latency_encoding_l0s);
595 
596 	/* Setup L1 state */
597 	if (upreg.support & dwreg.support & PCIE_LINK_STATE_L1)
598 		link->aspm_support |= ASPM_STATE_L1;
599 	if (upreg.enabled & dwreg.enabled & PCIE_LINK_STATE_L1)
600 		link->aspm_enabled |= ASPM_STATE_L1;
601 	link->latency_up.l1 = calc_l1_latency(upreg.latency_encoding_l1);
602 	link->latency_dw.l1 = calc_l1_latency(dwreg.latency_encoding_l1);
603 
604 	/* Setup L1 substate */
605 	if (upreg.l1ss_cap & dwreg.l1ss_cap & PCI_L1SS_CAP_ASPM_L1_1)
606 		link->aspm_support |= ASPM_STATE_L1_1;
607 	if (upreg.l1ss_cap & dwreg.l1ss_cap & PCI_L1SS_CAP_ASPM_L1_2)
608 		link->aspm_support |= ASPM_STATE_L1_2;
609 	if (upreg.l1ss_cap & dwreg.l1ss_cap & PCI_L1SS_CAP_PCIPM_L1_1)
610 		link->aspm_support |= ASPM_STATE_L1_1_PCIPM;
611 	if (upreg.l1ss_cap & dwreg.l1ss_cap & PCI_L1SS_CAP_PCIPM_L1_2)
612 		link->aspm_support |= ASPM_STATE_L1_2_PCIPM;
613 
614 	if (upreg.l1ss_ctl1 & dwreg.l1ss_ctl1 & PCI_L1SS_CTL1_ASPM_L1_1)
615 		link->aspm_enabled |= ASPM_STATE_L1_1;
616 	if (upreg.l1ss_ctl1 & dwreg.l1ss_ctl1 & PCI_L1SS_CTL1_ASPM_L1_2)
617 		link->aspm_enabled |= ASPM_STATE_L1_2;
618 	if (upreg.l1ss_ctl1 & dwreg.l1ss_ctl1 & PCI_L1SS_CTL1_PCIPM_L1_1)
619 		link->aspm_enabled |= ASPM_STATE_L1_1_PCIPM;
620 	if (upreg.l1ss_ctl1 & dwreg.l1ss_ctl1 & PCI_L1SS_CTL1_PCIPM_L1_2)
621 		link->aspm_enabled |= ASPM_STATE_L1_2_PCIPM;
622 
623 	if (link->aspm_support & ASPM_STATE_L1SS)
624 		aspm_calc_l1ss_info(link, &upreg, &dwreg);
625 
626 	/* Save default state */
627 	link->aspm_default = link->aspm_enabled;
628 
629 	/* Setup initial capable state. Will be updated later */
630 	link->aspm_capable = link->aspm_support;
631 
632 	/* Get and check endpoint acceptable latencies */
633 	list_for_each_entry(child, &linkbus->devices, bus_list) {
634 		u32 reg32, encoding;
635 		struct aspm_latency *acceptable =
636 			&link->acceptable[PCI_FUNC(child->devfn)];
637 
638 		if (pci_pcie_type(child) != PCI_EXP_TYPE_ENDPOINT &&
639 		    pci_pcie_type(child) != PCI_EXP_TYPE_LEG_END)
640 			continue;
641 
642 		pcie_capability_read_dword(child, PCI_EXP_DEVCAP, &reg32);
643 		/* Calculate endpoint L0s acceptable latency */
644 		encoding = (reg32 & PCI_EXP_DEVCAP_L0S) >> 6;
645 		acceptable->l0s = calc_l0s_acceptable(encoding);
646 		/* Calculate endpoint L1 acceptable latency */
647 		encoding = (reg32 & PCI_EXP_DEVCAP_L1) >> 9;
648 		acceptable->l1 = calc_l1_acceptable(encoding);
649 
650 		pcie_aspm_check_latency(child);
651 	}
652 }
653 
654 static void pci_clear_and_set_dword(struct pci_dev *pdev, int pos,
655 				    u32 clear, u32 set)
656 {
657 	u32 val;
658 
659 	pci_read_config_dword(pdev, pos, &val);
660 	val &= ~clear;
661 	val |= set;
662 	pci_write_config_dword(pdev, pos, val);
663 }
664 
665 /* Configure the ASPM L1 substates */
666 static void pcie_config_aspm_l1ss(struct pcie_link_state *link, u32 state)
667 {
668 	u32 val, enable_req;
669 	struct pci_dev *child = link->downstream, *parent = link->pdev;
670 	u32 up_cap_ptr = link->l1ss.up_cap_ptr;
671 	u32 dw_cap_ptr = link->l1ss.dw_cap_ptr;
672 
673 	enable_req = (link->aspm_enabled ^ state) & state;
674 
675 	/*
676 	 * Here are the rules specified in the PCIe spec for enabling L1SS:
677 	 * - When enabling L1.x, enable bit at parent first, then at child
678 	 * - When disabling L1.x, disable bit at child first, then at parent
679 	 * - When enabling ASPM L1.x, need to disable L1
680 	 *   (at child followed by parent).
681 	 * - The ASPM/PCIPM L1.2 must be disabled while programming timing
682 	 *   parameters
683 	 *
684 	 * To keep it simple, disable all L1SS bits first, and later enable
685 	 * what is needed.
686 	 */
687 
688 	/* Disable all L1 substates */
689 	pci_clear_and_set_dword(child, dw_cap_ptr + PCI_L1SS_CTL1,
690 				PCI_L1SS_CTL1_L1SS_MASK, 0);
691 	pci_clear_and_set_dword(parent, up_cap_ptr + PCI_L1SS_CTL1,
692 				PCI_L1SS_CTL1_L1SS_MASK, 0);
693 	/*
694 	 * If needed, disable L1, and it gets enabled later
695 	 * in pcie_config_aspm_link().
696 	 */
697 	if (enable_req & (ASPM_STATE_L1_1 | ASPM_STATE_L1_2)) {
698 		pcie_capability_clear_and_set_word(child, PCI_EXP_LNKCTL,
699 						   PCI_EXP_LNKCTL_ASPM_L1, 0);
700 		pcie_capability_clear_and_set_word(parent, PCI_EXP_LNKCTL,
701 						   PCI_EXP_LNKCTL_ASPM_L1, 0);
702 	}
703 
704 	if (enable_req & ASPM_STATE_L1_2_MASK) {
705 
706 		/* Program T_POWER_ON times in both ports */
707 		pci_write_config_dword(parent, up_cap_ptr + PCI_L1SS_CTL2,
708 				       link->l1ss.ctl2);
709 		pci_write_config_dword(child, dw_cap_ptr + PCI_L1SS_CTL2,
710 				       link->l1ss.ctl2);
711 
712 		/* Program Common_Mode_Restore_Time in upstream device */
713 		pci_clear_and_set_dword(parent, up_cap_ptr + PCI_L1SS_CTL1,
714 					PCI_L1SS_CTL1_CM_RESTORE_TIME,
715 					link->l1ss.ctl1);
716 
717 		/* Program LTR_L1.2_THRESHOLD time in both ports */
718 		pci_clear_and_set_dword(parent,	up_cap_ptr + PCI_L1SS_CTL1,
719 					PCI_L1SS_CTL1_LTR_L12_TH_VALUE |
720 					PCI_L1SS_CTL1_LTR_L12_TH_SCALE,
721 					link->l1ss.ctl1);
722 		pci_clear_and_set_dword(child, dw_cap_ptr + PCI_L1SS_CTL1,
723 					PCI_L1SS_CTL1_LTR_L12_TH_VALUE |
724 					PCI_L1SS_CTL1_LTR_L12_TH_SCALE,
725 					link->l1ss.ctl1);
726 	}
727 
728 	val = 0;
729 	if (state & ASPM_STATE_L1_1)
730 		val |= PCI_L1SS_CTL1_ASPM_L1_1;
731 	if (state & ASPM_STATE_L1_2)
732 		val |= PCI_L1SS_CTL1_ASPM_L1_2;
733 	if (state & ASPM_STATE_L1_1_PCIPM)
734 		val |= PCI_L1SS_CTL1_PCIPM_L1_1;
735 	if (state & ASPM_STATE_L1_2_PCIPM)
736 		val |= PCI_L1SS_CTL1_PCIPM_L1_2;
737 
738 	/* Enable what we need to enable */
739 	pci_clear_and_set_dword(parent, up_cap_ptr + PCI_L1SS_CTL1,
740 				PCI_L1SS_CTL1_L1SS_MASK, val);
741 	pci_clear_and_set_dword(child, dw_cap_ptr + PCI_L1SS_CTL1,
742 				PCI_L1SS_CTL1_L1SS_MASK, val);
743 }
744 
745 static void pcie_config_aspm_dev(struct pci_dev *pdev, u32 val)
746 {
747 	pcie_capability_clear_and_set_word(pdev, PCI_EXP_LNKCTL,
748 					   PCI_EXP_LNKCTL_ASPMC, val);
749 }
750 
751 static void pcie_config_aspm_link(struct pcie_link_state *link, u32 state)
752 {
753 	u32 upstream = 0, dwstream = 0;
754 	struct pci_dev *child = link->downstream, *parent = link->pdev;
755 	struct pci_bus *linkbus = parent->subordinate;
756 
757 	/* Enable only the states that were not explicitly disabled */
758 	state &= (link->aspm_capable & ~link->aspm_disable);
759 
760 	/* Can't enable any substates if L1 is not enabled */
761 	if (!(state & ASPM_STATE_L1))
762 		state &= ~ASPM_STATE_L1SS;
763 
764 	/* Spec says both ports must be in D0 before enabling PCI PM substates*/
765 	if (parent->current_state != PCI_D0 || child->current_state != PCI_D0) {
766 		state &= ~ASPM_STATE_L1_SS_PCIPM;
767 		state |= (link->aspm_enabled & ASPM_STATE_L1_SS_PCIPM);
768 	}
769 
770 	/* Nothing to do if the link is already in the requested state */
771 	if (link->aspm_enabled == state)
772 		return;
773 	/* Convert ASPM state to upstream/downstream ASPM register state */
774 	if (state & ASPM_STATE_L0S_UP)
775 		dwstream |= PCI_EXP_LNKCTL_ASPM_L0S;
776 	if (state & ASPM_STATE_L0S_DW)
777 		upstream |= PCI_EXP_LNKCTL_ASPM_L0S;
778 	if (state & ASPM_STATE_L1) {
779 		upstream |= PCI_EXP_LNKCTL_ASPM_L1;
780 		dwstream |= PCI_EXP_LNKCTL_ASPM_L1;
781 	}
782 
783 	if (link->aspm_capable & ASPM_STATE_L1SS)
784 		pcie_config_aspm_l1ss(link, state);
785 
786 	/*
787 	 * Spec 2.0 suggests all functions should be configured the
788 	 * same setting for ASPM. Enabling ASPM L1 should be done in
789 	 * upstream component first and then downstream, and vice
790 	 * versa for disabling ASPM L1. Spec doesn't mention L0S.
791 	 */
792 	if (state & ASPM_STATE_L1)
793 		pcie_config_aspm_dev(parent, upstream);
794 	list_for_each_entry(child, &linkbus->devices, bus_list)
795 		pcie_config_aspm_dev(child, dwstream);
796 	if (!(state & ASPM_STATE_L1))
797 		pcie_config_aspm_dev(parent, upstream);
798 
799 	link->aspm_enabled = state;
800 }
801 
802 static void pcie_config_aspm_path(struct pcie_link_state *link)
803 {
804 	while (link) {
805 		pcie_config_aspm_link(link, policy_to_aspm_state(link));
806 		link = link->parent;
807 	}
808 }
809 
810 static void free_link_state(struct pcie_link_state *link)
811 {
812 	link->pdev->link_state = NULL;
813 	kfree(link);
814 }
815 
816 static int pcie_aspm_sanity_check(struct pci_dev *pdev)
817 {
818 	struct pci_dev *child;
819 	u32 reg32;
820 
821 	/*
822 	 * Some functions in a slot might not all be PCIe functions,
823 	 * very strange. Disable ASPM for the whole slot
824 	 */
825 	list_for_each_entry(child, &pdev->subordinate->devices, bus_list) {
826 		if (!pci_is_pcie(child))
827 			return -EINVAL;
828 
829 		/*
830 		 * If ASPM is disabled then we're not going to change
831 		 * the BIOS state. It's safe to continue even if it's a
832 		 * pre-1.1 device
833 		 */
834 
835 		if (aspm_disabled)
836 			continue;
837 
838 		/*
839 		 * Disable ASPM for pre-1.1 PCIe device, we follow MS to use
840 		 * RBER bit to determine if a function is 1.1 version device
841 		 */
842 		pcie_capability_read_dword(child, PCI_EXP_DEVCAP, &reg32);
843 		if (!(reg32 & PCI_EXP_DEVCAP_RBER) && !aspm_force) {
844 			pci_info(child, "disabling ASPM on pre-1.1 PCIe device.  You can enable it with 'pcie_aspm=force'\n");
845 			return -EINVAL;
846 		}
847 	}
848 	return 0;
849 }
850 
851 static struct pcie_link_state *alloc_pcie_link_state(struct pci_dev *pdev)
852 {
853 	struct pcie_link_state *link;
854 
855 	link = kzalloc(sizeof(*link), GFP_KERNEL);
856 	if (!link)
857 		return NULL;
858 
859 	INIT_LIST_HEAD(&link->sibling);
860 	link->pdev = pdev;
861 	link->downstream = pci_function_0(pdev->subordinate);
862 
863 	/*
864 	 * Root Ports and PCI/PCI-X to PCIe Bridges are roots of PCIe
865 	 * hierarchies.  Note that some PCIe host implementations omit
866 	 * the root ports entirely, in which case a downstream port on
867 	 * a switch may become the root of the link state chain for all
868 	 * its subordinate endpoints.
869 	 */
870 	if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT ||
871 	    pci_pcie_type(pdev) == PCI_EXP_TYPE_PCIE_BRIDGE ||
872 	    !pdev->bus->parent->self) {
873 		link->root = link;
874 	} else {
875 		struct pcie_link_state *parent;
876 
877 		parent = pdev->bus->parent->self->link_state;
878 		if (!parent) {
879 			kfree(link);
880 			return NULL;
881 		}
882 
883 		link->parent = parent;
884 		link->root = link->parent->root;
885 	}
886 
887 	list_add(&link->sibling, &link_list);
888 	pdev->link_state = link;
889 	return link;
890 }
891 
892 static void pcie_aspm_update_sysfs_visibility(struct pci_dev *pdev)
893 {
894 	struct pci_dev *child;
895 
896 	list_for_each_entry(child, &pdev->subordinate->devices, bus_list)
897 		sysfs_update_group(&child->dev.kobj, &aspm_ctrl_attr_group);
898 }
899 
900 /*
901  * pcie_aspm_init_link_state: Initiate PCI express link state.
902  * It is called after the pcie and its children devices are scanned.
903  * @pdev: the root port or switch downstream port
904  */
905 void pcie_aspm_init_link_state(struct pci_dev *pdev)
906 {
907 	struct pcie_link_state *link;
908 	int blacklist = !!pcie_aspm_sanity_check(pdev);
909 
910 	if (!aspm_support_enabled)
911 		return;
912 
913 	if (pdev->link_state)
914 		return;
915 
916 	/*
917 	 * We allocate pcie_link_state for the component on the upstream
918 	 * end of a Link, so there's nothing to do unless this device is
919 	 * downstream port.
920 	 */
921 	if (!pcie_downstream_port(pdev))
922 		return;
923 
924 	/* VIA has a strange chipset, root port is under a bridge */
925 	if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT &&
926 	    pdev->bus->self)
927 		return;
928 
929 	down_read(&pci_bus_sem);
930 	if (list_empty(&pdev->subordinate->devices))
931 		goto out;
932 
933 	mutex_lock(&aspm_lock);
934 	link = alloc_pcie_link_state(pdev);
935 	if (!link)
936 		goto unlock;
937 	/*
938 	 * Setup initial ASPM state. Note that we need to configure
939 	 * upstream links also because capable state of them can be
940 	 * update through pcie_aspm_cap_init().
941 	 */
942 	pcie_aspm_cap_init(link, blacklist);
943 
944 	/* Setup initial Clock PM state */
945 	pcie_clkpm_cap_init(link, blacklist);
946 
947 	/*
948 	 * At this stage drivers haven't had an opportunity to change the
949 	 * link policy setting. Enabling ASPM on broken hardware can cripple
950 	 * it even before the driver has had a chance to disable ASPM, so
951 	 * default to a safe level right now. If we're enabling ASPM beyond
952 	 * the BIOS's expectation, we'll do so once pci_enable_device() is
953 	 * called.
954 	 */
955 	if (aspm_policy != POLICY_POWERSAVE &&
956 	    aspm_policy != POLICY_POWER_SUPERSAVE) {
957 		pcie_config_aspm_path(link);
958 		pcie_set_clkpm(link, policy_to_clkpm_state(link));
959 	}
960 
961 	pcie_aspm_update_sysfs_visibility(pdev);
962 
963 unlock:
964 	mutex_unlock(&aspm_lock);
965 out:
966 	up_read(&pci_bus_sem);
967 }
968 
969 /* Recheck latencies and update aspm_capable for links under the root */
970 static void pcie_update_aspm_capable(struct pcie_link_state *root)
971 {
972 	struct pcie_link_state *link;
973 	BUG_ON(root->parent);
974 	list_for_each_entry(link, &link_list, sibling) {
975 		if (link->root != root)
976 			continue;
977 		link->aspm_capable = link->aspm_support;
978 	}
979 	list_for_each_entry(link, &link_list, sibling) {
980 		struct pci_dev *child;
981 		struct pci_bus *linkbus = link->pdev->subordinate;
982 		if (link->root != root)
983 			continue;
984 		list_for_each_entry(child, &linkbus->devices, bus_list) {
985 			if ((pci_pcie_type(child) != PCI_EXP_TYPE_ENDPOINT) &&
986 			    (pci_pcie_type(child) != PCI_EXP_TYPE_LEG_END))
987 				continue;
988 			pcie_aspm_check_latency(child);
989 		}
990 	}
991 }
992 
993 /* @pdev: the endpoint device */
994 void pcie_aspm_exit_link_state(struct pci_dev *pdev)
995 {
996 	struct pci_dev *parent = pdev->bus->self;
997 	struct pcie_link_state *link, *root, *parent_link;
998 
999 	if (!parent || !parent->link_state)
1000 		return;
1001 
1002 	down_read(&pci_bus_sem);
1003 	mutex_lock(&aspm_lock);
1004 	/*
1005 	 * All PCIe functions are in one slot, remove one function will remove
1006 	 * the whole slot, so just wait until we are the last function left.
1007 	 */
1008 	if (!list_empty(&parent->subordinate->devices))
1009 		goto out;
1010 
1011 	link = parent->link_state;
1012 	root = link->root;
1013 	parent_link = link->parent;
1014 
1015 	/* All functions are removed, so just disable ASPM for the link */
1016 	pcie_config_aspm_link(link, 0);
1017 	list_del(&link->sibling);
1018 	/* Clock PM is for endpoint device */
1019 	free_link_state(link);
1020 
1021 	/* Recheck latencies and configure upstream links */
1022 	if (parent_link) {
1023 		pcie_update_aspm_capable(root);
1024 		pcie_config_aspm_path(parent_link);
1025 	}
1026 out:
1027 	mutex_unlock(&aspm_lock);
1028 	up_read(&pci_bus_sem);
1029 }
1030 
1031 /* @pdev: the root port or switch downstream port */
1032 void pcie_aspm_pm_state_change(struct pci_dev *pdev)
1033 {
1034 	struct pcie_link_state *link = pdev->link_state;
1035 
1036 	if (aspm_disabled || !link)
1037 		return;
1038 	/*
1039 	 * Devices changed PM state, we should recheck if latency
1040 	 * meets all functions' requirement
1041 	 */
1042 	down_read(&pci_bus_sem);
1043 	mutex_lock(&aspm_lock);
1044 	pcie_update_aspm_capable(link->root);
1045 	pcie_config_aspm_path(link);
1046 	mutex_unlock(&aspm_lock);
1047 	up_read(&pci_bus_sem);
1048 }
1049 
1050 void pcie_aspm_powersave_config_link(struct pci_dev *pdev)
1051 {
1052 	struct pcie_link_state *link = pdev->link_state;
1053 
1054 	if (aspm_disabled || !link)
1055 		return;
1056 
1057 	if (aspm_policy != POLICY_POWERSAVE &&
1058 	    aspm_policy != POLICY_POWER_SUPERSAVE)
1059 		return;
1060 
1061 	down_read(&pci_bus_sem);
1062 	mutex_lock(&aspm_lock);
1063 	pcie_config_aspm_path(link);
1064 	pcie_set_clkpm(link, policy_to_clkpm_state(link));
1065 	mutex_unlock(&aspm_lock);
1066 	up_read(&pci_bus_sem);
1067 }
1068 
1069 static struct pcie_link_state *pcie_aspm_get_link(struct pci_dev *pdev)
1070 {
1071 	struct pci_dev *bridge;
1072 
1073 	if (!pci_is_pcie(pdev))
1074 		return NULL;
1075 
1076 	bridge = pci_upstream_bridge(pdev);
1077 	if (!bridge || !pci_is_pcie(bridge))
1078 		return NULL;
1079 
1080 	return bridge->link_state;
1081 }
1082 
1083 static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool sem)
1084 {
1085 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1086 
1087 	if (!link)
1088 		return -EINVAL;
1089 	/*
1090 	 * A driver requested that ASPM be disabled on this device, but
1091 	 * if we don't have permission to manage ASPM (e.g., on ACPI
1092 	 * systems we have to observe the FADT ACPI_FADT_NO_ASPM bit and
1093 	 * the _OSC method), we can't honor that request.  Windows has
1094 	 * a similar mechanism using "PciASPMOptOut", which is also
1095 	 * ignored in this situation.
1096 	 */
1097 	if (aspm_disabled) {
1098 		pci_warn(pdev, "can't disable ASPM; OS doesn't have ASPM control\n");
1099 		return -EPERM;
1100 	}
1101 
1102 	if (sem)
1103 		down_read(&pci_bus_sem);
1104 	mutex_lock(&aspm_lock);
1105 	if (state & PCIE_LINK_STATE_L0S)
1106 		link->aspm_disable |= ASPM_STATE_L0S;
1107 	if (state & PCIE_LINK_STATE_L1)
1108 		/* L1 PM substates require L1 */
1109 		link->aspm_disable |= ASPM_STATE_L1 | ASPM_STATE_L1SS;
1110 	if (state & PCIE_LINK_STATE_L1_1)
1111 		link->aspm_disable |= ASPM_STATE_L1_1;
1112 	if (state & PCIE_LINK_STATE_L1_2)
1113 		link->aspm_disable |= ASPM_STATE_L1_2;
1114 	if (state & PCIE_LINK_STATE_L1_1_PCIPM)
1115 		link->aspm_disable |= ASPM_STATE_L1_1_PCIPM;
1116 	if (state & PCIE_LINK_STATE_L1_2_PCIPM)
1117 		link->aspm_disable |= ASPM_STATE_L1_2_PCIPM;
1118 	pcie_config_aspm_link(link, policy_to_aspm_state(link));
1119 
1120 	if (state & PCIE_LINK_STATE_CLKPM)
1121 		link->clkpm_disable = 1;
1122 	pcie_set_clkpm(link, policy_to_clkpm_state(link));
1123 	mutex_unlock(&aspm_lock);
1124 	if (sem)
1125 		up_read(&pci_bus_sem);
1126 
1127 	return 0;
1128 }
1129 
1130 int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
1131 {
1132 	return __pci_disable_link_state(pdev, state, false);
1133 }
1134 EXPORT_SYMBOL(pci_disable_link_state_locked);
1135 
1136 /**
1137  * pci_disable_link_state - Disable device's link state, so the link will
1138  * never enter specific states.  Note that if the BIOS didn't grant ASPM
1139  * control to the OS, this does nothing because we can't touch the LNKCTL
1140  * register. Returns 0 or a negative errno.
1141  *
1142  * @pdev: PCI device
1143  * @state: ASPM link state to disable
1144  */
1145 int pci_disable_link_state(struct pci_dev *pdev, int state)
1146 {
1147 	return __pci_disable_link_state(pdev, state, true);
1148 }
1149 EXPORT_SYMBOL(pci_disable_link_state);
1150 
1151 static int pcie_aspm_set_policy(const char *val,
1152 				const struct kernel_param *kp)
1153 {
1154 	int i;
1155 	struct pcie_link_state *link;
1156 
1157 	if (aspm_disabled)
1158 		return -EPERM;
1159 	i = sysfs_match_string(policy_str, val);
1160 	if (i < 0)
1161 		return i;
1162 	if (i == aspm_policy)
1163 		return 0;
1164 
1165 	down_read(&pci_bus_sem);
1166 	mutex_lock(&aspm_lock);
1167 	aspm_policy = i;
1168 	list_for_each_entry(link, &link_list, sibling) {
1169 		pcie_config_aspm_link(link, policy_to_aspm_state(link));
1170 		pcie_set_clkpm(link, policy_to_clkpm_state(link));
1171 	}
1172 	mutex_unlock(&aspm_lock);
1173 	up_read(&pci_bus_sem);
1174 	return 0;
1175 }
1176 
1177 static int pcie_aspm_get_policy(char *buffer, const struct kernel_param *kp)
1178 {
1179 	int i, cnt = 0;
1180 	for (i = 0; i < ARRAY_SIZE(policy_str); i++)
1181 		if (i == aspm_policy)
1182 			cnt += sprintf(buffer + cnt, "[%s] ", policy_str[i]);
1183 		else
1184 			cnt += sprintf(buffer + cnt, "%s ", policy_str[i]);
1185 	return cnt;
1186 }
1187 
1188 module_param_call(policy, pcie_aspm_set_policy, pcie_aspm_get_policy,
1189 	NULL, 0644);
1190 
1191 /**
1192  * pcie_aspm_enabled - Check if PCIe ASPM has been enabled for a device.
1193  * @pdev: Target device.
1194  *
1195  * Relies on the upstream bridge's link_state being valid.  The link_state
1196  * is deallocated only when the last child of the bridge (i.e., @pdev or a
1197  * sibling) is removed, and the caller should be holding a reference to
1198  * @pdev, so this should be safe.
1199  */
1200 bool pcie_aspm_enabled(struct pci_dev *pdev)
1201 {
1202 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1203 
1204 	if (!link)
1205 		return false;
1206 
1207 	return link->aspm_enabled;
1208 }
1209 EXPORT_SYMBOL_GPL(pcie_aspm_enabled);
1210 
1211 static ssize_t aspm_attr_show_common(struct device *dev,
1212 				     struct device_attribute *attr,
1213 				     char *buf, u8 state)
1214 {
1215 	struct pci_dev *pdev = to_pci_dev(dev);
1216 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1217 
1218 	return sprintf(buf, "%d\n", (link->aspm_enabled & state) ? 1 : 0);
1219 }
1220 
1221 static ssize_t aspm_attr_store_common(struct device *dev,
1222 				      struct device_attribute *attr,
1223 				      const char *buf, size_t len, u8 state)
1224 {
1225 	struct pci_dev *pdev = to_pci_dev(dev);
1226 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1227 	bool state_enable;
1228 
1229 	if (strtobool(buf, &state_enable) < 0)
1230 		return -EINVAL;
1231 
1232 	down_read(&pci_bus_sem);
1233 	mutex_lock(&aspm_lock);
1234 
1235 	if (state_enable) {
1236 		link->aspm_disable &= ~state;
1237 		/* need to enable L1 for substates */
1238 		if (state & ASPM_STATE_L1SS)
1239 			link->aspm_disable &= ~ASPM_STATE_L1;
1240 	} else {
1241 		link->aspm_disable |= state;
1242 	}
1243 
1244 	pcie_config_aspm_link(link, policy_to_aspm_state(link));
1245 
1246 	mutex_unlock(&aspm_lock);
1247 	up_read(&pci_bus_sem);
1248 
1249 	return len;
1250 }
1251 
1252 #define ASPM_ATTR(_f, _s)						\
1253 static ssize_t _f##_show(struct device *dev,				\
1254 			 struct device_attribute *attr, char *buf)	\
1255 { return aspm_attr_show_common(dev, attr, buf, ASPM_STATE_##_s); }	\
1256 									\
1257 static ssize_t _f##_store(struct device *dev,				\
1258 			  struct device_attribute *attr,		\
1259 			  const char *buf, size_t len)			\
1260 { return aspm_attr_store_common(dev, attr, buf, len, ASPM_STATE_##_s); }
1261 
1262 ASPM_ATTR(l0s_aspm, L0S)
1263 ASPM_ATTR(l1_aspm, L1)
1264 ASPM_ATTR(l1_1_aspm, L1_1)
1265 ASPM_ATTR(l1_2_aspm, L1_2)
1266 ASPM_ATTR(l1_1_pcipm, L1_1_PCIPM)
1267 ASPM_ATTR(l1_2_pcipm, L1_2_PCIPM)
1268 
1269 static ssize_t clkpm_show(struct device *dev,
1270 			  struct device_attribute *attr, char *buf)
1271 {
1272 	struct pci_dev *pdev = to_pci_dev(dev);
1273 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1274 
1275 	return sprintf(buf, "%d\n", link->clkpm_enabled);
1276 }
1277 
1278 static ssize_t clkpm_store(struct device *dev,
1279 			   struct device_attribute *attr,
1280 			   const char *buf, size_t len)
1281 {
1282 	struct pci_dev *pdev = to_pci_dev(dev);
1283 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1284 	bool state_enable;
1285 
1286 	if (strtobool(buf, &state_enable) < 0)
1287 		return -EINVAL;
1288 
1289 	down_read(&pci_bus_sem);
1290 	mutex_lock(&aspm_lock);
1291 
1292 	link->clkpm_disable = !state_enable;
1293 	pcie_set_clkpm(link, policy_to_clkpm_state(link));
1294 
1295 	mutex_unlock(&aspm_lock);
1296 	up_read(&pci_bus_sem);
1297 
1298 	return len;
1299 }
1300 
1301 static DEVICE_ATTR_RW(clkpm);
1302 static DEVICE_ATTR_RW(l0s_aspm);
1303 static DEVICE_ATTR_RW(l1_aspm);
1304 static DEVICE_ATTR_RW(l1_1_aspm);
1305 static DEVICE_ATTR_RW(l1_2_aspm);
1306 static DEVICE_ATTR_RW(l1_1_pcipm);
1307 static DEVICE_ATTR_RW(l1_2_pcipm);
1308 
1309 static struct attribute *aspm_ctrl_attrs[] = {
1310 	&dev_attr_clkpm.attr,
1311 	&dev_attr_l0s_aspm.attr,
1312 	&dev_attr_l1_aspm.attr,
1313 	&dev_attr_l1_1_aspm.attr,
1314 	&dev_attr_l1_2_aspm.attr,
1315 	&dev_attr_l1_1_pcipm.attr,
1316 	&dev_attr_l1_2_pcipm.attr,
1317 	NULL
1318 };
1319 
1320 static umode_t aspm_ctrl_attrs_are_visible(struct kobject *kobj,
1321 					   struct attribute *a, int n)
1322 {
1323 	struct device *dev = kobj_to_dev(kobj);
1324 	struct pci_dev *pdev = to_pci_dev(dev);
1325 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
1326 	static const u8 aspm_state_map[] = {
1327 		ASPM_STATE_L0S,
1328 		ASPM_STATE_L1,
1329 		ASPM_STATE_L1_1,
1330 		ASPM_STATE_L1_2,
1331 		ASPM_STATE_L1_1_PCIPM,
1332 		ASPM_STATE_L1_2_PCIPM,
1333 	};
1334 
1335 	if (aspm_disabled || !link)
1336 		return 0;
1337 
1338 	if (n == 0)
1339 		return link->clkpm_capable ? a->mode : 0;
1340 
1341 	return link->aspm_capable & aspm_state_map[n - 1] ? a->mode : 0;
1342 }
1343 
1344 const struct attribute_group aspm_ctrl_attr_group = {
1345 	.name = "link",
1346 	.attrs = aspm_ctrl_attrs,
1347 	.is_visible = aspm_ctrl_attrs_are_visible,
1348 };
1349 
1350 static int __init pcie_aspm_disable(char *str)
1351 {
1352 	if (!strcmp(str, "off")) {
1353 		aspm_policy = POLICY_DEFAULT;
1354 		aspm_disabled = 1;
1355 		aspm_support_enabled = false;
1356 		printk(KERN_INFO "PCIe ASPM is disabled\n");
1357 	} else if (!strcmp(str, "force")) {
1358 		aspm_force = 1;
1359 		printk(KERN_INFO "PCIe ASPM is forcibly enabled\n");
1360 	}
1361 	return 1;
1362 }
1363 
1364 __setup("pcie_aspm=", pcie_aspm_disable);
1365 
1366 void pcie_no_aspm(void)
1367 {
1368 	/*
1369 	 * Disabling ASPM is intended to prevent the kernel from modifying
1370 	 * existing hardware state, not to clear existing state. To that end:
1371 	 * (a) set policy to POLICY_DEFAULT in order to avoid changing state
1372 	 * (b) prevent userspace from changing policy
1373 	 */
1374 	if (!aspm_force) {
1375 		aspm_policy = POLICY_DEFAULT;
1376 		aspm_disabled = 1;
1377 	}
1378 }
1379 
1380 bool pcie_aspm_support_enabled(void)
1381 {
1382 	return aspm_support_enabled;
1383 }
1384 EXPORT_SYMBOL(pcie_aspm_support_enabled);
1385