xref: /freebsd/sys/dev/ipmi/ipmi_acpi.c (revision 2f02600abfddfc4e9f20dd384a2e729b451e16bd)
1 /*-
2  * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
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/systm.h>
32 #include <sys/bus.h>
33 #include <sys/condvar.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/rman.h>
37 #include <sys/selinfo.h>
38 
39 #include <contrib/dev/acpica/include/acpi.h>
40 
41 #include <dev/acpica/acpivar.h>
42 
43 /* Hooks for the ACPI CA debugging infrastructure */
44 #define _COMPONENT	ACPI_BUTTON
45 ACPI_MODULE_NAME("IPMI")
46 
47 #ifdef LOCAL_MODULE
48 #include <ipmi.h>
49 #include <ipmivars.h>
50 #else
51 #include <sys/ipmi.h>
52 #include <dev/ipmi/ipmivars.h>
53 #endif
54 
55 static int ipmi_acpi_probe(device_t);
56 static int ipmi_acpi_attach(device_t);
57 
58 int
59 ipmi_acpi_probe(device_t dev)
60 {
61 	static char *ipmi_ids[] = {"IPI0001", NULL};
62 
63 	if (ipmi_attached)
64 		return (EBUSY);
65 
66 	if (acpi_disabled("ipmi") ||
67 	    ACPI_ID_PROBE(device_get_parent(dev), dev, ipmi_ids) == NULL)
68 		return (ENXIO);
69 
70 	device_set_desc(dev, "IPMI System Interface");
71 
72 	return (0);
73 }
74 
75 static int
76 ipmi_acpi_attach(device_t dev)
77 {
78 	ACPI_HANDLE devh;
79 	const char *mode;
80 	struct ipmi_get_info info;
81 	struct ipmi_softc *sc = device_get_softc(dev);
82 	int count, error, flags, i, type;
83 	int interface_type = 0, interface_version = 0;
84 
85 	error = 0;
86 	devh = acpi_get_handle(dev);
87 	if (ACPI_FAILURE(acpi_GetInteger(devh, "_IFT", &interface_type)))
88 		return (ENXIO);
89 
90 	if (ACPI_FAILURE(acpi_GetInteger(devh, "_SRV", &interface_version)))
91 		return (ENXIO);
92 
93 	switch (interface_type) {
94 	case KCS_MODE:
95 		count = 2;
96 		mode = "KCS";
97 		break;
98 	case SMIC_MODE:
99 		count = 3;
100 		mode = "SMIC";
101 		break;
102 	case BT_MODE:
103 		device_printf(dev, "BT interface not supported\n");
104 		return (ENXIO);
105 	case SSIF_MODE:
106 		if (ACPI_FAILURE(acpi_GetInteger(devh, "_ADR", &flags)))
107 			return (ENXIO);
108 		info.address = flags;
109 		device_printf(dev, "SSIF interface not supported on ACPI\n");
110 		return (0);
111 	default:
112 		return (ENXIO);
113 	}
114 
115 	if (bus_get_resource(dev, SYS_RES_IOPORT, 0, NULL, NULL) == 0)
116 		type = SYS_RES_IOPORT;
117 	else if (bus_get_resource(dev, SYS_RES_MEMORY, 0, NULL, NULL) == 0)
118 		type = SYS_RES_MEMORY;
119 	else {
120 		device_printf(dev, "unknown resource type\n");
121 		return (ENXIO);
122 	}
123 
124 	sc->ipmi_io_rid = 0;
125 	sc->ipmi_io_res[0] = bus_alloc_resource_any(dev, type,
126 	    &sc->ipmi_io_rid, RF_ACTIVE);
127 	sc->ipmi_io_type = type;
128 	sc->ipmi_io_spacing = 1;
129 	if (sc->ipmi_io_res[0] == NULL) {
130 		device_printf(dev, "couldn't configure I/O resource\n");
131 		return (ENXIO);
132 	}
133 
134 	/* If we have multiple resources, allocate up to MAX_RES. */
135 	for (i = 1; i < MAX_RES; i++) {
136 		sc->ipmi_io_rid = i;
137 		sc->ipmi_io_res[i] = bus_alloc_resource_any(dev, type,
138 		    &sc->ipmi_io_rid, RF_ACTIVE);
139 		if (sc->ipmi_io_res[i] == NULL)
140 			break;
141 	}
142 	sc->ipmi_io_rid = 0;
143 
144 	/* If we have multiple resources, make sure we have enough of them. */
145 	if (sc->ipmi_io_res[1] != NULL && sc->ipmi_io_res[count - 1] == NULL) {
146 		device_printf(dev, "too few I/O resources\n");
147 		error = ENXIO;
148 		goto bad;
149 	}
150 
151 	device_printf(dev, "%s mode found at %s 0x%jx on %s\n",
152 	    mode, type == SYS_RES_IOPORT ? "io" : "mem",
153 	    (uintmax_t)rman_get_start(sc->ipmi_io_res[0]),
154 	    device_get_name(device_get_parent(dev)));
155 
156 	sc->ipmi_dev = dev;
157 
158 	/*
159 	 * Setup an interrupt if we have an interrupt resource.  We
160 	 * don't support GPE interrupts via _GPE yet.
161 	 */
162 	sc->ipmi_irq_rid = 0;
163 	sc->ipmi_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
164 	    &sc->ipmi_irq_rid, RF_SHAREABLE | RF_ACTIVE);
165 
166 	/* Warn if _GPE exists. */
167 	if (ACPI_SUCCESS(AcpiEvaluateObject(devh, "_GPE", NULL, NULL)))
168 		device_printf(dev, "_GPE support not implemented\n");
169 
170 	/*
171 	 * We assume an alignment of 1 byte as currently the IPMI spec
172 	 * doesn't provide any way to determine the alignment via ACPI.
173 	 */
174 	switch (interface_type) {
175 	case KCS_MODE:
176 		error = ipmi_kcs_attach(sc);
177 		if (error)
178 			goto bad;
179 		break;
180 	case SMIC_MODE:
181 		error = ipmi_smic_attach(sc);
182 		if (error)
183 			goto bad;
184 		break;
185 	}
186 	error = ipmi_attach(dev);
187 	if (error)
188 		goto bad;
189 
190 	return (0);
191 bad:
192 	ipmi_release_resources(dev);
193 	return (error);
194 }
195 
196 static device_method_t ipmi_methods[] = {
197 	/* Device interface */
198 	DEVMETHOD(device_probe,		ipmi_acpi_probe),
199 	DEVMETHOD(device_attach,	ipmi_acpi_attach),
200 	DEVMETHOD(device_detach,	ipmi_detach),
201 	{ 0, 0 }
202 };
203 
204 static driver_t ipmi_acpi_driver = {
205 	"ipmi",
206 	ipmi_methods,
207 	sizeof(struct ipmi_softc),
208 };
209 
210 DRIVER_MODULE(ipmi_acpi, acpi, ipmi_acpi_driver, ipmi_devclass, 0, 0);
211 MODULE_DEPEND(ipmi_acpi, acpi, 1, 1, 1);
212