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/platform_data/i2c-gpio.h>
23 #include <linux/gpio/machine.h>
24 #include <linux/slab.h>
26 #include <linux/sm501.h>
27 #include <linux/sm501-regs.h>
28 #include <linux/serial_8250.h>
33 struct list_head list;
34 struct platform_device pdev;
39 #ifdef CONFIG_MFD_SM501_GPIO
40 #include <linux/gpio.h>
42 struct sm501_gpio_chip {
43 struct gpio_chip gpio;
44 struct sm501_gpio *ourgpio; /* to get back to parent. */
45 void __iomem *regbase;
46 void __iomem *control; /* address of control reg. */
50 struct sm501_gpio_chip low;
51 struct sm501_gpio_chip high;
54 unsigned int registered : 1;
56 struct resource *regs_res;
60 /* no gpio support, empty definition for sm501_devdata. */
64 struct sm501_devdata {
66 struct mutex clock_lock;
67 struct list_head devices;
68 struct sm501_gpio gpio;
71 struct resource *io_res;
72 struct resource *mem_res;
73 struct resource *regs_claim;
74 struct sm501_platdata *platdata;
77 unsigned int in_suspend;
78 unsigned long pm_misc;
88 #define MHZ (1000 * 1000)
91 static const unsigned int div_tab[] = {
118 static unsigned long decode_div(unsigned long pll2, unsigned long val,
119 unsigned int lshft, unsigned int selbit,
125 return pll2 / div_tab[(val >> lshft) & mask];
128 #define fmt_freq(x) ((x) / MHZ), ((x) % MHZ), (x)
132 * Print out the current clock configuration for the device
135 static void sm501_dump_clk(struct sm501_devdata *sm)
137 unsigned long misct = smc501_readl(sm->regs + SM501_MISC_TIMING);
138 unsigned long pm0 = smc501_readl(sm->regs + SM501_POWER_MODE_0_CLOCK);
139 unsigned long pm1 = smc501_readl(sm->regs + SM501_POWER_MODE_1_CLOCK);
140 unsigned long pmc = smc501_readl(sm->regs + SM501_POWER_MODE_CONTROL);
141 unsigned long sdclk0, sdclk1;
142 unsigned long pll2 = 0;
144 switch (misct & 0x30) {
159 sdclk0 = (misct & (1<<12)) ? pll2 : 288 * MHZ;
160 sdclk0 /= div_tab[((misct >> 8) & 0xf)];
162 sdclk1 = (misct & (1<<20)) ? pll2 : 288 * MHZ;
163 sdclk1 /= div_tab[((misct >> 16) & 0xf)];
165 dev_dbg(sm->dev, "MISCT=%08lx, PM0=%08lx, PM1=%08lx\n",
168 dev_dbg(sm->dev, "PLL2 = %ld.%ld MHz (%ld), SDCLK0=%08lx, SDCLK1=%08lx\n",
169 fmt_freq(pll2), sdclk0, sdclk1);
171 dev_dbg(sm->dev, "SDRAM: PM0=%ld, PM1=%ld\n", sdclk0, sdclk1);
173 dev_dbg(sm->dev, "PM0[%c]: "
174 "P2 %ld.%ld MHz (%ld), V2 %ld.%ld (%ld), "
175 "M %ld.%ld (%ld), MX1 %ld.%ld (%ld)\n",
176 (pmc & 3 ) == 0 ? '*' : '-',
177 fmt_freq(decode_div(pll2, pm0, 24, 1<<29, 31)),
178 fmt_freq(decode_div(pll2, pm0, 16, 1<<20, 15)),
179 fmt_freq(decode_div(pll2, pm0, 8, 1<<12, 15)),
180 fmt_freq(decode_div(pll2, pm0, 0, 1<<4, 15)));
182 dev_dbg(sm->dev, "PM1[%c]: "
183 "P2 %ld.%ld MHz (%ld), V2 %ld.%ld (%ld), "
184 "M %ld.%ld (%ld), MX1 %ld.%ld (%ld)\n",
185 (pmc & 3 ) == 1 ? '*' : '-',
186 fmt_freq(decode_div(pll2, pm1, 24, 1<<29, 31)),
187 fmt_freq(decode_div(pll2, pm1, 16, 1<<20, 15)),
188 fmt_freq(decode_div(pll2, pm1, 8, 1<<12, 15)),
189 fmt_freq(decode_div(pll2, pm1, 0, 1<<4, 15)));
192 static void sm501_dump_regs(struct sm501_devdata *sm)
194 void __iomem *regs = sm->regs;
196 dev_info(sm->dev, "System Control %08x\n",
197 smc501_readl(regs + SM501_SYSTEM_CONTROL));
198 dev_info(sm->dev, "Misc Control %08x\n",
199 smc501_readl(regs + SM501_MISC_CONTROL));
200 dev_info(sm->dev, "GPIO Control Low %08x\n",
201 smc501_readl(regs + SM501_GPIO31_0_CONTROL));
202 dev_info(sm->dev, "GPIO Control Hi %08x\n",
203 smc501_readl(regs + SM501_GPIO63_32_CONTROL));
204 dev_info(sm->dev, "DRAM Control %08x\n",
205 smc501_readl(regs + SM501_DRAM_CONTROL));
206 dev_info(sm->dev, "Arbitration Ctrl %08x\n",
207 smc501_readl(regs + SM501_ARBTRTN_CONTROL));
208 dev_info(sm->dev, "Misc Timing %08x\n",
209 smc501_readl(regs + SM501_MISC_TIMING));
212 static void sm501_dump_gate(struct sm501_devdata *sm)
214 dev_info(sm->dev, "CurrentGate %08x\n",
215 smc501_readl(sm->regs + SM501_CURRENT_GATE));
216 dev_info(sm->dev, "CurrentClock %08x\n",
217 smc501_readl(sm->regs + SM501_CURRENT_CLOCK));
218 dev_info(sm->dev, "PowerModeControl %08x\n",
219 smc501_readl(sm->regs + SM501_POWER_MODE_CONTROL));
223 static inline void sm501_dump_gate(struct sm501_devdata *sm) { }
224 static inline void sm501_dump_regs(struct sm501_devdata *sm) { }
225 static inline void sm501_dump_clk(struct sm501_devdata *sm) { }
233 static void sm501_sync_regs(struct sm501_devdata *sm)
235 smc501_readl(sm->regs);
238 static inline void sm501_mdelay(struct sm501_devdata *sm, unsigned int delay)
240 /* during suspend/resume, we are currently not allowed to sleep,
241 * so change to using mdelay() instead of msleep() if we
242 * are in one of these paths */
250 /* sm501_misc_control
252 * alters the miscellaneous control parameters
255 int sm501_misc_control(struct device *dev,
256 unsigned long set, unsigned long clear)
258 struct sm501_devdata *sm = dev_get_drvdata(dev);
263 spin_lock_irqsave(&sm->reg_lock, save);
265 misc = smc501_readl(sm->regs + SM501_MISC_CONTROL);
266 to = (misc & ~clear) | set;
269 smc501_writel(to, sm->regs + SM501_MISC_CONTROL);
272 dev_dbg(sm->dev, "MISC_CONTROL %08lx\n", misc);
275 spin_unlock_irqrestore(&sm->reg_lock, save);
279 EXPORT_SYMBOL_GPL(sm501_misc_control);
283 * Modify a register in the SM501 which may be shared with other
287 unsigned long sm501_modify_reg(struct device *dev,
292 struct sm501_devdata *sm = dev_get_drvdata(dev);
296 spin_lock_irqsave(&sm->reg_lock, save);
298 data = smc501_readl(sm->regs + reg);
302 smc501_writel(data, sm->regs + reg);
305 spin_unlock_irqrestore(&sm->reg_lock, save);
310 EXPORT_SYMBOL_GPL(sm501_modify_reg);
314 * alters the power active gate to set specific units on or off
317 int sm501_unit_power(struct device *dev, unsigned int unit, unsigned int to)
319 struct sm501_devdata *sm = dev_get_drvdata(dev);
324 mutex_lock(&sm->clock_lock);
326 mode = smc501_readl(sm->regs + SM501_POWER_MODE_CONTROL);
327 gate = smc501_readl(sm->regs + SM501_CURRENT_GATE);
328 clock = smc501_readl(sm->regs + SM501_CURRENT_CLOCK);
330 mode &= 3; /* get current power mode */
332 if (unit >= ARRAY_SIZE(sm->unit_power)) {
333 dev_err(dev, "%s: bad unit %d\n", __func__, unit);
337 dev_dbg(sm->dev, "%s: unit %d, cur %d, to %d\n", __func__, unit,
338 sm->unit_power[unit], to);
340 if (to == 0 && sm->unit_power[unit] == 0) {
341 dev_err(sm->dev, "unit %d is already shutdown\n", unit);
345 sm->unit_power[unit] += to ? 1 : -1;
346 to = sm->unit_power[unit] ? 1 : 0;
349 if (gate & (1 << unit))
353 if (!(gate & (1 << unit)))
355 gate &= ~(1 << unit);
360 smc501_writel(gate, sm->regs + SM501_POWER_MODE_0_GATE);
361 smc501_writel(clock, sm->regs + SM501_POWER_MODE_0_CLOCK);
366 smc501_writel(gate, sm->regs + SM501_POWER_MODE_1_GATE);
367 smc501_writel(clock, sm->regs + SM501_POWER_MODE_1_CLOCK);
376 smc501_writel(mode, sm->regs + SM501_POWER_MODE_CONTROL);
379 dev_dbg(sm->dev, "gate %08lx, clock %08lx, mode %08lx\n",
382 sm501_mdelay(sm, 16);
385 mutex_unlock(&sm->clock_lock);
389 EXPORT_SYMBOL_GPL(sm501_unit_power);
391 /* clock value structure. */
396 unsigned int m, n, k;
401 * Calculates the nearest discrete clock frequency that
402 * can be achieved with the specified input clock.
403 * the maximum divisor is 3 or 5
406 static int sm501_calc_clock(unsigned long freq,
407 struct sm501_clock *clock,
417 /* try dividers 1 and 3 for CRT and for panel,
418 try divider 5 for panel only.*/
420 for (divider = 1; divider <= max_div; divider += 2) {
421 /* try all 8 shift values.*/
422 for (shift = 0; shift < 8; shift++) {
423 /* Calculate difference to requested clock */
424 diff = DIV_ROUND_CLOSEST(mclk, divider << shift) - freq;
428 /* If it is less than the current, use it */
429 if (diff < *best_diff) {
433 clock->divider = divider;
434 clock->shift = shift;
445 * Calculates the nearest discrete clock frequency that can be
446 * achieved using the programmable PLL.
447 * the maximum divisor is 3 or 5
450 static unsigned long sm501_calc_pll(unsigned long freq,
451 struct sm501_clock *clock,
455 unsigned int m, n, k;
456 long best_diff = 999999999;
459 * The SM502 datasheet doesn't specify the min/max values for M and N.
460 * N = 1 at least doesn't work in practice.
462 for (m = 2; m <= 255; m++) {
463 for (n = 2; n <= 127; n++) {
464 for (k = 0; k <= 1; k++) {
465 mclk = (24000000UL * m / n) >> k;
467 if (sm501_calc_clock(freq, clock, max_div,
477 /* Return best clock. */
478 return clock->mclk / (clock->divider << clock->shift);
481 /* sm501_select_clock
483 * Calculates the nearest discrete clock frequency that can be
484 * achieved using the 288MHz and 336MHz PLLs.
485 * the maximum divisor is 3 or 5
488 static unsigned long sm501_select_clock(unsigned long freq,
489 struct sm501_clock *clock,
493 long best_diff = 999999999;
495 /* Try 288MHz and 336MHz clocks. */
496 for (mclk = 288000000; mclk <= 336000000; mclk += 48000000) {
497 sm501_calc_clock(freq, clock, max_div, mclk, &best_diff);
500 /* Return best clock. */
501 return clock->mclk / (clock->divider << clock->shift);
506 * set one of the four clock sources to the closest available frequency to
510 unsigned long sm501_set_clock(struct device *dev,
512 unsigned long req_freq)
514 struct sm501_devdata *sm = dev_get_drvdata(dev);
515 unsigned long mode = smc501_readl(sm->regs + SM501_POWER_MODE_CONTROL);
516 unsigned long gate = smc501_readl(sm->regs + SM501_CURRENT_GATE);
517 unsigned long clock = smc501_readl(sm->regs + SM501_CURRENT_CLOCK);
518 unsigned int pll_reg = 0;
519 unsigned long sm501_freq; /* the actual frequency achieved */
522 struct sm501_clock to;
524 /* find achivable discrete frequency and setup register value
525 * accordingly, V2XCLK, MCLK and M1XCLK are the same P2XCLK
526 * has an extra bit for the divider */
529 case SM501_CLOCK_P2XCLK:
530 /* This clock is divided in half so to achieve the
531 * requested frequency the value must be multiplied by
532 * 2. This clock also has an additional pre divisor */
534 if (sm->rev >= 0xC0) {
535 /* SM502 -> use the programmable PLL */
536 sm501_freq = (sm501_calc_pll(2 * req_freq,
538 reg = to.shift & 0x07;/* bottom 3 bits are shift */
540 reg |= 0x08; /* /3 divider required */
541 else if (to.divider == 5)
542 reg |= 0x10; /* /5 divider required */
543 reg |= 0x40; /* select the programmable PLL */
544 pll_reg = 0x20000 | (to.k << 15) | (to.n << 8) | to.m;
546 sm501_freq = (sm501_select_clock(2 * req_freq,
548 reg = to.shift & 0x07;/* bottom 3 bits are shift */
550 reg |= 0x08; /* /3 divider required */
551 else if (to.divider == 5)
552 reg |= 0x10; /* /5 divider required */
553 if (to.mclk != 288000000)
554 reg |= 0x20; /* which mclk pll is source */
558 case SM501_CLOCK_V2XCLK:
559 /* This clock is divided in half so to achieve the
560 * requested frequency the value must be multiplied by 2. */
562 sm501_freq = (sm501_select_clock(2 * req_freq, &to, 3) / 2);
563 reg=to.shift & 0x07; /* bottom 3 bits are shift */
565 reg |= 0x08; /* /3 divider required */
566 if (to.mclk != 288000000)
567 reg |= 0x10; /* which mclk pll is source */
570 case SM501_CLOCK_MCLK:
571 case SM501_CLOCK_M1XCLK:
572 /* These clocks are the same and not further divided */
574 sm501_freq = sm501_select_clock( req_freq, &to, 3);
575 reg=to.shift & 0x07; /* bottom 3 bits are shift */
577 reg |= 0x08; /* /3 divider required */
578 if (to.mclk != 288000000)
579 reg |= 0x10; /* which mclk pll is source */
583 return 0; /* this is bad */
586 mutex_lock(&sm->clock_lock);
588 mode = smc501_readl(sm->regs + SM501_POWER_MODE_CONTROL);
589 gate = smc501_readl(sm->regs + SM501_CURRENT_GATE);
590 clock = smc501_readl(sm->regs + SM501_CURRENT_CLOCK);
592 clock = clock & ~(0xFF << clksrc);
593 clock |= reg<<clksrc;
595 mode &= 3; /* find current mode */
599 smc501_writel(gate, sm->regs + SM501_POWER_MODE_0_GATE);
600 smc501_writel(clock, sm->regs + SM501_POWER_MODE_0_CLOCK);
605 smc501_writel(gate, sm->regs + SM501_POWER_MODE_1_GATE);
606 smc501_writel(clock, sm->regs + SM501_POWER_MODE_1_CLOCK);
611 mutex_unlock(&sm->clock_lock);
615 smc501_writel(mode, sm->regs + SM501_POWER_MODE_CONTROL);
618 smc501_writel(pll_reg,
619 sm->regs + SM501_PROGRAMMABLE_PLL_CONTROL);
623 dev_dbg(sm->dev, "gate %08lx, clock %08lx, mode %08lx\n",
626 sm501_mdelay(sm, 16);
627 mutex_unlock(&sm->clock_lock);
634 EXPORT_SYMBOL_GPL(sm501_set_clock);
638 * finds the closest available frequency for a given clock
641 unsigned long sm501_find_clock(struct device *dev,
643 unsigned long req_freq)
645 struct sm501_devdata *sm = dev_get_drvdata(dev);
646 unsigned long sm501_freq; /* the frequency achieveable by the 501 */
647 struct sm501_clock to;
650 case SM501_CLOCK_P2XCLK:
651 if (sm->rev >= 0xC0) {
652 /* SM502 -> use the programmable PLL */
653 sm501_freq = (sm501_calc_pll(2 * req_freq,
656 sm501_freq = (sm501_select_clock(2 * req_freq,
661 case SM501_CLOCK_V2XCLK:
662 sm501_freq = (sm501_select_clock(2 * req_freq, &to, 3) / 2);
665 case SM501_CLOCK_MCLK:
666 case SM501_CLOCK_M1XCLK:
667 sm501_freq = sm501_select_clock(req_freq, &to, 3);
671 sm501_freq = 0; /* error */
677 EXPORT_SYMBOL_GPL(sm501_find_clock);
679 static struct sm501_device *to_sm_device(struct platform_device *pdev)
681 return container_of(pdev, struct sm501_device, pdev);
684 /* sm501_device_release
686 * A release function for the platform devices we create to allow us to
687 * free any items we allocated
690 static void sm501_device_release(struct device *dev)
692 kfree(to_sm_device(to_platform_device(dev)));
695 /* sm501_create_subdev
697 * Create a skeleton platform device with resources for passing to a
701 static struct platform_device *
702 sm501_create_subdev(struct sm501_devdata *sm, char *name,
703 unsigned int res_count, unsigned int platform_data_size)
705 struct sm501_device *smdev;
707 smdev = kzalloc(sizeof(struct sm501_device) +
708 (sizeof(struct resource) * res_count) +
709 platform_data_size, GFP_KERNEL);
713 smdev->pdev.dev.release = sm501_device_release;
715 smdev->pdev.name = name;
716 smdev->pdev.id = sm->pdev_id;
717 smdev->pdev.dev.parent = sm->dev;
718 smdev->pdev.dev.coherent_dma_mask = 0xffffffff;
721 smdev->pdev.resource = (struct resource *)(smdev+1);
722 smdev->pdev.num_resources = res_count;
724 if (platform_data_size)
725 smdev->pdev.dev.platform_data = (void *)(smdev+1);
730 /* sm501_register_device
732 * Register a platform device created with sm501_create_subdev()
735 static int sm501_register_device(struct sm501_devdata *sm,
736 struct platform_device *pdev)
738 struct sm501_device *smdev = to_sm_device(pdev);
742 for (ptr = 0; ptr < pdev->num_resources; ptr++) {
743 printk(KERN_DEBUG "%s[%d] %pR\n",
744 pdev->name, ptr, &pdev->resource[ptr]);
747 ret = platform_device_register(pdev);
750 dev_dbg(sm->dev, "registered %s\n", pdev->name);
751 list_add_tail(&smdev->list, &sm->devices);
753 dev_err(sm->dev, "error registering %s (%d)\n",
759 /* sm501_create_subio
761 * Fill in an IO resource for a sub device
764 static void sm501_create_subio(struct sm501_devdata *sm,
765 struct resource *res,
766 resource_size_t offs,
767 resource_size_t size)
769 res->flags = IORESOURCE_MEM;
770 res->parent = sm->io_res;
771 res->start = sm->io_res->start + offs;
772 res->end = res->start + size - 1;
777 * Fill in an MEM resource for a sub device
780 static void sm501_create_mem(struct sm501_devdata *sm,
781 struct resource *res,
782 resource_size_t *offs,
783 resource_size_t size)
785 *offs -= size; /* adjust memory size */
787 res->flags = IORESOURCE_MEM;
788 res->parent = sm->mem_res;
789 res->start = sm->mem_res->start + *offs;
790 res->end = res->start + size - 1;
795 * Fill in an IRQ resource for a sub device
798 static void sm501_create_irq(struct sm501_devdata *sm,
799 struct resource *res)
801 res->flags = IORESOURCE_IRQ;
803 res->start = res->end = sm->irq;
806 static int sm501_register_usbhost(struct sm501_devdata *sm,
807 resource_size_t *mem_avail)
809 struct platform_device *pdev;
811 pdev = sm501_create_subdev(sm, "sm501-usb", 3, 0);
815 sm501_create_subio(sm, &pdev->resource[0], 0x40000, 0x20000);
816 sm501_create_mem(sm, &pdev->resource[1], mem_avail, 256*1024);
817 sm501_create_irq(sm, &pdev->resource[2]);
819 return sm501_register_device(sm, pdev);
822 static void sm501_setup_uart_data(struct sm501_devdata *sm,
823 struct plat_serial8250_port *uart_data,
826 uart_data->membase = sm->regs + offset;
827 uart_data->mapbase = sm->io_res->start + offset;
828 uart_data->iotype = UPIO_MEM;
829 uart_data->irq = sm->irq;
830 uart_data->flags = UPF_BOOT_AUTOCONF | UPF_SKIP_TEST | UPF_SHARE_IRQ;
831 uart_data->regshift = 2;
832 uart_data->uartclk = (9600 * 16);
835 static int sm501_register_uart(struct sm501_devdata *sm, int devices)
837 struct platform_device *pdev;
838 struct plat_serial8250_port *uart_data;
840 pdev = sm501_create_subdev(sm, "serial8250", 0,
841 sizeof(struct plat_serial8250_port) * 3);
845 uart_data = dev_get_platdata(&pdev->dev);
847 if (devices & SM501_USE_UART0) {
848 sm501_setup_uart_data(sm, uart_data++, 0x30000);
849 sm501_unit_power(sm->dev, SM501_GATE_UART0, 1);
850 sm501_modify_reg(sm->dev, SM501_IRQ_MASK, 1 << 12, 0);
851 sm501_modify_reg(sm->dev, SM501_GPIO63_32_CONTROL, 0x01e0, 0);
853 if (devices & SM501_USE_UART1) {
854 sm501_setup_uart_data(sm, uart_data++, 0x30020);
855 sm501_unit_power(sm->dev, SM501_GATE_UART1, 1);
856 sm501_modify_reg(sm->dev, SM501_IRQ_MASK, 1 << 13, 0);
857 sm501_modify_reg(sm->dev, SM501_GPIO63_32_CONTROL, 0x1e00, 0);
860 pdev->id = PLAT8250_DEV_SM501;
862 return sm501_register_device(sm, pdev);
865 static int sm501_register_display(struct sm501_devdata *sm,
866 resource_size_t *mem_avail)
868 struct platform_device *pdev;
870 pdev = sm501_create_subdev(sm, "sm501-fb", 4, 0);
874 sm501_create_subio(sm, &pdev->resource[0], 0x80000, 0x10000);
875 sm501_create_subio(sm, &pdev->resource[1], 0x100000, 0x50000);
876 sm501_create_mem(sm, &pdev->resource[2], mem_avail, *mem_avail);
877 sm501_create_irq(sm, &pdev->resource[3]);
879 return sm501_register_device(sm, pdev);
882 #ifdef CONFIG_MFD_SM501_GPIO
884 static inline struct sm501_devdata *sm501_gpio_to_dev(struct sm501_gpio *gpio)
886 return container_of(gpio, struct sm501_devdata, gpio);
889 static int sm501_gpio_get(struct gpio_chip *chip, unsigned offset)
892 struct sm501_gpio_chip *smgpio = gpiochip_get_data(chip);
893 unsigned long result;
895 result = smc501_readl(smgpio->regbase + SM501_GPIO_DATA_LOW);
901 static void sm501_gpio_ensure_gpio(struct sm501_gpio_chip *smchip,
906 /* check and modify if this pin is not set as gpio. */
908 if (smc501_readl(smchip->control) & bit) {
909 dev_info(sm501_gpio_to_dev(smchip->ourgpio)->dev,
910 "changing mode of gpio, bit %08lx\n", bit);
912 ctrl = smc501_readl(smchip->control);
914 smc501_writel(ctrl, smchip->control);
916 sm501_sync_regs(sm501_gpio_to_dev(smchip->ourgpio));
920 static void sm501_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
923 struct sm501_gpio_chip *smchip = gpiochip_get_data(chip);
924 struct sm501_gpio *smgpio = smchip->ourgpio;
925 unsigned long bit = 1 << offset;
926 void __iomem *regs = smchip->regbase;
930 dev_dbg(sm501_gpio_to_dev(smgpio)->dev, "%s(%p,%d)\n",
931 __func__, chip, offset);
933 spin_lock_irqsave(&smgpio->lock, save);
935 val = smc501_readl(regs + SM501_GPIO_DATA_LOW) & ~bit;
938 smc501_writel(val, regs);
940 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
941 sm501_gpio_ensure_gpio(smchip, bit);
943 spin_unlock_irqrestore(&smgpio->lock, save);
946 static int sm501_gpio_input(struct gpio_chip *chip, unsigned offset)
948 struct sm501_gpio_chip *smchip = gpiochip_get_data(chip);
949 struct sm501_gpio *smgpio = smchip->ourgpio;
950 void __iomem *regs = smchip->regbase;
951 unsigned long bit = 1 << offset;
955 dev_dbg(sm501_gpio_to_dev(smgpio)->dev, "%s(%p,%d)\n",
956 __func__, chip, offset);
958 spin_lock_irqsave(&smgpio->lock, save);
960 ddr = smc501_readl(regs + SM501_GPIO_DDR_LOW);
961 smc501_writel(ddr & ~bit, regs + SM501_GPIO_DDR_LOW);
963 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
964 sm501_gpio_ensure_gpio(smchip, bit);
966 spin_unlock_irqrestore(&smgpio->lock, save);
971 static int sm501_gpio_output(struct gpio_chip *chip,
972 unsigned offset, int value)
974 struct sm501_gpio_chip *smchip = gpiochip_get_data(chip);
975 struct sm501_gpio *smgpio = smchip->ourgpio;
976 unsigned long bit = 1 << offset;
977 void __iomem *regs = smchip->regbase;
982 dev_dbg(sm501_gpio_to_dev(smgpio)->dev, "%s(%p,%d,%d)\n",
983 __func__, chip, offset, value);
985 spin_lock_irqsave(&smgpio->lock, save);
987 val = smc501_readl(regs + SM501_GPIO_DATA_LOW);
992 smc501_writel(val, regs);
994 ddr = smc501_readl(regs + SM501_GPIO_DDR_LOW);
995 smc501_writel(ddr | bit, regs + SM501_GPIO_DDR_LOW);
997 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
998 smc501_writel(val, regs + SM501_GPIO_DATA_LOW);
1000 sm501_sync_regs(sm501_gpio_to_dev(smgpio));
1001 spin_unlock_irqrestore(&smgpio->lock, save);
1006 static const struct gpio_chip gpio_chip_template = {
1008 .direction_input = sm501_gpio_input,
1009 .direction_output = sm501_gpio_output,
1010 .set = sm501_gpio_set,
1011 .get = sm501_gpio_get,
1014 static int sm501_gpio_register_chip(struct sm501_devdata *sm,
1015 struct sm501_gpio *gpio,
1016 struct sm501_gpio_chip *chip)
1018 struct sm501_platdata *pdata = sm->platdata;
1019 struct gpio_chip *gchip = &chip->gpio;
1020 int base = pdata->gpio_base;
1022 chip->gpio = gpio_chip_template;
1024 if (chip == &gpio->high) {
1027 chip->regbase = gpio->regs + SM501_GPIO_DATA_HIGH;
1028 chip->control = sm->regs + SM501_GPIO63_32_CONTROL;
1029 gchip->label = "SM501-HIGH";
1031 chip->regbase = gpio->regs + SM501_GPIO_DATA_LOW;
1032 chip->control = sm->regs + SM501_GPIO31_0_CONTROL;
1033 gchip->label = "SM501-LOW";
1037 chip->ourgpio = gpio;
1039 return gpiochip_add_data(gchip, chip);
1042 static int sm501_register_gpio(struct sm501_devdata *sm)
1044 struct sm501_gpio *gpio = &sm->gpio;
1045 resource_size_t iobase = sm->io_res->start + SM501_GPIO;
1048 dev_dbg(sm->dev, "registering gpio block %08llx\n",
1049 (unsigned long long)iobase);
1051 spin_lock_init(&gpio->lock);
1053 gpio->regs_res = request_mem_region(iobase, 0x20, "sm501-gpio");
1054 if (!gpio->regs_res) {
1055 dev_err(sm->dev, "gpio: failed to request region\n");
1059 gpio->regs = ioremap(iobase, 0x20);
1061 dev_err(sm->dev, "gpio: failed to remap registers\n");
1066 /* Register both our chips. */
1068 ret = sm501_gpio_register_chip(sm, gpio, &gpio->low);
1070 dev_err(sm->dev, "failed to add low chip\n");
1074 ret = sm501_gpio_register_chip(sm, gpio, &gpio->high);
1076 dev_err(sm->dev, "failed to add high chip\n");
1080 gpio->registered = 1;
1085 gpiochip_remove(&gpio->low.gpio);
1088 iounmap(gpio->regs);
1091 release_resource(gpio->regs_res);
1092 kfree(gpio->regs_res);
1097 static void sm501_gpio_remove(struct sm501_devdata *sm)
1099 struct sm501_gpio *gpio = &sm->gpio;
1101 if (!sm->gpio.registered)
1104 gpiochip_remove(&gpio->low.gpio);
1105 gpiochip_remove(&gpio->high.gpio);
1107 iounmap(gpio->regs);
1108 release_resource(gpio->regs_res);
1109 kfree(gpio->regs_res);
1112 static inline int sm501_gpio_isregistered(struct sm501_devdata *sm)
1114 return sm->gpio.registered;
1117 static inline int sm501_register_gpio(struct sm501_devdata *sm)
1122 static inline void sm501_gpio_remove(struct sm501_devdata *sm)
1126 static inline int sm501_gpio_isregistered(struct sm501_devdata *sm)
1132 static int sm501_register_gpio_i2c_instance(struct sm501_devdata *sm,
1133 struct sm501_platdata_gpio_i2c *iic)
1135 struct i2c_gpio_platform_data *icd;
1136 struct platform_device *pdev;
1137 struct gpiod_lookup_table *lookup;
1139 pdev = sm501_create_subdev(sm, "i2c-gpio", 0,
1140 sizeof(struct i2c_gpio_platform_data));
1144 /* Create a gpiod lookup using gpiochip-local offsets */
1145 lookup = devm_kzalloc(&pdev->dev, struct_size(lookup, table, 3),
1150 lookup->dev_id = "i2c-gpio";
1151 if (iic->pin_sda < 32)
1152 lookup->table[0].chip_label = "SM501-LOW";
1154 lookup->table[0].chip_label = "SM501-HIGH";
1155 lookup->table[0].chip_hwnum = iic->pin_sda % 32;
1156 lookup->table[0].con_id = NULL;
1157 lookup->table[0].idx = 0;
1158 lookup->table[0].flags = GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN;
1159 if (iic->pin_scl < 32)
1160 lookup->table[1].chip_label = "SM501-LOW";
1162 lookup->table[1].chip_label = "SM501-HIGH";
1163 lookup->table[1].chip_hwnum = iic->pin_scl % 32;
1164 lookup->table[1].con_id = NULL;
1165 lookup->table[1].idx = 1;
1166 lookup->table[1].flags = GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN;
1167 gpiod_add_lookup_table(lookup);
1169 icd = dev_get_platdata(&pdev->dev);
1170 icd->timeout = iic->timeout;
1171 icd->udelay = iic->udelay;
1173 /* note, we can't use either of the pin numbers, as the i2c-gpio
1174 * driver uses the platform.id field to generate the bus number
1175 * to register with the i2c core; The i2c core doesn't have enough
1176 * entries to deal with anything we currently use.
1179 pdev->id = iic->bus_num;
1181 dev_info(sm->dev, "registering i2c-%d: sda=%d, scl=%d\n",
1183 iic->pin_sda, iic->pin_scl);
1185 return sm501_register_device(sm, pdev);
1188 static int sm501_register_gpio_i2c(struct sm501_devdata *sm,
1189 struct sm501_platdata *pdata)
1191 struct sm501_platdata_gpio_i2c *iic = pdata->gpio_i2c;
1195 for (index = 0; index < pdata->gpio_i2c_nr; index++, iic++) {
1196 ret = sm501_register_gpio_i2c_instance(sm, iic);
1206 * Debug attribute to attach to parent device to show core registers
1209 static ssize_t sm501_dbg_regs(struct device *dev,
1210 struct device_attribute *attr, char *buff)
1212 struct sm501_devdata *sm = dev_get_drvdata(dev) ;
1217 for (reg = 0x00; reg < 0x70; reg += 4) {
1218 ret = sprintf(ptr, "%08x = %08x\n",
1219 reg, smc501_readl(sm->regs + reg));
1227 static DEVICE_ATTR(dbg_regs, 0444, sm501_dbg_regs, NULL);
1231 * Helper function for the init code to setup a register
1233 * clear the bits which are set in r->mask, and then set
1234 * the bits set in r->set.
1237 static inline void sm501_init_reg(struct sm501_devdata *sm,
1239 struct sm501_reg_init *r)
1243 tmp = smc501_readl(sm->regs + reg);
1246 smc501_writel(tmp, sm->regs + reg);
1251 * Setup core register values
1254 static void sm501_init_regs(struct sm501_devdata *sm,
1255 struct sm501_initdata *init)
1257 sm501_misc_control(sm->dev,
1258 init->misc_control.set,
1259 init->misc_control.mask);
1261 sm501_init_reg(sm, SM501_MISC_TIMING, &init->misc_timing);
1262 sm501_init_reg(sm, SM501_GPIO31_0_CONTROL, &init->gpio_low);
1263 sm501_init_reg(sm, SM501_GPIO63_32_CONTROL, &init->gpio_high);
1266 dev_info(sm->dev, "setting M1XCLK to %ld\n", init->m1xclk);
1267 sm501_set_clock(sm->dev, SM501_CLOCK_M1XCLK, init->m1xclk);
1271 dev_info(sm->dev, "setting MCLK to %ld\n", init->mclk);
1272 sm501_set_clock(sm->dev, SM501_CLOCK_MCLK, init->mclk);
1277 /* Check the PLL sources for the M1CLK and M1XCLK
1279 * If the M1CLK and M1XCLKs are not sourced from the same PLL, then
1280 * there is a risk (see errata AB-5) that the SM501 will cease proper
1281 * function. If this happens, then it is likely the SM501 will
1285 static int sm501_check_clocks(struct sm501_devdata *sm)
1287 unsigned long pwrmode = smc501_readl(sm->regs + SM501_CURRENT_CLOCK);
1288 unsigned long msrc = (pwrmode & SM501_POWERMODE_M_SRC);
1289 unsigned long m1src = (pwrmode & SM501_POWERMODE_M1_SRC);
1291 return ((msrc == 0 && m1src != 0) || (msrc != 0 && m1src == 0));
1294 static unsigned int sm501_mem_local[] = {
1305 * Common init code for an SM501
1308 static int sm501_init_dev(struct sm501_devdata *sm)
1310 struct sm501_initdata *idata;
1311 struct sm501_platdata *pdata;
1312 resource_size_t mem_avail;
1313 unsigned long dramctrl;
1314 unsigned long devid;
1317 mutex_init(&sm->clock_lock);
1318 spin_lock_init(&sm->reg_lock);
1320 INIT_LIST_HEAD(&sm->devices);
1322 devid = smc501_readl(sm->regs + SM501_DEVICEID);
1324 if ((devid & SM501_DEVICEID_IDMASK) != SM501_DEVICEID_SM501) {
1325 dev_err(sm->dev, "incorrect device id %08lx\n", devid);
1330 smc501_writel(0, sm->regs + SM501_IRQ_MASK);
1332 dramctrl = smc501_readl(sm->regs + SM501_DRAM_CONTROL);
1333 mem_avail = sm501_mem_local[(dramctrl >> 13) & 0x7];
1335 dev_info(sm->dev, "SM501 At %p: Version %08lx, %ld Mb, IRQ %d\n",
1336 sm->regs, devid, (unsigned long)mem_avail >> 20, sm->irq);
1338 sm->rev = devid & SM501_DEVICEID_REVMASK;
1340 sm501_dump_gate(sm);
1342 ret = device_create_file(sm->dev, &dev_attr_dbg_regs);
1344 dev_err(sm->dev, "failed to create debug regs file\n");
1348 /* check to see if we have some device initialisation */
1350 pdata = sm->platdata;
1351 idata = pdata ? pdata->init : NULL;
1354 sm501_init_regs(sm, idata);
1356 if (idata->devices & SM501_USE_USB_HOST)
1357 sm501_register_usbhost(sm, &mem_avail);
1358 if (idata->devices & (SM501_USE_UART0 | SM501_USE_UART1))
1359 sm501_register_uart(sm, idata->devices);
1360 if (idata->devices & SM501_USE_GPIO)
1361 sm501_register_gpio(sm);
1364 if (pdata && pdata->gpio_i2c && pdata->gpio_i2c_nr > 0) {
1365 if (!sm501_gpio_isregistered(sm))
1366 dev_err(sm->dev, "no gpio available for i2c gpio.\n");
1368 sm501_register_gpio_i2c(sm, pdata);
1371 ret = sm501_check_clocks(sm);
1373 dev_err(sm->dev, "M1X and M clocks sourced from different "
1378 /* always create a framebuffer */
1379 sm501_register_display(sm, &mem_avail);
1384 static int sm501_plat_probe(struct platform_device *dev)
1386 struct sm501_devdata *sm;
1389 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1395 sm->dev = &dev->dev;
1396 sm->pdev_id = dev->id;
1397 sm->platdata = dev_get_platdata(&dev->dev);
1399 ret = platform_get_irq(dev, 0);
1401 dev_err(&dev->dev, "failed to get irq resource\n");
1406 sm->io_res = platform_get_resource(dev, IORESOURCE_MEM, 1);
1407 sm->mem_res = platform_get_resource(dev, IORESOURCE_MEM, 0);
1408 if (!sm->io_res || !sm->mem_res) {
1409 dev_err(&dev->dev, "failed to get IO resource\n");
1414 sm->regs_claim = request_mem_region(sm->io_res->start,
1416 if (!sm->regs_claim) {
1417 dev_err(&dev->dev, "cannot claim registers\n");
1422 platform_set_drvdata(dev, sm);
1424 sm->regs = ioremap(sm->io_res->start, resource_size(sm->io_res));
1426 dev_err(&dev->dev, "cannot remap registers\n");
1431 return sm501_init_dev(sm);
1434 release_resource(sm->regs_claim);
1435 kfree(sm->regs_claim);
1445 /* power management support */
1447 static void sm501_set_power(struct sm501_devdata *sm, int on)
1449 struct sm501_platdata *pd = sm->platdata;
1454 if (pd->get_power) {
1455 if (pd->get_power(sm->dev) == on) {
1456 dev_dbg(sm->dev, "is already %d\n", on);
1461 if (pd->set_power) {
1462 dev_dbg(sm->dev, "setting power to %d\n", on);
1464 pd->set_power(sm->dev, on);
1465 sm501_mdelay(sm, 10);
1469 static int sm501_plat_suspend(struct platform_device *pdev, pm_message_t state)
1471 struct sm501_devdata *sm = platform_get_drvdata(pdev);
1474 sm->pm_misc = smc501_readl(sm->regs + SM501_MISC_CONTROL);
1476 sm501_dump_regs(sm);
1479 if (sm->platdata->flags & SM501_FLAG_SUSPEND_OFF)
1480 sm501_set_power(sm, 0);
1486 static int sm501_plat_resume(struct platform_device *pdev)
1488 struct sm501_devdata *sm = platform_get_drvdata(pdev);
1490 sm501_set_power(sm, 1);
1492 sm501_dump_regs(sm);
1493 sm501_dump_gate(sm);
1496 /* check to see if we are in the same state as when suspended */
1498 if (smc501_readl(sm->regs + SM501_MISC_CONTROL) != sm->pm_misc) {
1499 dev_info(sm->dev, "SM501_MISC_CONTROL changed over sleep\n");
1500 smc501_writel(sm->pm_misc, sm->regs + SM501_MISC_CONTROL);
1502 /* our suspend causes the controller state to change,
1503 * either by something attempting setup, power loss,
1504 * or an external reset event on power change */
1506 if (sm->platdata && sm->platdata->init) {
1507 sm501_init_regs(sm, sm->platdata->init);
1511 /* dump our state from resume */
1513 sm501_dump_regs(sm);
1521 #define sm501_plat_suspend NULL
1522 #define sm501_plat_resume NULL
1525 /* Initialisation data for PCI devices */
1527 static struct sm501_initdata sm501_pci_initdata = {
1529 .set = 0x3F000000, /* 24bit panel */
1533 .set = 0x010100, /* SDRAM timing */
1537 .set = SM501_MISC_PNL_24BIT,
1541 .devices = SM501_USE_ALL,
1543 /* Errata AB-3 says that 72MHz is the fastest available
1544 * for 33MHZ PCI with proper bus-mastering operation */
1547 .m1xclk = 144 * MHZ,
1550 static struct sm501_platdata_fbsub sm501_pdata_fbsub = {
1551 .flags = (SM501FB_FLAG_USE_INIT_MODE |
1552 SM501FB_FLAG_USE_HWCURSOR |
1553 SM501FB_FLAG_USE_HWACCEL |
1554 SM501FB_FLAG_DISABLE_AT_EXIT),
1557 static struct sm501_platdata_fb sm501_fb_pdata = {
1558 .fb_route = SM501_FB_OWN,
1559 .fb_crt = &sm501_pdata_fbsub,
1560 .fb_pnl = &sm501_pdata_fbsub,
1563 static struct sm501_platdata sm501_pci_platdata = {
1564 .init = &sm501_pci_initdata,
1565 .fb = &sm501_fb_pdata,
1569 static int sm501_pci_probe(struct pci_dev *dev,
1570 const struct pci_device_id *id)
1572 struct sm501_devdata *sm;
1575 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1581 /* set a default set of platform data */
1582 dev->dev.platform_data = sm->platdata = &sm501_pci_platdata;
1584 /* set a hopefully unique id for our child platform devices */
1585 sm->pdev_id = 32 + dev->devfn;
1587 pci_set_drvdata(dev, sm);
1589 err = pci_enable_device(dev);
1591 dev_err(&dev->dev, "cannot enable device\n");
1595 sm->dev = &dev->dev;
1599 /* if the system is big-endian, we most probably have a
1600 * translation in the IO layer making the PCI bus little endian
1601 * so make the framebuffer swapped pixels */
1603 sm501_fb_pdata.flags |= SM501_FBPD_SWAP_FB_ENDIAN;
1606 /* check our resources */
1608 if (!(pci_resource_flags(dev, 0) & IORESOURCE_MEM)) {
1609 dev_err(&dev->dev, "region #0 is not memory?\n");
1614 if (!(pci_resource_flags(dev, 1) & IORESOURCE_MEM)) {
1615 dev_err(&dev->dev, "region #1 is not memory?\n");
1620 /* make our resources ready for sharing */
1622 sm->io_res = &dev->resource[1];
1623 sm->mem_res = &dev->resource[0];
1625 sm->regs_claim = request_mem_region(sm->io_res->start,
1627 if (!sm->regs_claim) {
1628 dev_err(&dev->dev, "cannot claim registers\n");
1633 sm->regs = pci_ioremap_bar(dev, 1);
1635 dev_err(&dev->dev, "cannot remap registers\n");
1644 release_resource(sm->regs_claim);
1645 kfree(sm->regs_claim);
1647 pci_disable_device(dev);
1654 static void sm501_remove_sub(struct sm501_devdata *sm,
1655 struct sm501_device *smdev)
1657 list_del(&smdev->list);
1658 platform_device_unregister(&smdev->pdev);
1661 static void sm501_dev_remove(struct sm501_devdata *sm)
1663 struct sm501_device *smdev, *tmp;
1665 list_for_each_entry_safe(smdev, tmp, &sm->devices, list)
1666 sm501_remove_sub(sm, smdev);
1668 device_remove_file(sm->dev, &dev_attr_dbg_regs);
1670 sm501_gpio_remove(sm);
1673 static void sm501_pci_remove(struct pci_dev *dev)
1675 struct sm501_devdata *sm = pci_get_drvdata(dev);
1677 sm501_dev_remove(sm);
1680 release_resource(sm->regs_claim);
1681 kfree(sm->regs_claim);
1683 pci_disable_device(dev);
1686 static int sm501_plat_remove(struct platform_device *dev)
1688 struct sm501_devdata *sm = platform_get_drvdata(dev);
1690 sm501_dev_remove(sm);
1693 release_resource(sm->regs_claim);
1694 kfree(sm->regs_claim);
1699 static const struct pci_device_id sm501_pci_tbl[] = {
1700 { 0x126f, 0x0501, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
1704 MODULE_DEVICE_TABLE(pci, sm501_pci_tbl);
1706 static struct pci_driver sm501_pci_driver = {
1708 .id_table = sm501_pci_tbl,
1709 .probe = sm501_pci_probe,
1710 .remove = sm501_pci_remove,
1713 MODULE_ALIAS("platform:sm501");
1715 static const struct of_device_id of_sm501_match_tbl[] = {
1716 { .compatible = "smi,sm501", },
1719 MODULE_DEVICE_TABLE(of, of_sm501_match_tbl);
1721 static struct platform_driver sm501_plat_driver = {
1724 .of_match_table = of_sm501_match_tbl,
1726 .probe = sm501_plat_probe,
1727 .remove = sm501_plat_remove,
1728 .suspend = sm501_plat_suspend,
1729 .resume = sm501_plat_resume,
1732 static int __init sm501_base_init(void)
1734 platform_driver_register(&sm501_plat_driver);
1735 return pci_register_driver(&sm501_pci_driver);
1738 static void __exit sm501_base_exit(void)
1740 platform_driver_unregister(&sm501_plat_driver);
1741 pci_unregister_driver(&sm501_pci_driver);
1744 module_init(sm501_base_init);
1745 module_exit(sm501_base_exit);
1747 MODULE_DESCRIPTION("SM501 Core Driver");
1748 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>, Vincent Sanders");
1749 MODULE_LICENSE("GPL v2");