xref: /kernel/linux/linux-5.10/drivers/ssb/main.c (revision 8c2ecf20)
1/*
2 * Sonics Silicon Backplane
3 * Subsystem core
4 *
5 * Copyright 2005, Broadcom Corporation
6 * Copyright 2006, 2007, Michael Buesch <m@bues.ch>
7 *
8 * Licensed under the GNU/GPL. See COPYING for details.
9 */
10
11#include "ssb_private.h"
12
13#include <linux/delay.h>
14#include <linux/io.h>
15#include <linux/module.h>
16#include <linux/platform_device.h>
17#include <linux/ssb/ssb.h>
18#include <linux/ssb/ssb_regs.h>
19#include <linux/ssb/ssb_driver_gige.h>
20#include <linux/dma-mapping.h>
21#include <linux/pci.h>
22#include <linux/mmc/sdio_func.h>
23#include <linux/slab.h>
24
25#include <pcmcia/cistpl.h>
26#include <pcmcia/ds.h>
27
28
29MODULE_DESCRIPTION("Sonics Silicon Backplane driver");
30MODULE_LICENSE("GPL");
31
32
33/* Temporary list of yet-to-be-attached buses */
34static LIST_HEAD(attach_queue);
35/* List if running buses */
36static LIST_HEAD(buses);
37/* Software ID counter */
38static unsigned int next_busnumber;
39/* buses_mutes locks the two buslists and the next_busnumber.
40 * Don't lock this directly, but use ssb_buses_[un]lock() below. */
41static DEFINE_MUTEX(buses_mutex);
42
43/* There are differences in the codeflow, if the bus is
44 * initialized from early boot, as various needed services
45 * are not available early. This is a mechanism to delay
46 * these initializations to after early boot has finished.
47 * It's also used to avoid mutex locking, as that's not
48 * available and needed early. */
49static bool ssb_is_early_boot = 1;
50
51static void ssb_buses_lock(void);
52static void ssb_buses_unlock(void);
53
54
55#ifdef CONFIG_SSB_PCIHOST
56struct ssb_bus *ssb_pci_dev_to_bus(struct pci_dev *pdev)
57{
58	struct ssb_bus *bus;
59
60	ssb_buses_lock();
61	list_for_each_entry(bus, &buses, list) {
62		if (bus->bustype == SSB_BUSTYPE_PCI &&
63		    bus->host_pci == pdev)
64			goto found;
65	}
66	bus = NULL;
67found:
68	ssb_buses_unlock();
69
70	return bus;
71}
72#endif /* CONFIG_SSB_PCIHOST */
73
74#ifdef CONFIG_SSB_PCMCIAHOST
75struct ssb_bus *ssb_pcmcia_dev_to_bus(struct pcmcia_device *pdev)
76{
77	struct ssb_bus *bus;
78
79	ssb_buses_lock();
80	list_for_each_entry(bus, &buses, list) {
81		if (bus->bustype == SSB_BUSTYPE_PCMCIA &&
82		    bus->host_pcmcia == pdev)
83			goto found;
84	}
85	bus = NULL;
86found:
87	ssb_buses_unlock();
88
89	return bus;
90}
91#endif /* CONFIG_SSB_PCMCIAHOST */
92
93int ssb_for_each_bus_call(unsigned long data,
94			  int (*func)(struct ssb_bus *bus, unsigned long data))
95{
96	struct ssb_bus *bus;
97	int res;
98
99	ssb_buses_lock();
100	list_for_each_entry(bus, &buses, list) {
101		res = func(bus, data);
102		if (res >= 0) {
103			ssb_buses_unlock();
104			return res;
105		}
106	}
107	ssb_buses_unlock();
108
109	return -ENODEV;
110}
111
112static struct ssb_device *ssb_device_get(struct ssb_device *dev)
113{
114	if (dev)
115		get_device(dev->dev);
116	return dev;
117}
118
119static void ssb_device_put(struct ssb_device *dev)
120{
121	if (dev)
122		put_device(dev->dev);
123}
124
125static int ssb_device_resume(struct device *dev)
126{
127	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
128	struct ssb_driver *ssb_drv;
129	int err = 0;
130
131	if (dev->driver) {
132		ssb_drv = drv_to_ssb_drv(dev->driver);
133		if (ssb_drv && ssb_drv->resume)
134			err = ssb_drv->resume(ssb_dev);
135		if (err)
136			goto out;
137	}
138out:
139	return err;
140}
141
142static int ssb_device_suspend(struct device *dev, pm_message_t state)
143{
144	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
145	struct ssb_driver *ssb_drv;
146	int err = 0;
147
148	if (dev->driver) {
149		ssb_drv = drv_to_ssb_drv(dev->driver);
150		if (ssb_drv && ssb_drv->suspend)
151			err = ssb_drv->suspend(ssb_dev, state);
152		if (err)
153			goto out;
154	}
155out:
156	return err;
157}
158
159int ssb_bus_resume(struct ssb_bus *bus)
160{
161	int err;
162
163	/* Reset HW state information in memory, so that HW is
164	 * completely reinitialized. */
165	bus->mapped_device = NULL;
166#ifdef CONFIG_SSB_DRIVER_PCICORE
167	bus->pcicore.setup_done = 0;
168#endif
169
170	err = ssb_bus_powerup(bus, 0);
171	if (err)
172		return err;
173	err = ssb_pcmcia_hardware_setup(bus);
174	if (err) {
175		ssb_bus_may_powerdown(bus);
176		return err;
177	}
178	ssb_chipco_resume(&bus->chipco);
179	ssb_bus_may_powerdown(bus);
180
181	return 0;
182}
183EXPORT_SYMBOL(ssb_bus_resume);
184
185int ssb_bus_suspend(struct ssb_bus *bus)
186{
187	ssb_chipco_suspend(&bus->chipco);
188	ssb_pci_xtal(bus, SSB_GPIO_XTAL | SSB_GPIO_PLL, 0);
189
190	return 0;
191}
192EXPORT_SYMBOL(ssb_bus_suspend);
193
194#ifdef CONFIG_SSB_SPROM
195/** ssb_devices_freeze - Freeze all devices on the bus.
196 *
197 * After freezing no device driver will be handling a device
198 * on this bus anymore. ssb_devices_thaw() must be called after
199 * a successful freeze to reactivate the devices.
200 *
201 * @bus: The bus.
202 * @ctx: Context structure. Pass this to ssb_devices_thaw().
203 */
204int ssb_devices_freeze(struct ssb_bus *bus, struct ssb_freeze_context *ctx)
205{
206	struct ssb_device *sdev;
207	struct ssb_driver *sdrv;
208	unsigned int i;
209
210	memset(ctx, 0, sizeof(*ctx));
211	ctx->bus = bus;
212	WARN_ON(bus->nr_devices > ARRAY_SIZE(ctx->device_frozen));
213
214	for (i = 0; i < bus->nr_devices; i++) {
215		sdev = ssb_device_get(&bus->devices[i]);
216
217		if (!sdev->dev || !sdev->dev->driver ||
218		    !device_is_registered(sdev->dev)) {
219			ssb_device_put(sdev);
220			continue;
221		}
222		sdrv = drv_to_ssb_drv(sdev->dev->driver);
223		if (WARN_ON(!sdrv->remove))
224			continue;
225		sdrv->remove(sdev);
226		ctx->device_frozen[i] = 1;
227	}
228
229	return 0;
230}
231
232/** ssb_devices_thaw - Unfreeze all devices on the bus.
233 *
234 * This will re-attach the device drivers and re-init the devices.
235 *
236 * @ctx: The context structure from ssb_devices_freeze()
237 */
238int ssb_devices_thaw(struct ssb_freeze_context *ctx)
239{
240	struct ssb_bus *bus = ctx->bus;
241	struct ssb_device *sdev;
242	struct ssb_driver *sdrv;
243	unsigned int i;
244	int err, result = 0;
245
246	for (i = 0; i < bus->nr_devices; i++) {
247		if (!ctx->device_frozen[i])
248			continue;
249		sdev = &bus->devices[i];
250
251		if (WARN_ON(!sdev->dev || !sdev->dev->driver))
252			continue;
253		sdrv = drv_to_ssb_drv(sdev->dev->driver);
254		if (WARN_ON(!sdrv || !sdrv->probe))
255			continue;
256
257		err = sdrv->probe(sdev, &sdev->id);
258		if (err) {
259			dev_err(sdev->dev,
260				"Failed to thaw device %s\n",
261				dev_name(sdev->dev));
262			result = err;
263		}
264		ssb_device_put(sdev);
265	}
266
267	return result;
268}
269#endif /* CONFIG_SSB_SPROM */
270
271static void ssb_device_shutdown(struct device *dev)
272{
273	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
274	struct ssb_driver *ssb_drv;
275
276	if (!dev->driver)
277		return;
278	ssb_drv = drv_to_ssb_drv(dev->driver);
279	if (ssb_drv && ssb_drv->shutdown)
280		ssb_drv->shutdown(ssb_dev);
281}
282
283static int ssb_device_remove(struct device *dev)
284{
285	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
286	struct ssb_driver *ssb_drv = drv_to_ssb_drv(dev->driver);
287
288	if (ssb_drv && ssb_drv->remove)
289		ssb_drv->remove(ssb_dev);
290	ssb_device_put(ssb_dev);
291
292	return 0;
293}
294
295static int ssb_device_probe(struct device *dev)
296{
297	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
298	struct ssb_driver *ssb_drv = drv_to_ssb_drv(dev->driver);
299	int err = 0;
300
301	ssb_device_get(ssb_dev);
302	if (ssb_drv && ssb_drv->probe)
303		err = ssb_drv->probe(ssb_dev, &ssb_dev->id);
304	if (err)
305		ssb_device_put(ssb_dev);
306
307	return err;
308}
309
310static int ssb_match_devid(const struct ssb_device_id *tabid,
311			   const struct ssb_device_id *devid)
312{
313	if ((tabid->vendor != devid->vendor) &&
314	    tabid->vendor != SSB_ANY_VENDOR)
315		return 0;
316	if ((tabid->coreid != devid->coreid) &&
317	    tabid->coreid != SSB_ANY_ID)
318		return 0;
319	if ((tabid->revision != devid->revision) &&
320	    tabid->revision != SSB_ANY_REV)
321		return 0;
322	return 1;
323}
324
325static int ssb_bus_match(struct device *dev, struct device_driver *drv)
326{
327	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
328	struct ssb_driver *ssb_drv = drv_to_ssb_drv(drv);
329	const struct ssb_device_id *id;
330
331	for (id = ssb_drv->id_table;
332	     id->vendor || id->coreid || id->revision;
333	     id++) {
334		if (ssb_match_devid(id, &ssb_dev->id))
335			return 1; /* found */
336	}
337
338	return 0;
339}
340
341static int ssb_device_uevent(struct device *dev, struct kobj_uevent_env *env)
342{
343	struct ssb_device *ssb_dev = dev_to_ssb_dev(dev);
344
345	if (!dev)
346		return -ENODEV;
347
348	return add_uevent_var(env,
349			     "MODALIAS=ssb:v%04Xid%04Xrev%02X",
350			     ssb_dev->id.vendor, ssb_dev->id.coreid,
351			     ssb_dev->id.revision);
352}
353
354#define ssb_config_attr(attrib, field, format_string) \
355static ssize_t \
356attrib##_show(struct device *dev, struct device_attribute *attr, char *buf) \
357{ \
358	return sprintf(buf, format_string, dev_to_ssb_dev(dev)->field); \
359} \
360static DEVICE_ATTR_RO(attrib);
361
362ssb_config_attr(core_num, core_index, "%u\n")
363ssb_config_attr(coreid, id.coreid, "0x%04x\n")
364ssb_config_attr(vendor, id.vendor, "0x%04x\n")
365ssb_config_attr(revision, id.revision, "%u\n")
366ssb_config_attr(irq, irq, "%u\n")
367static ssize_t
368name_show(struct device *dev, struct device_attribute *attr, char *buf)
369{
370	return sprintf(buf, "%s\n",
371		       ssb_core_name(dev_to_ssb_dev(dev)->id.coreid));
372}
373static DEVICE_ATTR_RO(name);
374
375static struct attribute *ssb_device_attrs[] = {
376	&dev_attr_name.attr,
377	&dev_attr_core_num.attr,
378	&dev_attr_coreid.attr,
379	&dev_attr_vendor.attr,
380	&dev_attr_revision.attr,
381	&dev_attr_irq.attr,
382	NULL,
383};
384ATTRIBUTE_GROUPS(ssb_device);
385
386static struct bus_type ssb_bustype = {
387	.name		= "ssb",
388	.match		= ssb_bus_match,
389	.probe		= ssb_device_probe,
390	.remove		= ssb_device_remove,
391	.shutdown	= ssb_device_shutdown,
392	.suspend	= ssb_device_suspend,
393	.resume		= ssb_device_resume,
394	.uevent		= ssb_device_uevent,
395	.dev_groups	= ssb_device_groups,
396};
397
398static void ssb_buses_lock(void)
399{
400	/* See the comment at the ssb_is_early_boot definition */
401	if (!ssb_is_early_boot)
402		mutex_lock(&buses_mutex);
403}
404
405static void ssb_buses_unlock(void)
406{
407	/* See the comment at the ssb_is_early_boot definition */
408	if (!ssb_is_early_boot)
409		mutex_unlock(&buses_mutex);
410}
411
412static void ssb_devices_unregister(struct ssb_bus *bus)
413{
414	struct ssb_device *sdev;
415	int i;
416
417	for (i = bus->nr_devices - 1; i >= 0; i--) {
418		sdev = &(bus->devices[i]);
419		if (sdev->dev)
420			device_unregister(sdev->dev);
421	}
422
423#ifdef CONFIG_SSB_EMBEDDED
424	if (bus->bustype == SSB_BUSTYPE_SSB)
425		platform_device_unregister(bus->watchdog);
426#endif
427}
428
429void ssb_bus_unregister(struct ssb_bus *bus)
430{
431	int err;
432
433	err = ssb_gpio_unregister(bus);
434	if (err == -EBUSY)
435		pr_debug("Some GPIOs are still in use\n");
436	else if (err)
437		pr_debug("Can not unregister GPIO driver: %i\n", err);
438
439	ssb_buses_lock();
440	ssb_devices_unregister(bus);
441	list_del(&bus->list);
442	ssb_buses_unlock();
443
444	ssb_pcmcia_exit(bus);
445	ssb_pci_exit(bus);
446	ssb_iounmap(bus);
447}
448EXPORT_SYMBOL(ssb_bus_unregister);
449
450static void ssb_release_dev(struct device *dev)
451{
452	struct __ssb_dev_wrapper *devwrap;
453
454	devwrap = container_of(dev, struct __ssb_dev_wrapper, dev);
455	kfree(devwrap);
456}
457
458static int ssb_devices_register(struct ssb_bus *bus)
459{
460	struct ssb_device *sdev;
461	struct device *dev;
462	struct __ssb_dev_wrapper *devwrap;
463	int i, err = 0;
464	int dev_idx = 0;
465
466	for (i = 0; i < bus->nr_devices; i++) {
467		sdev = &(bus->devices[i]);
468
469		/* We don't register SSB-system devices to the kernel,
470		 * as the drivers for them are built into SSB. */
471		switch (sdev->id.coreid) {
472		case SSB_DEV_CHIPCOMMON:
473		case SSB_DEV_PCI:
474		case SSB_DEV_PCIE:
475		case SSB_DEV_PCMCIA:
476		case SSB_DEV_MIPS:
477		case SSB_DEV_MIPS_3302:
478		case SSB_DEV_EXTIF:
479			continue;
480		}
481
482		devwrap = kzalloc(sizeof(*devwrap), GFP_KERNEL);
483		if (!devwrap) {
484			err = -ENOMEM;
485			goto error;
486		}
487		dev = &devwrap->dev;
488		devwrap->sdev = sdev;
489
490		dev->release = ssb_release_dev;
491		dev->bus = &ssb_bustype;
492		dev_set_name(dev, "ssb%u:%d", bus->busnumber, dev_idx);
493
494		switch (bus->bustype) {
495		case SSB_BUSTYPE_PCI:
496#ifdef CONFIG_SSB_PCIHOST
497			sdev->irq = bus->host_pci->irq;
498			dev->parent = &bus->host_pci->dev;
499			sdev->dma_dev = dev->parent;
500#endif
501			break;
502		case SSB_BUSTYPE_PCMCIA:
503#ifdef CONFIG_SSB_PCMCIAHOST
504			sdev->irq = bus->host_pcmcia->irq;
505			dev->parent = &bus->host_pcmcia->dev;
506#endif
507			break;
508		case SSB_BUSTYPE_SDIO:
509#ifdef CONFIG_SSB_SDIOHOST
510			dev->parent = &bus->host_sdio->dev;
511#endif
512			break;
513		case SSB_BUSTYPE_SSB:
514			dev->dma_mask = &dev->coherent_dma_mask;
515			sdev->dma_dev = dev;
516			break;
517		}
518
519		sdev->dev = dev;
520		err = device_register(dev);
521		if (err) {
522			pr_err("Could not register %s\n", dev_name(dev));
523			/* Set dev to NULL to not unregister
524			 * dev on error unwinding. */
525			sdev->dev = NULL;
526			put_device(dev);
527			goto error;
528		}
529		dev_idx++;
530	}
531
532#ifdef CONFIG_SSB_DRIVER_MIPS
533	if (bus->mipscore.pflash.present) {
534		err = platform_device_register(&ssb_pflash_dev);
535		if (err)
536			pr_err("Error registering parallel flash\n");
537	}
538#endif
539
540#ifdef CONFIG_SSB_SFLASH
541	if (bus->mipscore.sflash.present) {
542		err = platform_device_register(&ssb_sflash_dev);
543		if (err)
544			pr_err("Error registering serial flash\n");
545	}
546#endif
547
548	return 0;
549error:
550	/* Unwind the already registered devices. */
551	ssb_devices_unregister(bus);
552	return err;
553}
554
555/* Needs ssb_buses_lock() */
556static int ssb_attach_queued_buses(void)
557{
558	struct ssb_bus *bus, *n;
559	int err = 0;
560	int drop_them_all = 0;
561
562	list_for_each_entry_safe(bus, n, &attach_queue, list) {
563		if (drop_them_all) {
564			list_del(&bus->list);
565			continue;
566		}
567		/* Can't init the PCIcore in ssb_bus_register(), as that
568		 * is too early in boot for embedded systems
569		 * (no udelay() available). So do it here in attach stage.
570		 */
571		err = ssb_bus_powerup(bus, 0);
572		if (err)
573			goto error;
574		ssb_pcicore_init(&bus->pcicore);
575		if (bus->bustype == SSB_BUSTYPE_SSB)
576			ssb_watchdog_register(bus);
577
578		err = ssb_gpio_init(bus);
579		if (err == -ENOTSUPP)
580			pr_debug("GPIO driver not activated\n");
581		else if (err)
582			pr_debug("Error registering GPIO driver: %i\n", err);
583
584		ssb_bus_may_powerdown(bus);
585
586		err = ssb_devices_register(bus);
587error:
588		if (err) {
589			drop_them_all = 1;
590			list_del(&bus->list);
591			continue;
592		}
593		list_move_tail(&bus->list, &buses);
594	}
595
596	return err;
597}
598
599static int ssb_fetch_invariants(struct ssb_bus *bus,
600				ssb_invariants_func_t get_invariants)
601{
602	struct ssb_init_invariants iv;
603	int err;
604
605	memset(&iv, 0, sizeof(iv));
606	err = get_invariants(bus, &iv);
607	if (err)
608		goto out;
609	memcpy(&bus->boardinfo, &iv.boardinfo, sizeof(iv.boardinfo));
610	memcpy(&bus->sprom, &iv.sprom, sizeof(iv.sprom));
611	bus->has_cardbus_slot = iv.has_cardbus_slot;
612out:
613	return err;
614}
615
616static int __maybe_unused
617ssb_bus_register(struct ssb_bus *bus,
618		 ssb_invariants_func_t get_invariants,
619		 unsigned long baseaddr)
620{
621	int err;
622
623	spin_lock_init(&bus->bar_lock);
624	INIT_LIST_HEAD(&bus->list);
625#ifdef CONFIG_SSB_EMBEDDED
626	spin_lock_init(&bus->gpio_lock);
627#endif
628
629	/* Powerup the bus */
630	err = ssb_pci_xtal(bus, SSB_GPIO_XTAL | SSB_GPIO_PLL, 1);
631	if (err)
632		goto out;
633
634	/* Init SDIO-host device (if any), before the scan */
635	err = ssb_sdio_init(bus);
636	if (err)
637		goto err_disable_xtal;
638
639	ssb_buses_lock();
640	bus->busnumber = next_busnumber;
641	/* Scan for devices (cores) */
642	err = ssb_bus_scan(bus, baseaddr);
643	if (err)
644		goto err_sdio_exit;
645
646	/* Init PCI-host device (if any) */
647	err = ssb_pci_init(bus);
648	if (err)
649		goto err_unmap;
650	/* Init PCMCIA-host device (if any) */
651	err = ssb_pcmcia_init(bus);
652	if (err)
653		goto err_pci_exit;
654
655	/* Initialize basic system devices (if available) */
656	err = ssb_bus_powerup(bus, 0);
657	if (err)
658		goto err_pcmcia_exit;
659	ssb_chipcommon_init(&bus->chipco);
660	ssb_extif_init(&bus->extif);
661	ssb_mipscore_init(&bus->mipscore);
662	err = ssb_fetch_invariants(bus, get_invariants);
663	if (err) {
664		ssb_bus_may_powerdown(bus);
665		goto err_pcmcia_exit;
666	}
667	ssb_bus_may_powerdown(bus);
668
669	/* Queue it for attach.
670	 * See the comment at the ssb_is_early_boot definition. */
671	list_add_tail(&bus->list, &attach_queue);
672	if (!ssb_is_early_boot) {
673		/* This is not early boot, so we must attach the bus now */
674		err = ssb_attach_queued_buses();
675		if (err)
676			goto err_dequeue;
677	}
678	next_busnumber++;
679	ssb_buses_unlock();
680
681out:
682	return err;
683
684err_dequeue:
685	list_del(&bus->list);
686err_pcmcia_exit:
687	ssb_pcmcia_exit(bus);
688err_pci_exit:
689	ssb_pci_exit(bus);
690err_unmap:
691	ssb_iounmap(bus);
692err_sdio_exit:
693	ssb_sdio_exit(bus);
694err_disable_xtal:
695	ssb_buses_unlock();
696	ssb_pci_xtal(bus, SSB_GPIO_XTAL | SSB_GPIO_PLL, 0);
697	return err;
698}
699
700#ifdef CONFIG_SSB_PCIHOST
701int ssb_bus_pcibus_register(struct ssb_bus *bus, struct pci_dev *host_pci)
702{
703	int err;
704
705	bus->bustype = SSB_BUSTYPE_PCI;
706	bus->host_pci = host_pci;
707	bus->ops = &ssb_pci_ops;
708
709	err = ssb_bus_register(bus, ssb_pci_get_invariants, 0);
710	if (!err) {
711		dev_info(&host_pci->dev,
712			 "Sonics Silicon Backplane found on PCI device %s\n",
713			 dev_name(&host_pci->dev));
714	} else {
715		dev_err(&host_pci->dev,
716			"Failed to register PCI version of SSB with error %d\n",
717			err);
718	}
719
720	return err;
721}
722#endif /* CONFIG_SSB_PCIHOST */
723
724#ifdef CONFIG_SSB_PCMCIAHOST
725int ssb_bus_pcmciabus_register(struct ssb_bus *bus,
726			       struct pcmcia_device *pcmcia_dev,
727			       unsigned long baseaddr)
728{
729	int err;
730
731	bus->bustype = SSB_BUSTYPE_PCMCIA;
732	bus->host_pcmcia = pcmcia_dev;
733	bus->ops = &ssb_pcmcia_ops;
734
735	err = ssb_bus_register(bus, ssb_pcmcia_get_invariants, baseaddr);
736	if (!err) {
737		dev_info(&pcmcia_dev->dev,
738			 "Sonics Silicon Backplane found on PCMCIA device %s\n",
739			 pcmcia_dev->devname);
740	}
741
742	return err;
743}
744#endif /* CONFIG_SSB_PCMCIAHOST */
745
746#ifdef CONFIG_SSB_SDIOHOST
747int ssb_bus_sdiobus_register(struct ssb_bus *bus, struct sdio_func *func,
748			     unsigned int quirks)
749{
750	int err;
751
752	bus->bustype = SSB_BUSTYPE_SDIO;
753	bus->host_sdio = func;
754	bus->ops = &ssb_sdio_ops;
755	bus->quirks = quirks;
756
757	err = ssb_bus_register(bus, ssb_sdio_get_invariants, ~0);
758	if (!err) {
759		dev_info(&func->dev,
760			 "Sonics Silicon Backplane found on SDIO device %s\n",
761			 sdio_func_id(func));
762	}
763
764	return err;
765}
766EXPORT_SYMBOL(ssb_bus_sdiobus_register);
767#endif /* CONFIG_SSB_PCMCIAHOST */
768
769#ifdef CONFIG_SSB_HOST_SOC
770int ssb_bus_host_soc_register(struct ssb_bus *bus, unsigned long baseaddr)
771{
772	int err;
773
774	bus->bustype = SSB_BUSTYPE_SSB;
775	bus->ops = &ssb_host_soc_ops;
776
777	err = ssb_bus_register(bus, ssb_host_soc_get_invariants, baseaddr);
778	if (!err) {
779		pr_info("Sonics Silicon Backplane found at address 0x%08lX\n",
780			baseaddr);
781	}
782
783	return err;
784}
785#endif
786
787int __ssb_driver_register(struct ssb_driver *drv, struct module *owner)
788{
789	drv->drv.name = drv->name;
790	drv->drv.bus = &ssb_bustype;
791	drv->drv.owner = owner;
792
793	return driver_register(&drv->drv);
794}
795EXPORT_SYMBOL(__ssb_driver_register);
796
797void ssb_driver_unregister(struct ssb_driver *drv)
798{
799	driver_unregister(&drv->drv);
800}
801EXPORT_SYMBOL(ssb_driver_unregister);
802
803void ssb_set_devtypedata(struct ssb_device *dev, void *data)
804{
805	struct ssb_bus *bus = dev->bus;
806	struct ssb_device *ent;
807	int i;
808
809	for (i = 0; i < bus->nr_devices; i++) {
810		ent = &(bus->devices[i]);
811		if (ent->id.vendor != dev->id.vendor)
812			continue;
813		if (ent->id.coreid != dev->id.coreid)
814			continue;
815
816		ent->devtypedata = data;
817	}
818}
819EXPORT_SYMBOL(ssb_set_devtypedata);
820
821static u32 clkfactor_f6_resolve(u32 v)
822{
823	/* map the magic values */
824	switch (v) {
825	case SSB_CHIPCO_CLK_F6_2:
826		return 2;
827	case SSB_CHIPCO_CLK_F6_3:
828		return 3;
829	case SSB_CHIPCO_CLK_F6_4:
830		return 4;
831	case SSB_CHIPCO_CLK_F6_5:
832		return 5;
833	case SSB_CHIPCO_CLK_F6_6:
834		return 6;
835	case SSB_CHIPCO_CLK_F6_7:
836		return 7;
837	}
838	return 0;
839}
840
841/* Calculate the speed the backplane would run at a given set of clockcontrol values */
842u32 ssb_calc_clock_rate(u32 plltype, u32 n, u32 m)
843{
844	u32 n1, n2, clock, m1, m2, m3, mc;
845
846	n1 = (n & SSB_CHIPCO_CLK_N1);
847	n2 = ((n & SSB_CHIPCO_CLK_N2) >> SSB_CHIPCO_CLK_N2_SHIFT);
848
849	switch (plltype) {
850	case SSB_PLLTYPE_6: /* 100/200 or 120/240 only */
851		if (m & SSB_CHIPCO_CLK_T6_MMASK)
852			return SSB_CHIPCO_CLK_T6_M1;
853		return SSB_CHIPCO_CLK_T6_M0;
854	case SSB_PLLTYPE_1: /* 48Mhz base, 3 dividers */
855	case SSB_PLLTYPE_3: /* 25Mhz, 2 dividers */
856	case SSB_PLLTYPE_4: /* 48Mhz, 4 dividers */
857	case SSB_PLLTYPE_7: /* 25Mhz, 4 dividers */
858		n1 = clkfactor_f6_resolve(n1);
859		n2 += SSB_CHIPCO_CLK_F5_BIAS;
860		break;
861	case SSB_PLLTYPE_2: /* 48Mhz, 4 dividers */
862		n1 += SSB_CHIPCO_CLK_T2_BIAS;
863		n2 += SSB_CHIPCO_CLK_T2_BIAS;
864		WARN_ON(!((n1 >= 2) && (n1 <= 7)));
865		WARN_ON(!((n2 >= 5) && (n2 <= 23)));
866		break;
867	case SSB_PLLTYPE_5: /* 25Mhz, 4 dividers */
868		return 100000000;
869	default:
870		WARN_ON(1);
871	}
872
873	switch (plltype) {
874	case SSB_PLLTYPE_3: /* 25Mhz, 2 dividers */
875	case SSB_PLLTYPE_7: /* 25Mhz, 4 dividers */
876		clock = SSB_CHIPCO_CLK_BASE2 * n1 * n2;
877		break;
878	default:
879		clock = SSB_CHIPCO_CLK_BASE1 * n1 * n2;
880	}
881	if (!clock)
882		return 0;
883
884	m1 = (m & SSB_CHIPCO_CLK_M1);
885	m2 = ((m & SSB_CHIPCO_CLK_M2) >> SSB_CHIPCO_CLK_M2_SHIFT);
886	m3 = ((m & SSB_CHIPCO_CLK_M3) >> SSB_CHIPCO_CLK_M3_SHIFT);
887	mc = ((m & SSB_CHIPCO_CLK_MC) >> SSB_CHIPCO_CLK_MC_SHIFT);
888
889	switch (plltype) {
890	case SSB_PLLTYPE_1: /* 48Mhz base, 3 dividers */
891	case SSB_PLLTYPE_3: /* 25Mhz, 2 dividers */
892	case SSB_PLLTYPE_4: /* 48Mhz, 4 dividers */
893	case SSB_PLLTYPE_7: /* 25Mhz, 4 dividers */
894		m1 = clkfactor_f6_resolve(m1);
895		if ((plltype == SSB_PLLTYPE_1) ||
896		    (plltype == SSB_PLLTYPE_3))
897			m2 += SSB_CHIPCO_CLK_F5_BIAS;
898		else
899			m2 = clkfactor_f6_resolve(m2);
900		m3 = clkfactor_f6_resolve(m3);
901
902		switch (mc) {
903		case SSB_CHIPCO_CLK_MC_BYPASS:
904			return clock;
905		case SSB_CHIPCO_CLK_MC_M1:
906			return (clock / m1);
907		case SSB_CHIPCO_CLK_MC_M1M2:
908			return (clock / (m1 * m2));
909		case SSB_CHIPCO_CLK_MC_M1M2M3:
910			return (clock / (m1 * m2 * m3));
911		case SSB_CHIPCO_CLK_MC_M1M3:
912			return (clock / (m1 * m3));
913		}
914		return 0;
915	case SSB_PLLTYPE_2:
916		m1 += SSB_CHIPCO_CLK_T2_BIAS;
917		m2 += SSB_CHIPCO_CLK_T2M2_BIAS;
918		m3 += SSB_CHIPCO_CLK_T2_BIAS;
919		WARN_ON(!((m1 >= 2) && (m1 <= 7)));
920		WARN_ON(!((m2 >= 3) && (m2 <= 10)));
921		WARN_ON(!((m3 >= 2) && (m3 <= 7)));
922
923		if (!(mc & SSB_CHIPCO_CLK_T2MC_M1BYP))
924			clock /= m1;
925		if (!(mc & SSB_CHIPCO_CLK_T2MC_M2BYP))
926			clock /= m2;
927		if (!(mc & SSB_CHIPCO_CLK_T2MC_M3BYP))
928			clock /= m3;
929		return clock;
930	default:
931		WARN_ON(1);
932	}
933	return 0;
934}
935
936/* Get the current speed the backplane is running at */
937u32 ssb_clockspeed(struct ssb_bus *bus)
938{
939	u32 rate;
940	u32 plltype;
941	u32 clkctl_n, clkctl_m;
942
943	if (bus->chipco.capabilities & SSB_CHIPCO_CAP_PMU)
944		return ssb_pmu_get_controlclock(&bus->chipco);
945
946	if (ssb_extif_available(&bus->extif))
947		ssb_extif_get_clockcontrol(&bus->extif, &plltype,
948					   &clkctl_n, &clkctl_m);
949	else if (bus->chipco.dev)
950		ssb_chipco_get_clockcontrol(&bus->chipco, &plltype,
951					    &clkctl_n, &clkctl_m);
952	else
953		return 0;
954
955	if (bus->chip_id == 0x5365) {
956		rate = 100000000;
957	} else {
958		rate = ssb_calc_clock_rate(plltype, clkctl_n, clkctl_m);
959		if (plltype == SSB_PLLTYPE_3) /* 25Mhz, 2 dividers */
960			rate /= 2;
961	}
962
963	return rate;
964}
965EXPORT_SYMBOL(ssb_clockspeed);
966
967static u32 ssb_tmslow_reject_bitmask(struct ssb_device *dev)
968{
969	u32 rev = ssb_read32(dev, SSB_IDLOW) & SSB_IDLOW_SSBREV;
970
971	/* The REJECT bit seems to be different for Backplane rev 2.3 */
972	switch (rev) {
973	case SSB_IDLOW_SSBREV_22:
974	case SSB_IDLOW_SSBREV_24:
975	case SSB_IDLOW_SSBREV_26:
976		return SSB_TMSLOW_REJECT;
977	case SSB_IDLOW_SSBREV_23:
978		return SSB_TMSLOW_REJECT_23;
979	case SSB_IDLOW_SSBREV_25:     /* TODO - find the proper REJECT bit */
980	case SSB_IDLOW_SSBREV_27:     /* same here */
981		return SSB_TMSLOW_REJECT;	/* this is a guess */
982	case SSB_IDLOW_SSBREV:
983		break;
984	default:
985		WARN(1, KERN_INFO "ssb: Backplane Revision 0x%.8X\n", rev);
986	}
987	return (SSB_TMSLOW_REJECT | SSB_TMSLOW_REJECT_23);
988}
989
990int ssb_device_is_enabled(struct ssb_device *dev)
991{
992	u32 val;
993	u32 reject;
994
995	reject = ssb_tmslow_reject_bitmask(dev);
996	val = ssb_read32(dev, SSB_TMSLOW);
997	val &= SSB_TMSLOW_CLOCK | SSB_TMSLOW_RESET | reject;
998
999	return (val == SSB_TMSLOW_CLOCK);
1000}
1001EXPORT_SYMBOL(ssb_device_is_enabled);
1002
1003static void ssb_flush_tmslow(struct ssb_device *dev)
1004{
1005	/* Make _really_ sure the device has finished the TMSLOW
1006	 * register write transaction, as we risk running into
1007	 * a machine check exception otherwise.
1008	 * Do this by reading the register back to commit the
1009	 * PCI write and delay an additional usec for the device
1010	 * to react to the change. */
1011	ssb_read32(dev, SSB_TMSLOW);
1012	udelay(1);
1013}
1014
1015void ssb_device_enable(struct ssb_device *dev, u32 core_specific_flags)
1016{
1017	u32 val;
1018
1019	ssb_device_disable(dev, core_specific_flags);
1020	ssb_write32(dev, SSB_TMSLOW,
1021		    SSB_TMSLOW_RESET | SSB_TMSLOW_CLOCK |
1022		    SSB_TMSLOW_FGC | core_specific_flags);
1023	ssb_flush_tmslow(dev);
1024
1025	/* Clear SERR if set. This is a hw bug workaround. */
1026	if (ssb_read32(dev, SSB_TMSHIGH) & SSB_TMSHIGH_SERR)
1027		ssb_write32(dev, SSB_TMSHIGH, 0);
1028
1029	val = ssb_read32(dev, SSB_IMSTATE);
1030	if (val & (SSB_IMSTATE_IBE | SSB_IMSTATE_TO)) {
1031		val &= ~(SSB_IMSTATE_IBE | SSB_IMSTATE_TO);
1032		ssb_write32(dev, SSB_IMSTATE, val);
1033	}
1034
1035	ssb_write32(dev, SSB_TMSLOW,
1036		    SSB_TMSLOW_CLOCK | SSB_TMSLOW_FGC |
1037		    core_specific_flags);
1038	ssb_flush_tmslow(dev);
1039
1040	ssb_write32(dev, SSB_TMSLOW, SSB_TMSLOW_CLOCK |
1041		    core_specific_flags);
1042	ssb_flush_tmslow(dev);
1043}
1044EXPORT_SYMBOL(ssb_device_enable);
1045
1046/* Wait for bitmask in a register to get set or cleared.
1047 * timeout is in units of ten-microseconds */
1048static int ssb_wait_bits(struct ssb_device *dev, u16 reg, u32 bitmask,
1049			 int timeout, int set)
1050{
1051	int i;
1052	u32 val;
1053
1054	for (i = 0; i < timeout; i++) {
1055		val = ssb_read32(dev, reg);
1056		if (set) {
1057			if ((val & bitmask) == bitmask)
1058				return 0;
1059		} else {
1060			if (!(val & bitmask))
1061				return 0;
1062		}
1063		udelay(10);
1064	}
1065	dev_err(dev->dev,
1066		"Timeout waiting for bitmask %08X on register %04X to %s\n",
1067		bitmask, reg, set ? "set" : "clear");
1068
1069	return -ETIMEDOUT;
1070}
1071
1072void ssb_device_disable(struct ssb_device *dev, u32 core_specific_flags)
1073{
1074	u32 reject, val;
1075
1076	if (ssb_read32(dev, SSB_TMSLOW) & SSB_TMSLOW_RESET)
1077		return;
1078
1079	reject = ssb_tmslow_reject_bitmask(dev);
1080
1081	if (ssb_read32(dev, SSB_TMSLOW) & SSB_TMSLOW_CLOCK) {
1082		ssb_write32(dev, SSB_TMSLOW, reject | SSB_TMSLOW_CLOCK);
1083		ssb_wait_bits(dev, SSB_TMSLOW, reject, 1000, 1);
1084		ssb_wait_bits(dev, SSB_TMSHIGH, SSB_TMSHIGH_BUSY, 1000, 0);
1085
1086		if (ssb_read32(dev, SSB_IDLOW) & SSB_IDLOW_INITIATOR) {
1087			val = ssb_read32(dev, SSB_IMSTATE);
1088			val |= SSB_IMSTATE_REJECT;
1089			ssb_write32(dev, SSB_IMSTATE, val);
1090			ssb_wait_bits(dev, SSB_IMSTATE, SSB_IMSTATE_BUSY, 1000,
1091				      0);
1092		}
1093
1094		ssb_write32(dev, SSB_TMSLOW,
1095			SSB_TMSLOW_FGC | SSB_TMSLOW_CLOCK |
1096			reject | SSB_TMSLOW_RESET |
1097			core_specific_flags);
1098		ssb_flush_tmslow(dev);
1099
1100		if (ssb_read32(dev, SSB_IDLOW) & SSB_IDLOW_INITIATOR) {
1101			val = ssb_read32(dev, SSB_IMSTATE);
1102			val &= ~SSB_IMSTATE_REJECT;
1103			ssb_write32(dev, SSB_IMSTATE, val);
1104		}
1105	}
1106
1107	ssb_write32(dev, SSB_TMSLOW,
1108		    reject | SSB_TMSLOW_RESET |
1109		    core_specific_flags);
1110	ssb_flush_tmslow(dev);
1111}
1112EXPORT_SYMBOL(ssb_device_disable);
1113
1114/* Some chipsets need routing known for PCIe and 64-bit DMA */
1115static bool ssb_dma_translation_special_bit(struct ssb_device *dev)
1116{
1117	u16 chip_id = dev->bus->chip_id;
1118
1119	if (dev->id.coreid == SSB_DEV_80211) {
1120		return (chip_id == 0x4322 || chip_id == 43221 ||
1121			chip_id == 43231 || chip_id == 43222);
1122	}
1123
1124	return false;
1125}
1126
1127u32 ssb_dma_translation(struct ssb_device *dev)
1128{
1129	switch (dev->bus->bustype) {
1130	case SSB_BUSTYPE_SSB:
1131		return 0;
1132	case SSB_BUSTYPE_PCI:
1133		if (pci_is_pcie(dev->bus->host_pci) &&
1134		    ssb_read32(dev, SSB_TMSHIGH) & SSB_TMSHIGH_DMA64) {
1135			return SSB_PCIE_DMA_H32;
1136		} else {
1137			if (ssb_dma_translation_special_bit(dev))
1138				return SSB_PCIE_DMA_H32;
1139			else
1140				return SSB_PCI_DMA;
1141		}
1142	default:
1143		__ssb_dma_not_implemented(dev);
1144	}
1145	return 0;
1146}
1147EXPORT_SYMBOL(ssb_dma_translation);
1148
1149int ssb_bus_may_powerdown(struct ssb_bus *bus)
1150{
1151	struct ssb_chipcommon *cc;
1152	int err = 0;
1153
1154	/* On buses where more than one core may be working
1155	 * at a time, we must not powerdown stuff if there are
1156	 * still cores that may want to run. */
1157	if (bus->bustype == SSB_BUSTYPE_SSB)
1158		goto out;
1159
1160	cc = &bus->chipco;
1161
1162	if (!cc->dev)
1163		goto out;
1164	if (cc->dev->id.revision < 5)
1165		goto out;
1166
1167	ssb_chipco_set_clockmode(cc, SSB_CLKMODE_SLOW);
1168	err = ssb_pci_xtal(bus, SSB_GPIO_XTAL | SSB_GPIO_PLL, 0);
1169	if (err)
1170		goto error;
1171out:
1172	bus->powered_up = 0;
1173	return err;
1174error:
1175	pr_err("Bus powerdown failed\n");
1176	goto out;
1177}
1178EXPORT_SYMBOL(ssb_bus_may_powerdown);
1179
1180int ssb_bus_powerup(struct ssb_bus *bus, bool dynamic_pctl)
1181{
1182	int err;
1183	enum ssb_clkmode mode;
1184
1185	err = ssb_pci_xtal(bus, SSB_GPIO_XTAL | SSB_GPIO_PLL, 1);
1186	if (err)
1187		goto error;
1188
1189	bus->powered_up = 1;
1190
1191	mode = dynamic_pctl ? SSB_CLKMODE_DYNAMIC : SSB_CLKMODE_FAST;
1192	ssb_chipco_set_clockmode(&bus->chipco, mode);
1193
1194	return 0;
1195error:
1196	pr_err("Bus powerup failed\n");
1197	return err;
1198}
1199EXPORT_SYMBOL(ssb_bus_powerup);
1200
1201static void ssb_broadcast_value(struct ssb_device *dev,
1202				u32 address, u32 data)
1203{
1204#ifdef CONFIG_SSB_DRIVER_PCICORE
1205	/* This is used for both, PCI and ChipCommon core, so be careful. */
1206	BUILD_BUG_ON(SSB_PCICORE_BCAST_ADDR != SSB_CHIPCO_BCAST_ADDR);
1207	BUILD_BUG_ON(SSB_PCICORE_BCAST_DATA != SSB_CHIPCO_BCAST_DATA);
1208#endif
1209
1210	ssb_write32(dev, SSB_CHIPCO_BCAST_ADDR, address);
1211	ssb_read32(dev, SSB_CHIPCO_BCAST_ADDR); /* flush */
1212	ssb_write32(dev, SSB_CHIPCO_BCAST_DATA, data);
1213	ssb_read32(dev, SSB_CHIPCO_BCAST_DATA); /* flush */
1214}
1215
1216void ssb_commit_settings(struct ssb_bus *bus)
1217{
1218	struct ssb_device *dev;
1219
1220#ifdef CONFIG_SSB_DRIVER_PCICORE
1221	dev = bus->chipco.dev ? bus->chipco.dev : bus->pcicore.dev;
1222#else
1223	dev = bus->chipco.dev;
1224#endif
1225	if (WARN_ON(!dev))
1226		return;
1227	/* This forces an update of the cached registers. */
1228	ssb_broadcast_value(dev, 0xFD8, 0);
1229}
1230EXPORT_SYMBOL(ssb_commit_settings);
1231
1232u32 ssb_admatch_base(u32 adm)
1233{
1234	u32 base = 0;
1235
1236	switch (adm & SSB_ADM_TYPE) {
1237	case SSB_ADM_TYPE0:
1238		base = (adm & SSB_ADM_BASE0);
1239		break;
1240	case SSB_ADM_TYPE1:
1241		WARN_ON(adm & SSB_ADM_NEG); /* unsupported */
1242		base = (adm & SSB_ADM_BASE1);
1243		break;
1244	case SSB_ADM_TYPE2:
1245		WARN_ON(adm & SSB_ADM_NEG); /* unsupported */
1246		base = (adm & SSB_ADM_BASE2);
1247		break;
1248	default:
1249		WARN_ON(1);
1250	}
1251
1252	return base;
1253}
1254EXPORT_SYMBOL(ssb_admatch_base);
1255
1256u32 ssb_admatch_size(u32 adm)
1257{
1258	u32 size = 0;
1259
1260	switch (adm & SSB_ADM_TYPE) {
1261	case SSB_ADM_TYPE0:
1262		size = ((adm & SSB_ADM_SZ0) >> SSB_ADM_SZ0_SHIFT);
1263		break;
1264	case SSB_ADM_TYPE1:
1265		WARN_ON(adm & SSB_ADM_NEG); /* unsupported */
1266		size = ((adm & SSB_ADM_SZ1) >> SSB_ADM_SZ1_SHIFT);
1267		break;
1268	case SSB_ADM_TYPE2:
1269		WARN_ON(adm & SSB_ADM_NEG); /* unsupported */
1270		size = ((adm & SSB_ADM_SZ2) >> SSB_ADM_SZ2_SHIFT);
1271		break;
1272	default:
1273		WARN_ON(1);
1274	}
1275	size = (1 << (size + 1));
1276
1277	return size;
1278}
1279EXPORT_SYMBOL(ssb_admatch_size);
1280
1281static int __init ssb_modinit(void)
1282{
1283	int err;
1284
1285	/* See the comment at the ssb_is_early_boot definition */
1286	ssb_is_early_boot = 0;
1287	err = bus_register(&ssb_bustype);
1288	if (err)
1289		return err;
1290
1291	/* Maybe we already registered some buses at early boot.
1292	 * Check for this and attach them
1293	 */
1294	ssb_buses_lock();
1295	err = ssb_attach_queued_buses();
1296	ssb_buses_unlock();
1297	if (err) {
1298		bus_unregister(&ssb_bustype);
1299		goto out;
1300	}
1301
1302	err = b43_pci_ssb_bridge_init();
1303	if (err) {
1304		pr_err("Broadcom 43xx PCI-SSB-bridge initialization failed\n");
1305		/* don't fail SSB init because of this */
1306		err = 0;
1307	}
1308	err = ssb_host_pcmcia_init();
1309	if (err) {
1310		pr_err("PCMCIA host initialization failed\n");
1311		/* don't fail SSB init because of this */
1312		err = 0;
1313	}
1314	err = ssb_gige_init();
1315	if (err) {
1316		pr_err("SSB Broadcom Gigabit Ethernet driver initialization failed\n");
1317		/* don't fail SSB init because of this */
1318		err = 0;
1319	}
1320out:
1321	return err;
1322}
1323/* ssb must be initialized after PCI but before the ssb drivers.
1324 * That means we must use some initcall between subsys_initcall
1325 * and device_initcall. */
1326fs_initcall(ssb_modinit);
1327
1328static void __exit ssb_modexit(void)
1329{
1330	ssb_gige_exit();
1331	ssb_host_pcmcia_exit();
1332	b43_pci_ssb_bridge_exit();
1333	bus_unregister(&ssb_bustype);
1334}
1335module_exit(ssb_modexit)
1336