1 /*- 2 * Copyright (c) 2004-2005 Nate Lawson (SDG) 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #include <sys/cdefs.h> 28 __FBSDID("$FreeBSD$"); 29 30 #include <sys/param.h> 31 #include <sys/bus.h> 32 #include <sys/cpu.h> 33 #include <sys/kernel.h> 34 #include <sys/malloc.h> 35 #include <sys/module.h> 36 #include <sys/pcpu.h> 37 #include <sys/sysctl.h> 38 #include <sys/systm.h> 39 40 #include <dev/pci/pcivar.h> 41 #include <machine/bus.h> 42 #include <machine/clock.h> 43 #include <machine/resource.h> 44 #include <sys/rman.h> 45 46 #include "cpufreq_if.h" 47 48 /* 49 * The SpeedStep ICH feature is a chipset-initiated voltage and frequency 50 * transition available on the ICH2M, 3M, and 4M. It is different from 51 * the newer Pentium-M SpeedStep feature. It offers only two levels of 52 * frequency/voltage. Often, the BIOS will select one of the levels via 53 * SMM code during the power-on process (i.e., choose a lower level if the 54 * system is off AC power.) 55 */ 56 57 struct ichss_softc { 58 device_t dev; 59 int bm_rid; /* Bus-mastering control (PM2REG). */ 60 struct resource *bm_reg; 61 int ctrl_rid; /* Control/status register. */ 62 struct resource *ctrl_reg; 63 struct cf_setting sets[2]; /* Only two settings. */ 64 }; 65 66 /* Supported PCI IDs. */ 67 #define PCI_VENDOR_INTEL 0x8086 68 #define PCI_DEV_82801BA 0x244c /* ICH2M */ 69 #define PCI_DEV_82801CA 0x248c /* ICH3M */ 70 #define PCI_DEV_82801DB 0x24cc /* ICH4M */ 71 #define PCI_DEV_82815BA 0x1130 /* Unsupported/buggy part */ 72 73 /* PCI config registers for finding PMBASE and enabling SpeedStep. */ 74 #define ICHSS_PMBASE_OFFSET 0x40 75 #define ICHSS_PMCFG_OFFSET 0xa0 76 77 /* Values and masks. */ 78 #define ICHSS_ENABLE (1<<3) /* Enable SpeedStep control. */ 79 #define ICHSS_IO_REG 0x1 /* Access register via I/O space. */ 80 #define ICHSS_PMBASE_MASK 0xff80 /* PMBASE address bits. */ 81 #define ICHSS_CTRL_BIT 0x1 /* 0 is high speed, 1 is low. */ 82 #define ICHSS_BM_DISABLE 0x1 83 84 /* Offsets from PMBASE for various registers. */ 85 #define ICHSS_BM_OFFSET 0x20 86 #define ICHSS_CTRL_OFFSET 0x50 87 88 #define ICH_GET_REG(reg) \ 89 (bus_space_read_1(rman_get_bustag((reg)), \ 90 rman_get_bushandle((reg)), 0)) 91 #define ICH_SET_REG(reg, val) \ 92 (bus_space_write_1(rman_get_bustag((reg)), \ 93 rman_get_bushandle((reg)), 0, (val))) 94 95 static int ichss_pci_probe(device_t dev); 96 static int ichss_probe(device_t dev); 97 static int ichss_attach(device_t dev); 98 static int ichss_detach(device_t dev); 99 static int ichss_settings(device_t dev, struct cf_setting *sets, 100 int *count, int *type); 101 static int ichss_set(device_t dev, const struct cf_setting *set); 102 static int ichss_get(device_t dev, struct cf_setting *set); 103 104 static device_method_t ichss_methods[] = { 105 /* Device interface */ 106 DEVMETHOD(device_probe, ichss_probe), 107 DEVMETHOD(device_attach, ichss_attach), 108 DEVMETHOD(device_detach, ichss_detach), 109 110 /* cpufreq interface */ 111 DEVMETHOD(cpufreq_drv_set, ichss_set), 112 DEVMETHOD(cpufreq_drv_get, ichss_get), 113 DEVMETHOD(cpufreq_drv_settings, ichss_settings), 114 {0, 0} 115 }; 116 static driver_t ichss_driver = { 117 "ichss", ichss_methods, sizeof(struct ichss_softc) 118 }; 119 static devclass_t ichss_devclass; 120 DRIVER_MODULE(ichss, cpu, ichss_driver, ichss_devclass, 0, 0); 121 122 static device_method_t ichss_pci_methods[] = { 123 DEVMETHOD(device_probe, ichss_pci_probe), 124 {0, 0} 125 }; 126 static driver_t ichss_pci_driver = { 127 "ichss_pci", ichss_pci_methods, 0 128 }; 129 static devclass_t ichss_pci_devclass; 130 DRIVER_MODULE(ichss_pci, pci, ichss_pci_driver, ichss_pci_devclass, 0, 0); 131 132 #if 0 133 #define DPRINT(x...) printf(x) 134 #else 135 #define DPRINT(x...) 136 #endif 137 138 /* 139 * We detect the chipset by looking for its LPC bus ID during the PCI 140 * scan and reading its config registers during the probe. However, 141 * we add the ichss child under the cpu device since even though the 142 * chipset provides the control, it really affects the cpu only. 143 * 144 * XXX This approach does not work if the module is loaded after boot. 145 */ 146 static int 147 ichss_pci_probe(device_t dev) 148 { 149 device_t child, parent; 150 uint32_t pmbase; 151 uint16_t ss_en; 152 153 /* 154 * TODO: add a quirk to disable if we see the 82815_MC along 155 * with the 82801BA and revision < 5. 156 */ 157 if (pci_get_vendor(dev) != PCI_VENDOR_INTEL || 158 (pci_get_device(dev) != PCI_DEV_82801BA && 159 pci_get_device(dev) != PCI_DEV_82801CA && 160 pci_get_device(dev) != PCI_DEV_82801DB)) 161 return (ENXIO); 162 163 /* Only one CPU is supported for this hardware. */ 164 if (devclass_get_device(ichss_devclass, 0)) 165 return (ENXIO); 166 167 /* Add a child under the CPU parent. */ 168 parent = devclass_get_device(devclass_find("cpu"), 0); 169 KASSERT(parent != NULL, ("cpu parent is NULL")); 170 child = BUS_ADD_CHILD(parent, 0, "ichss", 0); 171 if (child == NULL) { 172 device_printf(parent, "add SpeedStep child failed\n"); 173 return (ENXIO); 174 } 175 176 /* Find the PMBASE register from our PCI config header. */ 177 pmbase = pci_read_config(dev, ICHSS_PMBASE_OFFSET, sizeof(pmbase)); 178 if ((pmbase & ICHSS_IO_REG) == 0) { 179 printf("ichss: invalid PMBASE memory type\n"); 180 return (ENXIO); 181 } 182 pmbase &= ICHSS_PMBASE_MASK; 183 if (pmbase == 0) { 184 printf("ichss: invalid zero PMBASE address\n"); 185 return (ENXIO); 186 } 187 DPRINT("ichss: PMBASE is %#x\n", pmbase); 188 189 /* Add the bus master arbitration and control registers. */ 190 bus_set_resource(child, SYS_RES_IOPORT, 0, pmbase + ICHSS_BM_OFFSET, 191 1); 192 bus_set_resource(child, SYS_RES_IOPORT, 1, pmbase + ICHSS_CTRL_OFFSET, 193 1); 194 195 /* Activate SpeedStep control if not already enabled. */ 196 ss_en = pci_read_config(dev, ICHSS_PMCFG_OFFSET, sizeof(ss_en)); 197 if ((ss_en & ICHSS_ENABLE) == 0) { 198 printf("ichss: enabling SpeedStep support\n"); 199 pci_write_config(dev, ICHSS_PMCFG_OFFSET, 200 ss_en | ICHSS_ENABLE, sizeof(ss_en)); 201 } 202 203 /* Attach the new CPU child now. */ 204 device_probe_and_attach(child); 205 206 return (ENXIO); 207 } 208 209 static int 210 ichss_probe(device_t dev) 211 { 212 struct cf_setting set; 213 device_t perf_dev; 214 int count, type; 215 216 /* 217 * If the ACPI perf driver has attached and is not just offering 218 * info, let it manage things. 219 */ 220 perf_dev = device_find_child(device_get_parent(dev), "acpi_perf", -1); 221 if (perf_dev && device_is_attached(perf_dev)) { 222 type = 0; 223 count = 1; 224 CPUFREQ_DRV_SETTINGS(perf_dev, &set, &count, &type); 225 if ((type & CPUFREQ_FLAG_INFO_ONLY) == 0) 226 return (ENXIO); 227 } 228 229 device_set_desc(dev, "SpeedStep ICH"); 230 return (-1000); 231 } 232 233 static int 234 ichss_attach(device_t dev) 235 { 236 struct ichss_softc *sc; 237 238 sc = device_get_softc(dev); 239 sc->dev = dev; 240 241 sc->bm_rid = 0; 242 sc->bm_reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &sc->bm_rid, 243 RF_ACTIVE); 244 if (sc->bm_reg == NULL) { 245 device_printf(dev, "failed to alloc BM arb register\n"); 246 return (ENXIO); 247 } 248 sc->ctrl_rid = 1; 249 sc->ctrl_reg = bus_alloc_resource_any(dev, SYS_RES_IOPORT, 250 &sc->ctrl_rid, RF_ACTIVE); 251 if (sc->ctrl_reg == NULL) { 252 device_printf(dev, "failed to alloc control register\n"); 253 bus_release_resource(dev, SYS_RES_IOPORT, sc->bm_rid, 254 sc->bm_reg); 255 return (ENXIO); 256 } 257 258 /* Setup some defaults for our exported settings. */ 259 sc->sets[0].freq = CPUFREQ_VAL_UNKNOWN; 260 sc->sets[0].volts = CPUFREQ_VAL_UNKNOWN; 261 sc->sets[0].power = CPUFREQ_VAL_UNKNOWN; 262 sc->sets[0].lat = 1000; 263 sc->sets[0].dev = dev; 264 sc->sets[1] = sc->sets[0]; 265 cpufreq_register(dev); 266 267 return (0); 268 } 269 270 static int 271 ichss_detach(device_t dev) 272 { 273 /* TODO: teardown BM and CTRL registers. */ 274 return (ENXIO); 275 } 276 277 static int 278 ichss_settings(device_t dev, struct cf_setting *sets, int *count, int *type) 279 { 280 struct ichss_softc *sc; 281 struct cf_setting set; 282 int first, i; 283 284 if (sets == NULL || count == NULL) 285 return (EINVAL); 286 if (*count < 2) { 287 *count = 2; 288 return (E2BIG); 289 } 290 sc = device_get_softc(dev); 291 292 /* 293 * Estimate frequencies for both levels, temporarily switching to 294 * the other one if we haven't calibrated it yet. 295 */ 296 ichss_get(dev, &set); 297 for (i = 0; i < 2; i++) { 298 if (sc->sets[i].freq == CPUFREQ_VAL_UNKNOWN) { 299 first = (i == 0) ? 1 : 0; 300 ichss_set(dev, &sc->sets[i]); 301 ichss_set(dev, &sc->sets[first]); 302 } 303 } 304 305 bcopy(sc->sets, sets, sizeof(sc->sets)); 306 *count = 2; 307 *type = CPUFREQ_TYPE_ABSOLUTE; 308 309 return (0); 310 } 311 312 static int 313 ichss_set(device_t dev, const struct cf_setting *set) 314 { 315 struct ichss_softc *sc; 316 uint8_t bmval, new_val, old_val, req_val; 317 uint64_t rate; 318 register_t regs; 319 320 /* Look up appropriate bit value based on frequency. */ 321 sc = device_get_softc(dev); 322 if (CPUFREQ_CMP(set->freq, sc->sets[0].freq)) 323 req_val = 0; 324 else if (CPUFREQ_CMP(set->freq, sc->sets[1].freq)) 325 req_val = ICHSS_CTRL_BIT; 326 else 327 return (EINVAL); 328 DPRINT("ichss: requested setting %d\n", req_val); 329 330 /* Disable interrupts and get the other register contents. */ 331 regs = intr_disable(); 332 old_val = ICH_GET_REG(sc->ctrl_reg) & ~ICHSS_CTRL_BIT; 333 334 /* 335 * Disable bus master arbitration, write the new value to the control 336 * register, and then re-enable bus master arbitration. 337 */ 338 bmval = ICH_GET_REG(sc->bm_reg) | ICHSS_BM_DISABLE; 339 ICH_SET_REG(sc->bm_reg, bmval); 340 ICH_SET_REG(sc->ctrl_reg, old_val | req_val); 341 ICH_SET_REG(sc->bm_reg, bmval & ~ICHSS_BM_DISABLE); 342 343 /* Get the new value and re-enable interrupts. */ 344 new_val = ICH_GET_REG(sc->ctrl_reg); 345 intr_restore(regs); 346 347 /* Check if the desired state was indeed selected. */ 348 if (req_val != (new_val & ICHSS_CTRL_BIT)) { 349 device_printf(sc->dev, "transition to %d failed\n", req_val); 350 return (ENXIO); 351 } 352 353 /* Re-initialize our cycle counter if we don't know this new state. */ 354 if (sc->sets[req_val].freq == CPUFREQ_VAL_UNKNOWN) { 355 cpu_est_clockrate(0, &rate); 356 sc->sets[req_val].freq = rate / 1000000; 357 DPRINT("ichss: set calibrated new rate of %d\n", 358 sc->sets[req_val].freq); 359 } 360 361 return (0); 362 } 363 364 static int 365 ichss_get(device_t dev, struct cf_setting *set) 366 { 367 struct ichss_softc *sc; 368 uint64_t rate; 369 uint8_t state; 370 371 sc = device_get_softc(dev); 372 state = ICH_GET_REG(sc->ctrl_reg) & ICHSS_CTRL_BIT; 373 374 /* If we haven't changed settings yet, estimate the current value. */ 375 if (sc->sets[state].freq == CPUFREQ_VAL_UNKNOWN) { 376 cpu_est_clockrate(0, &rate); 377 sc->sets[state].freq = rate / 1000000; 378 DPRINT("ichss: get calibrated new rate of %d\n", 379 sc->sets[state].freq); 380 } 381 *set = sc->sets[state]; 382 383 return (0); 384 } 385