1 /* linux/drivers/mfd/sm501.c
3 * Copyright (C) 2006 Simtec Electronics
4 * Ben Dooks <ben@simtec.co.uk>
5 * Vincent Sanders <vince@simtec.co.uk>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/delay.h>
17 #include <linux/init.h>
18 #include <linux/list.h>
19 #include <linux/device.h>
20 #include <linux/platform_device.h>
21 #include <linux/pci.h>
22 #include <linux/i2c-gpio.h>
24 #include <linux/sm501.h>
25 #include <linux/sm501-regs.h>
26 #include <linux/serial_8250.h>
31 struct list_head list;
32 struct platform_device pdev;
37 #ifdef CONFIG_MFD_SM501_GPIO
38 #include <linux/gpio.h>
40 struct sm501_gpio_chip {
41 struct gpio_chip gpio;
42 struct sm501_gpio *ourgpio; /* to get back to parent. */
43 void __iomem *regbase;
44 void __iomem *control; /* address of control reg. */
48 struct sm501_gpio_chip low;
49 struct sm501_gpio_chip high;
52 unsigned int registered : 1;
54 struct resource *regs_res;
58 /* no gpio support, empty definition for sm501_devdata. */
62 struct sm501_devdata {
64 struct mutex clock_lock;
65 struct list_head devices;
66 struct sm501_gpio gpio;
69 struct resource *io_res;
70 struct resource *mem_res;
71 struct resource *regs_claim;
72 struct sm501_platdata *platdata;
75 unsigned int in_suspend;
76 unsigned long pm_misc;
86 #define MHZ (1000 * 1000)
89 static const unsigned int div_tab[] = {
116 static unsigned long decode_div(unsigned long pll2, unsigned long val,
117 unsigned int lshft, unsigned int selbit,
123 return pll2 / div_tab[(val >> lshft) & mask];
126 #define fmt_freq(x) ((x) / MHZ), ((x) % MHZ), (x)
130 * Print out the current clock configuration for the device
133 static void sm501_dump_clk(struct sm501_devdata *sm)
135 unsigned long misct = readl(sm->regs + SM501_MISC_TIMING);
136 unsigned long pm0 = readl(sm->regs + SM501_POWER_MODE_0_CLOCK);
137 unsigned long pm1 = readl(sm->regs + SM501_POWER_MODE_1_CLOCK);
138 unsigned long pmc = readl(sm->regs + SM501_POWER_MODE_CONTROL);
139 unsigned long sdclk0, sdclk1;
140 unsigned long pll2 = 0;
142 switch (misct & 0x30) {
157 sdclk0 = (misct & (1<<12)) ? pll2 : 288 * MHZ;
158 sdclk0 /= div_tab[((misct >> 8) & 0xf)];
160 sdclk1 = (misct & (1<<20)) ? pll2 : 288 * MHZ;
161 sdclk1 /= div_tab[((misct >> 16) & 0xf)];
163 dev_dbg(sm->dev, "MISCT=%08lx, PM0=%08lx, PM1=%08lx\n",
166 dev_dbg(sm->dev, "PLL2 = %ld.%ld MHz (%ld), SDCLK0=%08lx, SDCLK1=%08lx\n",
167 fmt_freq(pll2), sdclk0, sdclk1);
169 dev_dbg(sm->dev, "SDRAM: PM0=%ld, PM1=%ld\n", sdclk0, sdclk1);
171 dev_dbg(sm->dev, "PM0[%c]: "
172 "P2 %ld.%ld MHz (%ld), V2 %ld.%ld (%ld), "
173 "M %ld.%ld (%ld), MX1 %ld.%ld (%ld)\n",
174 (pmc & 3 ) == 0 ? '*' : '-',
175 fmt_freq(decode_div(pll2, pm0, 24, 1<<29, 31)),
176 fmt_freq(decode_div(pll2, pm0, 16, 1<<20, 15)),
177 fmt_freq(decode_div(pll2, pm0, 8, 1<<12, 15)),
178 fmt_freq(decode_div(pll2, pm0, 0, 1<<4, 15)));
180 dev_dbg(sm->dev, "PM1[%c]: "
181 "P2 %ld.%ld MHz (%ld), V2 %ld.%ld (%ld), "
182 "M %ld.%ld (%ld), MX1 %ld.%ld (%ld)\n",
183 (pmc & 3 ) == 1 ? '*' : '-',
184 fmt_freq(decode_div(pll2, pm1, 24, 1<<29, 31)),
185 fmt_freq(decode_div(pll2, pm1, 16, 1<<20, 15)),
186 fmt_freq(decode_div(pll2, pm1, 8, 1<<12, 15)),
187 fmt_freq(decode_div(pll2, pm1, 0, 1<<4, 15)));
190 static void sm501_dump_regs(struct sm501_devdata *sm)
192 void __iomem *regs = sm->regs;
194 dev_info(sm->dev, "System Control %08x\n",
195 readl(regs + SM501_SYSTEM_CONTROL));
196 dev_info(sm->dev, "Misc Control %08x\n",
197 readl(regs + SM501_MISC_CONTROL));
198 dev_info(sm->dev, "GPIO Control Low %08x\n",
199 readl(regs + SM501_GPIO31_0_CONTROL));
200 dev_info(sm->dev, "GPIO Control Hi %08x\n",
201 readl(regs + SM501_GPIO63_32_CONTROL));
202 dev_info(sm->dev, "DRAM Control %08x\n",
203 readl(regs + SM501_DRAM_CONTROL));
204 dev_info(sm->dev, "Arbitration Ctrl %08x\n",
205 readl(regs + SM501_ARBTRTN_CONTROL));
206 dev_info(sm->dev, "Misc Timing %08x\n",
207 readl(regs + SM501_MISC_TIMING));
210 static void sm501_dump_gate(struct sm501_devdata *sm)
212 dev_info(sm->dev, "CurrentGate %08x\n",
213 readl(sm->regs + SM501_CURRENT_GATE));
214 dev_info(sm->dev, "CurrentClock %08x\n",
215 readl(sm->regs + SM501_CURRENT_CLOCK));
216 dev_info(sm->dev, "PowerModeControl %08x\n",
217 readl(sm->regs + SM501_POWER_MODE_CONTROL));
221 static inline void sm501_dump_gate(struct sm501_devdata *sm) { }
222 static inline void sm501_dump_regs(struct sm501_devdata *sm) { }
223 static inline void sm501_dump_clk(struct sm501_devdata *sm) { }
231 static void sm501_sync_regs(struct sm501_devdata *sm)
236 static inline void sm501_mdelay(struct sm501_devdata *sm, unsigned int delay)
238 /* during suspend/resume, we are currently not allowed to sleep,
239 * so change to using mdelay() instead of msleep() if we
240 * are in one of these paths */
248 /* sm501_misc_control
250 * alters the miscellaneous control parameters
253 int sm501_misc_control(struct device *dev,
254 unsigned long set, unsigned long clear)
256 struct sm501_devdata *sm = dev_get_drvdata(dev);
261 spin_lock_irqsave(&sm->reg_lock, save);
263 misc = readl(sm->regs + SM501_MISC_CONTROL);
264 to = (misc & ~clear) | set;
267 writel(to, sm->regs + SM501_MISC_CONTROL);
270 dev_dbg(sm->dev, "MISC_CONTROL %08lx\n", misc);
273 spin_unlock_irqrestore(&sm->reg_lock, save);
277 EXPORT_SYMBOL_GPL(sm501_misc_control);
281 * Modify a register in the SM501 which may be shared with other
285 unsigned long sm501_modify_reg(struct device *dev,
290 struct sm501_devdata *sm = dev_get_drvdata(dev);
294 spin_lock_irqsave(&sm->reg_lock, save);
296 data = readl(sm->regs + reg);
300 writel(data, sm->regs + reg);
303 spin_unlock_irqrestore(&sm->reg_lock, save);
308 EXPORT_SYMBOL_GPL(sm501_modify_reg);
312 * alters the power active gate to set specific units on or off
315 int sm501_unit_power(struct device *dev, unsigned int unit, unsigned int to)
317 struct sm501_devdata *sm = dev_get_drvdata(dev);
322 mutex_lock(&sm->clock_lock);
324 mode = readl(sm->regs + SM501_POWER_MODE_CONTROL);
325 gate = readl(sm->regs + SM501_CURRENT_GATE);
326 clock = readl(sm->regs + SM501_CURRENT_CLOCK);
328 mode &= 3; /* get current power mode */
330 if (unit >= ARRAY_SIZE(sm->unit_power)) {
331 dev_err(dev, "%s: bad unit %d\n", __func__, unit);
335 dev_dbg(sm->dev, "%s: unit %d, cur %d, to %d\n", __func__, unit,
336 sm->unit_power[unit], to);
338 if (to == 0 && sm->unit_power[unit] == 0) {
339 dev_err(sm->dev, "unit %d is already shutdown\n", unit);
343 sm->unit_power[unit] += to ? 1 : -1;
344 to = sm->unit_power[unit] ? 1 : 0;
347 if (gate & (1 << unit))
351 if (!(gate & (1 << unit)))
353 gate &= ~(1 << unit);
358 writel(gate, sm->regs + SM501_POWER_MODE_0_GATE);
359 writel(clock, sm->regs + SM501_POWER_MODE_0_CLOCK);
364 writel(gate, sm->regs + SM501_POWER_MODE_1_GATE);
365 writel(clock, sm->regs + SM501_POWER_MODE_1_CLOCK);
374 writel(mode, sm->regs + SM501_POWER_MODE_CONTROL);
377 dev_dbg(sm->dev, "gate %08lx, clock %08lx, mode %08lx\n",
380 sm501_mdelay(sm, 16);
383 mutex_unlock(&sm->clock_lock);
387 EXPORT_SYMBOL_GPL(sm501_unit_power);
390 /* Perform a rounded division. */
391 static long sm501fb_round_div(long num, long denom)
393 /* n / d + 1 / 2 = (2n + d) / 2d */
394 return (2 * num + denom) / (2 * denom);
397 /* clock value structure. */
402 unsigned int m, n, k;
407 * Calculates the nearest discrete clock frequency that
408 * can be achieved with the specified input clock.
409 * the maximum divisor is 3 or 5
412 static int sm501_calc_clock(unsigned long freq,
413 struct sm501_clock *clock,
423 /* try dividers 1 and 3 for CRT and for panel,
424 try divider 5 for panel only.*/
426 for (divider = 1; divider <= max_div; divider += 2) {
427 /* try all 8 shift values.*/
428 for (shift = 0; shift < 8; shift++) {
429 /* Calculate difference to requested clock */
430 diff = sm501fb_round_div(mclk, divider << shift) - freq;
434 /* If it is less than the current, use it */
435 if (diff < *best_diff) {
439 clock->divider = divider;
440 clock->shift = shift;
451 * Calculates the nearest discrete clock frequency that can be
452 * achieved using the programmable PLL.
453 * the maximum divisor is 3 or 5
456 static unsigned long sm501_calc_pll(unsigned long freq,
457 struct sm501_clock *clock,
461 unsigned int m, n, k;
462 long best_diff = 999999999;
465 * The SM502 datasheet doesn't specify the min/max values for M and N.
466 * N = 1 at least doesn't work in practice.
468 for (m = 2; m <= 255; m++) {
469 for (n = 2; n <= 127; n++) {
470 for (k = 0; k <= 1; k++) {
471 mclk = (24000000UL * m / n) >> k;
473 if (sm501_calc_clock(freq, clock, max_div,
483 /* Return best clock. */
484 return clock->mclk / (clock->divider << clock->shift);
487 /* sm501_select_clock
489 * Calculates the nearest discrete clock frequency that can be
490 * achieved using the 288MHz and 336MHz PLLs.
491 * the maximum divisor is 3 or 5
494 static unsigned long sm501_select_clock(unsigned long freq,
495 struct sm501_clock *clock,
499 long best_diff = 999999999;
501 /* Try 288MHz and 336MHz clocks. */
502 for (mclk = 288000000; mclk <= 336000000; mclk += 48000000) {
503 sm501_calc_clock(freq, clock, max_div, mclk, &best_diff);
506 /* Return best clock. */
507 return clock->mclk / (clock->divider << clock->shift);
512 * set one of the four clock sources to the closest available frequency to
516 unsigned long sm501_set_clock(struct device *dev,
518 unsigned long req_freq)
520 struct sm501_devdata *sm = dev_get_drvdata(dev);
521 unsigned long mode = readl(sm->regs + SM501_POWER_MODE_CONTROL);
522 unsigned long gate = readl(sm->regs + SM501_CURRENT_GATE);
523 unsigned long clock = readl(sm->regs + SM501_CURRENT_CLOCK);
525 unsigned int pll_reg = 0;
526 unsigned long sm501_freq; /* the actual frequency acheived */
528 struct sm501_clock to;
530 /* find achivable discrete frequency and setup register value
531 * accordingly, V2XCLK, MCLK and M1XCLK are the same P2XCLK
532 * has an extra bit for the divider */
535 case SM501_CLOCK_P2XCLK:
536 /* This clock is divided in half so to achive the
537 * requested frequency the value must be multiplied by
538 * 2. This clock also has an additional pre divisor */
540 if (sm->rev >= 0xC0) {
541 /* SM502 -> use the programmable PLL */
542 sm501_freq = (sm501_calc_pll(2 * req_freq,
544 reg = to.shift & 0x07;/* bottom 3 bits are shift */
546 reg |= 0x08; /* /3 divider required */
547 else if (to.divider == 5)
548 reg |= 0x10; /* /5 divider required */
549 reg |= 0x40; /* select the programmable PLL */
550 pll_reg = 0x20000 | (to.k << 15) | (to.n << 8) | to.m;
552 sm501_freq = (sm501_select_clock(2 * req_freq,
554 reg = to.shift & 0x07;/* bottom 3 bits are shift */
556 reg |= 0x08; /* /3 divider required */
557 else if (to.divider == 5)
558 reg |= 0x10; /* /5 divider required */
559 if (to.mclk != 288000000)
560 reg |= 0x20; /* which mclk pll is source */
564 case SM501_CLOCK_V2XCLK:
565 /* This clock is divided in half so to achive the
566 * requested frequency the value must be multiplied by 2. */
568 sm501_freq = (sm501_select_clock(2 * req_freq, &to, 3) / 2);
569 reg=to.shift & 0x07; /* bottom 3 bits are shift */
571 reg |= 0x08; /* /3 divider required */
572 if (to.mclk != 288000000)
573 reg |= 0x10; /* which mclk pll is source */
576 case SM501_CLOCK_MCLK:
577 case SM501_CLOCK_M1XCLK:
578 /* These clocks are the same and not further divided */
580 sm501_freq = sm501_select_clock( req_freq, &to, 3);
581 reg=to.shift & 0x07; /* bottom 3 bits are shift */
583 reg |= 0x08; /* /3 divider required */
584 if (to.mclk != 288000000)
585 reg |= 0x10; /* which mclk pll is source */
589 return 0; /* this is bad */
592 mutex_lock(&sm->clock_lock);
594 mode = readl(sm->regs + SM501_POWER_MODE_CONTROL);
595 gate = readl(sm->regs + SM501_CURRENT_GATE);
596 clock = readl(sm->regs + SM501_CURRENT_CLOCK);
598 clock = clock & ~(0xFF << clksrc);
599 clock |= reg<<clksrc;
601 mode &= 3; /* find current mode */
605 writel(gate, sm->regs + SM501_POWER_MODE_0_GATE);
606 writel(clock, sm->regs + SM501_POWER_MODE_0_CLOCK);
611 writel(gate, sm->regs + SM501_POWER_MODE_1_GATE);
612 writel(clock, sm->regs + SM501_POWER_MODE_1_CLOCK);
617 mutex_unlock(&sm->clock_lock);
621 writel(mode, sm->regs + SM501_POWER_MODE_CONTROL);
624 writel(pll_reg, sm->regs + SM501_PROGRAMMABLE_PLL_CONTROL);
628 dev_dbg(sm->dev, "gate %08lx, clock %08lx, mode %08lx\n",
631 sm501_mdelay(sm, 16);
632 mutex_unlock(&sm->clock_lock);
639 EXPORT_SYMBOL_GPL(sm501_set_clock);
643 * finds the closest available frequency for a given clock
646 unsigned long sm501_find_clock(struct device *dev,
648 unsigned long req_freq)
650 struct sm501_devdata *sm = dev_get_drvdata(dev);
651 unsigned long sm501_freq; /* the frequency achiveable by the 501 */
652 struct sm501_clock to;
655 case SM501_CLOCK_P2XCLK:
656 if (sm->rev >= 0xC0) {
657 /* SM502 -> use the programmable PLL */
658 sm501_freq = (sm501_calc_pll(2 * req_freq,
661 sm501_freq = (sm501_select_clock(2 * req_freq,
666 case SM501_CLOCK_V2XCLK:
667 sm501_freq = (sm501_select_clock(2 * req_freq, &to, 3) / 2);
670 case SM501_CLOCK_MCLK:
671 case SM501_CLOCK_M1XCLK:
672 sm501_freq = sm501_select_clock(req_freq, &to, 3);
676 sm501_freq = 0; /* error */
682 EXPORT_SYMBOL_GPL(sm501_find_clock);
684 static struct sm501_device *to_sm_device(struct platform_device *pdev)
686 return container_of(pdev, struct sm501_device, pdev);
689 /* sm501_device_release
691 * A release function for the platform devices we create to allow us to
692 * free any items we allocated
695 static void sm501_device_release(struct device *dev)
697 kfree(to_sm_device(to_platform_device(dev)));
700 /* sm501_create_subdev
702 * Create a skeleton platform device with resources for passing to a
706 static struct platform_device *
707 sm501_create_subdev(struct sm501_devdata *sm, char *name,
708 unsigned int res_count, unsigned int platform_data_size)
710 struct sm501_device *smdev;
712 smdev = kzalloc(sizeof(struct sm501_device) +
713 (sizeof(struct resource) * res_count) +
714 platform_data_size, GFP_KERNEL);
718 smdev->pdev.dev.release = sm501_device_release;
720 smdev->pdev.name = name;
721 smdev->pdev.id = sm->pdev_id;
722 smdev->pdev.dev.parent = sm->dev;
725 smdev->pdev.resource = (struct resource *)(smdev+1);
726 smdev->pdev.num_resources = res_count;
728 if (platform_data_size)
729 smdev->pdev.dev.platform_data = (void *)(smdev+1);
734 /* sm501_register_device
736 * Register a platform device created with sm501_create_subdev()
739 static int sm501_register_device(struct sm501_devdata *sm,
740 struct platform_device *pdev)
742 struct sm501_device *smdev = to_sm_device(pdev);
746 for (ptr = 0; ptr < pdev->num_resources; ptr++) {
747 printk(KERN_DEBUG "%s[%d] flags %08lx: %08llx..%08llx\n",
749 pdev->resource[ptr].flags,
750 (unsigned long long)pdev->resource[ptr].start,
751 (unsigned long long)pdev->resource[ptr].end);
754 ret = platform_device_register(pdev);
757 dev_dbg(sm->dev, "registered %s\n", pdev->name);
758 list_add_tail(&smdev->list, &sm->devices);
760 dev_err(sm->dev, "error registering %s (%d)\n",
766 /* sm501_create_subio
768 * Fill in an IO resource for a sub device
771 static void sm501_create_subio(struct sm501_devdata *sm,
772 struct resource *res,
773 resource_size_t offs,
774 resource_size_t size)
776 res->flags = IORESOURCE_MEM;
777 res->parent = sm->io_res;
778 res->start = sm->io_res->start + offs;
779 res->end = res->start + size - 1;
784 * Fill in an MEM resource for a sub device
787 static void sm501_create_mem(struct sm501_devdata *sm,
788 struct resource *res,
789 resource_size_t *offs,
790 resource_size_t size)
792 *offs -= size; /* adjust memory size */
794 res->flags = IORESOURCE_MEM;
795 res->parent = sm->mem_res;
796 res->start = sm->mem_res->start + *offs;
797 res->end = res->start + size - 1;
802 * Fill in an IRQ resource for a sub device
805 static void sm501_create_irq(struct sm501_devdata *sm,
806 struct resource *res)
808 res->flags = IORESOURCE_IRQ;
810 res->start = res->end = sm->irq;
813 static int sm501_register_usbhost(struct sm501_devdata *sm,
814 resource_size_t *mem_avail)
816 struct platform_device *pdev;
818 pdev = sm501_create_subdev(sm, "sm501-usb", 3, 0);
822 sm501_create_subio(sm, &pdev->resource[0], 0x40000, 0x20000);
823 sm501_create_mem(sm, &pdev->resource[1], mem_avail, 256*1024);
824 sm501_create_irq(sm, &pdev->resource[2]);
826 return sm501_register_device(sm, pdev);
829 static void sm501_setup_uart_data(struct sm501_devdata *sm,
830 struct plat_serial8250_port *uart_data,
833 uart_data->membase = sm->regs + offset;
834 uart_data->mapbase = sm->io_res->start + offset;
835 uart_data->iotype = UPIO_MEM;
836 uart_data->irq = sm->irq;
837 uart_data->flags = UPF_BOOT_AUTOCONF | UPF_SKIP_TEST | UPF_SHARE_IRQ;
838 uart_data->regshift = 2;
839 uart_data->uartclk = (9600 * 16);
842 static int sm501_register_uart(struct sm501_devdata *sm, int devices)
844 struct platform_device *pdev;
845 struct plat_serial8250_port *uart_data;
847 pdev = sm501_create_subdev(sm, "serial8250", 0,
848 sizeof(struct plat_serial8250_port) * 3);
852 uart_data = pdev->dev.platform_data;
854 if (devices & SM501_USE_UART0) {
855 sm501_setup_uart_data(sm, uart_data++, 0x30000);
856 sm501_unit_power(sm->dev, SM501_GATE_UART0, 1);
857 sm501_modify_reg(sm->dev, SM501_IRQ_MASK, 1 << 12, 0);
858 sm501_modify_reg(sm->dev, SM501_GPIO63_32_CONTROL, 0x01e0, 0);
860 if (devices & SM501_USE_UART1) {
861 sm501_setup_uart_data(sm, uart_data++, 0x30020);
862 sm501_unit_power(sm->dev, SM501_GATE_UART1, 1);
863 sm501_modify_reg(sm->dev, SM501_IRQ_MASK, 1 << 13, 0);
864 sm501_modify_reg(sm->dev, SM501_GPIO63_32_CONTROL, 0x1e00, 0);
867 pdev->id = PLAT8250_DEV_SM501;
869 return sm501_register_device(sm, pdev);
872 static int sm501_register_display(struct sm501_devdata *sm,
873 resource_size_t *mem_avail)
875 struct platform_device *pdev;
877 pdev = sm501_create_subdev(sm, "sm501-fb", 4, 0);
881 sm501_create_subio(sm, &pdev->resource[0], 0x80000, 0x10000);
882 sm501_create_subio(sm, &pdev->resource[1], 0x100000, 0x50000);
883 sm501_create_mem(sm, &pdev->resource[2], mem_avail, *mem_avail);
884 sm501_create_irq(sm, &pdev->resource[3]);
886 return sm501_register_device(sm, pdev);
889 #ifdef CONFIG_MFD_SM501_GPIO
891 static inline struct sm501_gpio_chip *to_sm501_gpio(struct gpio_chip *gc)
893 return container_of(gc, struct sm501_gpio_chip, gpio);
896 static inline struct sm501_devdata *sm501_gpio_to_dev(struct sm501_gpio *gpio)
898 return container_of(gpio, struct sm501_devdata, gpio);
901 static int sm501_gpio_get(struct gpio_chip *chip, unsigned offset)
904 struct sm501_gpio_chip *smgpio = to_sm501_gpio(chip);
905 unsigned long result;
907 result = readl(smgpio->regbase + SM501_GPIO_DATA_LOW);
913 static void sm501_gpio_ensure_gpio(struct sm501_gpio_chip *smchip,
918 /* check and modify if this pin is not set as gpio. */
920 if (readl(smchip->control) & bit) {
921 dev_info(sm501_gpio_to_dev(smchip->ourgpio)->dev,
922 "changing mode of gpio, bit %08lx\n", bit);
924 ctrl = readl(smchip->control);
926 writel(ctrl, smchip->control);
928 sm501_sync_regs(sm501_gpio_to_dev(smchip->ourgpio));
932 static void sm501_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
935 struct sm501_gpio_chip *smchip = to_sm501_gpio(chip);
936 struct sm501_gpio *smgpio = smchip->ourgpio;
937 unsigned long bit = 1 << offset;
938 void __iomem *regs = smchip->regbase;
942 dev_dbg(sm501_gpio_to_dev(smgpio)->dev, "%s(%p,%d)\n",
943 __func__, chip, offset);
945 spin_lock_irqsave(&smgpio->lock, save);
947 val = readl(regs + SM501_GPIO_DATA_LOW) & ~bit;
952 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
953 sm501_gpio_ensure_gpio(smchip, bit);
955 spin_unlock_irqrestore(&smgpio->lock, save);
958 static int sm501_gpio_input(struct gpio_chip *chip, unsigned offset)
960 struct sm501_gpio_chip *smchip = to_sm501_gpio(chip);
961 struct sm501_gpio *smgpio = smchip->ourgpio;
962 void __iomem *regs = smchip->regbase;
963 unsigned long bit = 1 << offset;
967 dev_dbg(sm501_gpio_to_dev(smgpio)->dev, "%s(%p,%d)\n",
968 __func__, chip, offset);
970 spin_lock_irqsave(&smgpio->lock, save);
972 ddr = readl(regs + SM501_GPIO_DDR_LOW);
973 writel(ddr & ~bit, regs + SM501_GPIO_DDR_LOW);
975 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
976 sm501_gpio_ensure_gpio(smchip, bit);
978 spin_unlock_irqrestore(&smgpio->lock, save);
983 static int sm501_gpio_output(struct gpio_chip *chip,
984 unsigned offset, int value)
986 struct sm501_gpio_chip *smchip = to_sm501_gpio(chip);
987 struct sm501_gpio *smgpio = smchip->ourgpio;
988 unsigned long bit = 1 << offset;
989 void __iomem *regs = smchip->regbase;
994 dev_dbg(sm501_gpio_to_dev(smgpio)->dev, "%s(%p,%d,%d)\n",
995 __func__, chip, offset, value);
997 spin_lock_irqsave(&smgpio->lock, save);
999 val = readl(regs + SM501_GPIO_DATA_LOW);
1006 ddr = readl(regs + SM501_GPIO_DDR_LOW);
1007 writel(ddr | bit, regs + SM501_GPIO_DDR_LOW);
1009 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
1010 writel(val, regs + SM501_GPIO_DATA_LOW);
1012 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
1013 spin_unlock_irqrestore(&smgpio->lock, save);
1018 static struct gpio_chip gpio_chip_template = {
1020 .direction_input = sm501_gpio_input,
1021 .direction_output = sm501_gpio_output,
1022 .set = sm501_gpio_set,
1023 .get = sm501_gpio_get,
1026 static int __devinit sm501_gpio_register_chip(struct sm501_devdata *sm,
1027 struct sm501_gpio *gpio,
1028 struct sm501_gpio_chip *chip)
1030 struct sm501_platdata *pdata = sm->platdata;
1031 struct gpio_chip *gchip = &chip->gpio;
1032 int base = pdata->gpio_base;
1034 chip->gpio = gpio_chip_template;
1036 if (chip == &gpio->high) {
1039 chip->regbase = gpio->regs + SM501_GPIO_DATA_HIGH;
1040 chip->control = sm->regs + SM501_GPIO63_32_CONTROL;
1041 gchip->label = "SM501-HIGH";
1043 chip->regbase = gpio->regs + SM501_GPIO_DATA_LOW;
1044 chip->control = sm->regs + SM501_GPIO31_0_CONTROL;
1045 gchip->label = "SM501-LOW";
1049 chip->ourgpio = gpio;
1051 return gpiochip_add(gchip);
1054 static int __devinit sm501_register_gpio(struct sm501_devdata *sm)
1056 struct sm501_gpio *gpio = &sm->gpio;
1057 resource_size_t iobase = sm->io_res->start + SM501_GPIO;
1061 dev_dbg(sm->dev, "registering gpio block %08llx\n",
1062 (unsigned long long)iobase);
1064 spin_lock_init(&gpio->lock);
1066 gpio->regs_res = request_mem_region(iobase, 0x20, "sm501-gpio");
1067 if (gpio->regs_res == NULL) {
1068 dev_err(sm->dev, "gpio: failed to request region\n");
1072 gpio->regs = ioremap(iobase, 0x20);
1073 if (gpio->regs == NULL) {
1074 dev_err(sm->dev, "gpio: failed to remap registers\n");
1079 /* Register both our chips. */
1081 ret = sm501_gpio_register_chip(sm, gpio, &gpio->low);
1083 dev_err(sm->dev, "failed to add low chip\n");
1087 ret = sm501_gpio_register_chip(sm, gpio, &gpio->high);
1089 dev_err(sm->dev, "failed to add high chip\n");
1093 gpio->registered = 1;
1098 tmp = gpiochip_remove(&gpio->low.gpio);
1100 dev_err(sm->dev, "cannot remove low chip, cannot tidy up\n");
1105 iounmap(gpio->regs);
1108 release_resource(gpio->regs_res);
1109 kfree(gpio->regs_res);
1114 static void sm501_gpio_remove(struct sm501_devdata *sm)
1116 struct sm501_gpio *gpio = &sm->gpio;
1119 if (!sm->gpio.registered)
1122 ret = gpiochip_remove(&gpio->low.gpio);
1124 dev_err(sm->dev, "cannot remove low chip, cannot tidy up\n");
1126 ret = gpiochip_remove(&gpio->high.gpio);
1128 dev_err(sm->dev, "cannot remove high chip, cannot tidy up\n");
1130 iounmap(gpio->regs);
1131 release_resource(gpio->regs_res);
1132 kfree(gpio->regs_res);
1135 static inline int sm501_gpio_pin2nr(struct sm501_devdata *sm, unsigned int pin)
1137 struct sm501_gpio *gpio = &sm->gpio;
1138 int base = (pin < 32) ? gpio->low.gpio.base : gpio->high.gpio.base;
1140 return (pin % 32) + base;
1143 static inline int sm501_gpio_isregistered(struct sm501_devdata *sm)
1145 return sm->gpio.registered;
1148 static inline int sm501_register_gpio(struct sm501_devdata *sm)
1153 static inline void sm501_gpio_remove(struct sm501_devdata *sm)
1157 static inline int sm501_gpio_pin2nr(struct sm501_devdata *sm, unsigned int pin)
1162 static inline int sm501_gpio_isregistered(struct sm501_devdata *sm)
1168 static int sm501_register_gpio_i2c_instance(struct sm501_devdata *sm,
1169 struct sm501_platdata_gpio_i2c *iic)
1171 struct i2c_gpio_platform_data *icd;
1172 struct platform_device *pdev;
1174 pdev = sm501_create_subdev(sm, "i2c-gpio", 0,
1175 sizeof(struct i2c_gpio_platform_data));
1179 icd = pdev->dev.platform_data;
1181 /* We keep the pin_sda and pin_scl fields relative in case the
1182 * same platform data is passed to >1 SM501.
1185 icd->sda_pin = sm501_gpio_pin2nr(sm, iic->pin_sda);
1186 icd->scl_pin = sm501_gpio_pin2nr(sm, iic->pin_scl);
1187 icd->timeout = iic->timeout;
1188 icd->udelay = iic->udelay;
1190 /* note, we can't use either of the pin numbers, as the i2c-gpio
1191 * driver uses the platform.id field to generate the bus number
1192 * to register with the i2c core; The i2c core doesn't have enough
1193 * entries to deal with anything we currently use.
1196 pdev->id = iic->bus_num;
1198 dev_info(sm->dev, "registering i2c-%d: sda=%d (%d), scl=%d (%d)\n",
1200 icd->sda_pin, iic->pin_sda, icd->scl_pin, iic->pin_scl);
1202 return sm501_register_device(sm, pdev);
1205 static int sm501_register_gpio_i2c(struct sm501_devdata *sm,
1206 struct sm501_platdata *pdata)
1208 struct sm501_platdata_gpio_i2c *iic = pdata->gpio_i2c;
1212 for (index = 0; index < pdata->gpio_i2c_nr; index++, iic++) {
1213 ret = sm501_register_gpio_i2c_instance(sm, iic);
1223 * Debug attribute to attach to parent device to show core registers
1226 static ssize_t sm501_dbg_regs(struct device *dev,
1227 struct device_attribute *attr, char *buff)
1229 struct sm501_devdata *sm = dev_get_drvdata(dev) ;
1234 for (reg = 0x00; reg < 0x70; reg += 4) {
1235 ret = sprintf(ptr, "%08x = %08x\n",
1236 reg, readl(sm->regs + reg));
1244 static DEVICE_ATTR(dbg_regs, 0666, sm501_dbg_regs, NULL);
1248 * Helper function for the init code to setup a register
1250 * clear the bits which are set in r->mask, and then set
1251 * the bits set in r->set.
1254 static inline void sm501_init_reg(struct sm501_devdata *sm,
1256 struct sm501_reg_init *r)
1260 tmp = readl(sm->regs + reg);
1263 writel(tmp, sm->regs + reg);
1268 * Setup core register values
1271 static void sm501_init_regs(struct sm501_devdata *sm,
1272 struct sm501_initdata *init)
1274 sm501_misc_control(sm->dev,
1275 init->misc_control.set,
1276 init->misc_control.mask);
1278 sm501_init_reg(sm, SM501_MISC_TIMING, &init->misc_timing);
1279 sm501_init_reg(sm, SM501_GPIO31_0_CONTROL, &init->gpio_low);
1280 sm501_init_reg(sm, SM501_GPIO63_32_CONTROL, &init->gpio_high);
1283 dev_info(sm->dev, "setting M1XCLK to %ld\n", init->m1xclk);
1284 sm501_set_clock(sm->dev, SM501_CLOCK_M1XCLK, init->m1xclk);
1288 dev_info(sm->dev, "setting MCLK to %ld\n", init->mclk);
1289 sm501_set_clock(sm->dev, SM501_CLOCK_MCLK, init->mclk);
1294 /* Check the PLL sources for the M1CLK and M1XCLK
1296 * If the M1CLK and M1XCLKs are not sourced from the same PLL, then
1297 * there is a risk (see errata AB-5) that the SM501 will cease proper
1298 * function. If this happens, then it is likely the SM501 will
1302 static int sm501_check_clocks(struct sm501_devdata *sm)
1304 unsigned long pwrmode = readl(sm->regs + SM501_CURRENT_CLOCK);
1305 unsigned long msrc = (pwrmode & SM501_POWERMODE_M_SRC);
1306 unsigned long m1src = (pwrmode & SM501_POWERMODE_M1_SRC);
1308 return ((msrc == 0 && m1src != 0) || (msrc != 0 && m1src == 0));
1311 static unsigned int sm501_mem_local[] = {
1322 * Common init code for an SM501
1325 static int __devinit sm501_init_dev(struct sm501_devdata *sm)
1327 struct sm501_initdata *idata;
1328 struct sm501_platdata *pdata;
1329 resource_size_t mem_avail;
1330 unsigned long dramctrl;
1331 unsigned long devid;
1334 mutex_init(&sm->clock_lock);
1335 spin_lock_init(&sm->reg_lock);
1337 INIT_LIST_HEAD(&sm->devices);
1339 devid = readl(sm->regs + SM501_DEVICEID);
1341 if ((devid & SM501_DEVICEID_IDMASK) != SM501_DEVICEID_SM501) {
1342 dev_err(sm->dev, "incorrect device id %08lx\n", devid);
1347 writel(0, sm->regs + SM501_IRQ_MASK);
1349 dramctrl = readl(sm->regs + SM501_DRAM_CONTROL);
1350 mem_avail = sm501_mem_local[(dramctrl >> 13) & 0x7];
1352 dev_info(sm->dev, "SM501 At %p: Version %08lx, %ld Mb, IRQ %d\n",
1353 sm->regs, devid, (unsigned long)mem_avail >> 20, sm->irq);
1355 sm->rev = devid & SM501_DEVICEID_REVMASK;
1357 sm501_dump_gate(sm);
1359 ret = device_create_file(sm->dev, &dev_attr_dbg_regs);
1361 dev_err(sm->dev, "failed to create debug regs file\n");
1365 /* check to see if we have some device initialisation */
1367 pdata = sm->platdata;
1368 idata = pdata ? pdata->init : NULL;
1371 sm501_init_regs(sm, idata);
1373 if (idata->devices & SM501_USE_USB_HOST)
1374 sm501_register_usbhost(sm, &mem_avail);
1375 if (idata->devices & (SM501_USE_UART0 | SM501_USE_UART1))
1376 sm501_register_uart(sm, idata->devices);
1377 if (idata->devices & SM501_USE_GPIO)
1378 sm501_register_gpio(sm);
1381 if (pdata->gpio_i2c != NULL && pdata->gpio_i2c_nr > 0) {
1382 if (!sm501_gpio_isregistered(sm))
1383 dev_err(sm->dev, "no gpio available for i2c gpio.\n");
1385 sm501_register_gpio_i2c(sm, pdata);
1388 ret = sm501_check_clocks(sm);
1390 dev_err(sm->dev, "M1X and M clocks sourced from different "
1395 /* always create a framebuffer */
1396 sm501_register_display(sm, &mem_avail);
1401 static int __devinit sm501_plat_probe(struct platform_device *dev)
1403 struct sm501_devdata *sm;
1406 sm = kzalloc(sizeof(struct sm501_devdata), GFP_KERNEL);
1408 dev_err(&dev->dev, "no memory for device data\n");
1413 sm->dev = &dev->dev;
1414 sm->pdev_id = dev->id;
1415 sm->platdata = dev->dev.platform_data;
1417 ret = platform_get_irq(dev, 0);
1419 dev_err(&dev->dev, "failed to get irq resource\n");
1424 sm->io_res = platform_get_resource(dev, IORESOURCE_MEM, 1);
1425 sm->mem_res = platform_get_resource(dev, IORESOURCE_MEM, 0);
1426 if (sm->io_res == NULL || sm->mem_res == NULL) {
1427 dev_err(&dev->dev, "failed to get IO resource\n");
1432 sm->regs_claim = request_mem_region(sm->io_res->start,
1435 if (sm->regs_claim == NULL) {
1436 dev_err(&dev->dev, "cannot claim registers\n");
1441 platform_set_drvdata(dev, sm);
1443 sm->regs = ioremap(sm->io_res->start,
1444 (sm->io_res->end - sm->io_res->start) - 1);
1446 if (sm->regs == NULL) {
1447 dev_err(&dev->dev, "cannot remap registers\n");
1452 return sm501_init_dev(sm);
1455 release_resource(sm->regs_claim);
1456 kfree(sm->regs_claim);
1466 /* power management support */
1468 static void sm501_set_power(struct sm501_devdata *sm, int on)
1470 struct sm501_platdata *pd = sm->platdata;
1475 if (pd->get_power) {
1476 if (pd->get_power(sm->dev) == on) {
1477 dev_dbg(sm->dev, "is already %d\n", on);
1482 if (pd->set_power) {
1483 dev_dbg(sm->dev, "setting power to %d\n", on);
1485 pd->set_power(sm->dev, on);
1486 sm501_mdelay(sm, 10);
1490 static int sm501_plat_suspend(struct platform_device *pdev, pm_message_t state)
1492 struct sm501_devdata *sm = platform_get_drvdata(pdev);
1495 sm->pm_misc = readl(sm->regs + SM501_MISC_CONTROL);
1497 sm501_dump_regs(sm);
1500 if (sm->platdata->flags & SM501_FLAG_SUSPEND_OFF)
1501 sm501_set_power(sm, 0);
1507 static int sm501_plat_resume(struct platform_device *pdev)
1509 struct sm501_devdata *sm = platform_get_drvdata(pdev);
1511 sm501_set_power(sm, 1);
1513 sm501_dump_regs(sm);
1514 sm501_dump_gate(sm);
1517 /* check to see if we are in the same state as when suspended */
1519 if (readl(sm->regs + SM501_MISC_CONTROL) != sm->pm_misc) {
1520 dev_info(sm->dev, "SM501_MISC_CONTROL changed over sleep\n");
1521 writel(sm->pm_misc, sm->regs + SM501_MISC_CONTROL);
1523 /* our suspend causes the controller state to change,
1524 * either by something attempting setup, power loss,
1525 * or an external reset event on power change */
1527 if (sm->platdata && sm->platdata->init) {
1528 sm501_init_regs(sm, sm->platdata->init);
1532 /* dump our state from resume */
1534 sm501_dump_regs(sm);
1542 #define sm501_plat_suspend NULL
1543 #define sm501_plat_resume NULL
1546 /* Initialisation data for PCI devices */
1548 static struct sm501_initdata sm501_pci_initdata = {
1550 .set = 0x3F000000, /* 24bit panel */
1554 .set = 0x010100, /* SDRAM timing */
1558 .set = SM501_MISC_PNL_24BIT,
1562 .devices = SM501_USE_ALL,
1564 /* Errata AB-3 says that 72MHz is the fastest available
1565 * for 33MHZ PCI with proper bus-mastering operation */
1568 .m1xclk = 144 * MHZ,
1571 static struct sm501_platdata_fbsub sm501_pdata_fbsub = {
1572 .flags = (SM501FB_FLAG_USE_INIT_MODE |
1573 SM501FB_FLAG_USE_HWCURSOR |
1574 SM501FB_FLAG_USE_HWACCEL |
1575 SM501FB_FLAG_DISABLE_AT_EXIT),
1578 static struct sm501_platdata_fb sm501_fb_pdata = {
1579 .fb_route = SM501_FB_OWN,
1580 .fb_crt = &sm501_pdata_fbsub,
1581 .fb_pnl = &sm501_pdata_fbsub,
1584 static struct sm501_platdata sm501_pci_platdata = {
1585 .init = &sm501_pci_initdata,
1586 .fb = &sm501_fb_pdata,
1590 static int __devinit sm501_pci_probe(struct pci_dev *dev,
1591 const struct pci_device_id *id)
1593 struct sm501_devdata *sm;
1596 sm = kzalloc(sizeof(struct sm501_devdata), GFP_KERNEL);
1598 dev_err(&dev->dev, "no memory for device data\n");
1603 /* set a default set of platform data */
1604 dev->dev.platform_data = sm->platdata = &sm501_pci_platdata;
1606 /* set a hopefully unique id for our child platform devices */
1607 sm->pdev_id = 32 + dev->devfn;
1609 pci_set_drvdata(dev, sm);
1611 err = pci_enable_device(dev);
1613 dev_err(&dev->dev, "cannot enable device\n");
1617 sm->dev = &dev->dev;
1621 /* if the system is big-endian, we most probably have a
1622 * translation in the IO layer making the PCI bus little endian
1623 * so make the framebuffer swapped pixels */
1625 sm501_fb_pdata.flags |= SM501_FBPD_SWAP_FB_ENDIAN;
1628 /* check our resources */
1630 if (!(pci_resource_flags(dev, 0) & IORESOURCE_MEM)) {
1631 dev_err(&dev->dev, "region #0 is not memory?\n");
1636 if (!(pci_resource_flags(dev, 1) & IORESOURCE_MEM)) {
1637 dev_err(&dev->dev, "region #1 is not memory?\n");
1642 /* make our resources ready for sharing */
1644 sm->io_res = &dev->resource[1];
1645 sm->mem_res = &dev->resource[0];
1647 sm->regs_claim = request_mem_region(sm->io_res->start,
1649 if (sm->regs_claim == NULL) {
1650 dev_err(&dev->dev, "cannot claim registers\n");
1655 sm->regs = pci_ioremap_bar(dev, 1);
1657 if (sm->regs == NULL) {
1658 dev_err(&dev->dev, "cannot remap registers\n");
1667 release_resource(sm->regs_claim);
1668 kfree(sm->regs_claim);
1670 pci_disable_device(dev);
1672 pci_set_drvdata(dev, NULL);
1678 static void sm501_remove_sub(struct sm501_devdata *sm,
1679 struct sm501_device *smdev)
1681 list_del(&smdev->list);
1682 platform_device_unregister(&smdev->pdev);
1685 static void sm501_dev_remove(struct sm501_devdata *sm)
1687 struct sm501_device *smdev, *tmp;
1689 list_for_each_entry_safe(smdev, tmp, &sm->devices, list)
1690 sm501_remove_sub(sm, smdev);
1692 device_remove_file(sm->dev, &dev_attr_dbg_regs);
1694 sm501_gpio_remove(sm);
1697 static void __devexit sm501_pci_remove(struct pci_dev *dev)
1699 struct sm501_devdata *sm = pci_get_drvdata(dev);
1701 sm501_dev_remove(sm);
1704 release_resource(sm->regs_claim);
1705 kfree(sm->regs_claim);
1707 pci_set_drvdata(dev, NULL);
1708 pci_disable_device(dev);
1711 static int sm501_plat_remove(struct platform_device *dev)
1713 struct sm501_devdata *sm = platform_get_drvdata(dev);
1715 sm501_dev_remove(sm);
1718 release_resource(sm->regs_claim);
1719 kfree(sm->regs_claim);
1724 static struct pci_device_id sm501_pci_tbl[] = {
1725 { 0x126f, 0x0501, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
1729 MODULE_DEVICE_TABLE(pci, sm501_pci_tbl);
1731 static struct pci_driver sm501_pci_driver = {
1733 .id_table = sm501_pci_tbl,
1734 .probe = sm501_pci_probe,
1735 .remove = __devexit_p(sm501_pci_remove),
1738 MODULE_ALIAS("platform:sm501");
1740 static struct platform_driver sm501_plat_driver = {
1743 .owner = THIS_MODULE,
1745 .probe = sm501_plat_probe,
1746 .remove = sm501_plat_remove,
1747 .suspend = sm501_plat_suspend,
1748 .resume = sm501_plat_resume,
1751 static int __init sm501_base_init(void)
1753 platform_driver_register(&sm501_plat_driver);
1754 return pci_register_driver(&sm501_pci_driver);
1757 static void __exit sm501_base_exit(void)
1759 platform_driver_unregister(&sm501_plat_driver);
1760 pci_unregister_driver(&sm501_pci_driver);
1763 module_init(sm501_base_init);
1764 module_exit(sm501_base_exit);
1766 MODULE_DESCRIPTION("SM501 Core Driver");
1767 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>, Vincent Sanders");
1768 MODULE_LICENSE("GPL v2");