2 * pcmcia_ioctl.c -- ioctl interface for cardmgr and cardctl
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * The initial developer of the original code is David A. Hinds
9 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
10 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
12 * (C) 1999 David A. Hinds
13 * (C) 2003 - 2004 Dominik Brodowski
17 * This file will go away soon.
21 #include <linux/config.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/major.h>
26 #include <linux/errno.h>
27 #include <linux/ioctl.h>
28 #include <linux/proc_fs.h>
29 #include <linux/poll.h>
30 #include <linux/pci.h>
31 #include <linux/workqueue.h>
33 #define IN_CARD_SERVICES
34 #include <pcmcia/cs_types.h>
35 #include <pcmcia/cs.h>
36 #include <pcmcia/cistpl.h>
37 #include <pcmcia/ds.h>
38 #include <pcmcia/ss.h>
40 #include "cs_internal.h"
41 #include "ds_internal.h"
43 static int major_dev = -1;
46 /* Device user information */
48 #define USER_MAGIC 0x7ea4
49 #define CHECK_USER(u) \
50 (((u) == NULL) || ((u)->user_magic != USER_MAGIC))
52 typedef struct user_info_t {
54 int event_head, event_tail;
55 event_t event[MAX_EVENTS];
56 struct user_info_t *next;
57 struct pcmcia_socket *socket;
62 extern int ds_pc_debug;
63 #define cs_socket_name(skt) ((skt)->dev.class_id)
65 #define ds_dbg(lvl, fmt, arg...) do { \
66 if (ds_pc_debug >= lvl) \
67 printk(KERN_DEBUG "ds: " fmt , ## arg); \
70 #define ds_dbg(lvl, fmt, arg...) do { } while (0)
74 /* backwards-compatible accessing of driver --- by name! */
76 static struct pcmcia_driver * get_pcmcia_driver (dev_info_t *dev_info)
78 struct device_driver *drv;
79 struct pcmcia_driver *p_drv;
81 drv = driver_find((char *) dev_info, &pcmcia_bus_type);
85 p_drv = container_of(drv, struct pcmcia_driver, drv);
92 static struct proc_dir_entry *proc_pccard = NULL;
94 static int proc_read_drivers_callback(struct device_driver *driver, void *d)
97 struct pcmcia_driver *p_drv = container_of(driver,
98 struct pcmcia_driver, drv);
100 *p += sprintf(*p, "%-24.24s 1 %d\n", p_drv->drv.name,
101 #ifdef CONFIG_MODULE_UNLOAD
102 (p_drv->owner) ? module_refcount(p_drv->owner) : 1
112 static int proc_read_drivers(char *buf, char **start, off_t pos,
113 int count, int *eof, void *data)
117 bus_for_each_drv(&pcmcia_bus_type, NULL,
118 (void *) &p, proc_read_drivers_callback);
124 /*======================================================================
126 These manage a ring buffer of events pending for one user process
128 ======================================================================*/
131 static int queue_empty(user_info_t *user)
133 return (user->event_head == user->event_tail);
136 static event_t get_queued_event(user_info_t *user)
138 user->event_tail = (user->event_tail+1) % MAX_EVENTS;
139 return user->event[user->event_tail];
142 static void queue_event(user_info_t *user, event_t event)
144 user->event_head = (user->event_head+1) % MAX_EVENTS;
145 if (user->event_head == user->event_tail)
146 user->event_tail = (user->event_tail+1) % MAX_EVENTS;
147 user->event[user->event_head] = event;
150 void handle_event(struct pcmcia_socket *s, event_t event)
153 for (user = s->user; user; user = user->next)
154 queue_event(user, event);
155 wake_up_interruptible(&s->queue);
159 /*======================================================================
161 bind_request() and bind_device() are merged by now. Register_client()
162 is called right at the end of bind_request(), during the driver's
163 ->attach() call. Individual descriptions:
165 bind_request() connects a socket to a particular client driver.
166 It looks up the specified device ID in the list of registered
167 drivers, binds it to the socket, and tries to create an instance
168 of the device. unbind_request() deletes a driver instance.
170 Bind_device() associates a device driver with a particular socket.
171 It is normally called by Driver Services after it has identified
172 a newly inserted card. An instance of that driver will then be
173 eligible to register as a client of this socket.
175 Register_client() uses the dev_info_t handle to match the
176 caller with a socket. The driver must have already been bound
177 to a socket with bind_device() -- in fact, bind_device()
178 allocates the client structure that will be used.
180 ======================================================================*/
182 static int bind_request(struct pcmcia_socket *s, bind_info_t *bind_info)
184 struct pcmcia_driver *p_drv;
185 struct pcmcia_device *p_dev;
189 s = pcmcia_get_socket(s);
193 ds_dbg(2, "bind_request(%d, '%s')\n", s->sock,
194 (char *)bind_info->dev_info);
196 p_drv = get_pcmcia_driver(&bind_info->dev_info);
202 if (!try_module_get(p_drv->owner)) {
207 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
208 list_for_each_entry(p_dev, &s->devices_list, socket_device_list) {
209 if (p_dev->func == bind_info->function) {
210 if ((p_dev->dev.driver == &p_drv->drv)) {
211 if (p_dev->cardmgr) {
212 /* if there's already a device
213 * registered, and it was registered
214 * by userspace before, we need to
215 * return the "instance". */
216 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
217 bind_info->instance = p_dev->instance;
221 /* the correct driver managed to bind
222 * itself magically to the correct
224 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
225 p_dev->cardmgr = p_drv;
229 } else if (!p_dev->dev.driver) {
230 /* there's already a device available where
231 * no device has been bound to yet. So we don't
232 * need to register a device! */
233 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
238 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
240 p_dev = pcmcia_device_add(s, bind_info->function);
247 p_dev->cardmgr = p_drv;
249 /* if a driver is already running, we can abort */
250 if (p_dev->dev.driver)
254 * Prevent this racing with a card insertion.
257 bus_rescan_devices(&pcmcia_bus_type);
260 /* check whether the driver indeed matched. I don't care if this
261 * is racy or not, because it can only happen on cardmgr access
264 if (!(p_dev->dev.driver == &p_drv->drv))
265 p_dev->cardmgr = NULL;
268 module_put(p_drv->owner);
270 put_driver(&p_drv->drv);
272 pcmcia_put_socket(s);
277 #ifdef CONFIG_CARDBUS
279 static struct pci_bus *pcmcia_lookup_bus(struct pcmcia_socket *s)
281 if (!s || !(s->state & SOCKET_CARDBUS))
284 return s->cb_dev->subordinate;
288 static int get_device_info(struct pcmcia_socket *s, bind_info_t *bind_info, int first)
291 struct pcmcia_device *p_dev;
295 #ifdef CONFIG_CARDBUS
297 * Some unbelievably ugly code to associate the PCI cardbus
298 * device and its driver with the PCMCIA "bind" information.
303 bus = pcmcia_lookup_bus(s);
305 struct list_head *list;
306 struct pci_dev *dev = NULL;
308 list = bus->devices.next;
309 while (list != &bus->devices) {
310 struct pci_dev *pdev = pci_dev_b(list);
318 /* Try to handle "next" here some way? */
320 if (dev && dev->driver) {
321 strlcpy(bind_info->name, dev->driver->name, DEV_NAME_LEN);
322 bind_info->major = 0;
323 bind_info->minor = 0;
324 bind_info->next = NULL;
331 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
332 list_for_each_entry(p_dev, &s->devices_list, socket_device_list) {
333 if (p_dev->func == bind_info->function) {
334 p_dev = pcmcia_get_dev(p_dev);
340 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
344 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
346 if ((!p_dev->instance) ||
347 (p_dev->instance->state & DEV_CONFIG_PENDING)) {
353 node = p_dev->instance->dev;
355 for (node = p_dev->instance->dev; node; node = node->next)
356 if (node == bind_info->next)
363 strlcpy(bind_info->name, node->dev_name, DEV_NAME_LEN);
364 bind_info->major = node->major;
365 bind_info->minor = node->minor;
366 bind_info->next = node->next;
369 pcmcia_put_dev(p_dev);
371 } /* get_device_info */
374 static int ds_open(struct inode *inode, struct file *file)
376 socket_t i = iminor(inode);
377 struct pcmcia_socket *s;
380 ds_dbg(0, "ds_open(socket %d)\n", i);
382 s = pcmcia_get_socket_by_nr(i);
385 s = pcmcia_get_socket(s);
389 if ((file->f_flags & O_ACCMODE) != O_RDONLY) {
390 if (s->pcmcia_state.busy) {
391 pcmcia_put_socket(s);
395 s->pcmcia_state.busy = 1;
398 user = kmalloc(sizeof(user_info_t), GFP_KERNEL);
400 pcmcia_put_socket(s);
403 user->event_tail = user->event_head = 0;
404 user->next = s->user;
405 user->user_magic = USER_MAGIC;
408 file->private_data = user;
410 if (s->pcmcia_state.present)
411 queue_event(user, CS_EVENT_CARD_INSERTION);
415 /*====================================================================*/
417 static int ds_release(struct inode *inode, struct file *file)
419 struct pcmcia_socket *s;
420 user_info_t *user, **link;
422 ds_dbg(0, "ds_release(socket %d)\n", iminor(inode));
424 user = file->private_data;
425 if (CHECK_USER(user))
430 /* Unlink user data structure */
431 if ((file->f_flags & O_ACCMODE) != O_RDONLY) {
432 s->pcmcia_state.busy = 0;
434 file->private_data = NULL;
435 for (link = &s->user; *link; link = &(*link)->next)
436 if (*link == user) break;
440 user->user_magic = 0;
442 pcmcia_put_socket(s);
447 /*====================================================================*/
449 static ssize_t ds_read(struct file *file, char __user *buf,
450 size_t count, loff_t *ppos)
452 struct pcmcia_socket *s;
456 ds_dbg(2, "ds_read(socket %d)\n", iminor(file->f_dentry->d_inode));
461 user = file->private_data;
462 if (CHECK_USER(user))
466 if (s->pcmcia_state.dead)
469 ret = wait_event_interruptible(s->queue, !queue_empty(user));
471 ret = put_user(get_queued_event(user), (int __user *)buf) ? -EFAULT : 4;
476 /*====================================================================*/
478 static ssize_t ds_write(struct file *file, const char __user *buf,
479 size_t count, loff_t *ppos)
481 ds_dbg(2, "ds_write(socket %d)\n", iminor(file->f_dentry->d_inode));
485 if ((file->f_flags & O_ACCMODE) == O_RDONLY)
491 /*====================================================================*/
493 /* No kernel lock - fine */
494 static u_int ds_poll(struct file *file, poll_table *wait)
496 struct pcmcia_socket *s;
499 ds_dbg(2, "ds_poll(socket %d)\n", iminor(file->f_dentry->d_inode));
501 user = file->private_data;
502 if (CHECK_USER(user))
506 * We don't check for a dead socket here since that
507 * will send cardmgr into an endless spin.
509 poll_wait(file, &s->queue, wait);
510 if (!queue_empty(user))
511 return POLLIN | POLLRDNORM;
515 /*====================================================================*/
517 extern int pcmcia_adjust_resource_info(adjust_t *adj);
519 static int ds_ioctl(struct inode * inode, struct file * file,
520 u_int cmd, u_long arg)
522 struct pcmcia_socket *s;
523 void __user *uarg = (char __user *)arg;
529 ds_dbg(2, "ds_ioctl(socket %d, %#x, %#lx)\n", iminor(inode), cmd, arg);
531 user = file->private_data;
532 if (CHECK_USER(user))
536 if (s->pcmcia_state.dead)
539 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
540 if (size > sizeof(ds_ioctl_arg_t)) return -EINVAL;
542 /* Permission check */
543 if (!(cmd & IOC_OUT) && !capable(CAP_SYS_ADMIN))
547 if (!access_ok(VERIFY_READ, uarg, size)) {
548 ds_dbg(3, "ds_ioctl(): verify_read = %d\n", -EFAULT);
553 if (!access_ok(VERIFY_WRITE, uarg, size)) {
554 ds_dbg(3, "ds_ioctl(): verify_write = %d\n", -EFAULT);
558 buf = kmalloc(sizeof(ds_ioctl_arg_t), GFP_KERNEL);
564 if (cmd & IOC_IN) __copy_from_user((char *)buf, uarg, size);
567 case DS_ADJUST_RESOURCE_INFO:
568 ret = pcmcia_adjust_resource_info(&buf->adjust);
570 case DS_GET_CONFIGURATION_INFO:
571 if (buf->config.Function &&
572 (buf->config.Function >= s->functions))
575 ret = pccard_get_configuration_info(s,
576 buf->config.Function, &buf->config);
578 case DS_GET_FIRST_TUPLE:
580 pcmcia_validate_mem(s);
582 ret = pccard_get_first_tuple(s, BIND_FN_ALL, &buf->tuple);
584 case DS_GET_NEXT_TUPLE:
585 ret = pccard_get_next_tuple(s, BIND_FN_ALL, &buf->tuple);
587 case DS_GET_TUPLE_DATA:
588 buf->tuple.TupleData = buf->tuple_parse.data;
589 buf->tuple.TupleDataMax = sizeof(buf->tuple_parse.data);
590 ret = pccard_get_tuple_data(s, &buf->tuple);
593 buf->tuple.TupleData = buf->tuple_parse.data;
594 ret = pccard_parse_tuple(&buf->tuple, &buf->tuple_parse.parse);
597 ret = pccard_reset_card(s);
600 if (buf->status.Function &&
601 (buf->status.Function >= s->functions))
604 ret = pccard_get_status(s, buf->status.Function, &buf->status);
606 case DS_VALIDATE_CIS:
608 pcmcia_validate_mem(s);
610 ret = pccard_validate_cis(s, BIND_FN_ALL, &buf->cisinfo);
612 case DS_SUSPEND_CARD:
613 ret = pcmcia_suspend_card(s);
616 ret = pcmcia_resume_card(s);
619 err = pcmcia_eject_card(s);
622 err = pcmcia_insert_card(s);
624 case DS_ACCESS_CONFIGURATION_REGISTER:
625 if ((buf->conf_reg.Action == CS_WRITE) && !capable(CAP_SYS_ADMIN)) {
629 if (buf->conf_reg.Function &&
630 (buf->conf_reg.Function >= s->functions))
633 ret = pccard_access_configuration_register(s,
634 buf->conf_reg.Function, &buf->conf_reg);
636 case DS_GET_FIRST_REGION:
637 case DS_GET_NEXT_REGION:
639 if (!capable(CAP_SYS_ADMIN)) {
643 static int printed = 0;
645 printk(KERN_WARNING "2.6. kernels use pcmciamtd instead of memory_cs.c and do not require special\n");
646 printk(KERN_WARNING "MTD handling any more.\n");
653 case DS_GET_FIRST_WINDOW:
654 ret = pcmcia_get_window(s, &buf->win_info.handle, 0,
655 &buf->win_info.window);
657 case DS_GET_NEXT_WINDOW:
658 ret = pcmcia_get_window(s, &buf->win_info.handle,
659 buf->win_info.handle->index + 1, &buf->win_info.window);
661 case DS_GET_MEM_PAGE:
662 ret = pcmcia_get_mem_page(buf->win_info.handle,
666 ret = pcmcia_replace_cis(s, &buf->cisdump);
668 case DS_BIND_REQUEST:
669 if (!capable(CAP_SYS_ADMIN)) {
673 err = bind_request(s, &buf->bind_info);
675 case DS_GET_DEVICE_INFO:
676 err = get_device_info(s, &buf->bind_info, 1);
678 case DS_GET_NEXT_DEVICE:
679 err = get_device_info(s, &buf->bind_info, 0);
681 case DS_UNBIND_REQUEST:
688 if ((err == 0) && (ret != CS_SUCCESS)) {
689 ds_dbg(2, "ds_ioctl: ret = %d\n", ret);
691 case CS_BAD_SOCKET: case CS_NO_CARD:
692 err = -ENODEV; break;
693 case CS_BAD_ARGS: case CS_BAD_ATTRIBUTE: case CS_BAD_IRQ:
695 err = -EINVAL; break;
698 case CS_OUT_OF_RESOURCE:
699 err = -ENOSPC; break;
700 case CS_NO_MORE_ITEMS:
701 err = -ENODATA; break;
702 case CS_UNSUPPORTED_FUNCTION:
703 err = -ENOSYS; break;
710 if (__copy_to_user(uarg, (char *)buf, size))
719 /*====================================================================*/
721 static struct file_operations ds_fops = {
722 .owner = THIS_MODULE,
724 .release = ds_release,
731 void __init pcmcia_setup_ioctl(void) {
734 /* Set up character device for user mode clients */
735 i = register_chrdev(0, "pcmcia", &ds_fops);
737 printk(KERN_NOTICE "unable to find a free device # for "
738 "Driver Services (error=%d)\n", i);
742 #ifdef CONFIG_PROC_FS
743 proc_pccard = proc_mkdir("pccard", proc_bus);
745 create_proc_read_entry("drivers",0,proc_pccard,proc_read_drivers,NULL);
750 void __exit pcmcia_cleanup_ioctl(void) {
751 #ifdef CONFIG_PROC_FS
753 remove_proc_entry("drivers", proc_pccard);
754 remove_proc_entry("pccard", proc_bus);
758 unregister_chrdev(major_dev, "pcmcia");