xref: /freebsd/sys/dev/ipmi/ipmi_smbus.c (revision 4e8d558c)
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 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/bus.h>
35 #include <sys/condvar.h>
36 #include <sys/eventhandler.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/rman.h>
40 #include <sys/selinfo.h>
41 #include <sys/efi.h>
42 
43 #include <dev/smbus/smbconf.h>
44 #include <dev/smbus/smbus.h>
45 #include <dev/smbus/smb.h>
46 
47 #include "smbus_if.h"
48 
49 #ifdef LOCAL_MODULE
50 #include <ipmivars.h>
51 #else
52 #include <dev/ipmi/ipmivars.h>
53 #endif
54 
55 static void ipmi_smbus_identify(driver_t *driver, device_t parent);
56 static int ipmi_smbus_probe(device_t dev);
57 static int ipmi_smbus_attach(device_t dev);
58 
59 static void
60 ipmi_smbus_identify(driver_t *driver, device_t parent)
61 {
62 	struct ipmi_get_info info;
63 
64 	if (ipmi_smbios_identify(&info) && info.iface_type == SSIF_MODE &&
65 	    device_find_child(parent, "ipmi", -1) == NULL)
66 		BUS_ADD_CHILD(parent, 0, "ipmi", -1);
67 }
68 
69 static int
70 ipmi_smbus_probe(device_t dev)
71 {
72 
73 	device_set_desc(dev, "IPMI System Interface");
74 	return (BUS_PROBE_DEFAULT);
75 }
76 
77 static int
78 ipmi_smbus_attach(device_t dev)
79 {
80 	struct ipmi_softc *sc = device_get_softc(dev);
81 	struct ipmi_get_info info;
82 	int error;
83 
84 	/* This should never fail. */
85 	if (!ipmi_smbios_identify(&info))
86 		return (ENXIO);
87 
88 	if (info.iface_type != SSIF_MODE) {
89 		device_printf(dev, "No SSIF IPMI interface found\n");
90 		return (ENXIO);
91 	}
92 
93 	sc->ipmi_dev = dev;
94 
95 	if (info.irq != 0) {
96 		sc->ipmi_irq_rid = 0;
97 		sc->ipmi_irq_res = bus_alloc_resource(dev, SYS_RES_IRQ,
98 		    &sc->ipmi_irq_rid, info.irq, info.irq, 1,
99 		    RF_SHAREABLE | RF_ACTIVE);
100 	}
101 
102 	device_printf(dev, "SSIF mode found at address 0x%llx on %s\n",
103 	    (long long)info.address, device_get_name(device_get_parent(dev)));
104 	error = ipmi_ssif_attach(sc, device_get_parent(dev), info.address);
105 	if (error)
106 		goto bad;
107 
108 	error = ipmi_attach(dev);
109 	if (error)
110 		goto bad;
111 
112 	return (0);
113 bad:
114 	ipmi_release_resources(dev);
115 	return (error);
116 }
117 
118 static device_method_t ipmi_methods[] = {
119 	/* Device interface */
120 	DEVMETHOD(device_identify,	ipmi_smbus_identify),
121 	DEVMETHOD(device_probe,		ipmi_smbus_probe),
122 	DEVMETHOD(device_attach,	ipmi_smbus_attach),
123 	DEVMETHOD(device_detach,	ipmi_detach),
124 	{ 0, 0 }
125 };
126 
127 static driver_t ipmi_smbus_driver = {
128 	"ipmi",
129 	ipmi_methods,
130 	sizeof(struct ipmi_softc)
131 };
132 
133 DRIVER_MODULE(ipmi_smbus, smbus, ipmi_smbus_driver, 0, 0);
134 MODULE_DEPEND(ipmi_smbus, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
135 #ifdef ARCH_MAY_USE_EFI
136 MODULE_DEPEND(ipmi_smbus, efirt, 1, 1, 1);
137 #endif
138