1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0+
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * cpcihp_zt5550.c
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Intel/Ziatech ZT5550 CompactPCI Host Controller driver
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Copyright 2002 SOMA Networks, Inc.
8*4882a593Smuzhiyun * Copyright 2001 Intel San Luis Obispo
9*4882a593Smuzhiyun * Copyright 2000,2001 MontaVista Software Inc.
10*4882a593Smuzhiyun *
11*4882a593Smuzhiyun * Send feedback to <scottm@somanetworks.com>
12*4882a593Smuzhiyun */
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun #include <linux/module.h>
15*4882a593Smuzhiyun #include <linux/moduleparam.h>
16*4882a593Smuzhiyun #include <linux/init.h>
17*4882a593Smuzhiyun #include <linux/errno.h>
18*4882a593Smuzhiyun #include <linux/pci.h>
19*4882a593Smuzhiyun #include <linux/interrupt.h>
20*4882a593Smuzhiyun #include <linux/signal.h> /* IRQF_SHARED */
21*4882a593Smuzhiyun #include "cpci_hotplug.h"
22*4882a593Smuzhiyun #include "cpcihp_zt5550.h"
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun #define DRIVER_VERSION "0.2"
25*4882a593Smuzhiyun #define DRIVER_AUTHOR "Scott Murray <scottm@somanetworks.com>"
26*4882a593Smuzhiyun #define DRIVER_DESC "ZT5550 CompactPCI Hot Plug Driver"
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun #define MY_NAME "cpcihp_zt5550"
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun #define dbg(format, arg...) \
31*4882a593Smuzhiyun do { \
32*4882a593Smuzhiyun if (debug) \
33*4882a593Smuzhiyun printk(KERN_DEBUG "%s: " format "\n", \
34*4882a593Smuzhiyun MY_NAME, ## arg); \
35*4882a593Smuzhiyun } while (0)
36*4882a593Smuzhiyun #define err(format, arg...) printk(KERN_ERR "%s: " format "\n", MY_NAME, ## arg)
37*4882a593Smuzhiyun #define info(format, arg...) printk(KERN_INFO "%s: " format "\n", MY_NAME, ## arg)
38*4882a593Smuzhiyun #define warn(format, arg...) printk(KERN_WARNING "%s: " format "\n", MY_NAME, ## arg)
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun /* local variables */
41*4882a593Smuzhiyun static bool debug;
42*4882a593Smuzhiyun static bool poll;
43*4882a593Smuzhiyun static struct cpci_hp_controller_ops zt5550_hpc_ops;
44*4882a593Smuzhiyun static struct cpci_hp_controller zt5550_hpc;
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun /* Primary cPCI bus bridge device */
47*4882a593Smuzhiyun static struct pci_dev *bus0_dev;
48*4882a593Smuzhiyun static struct pci_bus *bus0;
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun /* Host controller device */
51*4882a593Smuzhiyun static struct pci_dev *hc_dev;
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun /* Host controller register addresses */
54*4882a593Smuzhiyun static void __iomem *hc_registers;
55*4882a593Smuzhiyun static void __iomem *csr_hc_index;
56*4882a593Smuzhiyun static void __iomem *csr_hc_data;
57*4882a593Smuzhiyun static void __iomem *csr_int_status;
58*4882a593Smuzhiyun static void __iomem *csr_int_mask;
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun
zt5550_hc_config(struct pci_dev * pdev)61*4882a593Smuzhiyun static int zt5550_hc_config(struct pci_dev *pdev)
62*4882a593Smuzhiyun {
63*4882a593Smuzhiyun int ret;
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun /* Since we know that no boards exist with two HC chips, treat it as an error */
66*4882a593Smuzhiyun if (hc_dev) {
67*4882a593Smuzhiyun err("too many host controller devices?");
68*4882a593Smuzhiyun return -EBUSY;
69*4882a593Smuzhiyun }
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun ret = pci_enable_device(pdev);
72*4882a593Smuzhiyun if (ret) {
73*4882a593Smuzhiyun err("cannot enable %s\n", pci_name(pdev));
74*4882a593Smuzhiyun return ret;
75*4882a593Smuzhiyun }
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun hc_dev = pdev;
78*4882a593Smuzhiyun dbg("hc_dev = %p", hc_dev);
79*4882a593Smuzhiyun dbg("pci resource start %llx", (unsigned long long)pci_resource_start(hc_dev, 1));
80*4882a593Smuzhiyun dbg("pci resource len %llx", (unsigned long long)pci_resource_len(hc_dev, 1));
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun if (!request_mem_region(pci_resource_start(hc_dev, 1),
83*4882a593Smuzhiyun pci_resource_len(hc_dev, 1), MY_NAME)) {
84*4882a593Smuzhiyun err("cannot reserve MMIO region");
85*4882a593Smuzhiyun ret = -ENOMEM;
86*4882a593Smuzhiyun goto exit_disable_device;
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun hc_registers =
90*4882a593Smuzhiyun ioremap(pci_resource_start(hc_dev, 1), pci_resource_len(hc_dev, 1));
91*4882a593Smuzhiyun if (!hc_registers) {
92*4882a593Smuzhiyun err("cannot remap MMIO region %llx @ %llx",
93*4882a593Smuzhiyun (unsigned long long)pci_resource_len(hc_dev, 1),
94*4882a593Smuzhiyun (unsigned long long)pci_resource_start(hc_dev, 1));
95*4882a593Smuzhiyun ret = -ENODEV;
96*4882a593Smuzhiyun goto exit_release_region;
97*4882a593Smuzhiyun }
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun csr_hc_index = hc_registers + CSR_HCINDEX;
100*4882a593Smuzhiyun csr_hc_data = hc_registers + CSR_HCDATA;
101*4882a593Smuzhiyun csr_int_status = hc_registers + CSR_INTSTAT;
102*4882a593Smuzhiyun csr_int_mask = hc_registers + CSR_INTMASK;
103*4882a593Smuzhiyun
104*4882a593Smuzhiyun /*
105*4882a593Smuzhiyun * Disable host control, fault and serial interrupts
106*4882a593Smuzhiyun */
107*4882a593Smuzhiyun dbg("disabling host control, fault and serial interrupts");
108*4882a593Smuzhiyun writeb((u8) HC_INT_MASK_REG, csr_hc_index);
109*4882a593Smuzhiyun writeb((u8) ALL_INDEXED_INTS_MASK, csr_hc_data);
110*4882a593Smuzhiyun dbg("disabled host control, fault and serial interrupts");
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun /*
113*4882a593Smuzhiyun * Disable timer0, timer1 and ENUM interrupts
114*4882a593Smuzhiyun */
115*4882a593Smuzhiyun dbg("disabling timer0, timer1 and ENUM interrupts");
116*4882a593Smuzhiyun writeb((u8) ALL_DIRECT_INTS_MASK, csr_int_mask);
117*4882a593Smuzhiyun dbg("disabled timer0, timer1 and ENUM interrupts");
118*4882a593Smuzhiyun return 0;
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun exit_release_region:
121*4882a593Smuzhiyun release_mem_region(pci_resource_start(hc_dev, 1),
122*4882a593Smuzhiyun pci_resource_len(hc_dev, 1));
123*4882a593Smuzhiyun exit_disable_device:
124*4882a593Smuzhiyun pci_disable_device(hc_dev);
125*4882a593Smuzhiyun return ret;
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun
zt5550_hc_cleanup(void)128*4882a593Smuzhiyun static int zt5550_hc_cleanup(void)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun if (!hc_dev)
131*4882a593Smuzhiyun return -ENODEV;
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun iounmap(hc_registers);
134*4882a593Smuzhiyun release_mem_region(pci_resource_start(hc_dev, 1),
135*4882a593Smuzhiyun pci_resource_len(hc_dev, 1));
136*4882a593Smuzhiyun pci_disable_device(hc_dev);
137*4882a593Smuzhiyun return 0;
138*4882a593Smuzhiyun }
139*4882a593Smuzhiyun
zt5550_hc_query_enum(void)140*4882a593Smuzhiyun static int zt5550_hc_query_enum(void)
141*4882a593Smuzhiyun {
142*4882a593Smuzhiyun u8 value;
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun value = inb_p(ENUM_PORT);
145*4882a593Smuzhiyun return ((value & ENUM_MASK) == ENUM_MASK);
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun
zt5550_hc_check_irq(void * dev_id)148*4882a593Smuzhiyun static int zt5550_hc_check_irq(void *dev_id)
149*4882a593Smuzhiyun {
150*4882a593Smuzhiyun int ret;
151*4882a593Smuzhiyun u8 reg;
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun ret = 0;
154*4882a593Smuzhiyun if (dev_id == zt5550_hpc.dev_id) {
155*4882a593Smuzhiyun reg = readb(csr_int_status);
156*4882a593Smuzhiyun if (reg)
157*4882a593Smuzhiyun ret = 1;
158*4882a593Smuzhiyun }
159*4882a593Smuzhiyun return ret;
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun
zt5550_hc_enable_irq(void)162*4882a593Smuzhiyun static int zt5550_hc_enable_irq(void)
163*4882a593Smuzhiyun {
164*4882a593Smuzhiyun u8 reg;
165*4882a593Smuzhiyun
166*4882a593Smuzhiyun if (hc_dev == NULL)
167*4882a593Smuzhiyun return -ENODEV;
168*4882a593Smuzhiyun
169*4882a593Smuzhiyun reg = readb(csr_int_mask);
170*4882a593Smuzhiyun reg = reg & ~ENUM_INT_MASK;
171*4882a593Smuzhiyun writeb(reg, csr_int_mask);
172*4882a593Smuzhiyun return 0;
173*4882a593Smuzhiyun }
174*4882a593Smuzhiyun
zt5550_hc_disable_irq(void)175*4882a593Smuzhiyun static int zt5550_hc_disable_irq(void)
176*4882a593Smuzhiyun {
177*4882a593Smuzhiyun u8 reg;
178*4882a593Smuzhiyun
179*4882a593Smuzhiyun if (hc_dev == NULL)
180*4882a593Smuzhiyun return -ENODEV;
181*4882a593Smuzhiyun
182*4882a593Smuzhiyun reg = readb(csr_int_mask);
183*4882a593Smuzhiyun reg = reg | ENUM_INT_MASK;
184*4882a593Smuzhiyun writeb(reg, csr_int_mask);
185*4882a593Smuzhiyun return 0;
186*4882a593Smuzhiyun }
187*4882a593Smuzhiyun
zt5550_hc_init_one(struct pci_dev * pdev,const struct pci_device_id * ent)188*4882a593Smuzhiyun static int zt5550_hc_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
189*4882a593Smuzhiyun {
190*4882a593Smuzhiyun int status;
191*4882a593Smuzhiyun
192*4882a593Smuzhiyun status = zt5550_hc_config(pdev);
193*4882a593Smuzhiyun if (status != 0)
194*4882a593Smuzhiyun return status;
195*4882a593Smuzhiyun
196*4882a593Smuzhiyun dbg("returned from zt5550_hc_config");
197*4882a593Smuzhiyun
198*4882a593Smuzhiyun memset(&zt5550_hpc, 0, sizeof(struct cpci_hp_controller));
199*4882a593Smuzhiyun zt5550_hpc_ops.query_enum = zt5550_hc_query_enum;
200*4882a593Smuzhiyun zt5550_hpc.ops = &zt5550_hpc_ops;
201*4882a593Smuzhiyun if (!poll) {
202*4882a593Smuzhiyun zt5550_hpc.irq = hc_dev->irq;
203*4882a593Smuzhiyun zt5550_hpc.irq_flags = IRQF_SHARED;
204*4882a593Smuzhiyun zt5550_hpc.dev_id = hc_dev;
205*4882a593Smuzhiyun
206*4882a593Smuzhiyun zt5550_hpc_ops.enable_irq = zt5550_hc_enable_irq;
207*4882a593Smuzhiyun zt5550_hpc_ops.disable_irq = zt5550_hc_disable_irq;
208*4882a593Smuzhiyun zt5550_hpc_ops.check_irq = zt5550_hc_check_irq;
209*4882a593Smuzhiyun } else {
210*4882a593Smuzhiyun info("using ENUM# polling mode");
211*4882a593Smuzhiyun }
212*4882a593Smuzhiyun
213*4882a593Smuzhiyun status = cpci_hp_register_controller(&zt5550_hpc);
214*4882a593Smuzhiyun if (status != 0) {
215*4882a593Smuzhiyun err("could not register cPCI hotplug controller");
216*4882a593Smuzhiyun goto init_hc_error;
217*4882a593Smuzhiyun }
218*4882a593Smuzhiyun dbg("registered controller");
219*4882a593Smuzhiyun
220*4882a593Smuzhiyun /* Look for first device matching cPCI bus's bridge vendor and device IDs */
221*4882a593Smuzhiyun bus0_dev = pci_get_device(PCI_VENDOR_ID_DEC,
222*4882a593Smuzhiyun PCI_DEVICE_ID_DEC_21154, NULL);
223*4882a593Smuzhiyun if (!bus0_dev) {
224*4882a593Smuzhiyun status = -ENODEV;
225*4882a593Smuzhiyun goto init_register_error;
226*4882a593Smuzhiyun }
227*4882a593Smuzhiyun bus0 = bus0_dev->subordinate;
228*4882a593Smuzhiyun pci_dev_put(bus0_dev);
229*4882a593Smuzhiyun
230*4882a593Smuzhiyun status = cpci_hp_register_bus(bus0, 0x0a, 0x0f);
231*4882a593Smuzhiyun if (status != 0) {
232*4882a593Smuzhiyun err("could not register cPCI hotplug bus");
233*4882a593Smuzhiyun goto init_register_error;
234*4882a593Smuzhiyun }
235*4882a593Smuzhiyun dbg("registered bus");
236*4882a593Smuzhiyun
237*4882a593Smuzhiyun status = cpci_hp_start();
238*4882a593Smuzhiyun if (status != 0) {
239*4882a593Smuzhiyun err("could not started cPCI hotplug system");
240*4882a593Smuzhiyun cpci_hp_unregister_bus(bus0);
241*4882a593Smuzhiyun goto init_register_error;
242*4882a593Smuzhiyun }
243*4882a593Smuzhiyun dbg("started cpci hp system");
244*4882a593Smuzhiyun
245*4882a593Smuzhiyun return 0;
246*4882a593Smuzhiyun init_register_error:
247*4882a593Smuzhiyun cpci_hp_unregister_controller(&zt5550_hpc);
248*4882a593Smuzhiyun init_hc_error:
249*4882a593Smuzhiyun err("status = %d", status);
250*4882a593Smuzhiyun zt5550_hc_cleanup();
251*4882a593Smuzhiyun return status;
252*4882a593Smuzhiyun
253*4882a593Smuzhiyun }
254*4882a593Smuzhiyun
zt5550_hc_remove_one(struct pci_dev * pdev)255*4882a593Smuzhiyun static void zt5550_hc_remove_one(struct pci_dev *pdev)
256*4882a593Smuzhiyun {
257*4882a593Smuzhiyun cpci_hp_stop();
258*4882a593Smuzhiyun cpci_hp_unregister_bus(bus0);
259*4882a593Smuzhiyun cpci_hp_unregister_controller(&zt5550_hpc);
260*4882a593Smuzhiyun zt5550_hc_cleanup();
261*4882a593Smuzhiyun }
262*4882a593Smuzhiyun
263*4882a593Smuzhiyun
264*4882a593Smuzhiyun static const struct pci_device_id zt5550_hc_pci_tbl[] = {
265*4882a593Smuzhiyun { PCI_VENDOR_ID_ZIATECH, PCI_DEVICE_ID_ZIATECH_5550_HC, PCI_ANY_ID, PCI_ANY_ID, },
266*4882a593Smuzhiyun { 0, }
267*4882a593Smuzhiyun };
268*4882a593Smuzhiyun MODULE_DEVICE_TABLE(pci, zt5550_hc_pci_tbl);
269*4882a593Smuzhiyun
270*4882a593Smuzhiyun static struct pci_driver zt5550_hc_driver = {
271*4882a593Smuzhiyun .name = "zt5550_hc",
272*4882a593Smuzhiyun .id_table = zt5550_hc_pci_tbl,
273*4882a593Smuzhiyun .probe = zt5550_hc_init_one,
274*4882a593Smuzhiyun .remove = zt5550_hc_remove_one,
275*4882a593Smuzhiyun };
276*4882a593Smuzhiyun
zt5550_init(void)277*4882a593Smuzhiyun static int __init zt5550_init(void)
278*4882a593Smuzhiyun {
279*4882a593Smuzhiyun struct resource *r;
280*4882a593Smuzhiyun int rc;
281*4882a593Smuzhiyun
282*4882a593Smuzhiyun info(DRIVER_DESC " version: " DRIVER_VERSION);
283*4882a593Smuzhiyun r = request_region(ENUM_PORT, 1, "#ENUM hotswap signal register");
284*4882a593Smuzhiyun if (!r)
285*4882a593Smuzhiyun return -EBUSY;
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun rc = pci_register_driver(&zt5550_hc_driver);
288*4882a593Smuzhiyun if (rc < 0)
289*4882a593Smuzhiyun release_region(ENUM_PORT, 1);
290*4882a593Smuzhiyun return rc;
291*4882a593Smuzhiyun }
292*4882a593Smuzhiyun
293*4882a593Smuzhiyun static void __exit
zt5550_exit(void)294*4882a593Smuzhiyun zt5550_exit(void)
295*4882a593Smuzhiyun {
296*4882a593Smuzhiyun pci_unregister_driver(&zt5550_hc_driver);
297*4882a593Smuzhiyun release_region(ENUM_PORT, 1);
298*4882a593Smuzhiyun }
299*4882a593Smuzhiyun
300*4882a593Smuzhiyun module_init(zt5550_init);
301*4882a593Smuzhiyun module_exit(zt5550_exit);
302*4882a593Smuzhiyun
303*4882a593Smuzhiyun MODULE_AUTHOR(DRIVER_AUTHOR);
304*4882a593Smuzhiyun MODULE_DESCRIPTION(DRIVER_DESC);
305*4882a593Smuzhiyun MODULE_LICENSE("GPL");
306*4882a593Smuzhiyun module_param(debug, bool, 0644);
307*4882a593Smuzhiyun MODULE_PARM_DESC(debug, "Debugging mode enabled or not");
308*4882a593Smuzhiyun module_param(poll, bool, 0644);
309*4882a593Smuzhiyun MODULE_PARM_DESC(poll, "#ENUM polling mode enabled or not");
310