xref: /netbsd/sys/dev/ipmi.c (revision 484ca534)
1 /*	$NetBSD: ipmi.c,v 1.10 2023/03/22 13:00:54 mlelstv Exp $ */
2 
3 /*
4  * Copyright (c) 2019 Michael van Elst
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27 /*
28  * Copyright (c) 2006 Manuel Bouyer.
29  *
30  * Redistribution and use in source and binary forms, with or without
31  * modification, are permitted provided that the following conditions
32  * are met:
33  * 1. Redistributions of source code must retain the above copyright
34  *    notice, this list of conditions and the following disclaimer.
35  * 2. Redistributions in binary form must reproduce the above copyright
36  *    notice, this list of conditions and the following disclaimer in the
37  *    documentation and/or other materials provided with the distribution.
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
40  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
42  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
43  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
45  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
46  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
47  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
48  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49  *
50  */
51 
52 /*
53  * Copyright (c) 2005 Jordan Hargrave
54  * All rights reserved.
55  *
56  * Redistribution and use in source and binary forms, with or without
57  * modification, are permitted provided that the following conditions
58  * are met:
59  * 1. Redistributions of source code must retain the above copyright
60  *    notice, this list of conditions and the following disclaimer.
61  * 2. Redistributions in binary form must reproduce the above copyright
62  *    notice, this list of conditions and the following disclaimer in the
63  *    documentation and/or other materials provided with the distribution.
64  *
65  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
66  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
67  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
68  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
69  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
70  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
71  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
72  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
73  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
74  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
75  * SUCH DAMAGE.
76  */
77 
78 #include <sys/cdefs.h>
79 __KERNEL_RCSID(0, "$NetBSD: ipmi.c,v 1.10 2023/03/22 13:00:54 mlelstv Exp $");
80 
81 #include <sys/types.h>
82 #include <sys/param.h>
83 #include <sys/systm.h>
84 #include <sys/kernel.h>
85 #include <sys/device.h>
86 #include <sys/extent.h>
87 #include <sys/callout.h>
88 #include <sys/envsys.h>
89 #include <sys/malloc.h>
90 #include <sys/kthread.h>
91 #include <sys/bus.h>
92 #include <sys/intr.h>
93 #include <sys/ioctl.h>
94 #include <sys/poll.h>
95 #include <sys/conf.h>
96 
97 #include <dev/isa/isareg.h>
98 #include <dev/isa/isavar.h>
99 
100 #include <sys/ipmi.h>
101 #include <dev/ipmivar.h>
102 
103 #include <uvm/uvm_extern.h>
104 
105 #include "ioconf.h"
106 
107 static dev_type_open(ipmi_open);
108 static dev_type_close(ipmi_close);
109 static dev_type_ioctl(ipmi_ioctl);
110 static dev_type_poll(ipmi_poll);
111 
112 const struct cdevsw ipmi_cdevsw = {
113 	.d_open = ipmi_open,
114 	.d_close = ipmi_close,
115 	.d_read = noread,
116 	.d_write = nowrite,
117 	.d_ioctl = ipmi_ioctl,
118 	.d_stop = nostop,
119 	.d_tty = notty,
120 	.d_poll = ipmi_poll,
121 	.d_mmap = nommap,
122 	.d_kqfilter = nokqfilter,
123 	.d_discard = nodiscard,
124 	.d_flag = D_OTHER
125 };
126 
127 #define IPMIUNIT(n) (minor(n))
128 
129 struct ipmi_sensor {
130 	uint8_t	*i_sdr;
131 	int		i_num;
132 	int		i_stype;
133 	int		i_etype;
134 	char		i_envdesc[64];
135 	int 		i_envtype; /* envsys compatible type */
136 	int		i_envnum; /* envsys index */
137 	sysmon_envsys_lim_t i_limits, i_deflims;
138 	uint32_t	i_props, i_defprops;
139 	SLIST_ENTRY(ipmi_sensor) i_list;
140 	int32_t		i_prevval;	/* feed rnd source on change */
141 };
142 
143 #if 0
144 static	int ipmi_nintr;
145 #endif
146 static	int ipmi_dbg = 0;
147 static	int ipmi_enabled = 0;
148 
149 #define SENSOR_REFRESH_RATE (hz / 2)
150 
151 #define IPMI_BTMSG_LEN			0
152 #define IPMI_BTMSG_NFLN			1
153 #define IPMI_BTMSG_SEQ			2
154 #define IPMI_BTMSG_CMD			3
155 #define IPMI_BTMSG_CCODE		4
156 #define IPMI_BTMSG_DATASND		4
157 #define IPMI_BTMSG_DATARCV		5
158 
159 #define IPMI_MSG_NFLN			0
160 #define IPMI_MSG_CMD			1
161 #define IPMI_MSG_CCODE			2
162 #define IPMI_MSG_DATASND		2
163 #define IPMI_MSG_DATARCV		3
164 
165 #define IPMI_SENSOR_TYPE_TEMP		0x0101
166 #define IPMI_SENSOR_TYPE_VOLT		0x0102
167 #define IPMI_SENSOR_TYPE_FAN		0x0104
168 #define IPMI_SENSOR_TYPE_INTRUSION	0x6F05
169 #define IPMI_SENSOR_TYPE_PWRSUPPLY	0x6F08
170 
171 #define IPMI_NAME_UNICODE		0x00
172 #define IPMI_NAME_BCDPLUS		0x01
173 #define IPMI_NAME_ASCII6BIT		0x02
174 #define IPMI_NAME_ASCII8BIT		0x03
175 
176 #define IPMI_ENTITY_PWRSUPPLY		0x0A
177 
178 #define IPMI_SENSOR_SCANNING_ENABLED	(1L << 6)
179 #define IPMI_SENSOR_UNAVAILABLE		(1L << 5)
180 #define IPMI_INVALID_SENSOR_P(x) \
181 	(((x) & (IPMI_SENSOR_SCANNING_ENABLED|IPMI_SENSOR_UNAVAILABLE)) \
182 	!= IPMI_SENSOR_SCANNING_ENABLED)
183 
184 #define IPMI_SDR_TYPEFULL		1
185 #define IPMI_SDR_TYPECOMPACT		2
186 
187 #define byteof(x) ((x) >> 3)
188 #define bitof(x)  (1L << ((x) & 0x7))
189 #define TB(b,m)	  (data[2+byteof(b)] & bitof(b))
190 
191 #define dbg_printf(lvl, fmt...) \
192 	if (ipmi_dbg >= lvl) \
193 		printf(fmt);
194 #define dbg_dump(lvl, msg, len, buf) \
195 	if (len && ipmi_dbg >= lvl) \
196 		dumpb(msg, len, (const uint8_t *)(buf));
197 
198 static	long signextend(unsigned long, int);
199 
200 SLIST_HEAD(ipmi_sensors_head, ipmi_sensor);
201 static struct ipmi_sensors_head ipmi_sensor_list =
202     SLIST_HEAD_INITIALIZER(&ipmi_sensor_list);
203 
204 static	void dumpb(const char *, int, const uint8_t *);
205 
206 static	int read_sensor(struct ipmi_softc *, struct ipmi_sensor *);
207 static	int add_sdr_sensor(struct ipmi_softc *, uint8_t *);
208 static	int get_sdr_partial(struct ipmi_softc *, uint16_t, uint16_t,
209 	    uint8_t, uint8_t, void *, uint16_t *);
210 static	int get_sdr(struct ipmi_softc *, uint16_t, uint16_t *);
211 
212 static	char *ipmi_buf_acquire(struct ipmi_softc *, size_t);
213 static	void ipmi_buf_release(struct ipmi_softc *, char *);
214 static	int ipmi_sendcmd(struct ipmi_softc *, int, int, int, int, int, const void*);
215 static	int ipmi_recvcmd(struct ipmi_softc *, int, int *, void *);
216 static	void ipmi_delay(struct ipmi_softc *, int);
217 
218 static	int ipmi_get_device_id(struct ipmi_softc *, struct ipmi_device_id *);
219 static	int ipmi_watchdog_setmode(struct sysmon_wdog *);
220 static	int ipmi_watchdog_tickle(struct sysmon_wdog *);
221 static	void ipmi_dotickle(struct ipmi_softc *);
222 
223 #if 0
224 static	int ipmi_intr(void *);
225 #endif
226 
227 static	int ipmi_match(device_t, cfdata_t, void *);
228 static	void ipmi_attach(device_t, device_t, void *);
229 static	int ipmi_detach(device_t, int);
230 
231 static	long	ipmi_convert(uint8_t, struct sdrtype1 *, long);
232 static	void	ipmi_sensor_name(char *, int, uint8_t, uint8_t *);
233 
234 /* BMC Helper Functions */
235 static	uint8_t bmc_read(struct ipmi_softc *, int);
236 static	void bmc_write(struct ipmi_softc *, int, uint8_t);
237 static	int bmc_io_wait(struct ipmi_softc *, int, uint8_t, uint8_t, const char *);
238 static	int bmc_io_wait_spin(struct ipmi_softc *, int, uint8_t, uint8_t);
239 static	int bmc_io_wait_sleep(struct ipmi_softc *, int, uint8_t, uint8_t);
240 
241 static	void *cmn_buildmsg(struct ipmi_softc *, int, int, int, const void *, int *);
242 
243 static	int getbits(uint8_t *, int, int);
244 static	int ipmi_sensor_type(int, int, int);
245 
246 static	void ipmi_refresh_sensors(struct ipmi_softc *);
247 static	int ipmi_map_regs(struct ipmi_softc *, struct ipmi_attach_args *);
248 static	void ipmi_unmap_regs(struct ipmi_softc *);
249 
250 static	int32_t ipmi_convert_sensor(uint8_t *, struct ipmi_sensor *);
251 static	void ipmi_set_limits(struct sysmon_envsys *, envsys_data_t *,
252 		sysmon_envsys_lim_t *, uint32_t *);
253 static	void ipmi_get_limits(struct sysmon_envsys *, envsys_data_t *,
254 		sysmon_envsys_lim_t *, uint32_t *);
255 static	void ipmi_get_sensor_limits(struct ipmi_softc *, struct ipmi_sensor *,
256 		sysmon_envsys_lim_t *, uint32_t *);
257 static	int ipmi_sensor_status(struct ipmi_softc *, struct ipmi_sensor *,
258 		envsys_data_t *, uint8_t *);
259 
260 static	int add_child_sensors(struct ipmi_softc *, uint8_t *, int, int, int,
261 		int, int, int, const char *);
262 
263 static	bool ipmi_suspend(device_t, const pmf_qual_t *);
264 
265 static	int kcs_probe(struct ipmi_softc *);
266 static	int kcs_reset(struct ipmi_softc *);
267 static	int kcs_sendmsg(struct ipmi_softc *, int, const uint8_t *);
268 static	int kcs_recvmsg(struct ipmi_softc *, int, int *len, uint8_t *);
269 
270 static	void *bt_buildmsg(struct ipmi_softc *, int, int, int, const void *, int *);
271 static	int bt_probe(struct ipmi_softc *);
272 static	int bt_reset(struct ipmi_softc *);
273 static	int bt_sendmsg(struct ipmi_softc *, int, const uint8_t *);
274 static	int bt_recvmsg(struct ipmi_softc *, int, int *, uint8_t *);
275 
276 static	int smic_probe(struct ipmi_softc *);
277 static	int smic_reset(struct ipmi_softc *);
278 static	int smic_sendmsg(struct ipmi_softc *, int, const uint8_t *);
279 static	int smic_recvmsg(struct ipmi_softc *, int, int *, uint8_t *);
280 
281 static struct ipmi_if kcs_if = {
282 	"KCS",
283 	IPMI_IF_KCS_NREGS,
284 	cmn_buildmsg,
285 	kcs_sendmsg,
286 	kcs_recvmsg,
287 	kcs_reset,
288 	kcs_probe,
289 };
290 
291 static struct ipmi_if smic_if = {
292 	"SMIC",
293 	IPMI_IF_SMIC_NREGS,
294 	cmn_buildmsg,
295 	smic_sendmsg,
296 	smic_recvmsg,
297 	smic_reset,
298 	smic_probe,
299 };
300 
301 static struct ipmi_if bt_if = {
302 	"BT",
303 	IPMI_IF_BT_NREGS,
304 	bt_buildmsg,
305 	bt_sendmsg,
306 	bt_recvmsg,
307 	bt_reset,
308 	bt_probe,
309 };
310 
311 static	struct ipmi_if *ipmi_get_if(int);
312 
313 static struct ipmi_if *
ipmi_get_if(int iftype)314 ipmi_get_if(int iftype)
315 {
316 	switch (iftype) {
317 	case IPMI_IF_KCS:
318 		return &kcs_if;
319 	case IPMI_IF_SMIC:
320 		return &smic_if;
321 	case IPMI_IF_BT:
322 		return &bt_if;
323 	default:
324 		return NULL;
325 	}
326 }
327 
328 /*
329  * BMC Helper Functions
330  */
331 static uint8_t
bmc_read(struct ipmi_softc * sc,int offset)332 bmc_read(struct ipmi_softc *sc, int offset)
333 {
334 	return bus_space_read_1(sc->sc_iot, sc->sc_ioh,
335 	    offset * sc->sc_if_iospacing);
336 }
337 
338 static void
bmc_write(struct ipmi_softc * sc,int offset,uint8_t val)339 bmc_write(struct ipmi_softc *sc, int offset, uint8_t val)
340 {
341 	bus_space_write_1(sc->sc_iot, sc->sc_ioh,
342 	    offset * sc->sc_if_iospacing, val);
343 }
344 
345 static int
bmc_io_wait_sleep(struct ipmi_softc * sc,int offset,uint8_t mask,uint8_t value)346 bmc_io_wait_sleep(struct ipmi_softc *sc, int offset, uint8_t mask,
347     uint8_t value)
348 {
349 	int retries;
350 	uint8_t v;
351 
352 	KASSERT(mutex_owned(&sc->sc_cmd_mtx));
353 
354 	for (retries = 0; retries < sc->sc_max_retries; retries++) {
355 		v = bmc_read(sc, offset);
356 		if ((v & mask) == value)
357 			return v;
358 		mutex_enter(&sc->sc_sleep_mtx);
359 		cv_timedwait(&sc->sc_cmd_sleep, &sc->sc_sleep_mtx, 1);
360 		mutex_exit(&sc->sc_sleep_mtx);
361 	}
362 	return -1;
363 }
364 
365 static int
bmc_io_wait(struct ipmi_softc * sc,int offset,uint8_t mask,uint8_t value,const char * lbl)366 bmc_io_wait(struct ipmi_softc *sc, int offset, uint8_t mask, uint8_t value,
367     const char *lbl)
368 {
369 	int v;
370 
371 	v = bmc_io_wait_spin(sc, offset, mask, value);
372 	if (cold || v != -1)
373 		return v;
374 
375 	return bmc_io_wait_sleep(sc, offset, mask, value);
376 }
377 
378 static int
bmc_io_wait_spin(struct ipmi_softc * sc,int offset,uint8_t mask,uint8_t value)379 bmc_io_wait_spin(struct ipmi_softc *sc, int offset, uint8_t mask,
380     uint8_t value)
381 {
382 	uint8_t	v;
383 	int			count = cold ? 15000 : 500;
384 	/* ~us */
385 
386 	while (count--) {
387 		v = bmc_read(sc, offset);
388 		if ((v & mask) == value)
389 			return v;
390 
391 		delay(1);
392 	}
393 
394 	return -1;
395 
396 }
397 
398 #define NETFN_LUN(nf,ln) (((nf) << 2) | ((ln) & 0x3))
399 #define GET_NETFN(m) (((m) >> 2)
400 #define GET_LUN(m) ((m) & 0x03)
401 
402 /*
403  * BT interface
404  */
405 #define _BT_CTRL_REG			0
406 #define	  BT_CLR_WR_PTR			(1L << 0)
407 #define	  BT_CLR_RD_PTR			(1L << 1)
408 #define	  BT_HOST2BMC_ATN		(1L << 2)
409 #define	  BT_BMC2HOST_ATN		(1L << 3)
410 #define	  BT_EVT_ATN			(1L << 4)
411 #define	  BT_HOST_BUSY			(1L << 6)
412 #define	  BT_BMC_BUSY			(1L << 7)
413 
414 #define	  BT_READY	(BT_HOST_BUSY|BT_HOST2BMC_ATN|BT_BMC2HOST_ATN)
415 
416 #define _BT_DATAIN_REG			1
417 #define _BT_DATAOUT_REG			1
418 
419 #define _BT_INTMASK_REG			2
420 #define	 BT_IM_HIRQ_PEND		(1L << 1)
421 #define	 BT_IM_SCI_EN			(1L << 2)
422 #define	 BT_IM_SMI_EN			(1L << 3)
423 #define	 BT_IM_NMI2SMI			(1L << 4)
424 
425 static int bt_read(struct ipmi_softc *, int);
426 static int bt_write(struct ipmi_softc *, int, uint8_t);
427 
428 static int
bt_read(struct ipmi_softc * sc,int reg)429 bt_read(struct ipmi_softc *sc, int reg)
430 {
431 	return bmc_read(sc, reg);
432 }
433 
434 static int
bt_write(struct ipmi_softc * sc,int reg,uint8_t data)435 bt_write(struct ipmi_softc *sc, int reg, uint8_t data)
436 {
437 	if (bmc_io_wait(sc, _BT_CTRL_REG, BT_BMC_BUSY, 0, __func__) < 0)
438 		return -1;
439 
440 	bmc_write(sc, reg, data);
441 	return 0;
442 }
443 
444 static int
bt_sendmsg(struct ipmi_softc * sc,int len,const uint8_t * data)445 bt_sendmsg(struct ipmi_softc *sc, int len, const uint8_t *data)
446 {
447 	int i;
448 
449 	bt_write(sc, _BT_CTRL_REG, BT_CLR_WR_PTR);
450 	for (i = 0; i < len; i++)
451 		bt_write(sc, _BT_DATAOUT_REG, data[i]);
452 
453 	bt_write(sc, _BT_CTRL_REG, BT_HOST2BMC_ATN);
454 	if (bmc_io_wait(sc, _BT_CTRL_REG, BT_HOST2BMC_ATN | BT_BMC_BUSY, 0,
455 	    __func__) < 0)
456 		return -1;
457 
458 	return 0;
459 }
460 
461 static int
bt_recvmsg(struct ipmi_softc * sc,int maxlen,int * rxlen,uint8_t * data)462 bt_recvmsg(struct ipmi_softc *sc, int maxlen, int *rxlen, uint8_t *data)
463 {
464 	uint8_t len, v, i;
465 
466 	if (bmc_io_wait(sc, _BT_CTRL_REG, BT_BMC2HOST_ATN, BT_BMC2HOST_ATN,
467 	    __func__) < 0)
468 		return -1;
469 
470 	bt_write(sc, _BT_CTRL_REG, BT_HOST_BUSY);
471 	bt_write(sc, _BT_CTRL_REG, BT_BMC2HOST_ATN);
472 	bt_write(sc, _BT_CTRL_REG, BT_CLR_RD_PTR);
473 	len = bt_read(sc, _BT_DATAIN_REG);
474 	for (i = IPMI_BTMSG_NFLN; i <= len; i++) {
475 		v = bt_read(sc, _BT_DATAIN_REG);
476 		if (i != IPMI_BTMSG_SEQ)
477 			*(data++) = v;
478 	}
479 	bt_write(sc, _BT_CTRL_REG, BT_HOST_BUSY);
480 	*rxlen = len - 1;
481 
482 	return 0;
483 }
484 
485 static int
bt_reset(struct ipmi_softc * sc)486 bt_reset(struct ipmi_softc *sc)
487 {
488 	return -1;
489 }
490 
491 static int
bt_probe(struct ipmi_softc * sc)492 bt_probe(struct ipmi_softc *sc)
493 {
494 	uint8_t rv;
495 
496 	rv = bmc_read(sc, _BT_CTRL_REG);
497 	rv &= BT_HOST_BUSY;
498 	rv |= BT_CLR_WR_PTR|BT_CLR_RD_PTR|BT_BMC2HOST_ATN|BT_HOST2BMC_ATN;
499 	bmc_write(sc, _BT_CTRL_REG, rv);
500 
501 	rv = bmc_read(sc, _BT_INTMASK_REG);
502 	rv &= BT_IM_SCI_EN|BT_IM_SMI_EN|BT_IM_NMI2SMI;
503 	rv |= BT_IM_HIRQ_PEND;
504 	bmc_write(sc, _BT_INTMASK_REG, rv);
505 
506 #if 0
507 	printf("%s: %2x\n", __func__, v);
508 	printf(" WR    : %2x\n", v & BT_CLR_WR_PTR);
509 	printf(" RD    : %2x\n", v & BT_CLR_RD_PTR);
510 	printf(" H2B   : %2x\n", v & BT_HOST2BMC_ATN);
511 	printf(" B2H   : %2x\n", v & BT_BMC2HOST_ATN);
512 	printf(" EVT   : %2x\n", v & BT_EVT_ATN);
513 	printf(" HBSY  : %2x\n", v & BT_HOST_BUSY);
514 	printf(" BBSY  : %2x\n", v & BT_BMC_BUSY);
515 #endif
516 	return 0;
517 }
518 
519 /*
520  * SMIC interface
521  */
522 #define _SMIC_DATAIN_REG		0
523 #define _SMIC_DATAOUT_REG		0
524 
525 #define _SMIC_CTRL_REG			1
526 #define	  SMS_CC_GET_STATUS		 0x40
527 #define	  SMS_CC_START_TRANSFER		 0x41
528 #define	  SMS_CC_NEXT_TRANSFER		 0x42
529 #define	  SMS_CC_END_TRANSFER		 0x43
530 #define	  SMS_CC_START_RECEIVE		 0x44
531 #define	  SMS_CC_NEXT_RECEIVE		 0x45
532 #define	  SMS_CC_END_RECEIVE		 0x46
533 #define	  SMS_CC_TRANSFER_ABORT		 0x47
534 
535 #define	  SMS_SC_READY			 0xc0
536 #define	  SMS_SC_WRITE_START		 0xc1
537 #define	  SMS_SC_WRITE_NEXT		 0xc2
538 #define	  SMS_SC_WRITE_END		 0xc3
539 #define	  SMS_SC_READ_START		 0xc4
540 #define	  SMS_SC_READ_NEXT		 0xc5
541 #define	  SMS_SC_READ_END		 0xc6
542 
543 #define _SMIC_FLAG_REG			2
544 #define	  SMIC_BUSY			(1L << 0)
545 #define	  SMIC_SMS_ATN			(1L << 2)
546 #define	  SMIC_EVT_ATN			(1L << 3)
547 #define	  SMIC_SMI			(1L << 4)
548 #define	  SMIC_TX_DATA_RDY		(1L << 6)
549 #define	  SMIC_RX_DATA_RDY		(1L << 7)
550 
551 static int smic_wait(struct ipmi_softc *, uint8_t, uint8_t, const char *);
552 static int smic_write_cmd_data(struct ipmi_softc *, uint8_t, const uint8_t *);
553 static int smic_read_data(struct ipmi_softc *, uint8_t *);
554 
555 static int
smic_wait(struct ipmi_softc * sc,uint8_t mask,uint8_t val,const char * lbl)556 smic_wait(struct ipmi_softc *sc, uint8_t mask, uint8_t val, const char *lbl)
557 {
558 	int v;
559 
560 	/* Wait for expected flag bits */
561 	v = bmc_io_wait(sc, _SMIC_FLAG_REG, mask, val, __func__);
562 	if (v < 0)
563 		return -1;
564 
565 	/* Return current status */
566 	v = bmc_read(sc, _SMIC_CTRL_REG);
567 	dbg_printf(99, "%s(%s) = %#.2x\n", __func__, lbl, v);
568 	return v;
569 }
570 
571 static int
smic_write_cmd_data(struct ipmi_softc * sc,uint8_t cmd,const uint8_t * data)572 smic_write_cmd_data(struct ipmi_softc *sc, uint8_t cmd, const uint8_t *data)
573 {
574 	int	sts, v;
575 
576 	dbg_printf(50, "%s: %#.2x %#.2x\n", __func__, cmd, data ? *data : -1);
577 	sts = smic_wait(sc, SMIC_TX_DATA_RDY | SMIC_BUSY, SMIC_TX_DATA_RDY,
578 	    "smic_write_cmd_data ready");
579 	if (sts < 0)
580 		return sts;
581 
582 	bmc_write(sc, _SMIC_CTRL_REG, cmd);
583 	if (data)
584 		bmc_write(sc, _SMIC_DATAOUT_REG, *data);
585 
586 	/* Toggle BUSY bit, then wait for busy bit to clear */
587 	v = bmc_read(sc, _SMIC_FLAG_REG);
588 	bmc_write(sc, _SMIC_FLAG_REG, v | SMIC_BUSY);
589 
590 	return smic_wait(sc, SMIC_BUSY, 0, __func__);
591 }
592 
593 static int
smic_read_data(struct ipmi_softc * sc,uint8_t * data)594 smic_read_data(struct ipmi_softc *sc, uint8_t *data)
595 {
596 	int sts;
597 
598 	sts = smic_wait(sc, SMIC_RX_DATA_RDY | SMIC_BUSY, SMIC_RX_DATA_RDY,
599 	    __func__);
600 	if (sts >= 0) {
601 		*data = bmc_read(sc, _SMIC_DATAIN_REG);
602 		dbg_printf(50, "%s: %#.2x\n", __func__, *data);
603 	}
604 	return sts;
605 }
606 
607 #define ErrStat(a, ...) if (a) printf(__VA_ARGS__);
608 
609 static int
smic_sendmsg(struct ipmi_softc * sc,int len,const uint8_t * data)610 smic_sendmsg(struct ipmi_softc *sc, int len, const uint8_t *data)
611 {
612 	int sts, idx;
613 
614 	sts = smic_write_cmd_data(sc, SMS_CC_START_TRANSFER, &data[0]);
615 	ErrStat(sts != SMS_SC_WRITE_START, "%s: wstart", __func__);
616 	for (idx = 1; idx < len - 1; idx++) {
617 		sts = smic_write_cmd_data(sc, SMS_CC_NEXT_TRANSFER,
618 		    &data[idx]);
619 		ErrStat(sts != SMS_SC_WRITE_NEXT, "%s: write", __func__);
620 	}
621 	sts = smic_write_cmd_data(sc, SMS_CC_END_TRANSFER, &data[idx]);
622 	if (sts != SMS_SC_WRITE_END) {
623 		dbg_printf(50, "%s: %d/%d = %#.2x\n", __func__, idx, len, sts);
624 		return -1;
625 	}
626 
627 	return 0;
628 }
629 
630 static int
smic_recvmsg(struct ipmi_softc * sc,int maxlen,int * len,uint8_t * data)631 smic_recvmsg(struct ipmi_softc *sc, int maxlen, int *len, uint8_t *data)
632 {
633 	int sts, idx;
634 
635 	*len = 0;
636 	sts = smic_wait(sc, SMIC_RX_DATA_RDY, SMIC_RX_DATA_RDY, __func__);
637 	if (sts < 0)
638 		return -1;
639 
640 	sts = smic_write_cmd_data(sc, SMS_CC_START_RECEIVE, NULL);
641 	ErrStat(sts != SMS_SC_READ_START, "%s: rstart", __func__);
642 	for (idx = 0;; ) {
643 		sts = smic_read_data(sc, &data[idx++]);
644 		if (sts != SMS_SC_READ_START && sts != SMS_SC_READ_NEXT)
645 			break;
646 		smic_write_cmd_data(sc, SMS_CC_NEXT_RECEIVE, NULL);
647 	}
648 	ErrStat(sts != SMS_SC_READ_END, "%s: rend", __func__);
649 
650 	*len = idx;
651 
652 	sts = smic_write_cmd_data(sc, SMS_CC_END_RECEIVE, NULL);
653 	if (sts != SMS_SC_READY) {
654 		dbg_printf(50, "%s: %d/%d = %#.2x\n",
655 		    __func__, idx, maxlen, sts);
656 		return -1;
657 	}
658 
659 	return 0;
660 }
661 
662 static int
smic_reset(struct ipmi_softc * sc)663 smic_reset(struct ipmi_softc *sc)
664 {
665 	return -1;
666 }
667 
668 static int
smic_probe(struct ipmi_softc * sc)669 smic_probe(struct ipmi_softc *sc)
670 {
671 	/* Flag register should not be 0xFF on a good system */
672 	if (bmc_read(sc, _SMIC_FLAG_REG) == 0xFF)
673 		return -1;
674 
675 	return 0;
676 }
677 
678 /*
679  * KCS interface
680  */
681 #define _KCS_DATAIN_REGISTER		0
682 #define _KCS_DATAOUT_REGISTER		0
683 #define	  KCS_READ_NEXT			0x68
684 
685 #define _KCS_COMMAND_REGISTER		1
686 #define	  KCS_GET_STATUS		0x60
687 #define	  KCS_WRITE_START		0x61
688 #define	  KCS_WRITE_END			0x62
689 
690 #define _KCS_STATUS_REGISTER		1
691 #define	  KCS_OBF			(1L << 0)
692 #define	  KCS_IBF			(1L << 1)
693 #define	  KCS_SMS_ATN			(1L << 2)
694 #define	  KCS_CD			(1L << 3)
695 #define	  KCS_OEM1			(1L << 4)
696 #define	  KCS_OEM2			(1L << 5)
697 #define	  KCS_STATE_MASK		0xc0
698 #define	    KCS_IDLE_STATE		0x00
699 #define	    KCS_READ_STATE		0x40
700 #define	    KCS_WRITE_STATE		0x80
701 #define	    KCS_ERROR_STATE		0xC0
702 
703 static int kcs_wait(struct ipmi_softc *, uint8_t, uint8_t, const char *);
704 static int kcs_write_cmd(struct ipmi_softc *, uint8_t);
705 static int kcs_write_data(struct ipmi_softc *, uint8_t);
706 static int kcs_read_data(struct ipmi_softc *, uint8_t *);
707 
708 static int
kcs_wait(struct ipmi_softc * sc,uint8_t mask,uint8_t value,const char * lbl)709 kcs_wait(struct ipmi_softc *sc, uint8_t mask, uint8_t value, const char *lbl)
710 {
711 	int v;
712 
713 	v = bmc_io_wait(sc, _KCS_STATUS_REGISTER, mask, value, lbl);
714 	if (v < 0)
715 		return v;
716 
717 	/* Check if output buffer full, read dummy byte	 */
718 	if ((v & (KCS_OBF | KCS_STATE_MASK)) == (KCS_OBF | KCS_WRITE_STATE))
719 		bmc_read(sc, _KCS_DATAIN_REGISTER);
720 
721 	/* Check for error state */
722 	if ((v & KCS_STATE_MASK) == KCS_ERROR_STATE) {
723 		bmc_write(sc, _KCS_COMMAND_REGISTER, KCS_GET_STATUS);
724 		while (bmc_read(sc, _KCS_STATUS_REGISTER) & KCS_IBF)
725 			;
726 		aprint_error_dev(sc->sc_dev, "error code: %#x\n",
727 		    bmc_read(sc, _KCS_DATAIN_REGISTER));
728 	}
729 
730 	return v & KCS_STATE_MASK;
731 }
732 
733 static int
kcs_write_cmd(struct ipmi_softc * sc,uint8_t cmd)734 kcs_write_cmd(struct ipmi_softc *sc, uint8_t cmd)
735 {
736 	/* ASSERT: IBF and OBF are clear */
737 	dbg_printf(50, "%s: %#.2x\n", __func__, cmd);
738 	bmc_write(sc, _KCS_COMMAND_REGISTER, cmd);
739 
740 	return kcs_wait(sc, KCS_IBF, 0, "write_cmd");
741 }
742 
743 static int
kcs_write_data(struct ipmi_softc * sc,uint8_t data)744 kcs_write_data(struct ipmi_softc *sc, uint8_t data)
745 {
746 	/* ASSERT: IBF and OBF are clear */
747 	dbg_printf(50, "%s: %#.2x\n", __func__, data);
748 	bmc_write(sc, _KCS_DATAOUT_REGISTER, data);
749 
750 	return kcs_wait(sc, KCS_IBF, 0, "write_data");
751 }
752 
753 static int
kcs_read_data(struct ipmi_softc * sc,uint8_t * data)754 kcs_read_data(struct ipmi_softc *sc, uint8_t * data)
755 {
756 	int sts;
757 
758 	sts = kcs_wait(sc, KCS_IBF | KCS_OBF, KCS_OBF, __func__);
759 	if (sts != KCS_READ_STATE)
760 		return sts;
761 
762 	/* ASSERT: OBF is set read data, request next byte */
763 	*data = bmc_read(sc, _KCS_DATAIN_REGISTER);
764 	bmc_write(sc, _KCS_DATAOUT_REGISTER, KCS_READ_NEXT);
765 
766 	dbg_printf(50, "%s: %#.2x\n", __func__, *data);
767 
768 	return sts;
769 }
770 
771 /* Exported KCS functions */
772 static int
kcs_sendmsg(struct ipmi_softc * sc,int len,const uint8_t * data)773 kcs_sendmsg(struct ipmi_softc *sc, int len, const uint8_t * data)
774 {
775 	int idx, sts;
776 
777 	/* ASSERT: IBF is clear */
778 	dbg_dump(50, __func__, len, data);
779 	sts = kcs_write_cmd(sc, KCS_WRITE_START);
780 	for (idx = 0; idx < len; idx++) {
781 		if (idx == len - 1)
782 			sts = kcs_write_cmd(sc, KCS_WRITE_END);
783 
784 		if (sts != KCS_WRITE_STATE)
785 			break;
786 
787 		sts = kcs_write_data(sc, data[idx]);
788 	}
789 	if (sts != KCS_READ_STATE) {
790 		dbg_printf(1, "%s: %d/%d <%#.2x>\n", __func__, idx, len, sts);
791 		dbg_dump(1, __func__, len, data);
792 		return -1;
793 	}
794 
795 	return 0;
796 }
797 
798 static int
kcs_recvmsg(struct ipmi_softc * sc,int maxlen,int * rxlen,uint8_t * data)799 kcs_recvmsg(struct ipmi_softc *sc, int maxlen, int *rxlen, uint8_t * data)
800 {
801 	int idx, sts;
802 
803 	for (idx = 0; idx < maxlen; idx++) {
804 		sts = kcs_read_data(sc, &data[idx]);
805 		if (sts != KCS_READ_STATE)
806 			break;
807 	}
808 	sts = kcs_wait(sc, KCS_IBF, 0, __func__);
809 	*rxlen = idx;
810 	if (sts != KCS_IDLE_STATE) {
811 		dbg_printf(1, "%s: %d/%d <%#.2x>\n",
812 		    __func__, idx, maxlen, sts);
813 		return -1;
814 	}
815 
816 	dbg_dump(50, __func__, idx, data);
817 
818 	return 0;
819 }
820 
821 static int
kcs_reset(struct ipmi_softc * sc)822 kcs_reset(struct ipmi_softc *sc)
823 {
824 	return -1;
825 }
826 
827 static int
kcs_probe(struct ipmi_softc * sc)828 kcs_probe(struct ipmi_softc *sc)
829 {
830 	uint8_t v;
831 
832 	v = bmc_read(sc, _KCS_STATUS_REGISTER);
833 #if 0
834 	printf("%s: %2x\n", __func__, v);
835 	printf(" STS: %2x\n", v & KCS_STATE_MASK);
836 	printf(" ATN: %2x\n", v & KCS_SMS_ATN);
837 	printf(" C/D: %2x\n", v & KCS_CD);
838 	printf(" IBF: %2x\n", v & KCS_IBF);
839 	printf(" OBF: %2x\n", v & KCS_OBF);
840 #else
841 	__USE(v);
842 #endif
843 	return 0;
844 }
845 
846 /*
847  * IPMI code
848  */
849 #define READ_SMS_BUFFER		0x37
850 #define WRITE_I2C		0x50
851 
852 #define GET_MESSAGE_CMD		0x33
853 #define SEND_MESSAGE_CMD	0x34
854 
855 #define IPMB_CHANNEL_NUMBER	0
856 
857 #define PUBLIC_BUS		0
858 
859 #define MIN_I2C_PACKET_SIZE	3
860 #define MIN_IMB_PACKET_SIZE	7	/* one byte for cksum */
861 
862 #define MIN_BTBMC_REQ_SIZE	4
863 #define MIN_BTBMC_RSP_SIZE	5
864 #define MIN_BMC_REQ_SIZE	2
865 #define MIN_BMC_RSP_SIZE	3
866 
867 #define BMC_SA			0x20	/* BMC/ESM3 */
868 #define FPC_SA			0x22	/* front panel */
869 #define BP_SA			0xC0	/* Primary Backplane */
870 #define BP2_SA			0xC2	/* Secondary Backplane */
871 #define PBP_SA			0xC4	/* Peripheral Backplane */
872 #define DRAC_SA			0x28	/* DRAC-III */
873 #define DRAC3_SA		0x30	/* DRAC-III */
874 #define BMC_LUN			0
875 #define SMS_LUN			2
876 
877 struct ipmi_request {
878 	uint8_t	rsSa;
879 	uint8_t	rsLun;
880 	uint8_t	netFn;
881 	uint8_t	cmd;
882 	uint8_t	data_len;
883 	uint8_t	*data;
884 };
885 
886 struct ipmi_response {
887 	uint8_t	cCode;
888 	uint8_t	data_len;
889 	uint8_t	*data;
890 };
891 
892 struct ipmi_bmc_request {
893 	uint8_t	bmc_nfLn;
894 	uint8_t	bmc_cmd;
895 	uint8_t	bmc_data_len;
896 	uint8_t	bmc_data[1];
897 };
898 
899 struct ipmi_bmc_response {
900 	uint8_t	bmc_nfLn;
901 	uint8_t	bmc_cmd;
902 	uint8_t	bmc_cCode;
903 	uint8_t	bmc_data_len;
904 	uint8_t	bmc_data[1];
905 };
906 
907 
908 CFATTACH_DECL2_NEW(ipmi, sizeof(struct ipmi_softc),
909     ipmi_match, ipmi_attach, ipmi_detach, NULL, NULL, NULL);
910 
911 static void
dumpb(const char * lbl,int len,const uint8_t * data)912 dumpb(const char *lbl, int len, const uint8_t *data)
913 {
914 	int idx;
915 
916 	printf("%s: ", lbl);
917 	for (idx = 0; idx < len; idx++)
918 		printf("%.2x ", data[idx]);
919 
920 	printf("\n");
921 }
922 
923 /*
924  * bt_buildmsg builds an IPMI message from a nfLun, cmd, and data
925  * This is used by BT protocol
926  *
927  * Returns a buffer to an allocated message, txlen contains length
928  *   of allocated message
929  */
930 static void *
bt_buildmsg(struct ipmi_softc * sc,int nfLun,int cmd,int len,const void * data,int * txlen)931 bt_buildmsg(struct ipmi_softc *sc, int nfLun, int cmd, int len,
932     const void *data, int *txlen)
933 {
934 	uint8_t *buf;
935 
936 	/* Block transfer needs 4 extra bytes: length/netfn/seq/cmd + data */
937 	*txlen = len + 4;
938 	buf = ipmi_buf_acquire(sc, *txlen);
939 	if (buf == NULL)
940 		return NULL;
941 
942 	buf[IPMI_BTMSG_LEN] = len + 3;
943 	buf[IPMI_BTMSG_NFLN] = nfLun;
944 	buf[IPMI_BTMSG_SEQ] = sc->sc_btseq++;
945 	buf[IPMI_BTMSG_CMD] = cmd;
946 	if (len && data)
947 		memcpy(buf + IPMI_BTMSG_DATASND, data, len);
948 
949 	return buf;
950 }
951 
952 /*
953  * cmn_buildmsg builds an IPMI message from a nfLun, cmd, and data
954  * This is used by both SMIC and KCS protocols
955  *
956  * Returns a buffer to an allocated message, txlen contains length
957  *   of allocated message
958  */
959 static void *
cmn_buildmsg(struct ipmi_softc * sc,int nfLun,int cmd,int len,const void * data,int * txlen)960 cmn_buildmsg(struct ipmi_softc *sc, int nfLun, int cmd, int len,
961     const void *data, int *txlen)
962 {
963 	uint8_t *buf;
964 
965 	/* Common needs two extra bytes: nfLun/cmd + data */
966 	*txlen = len + 2;
967 	buf = ipmi_buf_acquire(sc, *txlen);
968 	if (buf == NULL)
969 		return NULL;
970 
971 	buf[IPMI_MSG_NFLN] = nfLun;
972 	buf[IPMI_MSG_CMD] = cmd;
973 	if (len && data)
974 		memcpy(buf + IPMI_MSG_DATASND, data, len);
975 
976 	return buf;
977 }
978 
979 /*
980  * ipmi_sendcmd: caller must hold sc_cmd_mtx.
981  *
982  * Send an IPMI command
983  */
984 static int
ipmi_sendcmd(struct ipmi_softc * sc,int rssa,int rslun,int netfn,int cmd,int txlen,const void * data)985 ipmi_sendcmd(struct ipmi_softc *sc, int rssa, int rslun, int netfn, int cmd,
986     int txlen, const void *data)
987 {
988 	uint8_t	*buf;
989 	int		rc = -1;
990 
991 	dbg_printf(50, "%s: rssa=%#.2x nfln=%#.2x cmd=%#.2x len=%#.2x\n",
992 	    __func__, rssa, NETFN_LUN(netfn, rslun), cmd, txlen);
993 	dbg_dump(10, __func__, txlen, data);
994 	if (rssa != BMC_SA) {
995 #if 0
996 		buf = sc->sc_if->buildmsg(sc, NETFN_LUN(APP_NETFN, BMC_LUN),
997 		    APP_SEND_MESSAGE, 7 + txlen, NULL, &txlen);
998 		pI2C->bus = (sc->if_ver == 0x09) ?
999 		    PUBLIC_BUS :
1000 		    IPMB_CHANNEL_NUMBER;
1001 
1002 		imbreq->rsSa = rssa;
1003 		imbreq->nfLn = NETFN_LUN(netfn, rslun);
1004 		imbreq->cSum1 = -(imbreq->rsSa + imbreq->nfLn);
1005 		imbreq->rqSa = BMC_SA;
1006 		imbreq->seqLn = NETFN_LUN(sc->imb_seq++, SMS_LUN);
1007 		imbreq->cmd = cmd;
1008 		if (txlen)
1009 			memcpy(imbreq->data, data, txlen);
1010 		/* Set message checksum */
1011 		imbreq->data[txlen] = cksum8(&imbreq->rqSa, txlen + 3);
1012 #endif
1013 		goto done;
1014 	} else
1015 		buf = sc->sc_if->buildmsg(sc, NETFN_LUN(netfn, rslun), cmd,
1016 		    txlen, data, &txlen);
1017 
1018 	if (buf == NULL) {
1019 		aprint_error_dev(sc->sc_dev, "sendcmd buffer busy\n");
1020 		goto done;
1021 	}
1022 	rc = sc->sc_if->sendmsg(sc, txlen, buf);
1023 	ipmi_buf_release(sc, buf);
1024 
1025 	ipmi_delay(sc, 50); /* give bmc chance to digest command */
1026 
1027 done:
1028 	return rc;
1029 }
1030 
1031 static void
ipmi_buf_release(struct ipmi_softc * sc,char * buf)1032 ipmi_buf_release(struct ipmi_softc *sc, char *buf)
1033 {
1034 	KASSERT(sc->sc_buf_rsvd);
1035 	KASSERT(sc->sc_buf == buf);
1036 	sc->sc_buf_rsvd = false;
1037 }
1038 
1039 static char *
ipmi_buf_acquire(struct ipmi_softc * sc,size_t len)1040 ipmi_buf_acquire(struct ipmi_softc *sc, size_t len)
1041 {
1042 	KASSERT(len <= sizeof(sc->sc_buf));
1043 
1044 	if (sc->sc_buf_rsvd || len > sizeof(sc->sc_buf))
1045 		return NULL;
1046 	sc->sc_buf_rsvd = true;
1047 	return sc->sc_buf;
1048 }
1049 
1050 /*
1051  * ipmi_recvcmd: caller must hold sc_cmd_mtx.
1052  */
1053 static int
ipmi_recvcmd(struct ipmi_softc * sc,int maxlen,int * rxlen,void * data)1054 ipmi_recvcmd(struct ipmi_softc *sc, int maxlen, int *rxlen, void *data)
1055 {
1056 	uint8_t	*buf, rc = 0;
1057 	int		rawlen;
1058 
1059 	/* Need three extra bytes: netfn/cmd/ccode + data */
1060 	buf = ipmi_buf_acquire(sc, maxlen + 3);
1061 	if (buf == NULL) {
1062 		aprint_error_dev(sc->sc_dev, "%s: malloc fails\n", __func__);
1063 		return -1;
1064 	}
1065 	/* Receive message from interface, copy out result data */
1066 	if (sc->sc_if->recvmsg(sc, maxlen + 3, &rawlen, buf)) {
1067 		ipmi_buf_release(sc, buf);
1068 		return -1;
1069 	}
1070 
1071 	*rxlen = rawlen >= IPMI_MSG_DATARCV ? rawlen - IPMI_MSG_DATARCV : 0;
1072 	if (*rxlen > 0 && data)
1073 		memcpy(data, buf + IPMI_MSG_DATARCV, *rxlen);
1074 
1075 	if ((rc = buf[IPMI_MSG_CCODE]) != 0)
1076 		dbg_printf(1, "%s: nfln=%#.2x cmd=%#.2x err=%#.2x\n", __func__,
1077 		    buf[IPMI_MSG_NFLN], buf[IPMI_MSG_CMD], buf[IPMI_MSG_CCODE]);
1078 
1079 	dbg_printf(50, "%s: nfln=%#.2x cmd=%#.2x err=%#.2x len=%#.2x\n",
1080 	    __func__, buf[IPMI_MSG_NFLN], buf[IPMI_MSG_CMD],
1081 	    buf[IPMI_MSG_CCODE], *rxlen);
1082 	dbg_dump(10, __func__, *rxlen, data);
1083 
1084 	ipmi_buf_release(sc, buf);
1085 
1086 	return rc;
1087 }
1088 
1089 /*
1090  * ipmi_delay: caller must hold sc_cmd_mtx.
1091  */
1092 static void
ipmi_delay(struct ipmi_softc * sc,int ms)1093 ipmi_delay(struct ipmi_softc *sc, int ms)
1094 {
1095 	if (cold) {
1096 		delay(ms * 1000);
1097 		return;
1098 	}
1099 	mutex_enter(&sc->sc_sleep_mtx);
1100 	cv_timedwait(&sc->sc_cmd_sleep, &sc->sc_sleep_mtx, mstohz(ms));
1101 	mutex_exit(&sc->sc_sleep_mtx);
1102 }
1103 
1104 /* Read a partial SDR entry */
1105 static int
get_sdr_partial(struct ipmi_softc * sc,uint16_t recordId,uint16_t reserveId,uint8_t offset,uint8_t length,void * buffer,uint16_t * nxtRecordId)1106 get_sdr_partial(struct ipmi_softc *sc, uint16_t recordId, uint16_t reserveId,
1107     uint8_t offset, uint8_t length, void *buffer, uint16_t *nxtRecordId)
1108 {
1109 	uint8_t	cmd[256 + 8];
1110 	int		len;
1111 
1112 	((uint16_t *) cmd)[0] = reserveId;
1113 	((uint16_t *) cmd)[1] = recordId;
1114 	cmd[4] = offset;
1115 	cmd[5] = length;
1116 	mutex_enter(&sc->sc_cmd_mtx);
1117 	if (ipmi_sendcmd(sc, BMC_SA, 0, STORAGE_NETFN, STORAGE_GET_SDR, 6,
1118 	    cmd)) {
1119 		mutex_exit(&sc->sc_cmd_mtx);
1120 		aprint_error_dev(sc->sc_dev, "%s: sendcmd fails\n", __func__);
1121 		return -1;
1122 	}
1123 	if (ipmi_recvcmd(sc, 8 + length, &len, cmd)) {
1124 		mutex_exit(&sc->sc_cmd_mtx);
1125 		aprint_error_dev(sc->sc_dev, "%s: recvcmd fails\n", __func__);
1126 		return -1;
1127 	}
1128 	mutex_exit(&sc->sc_cmd_mtx);
1129 	if (nxtRecordId)
1130 		*nxtRecordId = *(uint16_t *) cmd;
1131 	memcpy(buffer, cmd + 2, len - 2);
1132 
1133 	return 0;
1134 }
1135 
1136 static int maxsdrlen = 0x10;
1137 
1138 /* Read an entire SDR; pass to add sensor */
1139 static int
get_sdr(struct ipmi_softc * sc,uint16_t recid,uint16_t * nxtrec)1140 get_sdr(struct ipmi_softc *sc, uint16_t recid, uint16_t *nxtrec)
1141 {
1142 	uint16_t	resid = 0;
1143 	int		len, sdrlen, offset;
1144 	uint8_t	*psdr;
1145 	struct sdrhdr	shdr;
1146 
1147 	mutex_enter(&sc->sc_cmd_mtx);
1148 	/* Reserve SDR */
1149 	if (ipmi_sendcmd(sc, BMC_SA, 0, STORAGE_NETFN, STORAGE_RESERVE_SDR,
1150 	    0, NULL)) {
1151 		mutex_exit(&sc->sc_cmd_mtx);
1152 		aprint_error_dev(sc->sc_dev, "reserve send fails\n");
1153 		return -1;
1154 	}
1155 	if (ipmi_recvcmd(sc, sizeof(resid), &len, &resid)) {
1156 		mutex_exit(&sc->sc_cmd_mtx);
1157 		aprint_error_dev(sc->sc_dev, "reserve recv fails\n");
1158 		return -1;
1159 	}
1160 	mutex_exit(&sc->sc_cmd_mtx);
1161 	/* Get SDR Header */
1162 	if (get_sdr_partial(sc, recid, resid, 0, sizeof shdr, &shdr, nxtrec)) {
1163 		aprint_error_dev(sc->sc_dev, "get header fails\n");
1164 		return -1;
1165 	}
1166 	/* Allocate space for entire SDR Length of SDR in header does not
1167 	 * include header length */
1168 	sdrlen = sizeof(shdr) + shdr.record_length;
1169 	psdr = malloc(sdrlen, M_DEVBUF, M_WAITOK);
1170 	if (psdr == NULL)
1171 		return -1;
1172 
1173 	memcpy(psdr, &shdr, sizeof(shdr));
1174 
1175 	/* Read SDR Data maxsdrlen bytes at a time */
1176 	for (offset = sizeof(shdr); offset < sdrlen; offset += maxsdrlen) {
1177 		len = sdrlen - offset;
1178 		if (len > maxsdrlen)
1179 			len = maxsdrlen;
1180 
1181 		if (get_sdr_partial(sc, recid, resid, offset, len,
1182 		    psdr + offset, NULL)) {
1183 			aprint_error_dev(sc->sc_dev,
1184 			    "get chunk : %d,%d fails\n", offset, len);
1185 			free(psdr, M_DEVBUF);
1186 			return -1;
1187 		}
1188 	}
1189 
1190 	/* Add SDR to sensor list, if not wanted, free buffer */
1191 	if (add_sdr_sensor(sc, psdr) == 0)
1192 		free(psdr, M_DEVBUF);
1193 
1194 	return 0;
1195 }
1196 
1197 static int
getbits(uint8_t * bytes,int bitpos,int bitlen)1198 getbits(uint8_t *bytes, int bitpos, int bitlen)
1199 {
1200 	int	v;
1201 	int	mask;
1202 
1203 	bitpos += bitlen - 1;
1204 	for (v = 0; bitlen--;) {
1205 		v <<= 1;
1206 		mask = 1L << (bitpos & 7);
1207 		if (bytes[bitpos >> 3] & mask)
1208 			v |= 1;
1209 		bitpos--;
1210 	}
1211 
1212 	return v;
1213 }
1214 
1215 /* Decode IPMI sensor name */
1216 static void
ipmi_sensor_name(char * name,int len,uint8_t typelen,uint8_t * bits)1217 ipmi_sensor_name(char *name, int len, uint8_t typelen, uint8_t *bits)
1218 {
1219 	int	i, slen;
1220 	char	bcdplus[] = "0123456789 -.:,_";
1221 
1222 	slen = typelen & 0x1F;
1223 	switch (typelen >> 6) {
1224 	case IPMI_NAME_UNICODE:
1225 		//unicode
1226 		break;
1227 
1228 	case IPMI_NAME_BCDPLUS:
1229 		/* Characters are encoded in 4-bit BCDPLUS */
1230 		if (len < slen * 2 + 1)
1231 			slen = (len >> 1) - 1;
1232 		for (i = 0; i < slen; i++) {
1233 			*(name++) = bcdplus[bits[i] >> 4];
1234 			*(name++) = bcdplus[bits[i] & 0xF];
1235 		}
1236 		break;
1237 
1238 	case IPMI_NAME_ASCII6BIT:
1239 		/* Characters are encoded in 6-bit ASCII
1240 		 *   0x00 - 0x3F maps to 0x20 - 0x5F */
1241 		/* XXX: need to calculate max len: slen = 3/4 * len */
1242 		if (len < slen + 1)
1243 			slen = len - 1;
1244 		for (i = 0; i < slen * 8; i += 6)
1245 			*(name++) = getbits(bits, i, 6) + ' ';
1246 		break;
1247 
1248 	case IPMI_NAME_ASCII8BIT:
1249 		/* Characters are 8-bit ascii */
1250 		if (len < slen + 1)
1251 			slen = len - 1;
1252 		while (slen--)
1253 			*(name++) = *(bits++);
1254 		break;
1255 	}
1256 	*name = 0;
1257 }
1258 
1259 /* Sign extend a n-bit value */
1260 static long
signextend(unsigned long val,int bits)1261 signextend(unsigned long val, int bits)
1262 {
1263 	long msk = (1L << (bits-1))-1;
1264 
1265 	return -(val & ~msk) | val;
1266 }
1267 
1268 
1269 /* fixpoint arithmetic */
1270 #define FIX2INT(x)   ((int64_t)((x) >> 32))
1271 #define INT2FIX(x)   ((int64_t)((uint64_t)(x) << 32))
1272 
1273 #define FIX2            0x0000000200000000ll /* 2.0 */
1274 #define FIX3            0x0000000300000000ll /* 3.0 */
1275 #define FIXE            0x00000002b7e15163ll /* 2.71828182845904523536 */
1276 #define FIX10           0x0000000a00000000ll /* 10.0 */
1277 #define FIXMONE         0xffffffff00000000ll /* -1.0 */
1278 #define FIXHALF         0x0000000080000000ll /* 0.5 */
1279 #define FIXTHIRD        0x0000000055555555ll /* 0.33333333333333333333 */
1280 
1281 #define FIX1LOG2        0x0000000171547653ll /* 1.0/log(2) */
1282 #define FIX1LOGE        0x0000000100000000ll /* 1.0/log(2.71828182845904523536) */
1283 #define FIX1LOG10       0x000000006F2DEC55ll /* 1.0/log(10) */
1284 
1285 #define FIX1E           0x000000005E2D58D9ll /* 1.0/2.71828182845904523536 */
1286 
1287 static int64_t fixlog_a[] = {
1288 	0x0000000100000000ll /* 1.0/1.0 */,
1289 	0xffffffff80000000ll /* -1.0/2.0 */,
1290 	0x0000000055555555ll /* 1.0/3.0 */,
1291 	0xffffffffc0000000ll /* -1.0/4.0 */,
1292 	0x0000000033333333ll /* 1.0/5.0 */,
1293 	0x000000002aaaaaabll /* -1.0/6.0 */,
1294 	0x0000000024924925ll /* 1.0/7.0 */,
1295 	0x0000000020000000ll /* -1.0/8.0 */,
1296 	0x000000001c71c71cll /* 1.0/9.0 */
1297 };
1298 
1299 static int64_t fixexp_a[] = {
1300 	0x0000000100000000ll /* 1.0/1.0 */,
1301 	0x0000000100000000ll /* 1.0/1.0 */,
1302 	0x0000000080000000ll /* 1.0/2.0 */,
1303 	0x000000002aaaaaabll /* 1.0/6.0 */,
1304 	0x000000000aaaaaabll /* 1.0/24.0 */,
1305 	0x0000000002222222ll /* 1.0/120.0 */,
1306 	0x00000000005b05b0ll /* 1.0/720.0 */,
1307 	0x00000000000d00d0ll /* 1.0/5040.0 */,
1308 	0x000000000001a01all /* 1.0/40320.0 */
1309 };
1310 
1311 static int64_t
fixmul(int64_t x,int64_t y)1312 fixmul(int64_t x, int64_t y)
1313 {
1314 	int64_t z;
1315 	int64_t a,b,c,d;
1316 	int neg;
1317 
1318 	neg = 0;
1319 	if (x < 0) {
1320 		x = -x;
1321 		neg = !neg;
1322 	}
1323 	if (y < 0) {
1324 		y = -y;
1325 		neg = !neg;
1326 	}
1327 
1328 	a = FIX2INT(x);
1329 	b = x - INT2FIX(a);
1330 	c = FIX2INT(y);
1331 	d = y - INT2FIX(c);
1332 
1333 	z = INT2FIX(a*c) + a * d + b * c + (b/2 * d/2 >> 30);
1334 
1335 	return neg ? -z : z;
1336 }
1337 
1338 static int64_t
poly(int64_t x0,int64_t x,int64_t a[],int n)1339 poly(int64_t x0, int64_t x, int64_t a[], int n)
1340 {
1341 	int64_t z;
1342 	int i;
1343 
1344 	z  = fixmul(x0, a[0]);
1345 	for (i=1; i<n; ++i) {
1346 		x0 = fixmul(x0, x);
1347 		z  = fixmul(x0, a[i]) + z;
1348 	}
1349 	return z;
1350 }
1351 
1352 static int64_t
logx(int64_t x,int64_t y)1353 logx(int64_t x, int64_t y)
1354 {
1355 	int64_t z;
1356 
1357 	if (x <= INT2FIX(0)) {
1358 		z = INT2FIX(-99999);
1359 		goto done;
1360 	}
1361 
1362 	z = INT2FIX(0);
1363 	while (x >= FIXE) {
1364 		x = fixmul(x, FIX1E);
1365 		z += INT2FIX(1);
1366 	}
1367 	while (x < INT2FIX(1)) {
1368 		x = fixmul(x, FIXE);
1369 		z -= INT2FIX(1);
1370 	}
1371 
1372 	x -= INT2FIX(1);
1373 	z += poly(x, x, fixlog_a, sizeof(fixlog_a)/sizeof(fixlog_a[0]));
1374 	z  = fixmul(z, y);
1375 
1376 done:
1377 	return z;
1378 }
1379 
1380 static int64_t
powx(int64_t x,int64_t y)1381 powx(int64_t x, int64_t y)
1382 {
1383 	int64_t k;
1384 
1385 	if (x == INT2FIX(0))
1386 		goto done;
1387 
1388 	x = logx(x,y);
1389 
1390 	if (x < INT2FIX(0)) {
1391 		x = INT2FIX(0) - x;
1392 		k = -FIX2INT(x);
1393 		x = INT2FIX(-k) - x;
1394 	} else {
1395 		k = FIX2INT(x);
1396 		x = x - INT2FIX(k);
1397 	}
1398 
1399 	x = poly(INT2FIX(1), x, fixexp_a, sizeof(fixexp_a)/sizeof(fixexp_a[0]));
1400 
1401 	while (k < 0) {
1402 		x = fixmul(x, FIX1E);
1403 		++k;
1404 	}
1405 	while (k > 0) {
1406 		x = fixmul(x, FIXE);
1407 		--k;
1408 	}
1409 
1410 done:
1411 	return x;
1412 }
1413 
1414 /* Convert IPMI reading from sensor factors */
1415 static long
ipmi_convert(uint8_t v,struct sdrtype1 * s1,long adj)1416 ipmi_convert(uint8_t v, struct sdrtype1 *s1, long adj)
1417 {
1418 	int64_t	M, B;
1419 	char	K1, K2;
1420 	int64_t	val, v1, v2, vs;
1421 	int sign = (s1->units1 >> 6) & 0x3;
1422 
1423 	vs = (sign == 0x1 || sign == 0x2) ? (int8_t)v : v;
1424 	if ((vs < 0) && (sign == 0x1))
1425 		vs++;
1426 
1427 	/* Calculate linear reading variables */
1428 	M  = signextend((((short)(s1->m_tolerance & 0xC0)) << 2) + s1->m, 10);
1429 	B  = signextend((((short)(s1->b_accuracy & 0xC0)) << 2) + s1->b, 10);
1430 	K1 = signextend(s1->rbexp & 0xF, 4);
1431 	K2 = signextend(s1->rbexp >> 4, 4);
1432 
1433 	/* Calculate sensor reading:
1434 	 *  y = L((M * v + (B * 10^K1)) * 10^(K2+adj)
1435 	 *
1436 	 * This commutes out to:
1437 	 *  y = L(M*v * 10^(K2+adj) + B * 10^(K1+K2+adj)); */
1438 	v1 = powx(FIX10, INT2FIX(K2 + adj));
1439 	v2 = powx(FIX10, INT2FIX(K1 + K2 + adj));
1440 	val = M * vs * v1 + B * v2;
1441 
1442 	/* Linearization function: y = f(x) 0 : y = x 1 : y = ln(x) 2 : y =
1443 	 * log10(x) 3 : y = log2(x) 4 : y = e^x 5 : y = 10^x 6 : y = 2^x 7 : y
1444 	 * = 1/x 8 : y = x^2 9 : y = x^3 10 : y = square root(x) 11 : y = cube
1445 	 * root(x) */
1446 	switch (s1->linear & 0x7f) {
1447 	case 0: break;
1448 	case 1: val = logx(val,FIX1LOGE); break;
1449 	case 2: val = logx(val,FIX1LOG10); break;
1450 	case 3: val = logx(val,FIX1LOG2); break;
1451 	case 4: val = powx(FIXE,val); break;
1452 	case 5: val = powx(FIX10,val); break;
1453 	case 6: val = powx(FIX2,val); break;
1454 	case 7: val = powx(val,FIXMONE); break;
1455 	case 8: val = powx(val,FIX2); break;
1456 	case 9: val = powx(val,FIX3); break;
1457 	case 10: val = powx(val,FIXHALF); break;
1458 	case 11: val = powx(val,FIXTHIRD); break;
1459 	}
1460 
1461 	return FIX2INT(val);
1462 }
1463 
1464 static int32_t
ipmi_convert_sensor(uint8_t * reading,struct ipmi_sensor * psensor)1465 ipmi_convert_sensor(uint8_t *reading, struct ipmi_sensor *psensor)
1466 {
1467 	struct sdrtype1	*s1 = (struct sdrtype1 *)psensor->i_sdr;
1468 	int32_t val;
1469 
1470 	switch (psensor->i_envtype) {
1471 	case ENVSYS_STEMP:
1472 		val = ipmi_convert(reading[0], s1, 6) + 273150000;
1473 		break;
1474 
1475 	case ENVSYS_SVOLTS_DC:
1476 		val = ipmi_convert(reading[0], s1, 6);
1477 		break;
1478 
1479 	case ENVSYS_SFANRPM:
1480 		val = ipmi_convert(reading[0], s1, 0);
1481 		if (((s1->units1>>3)&0x7) == 0x3)
1482 			val *= 60; /* RPS -> RPM */
1483 		break;
1484 	default:
1485 		val = 0;
1486 		break;
1487 	}
1488 	return val;
1489 }
1490 
1491 static void
ipmi_set_limits(struct sysmon_envsys * sme,envsys_data_t * edata,sysmon_envsys_lim_t * limits,uint32_t * props)1492 ipmi_set_limits(struct sysmon_envsys *sme, envsys_data_t *edata,
1493 		sysmon_envsys_lim_t *limits, uint32_t *props)
1494 {
1495 	struct ipmi_sensor *ipmi_s;
1496 
1497 	/* Find the ipmi_sensor corresponding to this edata */
1498 	SLIST_FOREACH(ipmi_s, &ipmi_sensor_list, i_list) {
1499 		if (ipmi_s->i_envnum == edata->sensor) {
1500 			if (limits == NULL) {
1501 				limits = &ipmi_s->i_deflims;
1502 				props  = &ipmi_s->i_defprops;
1503 			}
1504 			*props |= PROP_DRIVER_LIMITS;
1505 			ipmi_s->i_limits = *limits;
1506 			ipmi_s->i_props  = *props;
1507 			return;
1508 		}
1509 	}
1510 	return;
1511 }
1512 
1513 static void
ipmi_get_limits(struct sysmon_envsys * sme,envsys_data_t * edata,sysmon_envsys_lim_t * limits,uint32_t * props)1514 ipmi_get_limits(struct sysmon_envsys *sme, envsys_data_t *edata,
1515 		sysmon_envsys_lim_t *limits, uint32_t *props)
1516 {
1517 	struct ipmi_sensor *ipmi_s;
1518 	struct ipmi_softc *sc = sme->sme_cookie;
1519 
1520 	/* Find the ipmi_sensor corresponding to this edata */
1521 	SLIST_FOREACH(ipmi_s, &ipmi_sensor_list, i_list) {
1522 		if (ipmi_s->i_envnum == edata->sensor) {
1523 			ipmi_get_sensor_limits(sc, ipmi_s, limits, props);
1524 			ipmi_s->i_limits = *limits;
1525 			ipmi_s->i_props  = *props;
1526 			if (ipmi_s->i_defprops == 0) {
1527 				ipmi_s->i_defprops = *props;
1528 				ipmi_s->i_deflims  = *limits;
1529 			}
1530 			return;
1531 		}
1532 	}
1533 	return;
1534 }
1535 
1536 /* valid bits for (upper,lower) x (non-recoverable, critical, warn) */
1537 #define UN	0x20
1538 #define UC	0x10
1539 #define UW	0x08
1540 #define LN	0x04
1541 #define LC	0x02
1542 #define LW	0x01
1543 
1544 static void
ipmi_get_sensor_limits(struct ipmi_softc * sc,struct ipmi_sensor * psensor,sysmon_envsys_lim_t * limits,uint32_t * props)1545 ipmi_get_sensor_limits(struct ipmi_softc *sc, struct ipmi_sensor *psensor,
1546 		       sysmon_envsys_lim_t *limits, uint32_t *props)
1547 {
1548 	struct sdrtype1	*s1 = (struct sdrtype1 *)psensor->i_sdr;
1549 	bool failure;
1550 	int	rxlen;
1551 	uint8_t	data[32], valid;
1552 	uint32_t prop_critmax, prop_warnmax, prop_critmin, prop_warnmin;
1553 	int32_t *pcritmax, *pwarnmax, *pcritmin, *pwarnmin;
1554 
1555 	*props &= ~(PROP_CRITMIN | PROP_CRITMAX | PROP_WARNMIN | PROP_WARNMAX);
1556 	data[0] = psensor->i_num;
1557 	mutex_enter(&sc->sc_cmd_mtx);
1558 	failure =
1559 	    ipmi_sendcmd(sc, s1->owner_id, s1->owner_lun,
1560 			 SE_NETFN, SE_GET_SENSOR_THRESHOLD, 1, data) ||
1561 	    ipmi_recvcmd(sc, sizeof(data), &rxlen, data);
1562 	mutex_exit(&sc->sc_cmd_mtx);
1563 	if (failure)
1564 		return;
1565 
1566 	dbg_printf(25, "%s: %#.2x %#.2x %#.2x %#.2x %#.2x %#.2x %#.2x\n",
1567 	    __func__, data[0], data[1], data[2], data[3], data[4], data[5],
1568 	    data[6]);
1569 
1570 	switch (s1->linear & 0x7f) {
1571 	case 7: /* 1/x sensor, exchange upper and lower limits */
1572 		prop_critmax = PROP_CRITMIN;
1573 		prop_warnmax = PROP_WARNMIN;
1574 		prop_critmin = PROP_CRITMAX;
1575 		prop_warnmin = PROP_WARNMAX;
1576 		pcritmax = &limits->sel_critmin;
1577 		pwarnmax = &limits->sel_warnmin;
1578 		pcritmin = &limits->sel_critmax;
1579 		pwarnmin = &limits->sel_warnmax;
1580 		break;
1581 	default:
1582 		prop_critmax = PROP_CRITMAX;
1583 		prop_warnmax = PROP_WARNMAX;
1584 		prop_critmin = PROP_CRITMIN;
1585 		prop_warnmin = PROP_WARNMIN;
1586 		pcritmax = &limits->sel_critmax;
1587 		pwarnmax = &limits->sel_warnmax;
1588 		pcritmin = &limits->sel_critmin;
1589 		pwarnmin = &limits->sel_warnmin;
1590 		break;
1591 	}
1592 
1593 	valid = data[0];
1594 
1595 	/* if upper non-recoverable < warning, ignore it */
1596 	if ((valid & (UN|UW)) == (UN|UW) && data[6] < data[4])
1597 		valid ^= UN;
1598 	/* if upper critical < warning, ignore it */
1599 	if ((valid & (UC|UW)) == (UC|UW) && data[5] < data[4])
1600 		valid ^= UC;
1601 
1602 	/* if lower non-recoverable > warning, ignore it */
1603 	if ((data[0] & (LN|LW)) == (LN|LW) && data[3] > data[1])
1604 		valid ^= LN;
1605 	/* if lower critical > warning, ignore it */
1606 	if ((data[0] & (LC|LW)) == (LC|LW) && data[2] > data[1])
1607 		valid ^= LC;
1608 
1609 	if (valid & UN && data[6] != 0xff) {
1610 		*pcritmax = ipmi_convert_sensor(&data[6], psensor);
1611 		*props |= prop_critmax;
1612 	}
1613 	if (valid & UC && data[5] != 0xff) {
1614 		*pcritmax = ipmi_convert_sensor(&data[5], psensor);
1615 		*props |= prop_critmax;
1616 	}
1617 	if (valid & UW && data[4] != 0xff) {
1618 		*pwarnmax = ipmi_convert_sensor(&data[4], psensor);
1619 		*props |= prop_warnmax;
1620 	}
1621 	if (valid & LN && data[3] != 0x00) {
1622 		*pcritmin = ipmi_convert_sensor(&data[3], psensor);
1623 		*props |= prop_critmin;
1624 	}
1625 	if (valid & LC && data[2] != 0x00) {
1626 		*pcritmin = ipmi_convert_sensor(&data[2], psensor);
1627 		*props |= prop_critmin;
1628 	}
1629 	if (valid & LW && data[1] != 0x00) {
1630 		*pwarnmin = ipmi_convert_sensor(&data[1], psensor);
1631 		*props |= prop_warnmin;
1632 	}
1633 	return;
1634 }
1635 
1636 static int
ipmi_sensor_status(struct ipmi_softc * sc,struct ipmi_sensor * psensor,envsys_data_t * edata,uint8_t * reading)1637 ipmi_sensor_status(struct ipmi_softc *sc, struct ipmi_sensor *psensor,
1638     envsys_data_t *edata, uint8_t *reading)
1639 {
1640 	int	etype;
1641 
1642 	/* Get reading of sensor */
1643 	edata->value_cur = ipmi_convert_sensor(reading, psensor);
1644 
1645 	/* Return Sensor Status */
1646 	etype = (psensor->i_etype << 8) + psensor->i_stype;
1647 	switch (etype) {
1648 	case IPMI_SENSOR_TYPE_TEMP:
1649 	case IPMI_SENSOR_TYPE_VOLT:
1650 	case IPMI_SENSOR_TYPE_FAN:
1651 		if (psensor->i_props & PROP_CRITMAX &&
1652 		    edata->value_cur > psensor->i_limits.sel_critmax)
1653 			return ENVSYS_SCRITOVER;
1654 
1655 		if (psensor->i_props & PROP_WARNMAX &&
1656 		    edata->value_cur > psensor->i_limits.sel_warnmax)
1657 			return ENVSYS_SWARNOVER;
1658 
1659 		if (psensor->i_props & PROP_CRITMIN &&
1660 		    edata->value_cur < psensor->i_limits.sel_critmin)
1661 			return ENVSYS_SCRITUNDER;
1662 
1663 		if (psensor->i_props & PROP_WARNMIN &&
1664 		    edata->value_cur < psensor->i_limits.sel_warnmin)
1665 			return ENVSYS_SWARNUNDER;
1666 
1667 		break;
1668 
1669 	case IPMI_SENSOR_TYPE_INTRUSION:
1670 		edata->value_cur = (reading[2] & 1) ? 0 : 1;
1671 		if (reading[2] & 0x1)
1672 			return ENVSYS_SCRITICAL;
1673 		break;
1674 
1675 	case IPMI_SENSOR_TYPE_PWRSUPPLY:
1676 		/* Reading: 1 = present+powered, 0 = otherwise */
1677 		edata->value_cur = (reading[2] & 1) ? 0 : 1;
1678 		if (reading[2] & 0x10) {
1679 			/* XXX: Need envsys type for Power Supply types
1680 			 *   ok: power supply installed && powered
1681 			 * warn: power supply installed && !powered
1682 			 * crit: power supply !installed
1683 			 */
1684 			return ENVSYS_SCRITICAL;
1685 		}
1686 		if (reading[2] & 0x08) {
1687 			/* Power supply AC lost */
1688 			return ENVSYS_SWARNOVER;
1689 		}
1690 		break;
1691 	}
1692 
1693 	return ENVSYS_SVALID;
1694 }
1695 
1696 static int
read_sensor(struct ipmi_softc * sc,struct ipmi_sensor * psensor)1697 read_sensor(struct ipmi_softc *sc, struct ipmi_sensor *psensor)
1698 {
1699 	struct sdrtype1	*s1 = (struct sdrtype1 *) psensor->i_sdr;
1700 	uint8_t	data[8];
1701 	int		rxlen;
1702 	envsys_data_t *edata = &sc->sc_sensor[psensor->i_envnum];
1703 
1704 	memset(data, 0, sizeof(data));
1705 	data[0] = psensor->i_num;
1706 
1707 	mutex_enter(&sc->sc_cmd_mtx);
1708 	if (ipmi_sendcmd(sc, s1->owner_id, s1->owner_lun, SE_NETFN,
1709 	    SE_GET_SENSOR_READING, 1, data))
1710 		goto err;
1711 
1712 	if (ipmi_recvcmd(sc, sizeof(data), &rxlen, data))
1713 		goto err;
1714 	mutex_exit(&sc->sc_cmd_mtx);
1715 
1716 	dbg_printf(10, "m=%u, m_tolerance=%u, b=%u, b_accuracy=%u, "
1717 	    "rbexp=%u, linear=%d\n", s1->m, s1->m_tolerance, s1->b,
1718 	    s1->b_accuracy, s1->rbexp, s1->linear);
1719 	dbg_printf(10, "values=%#.2x %#.2x %#.2x %#.2x %s\n",
1720 	    data[0],data[1],data[2],data[3], edata->desc);
1721 	if (IPMI_INVALID_SENSOR_P(data[1])) {
1722 		/* Check if sensor is valid */
1723 		edata->state = ENVSYS_SINVALID;
1724 	} else {
1725 		edata->state = ipmi_sensor_status(sc, psensor, edata, data);
1726 	}
1727 	return 0;
1728 err:
1729 	mutex_exit(&sc->sc_cmd_mtx);
1730 	return -1;
1731 }
1732 
1733 static int
ipmi_sensor_type(int type,int ext_type,int entity)1734 ipmi_sensor_type(int type, int ext_type, int entity)
1735 {
1736 	switch (ext_type << 8L | type) {
1737 	case IPMI_SENSOR_TYPE_TEMP:
1738 		return ENVSYS_STEMP;
1739 
1740 	case IPMI_SENSOR_TYPE_VOLT:
1741 		return ENVSYS_SVOLTS_DC;
1742 
1743 	case IPMI_SENSOR_TYPE_FAN:
1744 		return ENVSYS_SFANRPM;
1745 
1746 	case IPMI_SENSOR_TYPE_PWRSUPPLY:
1747 		if (entity == IPMI_ENTITY_PWRSUPPLY)
1748 			return ENVSYS_INDICATOR;
1749 		break;
1750 
1751 	case IPMI_SENSOR_TYPE_INTRUSION:
1752 		return ENVSYS_INDICATOR;
1753 	}
1754 
1755 	return -1;
1756 }
1757 
1758 /* Add Sensor to BSD Sysctl interface */
1759 static int
add_sdr_sensor(struct ipmi_softc * sc,uint8_t * psdr)1760 add_sdr_sensor(struct ipmi_softc *sc, uint8_t *psdr)
1761 {
1762 	int			rc;
1763 	struct sdrtype1		*s1 = (struct sdrtype1 *)psdr;
1764 	struct sdrtype2		*s2 = (struct sdrtype2 *)psdr;
1765 	char			name[64];
1766 
1767 	switch (s1->sdrhdr.record_type) {
1768 	case IPMI_SDR_TYPEFULL:
1769 		ipmi_sensor_name(name, sizeof(name), s1->typelen, s1->name);
1770 		rc = add_child_sensors(sc, psdr, 1, s1->sensor_num,
1771 		    s1->sensor_type, s1->event_code, 0, s1->entity_id, name);
1772 		break;
1773 
1774 	case IPMI_SDR_TYPECOMPACT:
1775 		ipmi_sensor_name(name, sizeof(name), s2->typelen, s2->name);
1776 		rc = add_child_sensors(sc, psdr, s2->share1 & 0xF,
1777 		    s2->sensor_num, s2->sensor_type, s2->event_code,
1778 		    s2->share2 & 0x7F, s2->entity_id, name);
1779 		break;
1780 
1781 	default:
1782 		return 0;
1783 	}
1784 
1785 	return rc;
1786 }
1787 
1788 static int
ipmi_is_dupname(char * name)1789 ipmi_is_dupname(char *name)
1790 {
1791 	struct ipmi_sensor *ipmi_s;
1792 
1793 	SLIST_FOREACH(ipmi_s, &ipmi_sensor_list, i_list) {
1794 		if (strcmp(ipmi_s->i_envdesc, name) == 0) {
1795 			return 1;
1796 		}
1797 	}
1798 	return 0;
1799 }
1800 
1801 static int
add_child_sensors(struct ipmi_softc * sc,uint8_t * psdr,int count,int sensor_num,int sensor_type,int ext_type,int sensor_base,int entity,const char * name)1802 add_child_sensors(struct ipmi_softc *sc, uint8_t *psdr, int count,
1803     int sensor_num, int sensor_type, int ext_type, int sensor_base,
1804     int entity, const char *name)
1805 {
1806 	int			typ, idx, dupcnt, c;
1807 	char			*e;
1808 	struct ipmi_sensor	*psensor;
1809 	struct sdrtype1		*s1 = (struct sdrtype1 *)psdr;
1810 
1811 	typ = ipmi_sensor_type(sensor_type, ext_type, entity);
1812 	if (typ == -1) {
1813 		dbg_printf(5, "Unknown sensor type:%#.2x et:%#.2x sn:%#.2x "
1814 		    "name:%s\n", sensor_type, ext_type, sensor_num, name);
1815 		return 0;
1816 	}
1817 	dupcnt = 0;
1818 	sc->sc_nsensors += count;
1819 	for (idx = 0; idx < count; idx++) {
1820 		psensor = malloc(sizeof(struct ipmi_sensor), M_DEVBUF,
1821 		    M_WAITOK);
1822 		if (psensor == NULL)
1823 			break;
1824 
1825 		memset(psensor, 0, sizeof(struct ipmi_sensor));
1826 
1827 		/* Initialize BSD Sensor info */
1828 		psensor->i_sdr = psdr;
1829 		psensor->i_num = sensor_num + idx;
1830 		psensor->i_stype = sensor_type;
1831 		psensor->i_etype = ext_type;
1832 		psensor->i_envtype = typ;
1833 		if (count > 1)
1834 			snprintf(psensor->i_envdesc,
1835 			    sizeof(psensor->i_envdesc),
1836 			    "%s - %d", name, sensor_base + idx);
1837 		else
1838 			strlcpy(psensor->i_envdesc, name,
1839 			    sizeof(psensor->i_envdesc));
1840 
1841 		/*
1842 		 * Check for duplicates.  If there are duplicates,
1843 		 * make sure there is space in the name (if not,
1844 		 * truncate to make space) for a count (1-99) to
1845 		 * add to make the name unique.  If we run the
1846 		 * counter out, just accept the duplicate (@name99)
1847 		 * for now.
1848 		 */
1849 		if (ipmi_is_dupname(psensor->i_envdesc)) {
1850 			if (strlen(psensor->i_envdesc) >=
1851 			    sizeof(psensor->i_envdesc) - 3) {
1852 				e = psensor->i_envdesc +
1853 				    sizeof(psensor->i_envdesc) - 3;
1854 			} else {
1855 				e = psensor->i_envdesc +
1856 				    strlen(psensor->i_envdesc);
1857 			}
1858 			c = psensor->i_envdesc +
1859 			    sizeof(psensor->i_envdesc) - e;
1860 			do {
1861 				dupcnt++;
1862 				snprintf(e, c, "%d", dupcnt);
1863 			} while (dupcnt < 100 &&
1864 			         ipmi_is_dupname(psensor->i_envdesc));
1865 		}
1866 
1867 		dbg_printf(5, "%s: %#.4x %#.2x:%d ent:%#.2x:%#.2x %s\n",
1868 		    __func__,
1869 		    s1->sdrhdr.record_id, s1->sensor_type,
1870 		    typ, s1->entity_id, s1->entity_instance,
1871 		    psensor->i_envdesc);
1872 		SLIST_INSERT_HEAD(&ipmi_sensor_list, psensor, i_list);
1873 	}
1874 
1875 	return 1;
1876 }
1877 
1878 #if 0
1879 /* Interrupt handler */
1880 static int
1881 ipmi_intr(void *arg)
1882 {
1883 	struct ipmi_softc	*sc = (struct ipmi_softc *)arg;
1884 	int			v;
1885 
1886 	v = bmc_read(sc, _KCS_STATUS_REGISTER);
1887 	if (v & KCS_OBF)
1888 		++ipmi_nintr;
1889 
1890 	return 0;
1891 }
1892 #endif
1893 
1894 /* Handle IPMI Timer - reread sensor values */
1895 static void
ipmi_refresh_sensors(struct ipmi_softc * sc)1896 ipmi_refresh_sensors(struct ipmi_softc *sc)
1897 {
1898 
1899 	if (SLIST_EMPTY(&ipmi_sensor_list))
1900 		return;
1901 
1902 	sc->current_sensor = SLIST_NEXT(sc->current_sensor, i_list);
1903 	if (sc->current_sensor == NULL)
1904 		sc->current_sensor = SLIST_FIRST(&ipmi_sensor_list);
1905 
1906 	if (read_sensor(sc, sc->current_sensor)) {
1907 		dbg_printf(1, "%s: error reading\n", __func__);
1908 	}
1909 }
1910 
1911 static int
ipmi_map_regs(struct ipmi_softc * sc,struct ipmi_attach_args * ia)1912 ipmi_map_regs(struct ipmi_softc *sc, struct ipmi_attach_args *ia)
1913 {
1914 	int error;
1915 
1916 	sc->sc_if = ipmi_get_if(ia->iaa_if_type);
1917 	if (sc->sc_if == NULL)
1918 		return -1;
1919 
1920 	if (ia->iaa_if_iotype == 'i')
1921 		sc->sc_iot = ia->iaa_iot;
1922 	else
1923 		sc->sc_iot = ia->iaa_memt;
1924 
1925 	sc->sc_if_rev = ia->iaa_if_rev;
1926 	sc->sc_if_iospacing = ia->iaa_if_iospacing;
1927 	if ((error = bus_space_map(sc->sc_iot, ia->iaa_if_iobase,
1928 	    sc->sc_if->nregs * sc->sc_if_iospacing, 0, &sc->sc_ioh)) != 0) {
1929 		const char *xname = sc->sc_dev ? device_xname(sc->sc_dev) :
1930 		    "ipmi0";
1931 		aprint_error("%s: %s:bus_space_map(..., %" PRIx64 ", %x"
1932 		    ", 0, %p) type %c failed %d\n",
1933 		    xname, __func__, (uint64_t)ia->iaa_if_iobase,
1934 		    sc->sc_if->nregs * sc->sc_if_iospacing, &sc->sc_ioh,
1935 		    ia->iaa_if_iotype, error);
1936 		return -1;
1937 	}
1938 #if 0
1939 	if (iaa->if_if_irq != -1)
1940 		sc->ih = isa_intr_establish(-1, iaa->if_if_irq,
1941 		    iaa->if_irqlvl, IPL_BIO, ipmi_intr, sc,
1942 		    device_xname(sc->sc_dev);
1943 #endif
1944 	return 0;
1945 }
1946 
1947 static void
ipmi_unmap_regs(struct ipmi_softc * sc)1948 ipmi_unmap_regs(struct ipmi_softc *sc)
1949 {
1950 	bus_space_unmap(sc->sc_iot, sc->sc_ioh,
1951 	    sc->sc_if->nregs * sc->sc_if_iospacing);
1952 }
1953 
1954 static int
ipmi_match(device_t parent,cfdata_t cf,void * aux)1955 ipmi_match(device_t parent, cfdata_t cf, void *aux)
1956 {
1957 	struct ipmi_softc sc;
1958 	struct ipmi_attach_args *ia = aux;
1959 	int			rv = 0;
1960 
1961 	memset(&sc, 0, sizeof(sc));
1962 
1963 	/* Map registers */
1964 	if (ipmi_map_regs(&sc, ia) != 0)
1965 		return 0;
1966 
1967 	sc.sc_if->probe(&sc);
1968 
1969 	mutex_init(&sc.sc_cmd_mtx, MUTEX_DEFAULT, IPL_SOFTCLOCK);
1970 	cv_init(&sc.sc_cmd_sleep, "ipmimtch");
1971 
1972 	if (ipmi_get_device_id(&sc, NULL) == 0)
1973 		rv = 1;
1974 
1975 	cv_destroy(&sc.sc_cmd_sleep);
1976 	mutex_destroy(&sc.sc_cmd_mtx);
1977 	ipmi_unmap_regs(&sc);
1978 
1979 	return rv;
1980 }
1981 
1982 static void
ipmi_thread(void * cookie)1983 ipmi_thread(void *cookie)
1984 {
1985 	device_t		self = cookie;
1986 	struct ipmi_softc	*sc = device_private(self);
1987 	struct ipmi_attach_args *ia = &sc->sc_ia;
1988 	uint16_t		rec;
1989 	struct ipmi_sensor *ipmi_s;
1990 	struct ipmi_device_id	id;
1991 	int i;
1992 
1993 	sc->sc_thread_running = true;
1994 
1995 	/* setup ticker */
1996 	sc->sc_max_retries = hz * 90; /* 90 seconds max */
1997 
1998 	/* Map registers */
1999 	ipmi_map_regs(sc, ia);
2000 
2001 	memset(&id, 0, sizeof(id));
2002 	if (ipmi_get_device_id(sc, &id))
2003 		aprint_error_dev(self, "Failed to re-query device ID\n");
2004 
2005 	/* Scan SDRs, add sensors to list */
2006 	for (rec = 0; rec != 0xFFFF;)
2007 		if (get_sdr(sc, rec, &rec))
2008 			break;
2009 
2010 	/* allocate and fill sensor arrays */
2011 	sc->sc_sensor = malloc(sizeof(sc->sc_sensor[0]) * sc->sc_nsensors,
2012 	    M_DEVBUF, M_WAITOK | M_ZERO);
2013 
2014 	sc->sc_envsys = sysmon_envsys_create();
2015 	sc->sc_envsys->sme_cookie = sc;
2016 	sc->sc_envsys->sme_get_limits = ipmi_get_limits;
2017 	sc->sc_envsys->sme_set_limits = ipmi_set_limits;
2018 
2019 	i = 0;
2020 	SLIST_FOREACH(ipmi_s, &ipmi_sensor_list, i_list) {
2021 		ipmi_s->i_props = 0;
2022 		ipmi_s->i_envnum = -1;
2023 		sc->sc_sensor[i].units = ipmi_s->i_envtype;
2024 		sc->sc_sensor[i].state = ENVSYS_SINVALID;
2025 		sc->sc_sensor[i].flags |= ENVSYS_FHAS_ENTROPY;
2026 		/*
2027 		 * Monitor threshold limits in the sensors.
2028 		 */
2029 		switch (sc->sc_sensor[i].units) {
2030 		case ENVSYS_STEMP:
2031 		case ENVSYS_SVOLTS_DC:
2032 		case ENVSYS_SFANRPM:
2033 			sc->sc_sensor[i].flags |= ENVSYS_FMONLIMITS;
2034 			break;
2035 		default:
2036 			sc->sc_sensor[i].flags |= ENVSYS_FMONCRITICAL;
2037 		}
2038 		(void)strlcpy(sc->sc_sensor[i].desc, ipmi_s->i_envdesc,
2039 		    sizeof(sc->sc_sensor[i].desc));
2040 		++i;
2041 
2042 		if (sysmon_envsys_sensor_attach(sc->sc_envsys,
2043 						&sc->sc_sensor[i-1]))
2044 			continue;
2045 
2046 		/* get reference number from envsys */
2047 		ipmi_s->i_envnum = sc->sc_sensor[i-1].sensor;
2048 	}
2049 
2050 	sc->sc_envsys->sme_name = device_xname(sc->sc_dev);
2051 	sc->sc_envsys->sme_flags = SME_DISABLE_REFRESH;
2052 
2053 	if (sysmon_envsys_register(sc->sc_envsys)) {
2054 		aprint_error_dev(self, "unable to register with sysmon\n");
2055 		sysmon_envsys_destroy(sc->sc_envsys);
2056 		sc->sc_envsys = NULL;
2057 	}
2058 
2059 	/* initialize sensor list for thread */
2060 	if (!SLIST_EMPTY(&ipmi_sensor_list))
2061 		sc->current_sensor = SLIST_FIRST(&ipmi_sensor_list);
2062 
2063 	aprint_verbose_dev(self, "version %d.%d interface %s %sbase "
2064 	    "0x%" PRIx64 "/%#x spacing %d\n",
2065 	    ia->iaa_if_rev >> 4, ia->iaa_if_rev & 0xF, sc->sc_if->name,
2066 	    ia->iaa_if_iotype == 'i' ? "io" : "mem",
2067 	    (uint64_t)ia->iaa_if_iobase,
2068 	    ia->iaa_if_iospacing * sc->sc_if->nregs, ia->iaa_if_iospacing);
2069 	if (ia->iaa_if_irq != -1)
2070 		aprint_verbose_dev(self, " irq %d\n", ia->iaa_if_irq);
2071 
2072 	if (id.deviceid != 0) {
2073 		aprint_normal_dev(self, "ID %u.%u IPMI %x.%x%s%s\n",
2074 			id.deviceid, (id.revision & 0xf),
2075 			(id.version & 0xf), (id.version >> 4) & 0xf,
2076 			(id.fwrev1 & 0x80) ? " Initializing" : " Available",
2077 			(id.revision & 0x80) ? " +SDRs" : "");
2078 		if (id.additional != 0)
2079 			aprint_verbose_dev(self, "Additional%s%s%s%s%s%s%s%s\n",
2080 				(id.additional & 0x80) ? " Chassis" : "",
2081 				(id.additional & 0x40) ? " Bridge" : "",
2082 				(id.additional & 0x20) ? " IPMBGen" : "",
2083 				(id.additional & 0x10) ? " IPMBRcv" : "",
2084 				(id.additional & 0x08) ? " FRU" : "",
2085 				(id.additional & 0x04) ? " SEL" : "",
2086 				(id.additional & 0x02) ? " SDR" : "",
2087 				(id.additional & 0x01) ? " Sensor" : "");
2088 		aprint_verbose_dev(self, "Manufacturer %05x Product %04x\n",
2089 			(id.manufacturer[2] & 0xf) << 16
2090 			    | id.manufacturer[1] << 8
2091 			    | id.manufacturer[0],
2092 			id.product[1] << 8
2093 			    | id.manufacturer[0]);
2094 		aprint_verbose_dev(self, "Firmware %u.%x\n",
2095 			(id.fwrev1 & 0x7f), id.fwrev2);
2096 	}
2097 
2098 	/* setup flag to exclude iic */
2099 	ipmi_enabled = 1;
2100 
2101 	/* Setup Watchdog timer */
2102 	sc->sc_wdog.smw_name = device_xname(sc->sc_dev);
2103 	sc->sc_wdog.smw_cookie = sc;
2104 	sc->sc_wdog.smw_setmode = ipmi_watchdog_setmode;
2105 	sc->sc_wdog.smw_tickle = ipmi_watchdog_tickle;
2106 	sysmon_wdog_register(&sc->sc_wdog);
2107 
2108 	/* Set up a power handler so we can possibly sleep */
2109 	if (!pmf_device_register(self, ipmi_suspend, NULL))
2110                 aprint_error_dev(self, "couldn't establish a power handler\n");
2111 
2112 	config_pending_decr(self);
2113 
2114 	mutex_enter(&sc->sc_poll_mtx);
2115 	while (sc->sc_thread_running) {
2116 		while (sc->sc_mode == IPMI_MODE_COMMAND)
2117 			cv_wait(&sc->sc_mode_cv, &sc->sc_poll_mtx);
2118 		sc->sc_mode = IPMI_MODE_ENVSYS;
2119 
2120 		if (sc->sc_tickle_due) {
2121 			ipmi_dotickle(sc);
2122 			sc->sc_tickle_due = false;
2123 		}
2124 		ipmi_refresh_sensors(sc);
2125 
2126 		sc->sc_mode = IPMI_MODE_IDLE;
2127 		cv_broadcast(&sc->sc_mode_cv);
2128 		cv_timedwait(&sc->sc_poll_cv, &sc->sc_poll_mtx,
2129 		    SENSOR_REFRESH_RATE);
2130 	}
2131 	mutex_exit(&sc->sc_poll_mtx);
2132 	kthread_exit(0);
2133 }
2134 
2135 static void
ipmi_attach(device_t parent,device_t self,void * aux)2136 ipmi_attach(device_t parent, device_t self, void *aux)
2137 {
2138 	struct ipmi_softc	*sc = device_private(self);
2139 
2140 	sc->sc_ia = *(struct ipmi_attach_args *)aux;
2141 	sc->sc_dev = self;
2142 	aprint_naive("\n");
2143 	aprint_normal("\n");
2144 
2145 	/* lock around read_sensor so that no one messes with the bmc regs */
2146 	mutex_init(&sc->sc_cmd_mtx, MUTEX_DEFAULT, IPL_SOFTCLOCK);
2147 	mutex_init(&sc->sc_sleep_mtx, MUTEX_DEFAULT, IPL_SOFTCLOCK);
2148 	cv_init(&sc->sc_cmd_sleep, "ipmicmd");
2149 
2150 	mutex_init(&sc->sc_poll_mtx, MUTEX_DEFAULT, IPL_SOFTCLOCK);
2151 	cv_init(&sc->sc_poll_cv, "ipmipoll");
2152 	cv_init(&sc->sc_mode_cv, "ipmimode");
2153 
2154 	if (kthread_create(PRI_NONE, KTHREAD_MUSTJOIN, NULL, ipmi_thread, self,
2155 	    &sc->sc_kthread, "%s", device_xname(self)) != 0) {
2156 		aprint_error_dev(self, "unable to create thread, disabled\n");
2157 	} else
2158 		config_pending_incr(self);
2159 }
2160 
2161 static int
ipmi_detach(device_t self,int flags)2162 ipmi_detach(device_t self, int flags)
2163 {
2164 	struct ipmi_sensor *i;
2165 	int rc;
2166 	struct ipmi_softc *sc = device_private(self);
2167 
2168 	mutex_enter(&sc->sc_poll_mtx);
2169 	sc->sc_thread_running = false;
2170 	cv_signal(&sc->sc_poll_cv);
2171 	mutex_exit(&sc->sc_poll_mtx);
2172 	if (sc->sc_kthread)
2173 		(void)kthread_join(sc->sc_kthread);
2174 
2175 	if ((rc = sysmon_wdog_unregister(&sc->sc_wdog)) != 0) {
2176 		if (rc == ERESTART)
2177 			rc = EINTR;
2178 		return rc;
2179 	}
2180 
2181 	/* cancel any pending countdown */
2182 	sc->sc_wdog.smw_mode &= ~WDOG_MODE_MASK;
2183 	sc->sc_wdog.smw_mode |= WDOG_MODE_DISARMED;
2184 	sc->sc_wdog.smw_period = WDOG_PERIOD_DEFAULT;
2185 
2186 	if ((rc = ipmi_watchdog_setmode(&sc->sc_wdog)) != 0)
2187 		return rc;
2188 
2189 	ipmi_enabled = 0;
2190 
2191 	if (sc->sc_envsys != NULL) {
2192 		/* _unregister also destroys */
2193 		sysmon_envsys_unregister(sc->sc_envsys);
2194 		sc->sc_envsys = NULL;
2195 	}
2196 
2197 	while ((i = SLIST_FIRST(&ipmi_sensor_list)) != NULL) {
2198 		SLIST_REMOVE_HEAD(&ipmi_sensor_list, i_list);
2199 		free(i, M_DEVBUF);
2200 	}
2201 
2202 	if (sc->sc_sensor != NULL) {
2203 		free(sc->sc_sensor, M_DEVBUF);
2204 		sc->sc_sensor = NULL;
2205 	}
2206 
2207 	ipmi_unmap_regs(sc);
2208 
2209 	cv_destroy(&sc->sc_mode_cv);
2210 	cv_destroy(&sc->sc_poll_cv);
2211 	mutex_destroy(&sc->sc_poll_mtx);
2212 	cv_destroy(&sc->sc_cmd_sleep);
2213 	mutex_destroy(&sc->sc_sleep_mtx);
2214 	mutex_destroy(&sc->sc_cmd_mtx);
2215 
2216 	return 0;
2217 }
2218 
2219 static int
ipmi_get_device_id(struct ipmi_softc * sc,struct ipmi_device_id * res)2220 ipmi_get_device_id(struct ipmi_softc *sc, struct ipmi_device_id *res)
2221 {
2222 	uint8_t		buf[32];
2223 	int		len;
2224 	int		rc;
2225 
2226 	mutex_enter(&sc->sc_cmd_mtx);
2227 	/* Identify BMC device early to detect lying bios */
2228 	rc = ipmi_sendcmd(sc, BMC_SA, 0, APP_NETFN, APP_GET_DEVICE_ID, 0, NULL);
2229 	if (rc) {
2230 		dbg_printf(1, ": unable to send get device id "
2231 		    "command\n");
2232 		goto done;
2233 	}
2234 	rc = ipmi_recvcmd(sc, sizeof(buf), &len, buf);
2235 	if (rc) {
2236 		dbg_printf(1, ": unable to retrieve device id\n");
2237 	}
2238 done:
2239 	mutex_exit(&sc->sc_cmd_mtx);
2240 
2241 	if (rc == 0 && res != NULL)
2242 		memcpy(res, buf, MIN(sizeof(*res), len));
2243 
2244 	return rc;
2245 }
2246 
2247 static int
ipmi_watchdog_setmode(struct sysmon_wdog * smwdog)2248 ipmi_watchdog_setmode(struct sysmon_wdog *smwdog)
2249 {
2250 	struct ipmi_softc	*sc = smwdog->smw_cookie;
2251 	struct ipmi_get_watchdog gwdog;
2252 	struct ipmi_set_watchdog swdog;
2253 	int			rc, len;
2254 
2255 	if (smwdog->smw_period < 10)
2256 		return EINVAL;
2257 	if (smwdog->smw_period == WDOG_PERIOD_DEFAULT)
2258 		sc->sc_wdog.smw_period = 10;
2259 	else
2260 		sc->sc_wdog.smw_period = smwdog->smw_period;
2261 
2262 	mutex_enter(&sc->sc_cmd_mtx);
2263 	/* see if we can properly task to the watchdog */
2264 	rc = ipmi_sendcmd(sc, BMC_SA, BMC_LUN, APP_NETFN,
2265 	    APP_GET_WATCHDOG_TIMER, 0, NULL);
2266 	rc = ipmi_recvcmd(sc, sizeof(gwdog), &len, &gwdog);
2267 	mutex_exit(&sc->sc_cmd_mtx);
2268 	if (rc) {
2269 		aprint_error_dev(sc->sc_dev,
2270 		    "APP_GET_WATCHDOG_TIMER returned %#x\n", rc);
2271 		return EIO;
2272 	}
2273 
2274 	memset(&swdog, 0, sizeof(swdog));
2275 	/* Period is 10ths/sec */
2276 	swdog.wdog_timeout = htole16(sc->sc_wdog.smw_period * 10);
2277 	if ((smwdog->smw_mode & WDOG_MODE_MASK) == WDOG_MODE_DISARMED)
2278 		swdog.wdog_action = IPMI_WDOG_ACT_DISABLED;
2279 	else
2280 		swdog.wdog_action = IPMI_WDOG_ACT_RESET;
2281 	swdog.wdog_use = IPMI_WDOG_USE_USE_OS;
2282 
2283 	mutex_enter(&sc->sc_cmd_mtx);
2284 	if ((rc = ipmi_sendcmd(sc, BMC_SA, BMC_LUN, APP_NETFN,
2285 	    APP_SET_WATCHDOG_TIMER, sizeof(swdog), &swdog)) == 0)
2286 		rc = ipmi_recvcmd(sc, 0, &len, NULL);
2287 	mutex_exit(&sc->sc_cmd_mtx);
2288 	if (rc) {
2289 		aprint_error_dev(sc->sc_dev,
2290 		    "APP_SET_WATCHDOG_TIMER returned %#x\n", rc);
2291 		return EIO;
2292 	}
2293 
2294 	return 0;
2295 }
2296 
2297 static int
ipmi_watchdog_tickle(struct sysmon_wdog * smwdog)2298 ipmi_watchdog_tickle(struct sysmon_wdog *smwdog)
2299 {
2300 	struct ipmi_softc	*sc = smwdog->smw_cookie;
2301 
2302 	mutex_enter(&sc->sc_poll_mtx);
2303 	sc->sc_tickle_due = true;
2304 	cv_signal(&sc->sc_poll_cv);
2305 	mutex_exit(&sc->sc_poll_mtx);
2306 	return 0;
2307 }
2308 
2309 static void
ipmi_dotickle(struct ipmi_softc * sc)2310 ipmi_dotickle(struct ipmi_softc *sc)
2311 {
2312 	int			rc, len;
2313 
2314 	mutex_enter(&sc->sc_cmd_mtx);
2315 	/* tickle the watchdog */
2316 	if ((rc = ipmi_sendcmd(sc, BMC_SA, BMC_LUN, APP_NETFN,
2317 	    APP_RESET_WATCHDOG, 0, NULL)) == 0)
2318 		rc = ipmi_recvcmd(sc, 0, &len, NULL);
2319 	mutex_exit(&sc->sc_cmd_mtx);
2320 	if (rc != 0) {
2321 		aprint_error_dev(sc->sc_dev, "watchdog tickle returned %#x\n",
2322 		    rc);
2323 	}
2324 }
2325 
2326 static bool
ipmi_suspend(device_t dev,const pmf_qual_t * qual)2327 ipmi_suspend(device_t dev, const pmf_qual_t *qual)
2328 {
2329 	struct ipmi_softc *sc = device_private(dev);
2330 
2331 	/* Don't allow suspend if watchdog is armed */
2332 	if ((sc->sc_wdog.smw_mode & WDOG_MODE_MASK) != WDOG_MODE_DISARMED)
2333 		return false;
2334 	return true;
2335 }
2336 
2337 static int
ipmi_open(dev_t dev,int flag,int fmt,lwp_t * l)2338 ipmi_open(dev_t dev, int flag, int fmt, lwp_t *l)
2339 {
2340 	struct ipmi_softc *sc;
2341 	int unit;
2342 
2343 	unit = IPMIUNIT(dev);
2344 	if ((sc = device_lookup_private(&ipmi_cd, unit)) == NULL)
2345 		return (ENXIO);
2346 
2347 	return 0;
2348 }
2349 
2350 static int
ipmi_close(dev_t dev,int flag,int fmt,lwp_t * l)2351 ipmi_close(dev_t dev, int flag, int fmt, lwp_t *l)
2352 {
2353 	struct ipmi_softc *sc;
2354 	int unit;
2355 
2356 	unit = IPMIUNIT(dev);
2357 	if ((sc = device_lookup_private(&ipmi_cd, unit)) == NULL)
2358 		return (ENXIO);
2359 
2360 	mutex_enter(&sc->sc_poll_mtx);
2361 	if (sc->sc_mode == IPMI_MODE_COMMAND) {
2362 		sc->sc_mode = IPMI_MODE_IDLE;
2363 		cv_broadcast(&sc->sc_mode_cv);
2364 	}
2365 	mutex_exit(&sc->sc_poll_mtx);
2366 	return 0;
2367 }
2368 
2369 static int
ipmi_ioctl(dev_t dev,u_long cmd,void * data,int flag,lwp_t * l)2370 ipmi_ioctl(dev_t dev, u_long cmd, void *data, int flag, lwp_t *l)
2371 {
2372 	struct ipmi_softc *sc;
2373 	int unit, error = 0, len;
2374 	struct ipmi_req *req;
2375 	struct ipmi_recv *recv;
2376 	struct ipmi_addr addr;
2377 	unsigned char ccode, *buf = NULL;
2378 
2379 	unit = IPMIUNIT(dev);
2380 	if ((sc = device_lookup_private(&ipmi_cd, unit)) == NULL)
2381 		return (ENXIO);
2382 
2383 	switch (cmd) {
2384 	case IPMICTL_SEND_COMMAND:
2385 		mutex_enter(&sc->sc_poll_mtx);
2386 		while (sc->sc_mode == IPMI_MODE_ENVSYS) {
2387 			error = cv_wait_sig(&sc->sc_mode_cv, &sc->sc_poll_mtx);
2388 			if (error == EINTR) {
2389 				mutex_exit(&sc->sc_poll_mtx);
2390 				return error;
2391 			}
2392 		}
2393 		sc->sc_mode = IPMI_MODE_COMMAND;
2394 		mutex_exit(&sc->sc_poll_mtx);
2395 		break;
2396 	}
2397 
2398 	mutex_enter(&sc->sc_cmd_mtx);
2399 
2400 	switch (cmd) {
2401 	case IPMICTL_SEND_COMMAND:
2402 		req = data;
2403 		buf = malloc(IPMI_MAX_RX, M_DEVBUF, M_WAITOK);
2404 
2405 		len = req->msg.data_len;
2406 		if (len < 0 || len > IPMI_MAX_RX) {
2407 			error = EINVAL;
2408 			break;
2409 		}
2410 
2411 		/* clear pending result */
2412 		if (sc->sc_sent)
2413 			(void)ipmi_recvcmd(sc, IPMI_MAX_RX, &len, buf);
2414 
2415 		/* XXX */
2416 		error = copyin(req->addr, &addr, sizeof(addr));
2417 		if (error)
2418 			break;
2419 
2420 		error = copyin(req->msg.data, buf, len);
2421 		if (error)
2422 			break;
2423 
2424 		/* save for receive */
2425 		sc->sc_msgid = req->msgid;
2426 		sc->sc_netfn = req->msg.netfn;
2427 		sc->sc_cmd = req->msg.cmd;
2428 
2429 		if (ipmi_sendcmd(sc, BMC_SA, 0, req->msg.netfn,
2430 		    req->msg.cmd, len, buf)) {
2431 			error = EIO;
2432 			break;
2433 		}
2434 		sc->sc_sent = true;
2435 		break;
2436 	case IPMICTL_RECEIVE_MSG_TRUNC:
2437 	case IPMICTL_RECEIVE_MSG:
2438 		recv = data;
2439 		buf = malloc(IPMI_MAX_RX, M_DEVBUF, M_WAITOK);
2440 
2441 		if (recv->msg.data_len < 1) {
2442 			error = EINVAL;
2443 			break;
2444 		}
2445 
2446 		/* XXX */
2447 		error = copyin(recv->addr, &addr, sizeof(addr));
2448 		if (error)
2449 			break;
2450 
2451 
2452 		if (!sc->sc_sent) {
2453 			error = EIO;
2454 			break;
2455 		}
2456 
2457 		len = 0;
2458 		error = ipmi_recvcmd(sc, IPMI_MAX_RX, &len, buf);
2459 		if (error < 0) {
2460 			error = EIO;
2461 			break;
2462 		}
2463 		ccode = (unsigned char)error;
2464 		sc->sc_sent = false;
2465 
2466 		if (len > recv->msg.data_len - 1) {
2467 			if (cmd == IPMICTL_RECEIVE_MSG) {
2468 				error = EMSGSIZE;
2469 				break;
2470 			}
2471 			len = recv->msg.data_len - 1;
2472 		}
2473 
2474 		addr.channel = IPMI_BMC_CHANNEL;
2475 
2476 		recv->recv_type = IPMI_RESPONSE_RECV_TYPE;
2477 		recv->msgid = sc->sc_msgid;
2478 		recv->msg.netfn = sc->sc_netfn;
2479 		recv->msg.cmd = sc->sc_cmd;
2480 		recv->msg.data_len = len+1;
2481 
2482 		error = copyout(&addr, recv->addr, sizeof(addr));
2483 		if (error == 0)
2484 			error = copyout(&ccode, recv->msg.data, 1);
2485 		if (error == 0)
2486 			error = copyout(buf, recv->msg.data+1, len);
2487 		break;
2488 	case IPMICTL_SET_MY_ADDRESS_CMD:
2489 		sc->sc_address = *(int *)data;
2490 		break;
2491 	case IPMICTL_GET_MY_ADDRESS_CMD:
2492 		*(int *)data = sc->sc_address;
2493 		break;
2494 	case IPMICTL_SET_MY_LUN_CMD:
2495 		sc->sc_lun = *(int *)data & 0x3;
2496 		break;
2497 	case IPMICTL_GET_MY_LUN_CMD:
2498 		*(int *)data = sc->sc_lun;
2499 		break;
2500 	case IPMICTL_SET_GETS_EVENTS_CMD:
2501 		break;
2502 	case IPMICTL_REGISTER_FOR_CMD:
2503 	case IPMICTL_UNREGISTER_FOR_CMD:
2504 		error = EOPNOTSUPP;
2505 		break;
2506 	default:
2507 		error = ENODEV;
2508 		break;
2509 	}
2510 
2511 	if (buf)
2512 		free(buf, M_DEVBUF);
2513 
2514 	mutex_exit(&sc->sc_cmd_mtx);
2515 
2516 	switch (cmd) {
2517 	case IPMICTL_RECEIVE_MSG:
2518 	case IPMICTL_RECEIVE_MSG_TRUNC:
2519 		mutex_enter(&sc->sc_poll_mtx);
2520 		sc->sc_mode = IPMI_MODE_IDLE;
2521 		cv_broadcast(&sc->sc_mode_cv);
2522 		mutex_exit(&sc->sc_poll_mtx);
2523 		break;
2524 	}
2525 
2526 	return error;
2527 }
2528 
2529 static int
ipmi_poll(dev_t dev,int events,lwp_t * l)2530 ipmi_poll(dev_t dev, int events, lwp_t *l)
2531 {
2532 	struct ipmi_softc *sc;
2533 	int unit, revents = 0;
2534 
2535 	unit = IPMIUNIT(dev);
2536 	if ((sc = device_lookup_private(&ipmi_cd, unit)) == NULL)
2537 		return (ENXIO);
2538 
2539 	mutex_enter(&sc->sc_cmd_mtx);
2540 	if (events & (POLLIN | POLLRDNORM)) {
2541 		if (sc->sc_sent)
2542 			revents |= events & (POLLIN | POLLRDNORM);
2543 	}
2544 	mutex_exit(&sc->sc_cmd_mtx);
2545 
2546 	return revents;
2547 }
2548