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