1166bac38SJan Glauber /*
2166bac38SJan Glauber  * Driver for MMC and SSD cards for Cavium ThunderX SOCs.
3166bac38SJan Glauber  *
4166bac38SJan Glauber  * This file is subject to the terms and conditions of the GNU General Public
5166bac38SJan Glauber  * License.  See the file "COPYING" in the main directory of this archive
6166bac38SJan Glauber  * for more details.
7166bac38SJan Glauber  *
8166bac38SJan Glauber  * Copyright (C) 2016 Cavium Inc.
9166bac38SJan Glauber  */
10b917c6d1SJan Glauber #include <linux/device.h>
11166bac38SJan Glauber #include <linux/dma-mapping.h>
12166bac38SJan Glauber #include <linux/interrupt.h>
13166bac38SJan Glauber #include <linux/mmc/mmc.h>
14166bac38SJan Glauber #include <linux/module.h>
15166bac38SJan Glauber #include <linux/of.h>
16166bac38SJan Glauber #include <linux/of_platform.h>
17*c62da8a8SRob Herring #include <linux/platform_device.h>
18166bac38SJan Glauber #include <linux/pci.h>
19166bac38SJan Glauber #include "cavium.h"
20166bac38SJan Glauber 
thunder_mmc_acquire_bus(struct cvm_mmc_host * host)21166bac38SJan Glauber static void thunder_mmc_acquire_bus(struct cvm_mmc_host *host)
22166bac38SJan Glauber {
23166bac38SJan Glauber 	down(&host->mmc_serializer);
24166bac38SJan Glauber }
25166bac38SJan Glauber 
thunder_mmc_release_bus(struct cvm_mmc_host * host)26166bac38SJan Glauber static void thunder_mmc_release_bus(struct cvm_mmc_host *host)
27166bac38SJan Glauber {
28166bac38SJan Glauber 	up(&host->mmc_serializer);
29166bac38SJan Glauber }
30166bac38SJan Glauber 
thunder_mmc_int_enable(struct cvm_mmc_host * host,u64 val)31166bac38SJan Glauber static void thunder_mmc_int_enable(struct cvm_mmc_host *host, u64 val)
32166bac38SJan Glauber {
33166bac38SJan Glauber 	writeq(val, host->base + MIO_EMM_INT(host));
34166bac38SJan Glauber 	writeq(val, host->base + MIO_EMM_INT_EN_SET(host));
35166bac38SJan Glauber }
36166bac38SJan Glauber 
thunder_mmc_register_interrupts(struct cvm_mmc_host * host,struct pci_dev * pdev)37166bac38SJan Glauber static int thunder_mmc_register_interrupts(struct cvm_mmc_host *host,
38166bac38SJan Glauber 					   struct pci_dev *pdev)
39166bac38SJan Glauber {
40166bac38SJan Glauber 	int nvec, ret, i;
41166bac38SJan Glauber 
42166bac38SJan Glauber 	nvec = pci_alloc_irq_vectors(pdev, 1, 9, PCI_IRQ_MSIX);
43166bac38SJan Glauber 	if (nvec < 0)
44166bac38SJan Glauber 		return nvec;
45166bac38SJan Glauber 
46166bac38SJan Glauber 	/* register interrupts */
47166bac38SJan Glauber 	for (i = 0; i < nvec; i++) {
48166bac38SJan Glauber 		ret = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
49166bac38SJan Glauber 				       cvm_mmc_interrupt,
50166bac38SJan Glauber 				       0, cvm_mmc_irq_names[i], host);
51166bac38SJan Glauber 		if (ret)
52166bac38SJan Glauber 			return ret;
53166bac38SJan Glauber 	}
54166bac38SJan Glauber 	return 0;
55166bac38SJan Glauber }
56166bac38SJan Glauber 
thunder_mmc_probe(struct pci_dev * pdev,const struct pci_device_id * id)57166bac38SJan Glauber static int thunder_mmc_probe(struct pci_dev *pdev,
58166bac38SJan Glauber 			     const struct pci_device_id *id)
59166bac38SJan Glauber {
60166bac38SJan Glauber 	struct device_node *node = pdev->dev.of_node;
61166bac38SJan Glauber 	struct device *dev = &pdev->dev;
62166bac38SJan Glauber 	struct device_node *child_node;
63166bac38SJan Glauber 	struct cvm_mmc_host *host;
64166bac38SJan Glauber 	int ret, i = 0;
65166bac38SJan Glauber 
66166bac38SJan Glauber 	host = devm_kzalloc(dev, sizeof(*host), GFP_KERNEL);
67166bac38SJan Glauber 	if (!host)
68166bac38SJan Glauber 		return -ENOMEM;
69166bac38SJan Glauber 
70166bac38SJan Glauber 	pci_set_drvdata(pdev, host);
71166bac38SJan Glauber 	ret = pcim_enable_device(pdev);
72166bac38SJan Glauber 	if (ret)
73166bac38SJan Glauber 		return ret;
74166bac38SJan Glauber 
75166bac38SJan Glauber 	ret = pci_request_regions(pdev, KBUILD_MODNAME);
76166bac38SJan Glauber 	if (ret)
77166bac38SJan Glauber 		return ret;
78166bac38SJan Glauber 
79166bac38SJan Glauber 	host->base = pcim_iomap(pdev, 0, pci_resource_len(pdev, 0));
80f630d011SChuhong Yuan 	if (!host->base) {
81f630d011SChuhong Yuan 		ret = -EINVAL;
82f630d011SChuhong Yuan 		goto error;
83f630d011SChuhong Yuan 	}
84166bac38SJan Glauber 
85166bac38SJan Glauber 	/* On ThunderX these are identical */
86166bac38SJan Glauber 	host->dma_base = host->base;
87166bac38SJan Glauber 
88166bac38SJan Glauber 	host->reg_off = 0x2000;
89cd76e5c5SJan Glauber 	host->reg_off_dma = 0x160;
90166bac38SJan Glauber 
91166bac38SJan Glauber 	host->clk = devm_clk_get(dev, NULL);
92f630d011SChuhong Yuan 	if (IS_ERR(host->clk)) {
93f630d011SChuhong Yuan 		ret = PTR_ERR(host->clk);
94f630d011SChuhong Yuan 		goto error;
95f630d011SChuhong Yuan 	}
96166bac38SJan Glauber 
97166bac38SJan Glauber 	ret = clk_prepare_enable(host->clk);
98166bac38SJan Glauber 	if (ret)
99f630d011SChuhong Yuan 		goto error;
100166bac38SJan Glauber 	host->sys_freq = clk_get_rate(host->clk);
101166bac38SJan Glauber 
102166bac38SJan Glauber 	spin_lock_init(&host->irq_handler_lock);
103166bac38SJan Glauber 	sema_init(&host->mmc_serializer, 1);
104166bac38SJan Glauber 
105166bac38SJan Glauber 	host->dev = dev;
106166bac38SJan Glauber 	host->acquire_bus = thunder_mmc_acquire_bus;
107166bac38SJan Glauber 	host->release_bus = thunder_mmc_release_bus;
108166bac38SJan Glauber 	host->int_enable = thunder_mmc_int_enable;
109166bac38SJan Glauber 
110cd76e5c5SJan Glauber 	host->use_sg = true;
111166bac38SJan Glauber 	host->big_dma_addr = true;
112166bac38SJan Glauber 	host->need_irq_handler_lock = true;
113166bac38SJan Glauber 	host->last_slot = -1;
114166bac38SJan Glauber 
115166bac38SJan Glauber 	ret = dma_set_mask(dev, DMA_BIT_MASK(48));
116166bac38SJan Glauber 	if (ret)
117166bac38SJan Glauber 		goto error;
118166bac38SJan Glauber 
119166bac38SJan Glauber 	/*
120166bac38SJan Glauber 	 * Clear out any pending interrupts that may be left over from
121166bac38SJan Glauber 	 * bootloader. Writing 1 to the bits clears them.
122166bac38SJan Glauber 	 */
123166bac38SJan Glauber 	writeq(127, host->base + MIO_EMM_INT_EN(host));
124166bac38SJan Glauber 	writeq(3, host->base + MIO_EMM_DMA_INT_ENA_W1C(host));
125cd76e5c5SJan Glauber 	/* Clear DMA FIFO */
126cd76e5c5SJan Glauber 	writeq(BIT_ULL(16), host->base + MIO_EMM_DMA_FIFO_CFG(host));
127166bac38SJan Glauber 
128166bac38SJan Glauber 	ret = thunder_mmc_register_interrupts(host, pdev);
129166bac38SJan Glauber 	if (ret)
130166bac38SJan Glauber 		goto error;
131166bac38SJan Glauber 
132166bac38SJan Glauber 	for_each_child_of_node(node, child_node) {
133166bac38SJan Glauber 		/*
134166bac38SJan Glauber 		 * mmc_of_parse and devm* require one device per slot.
135166bac38SJan Glauber 		 * Create a dummy device per slot and set the node pointer to
136166bac38SJan Glauber 		 * the slot. The easiest way to get this is using
137166bac38SJan Glauber 		 * of_platform_device_create.
138166bac38SJan Glauber 		 */
139166bac38SJan Glauber 		if (of_device_is_compatible(child_node, "mmc-slot")) {
140166bac38SJan Glauber 			host->slot_pdev[i] = of_platform_device_create(child_node, NULL,
141166bac38SJan Glauber 								       &pdev->dev);
142166bac38SJan Glauber 			if (!host->slot_pdev[i])
143166bac38SJan Glauber 				continue;
144166bac38SJan Glauber 
145166bac38SJan Glauber 			ret = cvm_mmc_of_slot_probe(&host->slot_pdev[i]->dev, host);
1467ee48079SLiang He 			if (ret) {
1477ee48079SLiang He 				of_node_put(child_node);
148166bac38SJan Glauber 				goto error;
149166bac38SJan Glauber 			}
1507ee48079SLiang He 		}
151166bac38SJan Glauber 		i++;
152166bac38SJan Glauber 	}
153166bac38SJan Glauber 	dev_info(dev, "probed\n");
154166bac38SJan Glauber 	return 0;
155166bac38SJan Glauber 
156166bac38SJan Glauber error:
1578fb83b14SJan Glauber 	for (i = 0; i < CAVIUM_MAX_MMC; i++) {
1588fb83b14SJan Glauber 		if (host->slot[i])
1598fb83b14SJan Glauber 			cvm_mmc_of_slot_remove(host->slot[i]);
160b917c6d1SJan Glauber 		if (host->slot_pdev[i]) {
161b917c6d1SJan Glauber 			get_device(&host->slot_pdev[i]->dev);
1628fb83b14SJan Glauber 			of_platform_device_destroy(&host->slot_pdev[i]->dev, NULL);
163b917c6d1SJan Glauber 			put_device(&host->slot_pdev[i]->dev);
164b917c6d1SJan Glauber 		}
1658fb83b14SJan Glauber 	}
166166bac38SJan Glauber 	clk_disable_unprepare(host->clk);
167f630d011SChuhong Yuan 	pci_release_regions(pdev);
168166bac38SJan Glauber 	return ret;
169166bac38SJan Glauber }
170166bac38SJan Glauber 
thunder_mmc_remove(struct pci_dev * pdev)171166bac38SJan Glauber static void thunder_mmc_remove(struct pci_dev *pdev)
172166bac38SJan Glauber {
173166bac38SJan Glauber 	struct cvm_mmc_host *host = pci_get_drvdata(pdev);
174166bac38SJan Glauber 	u64 dma_cfg;
175166bac38SJan Glauber 	int i;
176166bac38SJan Glauber 
177166bac38SJan Glauber 	for (i = 0; i < CAVIUM_MAX_MMC; i++)
178166bac38SJan Glauber 		if (host->slot[i])
179166bac38SJan Glauber 			cvm_mmc_of_slot_remove(host->slot[i]);
180166bac38SJan Glauber 
181166bac38SJan Glauber 	dma_cfg = readq(host->dma_base + MIO_EMM_DMA_CFG(host));
182166bac38SJan Glauber 	dma_cfg &= ~MIO_EMM_DMA_CFG_EN;
183166bac38SJan Glauber 	writeq(dma_cfg, host->dma_base + MIO_EMM_DMA_CFG(host));
184166bac38SJan Glauber 
185166bac38SJan Glauber 	clk_disable_unprepare(host->clk);
186f630d011SChuhong Yuan 	pci_release_regions(pdev);
187166bac38SJan Glauber }
188166bac38SJan Glauber 
189166bac38SJan Glauber static const struct pci_device_id thunder_mmc_id_table[] = {
190166bac38SJan Glauber 	{ PCI_DEVICE(PCI_VENDOR_ID_CAVIUM, 0xa010) },
191166bac38SJan Glauber 	{ 0, }  /* end of table */
192166bac38SJan Glauber };
193166bac38SJan Glauber 
194166bac38SJan Glauber static struct pci_driver thunder_mmc_driver = {
195166bac38SJan Glauber 	.name = KBUILD_MODNAME,
196166bac38SJan Glauber 	.id_table = thunder_mmc_id_table,
197166bac38SJan Glauber 	.probe = thunder_mmc_probe,
198166bac38SJan Glauber 	.remove = thunder_mmc_remove,
199166bac38SJan Glauber };
200166bac38SJan Glauber 
201dfc28b11SWei Yongjun module_pci_driver(thunder_mmc_driver);
202166bac38SJan Glauber 
203166bac38SJan Glauber MODULE_AUTHOR("Cavium Inc.");
204166bac38SJan Glauber MODULE_DESCRIPTION("Cavium ThunderX eMMC Driver");
205166bac38SJan Glauber MODULE_LICENSE("GPL");
206166bac38SJan Glauber MODULE_DEVICE_TABLE(pci, thunder_mmc_id_table);
207