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