xref: /freebsd/sys/dev/ipmi/ipmi_acpi.c (revision 734e82fe33aa764367791a7d603b383996c6b40b)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
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 	int rv;
63 
64 	if (ipmi_attached)
65 		return (EBUSY);
66 
67 	if (acpi_disabled("ipmi"))
68 		return (ENXIO);
69 	rv = ACPI_ID_PROBE(device_get_parent(dev), dev, ipmi_ids, NULL);
70 	if (rv <= 0)
71 		device_set_desc(dev, "IPMI System Interface");
72 
73 	return (rv);
74 }
75 
76 static int
77 ipmi_acpi_attach(device_t dev)
78 {
79 	ACPI_HANDLE devh;
80 	const char *mode;
81 	struct ipmi_softc *sc = device_get_softc(dev);
82 	int count, error, 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 = IPMI_IF_KCS_NRES;
96 		mode = "KCS";
97 		break;
98 	case SMIC_MODE:
99 		count = IPMI_IF_SMIC_NRES;
100 		mode = "SMIC";
101 		break;
102 	case BT_MODE:
103 		count = IPMI_IF_BT_NRES;
104 		mode = "BT";
105 		break;
106 	case SSIF_MODE:
107 		device_printf(dev, "SSIF interface not supported on ACPI\n");
108 		return (0);
109 	default:
110 		return (ENXIO);
111 	}
112 
113 	if (bus_get_resource(dev, SYS_RES_IOPORT, 0, NULL, NULL) == 0)
114 		type = SYS_RES_IOPORT;
115 	else if (bus_get_resource(dev, SYS_RES_MEMORY, 0, NULL, NULL) == 0)
116 		type = SYS_RES_MEMORY;
117 	else {
118 		device_printf(dev, "unknown resource type\n");
119 		return (ENXIO);
120 	}
121 
122 	sc->ipmi_io_rid = 0;
123 	sc->ipmi_io_res[0] = bus_alloc_resource_any(dev, type,
124 	    &sc->ipmi_io_rid, RF_ACTIVE);
125 	sc->ipmi_io_type = type;
126 	sc->ipmi_io_spacing = 1;
127 	if (sc->ipmi_io_res[0] == NULL) {
128 		device_printf(dev, "couldn't configure I/O resource\n");
129 		return (ENXIO);
130 	}
131 
132 	/* If we have multiple resources, allocate up to MAX_RES. */
133 	for (i = 1; i < MAX_RES; i++) {
134 		sc->ipmi_io_rid = i;
135 		sc->ipmi_io_res[i] = bus_alloc_resource_any(dev, type,
136 		    &sc->ipmi_io_rid, RF_ACTIVE);
137 		if (sc->ipmi_io_res[i] == NULL)
138 			break;
139 	}
140 	sc->ipmi_io_rid = 0;
141 
142 	/* If we have multiple resources, make sure we have enough of them. */
143 	if (sc->ipmi_io_res[1] != NULL && sc->ipmi_io_res[count - 1] == NULL) {
144 		device_printf(dev, "too few I/O resources\n");
145 		error = ENXIO;
146 		goto bad;
147 	}
148 
149 	device_printf(dev, "%s mode found at %s 0x%jx on %s\n",
150 	    mode, type == SYS_RES_IOPORT ? "io" : "mem",
151 	    (uintmax_t)rman_get_start(sc->ipmi_io_res[0]),
152 	    device_get_name(device_get_parent(dev)));
153 
154 	sc->ipmi_dev = dev;
155 
156 	/*
157 	 * Setup an interrupt if we have an interrupt resource.  We
158 	 * don't support GPE interrupts via _GPE yet.
159 	 */
160 	sc->ipmi_irq_rid = 0;
161 	sc->ipmi_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
162 	    &sc->ipmi_irq_rid, RF_SHAREABLE | RF_ACTIVE);
163 
164 	/* Warn if _GPE exists. */
165 	if (ACPI_SUCCESS(AcpiEvaluateObject(devh, "_GPE", NULL, NULL)))
166 		device_printf(dev, "_GPE support not implemented\n");
167 
168 	/*
169 	 * We assume an alignment of 1 byte as currently the IPMI spec
170 	 * doesn't provide any way to determine the alignment via ACPI.
171 	 */
172 	error = ENXIO;
173 	switch (interface_type) {
174 	case KCS_MODE:
175 		error = ipmi_kcs_attach(sc);
176 		break;
177 	case SMIC_MODE:
178 		error = ipmi_smic_attach(sc);
179 		break;
180 	case BT_MODE:
181 		error = ipmi_bt_attach(sc);
182 		break;
183 	}
184 	if (error)
185 		goto bad;
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, 0, 0);
211 MODULE_DEPEND(ipmi_acpi, acpi, 1, 1, 1);
212