firewire: core: check for 1394a compliant IRM, fix inaccessibility of Sony camcorder
[firewire-audio.git] / drivers / macintosh / smu.c
blob2506c957712e894479e48ced054b5eb4bf532873
1 /*
2 * PowerMac G5 SMU driver
4 * Copyright 2004 J. Mayer <l_indien@magic.fr>
5 * Copyright 2005 Benjamin Herrenschmidt, IBM Corp.
7 * Released under the term of the GNU GPL v2.
8 */
11 * TODO:
12 * - maybe add timeout to commands ?
13 * - blocking version of time functions
14 * - polling version of i2c commands (including timer that works with
15 * interrupts off)
16 * - maybe avoid some data copies with i2c by directly using the smu cmd
17 * buffer and a lower level internal interface
18 * - understand SMU -> CPU events and implement reception of them via
19 * the userland interface
22 #include <linux/smp_lock.h>
23 #include <linux/types.h>
24 #include <linux/kernel.h>
25 #include <linux/device.h>
26 #include <linux/dmapool.h>
27 #include <linux/bootmem.h>
28 #include <linux/vmalloc.h>
29 #include <linux/highmem.h>
30 #include <linux/jiffies.h>
31 #include <linux/interrupt.h>
32 #include <linux/rtc.h>
33 #include <linux/completion.h>
34 #include <linux/miscdevice.h>
35 #include <linux/delay.h>
36 #include <linux/sysdev.h>
37 #include <linux/poll.h>
38 #include <linux/mutex.h>
39 #include <linux/of_device.h>
40 #include <linux/of_platform.h>
41 #include <linux/slab.h>
43 #include <asm/byteorder.h>
44 #include <asm/io.h>
45 #include <asm/prom.h>
46 #include <asm/machdep.h>
47 #include <asm/pmac_feature.h>
48 #include <asm/smu.h>
49 #include <asm/sections.h>
50 #include <asm/abs_addr.h>
51 #include <asm/uaccess.h>
53 #define VERSION "0.7"
54 #define AUTHOR "(c) 2005 Benjamin Herrenschmidt, IBM Corp."
56 #undef DEBUG_SMU
58 #ifdef DEBUG_SMU
59 #define DPRINTK(fmt, args...) do { printk(KERN_DEBUG fmt , ##args); } while (0)
60 #else
61 #define DPRINTK(fmt, args...) do { } while (0)
62 #endif
65 * This is the command buffer passed to the SMU hardware
67 #define SMU_MAX_DATA 254
69 struct smu_cmd_buf {
70 u8 cmd;
71 u8 length;
72 u8 data[SMU_MAX_DATA];
75 struct smu_device {
76 spinlock_t lock;
77 struct device_node *of_node;
78 struct of_device *of_dev;
79 int doorbell; /* doorbell gpio */
80 u32 __iomem *db_buf; /* doorbell buffer */
81 struct device_node *db_node;
82 unsigned int db_irq;
83 int msg;
84 struct device_node *msg_node;
85 unsigned int msg_irq;
86 struct smu_cmd_buf *cmd_buf; /* command buffer virtual */
87 u32 cmd_buf_abs; /* command buffer absolute */
88 struct list_head cmd_list;
89 struct smu_cmd *cmd_cur; /* pending command */
90 int broken_nap;
91 struct list_head cmd_i2c_list;
92 struct smu_i2c_cmd *cmd_i2c_cur; /* pending i2c command */
93 struct timer_list i2c_timer;
97 * I don't think there will ever be more than one SMU, so
98 * for now, just hard code that
100 static struct smu_device *smu;
101 static DEFINE_MUTEX(smu_part_access);
102 static int smu_irq_inited;
104 static void smu_i2c_retry(unsigned long data);
107 * SMU driver low level stuff
110 static void smu_start_cmd(void)
112 unsigned long faddr, fend;
113 struct smu_cmd *cmd;
115 if (list_empty(&smu->cmd_list))
116 return;
118 /* Fetch first command in queue */
119 cmd = list_entry(smu->cmd_list.next, struct smu_cmd, link);
120 smu->cmd_cur = cmd;
121 list_del(&cmd->link);
123 DPRINTK("SMU: starting cmd %x, %d bytes data\n", cmd->cmd,
124 cmd->data_len);
125 DPRINTK("SMU: data buffer: %02x %02x %02x %02x %02x %02x %02x %02x\n",
126 ((u8 *)cmd->data_buf)[0], ((u8 *)cmd->data_buf)[1],
127 ((u8 *)cmd->data_buf)[2], ((u8 *)cmd->data_buf)[3],
128 ((u8 *)cmd->data_buf)[4], ((u8 *)cmd->data_buf)[5],
129 ((u8 *)cmd->data_buf)[6], ((u8 *)cmd->data_buf)[7]);
131 /* Fill the SMU command buffer */
132 smu->cmd_buf->cmd = cmd->cmd;
133 smu->cmd_buf->length = cmd->data_len;
134 memcpy(smu->cmd_buf->data, cmd->data_buf, cmd->data_len);
136 /* Flush command and data to RAM */
137 faddr = (unsigned long)smu->cmd_buf;
138 fend = faddr + smu->cmd_buf->length + 2;
139 flush_inval_dcache_range(faddr, fend);
142 /* We also disable NAP mode for the duration of the command
143 * on U3 based machines.
144 * This is slightly racy as it can be written back to 1 by a sysctl
145 * but that never happens in practice. There seem to be an issue with
146 * U3 based machines such as the iMac G5 where napping for the
147 * whole duration of the command prevents the SMU from fetching it
148 * from memory. This might be related to the strange i2c based
149 * mechanism the SMU uses to access memory.
151 if (smu->broken_nap)
152 powersave_nap = 0;
154 /* This isn't exactly a DMA mapping here, I suspect
155 * the SMU is actually communicating with us via i2c to the
156 * northbridge or the CPU to access RAM.
158 writel(smu->cmd_buf_abs, smu->db_buf);
160 /* Ring the SMU doorbell */
161 pmac_do_feature_call(PMAC_FTR_WRITE_GPIO, NULL, smu->doorbell, 4);
165 static irqreturn_t smu_db_intr(int irq, void *arg)
167 unsigned long flags;
168 struct smu_cmd *cmd;
169 void (*done)(struct smu_cmd *cmd, void *misc) = NULL;
170 void *misc = NULL;
171 u8 gpio;
172 int rc = 0;
174 /* SMU completed the command, well, we hope, let's make sure
175 * of it
177 spin_lock_irqsave(&smu->lock, flags);
179 gpio = pmac_do_feature_call(PMAC_FTR_READ_GPIO, NULL, smu->doorbell);
180 if ((gpio & 7) != 7) {
181 spin_unlock_irqrestore(&smu->lock, flags);
182 return IRQ_HANDLED;
185 cmd = smu->cmd_cur;
186 smu->cmd_cur = NULL;
187 if (cmd == NULL)
188 goto bail;
190 if (rc == 0) {
191 unsigned long faddr;
192 int reply_len;
193 u8 ack;
195 /* CPU might have brought back the cache line, so we need
196 * to flush again before peeking at the SMU response. We
197 * flush the entire buffer for now as we haven't read the
198 * reply length (it's only 2 cache lines anyway)
200 faddr = (unsigned long)smu->cmd_buf;
201 flush_inval_dcache_range(faddr, faddr + 256);
203 /* Now check ack */
204 ack = (~cmd->cmd) & 0xff;
205 if (ack != smu->cmd_buf->cmd) {
206 DPRINTK("SMU: incorrect ack, want %x got %x\n",
207 ack, smu->cmd_buf->cmd);
208 rc = -EIO;
210 reply_len = rc == 0 ? smu->cmd_buf->length : 0;
211 DPRINTK("SMU: reply len: %d\n", reply_len);
212 if (reply_len > cmd->reply_len) {
213 printk(KERN_WARNING "SMU: reply buffer too small,"
214 "got %d bytes for a %d bytes buffer\n",
215 reply_len, cmd->reply_len);
216 reply_len = cmd->reply_len;
218 cmd->reply_len = reply_len;
219 if (cmd->reply_buf && reply_len)
220 memcpy(cmd->reply_buf, smu->cmd_buf->data, reply_len);
223 /* Now complete the command. Write status last in order as we lost
224 * ownership of the command structure as soon as it's no longer -1
226 done = cmd->done;
227 misc = cmd->misc;
228 mb();
229 cmd->status = rc;
231 /* Re-enable NAP mode */
232 if (smu->broken_nap)
233 powersave_nap = 1;
234 bail:
235 /* Start next command if any */
236 smu_start_cmd();
237 spin_unlock_irqrestore(&smu->lock, flags);
239 /* Call command completion handler if any */
240 if (done)
241 done(cmd, misc);
243 /* It's an edge interrupt, nothing to do */
244 return IRQ_HANDLED;
248 static irqreturn_t smu_msg_intr(int irq, void *arg)
250 /* I don't quite know what to do with this one, we seem to never
251 * receive it, so I suspect we have to arm it someway in the SMU
252 * to start getting events that way.
255 printk(KERN_INFO "SMU: message interrupt !\n");
257 /* It's an edge interrupt, nothing to do */
258 return IRQ_HANDLED;
263 * Queued command management.
267 int smu_queue_cmd(struct smu_cmd *cmd)
269 unsigned long flags;
271 if (smu == NULL)
272 return -ENODEV;
273 if (cmd->data_len > SMU_MAX_DATA ||
274 cmd->reply_len > SMU_MAX_DATA)
275 return -EINVAL;
277 cmd->status = 1;
278 spin_lock_irqsave(&smu->lock, flags);
279 list_add_tail(&cmd->link, &smu->cmd_list);
280 if (smu->cmd_cur == NULL)
281 smu_start_cmd();
282 spin_unlock_irqrestore(&smu->lock, flags);
284 /* Workaround for early calls when irq isn't available */
285 if (!smu_irq_inited || smu->db_irq == NO_IRQ)
286 smu_spinwait_cmd(cmd);
288 return 0;
290 EXPORT_SYMBOL(smu_queue_cmd);
293 int smu_queue_simple(struct smu_simple_cmd *scmd, u8 command,
294 unsigned int data_len,
295 void (*done)(struct smu_cmd *cmd, void *misc),
296 void *misc, ...)
298 struct smu_cmd *cmd = &scmd->cmd;
299 va_list list;
300 int i;
302 if (data_len > sizeof(scmd->buffer))
303 return -EINVAL;
305 memset(scmd, 0, sizeof(*scmd));
306 cmd->cmd = command;
307 cmd->data_len = data_len;
308 cmd->data_buf = scmd->buffer;
309 cmd->reply_len = sizeof(scmd->buffer);
310 cmd->reply_buf = scmd->buffer;
311 cmd->done = done;
312 cmd->misc = misc;
314 va_start(list, misc);
315 for (i = 0; i < data_len; ++i)
316 scmd->buffer[i] = (u8)va_arg(list, int);
317 va_end(list);
319 return smu_queue_cmd(cmd);
321 EXPORT_SYMBOL(smu_queue_simple);
324 void smu_poll(void)
326 u8 gpio;
328 if (smu == NULL)
329 return;
331 gpio = pmac_do_feature_call(PMAC_FTR_READ_GPIO, NULL, smu->doorbell);
332 if ((gpio & 7) == 7)
333 smu_db_intr(smu->db_irq, smu);
335 EXPORT_SYMBOL(smu_poll);
338 void smu_done_complete(struct smu_cmd *cmd, void *misc)
340 struct completion *comp = misc;
342 complete(comp);
344 EXPORT_SYMBOL(smu_done_complete);
347 void smu_spinwait_cmd(struct smu_cmd *cmd)
349 while(cmd->status == 1)
350 smu_poll();
352 EXPORT_SYMBOL(smu_spinwait_cmd);
355 /* RTC low level commands */
356 static inline int bcd2hex (int n)
358 return (((n & 0xf0) >> 4) * 10) + (n & 0xf);
362 static inline int hex2bcd (int n)
364 return ((n / 10) << 4) + (n % 10);
368 static inline void smu_fill_set_rtc_cmd(struct smu_cmd_buf *cmd_buf,
369 struct rtc_time *time)
371 cmd_buf->cmd = 0x8e;
372 cmd_buf->length = 8;
373 cmd_buf->data[0] = 0x80;
374 cmd_buf->data[1] = hex2bcd(time->tm_sec);
375 cmd_buf->data[2] = hex2bcd(time->tm_min);
376 cmd_buf->data[3] = hex2bcd(time->tm_hour);
377 cmd_buf->data[4] = time->tm_wday;
378 cmd_buf->data[5] = hex2bcd(time->tm_mday);
379 cmd_buf->data[6] = hex2bcd(time->tm_mon) + 1;
380 cmd_buf->data[7] = hex2bcd(time->tm_year - 100);
384 int smu_get_rtc_time(struct rtc_time *time, int spinwait)
386 struct smu_simple_cmd cmd;
387 int rc;
389 if (smu == NULL)
390 return -ENODEV;
392 memset(time, 0, sizeof(struct rtc_time));
393 rc = smu_queue_simple(&cmd, SMU_CMD_RTC_COMMAND, 1, NULL, NULL,
394 SMU_CMD_RTC_GET_DATETIME);
395 if (rc)
396 return rc;
397 smu_spinwait_simple(&cmd);
399 time->tm_sec = bcd2hex(cmd.buffer[0]);
400 time->tm_min = bcd2hex(cmd.buffer[1]);
401 time->tm_hour = bcd2hex(cmd.buffer[2]);
402 time->tm_wday = bcd2hex(cmd.buffer[3]);
403 time->tm_mday = bcd2hex(cmd.buffer[4]);
404 time->tm_mon = bcd2hex(cmd.buffer[5]) - 1;
405 time->tm_year = bcd2hex(cmd.buffer[6]) + 100;
407 return 0;
411 int smu_set_rtc_time(struct rtc_time *time, int spinwait)
413 struct smu_simple_cmd cmd;
414 int rc;
416 if (smu == NULL)
417 return -ENODEV;
419 rc = smu_queue_simple(&cmd, SMU_CMD_RTC_COMMAND, 8, NULL, NULL,
420 SMU_CMD_RTC_SET_DATETIME,
421 hex2bcd(time->tm_sec),
422 hex2bcd(time->tm_min),
423 hex2bcd(time->tm_hour),
424 time->tm_wday,
425 hex2bcd(time->tm_mday),
426 hex2bcd(time->tm_mon) + 1,
427 hex2bcd(time->tm_year - 100));
428 if (rc)
429 return rc;
430 smu_spinwait_simple(&cmd);
432 return 0;
436 void smu_shutdown(void)
438 struct smu_simple_cmd cmd;
440 if (smu == NULL)
441 return;
443 if (smu_queue_simple(&cmd, SMU_CMD_POWER_COMMAND, 9, NULL, NULL,
444 'S', 'H', 'U', 'T', 'D', 'O', 'W', 'N', 0))
445 return;
446 smu_spinwait_simple(&cmd);
447 for (;;)
452 void smu_restart(void)
454 struct smu_simple_cmd cmd;
456 if (smu == NULL)
457 return;
459 if (smu_queue_simple(&cmd, SMU_CMD_POWER_COMMAND, 8, NULL, NULL,
460 'R', 'E', 'S', 'T', 'A', 'R', 'T', 0))
461 return;
462 smu_spinwait_simple(&cmd);
463 for (;;)
468 int smu_present(void)
470 return smu != NULL;
472 EXPORT_SYMBOL(smu_present);
475 int __init smu_init (void)
477 struct device_node *np;
478 const u32 *data;
479 int ret = 0;
481 np = of_find_node_by_type(NULL, "smu");
482 if (np == NULL)
483 return -ENODEV;
485 printk(KERN_INFO "SMU: Driver %s %s\n", VERSION, AUTHOR);
487 if (smu_cmdbuf_abs == 0) {
488 printk(KERN_ERR "SMU: Command buffer not allocated !\n");
489 ret = -EINVAL;
490 goto fail_np;
493 smu = alloc_bootmem(sizeof(struct smu_device));
495 spin_lock_init(&smu->lock);
496 INIT_LIST_HEAD(&smu->cmd_list);
497 INIT_LIST_HEAD(&smu->cmd_i2c_list);
498 smu->of_node = np;
499 smu->db_irq = NO_IRQ;
500 smu->msg_irq = NO_IRQ;
502 /* smu_cmdbuf_abs is in the low 2G of RAM, can be converted to a
503 * 32 bits value safely
505 smu->cmd_buf_abs = (u32)smu_cmdbuf_abs;
506 smu->cmd_buf = (struct smu_cmd_buf *)abs_to_virt(smu_cmdbuf_abs);
508 smu->db_node = of_find_node_by_name(NULL, "smu-doorbell");
509 if (smu->db_node == NULL) {
510 printk(KERN_ERR "SMU: Can't find doorbell GPIO !\n");
511 ret = -ENXIO;
512 goto fail_bootmem;
514 data = of_get_property(smu->db_node, "reg", NULL);
515 if (data == NULL) {
516 printk(KERN_ERR "SMU: Can't find doorbell GPIO address !\n");
517 ret = -ENXIO;
518 goto fail_db_node;
521 /* Current setup has one doorbell GPIO that does both doorbell
522 * and ack. GPIOs are at 0x50, best would be to find that out
523 * in the device-tree though.
525 smu->doorbell = *data;
526 if (smu->doorbell < 0x50)
527 smu->doorbell += 0x50;
529 /* Now look for the smu-interrupt GPIO */
530 do {
531 smu->msg_node = of_find_node_by_name(NULL, "smu-interrupt");
532 if (smu->msg_node == NULL)
533 break;
534 data = of_get_property(smu->msg_node, "reg", NULL);
535 if (data == NULL) {
536 of_node_put(smu->msg_node);
537 smu->msg_node = NULL;
538 break;
540 smu->msg = *data;
541 if (smu->msg < 0x50)
542 smu->msg += 0x50;
543 } while(0);
545 /* Doorbell buffer is currently hard-coded, I didn't find a proper
546 * device-tree entry giving the address. Best would probably to use
547 * an offset for K2 base though, but let's do it that way for now.
549 smu->db_buf = ioremap(0x8000860c, 0x1000);
550 if (smu->db_buf == NULL) {
551 printk(KERN_ERR "SMU: Can't map doorbell buffer pointer !\n");
552 ret = -ENXIO;
553 goto fail_msg_node;
556 /* U3 has an issue with NAP mode when issuing SMU commands */
557 smu->broken_nap = pmac_get_uninorth_variant() < 4;
558 if (smu->broken_nap)
559 printk(KERN_INFO "SMU: using NAP mode workaround\n");
561 sys_ctrler = SYS_CTRLER_SMU;
562 return 0;
564 fail_msg_node:
565 if (smu->msg_node)
566 of_node_put(smu->msg_node);
567 fail_db_node:
568 of_node_put(smu->db_node);
569 fail_bootmem:
570 free_bootmem((unsigned long)smu, sizeof(struct smu_device));
571 smu = NULL;
572 fail_np:
573 of_node_put(np);
574 return ret;
578 static int smu_late_init(void)
580 if (!smu)
581 return 0;
583 init_timer(&smu->i2c_timer);
584 smu->i2c_timer.function = smu_i2c_retry;
585 smu->i2c_timer.data = (unsigned long)smu;
587 if (smu->db_node) {
588 smu->db_irq = irq_of_parse_and_map(smu->db_node, 0);
589 if (smu->db_irq == NO_IRQ)
590 printk(KERN_ERR "smu: failed to map irq for node %s\n",
591 smu->db_node->full_name);
593 if (smu->msg_node) {
594 smu->msg_irq = irq_of_parse_and_map(smu->msg_node, 0);
595 if (smu->msg_irq == NO_IRQ)
596 printk(KERN_ERR "smu: failed to map irq for node %s\n",
597 smu->msg_node->full_name);
601 * Try to request the interrupts
604 if (smu->db_irq != NO_IRQ) {
605 if (request_irq(smu->db_irq, smu_db_intr,
606 IRQF_SHARED, "SMU doorbell", smu) < 0) {
607 printk(KERN_WARNING "SMU: can't "
608 "request interrupt %d\n",
609 smu->db_irq);
610 smu->db_irq = NO_IRQ;
614 if (smu->msg_irq != NO_IRQ) {
615 if (request_irq(smu->msg_irq, smu_msg_intr,
616 IRQF_SHARED, "SMU message", smu) < 0) {
617 printk(KERN_WARNING "SMU: can't "
618 "request interrupt %d\n",
619 smu->msg_irq);
620 smu->msg_irq = NO_IRQ;
624 smu_irq_inited = 1;
625 return 0;
627 /* This has to be before arch_initcall as the low i2c stuff relies on the
628 * above having been done before we reach arch_initcalls
630 core_initcall(smu_late_init);
633 * sysfs visibility
636 static void smu_expose_childs(struct work_struct *unused)
638 struct device_node *np;
640 for (np = NULL; (np = of_get_next_child(smu->of_node, np)) != NULL;)
641 if (of_device_is_compatible(np, "smu-sensors"))
642 of_platform_device_create(np, "smu-sensors",
643 &smu->of_dev->dev);
646 static DECLARE_WORK(smu_expose_childs_work, smu_expose_childs);
648 static int smu_platform_probe(struct of_device* dev,
649 const struct of_device_id *match)
651 if (!smu)
652 return -ENODEV;
653 smu->of_dev = dev;
656 * Ok, we are matched, now expose all i2c busses. We have to defer
657 * that unfortunately or it would deadlock inside the device model
659 schedule_work(&smu_expose_childs_work);
661 return 0;
664 static const struct of_device_id smu_platform_match[] =
667 .type = "smu",
672 static struct of_platform_driver smu_of_platform_driver =
674 .driver = {
675 .name = "smu",
676 .owner = THIS_MODULE,
677 .of_match_table = smu_platform_match,
679 .probe = smu_platform_probe,
682 static int __init smu_init_sysfs(void)
685 * Due to sysfs bogosity, a sysdev is not a real device, so
686 * we should in fact create both if we want sysdev semantics
687 * for power management.
688 * For now, we don't power manage machines with an SMU chip,
689 * I'm a bit too far from figuring out how that works with those
690 * new chipsets, but that will come back and bite us
692 of_register_platform_driver(&smu_of_platform_driver);
693 return 0;
696 device_initcall(smu_init_sysfs);
698 struct of_device *smu_get_ofdev(void)
700 if (!smu)
701 return NULL;
702 return smu->of_dev;
705 EXPORT_SYMBOL_GPL(smu_get_ofdev);
708 * i2c interface
711 static void smu_i2c_complete_command(struct smu_i2c_cmd *cmd, int fail)
713 void (*done)(struct smu_i2c_cmd *cmd, void *misc) = cmd->done;
714 void *misc = cmd->misc;
715 unsigned long flags;
717 /* Check for read case */
718 if (!fail && cmd->read) {
719 if (cmd->pdata[0] < 1)
720 fail = 1;
721 else
722 memcpy(cmd->info.data, &cmd->pdata[1],
723 cmd->info.datalen);
726 DPRINTK("SMU: completing, success: %d\n", !fail);
728 /* Update status and mark no pending i2c command with lock
729 * held so nobody comes in while we dequeue an eventual
730 * pending next i2c command
732 spin_lock_irqsave(&smu->lock, flags);
733 smu->cmd_i2c_cur = NULL;
734 wmb();
735 cmd->status = fail ? -EIO : 0;
737 /* Is there another i2c command waiting ? */
738 if (!list_empty(&smu->cmd_i2c_list)) {
739 struct smu_i2c_cmd *newcmd;
741 /* Fetch it, new current, remove from list */
742 newcmd = list_entry(smu->cmd_i2c_list.next,
743 struct smu_i2c_cmd, link);
744 smu->cmd_i2c_cur = newcmd;
745 list_del(&cmd->link);
747 /* Queue with low level smu */
748 list_add_tail(&cmd->scmd.link, &smu->cmd_list);
749 if (smu->cmd_cur == NULL)
750 smu_start_cmd();
752 spin_unlock_irqrestore(&smu->lock, flags);
754 /* Call command completion handler if any */
755 if (done)
756 done(cmd, misc);
761 static void smu_i2c_retry(unsigned long data)
763 struct smu_i2c_cmd *cmd = smu->cmd_i2c_cur;
765 DPRINTK("SMU: i2c failure, requeuing...\n");
767 /* requeue command simply by resetting reply_len */
768 cmd->pdata[0] = 0xff;
769 cmd->scmd.reply_len = sizeof(cmd->pdata);
770 smu_queue_cmd(&cmd->scmd);
774 static void smu_i2c_low_completion(struct smu_cmd *scmd, void *misc)
776 struct smu_i2c_cmd *cmd = misc;
777 int fail = 0;
779 DPRINTK("SMU: i2c compl. stage=%d status=%x pdata[0]=%x rlen: %x\n",
780 cmd->stage, scmd->status, cmd->pdata[0], scmd->reply_len);
782 /* Check for possible status */
783 if (scmd->status < 0)
784 fail = 1;
785 else if (cmd->read) {
786 if (cmd->stage == 0)
787 fail = cmd->pdata[0] != 0;
788 else
789 fail = cmd->pdata[0] >= 0x80;
790 } else {
791 fail = cmd->pdata[0] != 0;
794 /* Handle failures by requeuing command, after 5ms interval
796 if (fail && --cmd->retries > 0) {
797 DPRINTK("SMU: i2c failure, starting timer...\n");
798 BUG_ON(cmd != smu->cmd_i2c_cur);
799 if (!smu_irq_inited) {
800 mdelay(5);
801 smu_i2c_retry(0);
802 return;
804 mod_timer(&smu->i2c_timer, jiffies + msecs_to_jiffies(5));
805 return;
808 /* If failure or stage 1, command is complete */
809 if (fail || cmd->stage != 0) {
810 smu_i2c_complete_command(cmd, fail);
811 return;
814 DPRINTK("SMU: going to stage 1\n");
816 /* Ok, initial command complete, now poll status */
817 scmd->reply_buf = cmd->pdata;
818 scmd->reply_len = sizeof(cmd->pdata);
819 scmd->data_buf = cmd->pdata;
820 scmd->data_len = 1;
821 cmd->pdata[0] = 0;
822 cmd->stage = 1;
823 cmd->retries = 20;
824 smu_queue_cmd(scmd);
828 int smu_queue_i2c(struct smu_i2c_cmd *cmd)
830 unsigned long flags;
832 if (smu == NULL)
833 return -ENODEV;
835 /* Fill most fields of scmd */
836 cmd->scmd.cmd = SMU_CMD_I2C_COMMAND;
837 cmd->scmd.done = smu_i2c_low_completion;
838 cmd->scmd.misc = cmd;
839 cmd->scmd.reply_buf = cmd->pdata;
840 cmd->scmd.reply_len = sizeof(cmd->pdata);
841 cmd->scmd.data_buf = (u8 *)(char *)&cmd->info;
842 cmd->scmd.status = 1;
843 cmd->stage = 0;
844 cmd->pdata[0] = 0xff;
845 cmd->retries = 20;
846 cmd->status = 1;
848 /* Check transfer type, sanitize some "info" fields
849 * based on transfer type and do more checking
851 cmd->info.caddr = cmd->info.devaddr;
852 cmd->read = cmd->info.devaddr & 0x01;
853 switch(cmd->info.type) {
854 case SMU_I2C_TRANSFER_SIMPLE:
855 memset(&cmd->info.sublen, 0, 4);
856 break;
857 case SMU_I2C_TRANSFER_COMBINED:
858 cmd->info.devaddr &= 0xfe;
859 case SMU_I2C_TRANSFER_STDSUB:
860 if (cmd->info.sublen > 3)
861 return -EINVAL;
862 break;
863 default:
864 return -EINVAL;
867 /* Finish setting up command based on transfer direction
869 if (cmd->read) {
870 if (cmd->info.datalen > SMU_I2C_READ_MAX)
871 return -EINVAL;
872 memset(cmd->info.data, 0xff, cmd->info.datalen);
873 cmd->scmd.data_len = 9;
874 } else {
875 if (cmd->info.datalen > SMU_I2C_WRITE_MAX)
876 return -EINVAL;
877 cmd->scmd.data_len = 9 + cmd->info.datalen;
880 DPRINTK("SMU: i2c enqueuing command\n");
881 DPRINTK("SMU: %s, len=%d bus=%x addr=%x sub0=%x type=%x\n",
882 cmd->read ? "read" : "write", cmd->info.datalen,
883 cmd->info.bus, cmd->info.caddr,
884 cmd->info.subaddr[0], cmd->info.type);
887 /* Enqueue command in i2c list, and if empty, enqueue also in
888 * main command list
890 spin_lock_irqsave(&smu->lock, flags);
891 if (smu->cmd_i2c_cur == NULL) {
892 smu->cmd_i2c_cur = cmd;
893 list_add_tail(&cmd->scmd.link, &smu->cmd_list);
894 if (smu->cmd_cur == NULL)
895 smu_start_cmd();
896 } else
897 list_add_tail(&cmd->link, &smu->cmd_i2c_list);
898 spin_unlock_irqrestore(&smu->lock, flags);
900 return 0;
904 * Handling of "partitions"
907 static int smu_read_datablock(u8 *dest, unsigned int addr, unsigned int len)
909 DECLARE_COMPLETION_ONSTACK(comp);
910 unsigned int chunk;
911 struct smu_cmd cmd;
912 int rc;
913 u8 params[8];
915 /* We currently use a chunk size of 0xe. We could check the
916 * SMU firmware version and use bigger sizes though
918 chunk = 0xe;
920 while (len) {
921 unsigned int clen = min(len, chunk);
923 cmd.cmd = SMU_CMD_MISC_ee_COMMAND;
924 cmd.data_len = 7;
925 cmd.data_buf = params;
926 cmd.reply_len = chunk;
927 cmd.reply_buf = dest;
928 cmd.done = smu_done_complete;
929 cmd.misc = &comp;
930 params[0] = SMU_CMD_MISC_ee_GET_DATABLOCK_REC;
931 params[1] = 0x4;
932 *((u32 *)&params[2]) = addr;
933 params[6] = clen;
935 rc = smu_queue_cmd(&cmd);
936 if (rc)
937 return rc;
938 wait_for_completion(&comp);
939 if (cmd.status != 0)
940 return rc;
941 if (cmd.reply_len != clen) {
942 printk(KERN_DEBUG "SMU: short read in "
943 "smu_read_datablock, got: %d, want: %d\n",
944 cmd.reply_len, clen);
945 return -EIO;
947 len -= clen;
948 addr += clen;
949 dest += clen;
951 return 0;
954 static struct smu_sdbp_header *smu_create_sdb_partition(int id)
956 DECLARE_COMPLETION_ONSTACK(comp);
957 struct smu_simple_cmd cmd;
958 unsigned int addr, len, tlen;
959 struct smu_sdbp_header *hdr;
960 struct property *prop;
962 /* First query the partition info */
963 DPRINTK("SMU: Query partition infos ... (irq=%d)\n", smu->db_irq);
964 smu_queue_simple(&cmd, SMU_CMD_PARTITION_COMMAND, 2,
965 smu_done_complete, &comp,
966 SMU_CMD_PARTITION_LATEST, id);
967 wait_for_completion(&comp);
968 DPRINTK("SMU: done, status: %d, reply_len: %d\n",
969 cmd.cmd.status, cmd.cmd.reply_len);
971 /* Partition doesn't exist (or other error) */
972 if (cmd.cmd.status != 0 || cmd.cmd.reply_len != 6)
973 return NULL;
975 /* Fetch address and length from reply */
976 addr = *((u16 *)cmd.buffer);
977 len = cmd.buffer[3] << 2;
978 /* Calucluate total length to allocate, including the 17 bytes
979 * for "sdb-partition-XX" that we append at the end of the buffer
981 tlen = sizeof(struct property) + len + 18;
983 prop = kzalloc(tlen, GFP_KERNEL);
984 if (prop == NULL)
985 return NULL;
986 hdr = (struct smu_sdbp_header *)(prop + 1);
987 prop->name = ((char *)prop) + tlen - 18;
988 sprintf(prop->name, "sdb-partition-%02x", id);
989 prop->length = len;
990 prop->value = hdr;
991 prop->next = NULL;
993 /* Read the datablock */
994 if (smu_read_datablock((u8 *)hdr, addr, len)) {
995 printk(KERN_DEBUG "SMU: datablock read failed while reading "
996 "partition %02x !\n", id);
997 goto failure;
1000 /* Got it, check a few things and create the property */
1001 if (hdr->id != id) {
1002 printk(KERN_DEBUG "SMU: Reading partition %02x and got "
1003 "%02x !\n", id, hdr->id);
1004 goto failure;
1006 if (prom_add_property(smu->of_node, prop)) {
1007 printk(KERN_DEBUG "SMU: Failed creating sdb-partition-%02x "
1008 "property !\n", id);
1009 goto failure;
1012 return hdr;
1013 failure:
1014 kfree(prop);
1015 return NULL;
1018 /* Note: Only allowed to return error code in pointers (using ERR_PTR)
1019 * when interruptible is 1
1021 const struct smu_sdbp_header *__smu_get_sdb_partition(int id,
1022 unsigned int *size, int interruptible)
1024 char pname[32];
1025 const struct smu_sdbp_header *part;
1027 if (!smu)
1028 return NULL;
1030 sprintf(pname, "sdb-partition-%02x", id);
1032 DPRINTK("smu_get_sdb_partition(%02x)\n", id);
1034 if (interruptible) {
1035 int rc;
1036 rc = mutex_lock_interruptible(&smu_part_access);
1037 if (rc)
1038 return ERR_PTR(rc);
1039 } else
1040 mutex_lock(&smu_part_access);
1042 part = of_get_property(smu->of_node, pname, size);
1043 if (part == NULL) {
1044 DPRINTK("trying to extract from SMU ...\n");
1045 part = smu_create_sdb_partition(id);
1046 if (part != NULL && size)
1047 *size = part->len << 2;
1049 mutex_unlock(&smu_part_access);
1050 return part;
1053 const struct smu_sdbp_header *smu_get_sdb_partition(int id, unsigned int *size)
1055 return __smu_get_sdb_partition(id, size, 0);
1057 EXPORT_SYMBOL(smu_get_sdb_partition);
1061 * Userland driver interface
1065 static LIST_HEAD(smu_clist);
1066 static DEFINE_SPINLOCK(smu_clist_lock);
1068 enum smu_file_mode {
1069 smu_file_commands,
1070 smu_file_events,
1071 smu_file_closing
1074 struct smu_private
1076 struct list_head list;
1077 enum smu_file_mode mode;
1078 int busy;
1079 struct smu_cmd cmd;
1080 spinlock_t lock;
1081 wait_queue_head_t wait;
1082 u8 buffer[SMU_MAX_DATA];
1086 static int smu_open(struct inode *inode, struct file *file)
1088 struct smu_private *pp;
1089 unsigned long flags;
1091 pp = kzalloc(sizeof(struct smu_private), GFP_KERNEL);
1092 if (pp == 0)
1093 return -ENOMEM;
1094 spin_lock_init(&pp->lock);
1095 pp->mode = smu_file_commands;
1096 init_waitqueue_head(&pp->wait);
1098 lock_kernel();
1099 spin_lock_irqsave(&smu_clist_lock, flags);
1100 list_add(&pp->list, &smu_clist);
1101 spin_unlock_irqrestore(&smu_clist_lock, flags);
1102 file->private_data = pp;
1103 unlock_kernel();
1105 return 0;
1109 static void smu_user_cmd_done(struct smu_cmd *cmd, void *misc)
1111 struct smu_private *pp = misc;
1113 wake_up_all(&pp->wait);
1117 static ssize_t smu_write(struct file *file, const char __user *buf,
1118 size_t count, loff_t *ppos)
1120 struct smu_private *pp = file->private_data;
1121 unsigned long flags;
1122 struct smu_user_cmd_hdr hdr;
1123 int rc = 0;
1125 if (pp->busy)
1126 return -EBUSY;
1127 else if (copy_from_user(&hdr, buf, sizeof(hdr)))
1128 return -EFAULT;
1129 else if (hdr.cmdtype == SMU_CMDTYPE_WANTS_EVENTS) {
1130 pp->mode = smu_file_events;
1131 return 0;
1132 } else if (hdr.cmdtype == SMU_CMDTYPE_GET_PARTITION) {
1133 const struct smu_sdbp_header *part;
1134 part = __smu_get_sdb_partition(hdr.cmd, NULL, 1);
1135 if (part == NULL)
1136 return -EINVAL;
1137 else if (IS_ERR(part))
1138 return PTR_ERR(part);
1139 return 0;
1140 } else if (hdr.cmdtype != SMU_CMDTYPE_SMU)
1141 return -EINVAL;
1142 else if (pp->mode != smu_file_commands)
1143 return -EBADFD;
1144 else if (hdr.data_len > SMU_MAX_DATA)
1145 return -EINVAL;
1147 spin_lock_irqsave(&pp->lock, flags);
1148 if (pp->busy) {
1149 spin_unlock_irqrestore(&pp->lock, flags);
1150 return -EBUSY;
1152 pp->busy = 1;
1153 pp->cmd.status = 1;
1154 spin_unlock_irqrestore(&pp->lock, flags);
1156 if (copy_from_user(pp->buffer, buf + sizeof(hdr), hdr.data_len)) {
1157 pp->busy = 0;
1158 return -EFAULT;
1161 pp->cmd.cmd = hdr.cmd;
1162 pp->cmd.data_len = hdr.data_len;
1163 pp->cmd.reply_len = SMU_MAX_DATA;
1164 pp->cmd.data_buf = pp->buffer;
1165 pp->cmd.reply_buf = pp->buffer;
1166 pp->cmd.done = smu_user_cmd_done;
1167 pp->cmd.misc = pp;
1168 rc = smu_queue_cmd(&pp->cmd);
1169 if (rc < 0)
1170 return rc;
1171 return count;
1175 static ssize_t smu_read_command(struct file *file, struct smu_private *pp,
1176 char __user *buf, size_t count)
1178 DECLARE_WAITQUEUE(wait, current);
1179 struct smu_user_reply_hdr hdr;
1180 unsigned long flags;
1181 int size, rc = 0;
1183 if (!pp->busy)
1184 return 0;
1185 if (count < sizeof(struct smu_user_reply_hdr))
1186 return -EOVERFLOW;
1187 spin_lock_irqsave(&pp->lock, flags);
1188 if (pp->cmd.status == 1) {
1189 if (file->f_flags & O_NONBLOCK) {
1190 spin_unlock_irqrestore(&pp->lock, flags);
1191 return -EAGAIN;
1193 add_wait_queue(&pp->wait, &wait);
1194 for (;;) {
1195 set_current_state(TASK_INTERRUPTIBLE);
1196 rc = 0;
1197 if (pp->cmd.status != 1)
1198 break;
1199 rc = -ERESTARTSYS;
1200 if (signal_pending(current))
1201 break;
1202 spin_unlock_irqrestore(&pp->lock, flags);
1203 schedule();
1204 spin_lock_irqsave(&pp->lock, flags);
1206 set_current_state(TASK_RUNNING);
1207 remove_wait_queue(&pp->wait, &wait);
1209 spin_unlock_irqrestore(&pp->lock, flags);
1210 if (rc)
1211 return rc;
1212 if (pp->cmd.status != 0)
1213 pp->cmd.reply_len = 0;
1214 size = sizeof(hdr) + pp->cmd.reply_len;
1215 if (count < size)
1216 size = count;
1217 rc = size;
1218 hdr.status = pp->cmd.status;
1219 hdr.reply_len = pp->cmd.reply_len;
1220 if (copy_to_user(buf, &hdr, sizeof(hdr)))
1221 return -EFAULT;
1222 size -= sizeof(hdr);
1223 if (size && copy_to_user(buf + sizeof(hdr), pp->buffer, size))
1224 return -EFAULT;
1225 pp->busy = 0;
1227 return rc;
1231 static ssize_t smu_read_events(struct file *file, struct smu_private *pp,
1232 char __user *buf, size_t count)
1234 /* Not implemented */
1235 msleep_interruptible(1000);
1236 return 0;
1240 static ssize_t smu_read(struct file *file, char __user *buf,
1241 size_t count, loff_t *ppos)
1243 struct smu_private *pp = file->private_data;
1245 if (pp->mode == smu_file_commands)
1246 return smu_read_command(file, pp, buf, count);
1247 if (pp->mode == smu_file_events)
1248 return smu_read_events(file, pp, buf, count);
1250 return -EBADFD;
1253 static unsigned int smu_fpoll(struct file *file, poll_table *wait)
1255 struct smu_private *pp = file->private_data;
1256 unsigned int mask = 0;
1257 unsigned long flags;
1259 if (pp == 0)
1260 return 0;
1262 if (pp->mode == smu_file_commands) {
1263 poll_wait(file, &pp->wait, wait);
1265 spin_lock_irqsave(&pp->lock, flags);
1266 if (pp->busy && pp->cmd.status != 1)
1267 mask |= POLLIN;
1268 spin_unlock_irqrestore(&pp->lock, flags);
1269 } if (pp->mode == smu_file_events) {
1270 /* Not yet implemented */
1272 return mask;
1275 static int smu_release(struct inode *inode, struct file *file)
1277 struct smu_private *pp = file->private_data;
1278 unsigned long flags;
1279 unsigned int busy;
1281 if (pp == 0)
1282 return 0;
1284 file->private_data = NULL;
1286 /* Mark file as closing to avoid races with new request */
1287 spin_lock_irqsave(&pp->lock, flags);
1288 pp->mode = smu_file_closing;
1289 busy = pp->busy;
1291 /* Wait for any pending request to complete */
1292 if (busy && pp->cmd.status == 1) {
1293 DECLARE_WAITQUEUE(wait, current);
1295 add_wait_queue(&pp->wait, &wait);
1296 for (;;) {
1297 set_current_state(TASK_UNINTERRUPTIBLE);
1298 if (pp->cmd.status != 1)
1299 break;
1300 spin_unlock_irqrestore(&pp->lock, flags);
1301 schedule();
1302 spin_lock_irqsave(&pp->lock, flags);
1304 set_current_state(TASK_RUNNING);
1305 remove_wait_queue(&pp->wait, &wait);
1307 spin_unlock_irqrestore(&pp->lock, flags);
1309 spin_lock_irqsave(&smu_clist_lock, flags);
1310 list_del(&pp->list);
1311 spin_unlock_irqrestore(&smu_clist_lock, flags);
1312 kfree(pp);
1314 return 0;
1318 static const struct file_operations smu_device_fops = {
1319 .llseek = no_llseek,
1320 .read = smu_read,
1321 .write = smu_write,
1322 .poll = smu_fpoll,
1323 .open = smu_open,
1324 .release = smu_release,
1327 static struct miscdevice pmu_device = {
1328 MISC_DYNAMIC_MINOR, "smu", &smu_device_fops
1331 static int smu_device_init(void)
1333 if (!smu)
1334 return -ENODEV;
1335 if (misc_register(&pmu_device) < 0)
1336 printk(KERN_ERR "via-pmu: cannot register misc device.\n");
1337 return 0;
1339 device_initcall(smu_device_init);