xref: /freebsd/sys/dev/ipmi/ipmi.c (revision acd3428b7d3e94cef0e1881c868cb4b131d4ff41)
1 /*-
2  * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/bus.h>
33 #include <sys/condvar.h>
34 #include <sys/conf.h>
35 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
38 #include <sys/poll.h>
39 #include <sys/rman.h>
40 #include <sys/selinfo.h>
41 #include <sys/sysctl.h>
42 #include <sys/watchdog.h>
43 
44 #ifdef LOCAL_MODULE
45 #include <ipmi.h>
46 #include <ipmivars.h>
47 #else
48 #include <sys/ipmi.h>
49 #include <dev/ipmi/ipmivars.h>
50 #endif
51 
52 #ifdef IPMB
53 static int ipmi_ipmb_checksum(u_char, int);
54 static int ipmi_ipmb_send_message(device_t, u_char, u_char, u_char,
55      u_char, u_char, int)
56 #endif
57 
58 static d_ioctl_t ipmi_ioctl;
59 static d_poll_t ipmi_poll;
60 static d_open_t ipmi_open;
61 static d_close_t ipmi_close;
62 
63 int ipmi_attached = 0;
64 
65 #define IPMI_MINOR	0
66 
67 static int on = 1;
68 SYSCTL_NODE(_hw, OID_AUTO, ipmi, CTLFLAG_RD, 0, "IPMI driver parameters");
69 SYSCTL_INT(_hw_ipmi, OID_AUTO, on, CTLFLAG_RW,
70 	&on, 0, "");
71 
72 static struct cdevsw ipmi_cdevsw = {
73 	.d_version =    D_VERSION,
74 	.d_open =	ipmi_open,
75 	.d_close =	ipmi_close,
76 	.d_ioctl =	ipmi_ioctl,
77 	.d_poll =	ipmi_poll,
78 	.d_name =	"ipmi",
79 };
80 
81 MALLOC_DEFINE(M_IPMI, "ipmi", "ipmi");
82 
83 static int
84 ipmi_open(struct cdev *cdev, int flags, int fmt, struct thread *td)
85 {
86 	struct ipmi_device *dev;
87 	struct ipmi_softc *sc;
88 
89 	if (!on)
90 		return (ENOENT);
91 
92 	dev = cdev->si_drv1;
93 	sc = dev->ipmi_softc;
94 	IPMI_LOCK(sc);
95 	if (dev->ipmi_open) {
96 		IPMI_UNLOCK(sc);
97 		return (EBUSY);
98 	}
99 	dev->ipmi_open = 1;
100 	IPMI_UNLOCK(sc);
101 
102 	return (0);
103 }
104 
105 static int
106 ipmi_poll(struct cdev *cdev, int poll_events, struct thread *td)
107 {
108 	struct ipmi_device *dev;
109 	struct ipmi_softc *sc;
110 	int revents = 0;
111 
112 	dev = cdev->si_drv1;
113 	sc = dev->ipmi_softc;
114 
115 	IPMI_LOCK(sc);
116 	if (poll_events & (POLLIN | POLLRDNORM)) {
117 		if (!TAILQ_EMPTY(&dev->ipmi_completed_requests))
118 		    revents |= poll_events & (POLLIN | POLLRDNORM);
119 		if (dev->ipmi_requests == 0)
120 		    revents |= POLLERR;
121 	}
122 
123 	if (revents == 0) {
124 		if (poll_events & (POLLIN | POLLRDNORM))
125 			selrecord(td, &dev->ipmi_select);
126 	}
127 	IPMI_UNLOCK(sc);
128 
129 	return (revents);
130 }
131 
132 static void
133 ipmi_purge_completed_requests(struct ipmi_device *dev)
134 {
135 	struct ipmi_request *req;
136 
137 	while (!TAILQ_EMPTY(&dev->ipmi_completed_requests)) {
138 		req = TAILQ_FIRST(&dev->ipmi_completed_requests);
139 		TAILQ_REMOVE(&dev->ipmi_completed_requests, req, ir_link);
140 		dev->ipmi_requests--;
141 		ipmi_free_request(req);
142 	}
143 }
144 
145 static int
146 ipmi_close(struct cdev *cdev, int flags, int fmt, struct thread *td)
147 {
148 	struct ipmi_request *req, *nreq;
149 	struct ipmi_device *dev;
150 	struct ipmi_softc *sc;
151 #ifdef CLONING
152 	int bit;
153 #endif
154 
155 	dev = cdev->si_drv1;
156 	sc = dev->ipmi_softc;
157 
158 	IPMI_LOCK(sc);
159 	if (dev->ipmi_requests) {
160 		/* Throw away any pending requests for this device. */
161 		TAILQ_FOREACH_SAFE(req, &sc->ipmi_pending_requests, ir_link,
162 		    nreq) {
163 			if (req->ir_owner == dev) {
164 				TAILQ_REMOVE(&sc->ipmi_pending_requests, req,
165 				    ir_link);
166 				dev->ipmi_requests--;
167 				ipmi_free_request(req);
168 			}
169 		}
170 
171 		/* Throw away any pending completed requests for this device. */
172 		ipmi_purge_completed_requests(dev);
173 
174 		/*
175 		 * If we still have outstanding requests, they must be stuck
176 		 * in an interface driver, so wait for those to drain.
177 		 */
178 		dev->ipmi_closing = 1;
179 		while (dev->ipmi_requests > 0) {
180 			msleep(&dev->ipmi_requests, &sc->ipmi_lock, PWAIT,
181 			    "ipmidrain", 0);
182 			ipmi_purge_completed_requests(dev);
183 		}
184 	}
185 
186 #ifdef CLONING
187 	/* Detach this sub-device from the main driver. */
188 	bit = minor(cdev) % 32;
189 	sc->ipmi_cdev_mask &= ~(1 << bit);
190 	TAILQ_REMOVE(&sc->ipmi_cdevs, dev, ipmi_link);
191 	IPMI_UNLOCK(sc);
192 
193 	/* Cleanup. */
194 	cdev->si_drv1 = NULL;
195 	free(dev, M_IPMI);
196 	destroy_dev(cdev);
197 #else
198 	dev->ipmi_open = 0;
199 	IPMI_UNLOCK(sc);
200 #endif
201 
202 	return (0);
203 }
204 
205 #ifdef IPMB
206 static int
207 ipmi_ipmb_checksum(u_char *data, int len)
208 {
209 	u_char sum = 0;
210 
211 	for (; len; len--) {
212 		sum += *data++;
213 	}
214 	return (-sum);
215 }
216 
217 /* XXX: Needs work */
218 static int
219 ipmi_ipmb_send_message(device_t dev, u_char channel, u_char netfn,
220     u_char command, u_char seq, u_char *data, int data_len)
221 {
222 	struct ipmi_softc *sc = device_get_softc(dev);
223 	struct ipmi_request *req;
224 	u_char slave_addr = 0x52;
225 	int error;
226 
227 	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
228 	    IPMI_SEND_MSG, data_len + 8, 0);
229 	req->ir_request[0] = channel;
230 	req->ir_request[1] = slave_addr;
231 	req->ir_request[2] = IPMI_ADDR(netfn, 0);
232 	req->ir_request[3] = ipmi_ipmb_checksum(&req->ir_request[1], 2);
233 	req->ir_request[4] = sc->ipmi_address;
234 	req->ir_request[5] = IPMI_ADDR(seq, sc->ipmi_lun);
235 	req->ir_request[6] = command;
236 
237 	bcopy(data, &req->ir_request[7], data_len);
238 	temp[data_len + 7] = ipmi_ipmb_checksum(&req->ir_request[4],
239 	    data_len + 3);
240 
241 	ipmi_submit_driver_request(sc, req);
242 	error = req->ir_error;
243 	ipmi_free_request(req);
244 
245 	return (error);
246 }
247 
248 static int
249 ipmi_handle_attn(struct ipmi_softc *sc)
250 {
251 	struct ipmi_request *req;
252 	int error;
253 
254 	device_printf(sc->ipmi_dev, "BMC has a message\n");
255 	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
256 	    IPMI_GET_MSG_FLAGS, 0, 1);
257 
258 	ipmi_submit_driver_request(sc, req);
259 
260 	if (req->ir_error == 0 && req->ir_compcode == 0) {
261 		if (req->ir_reply[0] & IPMI_MSG_BUFFER_FULL) {
262 			device_printf(sc->ipmi_dev, "message buffer full");
263 		}
264 		if (req->ir_reply[0] & IPMI_WDT_PRE_TIMEOUT) {
265 			device_printf(sc->ipmi_dev,
266 			    "watchdog about to go off");
267 		}
268 		if (req->ir_reply[0] & IPMI_MSG_AVAILABLE) {
269 			ipmi_free_request(req);
270 
271 			req = ipmi_alloc_driver_request(
272 			    IPMI_ADDR(IPMI_APP_REQUEST, 0), IPMI_GET_MSG, 0,
273 			    16);
274 
275 			device_printf(sc->ipmi_dev, "throw out message ");
276 			dump_buf(temp, 16);
277 		}
278 	}
279 	error = req->ir_error;
280 	ipmi_free_request(req);
281 
282 	return (error);
283 }
284 #endif
285 
286 #ifdef IPMICTL_SEND_COMMAND_32
287 #define	PTRIN(p)	((void *)(uintptr_t)(p))
288 #define	PTROUT(p)	((uintptr_t)(p))
289 #endif
290 
291 static int
292 ipmi_ioctl(struct cdev *cdev, u_long cmd, caddr_t data,
293     int flags, struct thread *td)
294 {
295 	struct ipmi_softc *sc;
296 	struct ipmi_device *dev;
297 	struct ipmi_request *kreq;
298 	struct ipmi_req *req = (struct ipmi_req *)data;
299 	struct ipmi_recv *recv = (struct ipmi_recv *)data;
300 	struct ipmi_addr addr;
301 #ifdef IPMICTL_SEND_COMMAND_32
302 	struct ipmi_req32 *req32 = (struct ipmi_req32 *)data;
303 	struct ipmi_recv32 *recv32 = (struct ipmi_recv32 *)data;
304 	union {
305 		struct ipmi_req req;
306 		struct ipmi_recv recv;
307 	} thunk32;
308 #endif
309 	int error, len;
310 
311 	dev = cdev->si_drv1;
312 	sc = dev->ipmi_softc;
313 
314 #ifdef IPMICTL_SEND_COMMAND_32
315 	/* Convert 32-bit structures to native. */
316 	switch (cmd) {
317 	case IPMICTL_SEND_COMMAND_32:
318 		req = &thunk32.req;
319 		req->addr = PTRIN(req32->addr);
320 		req->addr_len = req32->addr_len;
321 		req->msgid = req32->msgid;
322 		req->msg.netfn = req32->msg.netfn;
323 		req->msg.cmd = req32->msg.cmd;
324 		req->msg.data_len = req32->msg.data_len;
325 		req->msg.data = PTRIN(req32->msg.data);
326 		break;
327 	case IPMICTL_RECEIVE_MSG_TRUNC_32:
328 	case IPMICTL_RECEIVE_MSG_32:
329 		recv = &thunk32.recv;
330 		recv->addr = PTRIN(recv32->addr);
331 		recv->addr_len = recv32->addr_len;
332 		recv->msg.data_len = recv32->msg.data_len;
333 		recv->msg.data = PTRIN(recv32->msg.data);
334 		break;
335 	}
336 #endif
337 
338 	switch (cmd) {
339 #ifdef IPMICTL_SEND_COMMAND_32
340 	case IPMICTL_SEND_COMMAND_32:
341 #endif
342 	case IPMICTL_SEND_COMMAND:
343 		/*
344 		 * XXX: Need to add proper handling of this.
345 		 */
346 		error = copyin(req->addr, &addr, sizeof(addr));
347 		if (error)
348 			return (error);
349 
350 		IPMI_LOCK(sc);
351 		/* clear out old stuff in queue of stuff done */
352 		/* XXX: This seems odd. */
353 		while ((kreq = TAILQ_FIRST(&dev->ipmi_completed_requests))) {
354 			TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq,
355 			    ir_link);
356 			dev->ipmi_requests--;
357 			ipmi_free_request(kreq);
358 		}
359 		IPMI_UNLOCK(sc);
360 
361 		kreq = ipmi_alloc_request(dev, req->msgid,
362 		    IPMI_ADDR(req->msg.netfn, 0), req->msg.cmd,
363 		    req->msg.data_len, IPMI_MAX_RX);
364 		error = copyin(req->msg.data, kreq->ir_request,
365 		    req->msg.data_len);
366 		if (error) {
367 			ipmi_free_request(kreq);
368 			return (error);
369 		}
370 		IPMI_LOCK(sc);
371 		dev->ipmi_requests++;
372 		error = sc->ipmi_enqueue_request(sc, kreq);
373 		IPMI_UNLOCK(sc);
374 		if (error)
375 			return (error);
376 		break;
377 #ifdef IPMICTL_SEND_COMMAND_32
378 	case IPMICTL_RECEIVE_MSG_TRUNC_32:
379 	case IPMICTL_RECEIVE_MSG_32:
380 #endif
381 	case IPMICTL_RECEIVE_MSG_TRUNC:
382 	case IPMICTL_RECEIVE_MSG:
383 		error = copyin(recv->addr, &addr, sizeof(addr));
384 		if (error)
385 			return (error);
386 
387 		IPMI_LOCK(sc);
388 		kreq = TAILQ_FIRST(&dev->ipmi_completed_requests);
389 		if (kreq == NULL) {
390 			IPMI_UNLOCK(sc);
391 			return (EAGAIN);
392 		}
393 		addr.channel = IPMI_BMC_CHANNEL;
394 		/* XXX */
395 		recv->recv_type = IPMI_RESPONSE_RECV_TYPE;
396 		recv->msgid = kreq->ir_msgid;
397 		recv->msg.netfn = IPMI_REPLY_ADDR(kreq->ir_addr) >> 2;
398 		recv->msg.cmd = kreq->ir_command;
399 		error = kreq->ir_error;
400 		if (error) {
401 			TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq,
402 			    ir_link);
403 			dev->ipmi_requests--;
404 			IPMI_UNLOCK(sc);
405 			ipmi_free_request(kreq);
406 			return (error);
407 		}
408 		len = kreq->ir_replylen + 1;
409 		if (recv->msg.data_len < len &&
410 		    (cmd == IPMICTL_RECEIVE_MSG
411 #ifdef IPMICTL_RECEIVE_MSG_32
412 		     || cmd == IPMICTL_RECEIVE_MSG
413 #endif
414 		    )) {
415 			IPMI_UNLOCK(sc);
416 			return (EMSGSIZE);
417 		}
418 		TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq, ir_link);
419 		dev->ipmi_requests--;
420 		IPMI_UNLOCK(sc);
421 		len = min(recv->msg.data_len, len);
422 		recv->msg.data_len = len;
423 		error = copyout(&addr, recv->addr,sizeof(addr));
424 		if (error == 0)
425 			error = copyout(&kreq->ir_compcode, recv->msg.data, 1);
426 		if (error == 0)
427 			error = copyout(kreq->ir_reply, recv->msg.data + 1,
428 			    len - 1);
429 		ipmi_free_request(kreq);
430 		if (error)
431 			return (error);
432 		break;
433 	case IPMICTL_SET_MY_ADDRESS_CMD:
434 		IPMI_LOCK(sc);
435 		dev->ipmi_address = *(int*)data;
436 		IPMI_UNLOCK(sc);
437 		break;
438 	case IPMICTL_GET_MY_ADDRESS_CMD:
439 		IPMI_LOCK(sc);
440 		*(int*)data = dev->ipmi_address;
441 		IPMI_UNLOCK(sc);
442 		break;
443 	case IPMICTL_SET_MY_LUN_CMD:
444 		IPMI_LOCK(sc);
445 		dev->ipmi_lun = *(int*)data & 0x3;
446 		IPMI_UNLOCK(sc);
447 		break;
448 	case IPMICTL_GET_MY_LUN_CMD:
449 		IPMI_LOCK(sc);
450 		*(int*)data = dev->ipmi_lun;
451 		IPMI_UNLOCK(sc);
452 		break;
453 	case IPMICTL_SET_GETS_EVENTS_CMD:
454 		/*
455 		device_printf(sc->ipmi_dev,
456 		    "IPMICTL_SET_GETS_EVENTS_CMD NA\n");
457 		*/
458 		break;
459 	case IPMICTL_REGISTER_FOR_CMD:
460 	case IPMICTL_UNREGISTER_FOR_CMD:
461 		return (EOPNOTSUPP);
462 	default:
463 		device_printf(sc->ipmi_dev, "Unknown IOCTL %lX\n", cmd);
464 		return (ENOIOCTL);
465 	}
466 
467 #ifdef IPMICTL_SEND_COMMAND_32
468 	/* Update changed fields in 32-bit structures. */
469 	switch (cmd) {
470 	case IPMICTL_RECEIVE_MSG_TRUNC_32:
471 	case IPMICTL_RECEIVE_MSG_32:
472 		recv32->recv_type = recv->recv_type;
473 		recv32->msgid = recv->msgid;
474 		recv32->msg.netfn = recv->msg.netfn;
475 		recv32->msg.cmd = recv->msg.cmd;
476 		recv32->msg.data_len = recv->msg.data_len;
477 		break;
478 	}
479 #endif
480 	return (0);
481 }
482 
483 /*
484  * Request management.
485  */
486 
487 /* Allocate a new request with request and reply buffers. */
488 struct ipmi_request *
489 ipmi_alloc_request(struct ipmi_device *dev, long msgid, uint8_t addr,
490     uint8_t command, size_t requestlen, size_t replylen)
491 {
492 	struct ipmi_request *req;
493 
494 	req = malloc(sizeof(struct ipmi_request) + requestlen + replylen,
495 	    M_IPMI, M_WAITOK | M_ZERO);
496 	req->ir_owner = dev;
497 	req->ir_msgid = msgid;
498 	req->ir_addr = addr;
499 	req->ir_command = command;
500 	if (requestlen) {
501 		req->ir_request = (char *)&req[1];
502 		req->ir_requestlen = requestlen;
503 	}
504 	if (replylen) {
505 		req->ir_reply = (char *)&req[1] + requestlen;
506 		req->ir_replybuflen = replylen;
507 	}
508 	return (req);
509 }
510 
511 /* Free a request no longer in use. */
512 void
513 ipmi_free_request(struct ipmi_request *req)
514 {
515 
516 	free(req, M_IPMI);
517 }
518 
519 /* Store a processed request on the appropriate completion queue. */
520 void
521 ipmi_complete_request(struct ipmi_softc *sc, struct ipmi_request *req)
522 {
523 	struct ipmi_device *dev;
524 
525 	IPMI_LOCK_ASSERT(sc);
526 
527 	/*
528 	 * Anonymous requests (from inside the driver) always have a
529 	 * waiter that we awaken.
530 	 */
531 	if (req->ir_owner == NULL)
532 		wakeup(req);
533 	else {
534 		dev = req->ir_owner;
535 		TAILQ_INSERT_TAIL(&dev->ipmi_completed_requests, req, ir_link);
536 		selwakeup(&dev->ipmi_select);
537 		if (dev->ipmi_closing)
538 			wakeup(&dev->ipmi_requests);
539 	}
540 }
541 
542 /* Enqueue an internal driver request and wait until it is completed. */
543 int
544 ipmi_submit_driver_request(struct ipmi_softc *sc, struct ipmi_request *req,
545     int timo)
546 {
547 	int error;
548 
549 	IPMI_LOCK(sc);
550 	error = sc->ipmi_enqueue_request(sc, req);
551 	if (error == 0)
552 		error = msleep(req, &sc->ipmi_lock, 0, "ipmireq", timo);
553 	if (error == 0)
554 		error = req->ir_error;
555 	IPMI_UNLOCK(sc);
556 	return (error);
557 }
558 
559 /*
560  * Helper routine for polled system interfaces that use
561  * ipmi_polled_enqueue_request() to queue requests.  This request
562  * waits until there is a pending request and then returns the first
563  * request.  If the driver is shutting down, it returns NULL.
564  */
565 struct ipmi_request *
566 ipmi_dequeue_request(struct ipmi_softc *sc)
567 {
568 	struct ipmi_request *req;
569 
570 	IPMI_LOCK_ASSERT(sc);
571 
572 	while (!sc->ipmi_detaching && TAILQ_EMPTY(&sc->ipmi_pending_requests))
573 		cv_wait(&sc->ipmi_request_added, &sc->ipmi_lock);
574 	if (sc->ipmi_detaching)
575 		return (NULL);
576 
577 	req = TAILQ_FIRST(&sc->ipmi_pending_requests);
578 	TAILQ_REMOVE(&sc->ipmi_pending_requests, req, ir_link);
579 	return (req);
580 }
581 
582 /* Default implementation of ipmi_enqueue_request() for polled interfaces. */
583 int
584 ipmi_polled_enqueue_request(struct ipmi_softc *sc, struct ipmi_request *req)
585 {
586 
587 	IPMI_LOCK_ASSERT(sc);
588 
589 	TAILQ_INSERT_TAIL(&sc->ipmi_pending_requests, req, ir_link);
590 	cv_signal(&sc->ipmi_request_added);
591 	return (0);
592 }
593 
594 /*
595  * Watchdog event handler.
596  */
597 
598 static void
599 ipmi_set_watchdog(struct ipmi_softc *sc, int sec)
600 {
601 	struct ipmi_request *req;
602 	int error;
603 
604 	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
605 	    IPMI_SET_WDOG, 6, 0);
606 
607 	if (sec) {
608 		req->ir_request[0] = IPMI_SET_WD_TIMER_DONT_STOP
609 		    | IPMI_SET_WD_TIMER_SMS_OS;
610 		req->ir_request[1] = IPMI_SET_WD_ACTION_RESET;
611 		req->ir_request[2] = 0;
612 		req->ir_request[3] = 0;	/* Timer use */
613 		req->ir_request[4] = (sec * 10) & 0xff;
614 		req->ir_request[5] = (sec * 10) / 2550;
615 	} else {
616 		req->ir_request[0] = IPMI_SET_WD_TIMER_SMS_OS;
617 		req->ir_request[1] = 0;
618 		req->ir_request[2] = 0;
619 		req->ir_request[3] = 0;	/* Timer use */
620 		req->ir_request[4] = 0;
621 		req->ir_request[5] = 0;
622 	}
623 
624 	error = ipmi_submit_driver_request(sc, req, 0);
625 	if (error)
626 		device_printf(sc->ipmi_dev, "Failed to set watchdog\n");
627 
628 	if (error == 0 && sec) {
629 		ipmi_free_request(req);
630 
631 		req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
632 		    IPMI_RESET_WDOG, 0, 0);
633 
634 		error = ipmi_submit_driver_request(sc, req, 0);
635 		if (error)
636 			device_printf(sc->ipmi_dev,
637 			    "Failed to reset watchdog\n");
638 	}
639 
640 	ipmi_free_request(req);
641 	/*
642 	dump_watchdog(sc);
643 	*/
644 }
645 
646 static void
647 ipmi_wd_event(void *arg, unsigned int cmd, int *error)
648 {
649 	struct ipmi_softc *sc = arg;
650 	unsigned int timeout;
651 
652 	/* disable / enable */
653 	if (!(cmd & WD_ACTIVE)) {
654 		ipmi_set_watchdog(sc, 0);
655 		*error = 0;
656 		return;
657 	}
658 
659 	cmd &= WD_INTERVAL;
660 	/* convert from power-of-to-ns to WDT ticks */
661 	if (cmd >= 64) {
662 		*error = EINVAL;
663 		return;
664 	}
665 	timeout = ((uint64_t)1 << cmd) / 1800000000;
666 
667 	/* reload */
668 	ipmi_set_watchdog(sc, timeout);
669 
670 	*error = 0;
671 }
672 
673 #ifdef CLONING
674 static void
675 ipmi_clone(void *arg, struct ucred *cred, char *name, int namelen,
676     struct cdev **cdev)
677 {
678 	struct ipmi_softc *sc = arg;
679 	struct ipmi_device *dev;
680 	int minor, unit;
681 
682 	if (*cdev != NULL)
683 		return;
684 
685 	if (strcmp(name, device_get_nameunit(sc->ipmi_dev)) != 0)
686 		return;
687 
688 	dev = malloc(sizeof(struct ipmi_device), M_IPMI, M_WAITOK | M_ZERO);
689 
690 	/* Reserve a sub-device. */
691 	IPMI_LOCK(sc);
692 	minor = ffs(~(sc->ipmi_cdev_mask & 0xffff));
693 	if (minor == 0 || !sc->ipmi_cloning) {
694 		IPMI_UNLOCK(sc);
695 		free(dev, M_IPMI);
696 		return;
697 	}
698 	minor--;
699 	sc->ipmi_cdev_mask |= (1 << minor);
700 	TAILQ_INSERT_TAIL(&sc->ipmi_cdevs, dev, ipmi_link);
701 	IPMI_UNLOCK(sc);
702 
703 	/* Initialize the device. */
704 	TAILQ_INIT(&dev->ipmi_completed_requests);
705 	dev->ipmi_softc = sc;
706 	dev->ipmi_address = IPMI_BMC_SLAVE_ADDR;
707 	dev->ipmi_lun = IPMI_BMC_SMS_LUN;
708 	unit = device_get_unit(sc->ipmi_dev);
709 	dev->ipmi_cdev = make_dev_cred(&ipmi_cdevsw, unit * 32 + minor, cred,
710 	    UID_ROOT, GID_OPERATOR, 0660, "ipmi%d.%d", unit, minor);
711 	if (dev->ipmi_cdev == NULL) {
712 		IPMI_LOCK(sc);
713 		sc->ipmi_cdev_mask &= ~(1 << minor);
714 		TAILQ_REMOVE(&sc->ipmi_cdevs, dev, ipmi_link);
715 		IPMI_UNLOCK(sc);
716 		free(dev, M_IPMI);
717 		return;
718 	}
719 	dev->ipmi_cdev->si_drv1 = dev;
720 	*cdev = dev->ipmi_cdev;
721 	dev_ref(*cdev);
722 }
723 #endif
724 
725 static void
726 ipmi_startup(void *arg)
727 {
728 	struct ipmi_softc *sc = arg;
729 	struct ipmi_request *req;
730 	device_t dev;
731 	int error, i;
732 
733 	config_intrhook_disestablish(&sc->ipmi_ich);
734 	dev = sc->ipmi_dev;
735 
736 	/* Initialize interface-independent state. */
737 	mtx_init(&sc->ipmi_lock, device_get_nameunit(dev), "ipmi", MTX_DEF);
738 	cv_init(&sc->ipmi_request_added, "ipmireq");
739 	TAILQ_INIT(&sc->ipmi_pending_requests);
740 #ifdef CLONING
741 	TAILQ_INIT(&sc->ipmi_cdevs);
742 #endif
743 
744 	/* Initialize interface-dependent state. */
745 	error = sc->ipmi_startup(sc);
746 	if (error) {
747 		device_printf(dev, "Failed to initialize interface: %d\n",
748 		    error);
749 		return;
750 	}
751 
752 	/* Send a GET_DEVICE_ID request. */
753 	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
754 	    IPMI_GET_DEVICE_ID, 0, 15);
755 
756 	error = ipmi_submit_driver_request(sc, req, MAX_TIMEOUT);
757 	if (error == EWOULDBLOCK) {
758 		device_printf(dev, "Timed out waiting for GET_DEVICE_ID\n");
759 		return;
760 	} else if (error) {
761 		device_printf(dev, "Failed GET_DEVICE_ID: %d\n", error);
762 		return;
763 	} else if (req->ir_compcode != 0) {
764 		device_printf(dev,
765 		    "Bad completion code for GET_DEVICE_ID: %d\n",
766 		    req->ir_compcode);
767 		return;
768 	} else if (req->ir_replylen < 5) {
769 		device_printf(dev, "Short reply for GET_DEVICE_ID: %d\n",
770 		    req->ir_replylen);
771 		return;
772 	}
773 
774 	device_printf(dev, "IPMI device rev. %d, firmware rev. %d.%d, "
775 	    "version %d.%d\n",
776 	     req->ir_reply[1] & 0x0f,
777 	     req->ir_reply[2] & 0x0f, req->ir_reply[4],
778 	     req->ir_reply[4] & 0x0f, req->ir_reply[4] >> 4);
779 
780 	ipmi_free_request(req);
781 
782 	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
783 	    IPMI_CLEAR_FLAGS, 1, 0);
784 
785 	ipmi_submit_driver_request(sc, req, 0);
786 
787 	/* XXX: Magic numbers */
788 	if (req->ir_compcode == 0xc0) {
789 		device_printf(dev, "Clear flags is busy\n");
790 	}
791 	if (req->ir_compcode == 0xc1) {
792 		device_printf(dev, "Clear flags illegal\n");
793 	}
794 	ipmi_free_request(req);
795 
796 	for (i = 0; i < 8; i++) {
797 		req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
798 		    IPMI_GET_CHANNEL_INFO, 1, 0);
799 		req->ir_request[0] = i;
800 
801 		ipmi_submit_driver_request(sc, req, 0);
802 
803 		if (req->ir_compcode != 0) {
804 			ipmi_free_request(req);
805 			break;
806 		}
807 		ipmi_free_request(req);
808 	}
809 	device_printf(dev, "Number of channels %d\n", i);
810 
811 	/* probe for watchdog */
812 	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
813 	    IPMI_GET_WDOG, 0, 0);
814 
815 	ipmi_submit_driver_request(sc, req, 0);
816 
817 	if (req->ir_compcode == 0x00) {
818 		device_printf(dev, "Attached watchdog\n");
819 		/* register the watchdog event handler */
820 		sc->ipmi_watchdog_tag = EVENTHANDLER_REGISTER(watchdog_list,
821 		    ipmi_wd_event, sc, 0);
822 	}
823 	ipmi_free_request(req);
824 
825 #ifdef CLONING
826 	sc->ipmi_cloning = 1;
827 	sc->ipmi_clone_tag = EVENTHANDLER_REGISTER(dev_clone,  ipmi_clone, sc,
828 	    1000);
829 #else
830 	/* Initialize the device. */
831 	TAILQ_INIT(&sc->ipmi_idev.ipmi_completed_requests);
832 	sc->ipmi_idev.ipmi_softc = sc;
833 	sc->ipmi_idev.ipmi_address = IPMI_BMC_SLAVE_ADDR;
834 	sc->ipmi_idev.ipmi_lun = IPMI_BMC_SMS_LUN;
835 	sc->ipmi_idev.ipmi_cdev = make_dev(&ipmi_cdevsw, device_get_unit(dev),
836 	    UID_ROOT, GID_OPERATOR, 0660, "ipmi%d", device_get_unit(dev));
837 	if (sc->ipmi_idev.ipmi_cdev == NULL) {
838 		device_printf(dev, "Failed to create cdev\n");
839 		return;
840 	}
841 	sc->ipmi_idev.ipmi_cdev->si_drv1 = &sc->ipmi_idev;
842 #endif
843 }
844 
845 int
846 ipmi_attach(device_t dev)
847 {
848 	struct ipmi_softc *sc = device_get_softc(dev);
849 	int error;
850 
851 	if (sc->ipmi_irq_res != NULL && sc->ipmi_intr != NULL) {
852 		error = bus_setup_intr(dev, sc->ipmi_irq_res, INTR_TYPE_MISC,
853 		    sc->ipmi_intr, sc, &sc->ipmi_irq);
854 		if (error) {
855 			device_printf(dev, "can't set up interrupt\n");
856 			return (error);
857 		}
858 	}
859 
860 	bzero(&sc->ipmi_ich, sizeof(struct intr_config_hook));
861 	sc->ipmi_ich.ich_func = ipmi_startup;
862 	sc->ipmi_ich.ich_arg = sc;
863 	if (config_intrhook_establish(&sc->ipmi_ich) != 0) {
864 		device_printf(dev, "can't establish configuration hook\n");
865 		return (ENOMEM);
866 	}
867 
868 	ipmi_attached = 1;
869 	return (0);
870 }
871 
872 int
873 ipmi_detach(device_t dev)
874 {
875 	struct ipmi_softc *sc;
876 
877 	sc = device_get_softc(dev);
878 
879 	/* Fail if there are any open handles. */
880 	IPMI_LOCK(sc);
881 #ifdef CLONING
882 	if (!TAILQ_EMPTY(&sc->ipmi_cdevs)) {
883 		IPMI_UNLOCK(sc);
884 		return (EBUSY);
885 	}
886 
887 	/* Turn off cloning. */
888 	sc->ipmi_cloning = 0;
889 	IPMI_UNLOCK(sc);
890 
891 	EVENTHANDLER_DEREGISTER(dev_clone, sc->ipmi_clone_tag);
892 #else
893 	if (sc->ipmi_idev.ipmi_open) {
894 		IPMI_UNLOCK(sc);
895 		return (EBUSY);
896 	}
897 	IPMI_UNLOCK(sc);
898 	destroy_dev(sc->ipmi_idev.ipmi_cdev);
899 #endif
900 
901 	/* Detach from watchdog handling and turn off watchdog. */
902 	if (sc->ipmi_watchdog_tag) {
903 		EVENTHANDLER_DEREGISTER(watchdog_list, sc->ipmi_watchdog_tag);
904 		ipmi_set_watchdog(sc, 0);
905 	}
906 
907 	/* XXX: should use shutdown callout I think. */
908 	/* If the backend uses a kthread, shut it down. */
909 	IPMI_LOCK(sc);
910 	sc->ipmi_detaching = 1;
911 	if (sc->ipmi_kthread) {
912 		cv_broadcast(&sc->ipmi_request_added);
913 		msleep(sc->ipmi_kthread, &sc->ipmi_lock, 0, "ipmi_wait", 0);
914 	}
915 	IPMI_UNLOCK(sc);
916 	if (sc->ipmi_irq)
917 		bus_teardown_intr(dev, sc->ipmi_irq_res, sc->ipmi_irq);
918 
919 	ipmi_release_resources(dev);
920 	mtx_destroy(&sc->ipmi_lock);
921 	return (0);
922 }
923 
924 void
925 ipmi_release_resources(device_t dev)
926 {
927 	struct ipmi_softc *sc;
928 	int i;
929 
930 	sc = device_get_softc(dev);
931 	if (sc->ipmi_irq)
932 		bus_teardown_intr(dev, sc->ipmi_irq_res, sc->ipmi_irq);
933 	if (sc->ipmi_irq_res)
934 		bus_release_resource(dev, SYS_RES_IRQ, sc->ipmi_irq_rid,
935 		    sc->ipmi_irq_res);
936 	for (i = 0; i < MAX_RES; i++)
937 		if (sc->ipmi_io_res[i])
938 			bus_release_resource(dev, sc->ipmi_io_type,
939 			    sc->ipmi_io_rid + i, sc->ipmi_io_res[i]);
940 }
941 
942 devclass_t ipmi_devclass;
943 
944 /* XXX: Why? */
945 static void
946 ipmi_unload(void *arg)
947 {
948 	device_t *	devs;
949 	int		count;
950 	int		i;
951 
952 	if (devclass_get_devices(ipmi_devclass, &devs, &count) != 0)
953 		return;
954 	for (i = 0; i < count; i++)
955 		device_delete_child(device_get_parent(devs[i]), devs[i]);
956 	free(devs, M_TEMP);
957 }
958 SYSUNINIT(ipmi_unload, SI_SUB_DRIVERS, SI_ORDER_FIRST, ipmi_unload, NULL);
959 
960 #ifdef IMPI_DEBUG
961 static void
962 dump_buf(u_char *data, int len)
963 {
964 	char buf[20];
965 	char line[1024];
966 	char temp[30];
967 	int count = 0;
968 	int i=0;
969 
970 	printf("Address %p len %d\n", data, len);
971 	if (len > 256)
972 		len = 256;
973 	line[0] = '\000';
974 	for (; len > 0; len--, data++) {
975 		sprintf(temp, "%02x ", *data);
976 		strcat(line, temp);
977 		if (*data >= ' ' && *data <= '~')
978 			buf[count] = *data;
979 		else if (*data >= 'A' && *data <= 'Z')
980 			buf[count] = *data;
981 		else
982 			buf[count] = '.';
983 		if (++count == 16) {
984 			buf[count] = '\000';
985 			count = 0;
986 			printf("  %3x  %s %s\n", i, line, buf);
987 			i+=16;
988 			line[0] = '\000';
989 		}
990 	}
991 	buf[count] = '\000';
992 
993 	for (; count != 16; count++) {
994 		strcat(line, "   ");
995 	}
996 	printf("  %3x  %s %s\n", i, line, buf);
997 }
998 #endif
999