2 * Janz CMOD-IO MODULbus Carrier Board PCI Driver
4 * Copyright (c) 2010 Ira W. Snyder <iws@ovro.caltech.edu>
6 * Lots of inspiration and code was copied from drivers/mfd/sm501.c
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/pci.h>
18 #include <linux/interrupt.h>
19 #include <linux/delay.h>
20 #include <linux/platform_device.h>
21 #include <linux/slab.h>
22 #include <linux/mfd/core.h>
24 #include <linux/mfd/janz.h>
26 #define DRV_NAME "janz-cmodio"
28 /* Size of each MODULbus module in PCI BAR4 */
29 #define CMODIO_MODULBUS_SIZE 0x200
31 /* Maximum number of MODULbus modules on a CMOD-IO carrier board */
32 #define CMODIO_MAX_MODULES 4
34 /* Module Parameters */
35 static unsigned int num_modules
= CMODIO_MAX_MODULES
;
36 static char *modules
[CMODIO_MAX_MODULES
] = {
37 "empty", "empty", "empty", "empty",
40 module_param_array(modules
, charp
, &num_modules
, S_IRUGO
);
41 MODULE_PARM_DESC(modules
, "MODULbus modules attached to the carrier board");
43 /* Unique Device Id */
44 static unsigned int cmodio_id
;
46 struct cmodio_device
{
47 /* Parent PCI device */
50 /* PLX control registers */
51 struct janz_cmodio_onboard_regs __iomem
*ctrl
;
53 /* hex switch position */
57 struct mfd_cell cells
[CMODIO_MAX_MODULES
];
58 struct resource resources
[3 * CMODIO_MAX_MODULES
];
59 struct janz_platform_data pdata
[CMODIO_MAX_MODULES
];
63 * Subdevices using the mfd-core API
66 static int cmodio_setup_subdevice(struct cmodio_device
*priv
,
67 char *name
, unsigned int devno
,
70 struct janz_platform_data
*pdata
;
71 struct mfd_cell
*cell
;
76 cell
= &priv
->cells
[devno
];
77 res
= &priv
->resources
[devno
* 3];
78 pdata
= &priv
->pdata
[devno
];
81 cell
->resources
= res
;
82 cell
->num_resources
= 3;
84 /* Setup the subdevice ID -- must be unique */
85 cell
->id
= cmodio_id
++;
87 /* Add platform data */
89 cell
->platform_data
= pdata
;
90 cell
->pdata_size
= sizeof(*pdata
);
92 /* MODULbus registers -- PCI BAR3 is big-endian MODULbus access */
93 res
->flags
= IORESOURCE_MEM
;
94 res
->parent
= &pci
->resource
[3];
95 res
->start
= pci
->resource
[3].start
+ (CMODIO_MODULBUS_SIZE
* modno
);
96 res
->end
= res
->start
+ CMODIO_MODULBUS_SIZE
- 1;
99 /* PLX Control Registers -- PCI BAR4 is interrupt and other registers */
100 res
->flags
= IORESOURCE_MEM
;
101 res
->parent
= &pci
->resource
[4];
102 res
->start
= pci
->resource
[4].start
;
103 res
->end
= pci
->resource
[4].end
;
109 * The start and end fields are used as an offset to the irq_base
110 * parameter passed into the mfd_add_devices() function call. All
111 * devices share the same IRQ.
113 res
->flags
= IORESOURCE_IRQ
;
122 /* Probe each submodule using kernel parameters */
123 static int cmodio_probe_submodules(struct cmodio_device
*priv
)
125 struct pci_dev
*pdev
= priv
->pdev
;
126 unsigned int num_probed
= 0;
130 for (i
= 0; i
< num_modules
; i
++) {
132 if (!strcmp(name
, "") || !strcmp(name
, "empty"))
135 dev_dbg(&priv
->pdev
->dev
, "MODULbus %d: name %s\n", i
, name
);
136 cmodio_setup_subdevice(priv
, name
, num_probed
, i
);
140 /* print an error message if no modules were probed */
141 if (num_probed
== 0) {
142 dev_err(&priv
->pdev
->dev
, "no MODULbus modules specified, "
143 "please set the ``modules'' kernel "
144 "parameter according to your "
145 "hardware configuration\n");
149 return mfd_add_devices(&pdev
->dev
, 0, priv
->cells
,
150 num_probed
, NULL
, pdev
->irq
, NULL
);
157 static ssize_t
mbus_show(struct device
*dev
, struct device_attribute
*attr
,
160 struct cmodio_device
*priv
= dev_get_drvdata(dev
);
162 return snprintf(buf
, PAGE_SIZE
, "%x\n", priv
->hex
);
165 static DEVICE_ATTR(modulbus_number
, S_IRUGO
, mbus_show
, NULL
);
167 static struct attribute
*cmodio_sysfs_attrs
[] = {
168 &dev_attr_modulbus_number
.attr
,
172 static const struct attribute_group cmodio_sysfs_attr_group
= {
173 .attrs
= cmodio_sysfs_attrs
,
180 static int cmodio_pci_probe(struct pci_dev
*dev
,
181 const struct pci_device_id
*id
)
183 struct cmodio_device
*priv
;
186 priv
= kzalloc(sizeof(*priv
), GFP_KERNEL
);
188 dev_err(&dev
->dev
, "unable to allocate private data\n");
193 pci_set_drvdata(dev
, priv
);
196 /* Hardware Initialization */
197 ret
= pci_enable_device(dev
);
199 dev_err(&dev
->dev
, "unable to enable device\n");
204 ret
= pci_request_regions(dev
, DRV_NAME
);
206 dev_err(&dev
->dev
, "unable to request regions\n");
207 goto out_pci_disable_device
;
210 /* Onboard configuration registers */
211 priv
->ctrl
= pci_ioremap_bar(dev
, 4);
213 dev_err(&dev
->dev
, "unable to remap onboard regs\n");
215 goto out_pci_release_regions
;
218 /* Read the hex switch on the carrier board */
219 priv
->hex
= ioread8(&priv
->ctrl
->int_enable
);
221 /* Add the MODULbus number (hex switch value) to the device's sysfs */
222 ret
= sysfs_create_group(&dev
->dev
.kobj
, &cmodio_sysfs_attr_group
);
224 dev_err(&dev
->dev
, "unable to create sysfs attributes\n");
229 * Disable all interrupt lines, each submodule will enable its
230 * own interrupt line if needed
232 iowrite8(0xf, &priv
->ctrl
->int_disable
);
234 /* Register drivers for all submodules */
235 ret
= cmodio_probe_submodules(priv
);
237 dev_err(&dev
->dev
, "unable to probe submodules\n");
238 goto out_sysfs_remove_group
;
243 out_sysfs_remove_group
:
244 sysfs_remove_group(&dev
->dev
.kobj
, &cmodio_sysfs_attr_group
);
247 out_pci_release_regions
:
248 pci_release_regions(dev
);
249 out_pci_disable_device
:
250 pci_disable_device(dev
);
257 static void cmodio_pci_remove(struct pci_dev
*dev
)
259 struct cmodio_device
*priv
= pci_get_drvdata(dev
);
261 mfd_remove_devices(&dev
->dev
);
262 sysfs_remove_group(&dev
->dev
.kobj
, &cmodio_sysfs_attr_group
);
264 pci_release_regions(dev
);
265 pci_disable_device(dev
);
269 #define PCI_VENDOR_ID_JANZ 0x13c3
271 /* The list of devices that this module will support */
272 static DEFINE_PCI_DEVICE_TABLE(cmodio_pci_ids
) = {
273 { PCI_VENDOR_ID_PLX
, PCI_DEVICE_ID_PLX_9030
, PCI_VENDOR_ID_JANZ
, 0x0101 },
274 { PCI_VENDOR_ID_PLX
, PCI_DEVICE_ID_PLX_9050
, PCI_VENDOR_ID_JANZ
, 0x0100 },
277 MODULE_DEVICE_TABLE(pci
, cmodio_pci_ids
);
279 static struct pci_driver cmodio_pci_driver
= {
281 .id_table
= cmodio_pci_ids
,
282 .probe
= cmodio_pci_probe
,
283 .remove
= cmodio_pci_remove
,
286 module_pci_driver(cmodio_pci_driver
);
288 MODULE_AUTHOR("Ira W. Snyder <iws@ovro.caltech.edu>");
289 MODULE_DESCRIPTION("Janz CMOD-IO PCI MODULbus Carrier Board Driver");
290 MODULE_LICENSE("GPL");