4 * Linux device interface for the IPMI message handler.
6 * Author: MontaVista Software, Inc.
7 * Corey Minyard <minyard@mvista.com>
10 * Copyright 2002 MontaVista Software Inc.
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version.
18 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
24 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
26 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
27 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * You should have received a copy of the GNU General Public License along
30 * with this program; if not, write to the Free Software Foundation, Inc.,
31 * 675 Mass Ave, Cambridge, MA 02139, USA.
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/errno.h>
37 #include <asm/system.h>
38 #include <linux/poll.h>
39 #include <linux/spinlock.h>
40 #include <linux/slab.h>
41 #include <linux/ipmi.h>
42 #include <linux/mutex.h>
43 #include <linux/init.h>
44 #include <linux/device.h>
45 #include <linux/compat.h>
46 #include <linux/smp_lock.h>
48 struct ipmi_file_private
51 spinlock_t recv_msg_lock;
52 struct list_head recv_msgs;
54 struct fasync_struct *fasync_queue;
55 wait_queue_head_t wait;
56 struct mutex recv_mutex;
58 unsigned int default_retry_time_ms;
61 static void file_receive_handler(struct ipmi_recv_msg *msg,
64 struct ipmi_file_private *priv = handler_data;
68 spin_lock_irqsave(&(priv->recv_msg_lock), flags);
70 was_empty = list_empty(&(priv->recv_msgs));
71 list_add_tail(&(msg->link), &(priv->recv_msgs));
74 wake_up_interruptible(&priv->wait);
75 kill_fasync(&priv->fasync_queue, SIGIO, POLL_IN);
78 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
81 static unsigned int ipmi_poll(struct file *file, poll_table *wait)
83 struct ipmi_file_private *priv = file->private_data;
84 unsigned int mask = 0;
87 poll_wait(file, &priv->wait, wait);
89 spin_lock_irqsave(&priv->recv_msg_lock, flags);
91 if (!list_empty(&(priv->recv_msgs)))
92 mask |= (POLLIN | POLLRDNORM);
94 spin_unlock_irqrestore(&priv->recv_msg_lock, flags);
99 static int ipmi_fasync(int fd, struct file *file, int on)
101 struct ipmi_file_private *priv = file->private_data;
104 lock_kernel(); /* could race against open() otherwise */
105 result = fasync_helper(fd, file, on, &priv->fasync_queue);
111 static struct ipmi_user_hndl ipmi_hndlrs =
113 .ipmi_recv_hndl = file_receive_handler,
116 static int ipmi_open(struct inode *inode, struct file *file)
118 int if_num = iminor(inode);
120 struct ipmi_file_private *priv;
123 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
130 rv = ipmi_create_user(if_num,
139 file->private_data = priv;
141 spin_lock_init(&(priv->recv_msg_lock));
142 INIT_LIST_HEAD(&(priv->recv_msgs));
143 init_waitqueue_head(&priv->wait);
144 priv->fasync_queue = NULL;
145 mutex_init(&priv->recv_mutex);
147 /* Use the low-level defaults. */
148 priv->default_retries = -1;
149 priv->default_retry_time_ms = 0;
156 static int ipmi_release(struct inode *inode, struct file *file)
158 struct ipmi_file_private *priv = file->private_data;
161 rv = ipmi_destroy_user(priv->user);
165 ipmi_fasync (-1, file, 0);
167 /* FIXME - free the messages in the list. */
173 static int handle_send_req(ipmi_user_t user,
174 struct ipmi_req *req,
176 unsigned int retry_time_ms)
179 struct ipmi_addr addr;
180 struct kernel_ipmi_msg msg;
182 if (req->addr_len > sizeof(struct ipmi_addr))
185 if (copy_from_user(&addr, req->addr, req->addr_len))
188 msg.netfn = req->msg.netfn;
189 msg.cmd = req->msg.cmd;
190 msg.data_len = req->msg.data_len;
191 msg.data = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
195 /* From here out we cannot return, we must jump to "out" for
196 error exits to free msgdata. */
198 rv = ipmi_validate_addr(&addr, req->addr_len);
202 if (req->msg.data != NULL) {
203 if (req->msg.data_len > IPMI_MAX_MSG_LENGTH) {
208 if (copy_from_user(msg.data,
219 rv = ipmi_request_settime(user,
232 static int ipmi_ioctl(struct inode *inode,
238 struct ipmi_file_private *priv = file->private_data;
239 void __user *arg = (void __user *)data;
243 case IPMICTL_SEND_COMMAND:
247 if (copy_from_user(&req, arg, sizeof(req))) {
252 rv = handle_send_req(priv->user,
254 priv->default_retries,
255 priv->default_retry_time_ms);
259 case IPMICTL_SEND_COMMAND_SETTIME:
261 struct ipmi_req_settime req;
263 if (copy_from_user(&req, arg, sizeof(req))) {
268 rv = handle_send_req(priv->user,
275 case IPMICTL_RECEIVE_MSG:
276 case IPMICTL_RECEIVE_MSG_TRUNC:
278 struct ipmi_recv rsp;
280 struct list_head *entry;
281 struct ipmi_recv_msg *msg;
286 if (copy_from_user(&rsp, arg, sizeof(rsp))) {
291 /* We claim a mutex because we don't want two
292 users getting something from the queue at a time.
293 Since we have to release the spinlock before we can
294 copy the data to the user, it's possible another
295 user will grab something from the queue, too. Then
296 the messages might get out of order if something
297 fails and the message gets put back onto the
298 queue. This mutex prevents that problem. */
299 mutex_lock(&priv->recv_mutex);
301 /* Grab the message off the list. */
302 spin_lock_irqsave(&(priv->recv_msg_lock), flags);
303 if (list_empty(&(priv->recv_msgs))) {
304 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
308 entry = priv->recv_msgs.next;
309 msg = list_entry(entry, struct ipmi_recv_msg, link);
311 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
313 addr_len = ipmi_addr_length(msg->addr.addr_type);
314 if (rsp.addr_len < addr_len)
317 goto recv_putback_on_err;
320 if (copy_to_user(rsp.addr, &(msg->addr), addr_len)) {
322 goto recv_putback_on_err;
324 rsp.addr_len = addr_len;
326 rsp.recv_type = msg->recv_type;
327 rsp.msgid = msg->msgid;
328 rsp.msg.netfn = msg->msg.netfn;
329 rsp.msg.cmd = msg->msg.cmd;
331 if (msg->msg.data_len > 0) {
332 if (rsp.msg.data_len < msg->msg.data_len) {
334 if (cmd == IPMICTL_RECEIVE_MSG_TRUNC) {
335 msg->msg.data_len = rsp.msg.data_len;
337 goto recv_putback_on_err;
341 if (copy_to_user(rsp.msg.data,
346 goto recv_putback_on_err;
348 rsp.msg.data_len = msg->msg.data_len;
350 rsp.msg.data_len = 0;
353 if (copy_to_user(arg, &rsp, sizeof(rsp))) {
355 goto recv_putback_on_err;
358 mutex_unlock(&priv->recv_mutex);
359 ipmi_free_recv_msg(msg);
363 /* If we got an error, put the message back onto
364 the head of the queue. */
365 spin_lock_irqsave(&(priv->recv_msg_lock), flags);
366 list_add(entry, &(priv->recv_msgs));
367 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
368 mutex_unlock(&priv->recv_mutex);
372 mutex_unlock(&priv->recv_mutex);
376 case IPMICTL_REGISTER_FOR_CMD:
378 struct ipmi_cmdspec val;
380 if (copy_from_user(&val, arg, sizeof(val))) {
385 rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
390 case IPMICTL_UNREGISTER_FOR_CMD:
392 struct ipmi_cmdspec val;
394 if (copy_from_user(&val, arg, sizeof(val))) {
399 rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
404 case IPMICTL_REGISTER_FOR_CMD_CHANS:
406 struct ipmi_cmdspec_chans val;
408 if (copy_from_user(&val, arg, sizeof(val))) {
413 rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
418 case IPMICTL_UNREGISTER_FOR_CMD_CHANS:
420 struct ipmi_cmdspec_chans val;
422 if (copy_from_user(&val, arg, sizeof(val))) {
427 rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
432 case IPMICTL_SET_GETS_EVENTS_CMD:
436 if (copy_from_user(&val, arg, sizeof(val))) {
441 rv = ipmi_set_gets_events(priv->user, val);
445 /* The next four are legacy, not per-channel. */
446 case IPMICTL_SET_MY_ADDRESS_CMD:
450 if (copy_from_user(&val, arg, sizeof(val))) {
455 rv = ipmi_set_my_address(priv->user, 0, val);
459 case IPMICTL_GET_MY_ADDRESS_CMD:
464 rv = ipmi_get_my_address(priv->user, 0, &rval);
470 if (copy_to_user(arg, &val, sizeof(val))) {
477 case IPMICTL_SET_MY_LUN_CMD:
481 if (copy_from_user(&val, arg, sizeof(val))) {
486 rv = ipmi_set_my_LUN(priv->user, 0, val);
490 case IPMICTL_GET_MY_LUN_CMD:
495 rv = ipmi_get_my_LUN(priv->user, 0, &rval);
501 if (copy_to_user(arg, &val, sizeof(val))) {
508 case IPMICTL_SET_MY_CHANNEL_ADDRESS_CMD:
510 struct ipmi_channel_lun_address_set val;
512 if (copy_from_user(&val, arg, sizeof(val))) {
517 return ipmi_set_my_address(priv->user, val.channel, val.value);
521 case IPMICTL_GET_MY_CHANNEL_ADDRESS_CMD:
523 struct ipmi_channel_lun_address_set val;
525 if (copy_from_user(&val, arg, sizeof(val))) {
530 rv = ipmi_get_my_address(priv->user, val.channel, &val.value);
534 if (copy_to_user(arg, &val, sizeof(val))) {
541 case IPMICTL_SET_MY_CHANNEL_LUN_CMD:
543 struct ipmi_channel_lun_address_set val;
545 if (copy_from_user(&val, arg, sizeof(val))) {
550 rv = ipmi_set_my_LUN(priv->user, val.channel, val.value);
554 case IPMICTL_GET_MY_CHANNEL_LUN_CMD:
556 struct ipmi_channel_lun_address_set val;
558 if (copy_from_user(&val, arg, sizeof(val))) {
563 rv = ipmi_get_my_LUN(priv->user, val.channel, &val.value);
567 if (copy_to_user(arg, &val, sizeof(val))) {
574 case IPMICTL_SET_TIMING_PARMS_CMD:
576 struct ipmi_timing_parms parms;
578 if (copy_from_user(&parms, arg, sizeof(parms))) {
583 priv->default_retries = parms.retries;
584 priv->default_retry_time_ms = parms.retry_time_ms;
589 case IPMICTL_GET_TIMING_PARMS_CMD:
591 struct ipmi_timing_parms parms;
593 parms.retries = priv->default_retries;
594 parms.retry_time_ms = priv->default_retry_time_ms;
596 if (copy_to_user(arg, &parms, sizeof(parms))) {
605 case IPMICTL_GET_MAINTENANCE_MODE_CMD:
609 mode = ipmi_get_maintenance_mode(priv->user);
610 if (copy_to_user(arg, &mode, sizeof(mode))) {
618 case IPMICTL_SET_MAINTENANCE_MODE_CMD:
622 if (copy_from_user(&mode, arg, sizeof(mode))) {
626 rv = ipmi_set_maintenance_mode(priv->user, mode);
637 * The following code contains code for supporting 32-bit compatible
638 * ioctls on 64-bit kernels. This allows running 32-bit apps on the
641 #define COMPAT_IPMICTL_SEND_COMMAND \
642 _IOR(IPMI_IOC_MAGIC, 13, struct compat_ipmi_req)
643 #define COMPAT_IPMICTL_SEND_COMMAND_SETTIME \
644 _IOR(IPMI_IOC_MAGIC, 21, struct compat_ipmi_req_settime)
645 #define COMPAT_IPMICTL_RECEIVE_MSG \
646 _IOWR(IPMI_IOC_MAGIC, 12, struct compat_ipmi_recv)
647 #define COMPAT_IPMICTL_RECEIVE_MSG_TRUNC \
648 _IOWR(IPMI_IOC_MAGIC, 11, struct compat_ipmi_recv)
650 struct compat_ipmi_msg {
657 struct compat_ipmi_req {
659 compat_uint_t addr_len;
661 struct compat_ipmi_msg msg;
664 struct compat_ipmi_recv {
665 compat_int_t recv_type;
667 compat_uint_t addr_len;
669 struct compat_ipmi_msg msg;
672 struct compat_ipmi_req_settime {
673 struct compat_ipmi_req req;
674 compat_int_t retries;
675 compat_uint_t retry_time_ms;
679 * Define some helper functions for copying IPMI data
681 static long get_compat_ipmi_msg(struct ipmi_msg *p64,
682 struct compat_ipmi_msg __user *p32)
686 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
687 __get_user(p64->netfn, &p32->netfn) ||
688 __get_user(p64->cmd, &p32->cmd) ||
689 __get_user(p64->data_len, &p32->data_len) ||
690 __get_user(tmp, &p32->data))
692 p64->data = compat_ptr(tmp);
696 static long put_compat_ipmi_msg(struct ipmi_msg *p64,
697 struct compat_ipmi_msg __user *p32)
699 if (!access_ok(VERIFY_WRITE, p32, sizeof(*p32)) ||
700 __put_user(p64->netfn, &p32->netfn) ||
701 __put_user(p64->cmd, &p32->cmd) ||
702 __put_user(p64->data_len, &p32->data_len))
707 static long get_compat_ipmi_req(struct ipmi_req *p64,
708 struct compat_ipmi_req __user *p32)
713 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
714 __get_user(tmp, &p32->addr) ||
715 __get_user(p64->addr_len, &p32->addr_len) ||
716 __get_user(p64->msgid, &p32->msgid) ||
717 get_compat_ipmi_msg(&p64->msg, &p32->msg))
719 p64->addr = compat_ptr(tmp);
723 static long get_compat_ipmi_req_settime(struct ipmi_req_settime *p64,
724 struct compat_ipmi_req_settime __user *p32)
726 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
727 get_compat_ipmi_req(&p64->req, &p32->req) ||
728 __get_user(p64->retries, &p32->retries) ||
729 __get_user(p64->retry_time_ms, &p32->retry_time_ms))
734 static long get_compat_ipmi_recv(struct ipmi_recv *p64,
735 struct compat_ipmi_recv __user *p32)
739 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
740 __get_user(p64->recv_type, &p32->recv_type) ||
741 __get_user(tmp, &p32->addr) ||
742 __get_user(p64->addr_len, &p32->addr_len) ||
743 __get_user(p64->msgid, &p32->msgid) ||
744 get_compat_ipmi_msg(&p64->msg, &p32->msg))
746 p64->addr = compat_ptr(tmp);
750 static long put_compat_ipmi_recv(struct ipmi_recv *p64,
751 struct compat_ipmi_recv __user *p32)
753 if (!access_ok(VERIFY_WRITE, p32, sizeof(*p32)) ||
754 __put_user(p64->recv_type, &p32->recv_type) ||
755 __put_user(p64->addr_len, &p32->addr_len) ||
756 __put_user(p64->msgid, &p32->msgid) ||
757 put_compat_ipmi_msg(&p64->msg, &p32->msg))
763 * Handle compatibility ioctls
765 static long compat_ipmi_ioctl(struct file *filep, unsigned int cmd,
769 struct ipmi_file_private *priv = filep->private_data;
772 case COMPAT_IPMICTL_SEND_COMMAND:
776 if (get_compat_ipmi_req(&rp, compat_ptr(arg)))
779 return handle_send_req(priv->user, &rp,
780 priv->default_retries,
781 priv->default_retry_time_ms);
783 case COMPAT_IPMICTL_SEND_COMMAND_SETTIME:
785 struct ipmi_req_settime sp;
787 if (get_compat_ipmi_req_settime(&sp, compat_ptr(arg)))
790 return handle_send_req(priv->user, &sp.req,
791 sp.retries, sp.retry_time_ms);
793 case COMPAT_IPMICTL_RECEIVE_MSG:
794 case COMPAT_IPMICTL_RECEIVE_MSG_TRUNC:
796 struct ipmi_recv __user *precv64;
797 struct ipmi_recv recv64;
799 if (get_compat_ipmi_recv(&recv64, compat_ptr(arg)))
802 precv64 = compat_alloc_user_space(sizeof(recv64));
803 if (copy_to_user(precv64, &recv64, sizeof(recv64)))
806 rc = ipmi_ioctl(filep->f_path.dentry->d_inode, filep,
807 ((cmd == COMPAT_IPMICTL_RECEIVE_MSG)
808 ? IPMICTL_RECEIVE_MSG
809 : IPMICTL_RECEIVE_MSG_TRUNC),
810 (unsigned long) precv64);
814 if (copy_from_user(&recv64, precv64, sizeof(recv64)))
817 if (put_compat_ipmi_recv(&recv64, compat_ptr(arg)))
823 return ipmi_ioctl(filep->f_path.dentry->d_inode, filep, cmd, arg);
828 static const struct file_operations ipmi_fops = {
829 .owner = THIS_MODULE,
832 .compat_ioctl = compat_ipmi_ioctl,
835 .release = ipmi_release,
836 .fasync = ipmi_fasync,
840 #define DEVICE_NAME "ipmidev"
842 static int ipmi_major;
843 module_param(ipmi_major, int, 0);
844 MODULE_PARM_DESC(ipmi_major, "Sets the major number of the IPMI device. By"
845 " default, or if you set it to zero, it will choose the next"
846 " available device. Setting it to -1 will disable the"
847 " interface. Other values will set the major device number"
850 /* Keep track of the devices that are registered. */
851 struct ipmi_reg_list {
853 struct list_head link;
855 static LIST_HEAD(reg_list);
856 static DEFINE_MUTEX(reg_list_mutex);
858 static struct class *ipmi_class;
860 static void ipmi_new_smi(int if_num, struct device *device)
862 dev_t dev = MKDEV(ipmi_major, if_num);
863 struct ipmi_reg_list *entry;
865 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
867 printk(KERN_ERR "ipmi_devintf: Unable to create the"
868 " ipmi class device link\n");
873 mutex_lock(®_list_mutex);
874 device_create_drvdata(ipmi_class, device, dev, NULL, "ipmi%d", if_num);
875 list_add(&entry->link, ®_list);
876 mutex_unlock(®_list_mutex);
879 static void ipmi_smi_gone(int if_num)
881 dev_t dev = MKDEV(ipmi_major, if_num);
882 struct ipmi_reg_list *entry;
884 mutex_lock(®_list_mutex);
885 list_for_each_entry(entry, ®_list, link) {
886 if (entry->dev == dev) {
887 list_del(&entry->link);
892 device_destroy(ipmi_class, dev);
893 mutex_unlock(®_list_mutex);
896 static struct ipmi_smi_watcher smi_watcher =
898 .owner = THIS_MODULE,
899 .new_smi = ipmi_new_smi,
900 .smi_gone = ipmi_smi_gone,
903 static __init int init_ipmi_devintf(void)
910 printk(KERN_INFO "ipmi device interface\n");
912 ipmi_class = class_create(THIS_MODULE, "ipmi");
913 if (IS_ERR(ipmi_class)) {
914 printk(KERN_ERR "ipmi: can't register device class\n");
915 return PTR_ERR(ipmi_class);
918 rv = register_chrdev(ipmi_major, DEVICE_NAME, &ipmi_fops);
920 class_destroy(ipmi_class);
921 printk(KERN_ERR "ipmi: can't get major %d\n", ipmi_major);
925 if (ipmi_major == 0) {
929 rv = ipmi_smi_watcher_register(&smi_watcher);
931 unregister_chrdev(ipmi_major, DEVICE_NAME);
932 class_destroy(ipmi_class);
933 printk(KERN_WARNING "ipmi: can't register smi watcher\n");
939 module_init(init_ipmi_devintf);
941 static __exit void cleanup_ipmi(void)
943 struct ipmi_reg_list *entry, *entry2;
944 mutex_lock(®_list_mutex);
945 list_for_each_entry_safe(entry, entry2, ®_list, link) {
946 list_del(&entry->link);
947 device_destroy(ipmi_class, entry->dev);
950 mutex_unlock(®_list_mutex);
951 class_destroy(ipmi_class);
952 ipmi_smi_watcher_unregister(&smi_watcher);
953 unregister_chrdev(ipmi_major, DEVICE_NAME);
955 module_exit(cleanup_ipmi);
957 MODULE_LICENSE("GPL");
958 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
959 MODULE_DESCRIPTION("Linux device interface for the IPMI message handler.");