• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * MEN Chameleon Bus.
4  *
5  * Copyright (C) 2013 MEN Mikroelektronik GmbH (www.men.de)
6  * Author: Johannes Thumshirn <johannes.thumshirn@men.de>
7  */
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/slab.h>
11 #include <linux/types.h>
12 #include <linux/idr.h>
13 #include <linux/mcb.h>
14 
15 static DEFINE_IDA(mcb_ida);
16 
mcb_match_id(const struct mcb_device_id * ids,struct mcb_device * dev)17 static const struct mcb_device_id *mcb_match_id(const struct mcb_device_id *ids,
18 						struct mcb_device *dev)
19 {
20 	if (ids) {
21 		while (ids->device) {
22 			if (ids->device == dev->id)
23 				return ids;
24 			ids++;
25 		}
26 	}
27 
28 	return NULL;
29 }
30 
mcb_match(struct device * dev,struct device_driver * drv)31 static int mcb_match(struct device *dev, struct device_driver *drv)
32 {
33 	struct mcb_driver *mdrv = to_mcb_driver(drv);
34 	struct mcb_device *mdev = to_mcb_device(dev);
35 	const struct mcb_device_id *found_id;
36 
37 	found_id = mcb_match_id(mdrv->id_table, mdev);
38 	if (found_id)
39 		return 1;
40 
41 	return 0;
42 }
43 
mcb_uevent(struct device * dev,struct kobj_uevent_env * env)44 static int mcb_uevent(struct device *dev, struct kobj_uevent_env *env)
45 {
46 	struct mcb_device *mdev = to_mcb_device(dev);
47 	int ret;
48 
49 	ret = add_uevent_var(env, "MODALIAS=mcb:16z%03d", mdev->id);
50 	if (ret)
51 		return -ENOMEM;
52 
53 	return 0;
54 }
55 
mcb_probe(struct device * dev)56 static int mcb_probe(struct device *dev)
57 {
58 	struct mcb_driver *mdrv = to_mcb_driver(dev->driver);
59 	struct mcb_device *mdev = to_mcb_device(dev);
60 	const struct mcb_device_id *found_id;
61 	struct module *carrier_mod;
62 	int ret;
63 
64 	found_id = mcb_match_id(mdrv->id_table, mdev);
65 	if (!found_id)
66 		return -ENODEV;
67 
68 	carrier_mod = mdev->dev.parent->driver->owner;
69 	if (!try_module_get(carrier_mod))
70 		return -EINVAL;
71 
72 	get_device(dev);
73 	ret = mdrv->probe(mdev, found_id);
74 	if (ret) {
75 		module_put(carrier_mod);
76 		put_device(dev);
77 	}
78 
79 	return ret;
80 }
81 
mcb_remove(struct device * dev)82 static int mcb_remove(struct device *dev)
83 {
84 	struct mcb_driver *mdrv = to_mcb_driver(dev->driver);
85 	struct mcb_device *mdev = to_mcb_device(dev);
86 	struct module *carrier_mod;
87 
88 	mdrv->remove(mdev);
89 
90 	carrier_mod = mdev->dev.parent->driver->owner;
91 	module_put(carrier_mod);
92 
93 	put_device(&mdev->dev);
94 
95 	return 0;
96 }
97 
mcb_shutdown(struct device * dev)98 static void mcb_shutdown(struct device *dev)
99 {
100 	struct mcb_driver *mdrv = to_mcb_driver(dev->driver);
101 	struct mcb_device *mdev = to_mcb_device(dev);
102 
103 	if (mdrv && mdrv->shutdown)
104 		mdrv->shutdown(mdev);
105 }
106 
revision_show(struct device * dev,struct device_attribute * attr,char * buf)107 static ssize_t revision_show(struct device *dev, struct device_attribute *attr,
108 			 char *buf)
109 {
110 	struct mcb_bus *bus = to_mcb_bus(dev);
111 
112 	return scnprintf(buf, PAGE_SIZE, "%d\n", bus->revision);
113 }
114 static DEVICE_ATTR_RO(revision);
115 
model_show(struct device * dev,struct device_attribute * attr,char * buf)116 static ssize_t model_show(struct device *dev, struct device_attribute *attr,
117 			 char *buf)
118 {
119 	struct mcb_bus *bus = to_mcb_bus(dev);
120 
121 	return scnprintf(buf, PAGE_SIZE, "%c\n", bus->model);
122 }
123 static DEVICE_ATTR_RO(model);
124 
minor_show(struct device * dev,struct device_attribute * attr,char * buf)125 static ssize_t minor_show(struct device *dev, struct device_attribute *attr,
126 			 char *buf)
127 {
128 	struct mcb_bus *bus = to_mcb_bus(dev);
129 
130 	return scnprintf(buf, PAGE_SIZE, "%d\n", bus->minor);
131 }
132 static DEVICE_ATTR_RO(minor);
133 
name_show(struct device * dev,struct device_attribute * attr,char * buf)134 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
135 			 char *buf)
136 {
137 	struct mcb_bus *bus = to_mcb_bus(dev);
138 
139 	return scnprintf(buf, PAGE_SIZE, "%s\n", bus->name);
140 }
141 static DEVICE_ATTR_RO(name);
142 
143 static struct attribute *mcb_bus_attrs[] = {
144 	&dev_attr_revision.attr,
145 	&dev_attr_model.attr,
146 	&dev_attr_minor.attr,
147 	&dev_attr_name.attr,
148 	NULL,
149 };
150 
151 static const struct attribute_group mcb_carrier_group = {
152 	.attrs = mcb_bus_attrs,
153 };
154 
155 static const struct attribute_group *mcb_carrier_groups[] = {
156 	&mcb_carrier_group,
157 	NULL,
158 };
159 
160 
161 static struct bus_type mcb_bus_type = {
162 	.name = "mcb",
163 	.match = mcb_match,
164 	.uevent = mcb_uevent,
165 	.probe = mcb_probe,
166 	.remove = mcb_remove,
167 	.shutdown = mcb_shutdown,
168 };
169 
170 static struct device_type mcb_carrier_device_type = {
171 	.name = "mcb-carrier",
172 	.groups = mcb_carrier_groups,
173 };
174 
175 /**
176  * __mcb_register_driver() - Register a @mcb_driver at the system
177  * @drv: The @mcb_driver
178  * @owner: The @mcb_driver's module
179  * @mod_name: The name of the @mcb_driver's module
180  *
181  * Register a @mcb_driver at the system. Perform some sanity checks, if
182  * the .probe and .remove methods are provided by the driver.
183  */
__mcb_register_driver(struct mcb_driver * drv,struct module * owner,const char * mod_name)184 int __mcb_register_driver(struct mcb_driver *drv, struct module *owner,
185 			const char *mod_name)
186 {
187 	if (!drv->probe || !drv->remove)
188 		return -EINVAL;
189 
190 	drv->driver.owner = owner;
191 	drv->driver.bus = &mcb_bus_type;
192 	drv->driver.mod_name = mod_name;
193 
194 	return driver_register(&drv->driver);
195 }
196 EXPORT_SYMBOL_NS_GPL(__mcb_register_driver, MCB);
197 
198 /**
199  * mcb_unregister_driver() - Unregister a @mcb_driver from the system
200  * @drv: The @mcb_driver
201  *
202  * Unregister a @mcb_driver from the system.
203  */
mcb_unregister_driver(struct mcb_driver * drv)204 void mcb_unregister_driver(struct mcb_driver *drv)
205 {
206 	driver_unregister(&drv->driver);
207 }
208 EXPORT_SYMBOL_NS_GPL(mcb_unregister_driver, MCB);
209 
mcb_release_dev(struct device * dev)210 static void mcb_release_dev(struct device *dev)
211 {
212 	struct mcb_device *mdev = to_mcb_device(dev);
213 
214 	mcb_bus_put(mdev->bus);
215 	kfree(mdev);
216 }
217 
218 /**
219  * mcb_device_register() - Register a mcb_device
220  * @bus: The @mcb_bus of the device
221  * @dev: The @mcb_device
222  *
223  * Register a specific @mcb_device at a @mcb_bus and the system itself.
224  */
mcb_device_register(struct mcb_bus * bus,struct mcb_device * dev)225 int mcb_device_register(struct mcb_bus *bus, struct mcb_device *dev)
226 {
227 	int ret;
228 	int device_id;
229 
230 	device_initialize(&dev->dev);
231 	mcb_bus_get(bus);
232 	dev->dev.bus = &mcb_bus_type;
233 	dev->dev.parent = bus->dev.parent;
234 	dev->dev.release = mcb_release_dev;
235 	dev->dma_dev = bus->carrier;
236 
237 	device_id = dev->id;
238 	dev_set_name(&dev->dev, "mcb%d-16z%03d-%d:%d:%d",
239 		bus->bus_nr, device_id, dev->inst, dev->group, dev->var);
240 
241 	ret = device_add(&dev->dev);
242 	if (ret < 0) {
243 		pr_err("Failed registering device 16z%03d on bus mcb%d (%d)\n",
244 			device_id, bus->bus_nr, ret);
245 		goto out;
246 	}
247 
248 	return 0;
249 
250 out:
251 
252 	return ret;
253 }
254 EXPORT_SYMBOL_NS_GPL(mcb_device_register, MCB);
255 
mcb_free_bus(struct device * dev)256 static void mcb_free_bus(struct device *dev)
257 {
258 	struct mcb_bus *bus = to_mcb_bus(dev);
259 
260 	put_device(bus->carrier);
261 	ida_simple_remove(&mcb_ida, bus->bus_nr);
262 	kfree(bus);
263 }
264 
265 /**
266  * mcb_alloc_bus() - Allocate a new @mcb_bus
267  *
268  * Allocate a new @mcb_bus.
269  */
mcb_alloc_bus(struct device * carrier)270 struct mcb_bus *mcb_alloc_bus(struct device *carrier)
271 {
272 	struct mcb_bus *bus;
273 	int bus_nr;
274 	int rc;
275 
276 	bus = kzalloc(sizeof(struct mcb_bus), GFP_KERNEL);
277 	if (!bus)
278 		return ERR_PTR(-ENOMEM);
279 
280 	bus_nr = ida_simple_get(&mcb_ida, 0, 0, GFP_KERNEL);
281 	if (bus_nr < 0) {
282 		kfree(bus);
283 		return ERR_PTR(bus_nr);
284 	}
285 
286 	bus->bus_nr = bus_nr;
287 	bus->carrier = get_device(carrier);
288 
289 	device_initialize(&bus->dev);
290 	bus->dev.parent = carrier;
291 	bus->dev.bus = &mcb_bus_type;
292 	bus->dev.type = &mcb_carrier_device_type;
293 	bus->dev.release = &mcb_free_bus;
294 
295 	dev_set_name(&bus->dev, "mcb:%d", bus_nr);
296 	rc = device_add(&bus->dev);
297 	if (rc)
298 		goto err_put;
299 
300 	return bus;
301 
302 err_put:
303 	put_device(&bus->dev);
304 	return ERR_PTR(rc);
305 }
306 EXPORT_SYMBOL_NS_GPL(mcb_alloc_bus, MCB);
307 
__mcb_devices_unregister(struct device * dev,void * data)308 static int __mcb_devices_unregister(struct device *dev, void *data)
309 {
310 	device_unregister(dev);
311 	return 0;
312 }
313 
mcb_devices_unregister(struct mcb_bus * bus)314 static void mcb_devices_unregister(struct mcb_bus *bus)
315 {
316 	bus_for_each_dev(&mcb_bus_type, NULL, NULL, __mcb_devices_unregister);
317 }
318 /**
319  * mcb_release_bus() - Free a @mcb_bus
320  * @bus: The @mcb_bus to release
321  *
322  * Release an allocated @mcb_bus from the system.
323  */
mcb_release_bus(struct mcb_bus * bus)324 void mcb_release_bus(struct mcb_bus *bus)
325 {
326 	mcb_devices_unregister(bus);
327 }
328 EXPORT_SYMBOL_NS_GPL(mcb_release_bus, MCB);
329 
330 /**
331  * mcb_bus_put() - Increment refcnt
332  * @bus: The @mcb_bus
333  *
334  * Get a @mcb_bus' ref
335  */
mcb_bus_get(struct mcb_bus * bus)336 struct mcb_bus *mcb_bus_get(struct mcb_bus *bus)
337 {
338 	if (bus)
339 		get_device(&bus->dev);
340 
341 	return bus;
342 }
343 EXPORT_SYMBOL_NS_GPL(mcb_bus_get, MCB);
344 
345 /**
346  * mcb_bus_put() - Decrement refcnt
347  * @bus: The @mcb_bus
348  *
349  * Release a @mcb_bus' ref
350  */
mcb_bus_put(struct mcb_bus * bus)351 void mcb_bus_put(struct mcb_bus *bus)
352 {
353 	if (bus)
354 		put_device(&bus->dev);
355 }
356 EXPORT_SYMBOL_NS_GPL(mcb_bus_put, MCB);
357 
358 /**
359  * mcb_alloc_dev() - Allocate a device
360  * @bus: The @mcb_bus the device is part of
361  *
362  * Allocate a @mcb_device and add bus.
363  */
mcb_alloc_dev(struct mcb_bus * bus)364 struct mcb_device *mcb_alloc_dev(struct mcb_bus *bus)
365 {
366 	struct mcb_device *dev;
367 
368 	dev = kzalloc(sizeof(struct mcb_device), GFP_KERNEL);
369 	if (!dev)
370 		return NULL;
371 
372 	dev->bus = bus;
373 
374 	return dev;
375 }
376 EXPORT_SYMBOL_NS_GPL(mcb_alloc_dev, MCB);
377 
378 /**
379  * mcb_free_dev() - Free @mcb_device
380  * @dev: The device to free
381  *
382  * Free a @mcb_device
383  */
mcb_free_dev(struct mcb_device * dev)384 void mcb_free_dev(struct mcb_device *dev)
385 {
386 	kfree(dev);
387 }
388 EXPORT_SYMBOL_NS_GPL(mcb_free_dev, MCB);
389 
__mcb_bus_add_devices(struct device * dev,void * data)390 static int __mcb_bus_add_devices(struct device *dev, void *data)
391 {
392 	struct mcb_device *mdev = to_mcb_device(dev);
393 	int retval;
394 
395 	if (mdev->is_added)
396 		return 0;
397 
398 	retval = device_attach(dev);
399 	if (retval < 0)
400 		dev_err(dev, "Error adding device (%d)\n", retval);
401 
402 	mdev->is_added = true;
403 
404 	return 0;
405 }
406 
407 /**
408  * mcb_bus_add_devices() - Add devices in the bus' internal device list
409  * @bus: The @mcb_bus we add the devices
410  *
411  * Add devices in the bus' internal device list to the system.
412  */
mcb_bus_add_devices(const struct mcb_bus * bus)413 void mcb_bus_add_devices(const struct mcb_bus *bus)
414 {
415 	bus_for_each_dev(&mcb_bus_type, NULL, NULL, __mcb_bus_add_devices);
416 }
417 EXPORT_SYMBOL_NS_GPL(mcb_bus_add_devices, MCB);
418 
419 /**
420  * mcb_get_resource() - get a resource for a mcb device
421  * @dev: the mcb device
422  * @type: the type of resource
423  */
mcb_get_resource(struct mcb_device * dev,unsigned int type)424 struct resource *mcb_get_resource(struct mcb_device *dev, unsigned int type)
425 {
426 	if (type == IORESOURCE_MEM)
427 		return &dev->mem;
428 	else if (type == IORESOURCE_IRQ)
429 		return &dev->irq;
430 	else
431 		return NULL;
432 }
433 EXPORT_SYMBOL_NS_GPL(mcb_get_resource, MCB);
434 
435 /**
436  * mcb_request_mem() - Request memory
437  * @dev: The @mcb_device the memory is for
438  * @name: The name for the memory reference.
439  *
440  * Request memory for a @mcb_device. If @name is NULL the driver name will
441  * be used.
442  */
mcb_request_mem(struct mcb_device * dev,const char * name)443 struct resource *mcb_request_mem(struct mcb_device *dev, const char *name)
444 {
445 	struct resource *mem;
446 	u32 size;
447 
448 	if (!name)
449 		name = dev->dev.driver->name;
450 
451 	size = resource_size(&dev->mem);
452 
453 	mem = request_mem_region(dev->mem.start, size, name);
454 	if (!mem)
455 		return ERR_PTR(-EBUSY);
456 
457 	return mem;
458 }
459 EXPORT_SYMBOL_NS_GPL(mcb_request_mem, MCB);
460 
461 /**
462  * mcb_release_mem() - Release memory requested by device
463  * @dev: The @mcb_device that requested the memory
464  *
465  * Release memory that was prior requested via @mcb_request_mem().
466  */
mcb_release_mem(struct resource * mem)467 void mcb_release_mem(struct resource *mem)
468 {
469 	u32 size;
470 
471 	size = resource_size(mem);
472 	release_mem_region(mem->start, size);
473 }
474 EXPORT_SYMBOL_NS_GPL(mcb_release_mem, MCB);
475 
__mcb_get_irq(struct mcb_device * dev)476 static int __mcb_get_irq(struct mcb_device *dev)
477 {
478 	struct resource *irq;
479 
480 	irq = mcb_get_resource(dev, IORESOURCE_IRQ);
481 
482 	return irq->start;
483 }
484 
485 /**
486  * mcb_get_irq() - Get device's IRQ number
487  * @dev: The @mcb_device the IRQ is for
488  *
489  * Get the IRQ number of a given @mcb_device.
490  */
mcb_get_irq(struct mcb_device * dev)491 int mcb_get_irq(struct mcb_device *dev)
492 {
493 	struct mcb_bus *bus = dev->bus;
494 
495 	if (bus->get_irq)
496 		return bus->get_irq(dev);
497 
498 	return __mcb_get_irq(dev);
499 }
500 EXPORT_SYMBOL_NS_GPL(mcb_get_irq, MCB);
501 
mcb_init(void)502 static int mcb_init(void)
503 {
504 	return bus_register(&mcb_bus_type);
505 }
506 
mcb_exit(void)507 static void mcb_exit(void)
508 {
509 	ida_destroy(&mcb_ida);
510 	bus_unregister(&mcb_bus_type);
511 }
512 
513 /* mcb must be initialized after PCI but before the chameleon drivers.
514  * That means we must use some initcall between subsys_initcall and
515  * device_initcall.
516  */
517 fs_initcall(mcb_init);
518 module_exit(mcb_exit);
519 
520 MODULE_DESCRIPTION("MEN Chameleon Bus Driver");
521 MODULE_AUTHOR("Johannes Thumshirn <johannes.thumshirn@men.de>");
522 MODULE_LICENSE("GPL v2");
523