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/selinfo.h> 39 40 #include <vm/vm.h> 41 #include <vm/pmap.h> 42 #if defined(__amd64__) || defined(__i386__) 43 #include <machine/pc/bios.h> 44 #endif 45 #include <dev/smbios/smbios.h> 46 47 #ifdef LOCAL_MODULE 48 #include <ipmi.h> 49 #include <ipmivars.h> 50 #else 51 #include <sys/ipmi.h> 52 #include <dev/ipmi/ipmivars.h> 53 #endif 54 55 struct ipmi_entry { 56 uint8_t type; 57 uint8_t length; 58 uint16_t handle; 59 uint8_t interface_type; 60 uint8_t spec_revision; 61 uint8_t i2c_slave_address; 62 uint8_t NV_storage_device_address; 63 uint64_t base_address; 64 uint8_t base_address_modifier; 65 uint8_t interrupt_number; 66 }; 67 68 /* Fields in the base_address field of an IPMI entry. */ 69 #define IPMI_BAR_MODE(ba) ((ba) & 0x0000000000000001) 70 #define IPMI_BAR_ADDR(ba) ((ba) & 0xfffffffffffffffe) 71 72 /* Fields in the base_address_modifier field of an IPMI entry. */ 73 #define IPMI_BAM_IRQ_TRIGGER 0x01 74 #define IPMI_BAM_IRQ_POLARITY 0x02 75 #define IPMI_BAM_IRQ_VALID 0x08 76 #define IPMI_BAM_ADDR_LSB(bam) (((bam) & 0x10) >> 4) 77 #define IPMI_BAM_REG_SPACING(bam) (((bam) & 0xc0) >> 6) 78 #define SPACING_8 0x0 79 #define SPACING_32 0x1 80 #define SPACING_16 0x2 81 82 typedef void (*smbios_callback_t)(struct smbios_structure_header *, void *); 83 84 static struct ipmi_get_info ipmi_info; 85 static int ipmi_probed; 86 static struct mtx ipmi_info_mtx; 87 MTX_SYSINIT(ipmi_info, &ipmi_info_mtx, "ipmi info", MTX_DEF); 88 89 static void ipmi_smbios_probe(struct ipmi_get_info *); 90 static int smbios_cksum(struct smbios_eps *); 91 static void smbios_walk_table(uint8_t *, vm_size_t, smbios_callback_t, 92 void *); 93 static void smbios_ipmi_info(struct smbios_structure_header *, void *); 94 95 static void 96 smbios_ipmi_info(struct smbios_structure_header *h, void *arg) 97 { 98 struct ipmi_get_info *info; 99 struct ipmi_entry *s; 100 101 if (h->type != 38 || h->length < 102 offsetof(struct ipmi_entry, interrupt_number)) 103 return; 104 s = (struct ipmi_entry *)h; 105 info = arg; 106 bzero(info, sizeof(struct ipmi_get_info)); 107 switch (s->interface_type) { 108 case KCS_MODE: 109 case SMIC_MODE: 110 info->address = IPMI_BAR_ADDR(s->base_address) | 111 IPMI_BAM_ADDR_LSB(s->base_address_modifier); 112 info->io_mode = IPMI_BAR_MODE(s->base_address); 113 switch (IPMI_BAM_REG_SPACING(s->base_address_modifier)) { 114 case SPACING_8: 115 info->offset = 1; 116 break; 117 case SPACING_32: 118 info->offset = 4; 119 break; 120 case SPACING_16: 121 info->offset = 2; 122 break; 123 default: 124 printf("SMBIOS: Invalid register spacing\n"); 125 return; 126 } 127 break; 128 case SSIF_MODE: 129 if ((s->base_address & 0xffffffffffffff00) != 0) { 130 printf("SMBIOS: Invalid SSIF SMBus address, using BMC I2C slave address instead\n"); 131 info->address = s->i2c_slave_address; 132 break; 133 } 134 info->address = IPMI_BAR_ADDR(s->base_address); 135 break; 136 default: 137 return; 138 } 139 if (s->length > offsetof(struct ipmi_entry, interrupt_number)) { 140 if (s->interrupt_number > 15) 141 printf("SMBIOS: Non-ISA IRQ %d for IPMI\n", 142 s->interrupt_number); 143 else 144 info->irq = s->interrupt_number; 145 } 146 info->iface_type = s->interface_type; 147 } 148 149 static void 150 smbios_walk_table(uint8_t *table, vm_size_t size, smbios_callback_t cb, void *arg) 151 { 152 struct smbios_structure_header *s; 153 uint8_t *p; 154 155 for (p = table; p < table + size;) { 156 s = (struct smbios_structure_header *)p; 157 cb(s, arg); 158 159 /* 160 * Look for a double-nul after the end of the 161 * formatted area of this structure. 162 */ 163 p += s->length; 164 while (!(p[0] == 0 && p[1] == 0)) { 165 p++; 166 if (p >= table + size) 167 return; 168 } 169 170 /* 171 * Skip over the double-nul to the start of the next 172 * structure. 173 */ 174 p += 2; 175 } 176 } 177 178 /* 179 * Walk the SMBIOS table looking for an IPMI (type 38) entry. If we find 180 * one, return the parsed data in the passed in ipmi_get_info structure and 181 * return true. If we don't find one, return false. 182 */ 183 static void 184 ipmi_smbios_probe(struct ipmi_get_info *info) 185 { 186 void *table; 187 vm_paddr_t table_paddr; 188 vm_size_t table_size; 189 int err; 190 191 bzero(info, sizeof(struct ipmi_get_info)); 192 193 err = smbios_get_structure_table(&table_paddr, &table_size); 194 if (err != 0) 195 return; 196 197 table = pmap_mapbios(table_paddr, table_size); 198 199 smbios_walk_table(table, table_size, smbios_ipmi_info, info); 200 201 /* Unmap everything. */ 202 pmap_unmapbios((vm_offset_t)table, table_size); 203 } 204 205 /* 206 * Return the SMBIOS IPMI table entry info to the caller. If we haven't 207 * searched the IPMI table yet, search it. Otherwise, return a cached 208 * copy of the data. 209 */ 210 int 211 ipmi_smbios_identify(struct ipmi_get_info *info) 212 { 213 214 mtx_lock(&ipmi_info_mtx); 215 switch (ipmi_probed) { 216 case 0: 217 /* Need to probe the SMBIOS table. */ 218 ipmi_probed++; 219 mtx_unlock(&ipmi_info_mtx); 220 ipmi_smbios_probe(&ipmi_info); 221 mtx_lock(&ipmi_info_mtx); 222 ipmi_probed++; 223 wakeup(&ipmi_info); 224 break; 225 case 1: 226 /* Another thread is currently probing the table, so wait. */ 227 while (ipmi_probed == 1) 228 msleep(&ipmi_info, &ipmi_info_mtx, 0, "ipmi info", 0); 229 break; 230 default: 231 /* The cached data is available. */ 232 break; 233 } 234 235 bcopy(&ipmi_info, info, sizeof(ipmi_info)); 236 mtx_unlock(&ipmi_info_mtx); 237 238 return (info->iface_type != 0); 239 } 240 241 static int 242 smbios_cksum(struct smbios_eps *e) 243 { 244 u_int8_t *ptr; 245 u_int8_t cksum; 246 int i; 247 248 ptr = (u_int8_t *)e; 249 cksum = 0; 250 for (i = 0; i < e->length; i++) { 251 cksum += ptr[i]; 252 } 253 254 return (cksum); 255 } 256