]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/acpica/acpi_cpu.c
Import lib9p 9d5aee77bcc1bf0e79b0a3bfefff5fdf2146283c.
[FreeBSD/FreeBSD.git] / sys / dev / acpica / acpi_cpu.c
1 /*-
2  * Copyright (c) 2003-2005 Nate Lawson (SDG)
3  * Copyright (c) 2001 Michael Smith
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30
31 #include "opt_acpi.h"
32 #include <sys/param.h>
33 #include <sys/bus.h>
34 #include <sys/cpu.h>
35 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
38 #include <sys/pcpu.h>
39 #include <sys/power.h>
40 #include <sys/proc.h>
41 #include <sys/sched.h>
42 #include <sys/sbuf.h>
43 #include <sys/smp.h>
44
45 #include <dev/pci/pcivar.h>
46 #include <machine/atomic.h>
47 #include <machine/bus.h>
48 #if defined(__amd64__) || defined(__i386__)
49 #include <machine/clock.h>
50 #include <machine/specialreg.h>
51 #include <machine/md_var.h>
52 #endif
53 #include <sys/rman.h>
54
55 #include <contrib/dev/acpica/include/acpi.h>
56 #include <contrib/dev/acpica/include/accommon.h>
57
58 #include <dev/acpica/acpivar.h>
59
60 /*
61  * Support for ACPI Processor devices, including C[1-3] sleep states.
62  */
63
64 /* Hooks for the ACPI CA debugging infrastructure */
65 #define _COMPONENT      ACPI_PROCESSOR
66 ACPI_MODULE_NAME("PROCESSOR")
67
68 struct acpi_cx {
69     struct resource     *p_lvlx;        /* Register to read to enter state. */
70     uint32_t             type;          /* C1-3 (C4 and up treated as C3). */
71     uint32_t             trans_lat;     /* Transition latency (usec). */
72     uint32_t             power;         /* Power consumed (mW). */
73     int                  res_type;      /* Resource type for p_lvlx. */
74     int                  res_rid;       /* Resource ID for p_lvlx. */
75     bool                 do_mwait;
76     uint32_t             mwait_hint;
77     bool                 mwait_hw_coord;
78     bool                 mwait_bm_avoidance;
79 };
80 #define MAX_CX_STATES    8
81
82 struct acpi_cpu_softc {
83     device_t             cpu_dev;
84     ACPI_HANDLE          cpu_handle;
85     struct pcpu         *cpu_pcpu;
86     uint32_t             cpu_acpi_id;   /* ACPI processor id */
87     uint32_t             cpu_p_blk;     /* ACPI P_BLK location */
88     uint32_t             cpu_p_blk_len; /* P_BLK length (must be 6). */
89     struct acpi_cx       cpu_cx_states[MAX_CX_STATES];
90     int                  cpu_cx_count;  /* Number of valid Cx states. */
91     int                  cpu_prev_sleep;/* Last idle sleep duration. */
92     int                  cpu_features;  /* Child driver supported features. */
93     /* Runtime state. */
94     int                  cpu_non_c2;    /* Index of lowest non-C2 state. */
95     int                  cpu_non_c3;    /* Index of lowest non-C3 state. */
96     u_int                cpu_cx_stats[MAX_CX_STATES];/* Cx usage history. */
97     /* Values for sysctl. */
98     struct sysctl_ctx_list cpu_sysctl_ctx;
99     struct sysctl_oid   *cpu_sysctl_tree;
100     int                  cpu_cx_lowest;
101     int                  cpu_cx_lowest_lim;
102     int                  cpu_disable_idle; /* Disable entry to idle function */
103     char                 cpu_cx_supported[64];
104 };
105
106 struct acpi_cpu_device {
107     struct resource_list        ad_rl;
108 };
109
110 #define CPU_GET_REG(reg, width)                                         \
111     (bus_space_read_ ## width(rman_get_bustag((reg)),                   \
112                       rman_get_bushandle((reg)), 0))
113 #define CPU_SET_REG(reg, width, val)                                    \
114     (bus_space_write_ ## width(rman_get_bustag((reg)),                  \
115                        rman_get_bushandle((reg)), 0, (val)))
116
117 #define PM_USEC(x)       ((x) >> 2)     /* ~4 clocks per usec (3.57955 Mhz) */
118
119 #define ACPI_NOTIFY_CX_STATES   0x81    /* _CST changed. */
120
121 #define CPU_QUIRK_NO_C3         (1<<0)  /* C3-type states are not usable. */
122 #define CPU_QUIRK_NO_BM_CTRL    (1<<2)  /* No bus mastering control. */
123
124 #define PCI_VENDOR_INTEL        0x8086
125 #define PCI_DEVICE_82371AB_3    0x7113  /* PIIX4 chipset for quirks. */
126 #define PCI_REVISION_A_STEP     0
127 #define PCI_REVISION_B_STEP     1
128 #define PCI_REVISION_4E         2
129 #define PCI_REVISION_4M         3
130 #define PIIX4_DEVACTB_REG       0x58
131 #define PIIX4_BRLD_EN_IRQ0      (1<<0)
132 #define PIIX4_BRLD_EN_IRQ       (1<<1)
133 #define PIIX4_BRLD_EN_IRQ8      (1<<5)
134 #define PIIX4_STOP_BREAK_MASK   (PIIX4_BRLD_EN_IRQ0 | PIIX4_BRLD_EN_IRQ | PIIX4_BRLD_EN_IRQ8)
135 #define PIIX4_PCNTRL_BST_EN     (1<<10)
136
137 #define CST_FFH_VENDOR_INTEL    1
138 #define CST_FFH_INTEL_CL_C1IO   1
139 #define CST_FFH_INTEL_CL_MWAIT  2
140 #define CST_FFH_MWAIT_HW_COORD  0x0001
141 #define CST_FFH_MWAIT_BM_AVOID  0x0002
142
143 #define CPUDEV_DEVICE_ID        "ACPI0007"
144
145 /* Allow users to ignore processor orders in MADT. */
146 static int cpu_unordered;
147 SYSCTL_INT(_debug_acpi, OID_AUTO, cpu_unordered, CTLFLAG_RDTUN,
148     &cpu_unordered, 0,
149     "Do not use the MADT to match ACPI Processor objects to CPUs.");
150
151 /* Knob to disable acpi_cpu devices */
152 bool acpi_cpu_disabled = false;
153
154 /* Platform hardware resource information. */
155 static uint32_t          cpu_smi_cmd;   /* Value to write to SMI_CMD. */
156 static uint8_t           cpu_cst_cnt;   /* Indicate we are _CST aware. */
157 static int               cpu_quirks;    /* Indicate any hardware bugs. */
158
159 /* Values for sysctl. */
160 static struct sysctl_ctx_list cpu_sysctl_ctx;
161 static struct sysctl_oid *cpu_sysctl_tree;
162 static int               cpu_cx_generic;
163 static int               cpu_cx_lowest_lim;
164
165 static device_t         *cpu_devices;
166 static int               cpu_ndevices;
167 static struct acpi_cpu_softc **cpu_softc;
168 ACPI_SERIAL_DECL(cpu, "ACPI CPU");
169
170 static int      acpi_cpu_probe(device_t dev);
171 static int      acpi_cpu_attach(device_t dev);
172 static int      acpi_cpu_suspend(device_t dev);
173 static int      acpi_cpu_resume(device_t dev);
174 static int      acpi_pcpu_get_id(device_t dev, uint32_t *acpi_id,
175                     uint32_t *cpu_id);
176 static struct resource_list *acpi_cpu_get_rlist(device_t dev, device_t child);
177 static device_t acpi_cpu_add_child(device_t dev, u_int order, const char *name,
178                     int unit);
179 static int      acpi_cpu_read_ivar(device_t dev, device_t child, int index,
180                     uintptr_t *result);
181 static int      acpi_cpu_shutdown(device_t dev);
182 static void     acpi_cpu_cx_probe(struct acpi_cpu_softc *sc);
183 static void     acpi_cpu_generic_cx_probe(struct acpi_cpu_softc *sc);
184 static int      acpi_cpu_cx_cst(struct acpi_cpu_softc *sc);
185 static void     acpi_cpu_startup(void *arg);
186 static void     acpi_cpu_startup_cx(struct acpi_cpu_softc *sc);
187 static void     acpi_cpu_cx_list(struct acpi_cpu_softc *sc);
188 #if defined(__i386__) || defined(__amd64__)
189 static void     acpi_cpu_idle(sbintime_t sbt);
190 #endif
191 static void     acpi_cpu_notify(ACPI_HANDLE h, UINT32 notify, void *context);
192 static void     acpi_cpu_quirks(void);
193 static void     acpi_cpu_quirks_piix4(void);
194 static int      acpi_cpu_usage_sysctl(SYSCTL_HANDLER_ARGS);
195 static int      acpi_cpu_usage_counters_sysctl(SYSCTL_HANDLER_ARGS);
196 static int      acpi_cpu_set_cx_lowest(struct acpi_cpu_softc *sc);
197 static int      acpi_cpu_cx_lowest_sysctl(SYSCTL_HANDLER_ARGS);
198 static int      acpi_cpu_global_cx_lowest_sysctl(SYSCTL_HANDLER_ARGS);
199 #if defined(__i386__) || defined(__amd64__)
200 static int      acpi_cpu_method_sysctl(SYSCTL_HANDLER_ARGS);
201 #endif
202
203 static device_method_t acpi_cpu_methods[] = {
204     /* Device interface */
205     DEVMETHOD(device_probe,     acpi_cpu_probe),
206     DEVMETHOD(device_attach,    acpi_cpu_attach),
207     DEVMETHOD(device_detach,    bus_generic_detach),
208     DEVMETHOD(device_shutdown,  acpi_cpu_shutdown),
209     DEVMETHOD(device_suspend,   acpi_cpu_suspend),
210     DEVMETHOD(device_resume,    acpi_cpu_resume),
211
212     /* Bus interface */
213     DEVMETHOD(bus_add_child,    acpi_cpu_add_child),
214     DEVMETHOD(bus_read_ivar,    acpi_cpu_read_ivar),
215     DEVMETHOD(bus_get_resource_list, acpi_cpu_get_rlist),
216     DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
217     DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
218     DEVMETHOD(bus_alloc_resource, bus_generic_rl_alloc_resource),
219     DEVMETHOD(bus_release_resource, bus_generic_rl_release_resource),
220     DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
221     DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
222     DEVMETHOD(bus_setup_intr,   bus_generic_setup_intr),
223     DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
224
225     DEVMETHOD_END
226 };
227
228 static driver_t acpi_cpu_driver = {
229     "cpu",
230     acpi_cpu_methods,
231     sizeof(struct acpi_cpu_softc),
232 };
233
234 static devclass_t acpi_cpu_devclass;
235 DRIVER_MODULE(cpu, acpi, acpi_cpu_driver, acpi_cpu_devclass, 0, 0);
236 MODULE_DEPEND(cpu, acpi, 1, 1, 1);
237
238 static int
239 acpi_cpu_probe(device_t dev)
240 {
241     static char            *cpudev_ids[] = { CPUDEV_DEVICE_ID, NULL };
242     int                    acpi_id, cpu_id;
243     ACPI_BUFFER            buf;
244     ACPI_HANDLE            handle;
245     ACPI_OBJECT            *obj;
246     ACPI_STATUS            status;
247     ACPI_OBJECT_TYPE       type;
248
249     if (acpi_disabled("cpu") || acpi_cpu_disabled)
250         return (ENXIO);
251     type = acpi_get_type(dev);
252     if (type != ACPI_TYPE_PROCESSOR && type != ACPI_TYPE_DEVICE)
253         return (ENXIO);
254     if (type == ACPI_TYPE_DEVICE &&
255         ACPI_ID_PROBE(device_get_parent(dev), dev, cpudev_ids, NULL) >= 0)
256         return (ENXIO);
257
258     handle = acpi_get_handle(dev);
259     if (cpu_softc == NULL)
260         cpu_softc = malloc(sizeof(struct acpi_cpu_softc *) *
261             (mp_maxid + 1), M_TEMP /* XXX */, M_WAITOK | M_ZERO);
262
263     if (type == ACPI_TYPE_PROCESSOR) {
264         /* Get our Processor object. */
265         buf.Pointer = NULL;
266         buf.Length = ACPI_ALLOCATE_BUFFER;
267         status = AcpiEvaluateObject(handle, NULL, NULL, &buf);
268         if (ACPI_FAILURE(status)) {
269             device_printf(dev, "probe failed to get Processor obj - %s\n",
270                 AcpiFormatException(status));
271             return (ENXIO);
272         }
273         obj = (ACPI_OBJECT *)buf.Pointer;
274         if (obj->Type != ACPI_TYPE_PROCESSOR) {
275             device_printf(dev, "Processor object has bad type %d\n",
276                 obj->Type);
277             AcpiOsFree(obj);
278             return (ENXIO);
279         }
280
281         /*
282          * Find the processor associated with our unit.  We could use the
283          * ProcId as a key, however, some boxes do not have the same values
284          * in their Processor object as the ProcId values in the MADT.
285          */
286         acpi_id = obj->Processor.ProcId;
287         AcpiOsFree(obj);
288     } else {
289         status = acpi_GetInteger(handle, "_UID", &acpi_id);
290         if (ACPI_FAILURE(status)) {
291             device_printf(dev, "Device object has bad value - %s\n",
292                 AcpiFormatException(status));
293             return (ENXIO);
294         }
295     }
296     if (acpi_pcpu_get_id(dev, &acpi_id, &cpu_id) != 0)
297         return (ENXIO);
298
299     /*
300      * Check if we already probed this processor.  We scan the bus twice
301      * so it's possible we've already seen this one.
302      */
303     if (cpu_softc[cpu_id] != NULL)
304         return (ENXIO);
305
306     /* Mark this processor as in-use and save our derived id for attach. */
307     cpu_softc[cpu_id] = (void *)1;
308     acpi_set_private(dev, (void*)(intptr_t)cpu_id);
309     device_set_desc(dev, "ACPI CPU");
310
311     if (!bootverbose && device_get_unit(dev) != 0) {
312             device_quiet(dev);
313             device_quiet_children(dev);
314     }
315
316     return (0);
317 }
318
319 static int
320 acpi_cpu_attach(device_t dev)
321 {
322     ACPI_BUFFER            buf;
323     ACPI_OBJECT            arg, *obj;
324     ACPI_OBJECT_LIST       arglist;
325     struct pcpu            *pcpu_data;
326     struct acpi_cpu_softc *sc;
327     struct acpi_softc     *acpi_sc;
328     ACPI_STATUS            status;
329     u_int                  features;
330     int                    cpu_id, drv_count, i;
331     driver_t              **drivers;
332     uint32_t               cap_set[3];
333
334     /* UUID needed by _OSC evaluation */
335     static uint8_t cpu_oscuuid[16] = { 0x16, 0xA6, 0x77, 0x40, 0x0C, 0x29,
336                                        0xBE, 0x47, 0x9E, 0xBD, 0xD8, 0x70,
337                                        0x58, 0x71, 0x39, 0x53 };
338
339     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
340
341     sc = device_get_softc(dev);
342     sc->cpu_dev = dev;
343     sc->cpu_handle = acpi_get_handle(dev);
344     cpu_id = (int)(intptr_t)acpi_get_private(dev);
345     cpu_softc[cpu_id] = sc;
346     pcpu_data = pcpu_find(cpu_id);
347     pcpu_data->pc_device = dev;
348     sc->cpu_pcpu = pcpu_data;
349     cpu_smi_cmd = AcpiGbl_FADT.SmiCommand;
350     cpu_cst_cnt = AcpiGbl_FADT.CstControl;
351
352     if (acpi_get_type(dev) == ACPI_TYPE_PROCESSOR) {
353         buf.Pointer = NULL;
354         buf.Length = ACPI_ALLOCATE_BUFFER;
355         status = AcpiEvaluateObject(sc->cpu_handle, NULL, NULL, &buf);
356         if (ACPI_FAILURE(status)) {
357             device_printf(dev, "attach failed to get Processor obj - %s\n",
358                 AcpiFormatException(status));
359             return (ENXIO);
360         }
361         obj = (ACPI_OBJECT *)buf.Pointer;
362         sc->cpu_p_blk = obj->Processor.PblkAddress;
363         sc->cpu_p_blk_len = obj->Processor.PblkLength;
364         sc->cpu_acpi_id = obj->Processor.ProcId;
365         AcpiOsFree(obj);
366     } else {
367         KASSERT(acpi_get_type(dev) == ACPI_TYPE_DEVICE,
368             ("Unexpected ACPI object"));
369         status = acpi_GetInteger(sc->cpu_handle, "_UID", &sc->cpu_acpi_id);
370         if (ACPI_FAILURE(status)) {
371             device_printf(dev, "Device object has bad value - %s\n",
372                 AcpiFormatException(status));
373             return (ENXIO);
374         }
375         sc->cpu_p_blk = 0;
376         sc->cpu_p_blk_len = 0;
377     }
378     ACPI_DEBUG_PRINT((ACPI_DB_INFO, "acpi_cpu%d: P_BLK at %#x/%d\n",
379                      device_get_unit(dev), sc->cpu_p_blk, sc->cpu_p_blk_len));
380
381     /*
382      * If this is the first cpu we attach, create and initialize the generic
383      * resources that will be used by all acpi cpu devices.
384      */
385     if (device_get_unit(dev) == 0) {
386         /* Assume we won't be using generic Cx mode by default */
387         cpu_cx_generic = FALSE;
388
389         /* Install hw.acpi.cpu sysctl tree */
390         acpi_sc = acpi_device_get_parent_softc(dev);
391         sysctl_ctx_init(&cpu_sysctl_ctx);
392         cpu_sysctl_tree = SYSCTL_ADD_NODE(&cpu_sysctl_ctx,
393             SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO, "cpu",
394             CTLFLAG_RD | CTLFLAG_MPSAFE, 0, "node for CPU children");
395     }
396
397     /*
398      * Before calling any CPU methods, collect child driver feature hints
399      * and notify ACPI of them.  We support unified SMP power control
400      * so advertise this ourselves.  Note this is not the same as independent
401      * SMP control where each CPU can have different settings.
402      */
403     sc->cpu_features = ACPI_CAP_SMP_SAME | ACPI_CAP_SMP_SAME_C3 |
404       ACPI_CAP_C1_IO_HALT;
405
406 #if defined(__i386__) || defined(__amd64__)
407     /*
408      * Ask for MWAIT modes if not disabled and interrupts work
409      * reasonable with MWAIT.
410      */
411     if (!acpi_disabled("mwait") && cpu_mwait_usable())
412         sc->cpu_features |= ACPI_CAP_SMP_C1_NATIVE | ACPI_CAP_SMP_C3_NATIVE;
413 #endif
414
415     if (devclass_get_drivers(acpi_cpu_devclass, &drivers, &drv_count) == 0) {
416         for (i = 0; i < drv_count; i++) {
417             if (ACPI_GET_FEATURES(drivers[i], &features) == 0)
418                 sc->cpu_features |= features;
419         }
420         free(drivers, M_TEMP);
421     }
422
423     /*
424      * CPU capabilities are specified in
425      * Intel Processor Vendor-Specific ACPI Interface Specification.
426      */
427     if (sc->cpu_features) {
428         cap_set[1] = sc->cpu_features;
429         status = acpi_EvaluateOSC(sc->cpu_handle, cpu_oscuuid, 1, 2, cap_set,
430             cap_set, false);
431         if (ACPI_SUCCESS(status)) {
432             if (cap_set[0] != 0)
433                 device_printf(dev, "_OSC returned status %#x\n", cap_set[0]);
434         }
435         else {
436             arglist.Pointer = &arg;
437             arglist.Count = 1;
438             arg.Type = ACPI_TYPE_BUFFER;
439             arg.Buffer.Length = sizeof(cap_set);
440             arg.Buffer.Pointer = (uint8_t *)cap_set;
441             cap_set[0] = 1; /* revision */
442             cap_set[1] = 1; /* number of capabilities integers */
443             cap_set[2] = sc->cpu_features;
444             AcpiEvaluateObject(sc->cpu_handle, "_PDC", &arglist, NULL);
445         }
446     }
447
448     /* Probe for Cx state support. */
449     acpi_cpu_cx_probe(sc);
450
451     return (0);
452 }
453
454 static void
455 acpi_cpu_postattach(void *unused __unused)
456 {
457     device_t *devices;
458     int err;
459     int i, n;
460     int attached;
461
462     err = devclass_get_devices(acpi_cpu_devclass, &devices, &n);
463     if (err != 0) {
464         printf("devclass_get_devices(acpi_cpu_devclass) failed\n");
465         return;
466     }
467     attached = 0;
468     for (i = 0; i < n; i++)
469         if (device_is_attached(devices[i]) &&
470             device_get_driver(devices[i]) == &acpi_cpu_driver)
471             attached = 1;
472     for (i = 0; i < n; i++)
473         bus_generic_probe(devices[i]);
474     for (i = 0; i < n; i++)
475         bus_generic_attach(devices[i]);
476     free(devices, M_TEMP);
477
478     if (attached) {
479 #ifdef EARLY_AP_STARTUP
480         acpi_cpu_startup(NULL);
481 #else
482         /* Queue post cpu-probing task handler */
483         AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_cpu_startup, NULL);
484 #endif
485     }
486 }
487
488 SYSINIT(acpi_cpu, SI_SUB_CONFIGURE, SI_ORDER_MIDDLE,
489     acpi_cpu_postattach, NULL);
490
491 static void
492 disable_idle(struct acpi_cpu_softc *sc)
493 {
494     cpuset_t cpuset;
495
496     CPU_SETOF(sc->cpu_pcpu->pc_cpuid, &cpuset);
497     sc->cpu_disable_idle = TRUE;
498
499     /*
500      * Ensure that the CPU is not in idle state or in acpi_cpu_idle().
501      * Note that this code depends on the fact that the rendezvous IPI
502      * can not penetrate context where interrupts are disabled and acpi_cpu_idle
503      * is called and executed in such a context with interrupts being re-enabled
504      * right before return.
505      */
506     smp_rendezvous_cpus(cpuset, smp_no_rendezvous_barrier, NULL,
507         smp_no_rendezvous_barrier, NULL);
508 }
509
510 static void
511 enable_idle(struct acpi_cpu_softc *sc)
512 {
513
514     sc->cpu_disable_idle = FALSE;
515 }
516
517 #if defined(__i386__) || defined(__amd64__)
518 static int
519 is_idle_disabled(struct acpi_cpu_softc *sc)
520 {
521
522     return (sc->cpu_disable_idle);
523 }
524 #endif
525
526 /*
527  * Disable any entry to the idle function during suspend and re-enable it
528  * during resume.
529  */
530 static int
531 acpi_cpu_suspend(device_t dev)
532 {
533     int error;
534
535     error = bus_generic_suspend(dev);
536     if (error)
537         return (error);
538     disable_idle(device_get_softc(dev));
539     return (0);
540 }
541
542 static int
543 acpi_cpu_resume(device_t dev)
544 {
545
546     enable_idle(device_get_softc(dev));
547     return (bus_generic_resume(dev));
548 }
549
550 /*
551  * Find the processor associated with a given ACPI ID.  By default,
552  * use the MADT to map ACPI IDs to APIC IDs and use that to locate a
553  * processor.  Some systems have inconsistent ASL and MADT however.
554  * For these systems the cpu_unordered tunable can be set in which
555  * case we assume that Processor objects are listed in the same order
556  * in both the MADT and ASL.
557  */
558 static int
559 acpi_pcpu_get_id(device_t dev, uint32_t *acpi_id, uint32_t *cpu_id)
560 {
561     struct pcpu *pc;
562     uint32_t     i, idx;
563
564     KASSERT(acpi_id != NULL, ("Null acpi_id"));
565     KASSERT(cpu_id != NULL, ("Null cpu_id"));
566     idx = device_get_unit(dev);
567
568     /*
569      * If pc_acpi_id for CPU 0 is not initialized (e.g. a non-APIC
570      * UP box) use the ACPI ID from the first processor we find.
571      */
572     if (idx == 0 && mp_ncpus == 1) {
573         pc = pcpu_find(0);
574         if (pc->pc_acpi_id == 0xffffffff)
575             pc->pc_acpi_id = *acpi_id;
576         *cpu_id = 0;
577         return (0);
578     }
579
580     CPU_FOREACH(i) {
581         pc = pcpu_find(i);
582         KASSERT(pc != NULL, ("no pcpu data for %d", i));
583         if (cpu_unordered) {
584             if (idx-- == 0) {
585                 /*
586                  * If pc_acpi_id doesn't match the ACPI ID from the
587                  * ASL, prefer the MADT-derived value.
588                  */
589                 if (pc->pc_acpi_id != *acpi_id)
590                     *acpi_id = pc->pc_acpi_id;
591                 *cpu_id = pc->pc_cpuid;
592                 return (0);
593             }
594         } else {
595             if (pc->pc_acpi_id == *acpi_id) {
596                 if (bootverbose)
597                     device_printf(dev,
598                         "Processor %s (ACPI ID %u) -> APIC ID %d\n",
599                         acpi_name(acpi_get_handle(dev)), *acpi_id,
600                         pc->pc_cpuid);
601                 *cpu_id = pc->pc_cpuid;
602                 return (0);
603             }
604         }
605     }
606
607     if (bootverbose)
608         printf("ACPI: Processor %s (ACPI ID %u) ignored\n",
609             acpi_name(acpi_get_handle(dev)), *acpi_id);
610
611     return (ESRCH);
612 }
613
614 static struct resource_list *
615 acpi_cpu_get_rlist(device_t dev, device_t child)
616 {
617     struct acpi_cpu_device *ad;
618
619     ad = device_get_ivars(child);
620     if (ad == NULL)
621         return (NULL);
622     return (&ad->ad_rl);
623 }
624
625 static device_t
626 acpi_cpu_add_child(device_t dev, u_int order, const char *name, int unit)
627 {
628     struct acpi_cpu_device *ad;
629     device_t child;
630
631     if ((ad = malloc(sizeof(*ad), M_TEMP, M_NOWAIT | M_ZERO)) == NULL)
632         return (NULL);
633
634     resource_list_init(&ad->ad_rl);
635     
636     child = device_add_child_ordered(dev, order, name, unit);
637     if (child != NULL)
638         device_set_ivars(child, ad);
639     else
640         free(ad, M_TEMP);
641     return (child);
642 }
643
644 static int
645 acpi_cpu_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
646 {
647     struct acpi_cpu_softc *sc;
648
649     sc = device_get_softc(dev);
650     switch (index) {
651     case ACPI_IVAR_HANDLE:
652         *result = (uintptr_t)sc->cpu_handle;
653         break;
654     case CPU_IVAR_PCPU:
655         *result = (uintptr_t)sc->cpu_pcpu;
656         break;
657 #if defined(__amd64__) || defined(__i386__)
658     case CPU_IVAR_NOMINAL_MHZ:
659         if (tsc_is_invariant) {
660             *result = (uintptr_t)(atomic_load_acq_64(&tsc_freq) / 1000000);
661             break;
662         }
663         /* FALLTHROUGH */
664 #endif
665     default:
666         return (ENOENT);
667     }
668     return (0);
669 }
670
671 static int
672 acpi_cpu_shutdown(device_t dev)
673 {
674     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
675
676     /* Allow children to shutdown first. */
677     bus_generic_shutdown(dev);
678
679     /*
680      * Disable any entry to the idle function.
681      */
682     disable_idle(device_get_softc(dev));
683
684     /*
685      * CPU devices are not truly detached and remain referenced,
686      * so their resources are not freed.
687      */
688
689     return_VALUE (0);
690 }
691
692 static void
693 acpi_cpu_cx_probe(struct acpi_cpu_softc *sc)
694 {
695     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
696
697     /* Use initial sleep value of 1 sec. to start with lowest idle state. */
698     sc->cpu_prev_sleep = 1000000;
699     sc->cpu_cx_lowest = 0;
700     sc->cpu_cx_lowest_lim = 0;
701
702     /*
703      * Check for the ACPI 2.0 _CST sleep states object. If we can't find
704      * any, we'll revert to generic FADT/P_BLK Cx control method which will
705      * be handled by acpi_cpu_startup. We need to defer to after having
706      * probed all the cpus in the system before probing for generic Cx
707      * states as we may already have found cpus with valid _CST packages
708      */
709     if (!cpu_cx_generic && acpi_cpu_cx_cst(sc) != 0) {
710         /*
711          * We were unable to find a _CST package for this cpu or there
712          * was an error parsing it. Switch back to generic mode.
713          */
714         cpu_cx_generic = TRUE;
715         if (bootverbose)
716             device_printf(sc->cpu_dev, "switching to generic Cx mode\n");
717     }
718
719     /*
720      * TODO: _CSD Package should be checked here.
721      */
722 }
723
724 static void
725 acpi_cpu_generic_cx_probe(struct acpi_cpu_softc *sc)
726 {
727     ACPI_GENERIC_ADDRESS         gas;
728     struct acpi_cx              *cx_ptr;
729
730     sc->cpu_cx_count = 0;
731     cx_ptr = sc->cpu_cx_states;
732
733     /* Use initial sleep value of 1 sec. to start with lowest idle state. */
734     sc->cpu_prev_sleep = 1000000;
735
736     /* C1 has been required since just after ACPI 1.0 */
737     cx_ptr->type = ACPI_STATE_C1;
738     cx_ptr->trans_lat = 0;
739     cx_ptr++;
740     sc->cpu_non_c2 = sc->cpu_cx_count;
741     sc->cpu_non_c3 = sc->cpu_cx_count;
742     sc->cpu_cx_count++;
743
744     /* 
745      * The spec says P_BLK must be 6 bytes long.  However, some systems
746      * use it to indicate a fractional set of features present so we
747      * take 5 as C2.  Some may also have a value of 7 to indicate
748      * another C3 but most use _CST for this (as required) and having
749      * "only" C1-C3 is not a hardship.
750      */
751     if (sc->cpu_p_blk_len < 5)
752         return; 
753
754     /* Validate and allocate resources for C2 (P_LVL2). */
755     gas.SpaceId = ACPI_ADR_SPACE_SYSTEM_IO;
756     gas.BitWidth = 8;
757     if (AcpiGbl_FADT.C2Latency <= 100) {
758         gas.Address = sc->cpu_p_blk + 4;
759         cx_ptr->res_rid = 0;
760         acpi_bus_alloc_gas(sc->cpu_dev, &cx_ptr->res_type, &cx_ptr->res_rid,
761             &gas, &cx_ptr->p_lvlx, RF_SHAREABLE);
762         if (cx_ptr->p_lvlx != NULL) {
763             cx_ptr->type = ACPI_STATE_C2;
764             cx_ptr->trans_lat = AcpiGbl_FADT.C2Latency;
765             cx_ptr++;
766             sc->cpu_non_c3 = sc->cpu_cx_count;
767             sc->cpu_cx_count++;
768         }
769     }
770     if (sc->cpu_p_blk_len < 6)
771         return;
772
773     /* Validate and allocate resources for C3 (P_LVL3). */
774     if (AcpiGbl_FADT.C3Latency <= 1000 && !(cpu_quirks & CPU_QUIRK_NO_C3)) {
775         gas.Address = sc->cpu_p_blk + 5;
776         cx_ptr->res_rid = 1;
777         acpi_bus_alloc_gas(sc->cpu_dev, &cx_ptr->res_type, &cx_ptr->res_rid,
778             &gas, &cx_ptr->p_lvlx, RF_SHAREABLE);
779         if (cx_ptr->p_lvlx != NULL) {
780             cx_ptr->type = ACPI_STATE_C3;
781             cx_ptr->trans_lat = AcpiGbl_FADT.C3Latency;
782             cx_ptr++;
783             sc->cpu_cx_count++;
784         }
785     }
786 }
787
788 #if defined(__i386__) || defined(__amd64__)
789 static void
790 acpi_cpu_cx_cst_mwait(struct acpi_cx *cx_ptr, uint64_t address, int accsize)
791 {
792
793         cx_ptr->do_mwait = true;
794         cx_ptr->mwait_hint = address & 0xffffffff;
795         cx_ptr->mwait_hw_coord = (accsize & CST_FFH_MWAIT_HW_COORD) != 0;
796         cx_ptr->mwait_bm_avoidance = (accsize & CST_FFH_MWAIT_BM_AVOID) != 0;
797 }
798 #endif
799
800 static void
801 acpi_cpu_cx_cst_free_plvlx(device_t cpu_dev, struct acpi_cx *cx_ptr)
802 {
803
804         if (cx_ptr->p_lvlx == NULL)
805                 return;
806         bus_release_resource(cpu_dev, cx_ptr->res_type, cx_ptr->res_rid,
807             cx_ptr->p_lvlx);
808         cx_ptr->p_lvlx = NULL;
809 }
810
811 /*
812  * Parse a _CST package and set up its Cx states.  Since the _CST object
813  * can change dynamically, our notify handler may call this function
814  * to clean up and probe the new _CST package.
815  */
816 static int
817 acpi_cpu_cx_cst(struct acpi_cpu_softc *sc)
818 {
819     struct       acpi_cx *cx_ptr;
820     ACPI_STATUS  status;
821     ACPI_BUFFER  buf;
822     ACPI_OBJECT *top;
823     ACPI_OBJECT *pkg;
824     uint32_t     count;
825     int          i;
826 #if defined(__i386__) || defined(__amd64__)
827     uint64_t     address;
828     int          vendor, class, accsize;
829 #endif
830
831     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
832
833     buf.Pointer = NULL;
834     buf.Length = ACPI_ALLOCATE_BUFFER;
835     status = AcpiEvaluateObject(sc->cpu_handle, "_CST", NULL, &buf);
836     if (ACPI_FAILURE(status))
837         return (ENXIO);
838
839     /* _CST is a package with a count and at least one Cx package. */
840     top = (ACPI_OBJECT *)buf.Pointer;
841     if (!ACPI_PKG_VALID(top, 2) || acpi_PkgInt32(top, 0, &count) != 0) {
842         device_printf(sc->cpu_dev, "invalid _CST package\n");
843         AcpiOsFree(buf.Pointer);
844         return (ENXIO);
845     }
846     if (count != top->Package.Count - 1) {
847         device_printf(sc->cpu_dev, "invalid _CST state count (%d != %d)\n",
848                count, top->Package.Count - 1);
849         count = top->Package.Count - 1;
850     }
851     if (count > MAX_CX_STATES) {
852         device_printf(sc->cpu_dev, "_CST has too many states (%d)\n", count);
853         count = MAX_CX_STATES;
854     }
855
856     sc->cpu_non_c2 = 0;
857     sc->cpu_non_c3 = 0;
858     sc->cpu_cx_count = 0;
859     cx_ptr = sc->cpu_cx_states;
860
861     /*
862      * C1 has been required since just after ACPI 1.0.
863      * Reserve the first slot for it.
864      */
865     cx_ptr->type = ACPI_STATE_C0;
866     cx_ptr++;
867     sc->cpu_cx_count++;
868
869     /* Set up all valid states. */
870     for (i = 0; i < count; i++) {
871         pkg = &top->Package.Elements[i + 1];
872         if (!ACPI_PKG_VALID(pkg, 4) ||
873             acpi_PkgInt32(pkg, 1, &cx_ptr->type) != 0 ||
874             acpi_PkgInt32(pkg, 2, &cx_ptr->trans_lat) != 0 ||
875             acpi_PkgInt32(pkg, 3, &cx_ptr->power) != 0) {
876             device_printf(sc->cpu_dev, "skipping invalid Cx state package\n");
877             continue;
878         }
879
880         /* Validate the state to see if we should use it. */
881         switch (cx_ptr->type) {
882         case ACPI_STATE_C1:
883             acpi_cpu_cx_cst_free_plvlx(sc->cpu_dev, cx_ptr);
884 #if defined(__i386__) || defined(__amd64__)
885             if (acpi_PkgFFH_IntelCpu(pkg, 0, &vendor, &class, &address,
886               &accsize) == 0 && vendor == CST_FFH_VENDOR_INTEL) {
887                 if (class == CST_FFH_INTEL_CL_C1IO) {
888                     /* C1 I/O then Halt */
889                     cx_ptr->res_rid = sc->cpu_cx_count;
890                     bus_set_resource(sc->cpu_dev, SYS_RES_IOPORT,
891                       cx_ptr->res_rid, address, 1);
892                     cx_ptr->p_lvlx = bus_alloc_resource_any(sc->cpu_dev,
893                       SYS_RES_IOPORT, &cx_ptr->res_rid, RF_ACTIVE |
894                       RF_SHAREABLE);
895                     if (cx_ptr->p_lvlx == NULL) {
896                         bus_delete_resource(sc->cpu_dev, SYS_RES_IOPORT,
897                           cx_ptr->res_rid);
898                         device_printf(sc->cpu_dev,
899                           "C1 I/O failed to allocate port %d, "
900                           "degrading to C1 Halt", (int)address);
901                     }
902                 } else if (class == CST_FFH_INTEL_CL_MWAIT) {
903                     acpi_cpu_cx_cst_mwait(cx_ptr, address, accsize);
904                 }
905             }
906 #endif
907             if (sc->cpu_cx_states[0].type == ACPI_STATE_C0) {
908                 /* This is the first C1 state.  Use the reserved slot. */
909                 sc->cpu_cx_states[0] = *cx_ptr;
910             } else {
911                 sc->cpu_non_c2 = sc->cpu_cx_count;
912                 sc->cpu_non_c3 = sc->cpu_cx_count;
913                 cx_ptr++;
914                 sc->cpu_cx_count++;
915             }
916             continue;
917         case ACPI_STATE_C2:
918             sc->cpu_non_c3 = sc->cpu_cx_count;
919             break;
920         case ACPI_STATE_C3:
921         default:
922             if ((cpu_quirks & CPU_QUIRK_NO_C3) != 0) {
923                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
924                                  "acpi_cpu%d: C3[%d] not available.\n",
925                                  device_get_unit(sc->cpu_dev), i));
926                 continue;
927             }
928             break;
929         }
930
931         /* Free up any previous register. */
932         acpi_cpu_cx_cst_free_plvlx(sc->cpu_dev, cx_ptr);
933
934         /* Allocate the control register for C2 or C3. */
935 #if defined(__i386__) || defined(__amd64__)
936         if (acpi_PkgFFH_IntelCpu(pkg, 0, &vendor, &class, &address,
937           &accsize) == 0 && vendor == CST_FFH_VENDOR_INTEL &&
938           class == CST_FFH_INTEL_CL_MWAIT) {
939             /* Native C State Instruction use (mwait) */
940             acpi_cpu_cx_cst_mwait(cx_ptr, address, accsize);
941             ACPI_DEBUG_PRINT((ACPI_DB_INFO,
942               "acpi_cpu%d: Got C%d/mwait - %d latency\n",
943               device_get_unit(sc->cpu_dev), cx_ptr->type, cx_ptr->trans_lat));
944             cx_ptr++;
945             sc->cpu_cx_count++;
946         } else
947 #endif
948         {
949             cx_ptr->res_rid = sc->cpu_cx_count;
950             acpi_PkgGas(sc->cpu_dev, pkg, 0, &cx_ptr->res_type,
951                 &cx_ptr->res_rid, &cx_ptr->p_lvlx, RF_SHAREABLE);
952             if (cx_ptr->p_lvlx) {
953                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
954                      "acpi_cpu%d: Got C%d - %d latency\n",
955                      device_get_unit(sc->cpu_dev), cx_ptr->type,
956                      cx_ptr->trans_lat));
957                 cx_ptr++;
958                 sc->cpu_cx_count++;
959             }
960         }
961     }
962     AcpiOsFree(buf.Pointer);
963
964     /* If C1 state was not found, we need one now. */
965     cx_ptr = sc->cpu_cx_states;
966     if (cx_ptr->type == ACPI_STATE_C0) {
967         cx_ptr->type = ACPI_STATE_C1;
968         cx_ptr->trans_lat = 0;
969     }
970
971     return (0);
972 }
973
974 /*
975  * Call this *after* all CPUs have been attached.
976  */
977 static void
978 acpi_cpu_startup(void *arg)
979 {
980     struct acpi_cpu_softc *sc;
981     int i;
982
983     /* Get set of CPU devices */
984     devclass_get_devices(acpi_cpu_devclass, &cpu_devices, &cpu_ndevices);
985
986     /*
987      * Setup any quirks that might necessary now that we have probed
988      * all the CPUs
989      */
990     acpi_cpu_quirks();
991
992     if (cpu_cx_generic) {
993         /*
994          * We are using generic Cx mode, probe for available Cx states
995          * for all processors.
996          */
997         for (i = 0; i < cpu_ndevices; i++) {
998             sc = device_get_softc(cpu_devices[i]);
999             acpi_cpu_generic_cx_probe(sc);
1000         }
1001     } else {
1002         /*
1003          * We are using _CST mode, remove C3 state if necessary.
1004          * As we now know for sure that we will be using _CST mode
1005          * install our notify handler.
1006          */
1007         for (i = 0; i < cpu_ndevices; i++) {
1008             sc = device_get_softc(cpu_devices[i]);
1009             if (cpu_quirks & CPU_QUIRK_NO_C3) {
1010                 sc->cpu_cx_count = min(sc->cpu_cx_count, sc->cpu_non_c3 + 1);
1011             }
1012             AcpiInstallNotifyHandler(sc->cpu_handle, ACPI_DEVICE_NOTIFY,
1013                 acpi_cpu_notify, sc);
1014         }
1015     }
1016
1017     /* Perform Cx final initialization. */
1018     for (i = 0; i < cpu_ndevices; i++) {
1019         sc = device_get_softc(cpu_devices[i]);
1020         acpi_cpu_startup_cx(sc);
1021     }
1022
1023     /* Add a sysctl handler to handle global Cx lowest setting */
1024     SYSCTL_ADD_PROC(&cpu_sysctl_ctx, SYSCTL_CHILDREN(cpu_sysctl_tree),
1025         OID_AUTO, "cx_lowest", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1026         NULL, 0, acpi_cpu_global_cx_lowest_sysctl, "A",
1027         "Global lowest Cx sleep state to use");
1028
1029     /* Take over idling from cpu_idle_default(). */
1030     cpu_cx_lowest_lim = 0;
1031     for (i = 0; i < cpu_ndevices; i++) {
1032         sc = device_get_softc(cpu_devices[i]);
1033         enable_idle(sc);
1034     }
1035 #if defined(__i386__) || defined(__amd64__)
1036     cpu_idle_hook = acpi_cpu_idle;
1037 #endif
1038 }
1039
1040 static void
1041 acpi_cpu_cx_list(struct acpi_cpu_softc *sc)
1042 {
1043     struct sbuf sb;
1044     int i;
1045
1046     /*
1047      * Set up the list of Cx states
1048      */
1049     sbuf_new(&sb, sc->cpu_cx_supported, sizeof(sc->cpu_cx_supported),
1050         SBUF_FIXEDLEN);
1051     for (i = 0; i < sc->cpu_cx_count; i++)
1052         sbuf_printf(&sb, "C%d/%d/%d ", i + 1, sc->cpu_cx_states[i].type,
1053             sc->cpu_cx_states[i].trans_lat);
1054     sbuf_trim(&sb);
1055     sbuf_finish(&sb);
1056 }       
1057
1058 static void
1059 acpi_cpu_startup_cx(struct acpi_cpu_softc *sc)
1060 {
1061     acpi_cpu_cx_list(sc);
1062     
1063     SYSCTL_ADD_STRING(&sc->cpu_sysctl_ctx,
1064                       SYSCTL_CHILDREN(device_get_sysctl_tree(sc->cpu_dev)),
1065                       OID_AUTO, "cx_supported", CTLFLAG_RD,
1066                       sc->cpu_cx_supported, 0,
1067                       "Cx/microsecond values for supported Cx states");
1068     SYSCTL_ADD_PROC(&sc->cpu_sysctl_ctx,
1069         SYSCTL_CHILDREN(device_get_sysctl_tree(sc->cpu_dev)), OID_AUTO,
1070         "cx_lowest", CTLTYPE_STRING | CTLFLAG_RW | CTLFLAG_NEEDGIANT,
1071         (void *)sc, 0, acpi_cpu_cx_lowest_sysctl, "A",
1072         "lowest Cx sleep state to use");
1073     SYSCTL_ADD_PROC(&sc->cpu_sysctl_ctx,
1074         SYSCTL_CHILDREN(device_get_sysctl_tree(sc->cpu_dev)), OID_AUTO,
1075         "cx_usage", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
1076         (void *)sc, 0, acpi_cpu_usage_sysctl, "A",
1077         "percent usage for each Cx state");
1078     SYSCTL_ADD_PROC(&sc->cpu_sysctl_ctx,
1079         SYSCTL_CHILDREN(device_get_sysctl_tree(sc->cpu_dev)), OID_AUTO,
1080         "cx_usage_counters", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
1081         (void *)sc, 0, acpi_cpu_usage_counters_sysctl, "A",
1082         "Cx sleep state counters");
1083 #if defined(__i386__) || defined(__amd64__)
1084     SYSCTL_ADD_PROC(&sc->cpu_sysctl_ctx,
1085         SYSCTL_CHILDREN(device_get_sysctl_tree(sc->cpu_dev)), OID_AUTO,
1086         "cx_method", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NEEDGIANT,
1087         (void *)sc, 0, acpi_cpu_method_sysctl, "A", "Cx entrance methods");
1088 #endif
1089
1090     /* Signal platform that we can handle _CST notification. */
1091     if (!cpu_cx_generic && cpu_cst_cnt != 0) {
1092         ACPI_LOCK(acpi);
1093         AcpiOsWritePort(cpu_smi_cmd, cpu_cst_cnt, 8);
1094         ACPI_UNLOCK(acpi);
1095     }
1096 }
1097
1098 #if defined(__i386__) || defined(__amd64__)
1099 /*
1100  * Idle the CPU in the lowest state possible.  This function is called with
1101  * interrupts disabled.  Note that once it re-enables interrupts, a task
1102  * switch can occur so do not access shared data (i.e. the softc) after
1103  * interrupts are re-enabled.
1104  */
1105 static void
1106 acpi_cpu_idle(sbintime_t sbt)
1107 {
1108     struct      acpi_cpu_softc *sc;
1109     struct      acpi_cx *cx_next;
1110     uint64_t    cputicks;
1111     uint32_t    start_time, end_time;
1112     ACPI_STATUS status;
1113     int         bm_active, cx_next_idx, i, us;
1114
1115     /*
1116      * Look up our CPU id to get our softc.  If it's NULL, we'll use C1
1117      * since there is no ACPI processor object for this CPU.  This occurs
1118      * for logical CPUs in the HTT case.
1119      */
1120     sc = cpu_softc[PCPU_GET(cpuid)];
1121     if (sc == NULL) {
1122         acpi_cpu_c1();
1123         return;
1124     }
1125
1126     /* If disabled, take the safe path. */
1127     if (is_idle_disabled(sc)) {
1128         acpi_cpu_c1();
1129         return;
1130     }
1131
1132     /* Find the lowest state that has small enough latency. */
1133     us = sc->cpu_prev_sleep;
1134     if (sbt >= 0 && us > (sbt >> 12))
1135         us = (sbt >> 12);
1136     cx_next_idx = 0;
1137     if (cpu_disable_c2_sleep)
1138         i = min(sc->cpu_cx_lowest, sc->cpu_non_c2);
1139     else if (cpu_disable_c3_sleep)
1140         i = min(sc->cpu_cx_lowest, sc->cpu_non_c3);
1141     else
1142         i = sc->cpu_cx_lowest;
1143     for (; i >= 0; i--) {
1144         if (sc->cpu_cx_states[i].trans_lat * 3 <= us) {
1145             cx_next_idx = i;
1146             break;
1147         }
1148     }
1149
1150     /*
1151      * Check for bus master activity.  If there was activity, clear
1152      * the bit and use the lowest non-C3 state.  Note that the USB
1153      * driver polling for new devices keeps this bit set all the
1154      * time if USB is loaded.
1155      */
1156     if ((cpu_quirks & CPU_QUIRK_NO_BM_CTRL) == 0 &&
1157         cx_next_idx > sc->cpu_non_c3) {
1158         status = AcpiReadBitRegister(ACPI_BITREG_BUS_MASTER_STATUS, &bm_active);
1159         if (ACPI_SUCCESS(status) && bm_active != 0) {
1160             AcpiWriteBitRegister(ACPI_BITREG_BUS_MASTER_STATUS, 1);
1161             cx_next_idx = sc->cpu_non_c3;
1162         }
1163     }
1164
1165     /* Select the next state and update statistics. */
1166     cx_next = &sc->cpu_cx_states[cx_next_idx];
1167     sc->cpu_cx_stats[cx_next_idx]++;
1168     KASSERT(cx_next->type != ACPI_STATE_C0, ("acpi_cpu_idle: C0 sleep"));
1169
1170     /*
1171      * Execute HLT (or equivalent) and wait for an interrupt.  We can't
1172      * precisely calculate the time spent in C1 since the place we wake up
1173      * is an ISR.  Assume we slept no more then half of quantum, unless
1174      * we are called inside critical section, delaying context switch.
1175      */
1176     if (cx_next->type == ACPI_STATE_C1) {
1177         cputicks = cpu_ticks();
1178         if (cx_next->p_lvlx != NULL) {
1179             /* C1 I/O then Halt */
1180             CPU_GET_REG(cx_next->p_lvlx, 1);
1181         }
1182         if (cx_next->do_mwait)
1183             acpi_cpu_idle_mwait(cx_next->mwait_hint);
1184         else
1185             acpi_cpu_c1();
1186         end_time = ((cpu_ticks() - cputicks) << 20) / cpu_tickrate();
1187         if (curthread->td_critnest == 0)
1188                 end_time = min(end_time, 500000 / hz);
1189         /* acpi_cpu_c1() returns with interrupts enabled. */
1190         if (cx_next->do_mwait)
1191             ACPI_ENABLE_IRQS();
1192         sc->cpu_prev_sleep = (sc->cpu_prev_sleep * 3 + end_time) / 4;
1193         return;
1194     }
1195
1196     /*
1197      * For C3, disable bus master arbitration and enable bus master wake
1198      * if BM control is available, otherwise flush the CPU cache.
1199      */
1200     if (cx_next->type == ACPI_STATE_C3 || cx_next->mwait_bm_avoidance) {
1201         if ((cpu_quirks & CPU_QUIRK_NO_BM_CTRL) == 0) {
1202             AcpiWriteBitRegister(ACPI_BITREG_ARB_DISABLE, 1);
1203             AcpiWriteBitRegister(ACPI_BITREG_BUS_MASTER_RLD, 1);
1204         } else
1205             ACPI_FLUSH_CPU_CACHE();
1206     }
1207
1208     /*
1209      * Read from P_LVLx to enter C2(+), checking time spent asleep.
1210      * Use the ACPI timer for measuring sleep time.  Since we need to
1211      * get the time very close to the CPU start/stop clock logic, this
1212      * is the only reliable time source.
1213      */
1214     if (cx_next->type == ACPI_STATE_C3) {
1215         AcpiGetTimer(&start_time);
1216         cputicks = 0;
1217     } else {
1218         start_time = 0;
1219         cputicks = cpu_ticks();
1220     }
1221     if (cx_next->do_mwait)
1222         acpi_cpu_idle_mwait(cx_next->mwait_hint);
1223     else
1224         CPU_GET_REG(cx_next->p_lvlx, 1);
1225
1226     /*
1227      * Read the end time twice.  Since it may take an arbitrary time
1228      * to enter the idle state, the first read may be executed before
1229      * the processor has stopped.  Doing it again provides enough
1230      * margin that we are certain to have a correct value.
1231      */
1232     AcpiGetTimer(&end_time);
1233     if (cx_next->type == ACPI_STATE_C3) {
1234         AcpiGetTimer(&end_time);
1235         AcpiGetTimerDuration(start_time, end_time, &end_time);
1236     } else
1237         end_time = ((cpu_ticks() - cputicks) << 20) / cpu_tickrate();
1238
1239     /* Enable bus master arbitration and disable bus master wakeup. */
1240     if ((cx_next->type == ACPI_STATE_C3 || cx_next->mwait_bm_avoidance) &&
1241       (cpu_quirks & CPU_QUIRK_NO_BM_CTRL) == 0) {
1242         AcpiWriteBitRegister(ACPI_BITREG_ARB_DISABLE, 0);
1243         AcpiWriteBitRegister(ACPI_BITREG_BUS_MASTER_RLD, 0);
1244     }
1245     ACPI_ENABLE_IRQS();
1246
1247     sc->cpu_prev_sleep = (sc->cpu_prev_sleep * 3 + PM_USEC(end_time)) / 4;
1248 }
1249 #endif
1250
1251 /*
1252  * Re-evaluate the _CST object when we are notified that it changed.
1253  */
1254 static void
1255 acpi_cpu_notify(ACPI_HANDLE h, UINT32 notify, void *context)
1256 {
1257     struct acpi_cpu_softc *sc = (struct acpi_cpu_softc *)context;
1258
1259     if (notify != ACPI_NOTIFY_CX_STATES)
1260         return;
1261
1262     /*
1263      * C-state data for target CPU is going to be in flux while we execute
1264      * acpi_cpu_cx_cst, so disable entering acpi_cpu_idle.
1265      * Also, it may happen that multiple ACPI taskqueues may concurrently
1266      * execute notifications for the same CPU.  ACPI_SERIAL is used to
1267      * protect against that.
1268      */
1269     ACPI_SERIAL_BEGIN(cpu);
1270     disable_idle(sc);
1271
1272     /* Update the list of Cx states. */
1273     acpi_cpu_cx_cst(sc);
1274     acpi_cpu_cx_list(sc);
1275     acpi_cpu_set_cx_lowest(sc);
1276
1277     enable_idle(sc);
1278     ACPI_SERIAL_END(cpu);
1279
1280     acpi_UserNotify("PROCESSOR", sc->cpu_handle, notify);
1281 }
1282
1283 static void
1284 acpi_cpu_quirks(void)
1285 {
1286     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1287
1288     /*
1289      * Bus mastering arbitration control is needed to keep caches coherent
1290      * while sleeping in C3.  If it's not present but a working flush cache
1291      * instruction is present, flush the caches before entering C3 instead.
1292      * Otherwise, just disable C3 completely.
1293      */
1294     if (AcpiGbl_FADT.Pm2ControlBlock == 0 ||
1295         AcpiGbl_FADT.Pm2ControlLength == 0) {
1296         if ((AcpiGbl_FADT.Flags & ACPI_FADT_WBINVD) &&
1297             (AcpiGbl_FADT.Flags & ACPI_FADT_WBINVD_FLUSH) == 0) {
1298             cpu_quirks |= CPU_QUIRK_NO_BM_CTRL;
1299             ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1300                 "acpi_cpu: no BM control, using flush cache method\n"));
1301         } else {
1302             cpu_quirks |= CPU_QUIRK_NO_C3;
1303             ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1304                 "acpi_cpu: no BM control, C3 not available\n"));
1305         }
1306     }
1307
1308     /*
1309      * If we are using generic Cx mode, C3 on multiple CPUs requires using
1310      * the expensive flush cache instruction.
1311      */
1312     if (cpu_cx_generic && mp_ncpus > 1) {
1313         cpu_quirks |= CPU_QUIRK_NO_BM_CTRL;
1314         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1315             "acpi_cpu: SMP, using flush cache mode for C3\n"));
1316     }
1317
1318     /* Look for various quirks of the PIIX4 part. */
1319     acpi_cpu_quirks_piix4();
1320 }
1321
1322 static void
1323 acpi_cpu_quirks_piix4(void)
1324 {
1325 #ifdef __i386__
1326     device_t acpi_dev;
1327     uint32_t val;
1328     ACPI_STATUS status;
1329
1330     acpi_dev = pci_find_device(PCI_VENDOR_INTEL, PCI_DEVICE_82371AB_3);
1331     if (acpi_dev != NULL) {
1332         switch (pci_get_revid(acpi_dev)) {
1333         /*
1334          * Disable C3 support for all PIIX4 chipsets.  Some of these parts
1335          * do not report the BMIDE status to the BM status register and
1336          * others have a livelock bug if Type-F DMA is enabled.  Linux
1337          * works around the BMIDE bug by reading the BM status directly
1338          * but we take the simpler approach of disabling C3 for these
1339          * parts.
1340          *
1341          * See erratum #18 ("C3 Power State/BMIDE and Type-F DMA
1342          * Livelock") from the January 2002 PIIX4 specification update.
1343          * Applies to all PIIX4 models.
1344          *
1345          * Also, make sure that all interrupts cause a "Stop Break"
1346          * event to exit from C2 state.
1347          * Also, BRLD_EN_BM (ACPI_BITREG_BUS_MASTER_RLD in ACPI-speak)
1348          * should be set to zero, otherwise it causes C2 to short-sleep.
1349          * PIIX4 doesn't properly support C3 and bus master activity
1350          * need not break out of C2.
1351          */
1352         case PCI_REVISION_A_STEP:
1353         case PCI_REVISION_B_STEP:
1354         case PCI_REVISION_4E:
1355         case PCI_REVISION_4M:
1356             cpu_quirks |= CPU_QUIRK_NO_C3;
1357             ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1358                 "acpi_cpu: working around PIIX4 bug, disabling C3\n"));
1359
1360             val = pci_read_config(acpi_dev, PIIX4_DEVACTB_REG, 4);
1361             if ((val & PIIX4_STOP_BREAK_MASK) != PIIX4_STOP_BREAK_MASK) {
1362                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1363                     "acpi_cpu: PIIX4: enabling IRQs to generate Stop Break\n"));
1364                 val |= PIIX4_STOP_BREAK_MASK;
1365                 pci_write_config(acpi_dev, PIIX4_DEVACTB_REG, val, 4);
1366             }
1367             status = AcpiReadBitRegister(ACPI_BITREG_BUS_MASTER_RLD, &val);
1368             if (ACPI_SUCCESS(status) && val != 0) {
1369                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
1370                     "acpi_cpu: PIIX4: reset BRLD_EN_BM\n"));
1371                 AcpiWriteBitRegister(ACPI_BITREG_BUS_MASTER_RLD, 0);
1372             }
1373             break;
1374         default:
1375             break;
1376         }
1377     }
1378 #endif
1379 }
1380
1381 static int
1382 acpi_cpu_usage_sysctl(SYSCTL_HANDLER_ARGS)
1383 {
1384     struct acpi_cpu_softc *sc;
1385     struct sbuf  sb;
1386     char         buf[128];
1387     int          i;
1388     uintmax_t    fract, sum, whole;
1389
1390     sc = (struct acpi_cpu_softc *) arg1;
1391     sum = 0;
1392     for (i = 0; i < sc->cpu_cx_count; i++)
1393         sum += sc->cpu_cx_stats[i];
1394     sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
1395     for (i = 0; i < sc->cpu_cx_count; i++) {
1396         if (sum > 0) {
1397             whole = (uintmax_t)sc->cpu_cx_stats[i] * 100;
1398             fract = (whole % sum) * 100;
1399             sbuf_printf(&sb, "%u.%02u%% ", (u_int)(whole / sum),
1400                 (u_int)(fract / sum));
1401         } else
1402             sbuf_printf(&sb, "0.00%% ");
1403     }
1404     sbuf_printf(&sb, "last %dus", sc->cpu_prev_sleep);
1405     sbuf_trim(&sb);
1406     sbuf_finish(&sb);
1407     sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1408     sbuf_delete(&sb);
1409
1410     return (0);
1411 }
1412
1413 /*
1414  * XXX TODO: actually add support to count each entry/exit
1415  * from the Cx states.
1416  */
1417 static int
1418 acpi_cpu_usage_counters_sysctl(SYSCTL_HANDLER_ARGS)
1419 {
1420     struct acpi_cpu_softc *sc;
1421     struct sbuf  sb;
1422     char         buf[128];
1423     int          i;
1424
1425     sc = (struct acpi_cpu_softc *) arg1;
1426
1427     /* Print out the raw counters */
1428     sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
1429
1430     for (i = 0; i < sc->cpu_cx_count; i++) {
1431         sbuf_printf(&sb, "%u ", sc->cpu_cx_stats[i]);
1432     }
1433
1434     sbuf_trim(&sb);
1435     sbuf_finish(&sb);
1436     sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1437     sbuf_delete(&sb);
1438
1439     return (0);
1440 }
1441
1442 #if defined(__i386__) || defined(__amd64__)
1443 static int
1444 acpi_cpu_method_sysctl(SYSCTL_HANDLER_ARGS)
1445 {
1446         struct acpi_cpu_softc *sc;
1447         struct acpi_cx *cx;
1448         struct sbuf sb;
1449         char buf[128];
1450         int i;
1451
1452         sc = (struct acpi_cpu_softc *)arg1;
1453         sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
1454         for (i = 0; i < sc->cpu_cx_count; i++) {
1455                 cx = &sc->cpu_cx_states[i];
1456                 sbuf_printf(&sb, "C%d/", i + 1);
1457                 if (cx->do_mwait) {
1458                         sbuf_cat(&sb, "mwait");
1459                         if (cx->mwait_hw_coord)
1460                                 sbuf_cat(&sb, "/hwc");
1461                         if (cx->mwait_bm_avoidance)
1462                                 sbuf_cat(&sb, "/bma");
1463                 } else if (cx->type == ACPI_STATE_C1) {
1464                         sbuf_cat(&sb, "hlt");
1465                 } else {
1466                         sbuf_cat(&sb, "io");
1467                 }
1468                 if (cx->type == ACPI_STATE_C1 && cx->p_lvlx != NULL)
1469                         sbuf_cat(&sb, "/iohlt");
1470                 sbuf_putc(&sb, ' ');
1471         }
1472         sbuf_trim(&sb);
1473         sbuf_finish(&sb);
1474         sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
1475         sbuf_delete(&sb);
1476         return (0);
1477 }
1478 #endif
1479
1480 static int
1481 acpi_cpu_set_cx_lowest(struct acpi_cpu_softc *sc)
1482 {
1483     int i;
1484
1485     ACPI_SERIAL_ASSERT(cpu);
1486     sc->cpu_cx_lowest = min(sc->cpu_cx_lowest_lim, sc->cpu_cx_count - 1);
1487
1488     /* If not disabling, cache the new lowest non-C3 state. */
1489     sc->cpu_non_c3 = 0;
1490     for (i = sc->cpu_cx_lowest; i >= 0; i--) {
1491         if (sc->cpu_cx_states[i].type < ACPI_STATE_C3) {
1492             sc->cpu_non_c3 = i;
1493             break;
1494         }
1495     }
1496
1497     /* Reset the statistics counters. */
1498     bzero(sc->cpu_cx_stats, sizeof(sc->cpu_cx_stats));
1499     return (0);
1500 }
1501
1502 static int
1503 acpi_cpu_cx_lowest_sysctl(SYSCTL_HANDLER_ARGS)
1504 {
1505     struct       acpi_cpu_softc *sc;
1506     char         state[8];
1507     int          val, error;
1508
1509     sc = (struct acpi_cpu_softc *) arg1;
1510     snprintf(state, sizeof(state), "C%d", sc->cpu_cx_lowest_lim + 1);
1511     error = sysctl_handle_string(oidp, state, sizeof(state), req);
1512     if (error != 0 || req->newptr == NULL)
1513         return (error);
1514     if (strlen(state) < 2 || toupper(state[0]) != 'C')
1515         return (EINVAL);
1516     if (strcasecmp(state, "Cmax") == 0)
1517         val = MAX_CX_STATES;
1518     else {
1519         val = (int) strtol(state + 1, NULL, 10);
1520         if (val < 1 || val > MAX_CX_STATES)
1521             return (EINVAL);
1522     }
1523
1524     ACPI_SERIAL_BEGIN(cpu);
1525     sc->cpu_cx_lowest_lim = val - 1;
1526     acpi_cpu_set_cx_lowest(sc);
1527     ACPI_SERIAL_END(cpu);
1528
1529     return (0);
1530 }
1531
1532 static int
1533 acpi_cpu_global_cx_lowest_sysctl(SYSCTL_HANDLER_ARGS)
1534 {
1535     struct      acpi_cpu_softc *sc;
1536     char        state[8];
1537     int         val, error, i;
1538
1539     snprintf(state, sizeof(state), "C%d", cpu_cx_lowest_lim + 1);
1540     error = sysctl_handle_string(oidp, state, sizeof(state), req);
1541     if (error != 0 || req->newptr == NULL)
1542         return (error);
1543     if (strlen(state) < 2 || toupper(state[0]) != 'C')
1544         return (EINVAL);
1545     if (strcasecmp(state, "Cmax") == 0)
1546         val = MAX_CX_STATES;
1547     else {
1548         val = (int) strtol(state + 1, NULL, 10);
1549         if (val < 1 || val > MAX_CX_STATES)
1550             return (EINVAL);
1551     }
1552
1553     /* Update the new lowest useable Cx state for all CPUs. */
1554     ACPI_SERIAL_BEGIN(cpu);
1555     cpu_cx_lowest_lim = val - 1;
1556     for (i = 0; i < cpu_ndevices; i++) {
1557         sc = device_get_softc(cpu_devices[i]);
1558         sc->cpu_cx_lowest_lim = cpu_cx_lowest_lim;
1559         acpi_cpu_set_cx_lowest(sc);
1560     }
1561     ACPI_SERIAL_END(cpu);
1562
1563     return (0);
1564 }