1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * SCR24x PCMCIA Smart Card Reader Driver
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2005-2006 TL Sudheendran
6*4882a593Smuzhiyun * Copyright (C) 2016 Lubomir Rintel
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * Derived from "scr24x_v4.2.6_Release.tar.gz" driver by TL Sudheendran.
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/device.h>
12*4882a593Smuzhiyun #include <linux/module.h>
13*4882a593Smuzhiyun #include <linux/delay.h>
14*4882a593Smuzhiyun #include <linux/cdev.h>
15*4882a593Smuzhiyun #include <linux/slab.h>
16*4882a593Smuzhiyun #include <linux/fs.h>
17*4882a593Smuzhiyun #include <linux/io.h>
18*4882a593Smuzhiyun #include <linux/uaccess.h>
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun #include <pcmcia/cistpl.h>
21*4882a593Smuzhiyun #include <pcmcia/ds.h>
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #define CCID_HEADER_SIZE 10
24*4882a593Smuzhiyun #define CCID_LENGTH_OFFSET 1
25*4882a593Smuzhiyun #define CCID_MAX_LEN 271
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun #define SCR24X_DATA(n) (1 + n)
28*4882a593Smuzhiyun #define SCR24X_CMD_STATUS 7
29*4882a593Smuzhiyun #define CMD_START 0x40
30*4882a593Smuzhiyun #define CMD_WRITE_BYTE 0x41
31*4882a593Smuzhiyun #define CMD_READ_BYTE 0x42
32*4882a593Smuzhiyun #define STATUS_BUSY 0x80
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun struct scr24x_dev {
35*4882a593Smuzhiyun struct device *dev;
36*4882a593Smuzhiyun struct cdev c_dev;
37*4882a593Smuzhiyun unsigned char buf[CCID_MAX_LEN];
38*4882a593Smuzhiyun int devno;
39*4882a593Smuzhiyun struct mutex lock;
40*4882a593Smuzhiyun struct kref refcnt;
41*4882a593Smuzhiyun u8 __iomem *regs;
42*4882a593Smuzhiyun };
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun #define SCR24X_DEVS 8
45*4882a593Smuzhiyun static DECLARE_BITMAP(scr24x_minors, SCR24X_DEVS);
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun static struct class *scr24x_class;
48*4882a593Smuzhiyun static dev_t scr24x_devt;
49*4882a593Smuzhiyun
scr24x_delete(struct kref * kref)50*4882a593Smuzhiyun static void scr24x_delete(struct kref *kref)
51*4882a593Smuzhiyun {
52*4882a593Smuzhiyun struct scr24x_dev *dev = container_of(kref, struct scr24x_dev,
53*4882a593Smuzhiyun refcnt);
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun kfree(dev);
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun
scr24x_wait_ready(struct scr24x_dev * dev)58*4882a593Smuzhiyun static int scr24x_wait_ready(struct scr24x_dev *dev)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun u_char status;
61*4882a593Smuzhiyun int timeout = 100;
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun do {
64*4882a593Smuzhiyun status = ioread8(dev->regs + SCR24X_CMD_STATUS);
65*4882a593Smuzhiyun if (!(status & STATUS_BUSY))
66*4882a593Smuzhiyun return 0;
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun msleep(20);
69*4882a593Smuzhiyun } while (--timeout);
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun return -EIO;
72*4882a593Smuzhiyun }
73*4882a593Smuzhiyun
scr24x_open(struct inode * inode,struct file * filp)74*4882a593Smuzhiyun static int scr24x_open(struct inode *inode, struct file *filp)
75*4882a593Smuzhiyun {
76*4882a593Smuzhiyun struct scr24x_dev *dev = container_of(inode->i_cdev,
77*4882a593Smuzhiyun struct scr24x_dev, c_dev);
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun kref_get(&dev->refcnt);
80*4882a593Smuzhiyun filp->private_data = dev;
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun return stream_open(inode, filp);
83*4882a593Smuzhiyun }
84*4882a593Smuzhiyun
scr24x_release(struct inode * inode,struct file * filp)85*4882a593Smuzhiyun static int scr24x_release(struct inode *inode, struct file *filp)
86*4882a593Smuzhiyun {
87*4882a593Smuzhiyun struct scr24x_dev *dev = filp->private_data;
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun /* We must not take the dev->lock here as scr24x_delete()
90*4882a593Smuzhiyun * might be called to remove the dev structure altogether.
91*4882a593Smuzhiyun * We don't need the lock anyway, since after the reference
92*4882a593Smuzhiyun * acquired in probe() is released in remove() the chrdev
93*4882a593Smuzhiyun * is already unregistered and noone can possibly acquire
94*4882a593Smuzhiyun * a reference via open() anymore. */
95*4882a593Smuzhiyun kref_put(&dev->refcnt, scr24x_delete);
96*4882a593Smuzhiyun return 0;
97*4882a593Smuzhiyun }
98*4882a593Smuzhiyun
read_chunk(struct scr24x_dev * dev,size_t offset,size_t limit)99*4882a593Smuzhiyun static int read_chunk(struct scr24x_dev *dev, size_t offset, size_t limit)
100*4882a593Smuzhiyun {
101*4882a593Smuzhiyun size_t i, y;
102*4882a593Smuzhiyun int ret;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun for (i = offset; i < limit; i += 5) {
105*4882a593Smuzhiyun iowrite8(CMD_READ_BYTE, dev->regs + SCR24X_CMD_STATUS);
106*4882a593Smuzhiyun ret = scr24x_wait_ready(dev);
107*4882a593Smuzhiyun if (ret < 0)
108*4882a593Smuzhiyun return ret;
109*4882a593Smuzhiyun
110*4882a593Smuzhiyun for (y = 0; y < 5 && i + y < limit; y++)
111*4882a593Smuzhiyun dev->buf[i + y] = ioread8(dev->regs + SCR24X_DATA(y));
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun return 0;
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun
scr24x_read(struct file * filp,char __user * buf,size_t count,loff_t * ppos)117*4882a593Smuzhiyun static ssize_t scr24x_read(struct file *filp, char __user *buf, size_t count,
118*4882a593Smuzhiyun loff_t *ppos)
119*4882a593Smuzhiyun {
120*4882a593Smuzhiyun struct scr24x_dev *dev = filp->private_data;
121*4882a593Smuzhiyun int ret;
122*4882a593Smuzhiyun int len;
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun if (count < CCID_HEADER_SIZE)
125*4882a593Smuzhiyun return -EINVAL;
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun if (mutex_lock_interruptible(&dev->lock))
128*4882a593Smuzhiyun return -ERESTARTSYS;
129*4882a593Smuzhiyun
130*4882a593Smuzhiyun if (!dev->dev) {
131*4882a593Smuzhiyun ret = -ENODEV;
132*4882a593Smuzhiyun goto out;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun ret = scr24x_wait_ready(dev);
136*4882a593Smuzhiyun if (ret < 0)
137*4882a593Smuzhiyun goto out;
138*4882a593Smuzhiyun len = CCID_HEADER_SIZE;
139*4882a593Smuzhiyun ret = read_chunk(dev, 0, len);
140*4882a593Smuzhiyun if (ret < 0)
141*4882a593Smuzhiyun goto out;
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun len += le32_to_cpu(*(__le32 *)(&dev->buf[CCID_LENGTH_OFFSET]));
144*4882a593Smuzhiyun if (len > sizeof(dev->buf)) {
145*4882a593Smuzhiyun ret = -EIO;
146*4882a593Smuzhiyun goto out;
147*4882a593Smuzhiyun }
148*4882a593Smuzhiyun ret = read_chunk(dev, CCID_HEADER_SIZE, len);
149*4882a593Smuzhiyun if (ret < 0)
150*4882a593Smuzhiyun goto out;
151*4882a593Smuzhiyun
152*4882a593Smuzhiyun if (len < count)
153*4882a593Smuzhiyun count = len;
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun if (copy_to_user(buf, dev->buf, count)) {
156*4882a593Smuzhiyun ret = -EFAULT;
157*4882a593Smuzhiyun goto out;
158*4882a593Smuzhiyun }
159*4882a593Smuzhiyun
160*4882a593Smuzhiyun ret = count;
161*4882a593Smuzhiyun out:
162*4882a593Smuzhiyun mutex_unlock(&dev->lock);
163*4882a593Smuzhiyun return ret;
164*4882a593Smuzhiyun }
165*4882a593Smuzhiyun
scr24x_write(struct file * filp,const char __user * buf,size_t count,loff_t * ppos)166*4882a593Smuzhiyun static ssize_t scr24x_write(struct file *filp, const char __user *buf,
167*4882a593Smuzhiyun size_t count, loff_t *ppos)
168*4882a593Smuzhiyun {
169*4882a593Smuzhiyun struct scr24x_dev *dev = filp->private_data;
170*4882a593Smuzhiyun size_t i, y;
171*4882a593Smuzhiyun int ret;
172*4882a593Smuzhiyun
173*4882a593Smuzhiyun if (mutex_lock_interruptible(&dev->lock))
174*4882a593Smuzhiyun return -ERESTARTSYS;
175*4882a593Smuzhiyun
176*4882a593Smuzhiyun if (!dev->dev) {
177*4882a593Smuzhiyun ret = -ENODEV;
178*4882a593Smuzhiyun goto out;
179*4882a593Smuzhiyun }
180*4882a593Smuzhiyun
181*4882a593Smuzhiyun if (count > sizeof(dev->buf)) {
182*4882a593Smuzhiyun ret = -EINVAL;
183*4882a593Smuzhiyun goto out;
184*4882a593Smuzhiyun }
185*4882a593Smuzhiyun
186*4882a593Smuzhiyun if (copy_from_user(dev->buf, buf, count)) {
187*4882a593Smuzhiyun ret = -EFAULT;
188*4882a593Smuzhiyun goto out;
189*4882a593Smuzhiyun }
190*4882a593Smuzhiyun
191*4882a593Smuzhiyun ret = scr24x_wait_ready(dev);
192*4882a593Smuzhiyun if (ret < 0)
193*4882a593Smuzhiyun goto out;
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun iowrite8(CMD_START, dev->regs + SCR24X_CMD_STATUS);
196*4882a593Smuzhiyun ret = scr24x_wait_ready(dev);
197*4882a593Smuzhiyun if (ret < 0)
198*4882a593Smuzhiyun goto out;
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun for (i = 0; i < count; i += 5) {
201*4882a593Smuzhiyun for (y = 0; y < 5 && i + y < count; y++)
202*4882a593Smuzhiyun iowrite8(dev->buf[i + y], dev->regs + SCR24X_DATA(y));
203*4882a593Smuzhiyun
204*4882a593Smuzhiyun iowrite8(CMD_WRITE_BYTE, dev->regs + SCR24X_CMD_STATUS);
205*4882a593Smuzhiyun ret = scr24x_wait_ready(dev);
206*4882a593Smuzhiyun if (ret < 0)
207*4882a593Smuzhiyun goto out;
208*4882a593Smuzhiyun }
209*4882a593Smuzhiyun
210*4882a593Smuzhiyun ret = count;
211*4882a593Smuzhiyun out:
212*4882a593Smuzhiyun mutex_unlock(&dev->lock);
213*4882a593Smuzhiyun return ret;
214*4882a593Smuzhiyun }
215*4882a593Smuzhiyun
216*4882a593Smuzhiyun static const struct file_operations scr24x_fops = {
217*4882a593Smuzhiyun .owner = THIS_MODULE,
218*4882a593Smuzhiyun .read = scr24x_read,
219*4882a593Smuzhiyun .write = scr24x_write,
220*4882a593Smuzhiyun .open = scr24x_open,
221*4882a593Smuzhiyun .release = scr24x_release,
222*4882a593Smuzhiyun .llseek = no_llseek,
223*4882a593Smuzhiyun };
224*4882a593Smuzhiyun
scr24x_config_check(struct pcmcia_device * link,void * priv_data)225*4882a593Smuzhiyun static int scr24x_config_check(struct pcmcia_device *link, void *priv_data)
226*4882a593Smuzhiyun {
227*4882a593Smuzhiyun if (resource_size(link->resource[PCMCIA_IOPORT_0]) != 0x11)
228*4882a593Smuzhiyun return -ENODEV;
229*4882a593Smuzhiyun return pcmcia_request_io(link);
230*4882a593Smuzhiyun }
231*4882a593Smuzhiyun
scr24x_probe(struct pcmcia_device * link)232*4882a593Smuzhiyun static int scr24x_probe(struct pcmcia_device *link)
233*4882a593Smuzhiyun {
234*4882a593Smuzhiyun struct scr24x_dev *dev;
235*4882a593Smuzhiyun int ret;
236*4882a593Smuzhiyun
237*4882a593Smuzhiyun dev = kzalloc(sizeof(*dev), GFP_KERNEL);
238*4882a593Smuzhiyun if (!dev)
239*4882a593Smuzhiyun return -ENOMEM;
240*4882a593Smuzhiyun
241*4882a593Smuzhiyun dev->devno = find_first_zero_bit(scr24x_minors, SCR24X_DEVS);
242*4882a593Smuzhiyun if (dev->devno >= SCR24X_DEVS) {
243*4882a593Smuzhiyun ret = -EBUSY;
244*4882a593Smuzhiyun goto err;
245*4882a593Smuzhiyun }
246*4882a593Smuzhiyun
247*4882a593Smuzhiyun mutex_init(&dev->lock);
248*4882a593Smuzhiyun kref_init(&dev->refcnt);
249*4882a593Smuzhiyun
250*4882a593Smuzhiyun link->priv = dev;
251*4882a593Smuzhiyun link->config_flags |= CONF_ENABLE_IRQ | CONF_AUTO_SET_IO;
252*4882a593Smuzhiyun
253*4882a593Smuzhiyun ret = pcmcia_loop_config(link, scr24x_config_check, NULL);
254*4882a593Smuzhiyun if (ret < 0)
255*4882a593Smuzhiyun goto err;
256*4882a593Smuzhiyun
257*4882a593Smuzhiyun dev->dev = &link->dev;
258*4882a593Smuzhiyun dev->regs = devm_ioport_map(&link->dev,
259*4882a593Smuzhiyun link->resource[PCMCIA_IOPORT_0]->start,
260*4882a593Smuzhiyun resource_size(link->resource[PCMCIA_IOPORT_0]));
261*4882a593Smuzhiyun if (!dev->regs) {
262*4882a593Smuzhiyun ret = -EIO;
263*4882a593Smuzhiyun goto err;
264*4882a593Smuzhiyun }
265*4882a593Smuzhiyun
266*4882a593Smuzhiyun cdev_init(&dev->c_dev, &scr24x_fops);
267*4882a593Smuzhiyun dev->c_dev.owner = THIS_MODULE;
268*4882a593Smuzhiyun dev->c_dev.ops = &scr24x_fops;
269*4882a593Smuzhiyun ret = cdev_add(&dev->c_dev, MKDEV(MAJOR(scr24x_devt), dev->devno), 1);
270*4882a593Smuzhiyun if (ret < 0)
271*4882a593Smuzhiyun goto err;
272*4882a593Smuzhiyun
273*4882a593Smuzhiyun ret = pcmcia_enable_device(link);
274*4882a593Smuzhiyun if (ret < 0) {
275*4882a593Smuzhiyun pcmcia_disable_device(link);
276*4882a593Smuzhiyun goto err;
277*4882a593Smuzhiyun }
278*4882a593Smuzhiyun
279*4882a593Smuzhiyun device_create(scr24x_class, NULL, MKDEV(MAJOR(scr24x_devt), dev->devno),
280*4882a593Smuzhiyun NULL, "scr24x%d", dev->devno);
281*4882a593Smuzhiyun
282*4882a593Smuzhiyun dev_info(&link->dev, "SCR24x Chip Card Interface\n");
283*4882a593Smuzhiyun return 0;
284*4882a593Smuzhiyun
285*4882a593Smuzhiyun err:
286*4882a593Smuzhiyun if (dev->devno < SCR24X_DEVS)
287*4882a593Smuzhiyun clear_bit(dev->devno, scr24x_minors);
288*4882a593Smuzhiyun kfree (dev);
289*4882a593Smuzhiyun return ret;
290*4882a593Smuzhiyun }
291*4882a593Smuzhiyun
scr24x_remove(struct pcmcia_device * link)292*4882a593Smuzhiyun static void scr24x_remove(struct pcmcia_device *link)
293*4882a593Smuzhiyun {
294*4882a593Smuzhiyun struct scr24x_dev *dev = (struct scr24x_dev *)link->priv;
295*4882a593Smuzhiyun
296*4882a593Smuzhiyun device_destroy(scr24x_class, MKDEV(MAJOR(scr24x_devt), dev->devno));
297*4882a593Smuzhiyun mutex_lock(&dev->lock);
298*4882a593Smuzhiyun pcmcia_disable_device(link);
299*4882a593Smuzhiyun cdev_del(&dev->c_dev);
300*4882a593Smuzhiyun clear_bit(dev->devno, scr24x_minors);
301*4882a593Smuzhiyun dev->dev = NULL;
302*4882a593Smuzhiyun mutex_unlock(&dev->lock);
303*4882a593Smuzhiyun
304*4882a593Smuzhiyun kref_put(&dev->refcnt, scr24x_delete);
305*4882a593Smuzhiyun }
306*4882a593Smuzhiyun
307*4882a593Smuzhiyun static const struct pcmcia_device_id scr24x_ids[] = {
308*4882a593Smuzhiyun PCMCIA_DEVICE_PROD_ID12("HP", "PC Card Smart Card Reader",
309*4882a593Smuzhiyun 0x53cb94f9, 0xbfdf89a5),
310*4882a593Smuzhiyun PCMCIA_DEVICE_PROD_ID1("SCR241 PCMCIA", 0x6271efa3),
311*4882a593Smuzhiyun PCMCIA_DEVICE_PROD_ID1("SCR243 PCMCIA", 0x2054e8de),
312*4882a593Smuzhiyun PCMCIA_DEVICE_PROD_ID1("SCR24x PCMCIA", 0x54a33665),
313*4882a593Smuzhiyun PCMCIA_DEVICE_NULL
314*4882a593Smuzhiyun };
315*4882a593Smuzhiyun MODULE_DEVICE_TABLE(pcmcia, scr24x_ids);
316*4882a593Smuzhiyun
317*4882a593Smuzhiyun static struct pcmcia_driver scr24x_driver = {
318*4882a593Smuzhiyun .owner = THIS_MODULE,
319*4882a593Smuzhiyun .name = "scr24x_cs",
320*4882a593Smuzhiyun .probe = scr24x_probe,
321*4882a593Smuzhiyun .remove = scr24x_remove,
322*4882a593Smuzhiyun .id_table = scr24x_ids,
323*4882a593Smuzhiyun };
324*4882a593Smuzhiyun
scr24x_init(void)325*4882a593Smuzhiyun static int __init scr24x_init(void)
326*4882a593Smuzhiyun {
327*4882a593Smuzhiyun int ret;
328*4882a593Smuzhiyun
329*4882a593Smuzhiyun scr24x_class = class_create(THIS_MODULE, "scr24x");
330*4882a593Smuzhiyun if (IS_ERR(scr24x_class))
331*4882a593Smuzhiyun return PTR_ERR(scr24x_class);
332*4882a593Smuzhiyun
333*4882a593Smuzhiyun ret = alloc_chrdev_region(&scr24x_devt, 0, SCR24X_DEVS, "scr24x");
334*4882a593Smuzhiyun if (ret < 0) {
335*4882a593Smuzhiyun class_destroy(scr24x_class);
336*4882a593Smuzhiyun return ret;
337*4882a593Smuzhiyun }
338*4882a593Smuzhiyun
339*4882a593Smuzhiyun ret = pcmcia_register_driver(&scr24x_driver);
340*4882a593Smuzhiyun if (ret < 0) {
341*4882a593Smuzhiyun unregister_chrdev_region(scr24x_devt, SCR24X_DEVS);
342*4882a593Smuzhiyun class_destroy(scr24x_class);
343*4882a593Smuzhiyun }
344*4882a593Smuzhiyun
345*4882a593Smuzhiyun return ret;
346*4882a593Smuzhiyun }
347*4882a593Smuzhiyun
scr24x_exit(void)348*4882a593Smuzhiyun static void __exit scr24x_exit(void)
349*4882a593Smuzhiyun {
350*4882a593Smuzhiyun pcmcia_unregister_driver(&scr24x_driver);
351*4882a593Smuzhiyun unregister_chrdev_region(scr24x_devt, SCR24X_DEVS);
352*4882a593Smuzhiyun class_destroy(scr24x_class);
353*4882a593Smuzhiyun }
354*4882a593Smuzhiyun
355*4882a593Smuzhiyun module_init(scr24x_init);
356*4882a593Smuzhiyun module_exit(scr24x_exit);
357*4882a593Smuzhiyun
358*4882a593Smuzhiyun MODULE_AUTHOR("Lubomir Rintel");
359*4882a593Smuzhiyun MODULE_DESCRIPTION("SCR24x PCMCIA Smart Card Reader Driver");
360*4882a593Smuzhiyun MODULE_LICENSE("GPL");
361