2 * OLPC serio driver for multiplexed input from Marvell MMP security processor
4 * Copyright (C) 2011-2013 One Laptop Per Child
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include <linux/module.h>
18 #include <linux/interrupt.h>
19 #include <linux/serio.h>
20 #include <linux/err.h>
21 #include <linux/platform_device.h>
24 #include <linux/slab.h>
25 #include <linux/delay.h>
26 #include <linux/clk.h>
29 * The OLPC XO-1.75 and XO-4 laptops do not have a hardware PS/2 controller.
30 * Instead, the OLPC firmware runs a bit-banging PS/2 implementation on an
31 * otherwise-unused slow processor which is included in the Marvell MMP2/MMP3
32 * SoC, known as the "Security Processor" (SP) or "Wireless Trusted Module"
33 * (WTM). This firmware then reports its results via the WTM registers,
34 * which we read from the Application Processor (AP, i.e. main CPU) in this
37 * On the hardware side we have a PS/2 mouse and an AT keyboard, the data
38 * is multiplexed through this system. We create a serio port for each one,
39 * and demultiplex the data accordingly.
42 /* WTM register offsets */
43 #define SECURE_PROCESSOR_COMMAND 0x40
44 #define COMMAND_RETURN_STATUS 0x80
45 #define COMMAND_FIFO_STATUS 0xc4
46 #define PJ_RST_INTERRUPT 0xc8
47 #define PJ_INTERRUPT_MASK 0xcc
50 * The upper byte of SECURE_PROCESSOR_COMMAND and COMMAND_RETURN_STATUS is
51 * used to identify which port (device) is being talked to. The lower byte
52 * is the data being sent/received.
54 #define PORT_MASK 0xff00
55 #define DATA_MASK 0x00ff
57 #define KEYBOARD_PORT 0
58 #define TOUCHPAD_PORT 1
60 /* COMMAND_FIFO_STATUS */
61 #define CMD_CNTR_MASK 0x7 /* Number of pending/unprocessed commands */
62 #define MAX_PENDING_CMDS 4 /* from device specs */
64 /* PJ_RST_INTERRUPT */
65 #define SP_COMMAND_COMPLETE_RESET 0x1
67 /* PJ_INTERRUPT_MASK */
68 #define INT_0 (1 << 0)
70 /* COMMAND_FIFO_STATUS */
71 #define CMD_STS_MASK 0x100
83 static int olpc_apsp_write(struct serio *port, unsigned char val)
85 struct olpc_apsp *priv = port->port_data;
89 if (port == priv->padio)
90 which = TOUCHPAD_PORT << PORT_SHIFT;
92 which = KEYBOARD_PORT << PORT_SHIFT;
94 dev_dbg(priv->dev, "olpc_apsp_write which=%x val=%x\n", which, val);
95 for (i = 0; i < 50; i++) {
96 u32 sts = readl(priv->base + COMMAND_FIFO_STATUS);
97 if ((sts & CMD_CNTR_MASK) < MAX_PENDING_CMDS) {
99 priv->base + SECURE_PROCESSOR_COMMAND);
102 /* SP busy. This has not been seen in practice. */
106 dev_dbg(priv->dev, "olpc_apsp_write timeout, status=%x\n",
107 readl(priv->base + COMMAND_FIFO_STATUS));
112 static irqreturn_t olpc_apsp_rx(int irq, void *dev_id)
114 struct olpc_apsp *priv = dev_id;
119 * Write 1 to PJ_RST_INTERRUPT to acknowledge and clear the interrupt
120 * Write 0xff00 to SECURE_PROCESSOR_COMMAND.
122 tmp = readl(priv->base + PJ_RST_INTERRUPT);
123 if (!(tmp & SP_COMMAND_COMPLETE_RESET)) {
124 dev_warn(priv->dev, "spurious interrupt?\n");
128 w = readl(priv->base + COMMAND_RETURN_STATUS);
129 dev_dbg(priv->dev, "olpc_apsp_rx %x\n", w);
131 if (w >> PORT_SHIFT == KEYBOARD_PORT)
136 serio_interrupt(serio, w & DATA_MASK, 0);
138 /* Ack and clear interrupt */
139 writel(tmp | SP_COMMAND_COMPLETE_RESET, priv->base + PJ_RST_INTERRUPT);
140 writel(PORT_MASK, priv->base + SECURE_PROCESSOR_COMMAND);
142 pm_wakeup_event(priv->dev, 1000);
146 static int olpc_apsp_open(struct serio *port)
148 struct olpc_apsp *priv = port->port_data;
153 if (priv->open_count++ == 0) {
154 error = clk_prepare_enable(priv->clk);
158 l = readl(priv->base + COMMAND_FIFO_STATUS);
159 if (!(l & CMD_STS_MASK)) {
160 dev_err(priv->dev, "SP cannot accept commands.\n");
161 clk_disable_unprepare(priv->clk);
165 /* Enable interrupt 0 by clearing its bit */
166 tmp = readl(priv->base + PJ_INTERRUPT_MASK);
167 writel(tmp & ~INT_0, priv->base + PJ_INTERRUPT_MASK);
173 static void olpc_apsp_close(struct serio *port)
175 struct olpc_apsp *priv = port->port_data;
178 if (--priv->open_count == 0) {
179 /* Disable interrupt 0 */
180 tmp = readl(priv->base + PJ_INTERRUPT_MASK);
181 writel(tmp | INT_0, priv->base + PJ_INTERRUPT_MASK);
183 clk_disable_unprepare(priv->clk);
187 static int olpc_apsp_probe(struct platform_device *pdev)
189 struct serio *kb_serio, *pad_serio;
190 struct olpc_apsp *priv;
191 struct resource *res;
194 priv = devm_kzalloc(&pdev->dev, sizeof(struct olpc_apsp), GFP_KERNEL);
198 priv->dev = &pdev->dev;
200 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
201 priv->base = devm_ioremap_resource(&pdev->dev, res);
202 if (IS_ERR(priv->base)) {
203 dev_err(&pdev->dev, "Failed to map WTM registers\n");
204 return PTR_ERR(priv->base);
207 priv->irq = platform_get_irq(pdev, 0);
211 priv->clk = devm_clk_get(&pdev->dev, "sp");
212 if (IS_ERR(priv->clk))
213 return PTR_ERR(priv->clk);
216 kb_serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
219 kb_serio->id.type = SERIO_8042_XL;
220 kb_serio->write = olpc_apsp_write;
221 kb_serio->open = olpc_apsp_open;
222 kb_serio->close = olpc_apsp_close;
223 kb_serio->port_data = priv;
224 kb_serio->dev.parent = &pdev->dev;
225 strlcpy(kb_serio->name, "sp keyboard", sizeof(kb_serio->name));
226 strlcpy(kb_serio->phys, "sp/serio0", sizeof(kb_serio->phys));
227 priv->kbio = kb_serio;
228 serio_register_port(kb_serio);
231 pad_serio = kzalloc(sizeof(struct serio), GFP_KERNEL);
236 pad_serio->id.type = SERIO_8042;
237 pad_serio->write = olpc_apsp_write;
238 pad_serio->open = olpc_apsp_open;
239 pad_serio->close = olpc_apsp_close;
240 pad_serio->port_data = priv;
241 pad_serio->dev.parent = &pdev->dev;
242 strlcpy(pad_serio->name, "sp touchpad", sizeof(pad_serio->name));
243 strlcpy(pad_serio->phys, "sp/serio1", sizeof(pad_serio->phys));
244 priv->padio = pad_serio;
245 serio_register_port(pad_serio);
247 error = request_irq(priv->irq, olpc_apsp_rx, 0, "olpc-apsp", priv);
249 dev_err(&pdev->dev, "Failed to request IRQ\n");
253 device_init_wakeup(priv->dev, 1);
254 platform_set_drvdata(pdev, priv);
256 dev_dbg(&pdev->dev, "probed successfully.\n");
260 serio_unregister_port(pad_serio);
262 serio_unregister_port(kb_serio);
266 static int olpc_apsp_remove(struct platform_device *pdev)
268 struct olpc_apsp *priv = platform_get_drvdata(pdev);
270 free_irq(priv->irq, priv);
272 serio_unregister_port(priv->kbio);
273 serio_unregister_port(priv->padio);
278 static const struct of_device_id olpc_apsp_dt_ids[] = {
279 { .compatible = "olpc,ap-sp", },
282 MODULE_DEVICE_TABLE(of, olpc_apsp_dt_ids);
284 static struct platform_driver olpc_apsp_driver = {
285 .probe = olpc_apsp_probe,
286 .remove = olpc_apsp_remove,
289 .of_match_table = olpc_apsp_dt_ids,
293 MODULE_DESCRIPTION("OLPC AP-SP serio driver");
294 MODULE_LICENSE("GPL");
295 module_platform_driver(olpc_apsp_driver);