Hi,
This patch updates the pcmcia subsystem to utilize the driver model and sysfs.
It cooperates peacefully with pcmcia-cs and does not break any drivers or
require any API changes. It has been tested and is stable on my boxes.
The following features have been added to the pcmcia subsystem:
1.) "struct device" is created and removed
2.) pcmcia drivers are bound to the driver model device
3.) sysfs entries are created for identification information
4.) hotplug events are generated
5.) class devices are linked to physical pcmcia devices
6.) class devices are linked to pcmcia drivers
These changes are necessary for pcmcia to function properly on modern
hotplug/sysfs systems. I would appreciate any comments or suggestions.
Thanks,
Adam
Applies against 2.6.7:
diff -ur linux/drivers/pcmcia/cs.c linux-pcmcia/drivers/pcmcia/cs.c
--- linux/drivers/pcmcia/cs.c 2004-06-16 05:19:02.000000000 +0000
+++ linux-pcmcia/drivers/pcmcia/cs.c 2004-06-28 18:40:03.000000000 +0000
@@ -1155,6 +1155,22 @@
#endif
+/*=====================================================================
+
+ Return the driver model device associated with a card..
+
+======================================================================*/
+
+struct device *pcmcia_lookup_device(client_handle_t handle)
+{
+ if (CHECK_HANDLE(handle))
+ return NULL;
+
+ return handle->device;
+}
+
+EXPORT_SYMBOL(pcmcia_lookup_device);
+
/*======================================================================
Get the current socket state bits. We don't support the latched
@@ -2141,6 +2157,7 @@
EXPORT_SYMBOL(pcmcia_suspend_card);
EXPORT_SYMBOL(pcmcia_validate_cis);
EXPORT_SYMBOL(pcmcia_write_memory);
+EXPORT_SYMBOL(read_tuple);
EXPORT_SYMBOL(dead_socket);
EXPORT_SYMBOL(MTDHelperEntry);
diff -ur linux/drivers/pcmcia/cs_internal.h linux-pcmcia/drivers/pcmcia/cs_internal.h
--- linux/drivers/pcmcia/cs_internal.h 2004-06-16 05:20:26.000000000 +0000
+++ linux-pcmcia/drivers/pcmcia/cs_internal.h 2004-06-28 18:40:03.000000000 +0000
@@ -33,6 +33,7 @@
typedef struct client_t {
u_short client_magic;
struct pcmcia_socket *Socket;
+ struct device *device;
u_char Function;
dev_info_t dev_info;
u_int Attributes;
diff -ur linux/drivers/pcmcia/ds.c linux-pcmcia/drivers/pcmcia/ds.c
--- linux/drivers/pcmcia/ds.c 2004-06-16 05:19:44.000000000 +0000
+++ linux-pcmcia/drivers/pcmcia/ds.c 2004-06-28 19:38:02.000000000 +0000
@@ -108,6 +108,9 @@
struct pcmcia_bus_socket *socket;
} user_info_t;
+static LIST_HEAD(pcmcia_sockets);
+static DECLARE_MUTEX(pcmcia_socket_mutex);
+
/* Socket state information */
struct pcmcia_bus_socket {
atomic_t refcount;
@@ -119,6 +122,9 @@
struct work_struct removal;
socket_bind_t *bind;
struct pcmcia_socket *parent;
+ struct list_head devices;
+ struct semaphore device_mutex;
+ struct list_head socket_list;
};
#define DS_SOCKET_PRESENT 0x01
@@ -135,6 +141,8 @@
extern struct proc_dir_entry *proc_pccard;
+static int resources_ready;
+
/*====================================================================*/
/* code which was in cs.c before */
@@ -164,6 +172,7 @@
client->client_magic = CLIENT_MAGIC;
strlcpy(client->dev_info, (char *)req->dev_info, DEV_NAME_LEN);
client->Socket = s;
+ client->device = &req->device->dev;
client->Function = req->Function;
client->state = CLIENT_UNBOUND;
client->erase_busy.next = &client->erase_busy;
@@ -354,6 +363,8 @@
/*======================================================================*/
+static struct pcmcia_device * get_pcmcia_device (struct pcmcia_bus_socket *s, int function);
+static void put_pcmcia_device(struct pcmcia_device *dev);
static struct pcmcia_driver * get_pcmcia_driver (dev_info_t *dev_info);
static struct pcmcia_bus_socket * get_socket_info_by_nr(unsigned int nr);
@@ -430,6 +441,218 @@
/*======================================================================
+ sysfs support
+
+======================================================================*/
+
+static ssize_t
+pcmcia_show_product_string(struct pcmcia_device *dev, char *buf, int index)
+{
+ char *str = buf;
+
+ if (dev->id_mask & DEVICE_HAS_VERSION_INFO && index < dev->vers_1.ns)
+ str += sprintf(str,"%s\n",
+ dev->vers_1.str+dev->vers_1.ofs[index]);
+ else
+ str += sprintf(str,"\n");
+ return (str - buf);
+}
+
+#define pcmcia_prod_str_attr(field, index) \
+static ssize_t \
+show_##field (struct device *dmdev, char *buf) \
+{ \
+ struct pcmcia_device *dev; \
+ \
+ dev = to_pcmcia_device (dmdev); \
+ return pcmcia_show_product_string(dev,buf,index); \
+} \
+static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
+
+pcmcia_prod_str_attr(prod_str0,0);
+pcmcia_prod_str_attr(prod_str1,1);
+pcmcia_prod_str_attr(prod_str2,2);
+pcmcia_prod_str_attr(prod_str3,3);
+
+static ssize_t
+pcmcia_show_manfid(struct device *dmdev, char *buf)
+{
+ struct pcmcia_device *dev = to_pcmcia_device(dmdev);
+ char *str = buf;
+
+ if (dev->id_mask & DEVICE_HAS_MANF_INFO)
+ str += sprintf(str,"0x%04x, 0x%04x\n",
+ dev->manfid.manf,
+ dev->manfid.card);
+ else
+ str += sprintf(str,"\n");
+ return (str - buf);
+}
+
+static DEVICE_ATTR(manfid,S_IRUGO,pcmcia_show_manfid,NULL);
+
+static void pcmcia_sysfs_attach(struct pcmcia_device *dev)
+{
+ device_create_file (&dev->dev, &dev_attr_prod_str0);
+ device_create_file (&dev->dev, &dev_attr_prod_str1);
+ device_create_file (&dev->dev, &dev_attr_prod_str2);
+ device_create_file (&dev->dev, &dev_attr_prod_str3);
+ device_create_file (&dev->dev, &dev_attr_manfid);
+}
+
+/*======================================================================
+
+ device addition, removal, and hotplug functions for the driver model
+
+======================================================================*/
+
+static void pcmcia_bus_release_device(struct device *pdev)
+{
+ struct pcmcia_device *dev = to_pcmcia_device(pdev);
+ kfree(dev);
+}
+
+static int pcmcia_bus_insert_card(struct pcmcia_bus_socket *s)
+{
+ struct pcmcia_device *dev;
+ int i, ret, function_count = 0, has_cis = 0;
+ cisinfo_t cisinfo;
+
+ if (!(s->state & DS_SOCKET_PRESENT))
+ return CS_NO_CARD;
+
+ if (!resources_ready && !(s->parent->features & SS_CAP_STATIC_MAP))
+ return CS_NO_CARD;
+
+ down(&s->device_mutex);
+ if (!list_empty(&s->devices)) {
+ ret = -EBUSY;
+ goto out;
+ }
+
+ ret = pcmcia_validate_cis(s->handle, &cisinfo);
+ if (ret)
+ goto out;
+
+ if (cisinfo.Chains) {
+ cistpl_longlink_mfc_t mfc;
+
+ has_cis = 1;
+ if (!read_tuple(s->handle, CISTPL_LONGLINK_MFC, &mfc))
+ function_count = mfc.nfn;
+ }
+
+ for (i=0; i<=function_count; i++) {
+ dev = kmalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
+ if (!dev)
+ continue;
+
+ memset(dev, 0, sizeof(struct pcmcia_device));
+ dev->socket = s;
+ dev->dev.parent = s->parent->dev.dev;
+ dev->dev.bus = &pcmcia_bus_type;
+ dev->dev.release = &pcmcia_bus_release_device;
+ snprintf(dev->dev.bus_id, BUS_ID_SIZE, "%u:%u", s->parent->sock, i);
+
+ dev->function = i;
+ if (has_cis) {
+ if (!read_tuple(s->handle, CISTPL_VERS_1, &dev->vers_1))
+ dev->id_mask |= DEVICE_HAS_VERSION_INFO;
+ if (!read_tuple(s->handle, CISTPL_MANFID, &dev->manfid))
+ dev->id_mask |= DEVICE_HAS_MANF_INFO;
+ }
+
+ ret = device_register(&dev->dev);
+ if (!ret) {
+ list_add_tail(&dev->device_list, &s->devices);
+ pcmcia_sysfs_attach(dev);
+ } else
+ kfree(dev);
+ }
+
+out:
+ up(&s->device_mutex);
+ return ret;
+}
+
+static void pcmcia_bus_remove_card(struct pcmcia_bus_socket *s)
+{
+ struct pcmcia_device *dev, *tmp;
+ down(&s->device_mutex);
+ list_for_each_entry_safe(dev, tmp, &s->devices, device_list) {
+ list_del(&dev->device_list);
+ device_unregister(&dev->dev);
+ }
+ up(&s->device_mutex);
+}
+
+#ifdef CONFIG_HOTPLUG
+
+int pcmcia_bus_hotplug(struct device *pdev, char **envp, int num_envp,
+ char *buffer, int buffer_size)
+{
+ struct pcmcia_device *dev;
+ char *scratch;
+ int i = 0;
+ int length = 0;
+
+ if (!pdev)
+ return -ENODEV;
+
+ dev = to_pcmcia_device(pdev);
+
+ scratch = buffer;
+
+ /* stuff we want to pass to /sbin/hotplug */
+ envp[i++] = scratch;
+ length += snprintf (scratch, buffer_size - length, "PRODUCT=");
+ for (i = 0; i < dev->vers_1.ns; i++) {
+ length += snprintf(scratch,buffer_size - length, "%s\"%s\"", (i>0) ? "," : "",
+ dev->vers_1.str+dev->vers_1.ofs[i]);
+ }
+
+ if ((buffer_size - length <= 0) || (i >= num_envp))
+ return -ENOMEM;
+ ++length;
+ scratch += length;
+
+ envp [i++] = scratch;
+ length += snprintf (scratch, buffer_size - length, "MANFID=0x%04x,0x%04x",
+ dev->manfid.manf, dev->manfid.card);
+ if ((buffer_size - length <= 0) || (i >= num_envp))
+ return -ENOMEM;
+ ++length;
+ scratch += length;
+
+ envp[i] = 0;
+
+ return 0;
+}
+
+#else /* CONFIG_HOTPLUG */
+
+int pcmcia_bus_hotplug(struct device *pdev, char **envp, int num_envp,
+ char *buffer, int buffer_size)
+{
+ return -ENODEV;
+}
+
+#endif /* CONFIG_HOTPLUG */
+
+static void pcmcia_rescan_sockets(void)
+{
+ struct pcmcia_bus_socket *s;
+
+ down(&pcmcia_socket_mutex);
+
+ list_for_each_entry(s, &pcmcia_sockets, socket_list)
+ pcmcia_bus_insert_card(s);
+
+ up(&pcmcia_socket_mutex);
+}
+
+/*======================================================================
+
These manage a ring buffer of events pending for one user process
======================================================================*/
@@ -501,6 +724,7 @@
case CS_EVENT_CARD_REMOVAL:
s->state &= ~DS_SOCKET_PRESENT;
+ pcmcia_bus_remove_card(s);
if (!(s->state & DS_SOCKET_REMOVAL_PENDING)) {
s->state |= DS_SOCKET_REMOVAL_PENDING;
schedule_delayed_work(&s->removal, HZ/10);
@@ -509,6 +733,7 @@
case CS_EVENT_CARD_INSERTION:
s->state |= DS_SOCKET_PRESENT;
+ pcmcia_bus_insert_card(s);
handle_event(s, event);
break;
@@ -562,6 +787,7 @@
static int bind_request(struct pcmcia_bus_socket *s, bind_info_t *bind_info)
{
struct pcmcia_driver *driver;
+ struct pcmcia_device *device;
socket_bind_t *b;
bind_req_t bind_req;
int ret;
@@ -587,7 +813,12 @@
if (!try_module_get(driver->owner))
return -EINVAL;
+ device = get_pcmcia_device(s, bind_info->function);
+ if (!device)
+ return -EINVAL;
+
bind_req.Socket = s->parent;
+ bind_req.device = device;
bind_req.Function = bind_info->function;
bind_req.dev_info = (dev_info_t *) driver->drv.name;
ret = pcmcia_bind_device(&bind_req);
@@ -614,16 +845,25 @@
b->next = s->bind;
s->bind = b;
+ down_write(&device->dev.bus->subsys.rwsem);
+ device->dev.driver = &driver->drv;
+
if (driver->attach) {
b->instance = driver->attach();
if (b->instance == NULL) {
printk(KERN_NOTICE "ds: unable to create instance "
"of '%s'!\n", (char *)bind_info->dev_info);
module_put(driver->owner);
+ device->dev.driver = NULL;
+ up_write(&device->dev.bus->subsys.rwsem);
return -ENODEV;
}
}
+ device_bind_driver(&device->dev);
+ up_write(&device->dev.bus->subsys.rwsem);
+ put_pcmcia_device(device);
+
return 0;
} /* bind_request */
@@ -699,6 +939,7 @@
static int unbind_request(struct pcmcia_bus_socket *s, bind_info_t *bind_info)
{
socket_bind_t **b, *c;
+ struct pcmcia_device *device;
ds_dbg(2, "unbind_request(%d, '%s')\n", s->parent->sock,
(char *)bind_info->dev_info);
@@ -710,6 +951,14 @@
if (*b == NULL)
return -ENODEV;
+ device = get_pcmcia_device(s, bind_info->function);
+ if (device) {
+ down_write(&device->dev.bus->subsys.rwsem);
+ device_release_driver(&device->dev);
+ up_write(&device->dev.bus->subsys.rwsem);
+ put_pcmcia_device(device);
+ }
+
c = *b;
c->driver->use_count--;
if (c->driver->detach) {
@@ -933,6 +1182,12 @@
switch (cmd) {
case DS_ADJUST_RESOURCE_INFO:
ret = pcmcia_adjust_resource_info(s->handle, &buf.adjust);
+ /*
+ * We can't read CIS information until user space has given us the
+ * memory resource locations. Therefore, we wait until now.
+ */
+ if ((ret == CS_SUCCESS) && (buf.adjust.Resource == RES_MEMORY_RANGE))
+ resources_ready = 1;
break;
case DS_GET_CARD_SERVICES_INFO:
ret = pcmcia_get_card_services_info(&buf.servinfo);
@@ -1003,6 +1258,7 @@
break;
case DS_BIND_REQUEST:
if (!capable(CAP_SYS_ADMIN)) return -EPERM;
+ pcmcia_rescan_sockets();
err = bind_request(s, &buf.bind_info);
break;
case DS_GET_DEVICE_INFO:
@@ -1073,7 +1329,11 @@
return -ENOMEM;
memset(s, 0, sizeof(struct pcmcia_bus_socket));
atomic_set(&s->refcount, 1);
-
+
+ down(&pcmcia_socket_mutex);
+ list_add_tail(&s->socket_list, &pcmcia_sockets);
+ up(&pcmcia_socket_mutex);
+
/*
* Ugly. But we want to wait for the socket threads to have started up.
* We really should let the drivers themselves drive some of this..
@@ -1085,6 +1345,8 @@
init_waitqueue_head(&s->request);
/* initialize data */
+ INIT_LIST_HEAD(&s->devices);
+ init_MUTEX(&s->device_mutex);
INIT_WORK(&s->removal, handle_removal, s);
s->parent = socket;
@@ -1133,6 +1395,11 @@
pcmcia_deregister_client(socket->pcmcia->handle);
+ down(&pcmcia_socket_mutex);
+ pcmcia_bus_remove_card(socket->pcmcia);
+ list_del(&socket->pcmcia->socket_list);
+ up(&pcmcia_socket_mutex);
+
socket->pcmcia->state |= DS_SOCKET_DEAD;
pcmcia_put_bus_socket(socket->pcmcia);
socket->pcmcia = NULL;
@@ -1151,7 +1418,9 @@
struct bus_type pcmcia_bus_type = {
.name = "pcmcia",
+ .hotplug = pcmcia_bus_hotplug,
};
+
EXPORT_SYMBOL(pcmcia_bus_type);
@@ -1178,13 +1447,12 @@
return 0;
}
-fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
+fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
* pcmcia_socket_class is already registered */
static void __exit exit_pcmcia_bus(void)
{
- class_interface_unregister(&pcmcia_bus_interface);
#ifdef CONFIG_PROC_FS
if (proc_pccard) {
@@ -1195,6 +1463,7 @@
if (major_dev != -1)
unregister_chrdev(major_dev, "pcmcia");
+ class_interface_unregister(&pcmcia_bus_interface);
bus_unregister(&pcmcia_bus_type);
}
module_exit(exit_pcmcia_bus);
@@ -1236,9 +1505,30 @@
struct cmp_data cmp = {
.dev_info = dev_info,
};
-
+
ret = bus_for_each_drv(&pcmcia_bus_type, NULL, &cmp, cmp_drv_callback);
if (ret)
return cmp.drv;
return NULL;
}
+
+static struct pcmcia_device * get_pcmcia_device (struct pcmcia_bus_socket *s, int function)
+{
+ struct pcmcia_device *dev, *tmp;
+ down(&s->device_mutex);
+ list_for_each_entry_safe(dev, tmp, &s->devices, device_list) {
+ if (dev->function == function) {
+ if (!get_device(&dev->dev))
+ break;
+ up(&s->device_mutex);
+ return dev;
+ }
+ }
+ up(&s->device_mutex);
+ return NULL;
+}
+
+static void put_pcmcia_device(struct pcmcia_device *dev)
+{
+ put_device(&dev->dev);
+}
diff -ur linux/include/pcmcia/cs.h linux-pcmcia/include/pcmcia/cs.h
--- linux/include/pcmcia/cs.h 2004-06-16 05:18:37.000000000 +0000
+++ linux-pcmcia/include/pcmcia/cs.h 2004-06-28 18:40:03.000000000 +0000
@@ -318,6 +318,7 @@
/* Special stuff for binding drivers to sockets */
typedef struct bind_req_t {
struct pcmcia_socket *Socket;
+ struct pcmcia_device *device;
u_char Function;
dev_info_t *dev_info;
} bind_req_t;
@@ -452,6 +453,7 @@
int pcmcia_set_event_mask(client_handle_t handle, eventmask_t *mask);
int pcmcia_report_error(client_handle_t handle, error_info_t *err);
struct pci_bus *pcmcia_lookup_bus(client_handle_t handle);
+struct device *pcmcia_lookup_device(client_handle_t handle);
/* rsrc_mgr.c */
int pcmcia_adjust_resource_info(client_handle_t handle, adjust_t *adj);
diff -ur linux/include/pcmcia/ds.h linux-pcmcia/include/pcmcia/ds.h
--- linux/include/pcmcia/ds.h 2004-06-16 05:18:37.000000000 +0000
+++ linux-pcmcia/include/pcmcia/ds.h 2004-06-28 18:40:03.000000000 +0000
@@ -151,6 +151,21 @@
struct device_driver drv;
};
+struct pcmcia_device {
+ struct device dev;
+ struct pcmcia_bus_socket *socket;
+ struct list_head device_list;
+ int function;
+ int id_mask;
+ cistpl_vers_1_t vers_1;
+ cistpl_manfid_t manfid;
+};
+
+#define to_pcmcia_device(n) container_of(n, struct pcmcia_device, dev)
+
+#define DEVICE_HAS_VERSION_INFO 0x0001
+#define DEVICE_HAS_MANF_INFO 0x0002
+
/* driver registration */
int pcmcia_register_driver(struct pcmcia_driver *driver);
void pcmcia_unregister_driver(struct pcmcia_driver *driver);
On Monday 28 June 2004 03:02 pm, Adam Belay wrote:
> Hi,
>
> This patch updates the pcmcia subsystem to utilize the driver model and sysfs.
> It cooperates peacefully with pcmcia-cs and does not break any drivers or
> require any API changes. It has been tested and is stable on my boxes.
>
Works nicely here with SMC 2632W-v2 wireless card (atmel-cs) and
02:0f.0 CardBus bridge: Texas Instruments PCI4451 PC card Cardbus Controller
--
Dmitry
On Mon, Jun 28, 2004 at 08:02:24PM +0000, Adam Belay wrote:
> This patch updates the pcmcia subsystem to utilize the driver model and sysfs.
> It cooperates peacefully with pcmcia-cs and does not break any drivers or
> require any API changes. It has been tested and is stable on my boxes.
Thank you, I'll add this to my collection of PCMCIA device model
patches. I have quite a selection. 8)
I still have rather a number of patches for the pcmcia resource and
socket driver side of things, and I'm hesitant to put anything other
than bug fixes in before these are all in. This is something which
will only proceed slowly - hopefully it should be complete by 2.6.9.
This is especially slow because the only kernels which appear to be
well tested for PCMCIA are Linus' main releases and I don't want to
push too many changes in at one time.
Also, there remain races in the PCMCIA network drivers in their unload
code - they free everything and _then_ unregister from the network
layer. This should be fixed before we even think of adding device
model support... I thought I'd already sent this patch, but it seems
it never made it into the kernel.
--
Russell King
Linux kernel 2.6 ARM Linux - http://www.arm.linux.org.uk/
maintainer of: 2.6 PCMCIA - http://pcmcia.arm.linux.org.uk/
2.6 Serial core
Hi Adam,
First of all I'd like to say that I'm glad you're taking interest in
the PCMCIA core, and that your experience and patch-writing skills will
surely be a valuable addition in the joint effort of transforming the
PCMCIA subsystem to "kernel standards", e.g. hotplug, driver model and
sysfs.
Second, you might not know about the linux-pcmcia list
http://lists.infradead.org/mailman/listinfo/linux-pcmcia
yet -- it's where most PCMCIA-core-in-2.{6,7} stuff is discussed, and it is quite
low-traffic. Please CC this list on PCMCIA-core-in-2.{6,7} matters in
future.
Third, about your patches:
- I like many ideas in your patches -- large parts of them, though, are
"double work" as similar things have already been submitted (by me)
to Russell on the linux-pcmcia mailing list. What's missing in my current
patches [proof-of-concepts do exist and had been announced both on lkml
and on said linux-pcmcia list, though] is the exporting of product and
manufactor ID and "vers_1" strings, because that needs better resource
handling.
- the resource_ready handling is "racy", at least. Resources can disappear
again.
- what I don't like in your patches is that they add an aditional "layer"
and thus additional complexity on top of PCMCIA. It already has a multitude of
structs with different lifetime rules. Your additions don't make it easier
to simplify this complexity. That's why my patchsets [*] try to reduce the
complexity first, add struct pcmcia_device next, and reduce complexity by
merging other stuff into struct pcmcia_device in the third step. I'd need
to re-check whether the step (1) you're leaving out does _not_ cause
lifetime headaches and races in strange circumstances [and I don't mean
PCMCIA net drivers here, as they're in a comparably good shape.]
Dominik
[*] these patchsets have been announced in these messages:
1) http://lists.infradead.org/pipermail/linux-pcmcia/2004-May/000877.html
2) http://lists.infradead.org/pipermail/linux-pcmcia/2004-May/000878.html
3) http://lists.infradead.org/pipermail/linux-pcmcia/2004-May/000880.html
4) http://lists.infradead.org/pipermail/linux-pcmcia/2004-May/000881.html
5) http://lists.infradead.org/pipermail/linux-pcmcia/2004-May/000882.html