1 /*- 2 * Copyright (c) 2005 Poul-Henning Kamp 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 "opt_acpi.h" 31 #include <sys/param.h> 32 #include <sys/bus.h> 33 #include <sys/kernel.h> 34 #include <sys/module.h> 35 #include <sys/rman.h> 36 #include <sys/time.h> 37 #include <sys/timetc.h> 38 39 #include <contrib/dev/acpica/acpi.h> 40 #include <dev/acpica/acpivar.h> 41 42 ACPI_SERIAL_DECL(hpet, "ACPI HPET support"); 43 44 static devclass_t acpi_hpet_devclass; 45 46 /* ACPI CA debugging */ 47 #define _COMPONENT ACPI_TIMER 48 ACPI_MODULE_NAME("HPET") 49 50 struct acpi_hpet_softc { 51 device_t dev; 52 struct resource *mem_res; 53 ACPI_HANDLE handle; 54 }; 55 56 static u_int hpet_get_timecount(struct timecounter *tc); 57 static void acpi_hpet_test(struct acpi_hpet_softc *sc); 58 59 static char *hpet_ids[] = { "PNP0103", NULL }; 60 61 #define HPET_MEM_WIDTH 0x400 /* Expected memory region size */ 62 #define HPET_OFFSET_INFO 0 /* Location of info in region */ 63 #define HPET_OFFSET_PERIOD 4 /* Location of period (1/hz) */ 64 #define HPET_OFFSET_ENABLE 0x10 /* Location of enable word */ 65 #define HPET_OFFSET_VALUE 0xf0 /* Location of actual timer value */ 66 67 #define DEV_HPET(x) (acpi_get_magic(x) == (uintptr_t)&acpi_hpet_devclass) 68 69 struct timecounter hpet_timecounter = { 70 .tc_get_timecount = hpet_get_timecount, 71 .tc_counter_mask = ~0u, 72 .tc_name = "HPET", 73 .tc_quality = 900, 74 }; 75 76 static u_int 77 hpet_get_timecount(struct timecounter *tc) 78 { 79 struct acpi_hpet_softc *sc; 80 81 sc = tc->tc_priv; 82 return (bus_read_4(sc->mem_res, HPET_OFFSET_VALUE)); 83 } 84 85 /* Discover the HPET via the ACPI table of the same name. */ 86 static void 87 acpi_hpet_identify(driver_t *driver, device_t parent) 88 { 89 ACPI_TABLE_HPET *hpet; 90 ACPI_TABLE_HEADER *hdr; 91 ACPI_STATUS status; 92 device_t child; 93 94 /* Only one HPET device can be added. */ 95 if (devclass_get_device(acpi_hpet_devclass, 0)) 96 return; 97 98 /* Currently, ID and minimum clock tick info is unused. */ 99 100 status = AcpiGetTable(ACPI_SIG_HPET, 1, (ACPI_TABLE_HEADER **)&hdr); 101 if (ACPI_FAILURE(status)) 102 return; 103 104 /* 105 * The unit number could be derived from hdr->Sequence but we only 106 * support one HPET device. 107 */ 108 hpet = (ACPI_TABLE_HPET *)hdr; 109 if (hpet->Sequence != 0) 110 printf("ACPI HPET table warning: Sequence is non-zero (%d)\n", 111 hpet->Sequence); 112 child = BUS_ADD_CHILD(parent, ACPI_DEV_BASE_ORDER, "acpi_hpet", 0); 113 if (child == NULL) { 114 printf("%s: can't add child\n", __func__); 115 return; 116 } 117 118 /* Record a magic value so we can detect this device later. */ 119 acpi_set_magic(child, (uintptr_t)&acpi_hpet_devclass); 120 bus_set_resource(child, SYS_RES_MEMORY, 0, hpet->Address.Address, 121 HPET_MEM_WIDTH); 122 } 123 124 static int 125 acpi_hpet_probe(device_t dev) 126 { 127 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__); 128 129 if (acpi_disabled("hpet")) 130 return (ENXIO); 131 if (!DEV_HPET(dev) && 132 (ACPI_ID_PROBE(device_get_parent(dev), dev, hpet_ids) == NULL || 133 device_get_unit(dev) != 0)) 134 return (ENXIO); 135 136 device_set_desc(dev, "High Precision Event Timer"); 137 return (0); 138 } 139 140 static int 141 acpi_hpet_attach(device_t dev) 142 { 143 struct acpi_hpet_softc *sc; 144 int rid; 145 uint32_t val, val2; 146 uintmax_t freq; 147 148 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__); 149 150 sc = device_get_softc(dev); 151 sc->dev = dev; 152 sc->handle = acpi_get_handle(dev); 153 154 rid = 0; 155 sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 156 RF_ACTIVE); 157 if (sc->mem_res == NULL) 158 return (ENOMEM); 159 160 /* Validate that we can access the whole region. */ 161 if (rman_get_size(sc->mem_res) < HPET_MEM_WIDTH) { 162 device_printf(dev, "memory region width %ld too small\n", 163 rman_get_size(sc->mem_res)); 164 bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res); 165 return (ENXIO); 166 } 167 168 /* Be sure timer is enabled. */ 169 bus_write_4(sc->mem_res, HPET_OFFSET_ENABLE, 1); 170 171 /* Read basic statistics about the timer. */ 172 val = bus_read_4(sc->mem_res, HPET_OFFSET_PERIOD); 173 freq = (1000000000000000LL + val / 2) / val; 174 if (bootverbose) { 175 val = bus_read_4(sc->mem_res, HPET_OFFSET_INFO); 176 device_printf(dev, 177 "vend: 0x%x rev: 0x%x num: %d hz: %jd opts:%s%s\n", 178 val >> 16, val & 0xff, (val >> 18) & 0xf, freq, 179 ((val >> 15) & 1) ? " leg_route" : "", 180 ((val >> 13) & 1) ? " count_size" : ""); 181 } 182 183 if (testenv("debug.acpi.hpet_test")) 184 acpi_hpet_test(sc); 185 186 /* 187 * Don't attach if the timer never increments. Since the spec 188 * requires it to be at least 10 MHz, it has to change in 1 us. 189 */ 190 val = bus_read_4(sc->mem_res, HPET_OFFSET_VALUE); 191 DELAY(1); 192 val2 = bus_read_4(sc->mem_res, HPET_OFFSET_VALUE); 193 if (val == val2) { 194 device_printf(dev, "HPET never increments, disabling\n"); 195 bus_write_4(sc->mem_res, HPET_OFFSET_ENABLE, 0); 196 bus_free_resource(dev, SYS_RES_MEMORY, sc->mem_res); 197 return (ENXIO); 198 } 199 200 hpet_timecounter.tc_frequency = freq; 201 hpet_timecounter.tc_priv = sc; 202 tc_init(&hpet_timecounter); 203 204 return (0); 205 } 206 207 static int 208 acpi_hpet_detach(device_t dev) 209 { 210 ACPI_FUNCTION_TRACE((char *)(uintptr_t) __func__); 211 212 /* XXX Without a tc_remove() function, we can't detach. */ 213 return (EBUSY); 214 } 215 216 static int 217 acpi_hpet_resume(device_t dev) 218 { 219 struct acpi_hpet_softc *sc; 220 221 /* Re-enable the timer after a resume to keep the clock advancing. */ 222 sc = device_get_softc(dev); 223 bus_write_4(sc->mem_res, HPET_OFFSET_ENABLE, 1); 224 225 return (0); 226 } 227 228 /* Print some basic latency/rate information to assist in debugging. */ 229 static void 230 acpi_hpet_test(struct acpi_hpet_softc *sc) 231 { 232 int i; 233 uint32_t u1, u2; 234 struct bintime b0, b1, b2; 235 struct timespec ts; 236 237 binuptime(&b0); 238 binuptime(&b0); 239 binuptime(&b1); 240 u1 = bus_read_4(sc->mem_res, HPET_OFFSET_VALUE); 241 for (i = 1; i < 1000; i++) 242 u2 = bus_read_4(sc->mem_res, HPET_OFFSET_VALUE); 243 binuptime(&b2); 244 u2 = bus_read_4(sc->mem_res, HPET_OFFSET_VALUE); 245 246 bintime_sub(&b2, &b1); 247 bintime_sub(&b1, &b0); 248 bintime_sub(&b2, &b1); 249 bintime2timespec(&b2, &ts); 250 251 device_printf(sc->dev, "%ld.%09ld: %u ... %u = %u\n", 252 (long)ts.tv_sec, ts.tv_nsec, u1, u2, u2 - u1); 253 254 device_printf(sc->dev, "time per call: %ld ns\n", ts.tv_nsec / 1000); 255 } 256 257 static device_method_t acpi_hpet_methods[] = { 258 /* Device interface */ 259 DEVMETHOD(device_identify, acpi_hpet_identify), 260 DEVMETHOD(device_probe, acpi_hpet_probe), 261 DEVMETHOD(device_attach, acpi_hpet_attach), 262 DEVMETHOD(device_detach, acpi_hpet_detach), 263 DEVMETHOD(device_resume, acpi_hpet_resume), 264 265 {0, 0} 266 }; 267 268 static driver_t acpi_hpet_driver = { 269 "acpi_hpet", 270 acpi_hpet_methods, 271 sizeof(struct acpi_hpet_softc), 272 }; 273 274 275 DRIVER_MODULE(acpi_hpet, acpi, acpi_hpet_driver, acpi_hpet_devclass, 0, 0); 276 MODULE_DEPEND(acpi_hpet, acpi, 1, 1, 1); 277