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