PCI: Add standard PCIe Capability Link ASPM field names
[linux-3.10.git] / drivers / pci / pcie / aspm.c
1 /*
2  * File:        drivers/pci/pcie/aspm.c
3  * Enabling 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 <linux/pci-aspm.h>
22 #include "../pci.h"
23
24 #ifdef MODULE_PARAM_PREFIX
25 #undef MODULE_PARAM_PREFIX
26 #endif
27 #define MODULE_PARAM_PREFIX "pcie_aspm."
28
29 /* Note: those are not register definitions */
30 #define ASPM_STATE_L0S_UP       (1)     /* Upstream direction L0s state */
31 #define ASPM_STATE_L0S_DW       (2)     /* Downstream direction L0s state */
32 #define ASPM_STATE_L1           (4)     /* L1 state */
33 #define ASPM_STATE_L0S          (ASPM_STATE_L0S_UP | ASPM_STATE_L0S_DW)
34 #define ASPM_STATE_ALL          (ASPM_STATE_L0S | ASPM_STATE_L1)
35
36 struct aspm_latency {
37         u32 l0s;                        /* L0s latency (nsec) */
38         u32 l1;                         /* L1 latency (nsec) */
39 };
40
41 struct pcie_link_state {
42         struct pci_dev *pdev;           /* Upstream component of the Link */
43         struct pcie_link_state *root;   /* pointer to the root port link */
44         struct pcie_link_state *parent; /* pointer to the parent Link state */
45         struct list_head sibling;       /* node in link_list */
46         struct list_head children;      /* list of child link states */
47         struct list_head link;          /* node in parent's children list */
48
49         /* ASPM state */
50         u32 aspm_support:3;             /* Supported ASPM state */
51         u32 aspm_enabled:3;             /* Enabled ASPM state */
52         u32 aspm_capable:3;             /* Capable ASPM state with latency */
53         u32 aspm_default:3;             /* Default ASPM state by BIOS */
54         u32 aspm_disable:3;             /* Disabled ASPM state */
55
56         /* Clock PM state */
57         u32 clkpm_capable:1;            /* Clock PM capable? */
58         u32 clkpm_enabled:1;            /* Current Clock PM state */
59         u32 clkpm_default:1;            /* Default Clock PM state by BIOS */
60
61         /* Exit latencies */
62         struct aspm_latency latency_up; /* Upstream direction exit latency */
63         struct aspm_latency latency_dw; /* Downstream direction exit latency */
64         /*
65          * Endpoint acceptable latencies. A pcie downstream port only
66          * has one slot under it, so at most there are 8 functions.
67          */
68         struct aspm_latency acceptable[8];
69 };
70
71 static int aspm_disabled, aspm_force;
72 static bool aspm_support_enabled = true;
73 static DEFINE_MUTEX(aspm_lock);
74 static LIST_HEAD(link_list);
75
76 #define POLICY_DEFAULT 0        /* BIOS default setting */
77 #define POLICY_PERFORMANCE 1    /* high performance */
78 #define POLICY_POWERSAVE 2      /* high power saving */
79
80 #ifdef CONFIG_PCIEASPM_PERFORMANCE
81 static int aspm_policy = POLICY_PERFORMANCE;
82 #elif defined CONFIG_PCIEASPM_POWERSAVE
83 static int aspm_policy = POLICY_POWERSAVE;
84 #else
85 static int aspm_policy;
86 #endif
87
88 static const char *policy_str[] = {
89         [POLICY_DEFAULT] = "default",
90         [POLICY_PERFORMANCE] = "performance",
91         [POLICY_POWERSAVE] = "powersave"
92 };
93
94 #define LINK_RETRAIN_TIMEOUT HZ
95
96 static int policy_to_aspm_state(struct pcie_link_state *link)
97 {
98         switch (aspm_policy) {
99         case POLICY_PERFORMANCE:
100                 /* Disable ASPM and Clock PM */
101                 return 0;
102         case POLICY_POWERSAVE:
103                 /* Enable ASPM L0s/L1 */
104                 return ASPM_STATE_ALL;
105         case POLICY_DEFAULT:
106                 return link->aspm_default;
107         }
108         return 0;
109 }
110
111 static int policy_to_clkpm_state(struct pcie_link_state *link)
112 {
113         switch (aspm_policy) {
114         case POLICY_PERFORMANCE:
115                 /* Disable ASPM and Clock PM */
116                 return 0;
117         case POLICY_POWERSAVE:
118                 /* Disable Clock PM */
119                 return 1;
120         case POLICY_DEFAULT:
121                 return link->clkpm_default;
122         }
123         return 0;
124 }
125
126 static void pcie_set_clkpm_nocheck(struct pcie_link_state *link, int enable)
127 {
128         struct pci_dev *child;
129         struct pci_bus *linkbus = link->pdev->subordinate;
130
131         list_for_each_entry(child, &linkbus->devices, bus_list) {
132                 if (enable)
133                         pcie_capability_set_word(child, PCI_EXP_LNKCTL,
134                                                  PCI_EXP_LNKCTL_CLKREQ_EN);
135                 else
136                         pcie_capability_clear_word(child, PCI_EXP_LNKCTL,
137                                                    PCI_EXP_LNKCTL_CLKREQ_EN);
138         }
139         link->clkpm_enabled = !!enable;
140 }
141
142 static void pcie_set_clkpm(struct pcie_link_state *link, int enable)
143 {
144         /* Don't enable Clock PM if the link is not Clock PM capable */
145         if (!link->clkpm_capable && enable)
146                 enable = 0;
147         /* Need nothing if the specified equals to current state */
148         if (link->clkpm_enabled == enable)
149                 return;
150         pcie_set_clkpm_nocheck(link, enable);
151 }
152
153 static void pcie_clkpm_cap_init(struct pcie_link_state *link, int blacklist)
154 {
155         int capable = 1, enabled = 1;
156         u32 reg32;
157         u16 reg16;
158         struct pci_dev *child;
159         struct pci_bus *linkbus = link->pdev->subordinate;
160
161         /* All functions should have the same cap and state, take the worst */
162         list_for_each_entry(child, &linkbus->devices, bus_list) {
163                 pcie_capability_read_dword(child, PCI_EXP_LNKCAP, &reg32);
164                 if (!(reg32 & PCI_EXP_LNKCAP_CLKPM)) {
165                         capable = 0;
166                         enabled = 0;
167                         break;
168                 }
169                 pcie_capability_read_word(child, PCI_EXP_LNKCTL, &reg16);
170                 if (!(reg16 & PCI_EXP_LNKCTL_CLKREQ_EN))
171                         enabled = 0;
172         }
173         link->clkpm_enabled = enabled;
174         link->clkpm_default = enabled;
175         link->clkpm_capable = (blacklist) ? 0 : capable;
176 }
177
178 /*
179  * pcie_aspm_configure_common_clock: check if the 2 ends of a link
180  *   could use common clock. If they are, configure them to use the
181  *   common clock. That will reduce the ASPM state exit latency.
182  */
183 static void pcie_aspm_configure_common_clock(struct pcie_link_state *link)
184 {
185         int same_clock = 1;
186         u16 reg16, parent_reg, child_reg[8];
187         unsigned long start_jiffies;
188         struct pci_dev *child, *parent = link->pdev;
189         struct pci_bus *linkbus = parent->subordinate;
190         /*
191          * All functions of a slot should have the same Slot Clock
192          * Configuration, so just check one function
193          */
194         child = list_entry(linkbus->devices.next, struct pci_dev, bus_list);
195         BUG_ON(!pci_is_pcie(child));
196
197         /* Check downstream component if bit Slot Clock Configuration is 1 */
198         pcie_capability_read_word(child, PCI_EXP_LNKSTA, &reg16);
199         if (!(reg16 & PCI_EXP_LNKSTA_SLC))
200                 same_clock = 0;
201
202         /* Check upstream component if bit Slot Clock Configuration is 1 */
203         pcie_capability_read_word(parent, PCI_EXP_LNKSTA, &reg16);
204         if (!(reg16 & PCI_EXP_LNKSTA_SLC))
205                 same_clock = 0;
206
207         /* Configure downstream component, all functions */
208         list_for_each_entry(child, &linkbus->devices, bus_list) {
209                 pcie_capability_read_word(child, PCI_EXP_LNKCTL, &reg16);
210                 child_reg[PCI_FUNC(child->devfn)] = reg16;
211                 if (same_clock)
212                         reg16 |= PCI_EXP_LNKCTL_CCC;
213                 else
214                         reg16 &= ~PCI_EXP_LNKCTL_CCC;
215                 pcie_capability_write_word(child, PCI_EXP_LNKCTL, reg16);
216         }
217
218         /* Configure upstream component */
219         pcie_capability_read_word(parent, PCI_EXP_LNKCTL, &reg16);
220         parent_reg = reg16;
221         if (same_clock)
222                 reg16 |= PCI_EXP_LNKCTL_CCC;
223         else
224                 reg16 &= ~PCI_EXP_LNKCTL_CCC;
225         pcie_capability_write_word(parent, PCI_EXP_LNKCTL, reg16);
226
227         /* Retrain link */
228         reg16 |= PCI_EXP_LNKCTL_RL;
229         pcie_capability_write_word(parent, PCI_EXP_LNKCTL, reg16);
230
231         /* Wait for link training end. Break out after waiting for timeout */
232         start_jiffies = jiffies;
233         for (;;) {
234                 pcie_capability_read_word(parent, PCI_EXP_LNKSTA, &reg16);
235                 if (!(reg16 & PCI_EXP_LNKSTA_LT))
236                         break;
237                 if (time_after(jiffies, start_jiffies + LINK_RETRAIN_TIMEOUT))
238                         break;
239                 msleep(1);
240         }
241         if (!(reg16 & PCI_EXP_LNKSTA_LT))
242                 return;
243
244         /* Training failed. Restore common clock configurations */
245         dev_printk(KERN_ERR, &parent->dev,
246                    "ASPM: Could not configure common clock\n");
247         list_for_each_entry(child, &linkbus->devices, bus_list)
248                 pcie_capability_write_word(child, PCI_EXP_LNKCTL,
249                                            child_reg[PCI_FUNC(child->devfn)]);
250         pcie_capability_write_word(parent, PCI_EXP_LNKCTL, parent_reg);
251 }
252
253 /* Convert L0s latency encoding to ns */
254 static u32 calc_l0s_latency(u32 encoding)
255 {
256         if (encoding == 0x7)
257                 return (5 * 1000);      /* > 4us */
258         return (64 << encoding);
259 }
260
261 /* Convert L0s acceptable latency encoding to ns */
262 static u32 calc_l0s_acceptable(u32 encoding)
263 {
264         if (encoding == 0x7)
265                 return -1U;
266         return (64 << encoding);
267 }
268
269 /* Convert L1 latency encoding to ns */
270 static u32 calc_l1_latency(u32 encoding)
271 {
272         if (encoding == 0x7)
273                 return (65 * 1000);     /* > 64us */
274         return (1000 << encoding);
275 }
276
277 /* Convert L1 acceptable latency encoding to ns */
278 static u32 calc_l1_acceptable(u32 encoding)
279 {
280         if (encoding == 0x7)
281                 return -1U;
282         return (1000 << encoding);
283 }
284
285 struct aspm_register_info {
286         u32 support:2;
287         u32 enabled:2;
288         u32 latency_encoding_l0s;
289         u32 latency_encoding_l1;
290 };
291
292 static void pcie_get_aspm_reg(struct pci_dev *pdev,
293                               struct aspm_register_info *info)
294 {
295         u16 reg16;
296         u32 reg32;
297
298         pcie_capability_read_dword(pdev, PCI_EXP_LNKCAP, &reg32);
299         info->support = (reg32 & PCI_EXP_LNKCAP_ASPMS) >> 10;
300         info->latency_encoding_l0s = (reg32 & PCI_EXP_LNKCAP_L0SEL) >> 12;
301         info->latency_encoding_l1  = (reg32 & PCI_EXP_LNKCAP_L1EL) >> 15;
302         pcie_capability_read_word(pdev, PCI_EXP_LNKCTL, &reg16);
303         info->enabled = reg16 & PCI_EXP_LNKCTL_ASPMC;
304 }
305
306 static void pcie_aspm_check_latency(struct pci_dev *endpoint)
307 {
308         u32 latency, l1_switch_latency = 0;
309         struct aspm_latency *acceptable;
310         struct pcie_link_state *link;
311
312         /* Device not in D0 doesn't need latency check */
313         if ((endpoint->current_state != PCI_D0) &&
314             (endpoint->current_state != PCI_UNKNOWN))
315                 return;
316
317         link = endpoint->bus->self->link_state;
318         acceptable = &link->acceptable[PCI_FUNC(endpoint->devfn)];
319
320         while (link) {
321                 /* Check upstream direction L0s latency */
322                 if ((link->aspm_capable & ASPM_STATE_L0S_UP) &&
323                     (link->latency_up.l0s > acceptable->l0s))
324                         link->aspm_capable &= ~ASPM_STATE_L0S_UP;
325
326                 /* Check downstream direction L0s latency */
327                 if ((link->aspm_capable & ASPM_STATE_L0S_DW) &&
328                     (link->latency_dw.l0s > acceptable->l0s))
329                         link->aspm_capable &= ~ASPM_STATE_L0S_DW;
330                 /*
331                  * Check L1 latency.
332                  * Every switch on the path to root complex need 1
333                  * more microsecond for L1. Spec doesn't mention L0s.
334                  */
335                 latency = max_t(u32, link->latency_up.l1, link->latency_dw.l1);
336                 if ((link->aspm_capable & ASPM_STATE_L1) &&
337                     (latency + l1_switch_latency > acceptable->l1))
338                         link->aspm_capable &= ~ASPM_STATE_L1;
339                 l1_switch_latency += 1000;
340
341                 link = link->parent;
342         }
343 }
344
345 static void pcie_aspm_cap_init(struct pcie_link_state *link, int blacklist)
346 {
347         struct pci_dev *child, *parent = link->pdev;
348         struct pci_bus *linkbus = parent->subordinate;
349         struct aspm_register_info upreg, dwreg;
350
351         if (blacklist) {
352                 /* Set enabled/disable so that we will disable ASPM later */
353                 link->aspm_enabled = ASPM_STATE_ALL;
354                 link->aspm_disable = ASPM_STATE_ALL;
355                 return;
356         }
357
358         /* Configure common clock before checking latencies */
359         pcie_aspm_configure_common_clock(link);
360
361         /* Get upstream/downstream components' register state */
362         pcie_get_aspm_reg(parent, &upreg);
363         child = list_entry(linkbus->devices.next, struct pci_dev, bus_list);
364         pcie_get_aspm_reg(child, &dwreg);
365
366         /*
367          * Setup L0s state
368          *
369          * Note that we must not enable L0s in either direction on a
370          * given link unless components on both sides of the link each
371          * support L0s.
372          */
373         if (dwreg.support & upreg.support & PCIE_LINK_STATE_L0S)
374                 link->aspm_support |= ASPM_STATE_L0S;
375         if (dwreg.enabled & PCIE_LINK_STATE_L0S)
376                 link->aspm_enabled |= ASPM_STATE_L0S_UP;
377         if (upreg.enabled & PCIE_LINK_STATE_L0S)
378                 link->aspm_enabled |= ASPM_STATE_L0S_DW;
379         link->latency_up.l0s = calc_l0s_latency(upreg.latency_encoding_l0s);
380         link->latency_dw.l0s = calc_l0s_latency(dwreg.latency_encoding_l0s);
381
382         /* Setup L1 state */
383         if (upreg.support & dwreg.support & PCIE_LINK_STATE_L1)
384                 link->aspm_support |= ASPM_STATE_L1;
385         if (upreg.enabled & dwreg.enabled & PCIE_LINK_STATE_L1)
386                 link->aspm_enabled |= ASPM_STATE_L1;
387         link->latency_up.l1 = calc_l1_latency(upreg.latency_encoding_l1);
388         link->latency_dw.l1 = calc_l1_latency(dwreg.latency_encoding_l1);
389
390         /* Save default state */
391         link->aspm_default = link->aspm_enabled;
392
393         /* Setup initial capable state. Will be updated later */
394         link->aspm_capable = link->aspm_support;
395         /*
396          * If the downstream component has pci bridge function, don't
397          * do ASPM for now.
398          */
399         list_for_each_entry(child, &linkbus->devices, bus_list) {
400                 if (pci_pcie_type(child) == PCI_EXP_TYPE_PCI_BRIDGE) {
401                         link->aspm_disable = ASPM_STATE_ALL;
402                         break;
403                 }
404         }
405
406         /* Get and check endpoint acceptable latencies */
407         list_for_each_entry(child, &linkbus->devices, bus_list) {
408                 u32 reg32, encoding;
409                 struct aspm_latency *acceptable =
410                         &link->acceptable[PCI_FUNC(child->devfn)];
411
412                 if (pci_pcie_type(child) != PCI_EXP_TYPE_ENDPOINT &&
413                     pci_pcie_type(child) != PCI_EXP_TYPE_LEG_END)
414                         continue;
415
416                 pcie_capability_read_dword(child, PCI_EXP_DEVCAP, &reg32);
417                 /* Calculate endpoint L0s acceptable latency */
418                 encoding = (reg32 & PCI_EXP_DEVCAP_L0S) >> 6;
419                 acceptable->l0s = calc_l0s_acceptable(encoding);
420                 /* Calculate endpoint L1 acceptable latency */
421                 encoding = (reg32 & PCI_EXP_DEVCAP_L1) >> 9;
422                 acceptable->l1 = calc_l1_acceptable(encoding);
423
424                 pcie_aspm_check_latency(child);
425         }
426 }
427
428 static void pcie_config_aspm_dev(struct pci_dev *pdev, u32 val)
429 {
430         pcie_capability_clear_and_set_word(pdev, PCI_EXP_LNKCTL,
431                                            PCI_EXP_LNKCTL_ASPMC, val);
432 }
433
434 static void pcie_config_aspm_link(struct pcie_link_state *link, u32 state)
435 {
436         u32 upstream = 0, dwstream = 0;
437         struct pci_dev *child, *parent = link->pdev;
438         struct pci_bus *linkbus = parent->subordinate;
439
440         /* Nothing to do if the link is already in the requested state */
441         state &= (link->aspm_capable & ~link->aspm_disable);
442         if (link->aspm_enabled == state)
443                 return;
444         /* Convert ASPM state to upstream/downstream ASPM register state */
445         if (state & ASPM_STATE_L0S_UP)
446                 dwstream |= PCI_EXP_LNKCTL_ASPM_L0S;
447         if (state & ASPM_STATE_L0S_DW)
448                 upstream |= PCI_EXP_LNKCTL_ASPM_L0S;
449         if (state & ASPM_STATE_L1) {
450                 upstream |= PCI_EXP_LNKCTL_ASPM_L1;
451                 dwstream |= PCI_EXP_LNKCTL_ASPM_L1;
452         }
453         /*
454          * Spec 2.0 suggests all functions should be configured the
455          * same setting for ASPM. Enabling ASPM L1 should be done in
456          * upstream component first and then downstream, and vice
457          * versa for disabling ASPM L1. Spec doesn't mention L0S.
458          */
459         if (state & ASPM_STATE_L1)
460                 pcie_config_aspm_dev(parent, upstream);
461         list_for_each_entry(child, &linkbus->devices, bus_list)
462                 pcie_config_aspm_dev(child, dwstream);
463         if (!(state & ASPM_STATE_L1))
464                 pcie_config_aspm_dev(parent, upstream);
465
466         link->aspm_enabled = state;
467 }
468
469 static void pcie_config_aspm_path(struct pcie_link_state *link)
470 {
471         while (link) {
472                 pcie_config_aspm_link(link, policy_to_aspm_state(link));
473                 link = link->parent;
474         }
475 }
476
477 static void free_link_state(struct pcie_link_state *link)
478 {
479         link->pdev->link_state = NULL;
480         kfree(link);
481 }
482
483 static int pcie_aspm_sanity_check(struct pci_dev *pdev)
484 {
485         struct pci_dev *child;
486         u32 reg32;
487
488         /*
489          * Some functions in a slot might not all be PCIe functions,
490          * very strange. Disable ASPM for the whole slot
491          */
492         list_for_each_entry(child, &pdev->subordinate->devices, bus_list) {
493                 if (!pci_is_pcie(child))
494                         return -EINVAL;
495
496                 /*
497                  * If ASPM is disabled then we're not going to change
498                  * the BIOS state. It's safe to continue even if it's a
499                  * pre-1.1 device
500                  */
501
502                 if (aspm_disabled)
503                         continue;
504
505                 /*
506                  * Disable ASPM for pre-1.1 PCIe device, we follow MS to use
507                  * RBER bit to determine if a function is 1.1 version device
508                  */
509                 pcie_capability_read_dword(child, PCI_EXP_DEVCAP, &reg32);
510                 if (!(reg32 & PCI_EXP_DEVCAP_RBER) && !aspm_force) {
511                         dev_printk(KERN_INFO, &child->dev, "disabling ASPM"
512                                 " on pre-1.1 PCIe device.  You can enable it"
513                                 " with 'pcie_aspm=force'\n");
514                         return -EINVAL;
515                 }
516         }
517         return 0;
518 }
519
520 static struct pcie_link_state *alloc_pcie_link_state(struct pci_dev *pdev)
521 {
522         struct pcie_link_state *link;
523
524         link = kzalloc(sizeof(*link), GFP_KERNEL);
525         if (!link)
526                 return NULL;
527         INIT_LIST_HEAD(&link->sibling);
528         INIT_LIST_HEAD(&link->children);
529         INIT_LIST_HEAD(&link->link);
530         link->pdev = pdev;
531         if (pci_pcie_type(pdev) == PCI_EXP_TYPE_DOWNSTREAM) {
532                 struct pcie_link_state *parent;
533                 parent = pdev->bus->parent->self->link_state;
534                 if (!parent) {
535                         kfree(link);
536                         return NULL;
537                 }
538                 link->parent = parent;
539                 list_add(&link->link, &parent->children);
540         }
541         /* Setup a pointer to the root port link */
542         if (!link->parent)
543                 link->root = link;
544         else
545                 link->root = link->parent->root;
546
547         list_add(&link->sibling, &link_list);
548         pdev->link_state = link;
549         return link;
550 }
551
552 /*
553  * pcie_aspm_init_link_state: Initiate PCI express link state.
554  * It is called after the pcie and its children devices are scaned.
555  * @pdev: the root port or switch downstream port
556  */
557 void pcie_aspm_init_link_state(struct pci_dev *pdev)
558 {
559         struct pcie_link_state *link;
560         int blacklist = !!pcie_aspm_sanity_check(pdev);
561
562         if (!pci_is_pcie(pdev) || pdev->link_state)
563                 return;
564         if (pci_pcie_type(pdev) != PCI_EXP_TYPE_ROOT_PORT &&
565             pci_pcie_type(pdev) != PCI_EXP_TYPE_DOWNSTREAM)
566                 return;
567
568         /* VIA has a strange chipset, root port is under a bridge */
569         if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT &&
570             pdev->bus->self)
571                 return;
572
573         down_read(&pci_bus_sem);
574         if (list_empty(&pdev->subordinate->devices))
575                 goto out;
576
577         mutex_lock(&aspm_lock);
578         link = alloc_pcie_link_state(pdev);
579         if (!link)
580                 goto unlock;
581         /*
582          * Setup initial ASPM state. Note that we need to configure
583          * upstream links also because capable state of them can be
584          * update through pcie_aspm_cap_init().
585          */
586         pcie_aspm_cap_init(link, blacklist);
587
588         /* Setup initial Clock PM state */
589         pcie_clkpm_cap_init(link, blacklist);
590
591         /*
592          * At this stage drivers haven't had an opportunity to change the
593          * link policy setting. Enabling ASPM on broken hardware can cripple
594          * it even before the driver has had a chance to disable ASPM, so
595          * default to a safe level right now. If we're enabling ASPM beyond
596          * the BIOS's expectation, we'll do so once pci_enable_device() is
597          * called.
598          */
599         if (aspm_policy != POLICY_POWERSAVE) {
600                 pcie_config_aspm_path(link);
601                 pcie_set_clkpm(link, policy_to_clkpm_state(link));
602         }
603
604 unlock:
605         mutex_unlock(&aspm_lock);
606 out:
607         up_read(&pci_bus_sem);
608 }
609
610 /* Recheck latencies and update aspm_capable for links under the root */
611 static void pcie_update_aspm_capable(struct pcie_link_state *root)
612 {
613         struct pcie_link_state *link;
614         BUG_ON(root->parent);
615         list_for_each_entry(link, &link_list, sibling) {
616                 if (link->root != root)
617                         continue;
618                 link->aspm_capable = link->aspm_support;
619         }
620         list_for_each_entry(link, &link_list, sibling) {
621                 struct pci_dev *child;
622                 struct pci_bus *linkbus = link->pdev->subordinate;
623                 if (link->root != root)
624                         continue;
625                 list_for_each_entry(child, &linkbus->devices, bus_list) {
626                         if ((pci_pcie_type(child) != PCI_EXP_TYPE_ENDPOINT) &&
627                             (pci_pcie_type(child) != PCI_EXP_TYPE_LEG_END))
628                                 continue;
629                         pcie_aspm_check_latency(child);
630                 }
631         }
632 }
633
634 /* @pdev: the endpoint device */
635 void pcie_aspm_exit_link_state(struct pci_dev *pdev)
636 {
637         struct pci_dev *parent = pdev->bus->self;
638         struct pcie_link_state *link, *root, *parent_link;
639
640         if (!pci_is_pcie(pdev) || !parent || !parent->link_state)
641                 return;
642         if ((pci_pcie_type(parent) != PCI_EXP_TYPE_ROOT_PORT) &&
643             (pci_pcie_type(parent) != PCI_EXP_TYPE_DOWNSTREAM))
644                 return;
645
646         down_read(&pci_bus_sem);
647         mutex_lock(&aspm_lock);
648         /*
649          * All PCIe functions are in one slot, remove one function will remove
650          * the whole slot, so just wait until we are the last function left.
651          */
652         if (!list_is_last(&pdev->bus_list, &parent->subordinate->devices))
653                 goto out;
654
655         link = parent->link_state;
656         root = link->root;
657         parent_link = link->parent;
658
659         /* All functions are removed, so just disable ASPM for the link */
660         pcie_config_aspm_link(link, 0);
661         list_del(&link->sibling);
662         list_del(&link->link);
663         /* Clock PM is for endpoint device */
664         free_link_state(link);
665
666         /* Recheck latencies and configure upstream links */
667         if (parent_link) {
668                 pcie_update_aspm_capable(root);
669                 pcie_config_aspm_path(parent_link);
670         }
671 out:
672         mutex_unlock(&aspm_lock);
673         up_read(&pci_bus_sem);
674 }
675
676 /* @pdev: the root port or switch downstream port */
677 void pcie_aspm_pm_state_change(struct pci_dev *pdev)
678 {
679         struct pcie_link_state *link = pdev->link_state;
680
681         if (aspm_disabled || !pci_is_pcie(pdev) || !link)
682                 return;
683         if ((pci_pcie_type(pdev) != PCI_EXP_TYPE_ROOT_PORT) &&
684             (pci_pcie_type(pdev) != PCI_EXP_TYPE_DOWNSTREAM))
685                 return;
686         /*
687          * Devices changed PM state, we should recheck if latency
688          * meets all functions' requirement
689          */
690         down_read(&pci_bus_sem);
691         mutex_lock(&aspm_lock);
692         pcie_update_aspm_capable(link->root);
693         pcie_config_aspm_path(link);
694         mutex_unlock(&aspm_lock);
695         up_read(&pci_bus_sem);
696 }
697
698 void pcie_aspm_powersave_config_link(struct pci_dev *pdev)
699 {
700         struct pcie_link_state *link = pdev->link_state;
701
702         if (aspm_disabled || !pci_is_pcie(pdev) || !link)
703                 return;
704
705         if (aspm_policy != POLICY_POWERSAVE)
706                 return;
707
708         if ((pci_pcie_type(pdev) != PCI_EXP_TYPE_ROOT_PORT) &&
709             (pci_pcie_type(pdev) != PCI_EXP_TYPE_DOWNSTREAM))
710                 return;
711
712         down_read(&pci_bus_sem);
713         mutex_lock(&aspm_lock);
714         pcie_config_aspm_path(link);
715         pcie_set_clkpm(link, policy_to_clkpm_state(link));
716         mutex_unlock(&aspm_lock);
717         up_read(&pci_bus_sem);
718 }
719
720 /*
721  * pci_disable_link_state - disable pci device's link state, so the link will
722  * never enter specific states
723  */
724 static void __pci_disable_link_state(struct pci_dev *pdev, int state, bool sem,
725                                      bool force)
726 {
727         struct pci_dev *parent = pdev->bus->self;
728         struct pcie_link_state *link;
729
730         if (aspm_disabled && !force)
731                 return;
732
733         if (!pci_is_pcie(pdev))
734                 return;
735
736         if (pci_pcie_type(pdev) == PCI_EXP_TYPE_ROOT_PORT ||
737             pci_pcie_type(pdev) == PCI_EXP_TYPE_DOWNSTREAM)
738                 parent = pdev;
739         if (!parent || !parent->link_state)
740                 return;
741
742         if (sem)
743                 down_read(&pci_bus_sem);
744         mutex_lock(&aspm_lock);
745         link = parent->link_state;
746         if (state & PCIE_LINK_STATE_L0S)
747                 link->aspm_disable |= ASPM_STATE_L0S;
748         if (state & PCIE_LINK_STATE_L1)
749                 link->aspm_disable |= ASPM_STATE_L1;
750         pcie_config_aspm_link(link, policy_to_aspm_state(link));
751
752         if (state & PCIE_LINK_STATE_CLKPM) {
753                 link->clkpm_capable = 0;
754                 pcie_set_clkpm(link, 0);
755         }
756         mutex_unlock(&aspm_lock);
757         if (sem)
758                 up_read(&pci_bus_sem);
759 }
760
761 void pci_disable_link_state_locked(struct pci_dev *pdev, int state)
762 {
763         __pci_disable_link_state(pdev, state, false, false);
764 }
765 EXPORT_SYMBOL(pci_disable_link_state_locked);
766
767 void pci_disable_link_state(struct pci_dev *pdev, int state)
768 {
769         __pci_disable_link_state(pdev, state, true, false);
770 }
771 EXPORT_SYMBOL(pci_disable_link_state);
772
773 void pcie_clear_aspm(struct pci_bus *bus)
774 {
775         struct pci_dev *child;
776
777         /*
778          * Clear any ASPM setup that the firmware has carried out on this bus
779          */
780         list_for_each_entry(child, &bus->devices, bus_list) {
781                 __pci_disable_link_state(child, PCIE_LINK_STATE_L0S |
782                                          PCIE_LINK_STATE_L1 |
783                                          PCIE_LINK_STATE_CLKPM,
784                                          false, true);
785         }
786 }
787
788 static int pcie_aspm_set_policy(const char *val, struct kernel_param *kp)
789 {
790         int i;
791         struct pcie_link_state *link;
792
793         if (aspm_disabled)
794                 return -EPERM;
795         for (i = 0; i < ARRAY_SIZE(policy_str); i++)
796                 if (!strncmp(val, policy_str[i], strlen(policy_str[i])))
797                         break;
798         if (i >= ARRAY_SIZE(policy_str))
799                 return -EINVAL;
800         if (i == aspm_policy)
801                 return 0;
802
803         down_read(&pci_bus_sem);
804         mutex_lock(&aspm_lock);
805         aspm_policy = i;
806         list_for_each_entry(link, &link_list, sibling) {
807                 pcie_config_aspm_link(link, policy_to_aspm_state(link));
808                 pcie_set_clkpm(link, policy_to_clkpm_state(link));
809         }
810         mutex_unlock(&aspm_lock);
811         up_read(&pci_bus_sem);
812         return 0;
813 }
814
815 static int pcie_aspm_get_policy(char *buffer, struct kernel_param *kp)
816 {
817         int i, cnt = 0;
818         for (i = 0; i < ARRAY_SIZE(policy_str); i++)
819                 if (i == aspm_policy)
820                         cnt += sprintf(buffer + cnt, "[%s] ", policy_str[i]);
821                 else
822                         cnt += sprintf(buffer + cnt, "%s ", policy_str[i]);
823         return cnt;
824 }
825
826 module_param_call(policy, pcie_aspm_set_policy, pcie_aspm_get_policy,
827         NULL, 0644);
828
829 #ifdef CONFIG_PCIEASPM_DEBUG
830 static ssize_t link_state_show(struct device *dev,
831                 struct device_attribute *attr,
832                 char *buf)
833 {
834         struct pci_dev *pci_device = to_pci_dev(dev);
835         struct pcie_link_state *link_state = pci_device->link_state;
836
837         return sprintf(buf, "%d\n", link_state->aspm_enabled);
838 }
839
840 static ssize_t link_state_store(struct device *dev,
841                 struct device_attribute *attr,
842                 const char *buf,
843                 size_t n)
844 {
845         struct pci_dev *pdev = to_pci_dev(dev);
846         struct pcie_link_state *link, *root = pdev->link_state->root;
847         u32 val = buf[0] - '0', state = 0;
848
849         if (aspm_disabled)
850                 return -EPERM;
851         if (n < 1 || val > 3)
852                 return -EINVAL;
853
854         /* Convert requested state to ASPM state */
855         if (val & PCIE_LINK_STATE_L0S)
856                 state |= ASPM_STATE_L0S;
857         if (val & PCIE_LINK_STATE_L1)
858                 state |= ASPM_STATE_L1;
859
860         down_read(&pci_bus_sem);
861         mutex_lock(&aspm_lock);
862         list_for_each_entry(link, &link_list, sibling) {
863                 if (link->root != root)
864                         continue;
865                 pcie_config_aspm_link(link, state);
866         }
867         mutex_unlock(&aspm_lock);
868         up_read(&pci_bus_sem);
869         return n;
870 }
871
872 static ssize_t clk_ctl_show(struct device *dev,
873                 struct device_attribute *attr,
874                 char *buf)
875 {
876         struct pci_dev *pci_device = to_pci_dev(dev);
877         struct pcie_link_state *link_state = pci_device->link_state;
878
879         return sprintf(buf, "%d\n", link_state->clkpm_enabled);
880 }
881
882 static ssize_t clk_ctl_store(struct device *dev,
883                 struct device_attribute *attr,
884                 const char *buf,
885                 size_t n)
886 {
887         struct pci_dev *pdev = to_pci_dev(dev);
888         int state;
889
890         if (n < 1)
891                 return -EINVAL;
892         state = buf[0]-'0';
893
894         down_read(&pci_bus_sem);
895         mutex_lock(&aspm_lock);
896         pcie_set_clkpm_nocheck(pdev->link_state, !!state);
897         mutex_unlock(&aspm_lock);
898         up_read(&pci_bus_sem);
899
900         return n;
901 }
902
903 static DEVICE_ATTR(link_state, 0644, link_state_show, link_state_store);
904 static DEVICE_ATTR(clk_ctl, 0644, clk_ctl_show, clk_ctl_store);
905
906 static char power_group[] = "power";
907 void pcie_aspm_create_sysfs_dev_files(struct pci_dev *pdev)
908 {
909         struct pcie_link_state *link_state = pdev->link_state;
910
911         if (!pci_is_pcie(pdev) ||
912             (pci_pcie_type(pdev) != PCI_EXP_TYPE_ROOT_PORT &&
913              pci_pcie_type(pdev) != PCI_EXP_TYPE_DOWNSTREAM) || !link_state)
914                 return;
915
916         if (link_state->aspm_support)
917                 sysfs_add_file_to_group(&pdev->dev.kobj,
918                         &dev_attr_link_state.attr, power_group);
919         if (link_state->clkpm_capable)
920                 sysfs_add_file_to_group(&pdev->dev.kobj,
921                         &dev_attr_clk_ctl.attr, power_group);
922 }
923
924 void pcie_aspm_remove_sysfs_dev_files(struct pci_dev *pdev)
925 {
926         struct pcie_link_state *link_state = pdev->link_state;
927
928         if (!pci_is_pcie(pdev) ||
929             (pci_pcie_type(pdev) != PCI_EXP_TYPE_ROOT_PORT &&
930              pci_pcie_type(pdev) != PCI_EXP_TYPE_DOWNSTREAM) || !link_state)
931                 return;
932
933         if (link_state->aspm_support)
934                 sysfs_remove_file_from_group(&pdev->dev.kobj,
935                         &dev_attr_link_state.attr, power_group);
936         if (link_state->clkpm_capable)
937                 sysfs_remove_file_from_group(&pdev->dev.kobj,
938                         &dev_attr_clk_ctl.attr, power_group);
939 }
940 #endif
941
942 static int __init pcie_aspm_disable(char *str)
943 {
944         if (!strcmp(str, "off")) {
945                 aspm_policy = POLICY_DEFAULT;
946                 aspm_disabled = 1;
947                 aspm_support_enabled = false;
948                 printk(KERN_INFO "PCIe ASPM is disabled\n");
949         } else if (!strcmp(str, "force")) {
950                 aspm_force = 1;
951                 printk(KERN_INFO "PCIe ASPM is forcibly enabled\n");
952         }
953         return 1;
954 }
955
956 __setup("pcie_aspm=", pcie_aspm_disable);
957
958 void pcie_no_aspm(void)
959 {
960         /*
961          * Disabling ASPM is intended to prevent the kernel from modifying
962          * existing hardware state, not to clear existing state. To that end:
963          * (a) set policy to POLICY_DEFAULT in order to avoid changing state
964          * (b) prevent userspace from changing policy
965          */
966         if (!aspm_force) {
967                 aspm_policy = POLICY_DEFAULT;
968                 aspm_disabled = 1;
969         }
970 }
971
972 /**
973  * pcie_aspm_enabled - is PCIe ASPM enabled?
974  *
975  * Returns true if ASPM has not been disabled by the command-line option
976  * pcie_aspm=off.
977  **/
978 int pcie_aspm_enabled(void)
979 {
980        return !aspm_disabled;
981 }
982 EXPORT_SYMBOL(pcie_aspm_enabled);
983
984 bool pcie_aspm_support_enabled(void)
985 {
986         return aspm_support_enabled;
987 }
988 EXPORT_SYMBOL(pcie_aspm_support_enabled);