1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Support code for the SCOOP interface found on various Sharp PDAs
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (c) 2004 Richard Purdie
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Based on code written by Sharp/Lineo for 2.4 kernels
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <linux/device.h>
11*4882a593Smuzhiyun #include <linux/gpio/driver.h>
12*4882a593Smuzhiyun #include <linux/string.h>
13*4882a593Smuzhiyun #include <linux/slab.h>
14*4882a593Smuzhiyun #include <linux/platform_device.h>
15*4882a593Smuzhiyun #include <linux/export.h>
16*4882a593Smuzhiyun #include <linux/io.h>
17*4882a593Smuzhiyun #include <asm/hardware/scoop.h>
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun /* PCMCIA to Scoop linkage
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun There is no easy way to link multiple scoop devices into one
22*4882a593Smuzhiyun single entity for the pxa2xx_pcmcia device so this structure
23*4882a593Smuzhiyun is used which is setup by the platform code.
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun This file is never modular so this symbol is always
26*4882a593Smuzhiyun accessile to the board support files.
27*4882a593Smuzhiyun */
28*4882a593Smuzhiyun struct scoop_pcmcia_config *platform_scoop_config;
29*4882a593Smuzhiyun EXPORT_SYMBOL(platform_scoop_config);
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun struct scoop_dev {
32*4882a593Smuzhiyun void __iomem *base;
33*4882a593Smuzhiyun struct gpio_chip gpio;
34*4882a593Smuzhiyun spinlock_t scoop_lock;
35*4882a593Smuzhiyun unsigned short suspend_clr;
36*4882a593Smuzhiyun unsigned short suspend_set;
37*4882a593Smuzhiyun u32 scoop_gpwr;
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun
reset_scoop(struct device * dev)40*4882a593Smuzhiyun void reset_scoop(struct device *dev)
41*4882a593Smuzhiyun {
42*4882a593Smuzhiyun struct scoop_dev *sdev = dev_get_drvdata(dev);
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun iowrite16(0x0100, sdev->base + SCOOP_MCR); /* 00 */
45*4882a593Smuzhiyun iowrite16(0x0000, sdev->base + SCOOP_CDR); /* 04 */
46*4882a593Smuzhiyun iowrite16(0x0000, sdev->base + SCOOP_CCR); /* 10 */
47*4882a593Smuzhiyun iowrite16(0x0000, sdev->base + SCOOP_IMR); /* 18 */
48*4882a593Smuzhiyun iowrite16(0x00FF, sdev->base + SCOOP_IRM); /* 14 */
49*4882a593Smuzhiyun iowrite16(0x0000, sdev->base + SCOOP_ISR); /* 1C */
50*4882a593Smuzhiyun iowrite16(0x0000, sdev->base + SCOOP_IRM);
51*4882a593Smuzhiyun }
52*4882a593Smuzhiyun
__scoop_gpio_set(struct scoop_dev * sdev,unsigned offset,int value)53*4882a593Smuzhiyun static void __scoop_gpio_set(struct scoop_dev *sdev,
54*4882a593Smuzhiyun unsigned offset, int value)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun unsigned short gpwr;
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun gpwr = ioread16(sdev->base + SCOOP_GPWR);
59*4882a593Smuzhiyun if (value)
60*4882a593Smuzhiyun gpwr |= 1 << (offset + 1);
61*4882a593Smuzhiyun else
62*4882a593Smuzhiyun gpwr &= ~(1 << (offset + 1));
63*4882a593Smuzhiyun iowrite16(gpwr, sdev->base + SCOOP_GPWR);
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun
scoop_gpio_set(struct gpio_chip * chip,unsigned offset,int value)66*4882a593Smuzhiyun static void scoop_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun struct scoop_dev *sdev = gpiochip_get_data(chip);
69*4882a593Smuzhiyun unsigned long flags;
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun spin_lock_irqsave(&sdev->scoop_lock, flags);
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun __scoop_gpio_set(sdev, offset, value);
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun spin_unlock_irqrestore(&sdev->scoop_lock, flags);
76*4882a593Smuzhiyun }
77*4882a593Smuzhiyun
scoop_gpio_get(struct gpio_chip * chip,unsigned offset)78*4882a593Smuzhiyun static int scoop_gpio_get(struct gpio_chip *chip, unsigned offset)
79*4882a593Smuzhiyun {
80*4882a593Smuzhiyun struct scoop_dev *sdev = gpiochip_get_data(chip);
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun /* XXX: I'm unsure, but it seems so */
83*4882a593Smuzhiyun return !!(ioread16(sdev->base + SCOOP_GPRR) & (1 << (offset + 1)));
84*4882a593Smuzhiyun }
85*4882a593Smuzhiyun
scoop_gpio_direction_input(struct gpio_chip * chip,unsigned offset)86*4882a593Smuzhiyun static int scoop_gpio_direction_input(struct gpio_chip *chip,
87*4882a593Smuzhiyun unsigned offset)
88*4882a593Smuzhiyun {
89*4882a593Smuzhiyun struct scoop_dev *sdev = gpiochip_get_data(chip);
90*4882a593Smuzhiyun unsigned long flags;
91*4882a593Smuzhiyun unsigned short gpcr;
92*4882a593Smuzhiyun
93*4882a593Smuzhiyun spin_lock_irqsave(&sdev->scoop_lock, flags);
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun gpcr = ioread16(sdev->base + SCOOP_GPCR);
96*4882a593Smuzhiyun gpcr &= ~(1 << (offset + 1));
97*4882a593Smuzhiyun iowrite16(gpcr, sdev->base + SCOOP_GPCR);
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun spin_unlock_irqrestore(&sdev->scoop_lock, flags);
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun return 0;
102*4882a593Smuzhiyun }
103*4882a593Smuzhiyun
scoop_gpio_direction_output(struct gpio_chip * chip,unsigned offset,int value)104*4882a593Smuzhiyun static int scoop_gpio_direction_output(struct gpio_chip *chip,
105*4882a593Smuzhiyun unsigned offset, int value)
106*4882a593Smuzhiyun {
107*4882a593Smuzhiyun struct scoop_dev *sdev = gpiochip_get_data(chip);
108*4882a593Smuzhiyun unsigned long flags;
109*4882a593Smuzhiyun unsigned short gpcr;
110*4882a593Smuzhiyun
111*4882a593Smuzhiyun spin_lock_irqsave(&sdev->scoop_lock, flags);
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun __scoop_gpio_set(sdev, offset, value);
114*4882a593Smuzhiyun
115*4882a593Smuzhiyun gpcr = ioread16(sdev->base + SCOOP_GPCR);
116*4882a593Smuzhiyun gpcr |= 1 << (offset + 1);
117*4882a593Smuzhiyun iowrite16(gpcr, sdev->base + SCOOP_GPCR);
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun spin_unlock_irqrestore(&sdev->scoop_lock, flags);
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun return 0;
122*4882a593Smuzhiyun }
123*4882a593Smuzhiyun
read_scoop_reg(struct device * dev,unsigned short reg)124*4882a593Smuzhiyun unsigned short read_scoop_reg(struct device *dev, unsigned short reg)
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun struct scoop_dev *sdev = dev_get_drvdata(dev);
127*4882a593Smuzhiyun return ioread16(sdev->base + reg);
128*4882a593Smuzhiyun }
129*4882a593Smuzhiyun
write_scoop_reg(struct device * dev,unsigned short reg,unsigned short data)130*4882a593Smuzhiyun void write_scoop_reg(struct device *dev, unsigned short reg, unsigned short data)
131*4882a593Smuzhiyun {
132*4882a593Smuzhiyun struct scoop_dev *sdev = dev_get_drvdata(dev);
133*4882a593Smuzhiyun iowrite16(data, sdev->base + reg);
134*4882a593Smuzhiyun }
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun EXPORT_SYMBOL(reset_scoop);
137*4882a593Smuzhiyun EXPORT_SYMBOL(read_scoop_reg);
138*4882a593Smuzhiyun EXPORT_SYMBOL(write_scoop_reg);
139*4882a593Smuzhiyun
140*4882a593Smuzhiyun #ifdef CONFIG_PM
check_scoop_reg(struct scoop_dev * sdev)141*4882a593Smuzhiyun static void check_scoop_reg(struct scoop_dev *sdev)
142*4882a593Smuzhiyun {
143*4882a593Smuzhiyun unsigned short mcr;
144*4882a593Smuzhiyun
145*4882a593Smuzhiyun mcr = ioread16(sdev->base + SCOOP_MCR);
146*4882a593Smuzhiyun if ((mcr & 0x100) == 0)
147*4882a593Smuzhiyun iowrite16(0x0101, sdev->base + SCOOP_MCR);
148*4882a593Smuzhiyun }
149*4882a593Smuzhiyun
scoop_suspend(struct platform_device * dev,pm_message_t state)150*4882a593Smuzhiyun static int scoop_suspend(struct platform_device *dev, pm_message_t state)
151*4882a593Smuzhiyun {
152*4882a593Smuzhiyun struct scoop_dev *sdev = platform_get_drvdata(dev);
153*4882a593Smuzhiyun
154*4882a593Smuzhiyun check_scoop_reg(sdev);
155*4882a593Smuzhiyun sdev->scoop_gpwr = ioread16(sdev->base + SCOOP_GPWR);
156*4882a593Smuzhiyun iowrite16((sdev->scoop_gpwr & ~sdev->suspend_clr) | sdev->suspend_set, sdev->base + SCOOP_GPWR);
157*4882a593Smuzhiyun
158*4882a593Smuzhiyun return 0;
159*4882a593Smuzhiyun }
160*4882a593Smuzhiyun
scoop_resume(struct platform_device * dev)161*4882a593Smuzhiyun static int scoop_resume(struct platform_device *dev)
162*4882a593Smuzhiyun {
163*4882a593Smuzhiyun struct scoop_dev *sdev = platform_get_drvdata(dev);
164*4882a593Smuzhiyun
165*4882a593Smuzhiyun check_scoop_reg(sdev);
166*4882a593Smuzhiyun iowrite16(sdev->scoop_gpwr, sdev->base + SCOOP_GPWR);
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun return 0;
169*4882a593Smuzhiyun }
170*4882a593Smuzhiyun #else
171*4882a593Smuzhiyun #define scoop_suspend NULL
172*4882a593Smuzhiyun #define scoop_resume NULL
173*4882a593Smuzhiyun #endif
174*4882a593Smuzhiyun
scoop_probe(struct platform_device * pdev)175*4882a593Smuzhiyun static int scoop_probe(struct platform_device *pdev)
176*4882a593Smuzhiyun {
177*4882a593Smuzhiyun struct scoop_dev *devptr;
178*4882a593Smuzhiyun struct scoop_config *inf;
179*4882a593Smuzhiyun struct resource *mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
180*4882a593Smuzhiyun int ret;
181*4882a593Smuzhiyun
182*4882a593Smuzhiyun if (!mem)
183*4882a593Smuzhiyun return -EINVAL;
184*4882a593Smuzhiyun
185*4882a593Smuzhiyun devptr = kzalloc(sizeof(struct scoop_dev), GFP_KERNEL);
186*4882a593Smuzhiyun if (!devptr)
187*4882a593Smuzhiyun return -ENOMEM;
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun spin_lock_init(&devptr->scoop_lock);
190*4882a593Smuzhiyun
191*4882a593Smuzhiyun inf = pdev->dev.platform_data;
192*4882a593Smuzhiyun devptr->base = ioremap(mem->start, resource_size(mem));
193*4882a593Smuzhiyun
194*4882a593Smuzhiyun if (!devptr->base) {
195*4882a593Smuzhiyun ret = -ENOMEM;
196*4882a593Smuzhiyun goto err_ioremap;
197*4882a593Smuzhiyun }
198*4882a593Smuzhiyun
199*4882a593Smuzhiyun platform_set_drvdata(pdev, devptr);
200*4882a593Smuzhiyun
201*4882a593Smuzhiyun printk("Sharp Scoop Device found at 0x%08x -> 0x%8p\n",(unsigned int)mem->start, devptr->base);
202*4882a593Smuzhiyun
203*4882a593Smuzhiyun iowrite16(0x0140, devptr->base + SCOOP_MCR);
204*4882a593Smuzhiyun reset_scoop(&pdev->dev);
205*4882a593Smuzhiyun iowrite16(0x0000, devptr->base + SCOOP_CPR);
206*4882a593Smuzhiyun iowrite16(inf->io_dir & 0xffff, devptr->base + SCOOP_GPCR);
207*4882a593Smuzhiyun iowrite16(inf->io_out & 0xffff, devptr->base + SCOOP_GPWR);
208*4882a593Smuzhiyun
209*4882a593Smuzhiyun devptr->suspend_clr = inf->suspend_clr;
210*4882a593Smuzhiyun devptr->suspend_set = inf->suspend_set;
211*4882a593Smuzhiyun
212*4882a593Smuzhiyun devptr->gpio.base = -1;
213*4882a593Smuzhiyun
214*4882a593Smuzhiyun if (inf->gpio_base != 0) {
215*4882a593Smuzhiyun devptr->gpio.label = dev_name(&pdev->dev);
216*4882a593Smuzhiyun devptr->gpio.base = inf->gpio_base;
217*4882a593Smuzhiyun devptr->gpio.ngpio = 12; /* PA11 = 0, PA12 = 1, etc. up to PA22 = 11 */
218*4882a593Smuzhiyun devptr->gpio.set = scoop_gpio_set;
219*4882a593Smuzhiyun devptr->gpio.get = scoop_gpio_get;
220*4882a593Smuzhiyun devptr->gpio.direction_input = scoop_gpio_direction_input;
221*4882a593Smuzhiyun devptr->gpio.direction_output = scoop_gpio_direction_output;
222*4882a593Smuzhiyun
223*4882a593Smuzhiyun ret = gpiochip_add_data(&devptr->gpio, devptr);
224*4882a593Smuzhiyun if (ret)
225*4882a593Smuzhiyun goto err_gpio;
226*4882a593Smuzhiyun }
227*4882a593Smuzhiyun
228*4882a593Smuzhiyun return 0;
229*4882a593Smuzhiyun
230*4882a593Smuzhiyun err_gpio:
231*4882a593Smuzhiyun platform_set_drvdata(pdev, NULL);
232*4882a593Smuzhiyun err_ioremap:
233*4882a593Smuzhiyun iounmap(devptr->base);
234*4882a593Smuzhiyun kfree(devptr);
235*4882a593Smuzhiyun
236*4882a593Smuzhiyun return ret;
237*4882a593Smuzhiyun }
238*4882a593Smuzhiyun
scoop_remove(struct platform_device * pdev)239*4882a593Smuzhiyun static int scoop_remove(struct platform_device *pdev)
240*4882a593Smuzhiyun {
241*4882a593Smuzhiyun struct scoop_dev *sdev = platform_get_drvdata(pdev);
242*4882a593Smuzhiyun
243*4882a593Smuzhiyun if (!sdev)
244*4882a593Smuzhiyun return -EINVAL;
245*4882a593Smuzhiyun
246*4882a593Smuzhiyun if (sdev->gpio.base != -1)
247*4882a593Smuzhiyun gpiochip_remove(&sdev->gpio);
248*4882a593Smuzhiyun
249*4882a593Smuzhiyun platform_set_drvdata(pdev, NULL);
250*4882a593Smuzhiyun iounmap(sdev->base);
251*4882a593Smuzhiyun kfree(sdev);
252*4882a593Smuzhiyun
253*4882a593Smuzhiyun return 0;
254*4882a593Smuzhiyun }
255*4882a593Smuzhiyun
256*4882a593Smuzhiyun static struct platform_driver scoop_driver = {
257*4882a593Smuzhiyun .probe = scoop_probe,
258*4882a593Smuzhiyun .remove = scoop_remove,
259*4882a593Smuzhiyun .suspend = scoop_suspend,
260*4882a593Smuzhiyun .resume = scoop_resume,
261*4882a593Smuzhiyun .driver = {
262*4882a593Smuzhiyun .name = "sharp-scoop",
263*4882a593Smuzhiyun },
264*4882a593Smuzhiyun };
265*4882a593Smuzhiyun
scoop_init(void)266*4882a593Smuzhiyun static int __init scoop_init(void)
267*4882a593Smuzhiyun {
268*4882a593Smuzhiyun return platform_driver_register(&scoop_driver);
269*4882a593Smuzhiyun }
270*4882a593Smuzhiyun
271*4882a593Smuzhiyun subsys_initcall(scoop_init);
272