ipmi.c revision 163278
1259698Sdim/*-
2259698Sdim * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
3259698Sdim * All rights reserved.
4259698Sdim *
5259698Sdim * Redistribution and use in source and binary forms, with or without
6259698Sdim * modification, are permitted provided that the following conditions
7259698Sdim * are met:
8259698Sdim * 1. Redistributions of source code must retain the above copyright
9259698Sdim *    notice, this list of conditions and the following disclaimer.
10259698Sdim * 2. Redistributions in binary form must reproduce the above copyright
11259698Sdim *    notice, this list of conditions and the following disclaimer in the
12259698Sdim *    documentation and/or other materials provided with the distribution.
13259698Sdim *
14276479Sdim * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15259698Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16276479Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17259698Sdim * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18259698Sdim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19276479Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20280031Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21259698Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22259698Sdim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23259698Sdim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24259698Sdim * SUCH DAMAGE.
25259698Sdim */
26259698Sdim
27259698Sdim#include <sys/cdefs.h>
28259698Sdim__FBSDID("$FreeBSD: head/sys/dev/ipmi/ipmi.c 163278 2006-10-12 16:26:42Z jhb $");
29276479Sdim
30276479Sdim#include <sys/param.h>
31259698Sdim#include <sys/systm.h>
32259698Sdim#include <sys/bus.h>
33259698Sdim#include <sys/condvar.h>
34259698Sdim#include <sys/conf.h>
35259698Sdim#include <sys/kernel.h>
36288943Sdim#include <sys/malloc.h>
37288943Sdim#include <sys/module.h>
38288943Sdim#include <sys/poll.h>
39288943Sdim#include <sys/rman.h>
40259698Sdim#include <sys/selinfo.h>
41259698Sdim#include <sys/sysctl.h>
42259698Sdim#include <sys/watchdog.h>
43259698Sdim
44259698Sdim#ifdef LOCAL_MODULE
45259698Sdim#include <ipmi.h>
46259698Sdim#include <ipmivars.h>
47259698Sdim#else
48259698Sdim#include <sys/ipmi.h>
49259698Sdim#include <dev/ipmi/ipmivars.h>
50259698Sdim#endif
51259698Sdim
52259698Sdim#ifdef IPMB
53259698Sdimstatic int ipmi_ipmb_checksum(u_char, int);
54259698Sdimstatic int ipmi_ipmb_send_message(device_t, u_char, u_char, u_char,
55259698Sdim     u_char, u_char, int)
56259698Sdim#endif
57259698Sdim
58259698Sdimstatic d_ioctl_t ipmi_ioctl;
59259698Sdimstatic d_poll_t ipmi_poll;
60259698Sdimstatic d_open_t ipmi_open;
61259698Sdimstatic d_close_t ipmi_close;
62259698Sdim
63259698Sdimint ipmi_attached = 0;
64259698Sdim
65259698Sdim#define IPMI_MINOR	0
66259698Sdim
67259698Sdimstatic int on = 1;
68259698SdimSYSCTL_NODE(_hw, OID_AUTO, ipmi, CTLFLAG_RD, 0, "IPMI driver parameters");
69259698SdimSYSCTL_INT(_hw_ipmi, OID_AUTO, on, CTLFLAG_RW,
70259698Sdim	&on, 0, "");
71259698Sdim
72276479Sdimstatic struct cdevsw ipmi_cdevsw = {
73259698Sdim	.d_version =    D_VERSION,
74259698Sdim	.d_open =	ipmi_open,
75259698Sdim	.d_close =	ipmi_close,
76259698Sdim	.d_ioctl =	ipmi_ioctl,
77259698Sdim	.d_poll =	ipmi_poll,
78259698Sdim	.d_name =	"ipmi",
79259698Sdim};
80259698Sdim
81259698SdimMALLOC_DEFINE(M_IPMI, "ipmi", "ipmi");
82259698Sdim
83259698Sdimstatic int
84259698Sdimipmi_open(struct cdev *cdev, int flags, int fmt, struct thread *td)
85259698Sdim{
86259698Sdim	struct ipmi_device *dev;
87259698Sdim	struct ipmi_softc *sc;
88259698Sdim
89276479Sdim	if (!on)
90259698Sdim		return (ENOENT);
91259698Sdim
92259698Sdim	dev = cdev->si_drv1;
93276479Sdim	sc = dev->ipmi_softc;
94276479Sdim	IPMI_LOCK(sc);
95259698Sdim	if (dev->ipmi_open) {
96259698Sdim		IPMI_UNLOCK(sc);
97259698Sdim		return (EBUSY);
98259698Sdim	}
99259698Sdim	dev->ipmi_open = 1;
100259698Sdim	IPMI_UNLOCK(sc);
101259698Sdim
102259698Sdim	return (0);
103259698Sdim}
104259698Sdim
105259698Sdimstatic int
106259698Sdimipmi_poll(struct cdev *cdev, int poll_events, struct thread *td)
107259698Sdim{
108259698Sdim	struct ipmi_device *dev;
109259698Sdim	struct ipmi_softc *sc;
110259698Sdim	int revents = 0;
111259698Sdim
112259698Sdim	dev = cdev->si_drv1;
113259698Sdim	sc = dev->ipmi_softc;
114259698Sdim
115259698Sdim	IPMI_LOCK(sc);
116259698Sdim	if (poll_events & (POLLIN | POLLRDNORM)) {
117259698Sdim		if (!TAILQ_EMPTY(&dev->ipmi_completed_requests))
118259698Sdim		    revents |= poll_events & (POLLIN | POLLRDNORM);
119259698Sdim		if (dev->ipmi_requests == 0)
120259698Sdim		    revents |= POLLERR;
121288943Sdim	}
122259698Sdim
123259698Sdim	if (revents == 0) {
124288943Sdim		if (poll_events & (POLLIN | POLLRDNORM))
125259698Sdim			selrecord(td, &dev->ipmi_select);
126288943Sdim	}
127259698Sdim	IPMI_UNLOCK(sc);
128288943Sdim
129276479Sdim	return (revents);
130276479Sdim}
131276479Sdim
132276479Sdimstatic void
133276479Sdimipmi_purge_completed_requests(struct ipmi_device *dev)
134276479Sdim{
135276479Sdim	struct ipmi_request *req;
136276479Sdim
137276479Sdim	while (!TAILQ_EMPTY(&dev->ipmi_completed_requests)) {
138276479Sdim		req = TAILQ_FIRST(&dev->ipmi_completed_requests);
139276479Sdim		TAILQ_REMOVE(&dev->ipmi_completed_requests, req, ir_link);
140276479Sdim		dev->ipmi_requests--;
141276479Sdim		ipmi_free_request(req);
142276479Sdim	}
143276479Sdim}
144276479Sdim
145276479Sdimstatic int
146276479Sdimipmi_close(struct cdev *cdev, int flags, int fmt, struct thread *td)
147276479Sdim{
148276479Sdim	struct ipmi_request *req, *nreq;
149276479Sdim	struct ipmi_device *dev;
150276479Sdim	struct ipmi_softc *sc;
151276479Sdim#ifdef CLONING
152276479Sdim	int bit;
153276479Sdim#endif
154276479Sdim
155276479Sdim	dev = cdev->si_drv1;
156276479Sdim	sc = dev->ipmi_softc;
157276479Sdim
158276479Sdim	IPMI_LOCK(sc);
159276479Sdim	if (dev->ipmi_requests) {
160276479Sdim		/* Throw away any pending requests for this device. */
161276479Sdim		TAILQ_FOREACH_SAFE(req, &sc->ipmi_pending_requests, ir_link,
162276479Sdim		    nreq) {
163276479Sdim			if (req->ir_owner == dev) {
164276479Sdim				TAILQ_REMOVE(&sc->ipmi_pending_requests, req,
165276479Sdim				    ir_link);
166276479Sdim				dev->ipmi_requests--;
167276479Sdim				ipmi_free_request(req);
168276479Sdim			}
169276479Sdim		}
170276479Sdim
171276479Sdim		/* Throw away any pending completed requests for this device. */
172276479Sdim		ipmi_purge_completed_requests(dev);
173276479Sdim
174276479Sdim		/*
175276479Sdim		 * If we still have outstanding requests, they must be stuck
176276479Sdim		 * in an interface driver, so wait for those to drain.
177276479Sdim		 */
178259698Sdim		dev->ipmi_closing = 1;
179259698Sdim		while (dev->ipmi_requests > 0) {
180259698Sdim			msleep(&dev->ipmi_requests, &sc->ipmi_lock, PWAIT,
181259698Sdim			    "ipmidrain", 0);
182259698Sdim			ipmi_purge_completed_requests(dev);
183259698Sdim		}
184259698Sdim	}
185259698Sdim
186259698Sdim#ifdef CLONING
187259698Sdim	/* Detach this sub-device from the main driver. */
188259698Sdim	bit = minor(cdev) % 32;
189259698Sdim	sc->ipmi_cdev_mask &= ~(1 << bit);
190259698Sdim	TAILQ_REMOVE(&sc->ipmi_cdevs, dev, ipmi_link);
191259698Sdim	IPMI_UNLOCK(sc);
192259698Sdim
193259698Sdim	/* Cleanup. */
194259698Sdim	cdev->si_drv1 = NULL;
195259698Sdim	free(dev, M_IPMI);
196259698Sdim	destroy_dev(cdev);
197259698Sdim#else
198259698Sdim	dev->ipmi_open = 0;
199259698Sdim	IPMI_UNLOCK(sc);
200259698Sdim#endif
201259698Sdim
202259698Sdim	return (0);
203259698Sdim}
204259698Sdim
205259698Sdim#ifdef IPMB
206259698Sdimstatic int
207259698Sdimipmi_ipmb_checksum(u_char *data, int len)
208259698Sdim{
209259698Sdim	u_char sum = 0;
210259698Sdim
211259698Sdim	for (; len; len--) {
212259698Sdim		sum += *data++;
213259698Sdim	}
214259698Sdim	return (-sum);
215259698Sdim}
216259698Sdim
217259698Sdim/* XXX: Needs work */
218259698Sdimstatic int
219259698Sdimipmi_ipmb_send_message(device_t dev, u_char channel, u_char netfn,
220259698Sdim    u_char command, u_char seq, u_char *data, int data_len)
221259698Sdim{
222259698Sdim	struct ipmi_softc *sc = device_get_softc(dev);
223259698Sdim	struct ipmi_request *req;
224259698Sdim	u_char slave_addr = 0x52;
225259698Sdim	int error;
226259698Sdim
227259698Sdim	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
228259698Sdim	    IPMI_SEND_MSG, data_len + 8, 0);
229259698Sdim	req->ir_request[0] = channel;
230259698Sdim	req->ir_request[1] = slave_addr;
231259698Sdim	req->ir_request[2] = IPMI_ADDR(netfn, 0);
232259698Sdim	req->ir_request[3] = ipmi_ipmb_checksum(&req->ir_request[1], 2);
233259698Sdim	req->ir_request[4] = sc->ipmi_address;
234259698Sdim	req->ir_request[5] = IPMI_ADDR(seq, sc->ipmi_lun);
235259698Sdim	req->ir_request[6] = command;
236259698Sdim
237259698Sdim	bcopy(data, &req->ir_request[7], data_len);
238259698Sdim	temp[data_len + 7] = ipmi_ipmb_checksum(&req->ir_request[4],
239259698Sdim	    data_len + 3);
240259698Sdim
241259698Sdim	ipmi_submit_driver_request(sc, req);
242259698Sdim	error = req->ir_error;
243259698Sdim	ipmi_free_request(req);
244259698Sdim
245259698Sdim	return (error);
246259698Sdim}
247259698Sdim
248259698Sdimstatic int
249259698Sdimipmi_handle_attn(struct ipmi_softc *sc)
250259698Sdim{
251259698Sdim	struct ipmi_request *req;
252259698Sdim	int error;
253280031Sdim
254259698Sdim	device_printf(sc->ipmi_dev, "BMC has a message\n");
255259698Sdim	req = ipmi_alloc_driver_request(IPMI_ADDR(IPMI_APP_REQUEST, 0),
256259698Sdim	    IPMI_GET_MSG_FLAGS, 0, 1);
257259698Sdim
258259698Sdim	ipmi_submit_driver_request(sc, req);
259259698Sdim
260259698Sdim	if (req->ir_error == 0 && req->ir_compcode == 0) {
261259698Sdim		if (req->ir_reply[0] & IPMI_MSG_BUFFER_FULL) {
262259698Sdim			device_printf(sc->ipmi_dev, "message buffer full");
263259698Sdim		}
264276479Sdim		if (req->ir_reply[0] & IPMI_WDT_PRE_TIMEOUT) {
265276479Sdim			device_printf(sc->ipmi_dev,
266288943Sdim			    "watchdog about to go off");
267288943Sdim		}
268288943Sdim		if (req->ir_reply[0] & IPMI_MSG_AVAILABLE) {
269276479Sdim			ipmi_free_request(req);
270276479Sdim
271276479Sdim			req = ipmi_alloc_driver_request(
272276479Sdim			    IPMI_ADDR(IPMI_APP_REQUEST, 0), IPMI_GET_MSG, 0,
273276479Sdim			    16);
274276479Sdim
275288943Sdim			device_printf(sc->ipmi_dev, "throw out message ");
276288943Sdim			dump_buf(temp, 16);
277276479Sdim		}
278276479Sdim	}
279276479Sdim	error = req->ir_error;
280259698Sdim	ipmi_free_request(req);
281259698Sdim
282288943Sdim	return (error);
283288943Sdim}
284259698Sdim#endif
285276479Sdim
286276479Sdim#ifdef IPMICTL_SEND_COMMAND_32
287276479Sdim#define	PTRIN(p)	((void *)(uintptr_t)(p))
288276479Sdim#define	PTROUT(p)	((uintptr_t)(p))
289276479Sdim#endif
290276479Sdim
291276479Sdimstatic int
292288943Sdimipmi_ioctl(struct cdev *cdev, u_long cmd, caddr_t data,
293288943Sdim    int flags, struct thread *td)
294288943Sdim{
295288943Sdim	struct ipmi_softc *sc;
296276479Sdim	struct ipmi_device *dev;
297276479Sdim	struct ipmi_request *kreq;
298276479Sdim	struct ipmi_req *req = (struct ipmi_req *)data;
299276479Sdim	struct ipmi_recv *recv = (struct ipmi_recv *)data;
300288943Sdim	struct ipmi_addr addr;
301276479Sdim#ifdef IPMICTL_SEND_COMMAND_32
302276479Sdim	struct ipmi_req32 *req32 = (struct ipmi_req32 *)data;
303276479Sdim	struct ipmi_recv32 *recv32 = (struct ipmi_recv32 *)data;
304276479Sdim	union {
305288943Sdim		struct ipmi_req req;
306276479Sdim		struct ipmi_recv recv;
307276479Sdim	} thunk32;
308276479Sdim#endif
309276479Sdim	int error, len;
310276479Sdim
311276479Sdim	dev = cdev->si_drv1;
312276479Sdim	sc = dev->ipmi_softc;
313288943Sdim
314276479Sdim#ifdef IPMICTL_SEND_COMMAND_32
315276479Sdim	/* Convert 32-bit structures to native. */
316276479Sdim	switch (cmd) {
317276479Sdim	case IPMICTL_SEND_COMMAND_32:
318276479Sdim		req = &thunk32.req;
319276479Sdim		req->addr = PTRIN(req32->addr);
320288943Sdim		req->addr_len = req32->addr_len;
321276479Sdim		req->msgid = req32->msgid;
322276479Sdim		req->msg.netfn = req32->msg.netfn;
323276479Sdim		req->msg.cmd = req32->msg.cmd;
324276479Sdim		req->msg.data_len = req32->msg.data_len;
325276479Sdim		req->msg.data = PTRIN(req32->msg.data);
326259698Sdim		break;
327276479Sdim	case IPMICTL_RECEIVE_MSG_TRUNC_32:
328276479Sdim	case IPMICTL_RECEIVE_MSG_32:
329276479Sdim		recv = &thunk32.recv;
330259698Sdim		recv->addr = PTRIN(recv32->addr);
331288943Sdim		recv->addr_len = recv32->addr_len;
332259698Sdim		recv->msg.data_len = recv32->msg.data_len;
333276479Sdim		recv->msg.data = PTRIN(recv32->msg.data);
334276479Sdim		break;
335276479Sdim	}
336276479Sdim#endif
337276479Sdim
338276479Sdim	switch (cmd) {
339288943Sdim#ifdef IPMICTL_SEND_COMMAND_32
340288943Sdim	case IPMICTL_SEND_COMMAND_32:
341288943Sdim#endif
342288943Sdim	case IPMICTL_SEND_COMMAND:
343288943Sdim		/*
344288943Sdim		 * XXX: Need to add proper handling of this.
345276479Sdim		 */
346276479Sdim		error = copyin(req->addr, &addr, sizeof(addr));
347276479Sdim		if (error)
348276479Sdim			return (error);
349288943Sdim
350276479Sdim		IPMI_LOCK(sc);
351259698Sdim		/* clear out old stuff in queue of stuff done */
352276479Sdim		/* XXX: This seems odd. */
353276479Sdim		while ((kreq = TAILQ_FIRST(&dev->ipmi_completed_requests))) {
354276479Sdim			TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq,
355276479Sdim			    ir_link);
356276479Sdim			dev->ipmi_requests--;
357276479Sdim			ipmi_free_request(kreq);
358259698Sdim		}
359259698Sdim		IPMI_UNLOCK(sc);
360259698Sdim
361259698Sdim		kreq = ipmi_alloc_request(dev, req->msgid,
362259698Sdim		    IPMI_ADDR(req->msg.netfn, 0), req->msg.cmd,
363259698Sdim		    req->msg.data_len, IPMI_MAX_RX);
364259698Sdim		error = copyin(req->msg.data, kreq->ir_request,
365259698Sdim		    req->msg.data_len);
366288943Sdim		if (error) {
367259698Sdim			ipmi_free_request(kreq);
368259698Sdim			return (error);
369259698Sdim		}
370259698Sdim		IPMI_LOCK(sc);
371259698Sdim		dev->ipmi_requests++;
372259698Sdim		error = sc->ipmi_enqueue_request(sc, kreq);
373259698Sdim		IPMI_UNLOCK(sc);
374259698Sdim		if (error)
375259698Sdim			return (error);
376259698Sdim		break;
377259698Sdim#ifdef IPMICTL_SEND_COMMAND_32
378259698Sdim	case IPMICTL_RECEIVE_MSG_TRUNC_32:
379259698Sdim	case IPMICTL_RECEIVE_MSG_32:
380259698Sdim#endif
381259698Sdim	case IPMICTL_RECEIVE_MSG_TRUNC:
382259698Sdim	case IPMICTL_RECEIVE_MSG:
383259698Sdim		error = copyin(recv->addr, &addr, sizeof(addr));
384259698Sdim		if (error)
385259698Sdim			return (error);
386259698Sdim
387259698Sdim		IPMI_LOCK(sc);
388259698Sdim		kreq = TAILQ_FIRST(&dev->ipmi_completed_requests);
389259698Sdim		if (kreq == NULL) {
390259698Sdim			IPMI_UNLOCK(sc);
391259698Sdim			return (EAGAIN);
392259698Sdim		}
393259698Sdim		addr.channel = IPMI_BMC_CHANNEL;
394259698Sdim		/* XXX */
395259698Sdim		recv->recv_type = IPMI_RESPONSE_RECV_TYPE;
396259698Sdim		recv->msgid = kreq->ir_msgid;
397259698Sdim		recv->msg.netfn = IPMI_REPLY_ADDR(kreq->ir_addr) >> 2;
398259698Sdim		recv->msg.cmd = kreq->ir_command;
399259698Sdim		error = kreq->ir_error;
400259698Sdim		if (error) {
401259698Sdim			TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq,
402259698Sdim			    ir_link);
403259698Sdim			dev->ipmi_requests--;
404259698Sdim			IPMI_UNLOCK(sc);
405259698Sdim			ipmi_free_request(kreq);
406259698Sdim			return (error);
407259698Sdim		}
408259698Sdim		len = kreq->ir_replylen + 1;
409259698Sdim		if (recv->msg.data_len < len &&
410259698Sdim		    (cmd == IPMICTL_RECEIVE_MSG
411259698Sdim#ifdef IPMICTL_RECEIVE_MSG_32
412259698Sdim		     || cmd == IPMICTL_RECEIVE_MSG
413259698Sdim#endif
414259698Sdim		    )) {
415259698Sdim			IPMI_UNLOCK(sc);
416259698Sdim			return (EMSGSIZE);
417259698Sdim		}
418259698Sdim		TAILQ_REMOVE(&dev->ipmi_completed_requests, kreq, ir_link);
419259698Sdim		dev->ipmi_requests--;
420259698Sdim		IPMI_UNLOCK(sc);
421259698Sdim		len = min(recv->msg.data_len, len);
422259698Sdim		recv->msg.data_len = len;
423259698Sdim		error = copyout(&addr, recv->addr,sizeof(addr));
424259698Sdim		if (error == 0)
425259698Sdim			error = copyout(&kreq->ir_compcode, recv->msg.data, 1);
426259698Sdim		if (error == 0)
427259698Sdim			error = copyout(kreq->ir_reply, recv->msg.data + 1,
428259698Sdim			    len - 1);
429259698Sdim		ipmi_free_request(kreq);
430259698Sdim		if (error)
431259698Sdim			return (error);
432259698Sdim		break;
433259698Sdim	case IPMICTL_SET_MY_ADDRESS_CMD:
434259698Sdim		IPMI_LOCK(sc);
435259698Sdim		dev->ipmi_address = *(int*)data;
436259698Sdim		IPMI_UNLOCK(sc);
437259698Sdim		break;
438259698Sdim	case IPMICTL_GET_MY_ADDRESS_CMD:
439259698Sdim		IPMI_LOCK(sc);
440259698Sdim		*(int*)data = dev->ipmi_address;
441259698Sdim		IPMI_UNLOCK(sc);
442259698Sdim		break;
443259698Sdim	case IPMICTL_SET_MY_LUN_CMD:
444259698Sdim		IPMI_LOCK(sc);
445259698Sdim		dev->ipmi_lun = *(int*)data & 0x3;
446259698Sdim		IPMI_UNLOCK(sc);
447259698Sdim		break;
448259698Sdim	case IPMICTL_GET_MY_LUN_CMD:
449259698Sdim		IPMI_LOCK(sc);
450259698Sdim		*(int*)data = dev->ipmi_lun;
451259698Sdim		IPMI_UNLOCK(sc);
452259698Sdim		break;
453259698Sdim	case IPMICTL_SET_GETS_EVENTS_CMD:
454288943Sdim		/*
455259698Sdim		device_printf(sc->ipmi_dev,
456259698Sdim		    "IPMICTL_SET_GETS_EVENTS_CMD NA\n");
457288943Sdim		*/
458288943Sdim		break;
459259698Sdim	case IPMICTL_REGISTER_FOR_CMD:
460259698Sdim	case IPMICTL_UNREGISTER_FOR_CMD:
461288943Sdim		return (EOPNOTSUPP);
462259698Sdim	default:
463259698Sdim		device_printf(sc->ipmi_dev, "Unknown IOCTL %lX\n", cmd);
464259698Sdim		return (ENOIOCTL);
465288943Sdim	}
466259698Sdim
467259698Sdim#ifdef IPMICTL_SEND_COMMAND_32
468259698Sdim	/* Update changed fields in 32-bit structures. */
469259698Sdim	switch (cmd) {
470259698Sdim	case IPMICTL_RECEIVE_MSG_TRUNC_32:
471259698Sdim	case IPMICTL_RECEIVE_MSG_32:
472259698Sdim		recv32->recv_type = recv->recv_type;
473259698Sdim		recv32->msgid = recv->msgid;
474259698Sdim		recv32->msg.netfn = recv->msg.netfn;
475259698Sdim		recv32->msg.cmd = recv->msg.cmd;
476259698Sdim		recv32->msg.data_len = recv->msg.data_len;
477259698Sdim		break;
478259698Sdim	}
479259698Sdim#endif
480259698Sdim	return (0);
481259698Sdim}
482259698Sdim
483259698Sdim/*
484259698Sdim * Request management.
485259698Sdim */
486259698Sdim
487259698Sdim/* Allocate a new request with request and reply buffers. */
488259698Sdimstruct ipmi_request *
489259698Sdimipmi_alloc_request(struct ipmi_device *dev, long msgid, uint8_t addr,
490288943Sdim    uint8_t command, size_t requestlen, size_t replylen)
491259698Sdim{
492259698Sdim	struct ipmi_request *req;
493259698Sdim
494259698Sdim	req = malloc(sizeof(struct ipmi_request) + requestlen + replylen,
495259698Sdim	    M_IPMI, M_WAITOK | M_ZERO);
496259698Sdim	req->ir_owner = dev;
497259698Sdim	req->ir_msgid = msgid;
498259698Sdim	req->ir_addr = addr;
499259698Sdim	req->ir_command = command;
500259698Sdim	if (requestlen) {
501259698Sdim		req->ir_request = (char *)&req[1];
502259698Sdim		req->ir_requestlen = requestlen;
503259698Sdim	}
504259698Sdim	if (replylen) {
505259698Sdim		req->ir_reply = (char *)&req[1] + requestlen;
506259698Sdim		req->ir_replybuflen = replylen;
507259698Sdim	}
508259698Sdim	return (req);
509259698Sdim}
510259698Sdim
511259698Sdim/* Free a request no longer in use. */
512259698Sdimvoid
513259698Sdimipmi_free_request(struct ipmi_request *req)
514288943Sdim{
515259698Sdim
516	free(req, M_IPMI);
517}
518
519/* Store a processed request on the appropriate completion queue. */
520void
521ipmi_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. */
543int
544ipmi_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 */
565struct ipmi_request *
566ipmi_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. */
583int
584ipmi_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
598static void
599ipmi_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
646static void
647ipmi_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
674static void
675ipmi_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
725static void
726ipmi_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
845int
846ipmi_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
872int
873ipmi_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
924void
925ipmi_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
942devclass_t ipmi_devclass;
943
944/* XXX: Why? */
945static void
946ipmi_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}
958SYSUNINIT(ipmi_unload, SI_SUB_DRIVERS, SI_ORDER_FIRST, ipmi_unload, NULL);
959
960#ifdef IMPI_DEBUG
961static void
962dump_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