1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Generic driver for the OLPC Embedded Controller.
5 * Author: Andres Salomon <dilinger@queued.net>
7 * Copyright (C) 2011-2012 One Laptop per Child Foundation.
9 #include <linux/completion.h>
10 #include <linux/debugfs.h>
11 #include <linux/spinlock.h>
12 #include <linux/mutex.h>
13 #include <linux/platform_device.h>
14 #include <linux/slab.h>
15 #include <linux/workqueue.h>
16 #include <linux/init.h>
17 #include <linux/list.h>
18 #include <linux/regulator/driver.h>
19 #include <linux/olpc-ec.h>
27 struct completion finished
;
28 struct list_head node
;
34 struct olpc_ec_driver
*drv
;
36 struct work_struct worker
;
37 struct mutex cmd_lock
;
40 struct regulator_dev
*dcon_rdev
;
43 /* Pending EC commands */
44 struct list_head cmd_q
;
45 spinlock_t cmd_q_lock
;
47 struct dentry
*dbgfs_dir
;
50 * EC event mask to be applied during suspend (defining wakeup
56 * Running an EC command while suspending means we don't always finish
57 * the command before the machine suspends. This means that the EC
58 * is expecting the command protocol to finish, but we after a period
59 * of time (while the OS is asleep) the EC times out and restarts its
60 * idle loop. Meanwhile, the OS wakes up, thinks it's still in the
61 * middle of the command protocol, starts throwing random things at
62 * the EC... and everyone's uphappy.
67 static struct olpc_ec_driver
*ec_driver
;
68 static struct olpc_ec_priv
*ec_priv
;
69 static void *ec_cb_arg
;
71 void olpc_ec_driver_register(struct olpc_ec_driver
*drv
, void *arg
)
76 EXPORT_SYMBOL_GPL(olpc_ec_driver_register
);
78 static void olpc_ec_worker(struct work_struct
*w
)
80 struct olpc_ec_priv
*ec
= container_of(w
, struct olpc_ec_priv
, worker
);
81 struct ec_cmd_desc
*desc
= NULL
;
84 /* Grab the first pending command from the queue */
85 spin_lock_irqsave(&ec
->cmd_q_lock
, flags
);
86 if (!list_empty(&ec
->cmd_q
)) {
87 desc
= list_first_entry(&ec
->cmd_q
, struct ec_cmd_desc
, node
);
88 list_del(&desc
->node
);
90 spin_unlock_irqrestore(&ec
->cmd_q_lock
, flags
);
92 /* Do we actually have anything to do? */
96 /* Protect the EC hw with a mutex; only run one cmd at a time */
97 mutex_lock(&ec
->cmd_lock
);
98 desc
->err
= ec_driver
->ec_cmd(desc
->cmd
, desc
->inbuf
, desc
->inlen
,
99 desc
->outbuf
, desc
->outlen
, ec_cb_arg
);
100 mutex_unlock(&ec
->cmd_lock
);
102 /* Finished, wake up olpc_ec_cmd() */
103 complete(&desc
->finished
);
105 /* Run the worker thread again in case there are more cmds pending */
106 schedule_work(&ec
->worker
);
110 * Throw a cmd descripter onto the list. We now have SMP OLPC machines, so
111 * locking is pretty critical.
113 static void queue_ec_descriptor(struct ec_cmd_desc
*desc
,
114 struct olpc_ec_priv
*ec
)
118 INIT_LIST_HEAD(&desc
->node
);
120 spin_lock_irqsave(&ec
->cmd_q_lock
, flags
);
121 list_add_tail(&desc
->node
, &ec
->cmd_q
);
122 spin_unlock_irqrestore(&ec
->cmd_q_lock
, flags
);
124 schedule_work(&ec
->worker
);
127 int olpc_ec_cmd(u8 cmd
, u8
*inbuf
, size_t inlen
, u8
*outbuf
, size_t outlen
)
129 struct olpc_ec_priv
*ec
= ec_priv
;
130 struct ec_cmd_desc desc
;
132 /* Driver not yet registered. */
134 return -EPROBE_DEFER
;
136 if (WARN_ON(!ec_driver
->ec_cmd
))
142 /* Suspending in the middle of a command hoses things really badly */
143 if (WARN_ON(ec
->suspended
))
150 desc
.outbuf
= outbuf
;
152 desc
.outlen
= outlen
;
154 init_completion(&desc
.finished
);
156 queue_ec_descriptor(&desc
, ec
);
158 /* Timeouts must be handled in the platform-specific EC hook */
159 wait_for_completion(&desc
.finished
);
161 /* The worker thread dequeues the cmd; no need to do anything here */
164 EXPORT_SYMBOL_GPL(olpc_ec_cmd
);
166 void olpc_ec_wakeup_set(u16 value
)
168 struct olpc_ec_priv
*ec
= ec_priv
;
173 ec
->ec_wakeup_mask
|= value
;
175 EXPORT_SYMBOL_GPL(olpc_ec_wakeup_set
);
177 void olpc_ec_wakeup_clear(u16 value
)
179 struct olpc_ec_priv
*ec
= ec_priv
;
184 ec
->ec_wakeup_mask
&= ~value
;
186 EXPORT_SYMBOL_GPL(olpc_ec_wakeup_clear
);
188 int olpc_ec_mask_write(u16 bits
)
190 struct olpc_ec_priv
*ec
= ec_priv
;
195 /* EC version 0x5f adds support for wide SCI mask */
196 if (ec
->version
>= 0x5f) {
197 __be16 ec_word
= cpu_to_be16(bits
);
199 return olpc_ec_cmd(EC_WRITE_EXT_SCI_MASK
, (void *)&ec_word
, 2, NULL
, 0);
201 u8 ec_byte
= bits
& 0xff;
203 return olpc_ec_cmd(EC_WRITE_SCI_MASK
, &ec_byte
, 1, NULL
, 0);
206 EXPORT_SYMBOL_GPL(olpc_ec_mask_write
);
209 * Returns true if the compile and runtime configurations allow for EC events
210 * to wake the system.
212 bool olpc_ec_wakeup_available(void)
214 if (WARN_ON(!ec_driver
))
217 return ec_driver
->wakeup_available
;
219 EXPORT_SYMBOL_GPL(olpc_ec_wakeup_available
);
221 int olpc_ec_sci_query(u16
*sci_value
)
223 struct olpc_ec_priv
*ec
= ec_priv
;
229 /* EC version 0x5f adds support for wide SCI mask */
230 if (ec
->version
>= 0x5f) {
233 ret
= olpc_ec_cmd(EC_EXT_SCI_QUERY
, NULL
, 0, (void *)&ec_word
, 2);
235 *sci_value
= be16_to_cpu(ec_word
);
239 ret
= olpc_ec_cmd(EC_SCI_QUERY
, NULL
, 0, &ec_byte
, 1);
241 *sci_value
= ec_byte
;
246 EXPORT_SYMBOL_GPL(olpc_ec_sci_query
);
248 #ifdef CONFIG_DEBUG_FS
251 * debugfs support for "generic commands", to allow sending
252 * arbitrary EC commands from userspace.
255 #define EC_MAX_CMD_ARGS (5 + 1) /* cmd byte + 5 args */
256 #define EC_MAX_CMD_REPLY (8)
258 static DEFINE_MUTEX(ec_dbgfs_lock
);
259 static unsigned char ec_dbgfs_resp
[EC_MAX_CMD_REPLY
];
260 static unsigned int ec_dbgfs_resp_bytes
;
262 static ssize_t
ec_dbgfs_cmd_write(struct file
*file
, const char __user
*buf
,
263 size_t size
, loff_t
*ppos
)
266 unsigned char ec_cmd
[EC_MAX_CMD_ARGS
];
267 unsigned int ec_cmd_int
[EC_MAX_CMD_ARGS
];
271 mutex_lock(&ec_dbgfs_lock
);
273 size
= simple_write_to_buffer(cmdbuf
, sizeof(cmdbuf
), ppos
, buf
, size
);
275 m
= sscanf(cmdbuf
, "%x:%u %x %x %x %x %x", &ec_cmd_int
[0],
276 &ec_dbgfs_resp_bytes
, &ec_cmd_int
[1], &ec_cmd_int
[2],
277 &ec_cmd_int
[3], &ec_cmd_int
[4], &ec_cmd_int
[5]);
278 if (m
< 2 || ec_dbgfs_resp_bytes
> EC_MAX_CMD_REPLY
) {
279 /* reset to prevent overflow on read */
280 ec_dbgfs_resp_bytes
= 0;
282 pr_debug("olpc-ec: bad ec cmd: cmd:response-count [arg1 [arg2 ...]]\n");
287 /* convert scanf'd ints to char */
288 ec_cmd_bytes
= m
- 2;
289 for (i
= 0; i
<= ec_cmd_bytes
; i
++)
290 ec_cmd
[i
] = ec_cmd_int
[i
];
292 pr_debug("olpc-ec: debugfs cmd 0x%02x with %d args %5ph, want %d returns\n",
293 ec_cmd
[0], ec_cmd_bytes
, ec_cmd
+ 1,
294 ec_dbgfs_resp_bytes
);
296 olpc_ec_cmd(ec_cmd
[0], (ec_cmd_bytes
== 0) ? NULL
: &ec_cmd
[1],
297 ec_cmd_bytes
, ec_dbgfs_resp
, ec_dbgfs_resp_bytes
);
299 pr_debug("olpc-ec: response %8ph (%d bytes expected)\n",
300 ec_dbgfs_resp
, ec_dbgfs_resp_bytes
);
303 mutex_unlock(&ec_dbgfs_lock
);
307 static ssize_t
ec_dbgfs_cmd_read(struct file
*file
, char __user
*buf
,
308 size_t size
, loff_t
*ppos
)
314 mutex_lock(&ec_dbgfs_lock
);
316 rp
+= sprintf(rp
, "%02x", ec_dbgfs_resp
[0]);
317 for (i
= 1; i
< ec_dbgfs_resp_bytes
; i
++)
318 rp
+= sprintf(rp
, ", %02x", ec_dbgfs_resp
[i
]);
319 mutex_unlock(&ec_dbgfs_lock
);
320 rp
+= sprintf(rp
, "\n");
323 return simple_read_from_buffer(buf
, size
, ppos
, respbuf
, r
);
326 static const struct file_operations ec_dbgfs_ops
= {
327 .write
= ec_dbgfs_cmd_write
,
328 .read
= ec_dbgfs_cmd_read
,
331 static struct dentry
*olpc_ec_setup_debugfs(void)
333 struct dentry
*dbgfs_dir
;
335 dbgfs_dir
= debugfs_create_dir("olpc-ec", NULL
);
336 if (IS_ERR_OR_NULL(dbgfs_dir
))
339 debugfs_create_file("cmd", 0600, dbgfs_dir
, NULL
, &ec_dbgfs_ops
);
346 static struct dentry
*olpc_ec_setup_debugfs(void)
351 #endif /* CONFIG_DEBUG_FS */
353 static int olpc_ec_set_dcon_power(struct olpc_ec_priv
*ec
, bool state
)
355 unsigned char ec_byte
= state
;
358 if (ec
->dcon_enabled
== state
)
361 ret
= olpc_ec_cmd(EC_DCON_POWER_MODE
, &ec_byte
, 1, NULL
, 0);
365 ec
->dcon_enabled
= state
;
369 static int dcon_regulator_enable(struct regulator_dev
*rdev
)
371 struct olpc_ec_priv
*ec
= rdev_get_drvdata(rdev
);
373 return olpc_ec_set_dcon_power(ec
, true);
376 static int dcon_regulator_disable(struct regulator_dev
*rdev
)
378 struct olpc_ec_priv
*ec
= rdev_get_drvdata(rdev
);
380 return olpc_ec_set_dcon_power(ec
, false);
383 static int dcon_regulator_is_enabled(struct regulator_dev
*rdev
)
385 struct olpc_ec_priv
*ec
= rdev_get_drvdata(rdev
);
387 return ec
->dcon_enabled
? 1 : 0;
390 static struct regulator_ops dcon_regulator_ops
= {
391 .enable
= dcon_regulator_enable
,
392 .disable
= dcon_regulator_disable
,
393 .is_enabled
= dcon_regulator_is_enabled
,
396 static const struct regulator_desc dcon_desc
= {
399 .ops
= &dcon_regulator_ops
,
400 .type
= REGULATOR_VOLTAGE
,
401 .owner
= THIS_MODULE
,
404 static int olpc_ec_probe(struct platform_device
*pdev
)
406 struct olpc_ec_priv
*ec
;
407 struct regulator_config config
= { };
413 ec
= kzalloc(sizeof(*ec
), GFP_KERNEL
);
418 INIT_WORK(&ec
->worker
, olpc_ec_worker
);
419 mutex_init(&ec
->cmd_lock
);
421 INIT_LIST_HEAD(&ec
->cmd_q
);
422 spin_lock_init(&ec
->cmd_q_lock
);
425 platform_set_drvdata(pdev
, ec
);
427 /* get the EC revision */
428 err
= olpc_ec_cmd(EC_FIRMWARE_REV
, NULL
, 0, &ec
->version
, 1);
435 config
.dev
= pdev
->dev
.parent
;
436 config
.driver_data
= ec
;
437 ec
->dcon_enabled
= true;
438 ec
->dcon_rdev
= devm_regulator_register(&pdev
->dev
, &dcon_desc
,
440 if (IS_ERR(ec
->dcon_rdev
)) {
441 dev_err(&pdev
->dev
, "failed to register DCON regulator\n");
442 err
= PTR_ERR(ec
->dcon_rdev
);
447 ec
->dbgfs_dir
= olpc_ec_setup_debugfs();
452 static int olpc_ec_suspend(struct device
*dev
)
454 struct platform_device
*pdev
= to_platform_device(dev
);
455 struct olpc_ec_priv
*ec
= platform_get_drvdata(pdev
);
458 olpc_ec_mask_write(ec
->ec_wakeup_mask
);
460 if (ec_driver
->suspend
)
461 err
= ec_driver
->suspend(pdev
);
463 ec
->suspended
= true;
468 static int olpc_ec_resume(struct device
*dev
)
470 struct platform_device
*pdev
= to_platform_device(dev
);
471 struct olpc_ec_priv
*ec
= platform_get_drvdata(pdev
);
473 ec
->suspended
= false;
474 return ec_driver
->resume
? ec_driver
->resume(pdev
) : 0;
477 static const struct dev_pm_ops olpc_ec_pm_ops
= {
478 .suspend_late
= olpc_ec_suspend
,
479 .resume_early
= olpc_ec_resume
,
482 static struct platform_driver olpc_ec_plat_driver
= {
483 .probe
= olpc_ec_probe
,
486 .pm
= &olpc_ec_pm_ops
,
490 static int __init
olpc_ec_init_module(void)
492 return platform_driver_register(&olpc_ec_plat_driver
);
494 arch_initcall(olpc_ec_init_module
);