xref: /OK3568_Linux_fs/kernel/drivers/sh/superhyway/superhyway.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * drivers/sh/superhyway/superhyway.c
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * SuperHyway Bus Driver
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Copyright (C) 2004, 2005  Paul Mundt <lethal@linux-sh.org>
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * This file is subject to the terms and conditions of the GNU General Public
9*4882a593Smuzhiyun  * License.  See the file "COPYING" in the main directory of this archive
10*4882a593Smuzhiyun  * for more details.
11*4882a593Smuzhiyun  */
12*4882a593Smuzhiyun #include <linux/kernel.h>
13*4882a593Smuzhiyun #include <linux/device.h>
14*4882a593Smuzhiyun #include <linux/init.h>
15*4882a593Smuzhiyun #include <linux/module.h>
16*4882a593Smuzhiyun #include <linux/types.h>
17*4882a593Smuzhiyun #include <linux/list.h>
18*4882a593Smuzhiyun #include <linux/superhyway.h>
19*4882a593Smuzhiyun #include <linux/string.h>
20*4882a593Smuzhiyun #include <linux/slab.h>
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun static int superhyway_devices;
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun static struct device superhyway_bus_device = {
25*4882a593Smuzhiyun 	.init_name = "superhyway",
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
superhyway_device_release(struct device * dev)28*4882a593Smuzhiyun static void superhyway_device_release(struct device *dev)
29*4882a593Smuzhiyun {
30*4882a593Smuzhiyun 	struct superhyway_device *sdev = to_superhyway_device(dev);
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 	kfree(sdev->resource);
33*4882a593Smuzhiyun 	kfree(sdev);
34*4882a593Smuzhiyun }
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun /**
37*4882a593Smuzhiyun  * superhyway_add_device - Add a SuperHyway module
38*4882a593Smuzhiyun  * @base: Physical address where module is mapped.
39*4882a593Smuzhiyun  * @sdev: SuperHyway device to add, or NULL to allocate a new one.
40*4882a593Smuzhiyun  * @bus: Bus where SuperHyway module resides.
41*4882a593Smuzhiyun  *
42*4882a593Smuzhiyun  * This is responsible for adding a new SuperHyway module. This sets up a new
43*4882a593Smuzhiyun  * struct superhyway_device for the module being added if @sdev == NULL.
44*4882a593Smuzhiyun  *
45*4882a593Smuzhiyun  * Devices are initially added in the order that they are scanned (from the
46*4882a593Smuzhiyun  * top-down of the memory map), and are assigned an ID based on the order that
47*4882a593Smuzhiyun  * they are added. Any manual addition of a module will thus get the ID after
48*4882a593Smuzhiyun  * the devices already discovered regardless of where it resides in memory.
49*4882a593Smuzhiyun  *
50*4882a593Smuzhiyun  * Further work can and should be done in superhyway_scan_bus(), to be sure
51*4882a593Smuzhiyun  * that any new modules are properly discovered and subsequently registered.
52*4882a593Smuzhiyun  */
superhyway_add_device(unsigned long base,struct superhyway_device * sdev,struct superhyway_bus * bus)53*4882a593Smuzhiyun int superhyway_add_device(unsigned long base, struct superhyway_device *sdev,
54*4882a593Smuzhiyun 			  struct superhyway_bus *bus)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun 	struct superhyway_device *dev = sdev;
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 	if (!dev) {
59*4882a593Smuzhiyun 		dev = kzalloc(sizeof(struct superhyway_device), GFP_KERNEL);
60*4882a593Smuzhiyun 		if (!dev)
61*4882a593Smuzhiyun 			return -ENOMEM;
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	}
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	dev->bus = bus;
66*4882a593Smuzhiyun 	superhyway_read_vcr(dev, base, &dev->vcr);
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	if (!dev->resource) {
69*4882a593Smuzhiyun 		dev->resource = kzalloc(sizeof(struct resource), GFP_KERNEL);
70*4882a593Smuzhiyun 		if (!dev->resource) {
71*4882a593Smuzhiyun 			kfree(dev);
72*4882a593Smuzhiyun 			return -ENOMEM;
73*4882a593Smuzhiyun 		}
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun 		dev->resource->name	= dev->name;
76*4882a593Smuzhiyun 		dev->resource->start	= base;
77*4882a593Smuzhiyun 		dev->resource->end	= dev->resource->start + 0x01000000;
78*4882a593Smuzhiyun 	}
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	dev->dev.parent		= &superhyway_bus_device;
81*4882a593Smuzhiyun 	dev->dev.bus		= &superhyway_bus_type;
82*4882a593Smuzhiyun 	dev->dev.release	= superhyway_device_release;
83*4882a593Smuzhiyun 	dev->id.id		= dev->vcr.mod_id;
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 	sprintf(dev->name, "SuperHyway device %04x", dev->id.id);
86*4882a593Smuzhiyun 	dev_set_name(&dev->dev, "%02x", superhyway_devices);
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun 	superhyway_devices++;
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	return device_register(&dev->dev);
91*4882a593Smuzhiyun }
92*4882a593Smuzhiyun 
superhyway_add_devices(struct superhyway_bus * bus,struct superhyway_device ** devices,int nr_devices)93*4882a593Smuzhiyun int superhyway_add_devices(struct superhyway_bus *bus,
94*4882a593Smuzhiyun 			   struct superhyway_device **devices,
95*4882a593Smuzhiyun 			   int nr_devices)
96*4882a593Smuzhiyun {
97*4882a593Smuzhiyun 	int i, ret = 0;
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	for (i = 0; i < nr_devices; i++) {
100*4882a593Smuzhiyun 		struct superhyway_device *dev = devices[i];
101*4882a593Smuzhiyun 		ret |= superhyway_add_device(dev->resource[0].start, dev, bus);
102*4882a593Smuzhiyun 	}
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	return ret;
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun 
superhyway_init(void)107*4882a593Smuzhiyun static int __init superhyway_init(void)
108*4882a593Smuzhiyun {
109*4882a593Smuzhiyun 	struct superhyway_bus *bus;
110*4882a593Smuzhiyun 	int ret;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	ret = device_register(&superhyway_bus_device);
113*4882a593Smuzhiyun 	if (unlikely(ret))
114*4882a593Smuzhiyun 		return ret;
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 	for (bus = superhyway_channels; bus->ops; bus++)
117*4882a593Smuzhiyun 		ret |= superhyway_scan_bus(bus);
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun 	return ret;
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun postcore_initcall(superhyway_init);
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun static const struct superhyway_device_id *
superhyway_match_id(const struct superhyway_device_id * ids,struct superhyway_device * dev)124*4882a593Smuzhiyun superhyway_match_id(const struct superhyway_device_id *ids,
125*4882a593Smuzhiyun 		    struct superhyway_device *dev)
126*4882a593Smuzhiyun {
127*4882a593Smuzhiyun 	while (ids->id) {
128*4882a593Smuzhiyun 		if (ids->id == dev->id.id)
129*4882a593Smuzhiyun 			return ids;
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun 		ids++;
132*4882a593Smuzhiyun 	}
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 	return NULL;
135*4882a593Smuzhiyun }
136*4882a593Smuzhiyun 
superhyway_device_probe(struct device * dev)137*4882a593Smuzhiyun static int superhyway_device_probe(struct device *dev)
138*4882a593Smuzhiyun {
139*4882a593Smuzhiyun 	struct superhyway_device *shyway_dev = to_superhyway_device(dev);
140*4882a593Smuzhiyun 	struct superhyway_driver *shyway_drv = to_superhyway_driver(dev->driver);
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	if (shyway_drv && shyway_drv->probe) {
143*4882a593Smuzhiyun 		const struct superhyway_device_id *id;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 		id = superhyway_match_id(shyway_drv->id_table, shyway_dev);
146*4882a593Smuzhiyun 		if (id)
147*4882a593Smuzhiyun 			return shyway_drv->probe(shyway_dev, id);
148*4882a593Smuzhiyun 	}
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun 	return -ENODEV;
151*4882a593Smuzhiyun }
152*4882a593Smuzhiyun 
superhyway_device_remove(struct device * dev)153*4882a593Smuzhiyun static int superhyway_device_remove(struct device *dev)
154*4882a593Smuzhiyun {
155*4882a593Smuzhiyun 	struct superhyway_device *shyway_dev = to_superhyway_device(dev);
156*4882a593Smuzhiyun 	struct superhyway_driver *shyway_drv = to_superhyway_driver(dev->driver);
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 	if (shyway_drv && shyway_drv->remove) {
159*4882a593Smuzhiyun 		shyway_drv->remove(shyway_dev);
160*4882a593Smuzhiyun 		return 0;
161*4882a593Smuzhiyun 	}
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun 	return -ENODEV;
164*4882a593Smuzhiyun }
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun /**
167*4882a593Smuzhiyun  * superhyway_register_driver - Register a new SuperHyway driver
168*4882a593Smuzhiyun  * @drv: SuperHyway driver to register.
169*4882a593Smuzhiyun  *
170*4882a593Smuzhiyun  * This registers the passed in @drv. Any devices matching the id table will
171*4882a593Smuzhiyun  * automatically be populated and handed off to the driver's specified probe
172*4882a593Smuzhiyun  * routine.
173*4882a593Smuzhiyun  */
superhyway_register_driver(struct superhyway_driver * drv)174*4882a593Smuzhiyun int superhyway_register_driver(struct superhyway_driver *drv)
175*4882a593Smuzhiyun {
176*4882a593Smuzhiyun 	drv->drv.name	= drv->name;
177*4882a593Smuzhiyun 	drv->drv.bus	= &superhyway_bus_type;
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 	return driver_register(&drv->drv);
180*4882a593Smuzhiyun }
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun /**
183*4882a593Smuzhiyun  * superhyway_unregister_driver - Unregister a SuperHyway driver
184*4882a593Smuzhiyun  * @drv: SuperHyway driver to unregister.
185*4882a593Smuzhiyun  *
186*4882a593Smuzhiyun  * This cleans up after superhyway_register_driver(), and should be invoked in
187*4882a593Smuzhiyun  * the exit path of any module drivers.
188*4882a593Smuzhiyun  */
superhyway_unregister_driver(struct superhyway_driver * drv)189*4882a593Smuzhiyun void superhyway_unregister_driver(struct superhyway_driver *drv)
190*4882a593Smuzhiyun {
191*4882a593Smuzhiyun 	driver_unregister(&drv->drv);
192*4882a593Smuzhiyun }
193*4882a593Smuzhiyun 
superhyway_bus_match(struct device * dev,struct device_driver * drv)194*4882a593Smuzhiyun static int superhyway_bus_match(struct device *dev, struct device_driver *drv)
195*4882a593Smuzhiyun {
196*4882a593Smuzhiyun 	struct superhyway_device *shyway_dev = to_superhyway_device(dev);
197*4882a593Smuzhiyun 	struct superhyway_driver *shyway_drv = to_superhyway_driver(drv);
198*4882a593Smuzhiyun 	const struct superhyway_device_id *ids = shyway_drv->id_table;
199*4882a593Smuzhiyun 
200*4882a593Smuzhiyun 	if (!ids)
201*4882a593Smuzhiyun 		return -EINVAL;
202*4882a593Smuzhiyun 	if (superhyway_match_id(ids, shyway_dev))
203*4882a593Smuzhiyun 		return 1;
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun 	return -ENODEV;
206*4882a593Smuzhiyun }
207*4882a593Smuzhiyun 
208*4882a593Smuzhiyun struct bus_type superhyway_bus_type = {
209*4882a593Smuzhiyun 	.name		= "superhyway",
210*4882a593Smuzhiyun 	.match		= superhyway_bus_match,
211*4882a593Smuzhiyun #ifdef CONFIG_SYSFS
212*4882a593Smuzhiyun 	.dev_groups	= superhyway_dev_groups,
213*4882a593Smuzhiyun #endif
214*4882a593Smuzhiyun 	.probe		= superhyway_device_probe,
215*4882a593Smuzhiyun 	.remove		= superhyway_device_remove,
216*4882a593Smuzhiyun };
217*4882a593Smuzhiyun 
superhyway_bus_init(void)218*4882a593Smuzhiyun static int __init superhyway_bus_init(void)
219*4882a593Smuzhiyun {
220*4882a593Smuzhiyun 	return bus_register(&superhyway_bus_type);
221*4882a593Smuzhiyun }
222*4882a593Smuzhiyun 
superhyway_bus_exit(void)223*4882a593Smuzhiyun static void __exit superhyway_bus_exit(void)
224*4882a593Smuzhiyun {
225*4882a593Smuzhiyun 	device_unregister(&superhyway_bus_device);
226*4882a593Smuzhiyun 	bus_unregister(&superhyway_bus_type);
227*4882a593Smuzhiyun }
228*4882a593Smuzhiyun 
229*4882a593Smuzhiyun core_initcall(superhyway_bus_init);
230*4882a593Smuzhiyun module_exit(superhyway_bus_exit);
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun EXPORT_SYMBOL(superhyway_bus_type);
233*4882a593Smuzhiyun EXPORT_SYMBOL(superhyway_add_device);
234*4882a593Smuzhiyun EXPORT_SYMBOL(superhyway_add_devices);
235*4882a593Smuzhiyun EXPORT_SYMBOL(superhyway_register_driver);
236*4882a593Smuzhiyun EXPORT_SYMBOL(superhyway_unregister_driver);
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun MODULE_LICENSE("GPL");
239