2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/condvar.h>
36 #include <sys/eventhandler.h>
37 #include <sys/kernel.h>
38 #include <sys/selinfo.h>
42 #include <machine/pc/bios.h>
49 #include <dev/ipmi/ipmivars.h>
56 uint8_t interface_type;
57 uint8_t spec_revision;
58 uint8_t i2c_slave_address;
59 uint8_t NV_storage_device_address;
60 uint64_t base_address;
61 uint8_t base_address_modifier;
62 uint8_t interrupt_number;
65 /* Fields in the base_address field of an IPMI entry. */
66 #define IPMI_BAR_MODE(ba) ((ba) & 0x0000000000000001)
67 #define IPMI_BAR_ADDR(ba) ((ba) & 0xfffffffffffffffe)
69 /* Fields in the base_address_modifier field of an IPMI entry. */
70 #define IPMI_BAM_IRQ_TRIGGER 0x01
71 #define IPMI_BAM_IRQ_POLARITY 0x02
72 #define IPMI_BAM_IRQ_VALID 0x08
73 #define IPMI_BAM_ADDR_LSB(bam) (((bam) & 0x10) >> 4)
74 #define IPMI_BAM_REG_SPACING(bam) (((bam) & 0xc0) >> 6)
76 #define SPACING_32 0x1
77 #define SPACING_16 0x2
79 typedef void (*smbios_callback_t)(struct smbios_structure_header *, void *);
81 static struct ipmi_get_info ipmi_info;
82 static int ipmi_probed;
83 static struct mtx ipmi_info_mtx;
84 MTX_SYSINIT(ipmi_info, &ipmi_info_mtx, "ipmi info", MTX_DEF);
86 static void ipmi_smbios_probe(struct ipmi_get_info *);
87 static int smbios_cksum(struct smbios_eps *);
88 static void smbios_walk_table(uint8_t *, int, smbios_callback_t,
90 static void smbios_ipmi_info(struct smbios_structure_header *, void *);
93 smbios_ipmi_info(struct smbios_structure_header *h, void *arg)
95 struct ipmi_get_info *info;
98 if (h->type != 38 || h->length <
99 offsetof(struct ipmi_entry, interrupt_number))
101 s = (struct ipmi_entry *)h;
103 bzero(info, sizeof(struct ipmi_get_info));
104 switch (s->interface_type) {
107 info->address = IPMI_BAR_ADDR(s->base_address) |
108 IPMI_BAM_ADDR_LSB(s->base_address_modifier);
109 info->io_mode = IPMI_BAR_MODE(s->base_address);
110 switch (IPMI_BAM_REG_SPACING(s->base_address_modifier)) {
121 printf("SMBIOS: Invalid register spacing\n");
126 if ((s->base_address & 0xffffffffffffff00) != 0) {
127 printf("SMBIOS: Invalid SSIF SMBus address, using BMC I2C slave address instead\n");
128 info->address = s->i2c_slave_address;
131 info->address = IPMI_BAR_ADDR(s->base_address);
136 if (s->length > offsetof(struct ipmi_entry, interrupt_number)) {
137 if (s->interrupt_number > 15)
138 printf("SMBIOS: Non-ISA IRQ %d for IPMI\n",
139 s->interrupt_number);
141 info->irq = s->interrupt_number;
143 info->iface_type = s->interface_type;
147 smbios_walk_table(uint8_t *p, int entries, smbios_callback_t cb, void *arg)
149 struct smbios_structure_header *s;
152 s = (struct smbios_structure_header *)p;
156 * Look for a double-nul after the end of the
157 * formatted area of this structure.
160 while (!(p[0] == 0 && p[1] == 0))
164 * Skip over the double-nul to the start of the next
172 * Walk the SMBIOS table looking for an IPMI (type 38) entry. If we find
173 * one, return the parsed data in the passed in ipmi_get_info structure and
174 * return true. If we don't find one, return false.
177 ipmi_smbios_probe(struct ipmi_get_info *info)
179 struct smbios_eps *header;
183 bzero(info, sizeof(struct ipmi_get_info));
185 /* Find the SMBIOS table header. */
186 addr = bios_sigsearch(SMBIOS_START, SMBIOS_SIG, SMBIOS_LEN,
187 SMBIOS_STEP, SMBIOS_OFF);
192 * Map the header. We first map a fixed size to get the actual
193 * length and then map it a second time with the actual length so
194 * we can verify the checksum.
196 header = pmap_mapbios(addr, sizeof(struct smbios_eps));
197 table = pmap_mapbios(addr, header->length);
198 pmap_unmapbios((vm_offset_t)header, sizeof(struct smbios_eps));
200 if (smbios_cksum(header) != 0) {
201 pmap_unmapbios((vm_offset_t)header, header->length);
205 /* Now map the actual table and walk it looking for an IPMI entry. */
206 table = pmap_mapbios(header->structure_table_address,
207 header->structure_table_length);
208 smbios_walk_table(table, header->number_structures, smbios_ipmi_info,
211 /* Unmap everything. */
212 pmap_unmapbios((vm_offset_t)table, header->structure_table_length);
213 pmap_unmapbios((vm_offset_t)header, header->length);
217 * Return the SMBIOS IPMI table entry info to the caller. If we haven't
218 * searched the IPMI table yet, search it. Otherwise, return a cached
222 ipmi_smbios_identify(struct ipmi_get_info *info)
225 mtx_lock(&ipmi_info_mtx);
226 switch (ipmi_probed) {
228 /* Need to probe the SMBIOS table. */
230 mtx_unlock(&ipmi_info_mtx);
231 ipmi_smbios_probe(&ipmi_info);
232 mtx_lock(&ipmi_info_mtx);
237 /* Another thread is currently probing the table, so wait. */
238 while (ipmi_probed == 1)
239 msleep(&ipmi_info, &ipmi_info_mtx, 0, "ipmi info", 0);
242 /* The cached data is available. */
246 bcopy(&ipmi_info, info, sizeof(ipmi_info));
247 mtx_unlock(&ipmi_info_mtx);
249 return (info->iface_type != 0);
253 smbios_cksum(struct smbios_eps *e)
261 for (i = 0; i < e->length; i++) {