2 * Copyright (c) 2009-2011 Wind River Systems, Inc.
3 * Copyright (c) 2011 ST Microelectronics (Alessandro Rubini, Davide Ciminaghi)
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * See the GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/spinlock.h>
23 #include <linux/errno.h>
24 #include <linux/device.h>
25 #include <linux/slab.h>
26 #include <linux/list.h>
28 #include <linux/ioport.h>
29 #include <linux/pci.h>
30 #include <linux/seq_file.h>
31 #include <linux/platform_device.h>
32 #include <linux/mfd/core.h>
33 #include <linux/mfd/sta2x11-mfd.h>
34 #include <linux/regmap.h>
36 #include <asm/sta2x11.h>
38 static inline int __reg_within_range(unsigned int r
,
42 return ((r
>= start
) && (r
<= end
));
45 /* This describes STA2X11 MFD chip for us, we may have several */
47 struct sta2x11_instance
*instance
;
48 struct regmap
*regmap
[sta2x11_n_mfd_plat_devs
];
49 spinlock_t lock
[sta2x11_n_mfd_plat_devs
];
50 struct list_head list
;
51 void __iomem
*regs
[sta2x11_n_mfd_plat_devs
];
54 static LIST_HEAD(sta2x11_mfd_list
);
56 /* Three functions to act on the list */
57 static struct sta2x11_mfd
*sta2x11_mfd_find(struct pci_dev
*pdev
)
59 struct sta2x11_instance
*instance
;
60 struct sta2x11_mfd
*mfd
;
62 if (!pdev
&& !list_empty(&sta2x11_mfd_list
)) {
63 pr_warning("%s: Unspecified device, "
64 "using first instance\n", __func__
);
65 return list_entry(sta2x11_mfd_list
.next
,
66 struct sta2x11_mfd
, list
);
69 instance
= sta2x11_get_instance(pdev
);
72 list_for_each_entry(mfd
, &sta2x11_mfd_list
, list
) {
73 if (mfd
->instance
== instance
)
79 static int sta2x11_mfd_add(struct pci_dev
*pdev
, gfp_t flags
)
82 struct sta2x11_mfd
*mfd
= sta2x11_mfd_find(pdev
);
83 struct sta2x11_instance
*instance
;
87 instance
= sta2x11_get_instance(pdev
);
90 mfd
= kzalloc(sizeof(*mfd
), flags
);
93 INIT_LIST_HEAD(&mfd
->list
);
94 for (i
= 0; i
< ARRAY_SIZE(mfd
->lock
); i
++)
95 spin_lock_init(&mfd
->lock
[i
]);
96 mfd
->instance
= instance
;
97 list_add(&mfd
->list
, &sta2x11_mfd_list
);
101 static int mfd_remove(struct pci_dev
*pdev
)
103 struct sta2x11_mfd
*mfd
= sta2x11_mfd_find(pdev
);
107 list_del(&mfd
->list
);
112 /* This function is exported and is not expected to fail */
113 u32
__sta2x11_mfd_mask(struct pci_dev
*pdev
, u32 reg
, u32 mask
, u32 val
,
114 enum sta2x11_mfd_plat_dev index
)
116 struct sta2x11_mfd
*mfd
= sta2x11_mfd_find(pdev
);
122 dev_warn(&pdev
->dev
, ": can't access sctl regs\n");
126 regs
= mfd
->regs
[index
];
128 dev_warn(&pdev
->dev
, ": system ctl not initialized\n");
131 spin_lock_irqsave(&mfd
->lock
[index
], flags
);
132 r
= readl(regs
+ reg
);
136 writel(r
, regs
+ reg
);
137 spin_unlock_irqrestore(&mfd
->lock
[index
], flags
);
140 EXPORT_SYMBOL(__sta2x11_mfd_mask
);
142 int sta2x11_mfd_get_regs_data(struct platform_device
*dev
,
143 enum sta2x11_mfd_plat_dev index
,
147 struct pci_dev
*pdev
= *(struct pci_dev
**)(dev
->dev
.platform_data
);
148 struct sta2x11_mfd
*mfd
;
152 mfd
= sta2x11_mfd_find(pdev
);
155 if (index
>= sta2x11_n_mfd_plat_devs
)
157 *regs
= mfd
->regs
[index
];
158 *lock
= &mfd
->lock
[index
];
159 pr_debug("%s %d *regs = %p\n", __func__
, __LINE__
, *regs
);
160 return *regs
? 0 : -ENODEV
;
162 EXPORT_SYMBOL(sta2x11_mfd_get_regs_data
);
165 * Special sta2x11-mfd regmap lock/unlock functions
168 static void sta2x11_regmap_lock(void *__lock
)
170 spinlock_t
*lock
= __lock
;
174 static void sta2x11_regmap_unlock(void *__lock
)
176 spinlock_t
*lock
= __lock
;
180 /* OTP (one time programmable registers do not require locking */
181 static void sta2x11_regmap_nolock(void *__lock
)
185 static const char *sta2x11_mfd_names
[sta2x11_n_mfd_plat_devs
] = {
186 [sta2x11_sctl
] = STA2X11_MFD_SCTL_NAME
,
187 [sta2x11_apbreg
] = STA2X11_MFD_APBREG_NAME
,
188 [sta2x11_apb_soc_regs
] = STA2X11_MFD_APB_SOC_REGS_NAME
,
189 [sta2x11_scr
] = STA2X11_MFD_SCR_NAME
,
192 static bool sta2x11_sctl_writeable_reg(struct device
*dev
, unsigned int reg
)
194 return !__reg_within_range(reg
, SCTL_SCPCIECSBRST
, SCTL_SCRSTSTA
);
197 static struct regmap_config sta2x11_sctl_regmap_config
= {
201 .lock
= sta2x11_regmap_lock
,
202 .unlock
= sta2x11_regmap_unlock
,
203 .max_register
= SCTL_SCRSTSTA
,
204 .writeable_reg
= sta2x11_sctl_writeable_reg
,
207 static bool sta2x11_scr_readable_reg(struct device
*dev
, unsigned int reg
)
209 return (reg
== STA2X11_SECR_CR
) ||
210 __reg_within_range(reg
, STA2X11_SECR_FVR0
, STA2X11_SECR_FVR1
);
213 static bool sta2x11_scr_writeable_reg(struct device
*dev
, unsigned int reg
)
218 static struct regmap_config sta2x11_scr_regmap_config
= {
222 .lock
= sta2x11_regmap_nolock
,
223 .unlock
= sta2x11_regmap_nolock
,
224 .max_register
= STA2X11_SECR_FVR1
,
225 .readable_reg
= sta2x11_scr_readable_reg
,
226 .writeable_reg
= sta2x11_scr_writeable_reg
,
229 static bool sta2x11_apbreg_readable_reg(struct device
*dev
, unsigned int reg
)
231 /* Two blocks (CAN and MLB, SARAC) 0x100 bytes apart */
232 if (reg
>= APBREG_BSR_SARAC
)
233 reg
-= APBREG_BSR_SARAC
;
248 static bool sta2x11_apbreg_writeable_reg(struct device
*dev
, unsigned int reg
)
250 if (reg
>= APBREG_BSR_SARAC
)
251 reg
-= APBREG_BSR_SARAC
;
252 if (!sta2x11_apbreg_readable_reg(dev
, reg
))
254 return reg
!= APBREG_PAER
;
257 static struct regmap_config sta2x11_apbreg_regmap_config
= {
261 .lock
= sta2x11_regmap_lock
,
262 .unlock
= sta2x11_regmap_unlock
,
263 .max_register
= APBREG_EMU_PCG_SARAC
,
264 .readable_reg
= sta2x11_apbreg_readable_reg
,
265 .writeable_reg
= sta2x11_apbreg_writeable_reg
,
268 static bool sta2x11_apb_soc_regs_readable_reg(struct device
*dev
,
271 return reg
<= PCIE_SoC_INT_ROUTER_STATUS3_REG
||
272 __reg_within_range(reg
, DMA_IP_CTRL_REG
, SPARE3_RESERVED
) ||
273 __reg_within_range(reg
, MASTER_LOCK_REG
,
274 SYSTEM_CONFIG_STATUS_REG
) ||
275 reg
== MSP_CLK_CTRL_REG
||
276 __reg_within_range(reg
, COMPENSATION_REG1
, TEST_CTL_REG
);
279 static bool sta2x11_apb_soc_regs_writeable_reg(struct device
*dev
,
282 if (!sta2x11_apb_soc_regs_readable_reg(dev
, reg
))
285 case PCIE_COMMON_CLOCK_CONFIG_0_4_0
:
286 case SYSTEM_CONFIG_STATUS_REG
:
287 case COMPENSATION_REG1
:
288 case PCIE_SoC_INT_ROUTER_STATUS0_REG
...PCIE_SoC_INT_ROUTER_STATUS3_REG
:
289 case PCIE_PM_STATUS_0_PORT_0_4
...PCIE_PM_STATUS_7_0_EP4
:
296 static struct regmap_config sta2x11_apb_soc_regs_regmap_config
= {
300 .lock
= sta2x11_regmap_lock
,
301 .unlock
= sta2x11_regmap_unlock
,
302 .max_register
= TEST_CTL_REG
,
303 .readable_reg
= sta2x11_apb_soc_regs_readable_reg
,
304 .writeable_reg
= sta2x11_apb_soc_regs_writeable_reg
,
307 static struct regmap_config
*
308 sta2x11_mfd_regmap_configs
[sta2x11_n_mfd_plat_devs
] = {
309 [sta2x11_sctl
] = &sta2x11_sctl_regmap_config
,
310 [sta2x11_apbreg
] = &sta2x11_apbreg_regmap_config
,
311 [sta2x11_apb_soc_regs
] = &sta2x11_apb_soc_regs_regmap_config
,
312 [sta2x11_scr
] = &sta2x11_scr_regmap_config
,
315 /* Probe for the four platform devices */
317 static int sta2x11_mfd_platform_probe(struct platform_device
*dev
,
318 enum sta2x11_mfd_plat_dev index
)
320 struct pci_dev
**pdev
;
321 struct sta2x11_mfd
*mfd
;
322 struct resource
*res
;
323 const char *name
= sta2x11_mfd_names
[index
];
324 struct regmap_config
*regmap_config
= sta2x11_mfd_regmap_configs
[index
];
326 pdev
= dev
->dev
.platform_data
;
327 mfd
= sta2x11_mfd_find(*pdev
);
333 res
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
337 if (!request_mem_region(res
->start
, resource_size(res
), name
))
340 mfd
->regs
[index
] = ioremap(res
->start
, resource_size(res
));
341 if (!mfd
->regs
[index
]) {
342 release_mem_region(res
->start
, resource_size(res
));
345 regmap_config
->lock_arg
= &mfd
->lock
;
347 No caching, registers could be reached both via regmap and via
350 regmap_config
->cache_type
= REGCACHE_NONE
;
351 mfd
->regmap
[index
] = devm_regmap_init_mmio(&dev
->dev
, mfd
->regs
[index
],
353 WARN_ON(!mfd
->regmap
[index
]);
358 static int sta2x11_sctl_probe(struct platform_device
*dev
)
360 return sta2x11_mfd_platform_probe(dev
, sta2x11_sctl
);
363 static int sta2x11_apbreg_probe(struct platform_device
*dev
)
365 return sta2x11_mfd_platform_probe(dev
, sta2x11_apbreg
);
368 static int sta2x11_apb_soc_regs_probe(struct platform_device
*dev
)
370 return sta2x11_mfd_platform_probe(dev
, sta2x11_apb_soc_regs
);
373 static int sta2x11_scr_probe(struct platform_device
*dev
)
375 return sta2x11_mfd_platform_probe(dev
, sta2x11_scr
);
378 /* The three platform drivers */
379 static struct platform_driver sta2x11_sctl_platform_driver
= {
381 .name
= STA2X11_MFD_SCTL_NAME
,
382 .owner
= THIS_MODULE
,
384 .probe
= sta2x11_sctl_probe
,
387 static int __init
sta2x11_sctl_init(void)
389 pr_info("%s\n", __func__
);
390 return platform_driver_register(&sta2x11_sctl_platform_driver
);
393 static struct platform_driver sta2x11_platform_driver
= {
395 .name
= STA2X11_MFD_APBREG_NAME
,
396 .owner
= THIS_MODULE
,
398 .probe
= sta2x11_apbreg_probe
,
401 static int __init
sta2x11_apbreg_init(void)
403 pr_info("%s\n", __func__
);
404 return platform_driver_register(&sta2x11_platform_driver
);
407 static struct platform_driver sta2x11_apb_soc_regs_platform_driver
= {
409 .name
= STA2X11_MFD_APB_SOC_REGS_NAME
,
410 .owner
= THIS_MODULE
,
412 .probe
= sta2x11_apb_soc_regs_probe
,
415 static int __init
sta2x11_apb_soc_regs_init(void)
417 pr_info("%s\n", __func__
);
418 return platform_driver_register(&sta2x11_apb_soc_regs_platform_driver
);
421 static struct platform_driver sta2x11_scr_platform_driver
= {
423 .name
= STA2X11_MFD_SCR_NAME
,
424 .owner
= THIS_MODULE
,
426 .probe
= sta2x11_scr_probe
,
429 static int __init
sta2x11_scr_init(void)
431 pr_info("%s\n", __func__
);
432 return platform_driver_register(&sta2x11_scr_platform_driver
);
437 * What follows are the PCI devices that host the above pdevs.
438 * Each logic block is 4kB and they are all consecutive: we use this info.
444 enum mfd0_bar0_cells
{
454 enum mfd0_bar1_cells
{
457 #define CELL_4K(_name, _cell) { \
459 .start = _cell * 4096, .end = _cell * 4096 + 4095, \
460 .flags = IORESOURCE_MEM, \
463 static const struct resource gpio_resources
[] = {
465 /* 4 consecutive cells, 1 driver */
466 .name
= STA2X11_MFD_GPIO_NAME
,
468 .end
= (4 * 4096) - 1,
469 .flags
= IORESOURCE_MEM
,
472 static const struct resource sctl_resources
[] = {
473 CELL_4K(STA2X11_MFD_SCTL_NAME
, STA2X11_SCTL
),
475 static const struct resource scr_resources
[] = {
476 CELL_4K(STA2X11_MFD_SCR_NAME
, STA2X11_SCR
),
478 static const struct resource time_resources
[] = {
479 CELL_4K(STA2X11_MFD_TIME_NAME
, STA2X11_TIME
),
482 static const struct resource apbreg_resources
[] = {
483 CELL_4K(STA2X11_MFD_APBREG_NAME
, STA2X11_APBREG
),
486 #define DEV(_name, _r) \
487 { .name = _name, .num_resources = ARRAY_SIZE(_r), .resources = _r, }
489 static struct mfd_cell sta2x11_mfd0_bar0
[] = {
490 /* offset 0: we add pdata later */
491 DEV(STA2X11_MFD_GPIO_NAME
, gpio_resources
),
492 DEV(STA2X11_MFD_SCTL_NAME
, sctl_resources
),
493 DEV(STA2X11_MFD_SCR_NAME
, scr_resources
),
494 DEV(STA2X11_MFD_TIME_NAME
, time_resources
),
497 static struct mfd_cell sta2x11_mfd0_bar1
[] = {
498 DEV(STA2X11_MFD_APBREG_NAME
, apbreg_resources
),
504 enum mfd1_bar0_cells
{
509 enum mfd1_bar1_cells
{
510 STA2X11_APB_SOC_REGS
= 0,
513 static const struct resource vic_resources
[] = {
514 CELL_4K(STA2X11_MFD_VIC_NAME
, STA2X11_VIC
),
517 static const struct resource apb_soc_regs_resources
[] = {
518 CELL_4K(STA2X11_MFD_APB_SOC_REGS_NAME
, STA2X11_APB_SOC_REGS
),
521 static struct mfd_cell sta2x11_mfd1_bar0
[] = {
522 DEV(STA2X11_MFD_VIC_NAME
, vic_resources
),
525 static struct mfd_cell sta2x11_mfd1_bar1
[] = {
526 DEV(STA2X11_MFD_APB_SOC_REGS_NAME
, apb_soc_regs_resources
),
530 static int sta2x11_mfd_suspend(struct pci_dev
*pdev
, pm_message_t state
)
532 pci_save_state(pdev
);
533 pci_disable_device(pdev
);
534 pci_set_power_state(pdev
, pci_choose_state(pdev
, state
));
539 static int sta2x11_mfd_resume(struct pci_dev
*pdev
)
543 pci_set_power_state(pdev
, 0);
544 err
= pci_enable_device(pdev
);
547 pci_restore_state(pdev
);
552 struct sta2x11_mfd_bar_setup_data
{
553 struct mfd_cell
*cells
;
557 struct sta2x11_mfd_setup_data
{
558 struct sta2x11_mfd_bar_setup_data bars
[2];
561 #define STA2X11_MFD0 0
562 #define STA2X11_MFD1 1
564 static struct sta2x11_mfd_setup_data mfd_setup_data
[] = {
565 /* Mfd 0: gpio, sctl, scr, timers / apbregs */
569 .cells
= sta2x11_mfd0_bar0
,
570 .ncells
= ARRAY_SIZE(sta2x11_mfd0_bar0
),
573 .cells
= sta2x11_mfd0_bar1
,
574 .ncells
= ARRAY_SIZE(sta2x11_mfd0_bar1
),
578 /* Mfd 1: vic / apb-soc-regs */
582 .cells
= sta2x11_mfd1_bar0
,
583 .ncells
= ARRAY_SIZE(sta2x11_mfd1_bar0
),
586 .cells
= sta2x11_mfd1_bar1
,
587 .ncells
= ARRAY_SIZE(sta2x11_mfd1_bar1
),
593 static void sta2x11_mfd_setup(struct pci_dev
*pdev
,
594 struct sta2x11_mfd_setup_data
*sd
)
597 for (i
= 0; i
< ARRAY_SIZE(sd
->bars
); i
++)
598 for (j
= 0; j
< sd
->bars
[i
].ncells
; j
++) {
599 sd
->bars
[i
].cells
[j
].pdata_size
= sizeof(pdev
);
600 sd
->bars
[i
].cells
[j
].platform_data
= &pdev
;
604 static int sta2x11_mfd_probe(struct pci_dev
*pdev
,
605 const struct pci_device_id
*pci_id
)
608 struct sta2x11_mfd_setup_data
*setup_data
;
610 dev_info(&pdev
->dev
, "%s\n", __func__
);
612 err
= pci_enable_device(pdev
);
614 dev_err(&pdev
->dev
, "Can't enable device.\n");
618 err
= pci_enable_msi(pdev
);
620 dev_info(&pdev
->dev
, "Enable msi failed\n");
622 setup_data
= pci_id
->device
== PCI_DEVICE_ID_STMICRO_GPIO
?
623 &mfd_setup_data
[STA2X11_MFD0
] :
624 &mfd_setup_data
[STA2X11_MFD1
];
626 /* platform data is the pci device for all of them */
627 sta2x11_mfd_setup(pdev
, setup_data
);
629 /* Record this pdev before mfd_add_devices: their probe looks for it */
630 if (!sta2x11_mfd_find(pdev
))
631 sta2x11_mfd_add(pdev
, GFP_ATOMIC
);
633 /* Just 2 bars for all mfd's at present */
634 for (i
= 0; i
< 2; i
++) {
635 err
= mfd_add_devices(&pdev
->dev
, -1,
636 setup_data
->bars
[i
].cells
,
637 setup_data
->bars
[i
].ncells
,
642 "mfd_add_devices[%d] failed: %d\n", i
, err
);
650 mfd_remove_devices(&pdev
->dev
);
651 pci_disable_device(pdev
);
652 pci_disable_msi(pdev
);
656 static DEFINE_PCI_DEVICE_TABLE(sta2x11_mfd_tbl
) = {
657 {PCI_DEVICE(PCI_VENDOR_ID_STMICRO
, PCI_DEVICE_ID_STMICRO_GPIO
)},
658 {PCI_DEVICE(PCI_VENDOR_ID_STMICRO
, PCI_DEVICE_ID_STMICRO_VIC
)},
662 static struct pci_driver sta2x11_mfd_driver
= {
663 .name
= "sta2x11-mfd",
664 .id_table
= sta2x11_mfd_tbl
,
665 .probe
= sta2x11_mfd_probe
,
666 .suspend
= sta2x11_mfd_suspend
,
667 .resume
= sta2x11_mfd_resume
,
670 static int __init
sta2x11_mfd_init(void)
672 pr_info("%s\n", __func__
);
673 return pci_register_driver(&sta2x11_mfd_driver
);
677 * All of this must be ready before "normal" devices like MMCI appear.
678 * But MFD (the pci device) can't be too early. The following choice
679 * prepares platform drivers very early and probe the PCI device later,
680 * but before other PCI devices.
682 subsys_initcall(sta2x11_apbreg_init
);
683 subsys_initcall(sta2x11_sctl_init
);
684 subsys_initcall(sta2x11_apb_soc_regs_init
);
685 subsys_initcall(sta2x11_scr_init
);
686 rootfs_initcall(sta2x11_mfd_init
);
688 MODULE_LICENSE("GPL v2");
689 MODULE_AUTHOR("Wind River");
690 MODULE_DESCRIPTION("STA2x11 mfd for GPIO, SCTL and APBREG");
691 MODULE_DEVICE_TABLE(pci
, sta2x11_mfd_tbl
);