2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/condvar.h>
37 #include <sys/eventhandler.h>
38 #include <sys/kernel.h>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <sys/mutex.h>
44 #include <sys/reboot.h>
46 #include <sys/selinfo.h>
47 #include <sys/sysctl.h>
48 #include <sys/watchdog.h>
55 #include <dev/ipmi/ipmivars.h>
58 #ifdef IPMICTL_SEND_COMMAND_32
59 #include <sys/abi_compat.h>
63 * Driver request structures are allocated on the stack via alloca() to
64 * avoid calling malloc(), especially for the watchdog handler.
65 * To avoid too much stack growth, a previously allocated structure can
66 * be reused via IPMI_INIT_DRIVER_REQUEST(), but the caller should ensure
67 * that there is adequate reply/request space in the original allocation.
69 #define IPMI_INIT_DRIVER_REQUEST(req, addr, cmd, reqlen, replylen) \
70 bzero((req), sizeof(struct ipmi_request)); \
71 ipmi_init_request((req), NULL, 0, (addr), (cmd), (reqlen), (replylen))
73 #define IPMI_ALLOC_DRIVER_REQUEST(req, addr, cmd, reqlen, replylen) \
74 (req) = __builtin_alloca(sizeof(struct ipmi_request) + \
75 (reqlen) + (replylen)); \
76 IPMI_INIT_DRIVER_REQUEST((req), (addr), (cmd), (reqlen), \
80 static int ipmi_ipmb_checksum(u_char, int);
81 static int ipmi_ipmb_send_message(device_t, u_char, u_char, u_char,
85 static d_ioctl_t ipmi_ioctl;
86 static d_poll_t ipmi_poll;
87 static d_open_t ipmi_open;
88 static void ipmi_dtor(void *arg);
90 int ipmi_attached = 0;
93 static bool wd_in_shutdown = false;
94 static int wd_timer_actions = IPMI_SET_WD_ACTION_POWER_CYCLE;
95 static int wd_shutdown_countdown = 0; /* sec */
96 static int wd_startup_countdown = 0; /* sec */
97 static int wd_pretimeout_countdown = 120; /* sec */
98 static int cycle_wait = 10; /* sec */
100 static SYSCTL_NODE(_hw, OID_AUTO, ipmi, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
101 "IPMI driver parameters");
102 SYSCTL_INT(_hw_ipmi, OID_AUTO, on, CTLFLAG_RWTUN,
104 SYSCTL_INT(_hw_ipmi, OID_AUTO, wd_timer_actions, CTLFLAG_RW,
105 &wd_timer_actions, 0,
106 "IPMI watchdog timer actions (including pre-timeout interrupt)");
107 SYSCTL_INT(_hw_ipmi, OID_AUTO, wd_shutdown_countdown, CTLFLAG_RW,
108 &wd_shutdown_countdown, 0,
109 "IPMI watchdog countdown for shutdown (seconds)");
110 SYSCTL_INT(_hw_ipmi, OID_AUTO, wd_startup_countdown, CTLFLAG_RDTUN,
111 &wd_startup_countdown, 0,
112 "IPMI watchdog countdown initialized during startup (seconds)");
113 SYSCTL_INT(_hw_ipmi, OID_AUTO, wd_pretimeout_countdown, CTLFLAG_RW,
114 &wd_pretimeout_countdown, 0,
115 "IPMI watchdog pre-timeout countdown (seconds)");
116 SYSCTL_INT(_hw_ipmi, OID_AUTO, cyle_wait, CTLFLAG_RWTUN,
118 "IPMI power cycle on reboot delay time (seconds)");
120 static struct cdevsw ipmi_cdevsw = {
121 .d_version = D_VERSION,
123 .d_ioctl = ipmi_ioctl,
128 static MALLOC_DEFINE(M_IPMI, "ipmi", "ipmi");
131 ipmi_open(struct cdev *cdev, int flags, int fmt, struct thread *td)
133 struct ipmi_device *dev;
134 struct ipmi_softc *sc;
140 /* Initialize the per file descriptor data. */
141 dev = malloc(sizeof(struct ipmi_device), M_IPMI, M_WAITOK | M_ZERO);
142 error = devfs_set_cdevpriv(dev, ipmi_dtor);
149 TAILQ_INIT(&dev->ipmi_completed_requests);
150 dev->ipmi_address = IPMI_BMC_SLAVE_ADDR;
151 dev->ipmi_lun = IPMI_BMC_SMS_LUN;
152 dev->ipmi_softc = sc;
161 ipmi_poll(struct cdev *cdev, int poll_events, struct thread *td)
163 struct ipmi_device *dev;
164 struct ipmi_softc *sc;
167 if (devfs_get_cdevpriv((void **)&dev))
172 if (poll_events & (POLLIN | POLLRDNORM)) {
173 if (!TAILQ_EMPTY(&dev->ipmi_completed_requests))
174 revents |= poll_events & (POLLIN | POLLRDNORM);
175 if (dev->ipmi_requests == 0)
180 if (poll_events & (POLLIN | POLLRDNORM))
181 selrecord(td, &dev->ipmi_select);
189 ipmi_purge_completed_requests(struct ipmi_device *dev)
191 struct ipmi_request *req;
193 while (!TAILQ_EMPTY(&dev->ipmi_completed_requests)) {
194 req = TAILQ_FIRST(&dev->ipmi_completed_requests);
195 TAILQ_REMOVE(&dev->ipmi_completed_requests, req, ir_link);
196 dev->ipmi_requests--;
197 ipmi_free_request(req);
204 struct ipmi_request *req, *nreq;
205 struct ipmi_device *dev;
206 struct ipmi_softc *sc;
209 sc = dev->ipmi_softc;
212 if (dev->ipmi_requests) {
213 /* Throw away any pending requests for this device. */
214 TAILQ_FOREACH_SAFE(req, &sc->ipmi_pending_requests, ir_link,
216 if (req->ir_owner == dev) {
217 TAILQ_REMOVE(&sc->ipmi_pending_requests, req,
219 dev->ipmi_requests--;
220 ipmi_free_request(req);
224 /* Throw away any pending completed requests for this device. */
225 ipmi_purge_completed_requests(dev);
228 * If we still have outstanding requests, they must be stuck
229 * in an interface driver, so wait for those to drain.
231 dev->ipmi_closing = 1;
232 while (dev->ipmi_requests > 0) {
233 msleep(&dev->ipmi_requests, &sc->ipmi_requests_lock,
234 PWAIT, "ipmidrain", 0);
235 ipmi_purge_completed_requests(dev);
247 ipmi_ipmb_checksum(u_char *data, int len)
257 /* XXX: Needs work */
259 ipmi_ipmb_send_message(device_t dev, u_char channel, u_char netfn,
260 u_char command, u_char seq, u_char *data, int data_len)
262 struct ipmi_softc *sc = device_get_softc(dev);
263 struct ipmi_request *req;
264 u_char slave_addr = 0x52;
267 IPMI_ALLOC_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
268 IPMI_SEND_MSG, data_len + 8, 0);
269 req->ir_request[0] = channel;
270 req->ir_request[1] = slave_addr;
271 req->ir_request[2] = IPMI_ADDR(netfn, 0);
272 req->ir_request[3] = ipmi_ipmb_checksum(&req->ir_request[1], 2);
273 req->ir_request[4] = sc->ipmi_address;
274 req->ir_request[5] = IPMI_ADDR(seq, sc->ipmi_lun);
275 req->ir_request[6] = command;
277 bcopy(data, &req->ir_request[7], data_len);
278 temp[data_len + 7] = ipmi_ipmb_checksum(&req->ir_request[4],
281 ipmi_submit_driver_request(sc, req);
282 error = req->ir_error;
288 ipmi_handle_attn(struct ipmi_softc *sc)
290 struct ipmi_request *req;
293 device_printf(sc->ipmi_dev, "BMC has a message\n");
294 IPMI_ALLOC_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
295 IPMI_GET_MSG_FLAGS, 0, 1);
297 ipmi_submit_driver_request(sc, req);
299 if (req->ir_error == 0 && req->ir_compcode == 0) {
300 if (req->ir_reply[0] & IPMI_MSG_BUFFER_FULL) {
301 device_printf(sc->ipmi_dev, "message buffer full");
303 if (req->ir_reply[0] & IPMI_WDT_PRE_TIMEOUT) {
304 device_printf(sc->ipmi_dev,
305 "watchdog about to go off");
307 if (req->ir_reply[0] & IPMI_MSG_AVAILABLE) {
308 IPMI_ALLOC_DRIVER_REQUEST(req,
309 IPMI_ADDR(IPMI_APP_REQUEST, 0), IPMI_GET_MSG, 0,
312 device_printf(sc->ipmi_dev, "throw out message ");
316 error = req->ir_error;
323 ipmi_ioctl(struct cdev *cdev, u_long cmd, caddr_t data,
324 int flags, struct thread *td)
326 struct ipmi_softc *sc;
327 struct ipmi_device *dev;
328 struct ipmi_request *kreq;
329 struct ipmi_req *req = (struct ipmi_req *)data;
330 struct ipmi_recv *recv = (struct ipmi_recv *)data;
331 struct ipmi_addr addr;
332 #ifdef IPMICTL_SEND_COMMAND_32
333 struct ipmi_req32 *req32 = (struct ipmi_req32 *)data;
334 struct ipmi_recv32 *recv32 = (struct ipmi_recv32 *)data;
337 struct ipmi_recv recv;
342 error = devfs_get_cdevpriv((void **)&dev);
348 #ifdef IPMICTL_SEND_COMMAND_32
349 /* Convert 32-bit structures to native. */
351 case IPMICTL_SEND_COMMAND_32:
353 req->addr = PTRIN(req32->addr);
354 req->addr_len = req32->addr_len;
355 req->msgid = req32->msgid;
356 req->msg.netfn = req32->msg.netfn;
357 req->msg.cmd = req32->msg.cmd;
358 req->msg.data_len = req32->msg.data_len;
359 req->msg.data = PTRIN(req32->msg.data);
361 case IPMICTL_RECEIVE_MSG_TRUNC_32:
362 case IPMICTL_RECEIVE_MSG_32:
363 recv = &thunk32.recv;
364 recv->addr = PTRIN(recv32->addr);
365 recv->addr_len = recv32->addr_len;
366 recv->msg.data_len = recv32->msg.data_len;
367 recv->msg.data = PTRIN(recv32->msg.data);
373 #ifdef IPMICTL_SEND_COMMAND_32
374 case IPMICTL_SEND_COMMAND_32:
376 case IPMICTL_SEND_COMMAND:
378 * XXX: Need to add proper handling of this.
380 error = copyin(req->addr, &addr, sizeof(addr));
385 /* clear out old stuff in queue of stuff done */
386 /* XXX: This seems odd. */
387 while ((kreq = TAILQ_FIRST(&dev->ipmi_completed_requests))) {
388 TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq,
390 dev->ipmi_requests--;
391 ipmi_free_request(kreq);
395 kreq = ipmi_alloc_request(dev, req->msgid,
396 IPMI_ADDR(req->msg.netfn, 0), req->msg.cmd,
397 req->msg.data_len, IPMI_MAX_RX);
398 error = copyin(req->msg.data, kreq->ir_request,
401 ipmi_free_request(kreq);
405 dev->ipmi_requests++;
406 error = sc->ipmi_enqueue_request(sc, kreq);
411 #ifdef IPMICTL_SEND_COMMAND_32
412 case IPMICTL_RECEIVE_MSG_TRUNC_32:
413 case IPMICTL_RECEIVE_MSG_32:
415 case IPMICTL_RECEIVE_MSG_TRUNC:
416 case IPMICTL_RECEIVE_MSG:
417 error = copyin(recv->addr, &addr, sizeof(addr));
422 kreq = TAILQ_FIRST(&dev->ipmi_completed_requests);
427 addr.channel = IPMI_BMC_CHANNEL;
429 recv->recv_type = IPMI_RESPONSE_RECV_TYPE;
430 recv->msgid = kreq->ir_msgid;
431 recv->msg.netfn = IPMI_REPLY_ADDR(kreq->ir_addr) >> 2;
432 recv->msg.cmd = kreq->ir_command;
433 error = kreq->ir_error;
435 TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq,
437 dev->ipmi_requests--;
439 ipmi_free_request(kreq);
442 len = kreq->ir_replylen + 1;
443 if (recv->msg.data_len < len &&
444 (cmd == IPMICTL_RECEIVE_MSG
445 #ifdef IPMICTL_RECEIVE_MSG_32
446 || cmd == IPMICTL_RECEIVE_MSG_32
452 TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq, ir_link);
453 dev->ipmi_requests--;
455 len = min(recv->msg.data_len, len);
456 recv->msg.data_len = len;
457 error = copyout(&addr, recv->addr,sizeof(addr));
459 error = copyout(&kreq->ir_compcode, recv->msg.data, 1);
461 error = copyout(kreq->ir_reply, recv->msg.data + 1,
463 ipmi_free_request(kreq);
467 case IPMICTL_SET_MY_ADDRESS_CMD:
469 dev->ipmi_address = *(int*)data;
472 case IPMICTL_GET_MY_ADDRESS_CMD:
474 *(int*)data = dev->ipmi_address;
477 case IPMICTL_SET_MY_LUN_CMD:
479 dev->ipmi_lun = *(int*)data & 0x3;
482 case IPMICTL_GET_MY_LUN_CMD:
484 *(int*)data = dev->ipmi_lun;
487 case IPMICTL_SET_GETS_EVENTS_CMD:
489 device_printf(sc->ipmi_dev,
490 "IPMICTL_SET_GETS_EVENTS_CMD NA\n");
493 case IPMICTL_REGISTER_FOR_CMD:
494 case IPMICTL_UNREGISTER_FOR_CMD:
497 device_printf(sc->ipmi_dev, "Unknown IOCTL %lX\n", cmd);
501 #ifdef IPMICTL_SEND_COMMAND_32
502 /* Update changed fields in 32-bit structures. */
504 case IPMICTL_RECEIVE_MSG_TRUNC_32:
505 case IPMICTL_RECEIVE_MSG_32:
506 recv32->recv_type = recv->recv_type;
507 recv32->msgid = recv->msgid;
508 recv32->msg.netfn = recv->msg.netfn;
509 recv32->msg.cmd = recv->msg.cmd;
510 recv32->msg.data_len = recv->msg.data_len;
518 * Request management.
522 ipmi_init_request(struct ipmi_request *req, struct ipmi_device *dev, long msgid,
523 uint8_t addr, uint8_t command, size_t requestlen, size_t replylen)
527 req->ir_msgid = msgid;
529 req->ir_command = command;
531 req->ir_request = (char *)&req[1];
532 req->ir_requestlen = requestlen;
535 req->ir_reply = (char *)&req[1] + requestlen;
536 req->ir_replybuflen = replylen;
540 /* Allocate a new request with request and reply buffers. */
541 struct ipmi_request *
542 ipmi_alloc_request(struct ipmi_device *dev, long msgid, uint8_t addr,
543 uint8_t command, size_t requestlen, size_t replylen)
545 struct ipmi_request *req;
547 req = malloc(sizeof(struct ipmi_request) + requestlen + replylen,
548 M_IPMI, M_WAITOK | M_ZERO);
549 ipmi_init_request(req, dev, msgid, addr, command, requestlen, replylen);
553 /* Free a request no longer in use. */
555 ipmi_free_request(struct ipmi_request *req)
561 /* Store a processed request on the appropriate completion queue. */
563 ipmi_complete_request(struct ipmi_softc *sc, struct ipmi_request *req)
565 struct ipmi_device *dev;
567 IPMI_LOCK_ASSERT(sc);
570 * Anonymous requests (from inside the driver) always have a
571 * waiter that we awaken.
573 if (req->ir_owner == NULL)
577 TAILQ_INSERT_TAIL(&dev->ipmi_completed_requests, req, ir_link);
578 selwakeup(&dev->ipmi_select);
579 if (dev->ipmi_closing)
580 wakeup(&dev->ipmi_requests);
584 /* Perform an internal driver request. */
586 ipmi_submit_driver_request(struct ipmi_softc *sc, struct ipmi_request *req,
590 return (sc->ipmi_driver_request(sc, req, timo));
594 * Helper routine for polled system interfaces that use
595 * ipmi_polled_enqueue_request() to queue requests. This request
596 * waits until there is a pending request and then returns the first
597 * request. If the driver is shutting down, it returns NULL.
599 struct ipmi_request *
600 ipmi_dequeue_request(struct ipmi_softc *sc)
602 struct ipmi_request *req;
604 IPMI_LOCK_ASSERT(sc);
606 while (!sc->ipmi_detaching && TAILQ_EMPTY(&sc->ipmi_pending_requests))
607 cv_wait(&sc->ipmi_request_added, &sc->ipmi_requests_lock);
608 if (sc->ipmi_detaching)
611 req = TAILQ_FIRST(&sc->ipmi_pending_requests);
612 TAILQ_REMOVE(&sc->ipmi_pending_requests, req, ir_link);
616 /* Default implementation of ipmi_enqueue_request() for polled interfaces. */
618 ipmi_polled_enqueue_request(struct ipmi_softc *sc, struct ipmi_request *req)
621 IPMI_LOCK_ASSERT(sc);
623 TAILQ_INSERT_TAIL(&sc->ipmi_pending_requests, req, ir_link);
624 cv_signal(&sc->ipmi_request_added);
629 * Watchdog event handler.
633 ipmi_reset_watchdog(struct ipmi_softc *sc)
635 struct ipmi_request *req;
638 IPMI_ALLOC_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
639 IPMI_RESET_WDOG, 0, 0);
640 error = ipmi_submit_driver_request(sc, req, 0);
642 device_printf(sc->ipmi_dev, "Failed to reset watchdog\n");
647 ipmi_set_watchdog(struct ipmi_softc *sc, unsigned int sec)
649 struct ipmi_request *req;
652 if (sec > 0xffff / 10)
655 IPMI_ALLOC_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
656 IPMI_SET_WDOG, 6, 0);
658 req->ir_request[0] = IPMI_SET_WD_TIMER_DONT_STOP
659 | IPMI_SET_WD_TIMER_SMS_OS;
660 req->ir_request[1] = (wd_timer_actions & 0xff);
661 req->ir_request[2] = (wd_pretimeout_countdown & 0xff);
662 req->ir_request[3] = 0; /* Timer use */
663 req->ir_request[4] = (sec * 10) & 0xff;
664 req->ir_request[5] = (sec * 10) >> 8;
666 req->ir_request[0] = IPMI_SET_WD_TIMER_SMS_OS;
667 req->ir_request[1] = 0;
668 req->ir_request[2] = 0;
669 req->ir_request[3] = 0; /* Timer use */
670 req->ir_request[4] = 0;
671 req->ir_request[5] = 0;
673 error = ipmi_submit_driver_request(sc, req, 0);
675 device_printf(sc->ipmi_dev, "Failed to set watchdog\n");
680 ipmi_wd_event(void *arg, unsigned int cmd, int *error)
682 struct ipmi_softc *sc = arg;
683 unsigned int timeout;
686 /* Ignore requests while disabled. */
691 * To prevent infinite hangs, we don't let anyone pat or change
692 * the watchdog when we're shutting down. (See ipmi_shutdown_event().)
693 * However, we do want to keep patting the watchdog while we are doing
696 if (wd_in_shutdown) {
697 if (dumping && sc->ipmi_watchdog_active)
698 ipmi_reset_watchdog(sc);
703 if (cmd > 0 && cmd <= 63) {
704 timeout = ((uint64_t)1 << cmd) / 1000000000;
707 if (timeout != sc->ipmi_watchdog_active ||
708 wd_timer_actions != sc->ipmi_watchdog_actions ||
709 wd_pretimeout_countdown != sc->ipmi_watchdog_pretimeout) {
710 e = ipmi_set_watchdog(sc, timeout);
712 sc->ipmi_watchdog_active = timeout;
713 sc->ipmi_watchdog_actions = wd_timer_actions;
714 sc->ipmi_watchdog_pretimeout = wd_pretimeout_countdown;
716 (void)ipmi_set_watchdog(sc, 0);
717 sc->ipmi_watchdog_active = 0;
718 sc->ipmi_watchdog_actions = 0;
719 sc->ipmi_watchdog_pretimeout = 0;
722 if (sc->ipmi_watchdog_active != 0) {
723 e = ipmi_reset_watchdog(sc);
727 (void)ipmi_set_watchdog(sc, 0);
728 sc->ipmi_watchdog_active = 0;
729 sc->ipmi_watchdog_actions = 0;
730 sc->ipmi_watchdog_pretimeout = 0;
733 } else if (atomic_readandclear_int(&sc->ipmi_watchdog_active) != 0) {
734 sc->ipmi_watchdog_actions = 0;
735 sc->ipmi_watchdog_pretimeout = 0;
737 e = ipmi_set_watchdog(sc, 0);
738 if (e != 0 && cmd == 0)
744 ipmi_shutdown_event(void *arg, unsigned int cmd, int *error)
746 struct ipmi_softc *sc = arg;
748 /* Ignore event if disabled. */
753 * Positive wd_shutdown_countdown value will re-arm watchdog;
754 * Zero value in wd_shutdown_countdown will disable watchdog;
755 * Negative value in wd_shutdown_countdown will keep existing state;
757 * Revert to using a power cycle to ensure that the watchdog will
758 * do something useful here. Having the watchdog send an NMI
759 * instead is useless during shutdown, and might be ignored if an
760 * NMI already triggered.
763 wd_in_shutdown = true;
764 if (wd_shutdown_countdown == 0) {
765 /* disable watchdog */
766 ipmi_set_watchdog(sc, 0);
767 sc->ipmi_watchdog_active = 0;
768 } else if (wd_shutdown_countdown > 0) {
769 /* set desired action and time, and, reset watchdog */
770 wd_timer_actions = IPMI_SET_WD_ACTION_POWER_CYCLE;
771 ipmi_set_watchdog(sc, wd_shutdown_countdown);
772 sc->ipmi_watchdog_active = wd_shutdown_countdown;
773 ipmi_reset_watchdog(sc);
778 ipmi_power_cycle(void *arg, int howto)
780 struct ipmi_softc *sc = arg;
781 struct ipmi_request *req;
784 * Ignore everything except power cycling requests
786 if ((howto & RB_POWERCYCLE) == 0)
789 device_printf(sc->ipmi_dev, "Power cycling using IPMI\n");
792 * Send a CHASSIS_CONTROL command to the CHASSIS device, subcommand 2
793 * as described in IPMI v2.0 spec section 28.3.
795 IPMI_ALLOC_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_CHASSIS_REQUEST, 0),
796 IPMI_CHASSIS_CONTROL, 1, 0);
797 req->ir_request[0] = IPMI_CC_POWER_CYCLE;
799 ipmi_submit_driver_request(sc, req, MAX_TIMEOUT);
801 if (req->ir_error != 0 || req->ir_compcode != 0) {
802 device_printf(sc->ipmi_dev, "Power cycling via IPMI failed code %#x %#x\n",
803 req->ir_error, req->ir_compcode);
808 * BMCs are notoriously slow, give it cyle_wait seconds for the power
809 * down leg of the power cycle. If that fails, fallback to the next
810 * hanlder in the shutdown_final chain and/or the platform failsafe.
812 DELAY(cycle_wait * 1000 * 1000);
813 device_printf(sc->ipmi_dev, "Power cycling via IPMI timed out\n");
817 ipmi_startup(void *arg)
819 struct ipmi_softc *sc = arg;
820 struct ipmi_request *req;
824 config_intrhook_disestablish(&sc->ipmi_ich);
827 /* Initialize interface-independent state. */
828 mtx_init(&sc->ipmi_requests_lock, "ipmi requests", NULL, MTX_DEF);
829 mtx_init(&sc->ipmi_io_lock, "ipmi io", NULL, MTX_DEF);
830 cv_init(&sc->ipmi_request_added, "ipmireq");
831 TAILQ_INIT(&sc->ipmi_pending_requests);
833 /* Initialize interface-dependent state. */
834 error = sc->ipmi_startup(sc);
836 device_printf(dev, "Failed to initialize interface: %d\n",
841 /* Send a GET_DEVICE_ID request. */
842 IPMI_ALLOC_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
843 IPMI_GET_DEVICE_ID, 0, 15);
845 error = ipmi_submit_driver_request(sc, req, MAX_TIMEOUT);
846 if (error == EWOULDBLOCK) {
847 device_printf(dev, "Timed out waiting for GET_DEVICE_ID\n");
850 device_printf(dev, "Failed GET_DEVICE_ID: %d\n", error);
852 } else if (req->ir_compcode != 0) {
854 "Bad completion code for GET_DEVICE_ID: %d\n",
857 } else if (req->ir_replylen < 5) {
858 device_printf(dev, "Short reply for GET_DEVICE_ID: %d\n",
863 device_printf(dev, "IPMI device rev. %d, firmware rev. %d.%d%d, "
864 "version %d.%d, device support mask %#x\n",
865 req->ir_reply[1] & 0x0f,
866 req->ir_reply[2] & 0x7f, req->ir_reply[3] >> 4, req->ir_reply[3] & 0x0f,
867 req->ir_reply[4] & 0x0f, req->ir_reply[4] >> 4, req->ir_reply[5]);
869 sc->ipmi_dev_support = req->ir_reply[5];
871 IPMI_INIT_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
872 IPMI_CLEAR_FLAGS, 1, 0);
874 ipmi_submit_driver_request(sc, req, 0);
876 /* XXX: Magic numbers */
877 if (req->ir_compcode == 0xc0) {
878 device_printf(dev, "Clear flags is busy\n");
880 if (req->ir_compcode == 0xc1) {
881 device_printf(dev, "Clear flags illegal\n");
884 for (i = 0; i < 8; i++) {
885 IPMI_INIT_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
886 IPMI_GET_CHANNEL_INFO, 1, 0);
887 req->ir_request[0] = i;
889 ipmi_submit_driver_request(sc, req, 0);
891 if (req->ir_compcode != 0)
894 device_printf(dev, "Number of channels %d\n", i);
897 * Probe for watchdog, but only for backends which support
898 * polled driver requests.
900 if (sc->ipmi_driver_requests_polled) {
901 IPMI_INIT_DRIVER_REQUEST(req, IPMI_ADDR(IPMI_APP_REQUEST, 0),
902 IPMI_GET_WDOG, 0, 0);
904 ipmi_submit_driver_request(sc, req, 0);
906 if (req->ir_compcode == 0x00) {
907 device_printf(dev, "Attached watchdog\n");
908 /* register the watchdog event handler */
909 sc->ipmi_watchdog_tag = EVENTHANDLER_REGISTER(
910 watchdog_list, ipmi_wd_event, sc, 0);
911 sc->ipmi_shutdown_tag = EVENTHANDLER_REGISTER(
912 shutdown_pre_sync, ipmi_shutdown_event,
917 sc->ipmi_cdev = make_dev(&ipmi_cdevsw, device_get_unit(dev),
918 UID_ROOT, GID_OPERATOR, 0660, "ipmi%d", device_get_unit(dev));
919 if (sc->ipmi_cdev == NULL) {
920 device_printf(dev, "Failed to create cdev\n");
923 sc->ipmi_cdev->si_drv1 = sc;
926 * Set initial watchdog state. If desired, set an initial
927 * watchdog on startup. Or, if the watchdog device is
928 * disabled, clear any existing watchdog.
930 if (on && wd_startup_countdown > 0) {
931 wd_timer_actions = IPMI_SET_WD_ACTION_POWER_CYCLE;
932 if (ipmi_set_watchdog(sc, wd_startup_countdown) == 0 &&
933 ipmi_reset_watchdog(sc) == 0) {
934 sc->ipmi_watchdog_active = wd_startup_countdown;
935 sc->ipmi_watchdog_actions = wd_timer_actions;
936 sc->ipmi_watchdog_pretimeout = wd_pretimeout_countdown;
938 (void)ipmi_set_watchdog(sc, 0);
939 ipmi_reset_watchdog(sc);
941 (void)ipmi_set_watchdog(sc, 0);
943 * Power cycle the system off using IPMI. We use last - 2 since we don't
944 * handle all the other kinds of reboots. We'll let others handle them.
945 * We only try to do this if the BMC supports the Chassis device.
947 if (sc->ipmi_dev_support & IPMI_ADS_CHASSIS) {
948 device_printf(dev, "Establishing power cycle handler\n");
949 sc->ipmi_power_cycle_tag = EVENTHANDLER_REGISTER(shutdown_final,
950 ipmi_power_cycle, sc, SHUTDOWN_PRI_LAST - 2);
955 ipmi_attach(device_t dev)
957 struct ipmi_softc *sc = device_get_softc(dev);
960 if (sc->ipmi_irq_res != NULL && sc->ipmi_intr != NULL) {
961 error = bus_setup_intr(dev, sc->ipmi_irq_res, INTR_TYPE_MISC,
962 NULL, sc->ipmi_intr, sc, &sc->ipmi_irq);
964 device_printf(dev, "can't set up interrupt\n");
969 bzero(&sc->ipmi_ich, sizeof(struct intr_config_hook));
970 sc->ipmi_ich.ich_func = ipmi_startup;
971 sc->ipmi_ich.ich_arg = sc;
972 if (config_intrhook_establish(&sc->ipmi_ich) != 0) {
973 device_printf(dev, "can't establish configuration hook\n");
982 ipmi_detach(device_t dev)
984 struct ipmi_softc *sc;
986 sc = device_get_softc(dev);
988 /* Fail if there are any open handles. */
990 if (sc->ipmi_opened) {
996 destroy_dev(sc->ipmi_cdev);
998 /* Detach from watchdog handling and turn off watchdog. */
999 if (sc->ipmi_shutdown_tag)
1000 EVENTHANDLER_DEREGISTER(shutdown_pre_sync,
1001 sc->ipmi_shutdown_tag);
1002 if (sc->ipmi_watchdog_tag) {
1003 EVENTHANDLER_DEREGISTER(watchdog_list, sc->ipmi_watchdog_tag);
1004 ipmi_set_watchdog(sc, 0);
1007 /* Detach from shutdown handling for power cycle reboot */
1008 if (sc->ipmi_power_cycle_tag)
1009 EVENTHANDLER_DEREGISTER(shutdown_final, sc->ipmi_power_cycle_tag);
1011 /* XXX: should use shutdown callout I think. */
1012 /* If the backend uses a kthread, shut it down. */
1014 sc->ipmi_detaching = 1;
1015 if (sc->ipmi_kthread) {
1016 cv_broadcast(&sc->ipmi_request_added);
1017 msleep(sc->ipmi_kthread, &sc->ipmi_requests_lock, 0,
1022 bus_teardown_intr(dev, sc->ipmi_irq_res, sc->ipmi_irq);
1024 ipmi_release_resources(dev);
1025 mtx_destroy(&sc->ipmi_io_lock);
1026 mtx_destroy(&sc->ipmi_requests_lock);
1031 ipmi_release_resources(device_t dev)
1033 struct ipmi_softc *sc;
1036 sc = device_get_softc(dev);
1038 bus_teardown_intr(dev, sc->ipmi_irq_res, sc->ipmi_irq);
1039 if (sc->ipmi_irq_res)
1040 bus_release_resource(dev, SYS_RES_IRQ, sc->ipmi_irq_rid,
1042 for (i = 0; i < MAX_RES; i++)
1043 if (sc->ipmi_io_res[i])
1044 bus_release_resource(dev, sc->ipmi_io_type,
1045 sc->ipmi_io_rid + i, sc->ipmi_io_res[i]);
1048 devclass_t ipmi_devclass;
1052 ipmi_unload(void *arg)
1058 if (ipmi_devclass == NULL)
1060 if (devclass_get_devices(ipmi_devclass, &devs, &count) != 0)
1062 for (i = 0; i < count; i++)
1063 device_delete_child(device_get_parent(devs[i]), devs[i]);
1066 SYSUNINIT(ipmi_unload, SI_SUB_DRIVERS, SI_ORDER_FIRST, ipmi_unload, NULL);
1070 dump_buf(u_char *data, int len)
1078 printf("Address %p len %d\n", data, len);
1082 for (; len > 0; len--, data++) {
1083 sprintf(temp, "%02x ", *data);
1085 if (*data >= ' ' && *data <= '~')
1087 else if (*data >= 'A' && *data <= 'Z')
1091 if (++count == 16) {
1092 buf[count] = '\000';
1094 printf(" %3x %s %s\n", i, line, buf);
1099 buf[count] = '\000';
1101 for (; count != 16; count++) {
1104 printf(" %3x %s %s\n", i, line, buf);