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>
47 struct ipmi_file_private
50 spinlock_t recv_msg_lock;
51 struct list_head recv_msgs;
53 struct fasync_struct *fasync_queue;
54 wait_queue_head_t wait;
55 struct mutex recv_mutex;
57 unsigned int default_retry_time_ms;
60 static void file_receive_handler(struct ipmi_recv_msg *msg,
63 struct ipmi_file_private *priv = handler_data;
67 spin_lock_irqsave(&(priv->recv_msg_lock), flags);
69 was_empty = list_empty(&(priv->recv_msgs));
70 list_add_tail(&(msg->link), &(priv->recv_msgs));
73 wake_up_interruptible(&priv->wait);
74 kill_fasync(&priv->fasync_queue, SIGIO, POLL_IN);
77 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
80 static unsigned int ipmi_poll(struct file *file, poll_table *wait)
82 struct ipmi_file_private *priv = file->private_data;
83 unsigned int mask = 0;
86 poll_wait(file, &priv->wait, wait);
88 spin_lock_irqsave(&priv->recv_msg_lock, flags);
90 if (!list_empty(&(priv->recv_msgs)))
91 mask |= (POLLIN | POLLRDNORM);
93 spin_unlock_irqrestore(&priv->recv_msg_lock, flags);
98 static int ipmi_fasync(int fd, struct file *file, int on)
100 struct ipmi_file_private *priv = file->private_data;
103 result = fasync_helper(fd, file, on, &priv->fasync_queue);
108 static struct ipmi_user_hndl ipmi_hndlrs =
110 .ipmi_recv_hndl = file_receive_handler,
113 static int ipmi_open(struct inode *inode, struct file *file)
115 int if_num = iminor(inode);
117 struct ipmi_file_private *priv;
120 priv = kmalloc(sizeof(*priv), GFP_KERNEL);
126 rv = ipmi_create_user(if_num,
135 file->private_data = priv;
137 spin_lock_init(&(priv->recv_msg_lock));
138 INIT_LIST_HEAD(&(priv->recv_msgs));
139 init_waitqueue_head(&priv->wait);
140 priv->fasync_queue = NULL;
141 mutex_init(&priv->recv_mutex);
143 /* Use the low-level defaults. */
144 priv->default_retries = -1;
145 priv->default_retry_time_ms = 0;
150 static int ipmi_release(struct inode *inode, struct file *file)
152 struct ipmi_file_private *priv = file->private_data;
155 rv = ipmi_destroy_user(priv->user);
159 ipmi_fasync (-1, file, 0);
161 /* FIXME - free the messages in the list. */
167 static int handle_send_req(ipmi_user_t user,
168 struct ipmi_req *req,
170 unsigned int retry_time_ms)
173 struct ipmi_addr addr;
174 struct kernel_ipmi_msg msg;
176 if (req->addr_len > sizeof(struct ipmi_addr))
179 if (copy_from_user(&addr, req->addr, req->addr_len))
182 msg.netfn = req->msg.netfn;
183 msg.cmd = req->msg.cmd;
184 msg.data_len = req->msg.data_len;
185 msg.data = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
189 /* From here out we cannot return, we must jump to "out" for
190 error exits to free msgdata. */
192 rv = ipmi_validate_addr(&addr, req->addr_len);
196 if (req->msg.data != NULL) {
197 if (req->msg.data_len > IPMI_MAX_MSG_LENGTH) {
202 if (copy_from_user(msg.data,
213 rv = ipmi_request_settime(user,
226 static int ipmi_ioctl(struct inode *inode,
232 struct ipmi_file_private *priv = file->private_data;
233 void __user *arg = (void __user *)data;
237 case IPMICTL_SEND_COMMAND:
241 if (copy_from_user(&req, arg, sizeof(req))) {
246 rv = handle_send_req(priv->user,
248 priv->default_retries,
249 priv->default_retry_time_ms);
253 case IPMICTL_SEND_COMMAND_SETTIME:
255 struct ipmi_req_settime req;
257 if (copy_from_user(&req, arg, sizeof(req))) {
262 rv = handle_send_req(priv->user,
269 case IPMICTL_RECEIVE_MSG:
270 case IPMICTL_RECEIVE_MSG_TRUNC:
272 struct ipmi_recv rsp;
274 struct list_head *entry;
275 struct ipmi_recv_msg *msg;
280 if (copy_from_user(&rsp, arg, sizeof(rsp))) {
285 /* We claim a mutex because we don't want two
286 users getting something from the queue at a time.
287 Since we have to release the spinlock before we can
288 copy the data to the user, it's possible another
289 user will grab something from the queue, too. Then
290 the messages might get out of order if something
291 fails and the message gets put back onto the
292 queue. This mutex prevents that problem. */
293 mutex_lock(&priv->recv_mutex);
295 /* Grab the message off the list. */
296 spin_lock_irqsave(&(priv->recv_msg_lock), flags);
297 if (list_empty(&(priv->recv_msgs))) {
298 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
302 entry = priv->recv_msgs.next;
303 msg = list_entry(entry, struct ipmi_recv_msg, link);
305 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
307 addr_len = ipmi_addr_length(msg->addr.addr_type);
308 if (rsp.addr_len < addr_len)
311 goto recv_putback_on_err;
314 if (copy_to_user(rsp.addr, &(msg->addr), addr_len)) {
316 goto recv_putback_on_err;
318 rsp.addr_len = addr_len;
320 rsp.recv_type = msg->recv_type;
321 rsp.msgid = msg->msgid;
322 rsp.msg.netfn = msg->msg.netfn;
323 rsp.msg.cmd = msg->msg.cmd;
325 if (msg->msg.data_len > 0) {
326 if (rsp.msg.data_len < msg->msg.data_len) {
328 if (cmd == IPMICTL_RECEIVE_MSG_TRUNC) {
329 msg->msg.data_len = rsp.msg.data_len;
331 goto recv_putback_on_err;
335 if (copy_to_user(rsp.msg.data,
340 goto recv_putback_on_err;
342 rsp.msg.data_len = msg->msg.data_len;
344 rsp.msg.data_len = 0;
347 if (copy_to_user(arg, &rsp, sizeof(rsp))) {
349 goto recv_putback_on_err;
352 mutex_unlock(&priv->recv_mutex);
353 ipmi_free_recv_msg(msg);
357 /* If we got an error, put the message back onto
358 the head of the queue. */
359 spin_lock_irqsave(&(priv->recv_msg_lock), flags);
360 list_add(entry, &(priv->recv_msgs));
361 spin_unlock_irqrestore(&(priv->recv_msg_lock), flags);
362 mutex_unlock(&priv->recv_mutex);
366 mutex_unlock(&priv->recv_mutex);
370 case IPMICTL_REGISTER_FOR_CMD:
372 struct ipmi_cmdspec val;
374 if (copy_from_user(&val, arg, sizeof(val))) {
379 rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
384 case IPMICTL_UNREGISTER_FOR_CMD:
386 struct ipmi_cmdspec val;
388 if (copy_from_user(&val, arg, sizeof(val))) {
393 rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
398 case IPMICTL_REGISTER_FOR_CMD_CHANS:
400 struct ipmi_cmdspec_chans val;
402 if (copy_from_user(&val, arg, sizeof(val))) {
407 rv = ipmi_register_for_cmd(priv->user, val.netfn, val.cmd,
412 case IPMICTL_UNREGISTER_FOR_CMD_CHANS:
414 struct ipmi_cmdspec_chans val;
416 if (copy_from_user(&val, arg, sizeof(val))) {
421 rv = ipmi_unregister_for_cmd(priv->user, val.netfn, val.cmd,
426 case IPMICTL_SET_GETS_EVENTS_CMD:
430 if (copy_from_user(&val, arg, sizeof(val))) {
435 rv = ipmi_set_gets_events(priv->user, val);
439 /* The next four are legacy, not per-channel. */
440 case IPMICTL_SET_MY_ADDRESS_CMD:
444 if (copy_from_user(&val, arg, sizeof(val))) {
449 rv = ipmi_set_my_address(priv->user, 0, val);
453 case IPMICTL_GET_MY_ADDRESS_CMD:
458 rv = ipmi_get_my_address(priv->user, 0, &rval);
464 if (copy_to_user(arg, &val, sizeof(val))) {
471 case IPMICTL_SET_MY_LUN_CMD:
475 if (copy_from_user(&val, arg, sizeof(val))) {
480 rv = ipmi_set_my_LUN(priv->user, 0, val);
484 case IPMICTL_GET_MY_LUN_CMD:
489 rv = ipmi_get_my_LUN(priv->user, 0, &rval);
495 if (copy_to_user(arg, &val, sizeof(val))) {
502 case IPMICTL_SET_MY_CHANNEL_ADDRESS_CMD:
504 struct ipmi_channel_lun_address_set val;
506 if (copy_from_user(&val, arg, sizeof(val))) {
511 return ipmi_set_my_address(priv->user, val.channel, val.value);
515 case IPMICTL_GET_MY_CHANNEL_ADDRESS_CMD:
517 struct ipmi_channel_lun_address_set val;
519 if (copy_from_user(&val, arg, sizeof(val))) {
524 rv = ipmi_get_my_address(priv->user, val.channel, &val.value);
528 if (copy_to_user(arg, &val, sizeof(val))) {
535 case IPMICTL_SET_MY_CHANNEL_LUN_CMD:
537 struct ipmi_channel_lun_address_set val;
539 if (copy_from_user(&val, arg, sizeof(val))) {
544 rv = ipmi_set_my_LUN(priv->user, val.channel, val.value);
548 case IPMICTL_GET_MY_CHANNEL_LUN_CMD:
550 struct ipmi_channel_lun_address_set val;
552 if (copy_from_user(&val, arg, sizeof(val))) {
557 rv = ipmi_get_my_LUN(priv->user, val.channel, &val.value);
561 if (copy_to_user(arg, &val, sizeof(val))) {
568 case IPMICTL_SET_TIMING_PARMS_CMD:
570 struct ipmi_timing_parms parms;
572 if (copy_from_user(&parms, arg, sizeof(parms))) {
577 priv->default_retries = parms.retries;
578 priv->default_retry_time_ms = parms.retry_time_ms;
583 case IPMICTL_GET_TIMING_PARMS_CMD:
585 struct ipmi_timing_parms parms;
587 parms.retries = priv->default_retries;
588 parms.retry_time_ms = priv->default_retry_time_ms;
590 if (copy_to_user(arg, &parms, sizeof(parms))) {
599 case IPMICTL_GET_MAINTENANCE_MODE_CMD:
603 mode = ipmi_get_maintenance_mode(priv->user);
604 if (copy_to_user(arg, &mode, sizeof(mode))) {
612 case IPMICTL_SET_MAINTENANCE_MODE_CMD:
616 if (copy_from_user(&mode, arg, sizeof(mode))) {
620 rv = ipmi_set_maintenance_mode(priv->user, mode);
631 * The following code contains code for supporting 32-bit compatible
632 * ioctls on 64-bit kernels. This allows running 32-bit apps on the
635 #define COMPAT_IPMICTL_SEND_COMMAND \
636 _IOR(IPMI_IOC_MAGIC, 13, struct compat_ipmi_req)
637 #define COMPAT_IPMICTL_SEND_COMMAND_SETTIME \
638 _IOR(IPMI_IOC_MAGIC, 21, struct compat_ipmi_req_settime)
639 #define COMPAT_IPMICTL_RECEIVE_MSG \
640 _IOWR(IPMI_IOC_MAGIC, 12, struct compat_ipmi_recv)
641 #define COMPAT_IPMICTL_RECEIVE_MSG_TRUNC \
642 _IOWR(IPMI_IOC_MAGIC, 11, struct compat_ipmi_recv)
644 struct compat_ipmi_msg {
651 struct compat_ipmi_req {
653 compat_uint_t addr_len;
655 struct compat_ipmi_msg msg;
658 struct compat_ipmi_recv {
659 compat_int_t recv_type;
661 compat_uint_t addr_len;
663 struct compat_ipmi_msg msg;
666 struct compat_ipmi_req_settime {
667 struct compat_ipmi_req req;
668 compat_int_t retries;
669 compat_uint_t retry_time_ms;
673 * Define some helper functions for copying IPMI data
675 static long get_compat_ipmi_msg(struct ipmi_msg *p64,
676 struct compat_ipmi_msg __user *p32)
680 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
681 __get_user(p64->netfn, &p32->netfn) ||
682 __get_user(p64->cmd, &p32->cmd) ||
683 __get_user(p64->data_len, &p32->data_len) ||
684 __get_user(tmp, &p32->data))
686 p64->data = compat_ptr(tmp);
690 static long put_compat_ipmi_msg(struct ipmi_msg *p64,
691 struct compat_ipmi_msg __user *p32)
693 if (!access_ok(VERIFY_WRITE, p32, sizeof(*p32)) ||
694 __put_user(p64->netfn, &p32->netfn) ||
695 __put_user(p64->cmd, &p32->cmd) ||
696 __put_user(p64->data_len, &p32->data_len))
701 static long get_compat_ipmi_req(struct ipmi_req *p64,
702 struct compat_ipmi_req __user *p32)
707 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
708 __get_user(tmp, &p32->addr) ||
709 __get_user(p64->addr_len, &p32->addr_len) ||
710 __get_user(p64->msgid, &p32->msgid) ||
711 get_compat_ipmi_msg(&p64->msg, &p32->msg))
713 p64->addr = compat_ptr(tmp);
717 static long get_compat_ipmi_req_settime(struct ipmi_req_settime *p64,
718 struct compat_ipmi_req_settime __user *p32)
720 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
721 get_compat_ipmi_req(&p64->req, &p32->req) ||
722 __get_user(p64->retries, &p32->retries) ||
723 __get_user(p64->retry_time_ms, &p32->retry_time_ms))
728 static long get_compat_ipmi_recv(struct ipmi_recv *p64,
729 struct compat_ipmi_recv __user *p32)
733 if (!access_ok(VERIFY_READ, p32, sizeof(*p32)) ||
734 __get_user(p64->recv_type, &p32->recv_type) ||
735 __get_user(tmp, &p32->addr) ||
736 __get_user(p64->addr_len, &p32->addr_len) ||
737 __get_user(p64->msgid, &p32->msgid) ||
738 get_compat_ipmi_msg(&p64->msg, &p32->msg))
740 p64->addr = compat_ptr(tmp);
744 static long put_compat_ipmi_recv(struct ipmi_recv *p64,
745 struct compat_ipmi_recv __user *p32)
747 if (!access_ok(VERIFY_WRITE, p32, sizeof(*p32)) ||
748 __put_user(p64->recv_type, &p32->recv_type) ||
749 __put_user(p64->addr_len, &p32->addr_len) ||
750 __put_user(p64->msgid, &p32->msgid) ||
751 put_compat_ipmi_msg(&p64->msg, &p32->msg))
757 * Handle compatibility ioctls
759 static long compat_ipmi_ioctl(struct file *filep, unsigned int cmd,
763 struct ipmi_file_private *priv = filep->private_data;
766 case COMPAT_IPMICTL_SEND_COMMAND:
770 if (get_compat_ipmi_req(&rp, compat_ptr(arg)))
773 return handle_send_req(priv->user, &rp,
774 priv->default_retries,
775 priv->default_retry_time_ms);
777 case COMPAT_IPMICTL_SEND_COMMAND_SETTIME:
779 struct ipmi_req_settime sp;
781 if (get_compat_ipmi_req_settime(&sp, compat_ptr(arg)))
784 return handle_send_req(priv->user, &sp.req,
785 sp.retries, sp.retry_time_ms);
787 case COMPAT_IPMICTL_RECEIVE_MSG:
788 case COMPAT_IPMICTL_RECEIVE_MSG_TRUNC:
790 struct ipmi_recv __user *precv64;
791 struct ipmi_recv recv64;
793 if (get_compat_ipmi_recv(&recv64, compat_ptr(arg)))
796 precv64 = compat_alloc_user_space(sizeof(recv64));
797 if (copy_to_user(precv64, &recv64, sizeof(recv64)))
800 rc = ipmi_ioctl(filep->f_path.dentry->d_inode, filep,
801 ((cmd == COMPAT_IPMICTL_RECEIVE_MSG)
802 ? IPMICTL_RECEIVE_MSG
803 : IPMICTL_RECEIVE_MSG_TRUNC),
804 (unsigned long) precv64);
808 if (copy_from_user(&recv64, precv64, sizeof(recv64)))
811 if (put_compat_ipmi_recv(&recv64, compat_ptr(arg)))
817 return ipmi_ioctl(filep->f_path.dentry->d_inode, filep, cmd, arg);
822 static const struct file_operations ipmi_fops = {
823 .owner = THIS_MODULE,
826 .compat_ioctl = compat_ipmi_ioctl,
829 .release = ipmi_release,
830 .fasync = ipmi_fasync,
834 #define DEVICE_NAME "ipmidev"
836 static int ipmi_major;
837 module_param(ipmi_major, int, 0);
838 MODULE_PARM_DESC(ipmi_major, "Sets the major number of the IPMI device. By"
839 " default, or if you set it to zero, it will choose the next"
840 " available device. Setting it to -1 will disable the"
841 " interface. Other values will set the major device number"
844 /* Keep track of the devices that are registered. */
845 struct ipmi_reg_list {
847 struct list_head link;
849 static LIST_HEAD(reg_list);
850 static DEFINE_MUTEX(reg_list_mutex);
852 static struct class *ipmi_class;
854 static void ipmi_new_smi(int if_num, struct device *device)
856 dev_t dev = MKDEV(ipmi_major, if_num);
857 struct ipmi_reg_list *entry;
859 entry = kmalloc(sizeof(*entry), GFP_KERNEL);
861 printk(KERN_ERR "ipmi_devintf: Unable to create the"
862 " ipmi class device link\n");
867 mutex_lock(®_list_mutex);
868 class_device_create(ipmi_class, NULL, dev, device, "ipmi%d", if_num);
869 list_add(&entry->link, ®_list);
870 mutex_unlock(®_list_mutex);
873 static void ipmi_smi_gone(int if_num)
875 dev_t dev = MKDEV(ipmi_major, if_num);
876 struct ipmi_reg_list *entry;
878 mutex_lock(®_list_mutex);
879 list_for_each_entry(entry, ®_list, link) {
880 if (entry->dev == dev) {
881 list_del(&entry->link);
886 class_device_destroy(ipmi_class, dev);
887 mutex_unlock(®_list_mutex);
890 static struct ipmi_smi_watcher smi_watcher =
892 .owner = THIS_MODULE,
893 .new_smi = ipmi_new_smi,
894 .smi_gone = ipmi_smi_gone,
897 static __init int init_ipmi_devintf(void)
904 printk(KERN_INFO "ipmi device interface\n");
906 ipmi_class = class_create(THIS_MODULE, "ipmi");
907 if (IS_ERR(ipmi_class)) {
908 printk(KERN_ERR "ipmi: can't register device class\n");
909 return PTR_ERR(ipmi_class);
912 rv = register_chrdev(ipmi_major, DEVICE_NAME, &ipmi_fops);
914 class_destroy(ipmi_class);
915 printk(KERN_ERR "ipmi: can't get major %d\n", ipmi_major);
919 if (ipmi_major == 0) {
923 rv = ipmi_smi_watcher_register(&smi_watcher);
925 unregister_chrdev(ipmi_major, DEVICE_NAME);
926 class_destroy(ipmi_class);
927 printk(KERN_WARNING "ipmi: can't register smi watcher\n");
933 module_init(init_ipmi_devintf);
935 static __exit void cleanup_ipmi(void)
937 struct ipmi_reg_list *entry, *entry2;
938 mutex_lock(®_list_mutex);
939 list_for_each_entry_safe(entry, entry2, ®_list, link) {
940 list_del(&entry->link);
941 class_device_destroy(ipmi_class, entry->dev);
944 mutex_unlock(®_list_mutex);
945 class_destroy(ipmi_class);
946 ipmi_smi_watcher_unregister(&smi_watcher);
947 unregister_chrdev(ipmi_major, DEVICE_NAME);
949 module_exit(cleanup_ipmi);
951 MODULE_LICENSE("GPL");
952 MODULE_AUTHOR("Corey Minyard <minyard@mvista.com>");
953 MODULE_DESCRIPTION("Linux device interface for the IPMI message handler.");