2005-04-16 22:20:36 +00:00
|
|
|
/*
|
|
|
|
|
* device.h - generic, centralized driver model
|
|
|
|
|
*
|
|
|
|
|
* Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
|
2009-05-11 21:16:57 +00:00
|
|
|
* Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
|
|
|
|
|
* Copyright (c) 2008-2009 Novell Inc.
|
2005-04-16 22:20:36 +00:00
|
|
|
*
|
|
|
|
|
* This file is released under the GPLv2
|
|
|
|
|
*
|
|
|
|
|
* See Documentation/driver-model/ for more information.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _DEVICE_H_
|
|
|
|
|
#define _DEVICE_H_
|
|
|
|
|
|
|
|
|
|
#include <linux/ioport.h>
|
|
|
|
|
#include <linux/kobject.h>
|
2005-03-21 19:49:14 +00:00
|
|
|
#include <linux/klist.h>
|
2005-04-16 22:20:36 +00:00
|
|
|
#include <linux/list.h>
|
2008-05-28 16:28:39 +00:00
|
|
|
#include <linux/lockdep.h>
|
2006-08-15 05:43:17 +00:00
|
|
|
#include <linux/compiler.h>
|
2005-04-16 22:20:36 +00:00
|
|
|
#include <linux/types.h>
|
|
|
|
|
#include <linux/module.h>
|
|
|
|
|
#include <linux/pm.h>
|
2008-04-19 02:21:05 +00:00
|
|
|
#include <linux/semaphore.h>
|
2005-04-16 22:20:36 +00:00
|
|
|
#include <asm/atomic.h>
|
2006-11-11 06:18:39 +00:00
|
|
|
#include <asm/device.h>
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
struct device;
|
2008-12-16 20:23:36 +00:00
|
|
|
struct device_private;
|
2005-04-16 22:20:36 +00:00
|
|
|
struct device_driver;
|
2007-11-28 23:59:15 +00:00
|
|
|
struct driver_private;
|
2005-04-16 22:20:36 +00:00
|
|
|
struct class;
|
2008-01-22 23:17:41 +00:00
|
|
|
struct class_private;
|
Driver core: udev triggered device-<>driver binding
We get two per-bus sysfs files:
ls-l /sys/subsystem/usb
drwxr-xr-x 2 root root 0 2007-02-16 16:42 devices
drwxr-xr-x 7 root root 0 2007-02-16 14:55 drivers
-rw-r--r-- 1 root root 4096 2007-02-16 16:42 drivers_autoprobe
--w------- 1 root root 4096 2007-02-16 16:42 drivers_probe
The flag "drivers_autoprobe" controls the behavior of the bus to bind
devices by default, or just initialize the device and leave it alone.
The command "drivers_probe" accepts a bus_id and the bus tries to bind a
driver to this device.
Systems who want to control the driver binding with udev, switch off the
bus initiated probing:
echo 0 > /sys/subsystem/usb/drivers_autoprobe
echo 0 > /sys/subsystem/pcmcia/drivers_autoprobe
...
and initiate the probing with udev rules like:
ACTION=="add", SUBSYSTEM=="usb", ATTR{subsystem/drivers_probe}="$kernel"
ACTION=="add", SUBSYSTEM=="pcmcia", ATTR{subsystem/drivers_probe}="$kernel"
...
Custom driver binding can happen in earlier rules by something like:
ACTION=="add", SUBSYSTEM=="usb", \
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="5678" \
ATTR{subsystem/drivers/<custom-driver>/bind}="$kernel"
This is intended to solve the modprobe.conf mess with "install-rules", custom
bind/unbind-scripts and all the weird things people invented over the years.
It should also provide the functionality "libusual" was supposed to do.
With udev, one can just write a udev rule to drive all USB-disks at the
third port of USB-hub by the "ub" driver, and everything else by
usb-storage. One can also instruct udev to bind different wireless
drivers to identical cards - just selected by the pcmcia slot-number, and
whatever ...
To use the mentioned rules, it needs udev version 106, to be able to
write ATTR{}="$kernel" to sysfs files.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-02-16 16:33:36 +00:00
|
|
|
struct bus_type;
|
2007-11-02 02:41:16 +00:00
|
|
|
struct bus_type_private;
|
Driver core: udev triggered device-<>driver binding
We get two per-bus sysfs files:
ls-l /sys/subsystem/usb
drwxr-xr-x 2 root root 0 2007-02-16 16:42 devices
drwxr-xr-x 7 root root 0 2007-02-16 14:55 drivers
-rw-r--r-- 1 root root 4096 2007-02-16 16:42 drivers_autoprobe
--w------- 1 root root 4096 2007-02-16 16:42 drivers_probe
The flag "drivers_autoprobe" controls the behavior of the bus to bind
devices by default, or just initialize the device and leave it alone.
The command "drivers_probe" accepts a bus_id and the bus tries to bind a
driver to this device.
Systems who want to control the driver binding with udev, switch off the
bus initiated probing:
echo 0 > /sys/subsystem/usb/drivers_autoprobe
echo 0 > /sys/subsystem/pcmcia/drivers_autoprobe
...
and initiate the probing with udev rules like:
ACTION=="add", SUBSYSTEM=="usb", ATTR{subsystem/drivers_probe}="$kernel"
ACTION=="add", SUBSYSTEM=="pcmcia", ATTR{subsystem/drivers_probe}="$kernel"
...
Custom driver binding can happen in earlier rules by something like:
ACTION=="add", SUBSYSTEM=="usb", \
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="5678" \
ATTR{subsystem/drivers/<custom-driver>/bind}="$kernel"
This is intended to solve the modprobe.conf mess with "install-rules", custom
bind/unbind-scripts and all the weird things people invented over the years.
It should also provide the functionality "libusual" was supposed to do.
With udev, one can just write a udev rule to drive all USB-disks at the
third port of USB-hub by the "ub" driver, and everything else by
usb-storage. One can also instruct udev to bind different wireless
drivers to identical cards - just selected by the pcmcia slot-number, and
whatever ...
To use the mentioned rules, it needs udev version 106, to be able to
write ATTR{}="$kernel" to sysfs files.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-02-16 16:33:36 +00:00
|
|
|
|
|
|
|
|
struct bus_attribute {
|
|
|
|
|
struct attribute attr;
|
2008-01-25 05:04:46 +00:00
|
|
|
ssize_t (*show)(struct bus_type *bus, char *buf);
|
|
|
|
|
ssize_t (*store)(struct bus_type *bus, const char *buf, size_t count);
|
Driver core: udev triggered device-<>driver binding
We get two per-bus sysfs files:
ls-l /sys/subsystem/usb
drwxr-xr-x 2 root root 0 2007-02-16 16:42 devices
drwxr-xr-x 7 root root 0 2007-02-16 14:55 drivers
-rw-r--r-- 1 root root 4096 2007-02-16 16:42 drivers_autoprobe
--w------- 1 root root 4096 2007-02-16 16:42 drivers_probe
The flag "drivers_autoprobe" controls the behavior of the bus to bind
devices by default, or just initialize the device and leave it alone.
The command "drivers_probe" accepts a bus_id and the bus tries to bind a
driver to this device.
Systems who want to control the driver binding with udev, switch off the
bus initiated probing:
echo 0 > /sys/subsystem/usb/drivers_autoprobe
echo 0 > /sys/subsystem/pcmcia/drivers_autoprobe
...
and initiate the probing with udev rules like:
ACTION=="add", SUBSYSTEM=="usb", ATTR{subsystem/drivers_probe}="$kernel"
ACTION=="add", SUBSYSTEM=="pcmcia", ATTR{subsystem/drivers_probe}="$kernel"
...
Custom driver binding can happen in earlier rules by something like:
ACTION=="add", SUBSYSTEM=="usb", \
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="5678" \
ATTR{subsystem/drivers/<custom-driver>/bind}="$kernel"
This is intended to solve the modprobe.conf mess with "install-rules", custom
bind/unbind-scripts and all the weird things people invented over the years.
It should also provide the functionality "libusual" was supposed to do.
With udev, one can just write a udev rule to drive all USB-disks at the
third port of USB-hub by the "ub" driver, and everything else by
usb-storage. One can also instruct udev to bind different wireless
drivers to identical cards - just selected by the pcmcia slot-number, and
whatever ...
To use the mentioned rules, it needs udev version 106, to be able to
write ATTR{}="$kernel" to sysfs files.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-02-16 16:33:36 +00:00
|
|
|
};
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
#define BUS_ATTR(_name, _mode, _show, _store) \
|
|
|
|
|
struct bus_attribute bus_attr_##_name = __ATTR(_name, _mode, _show, _store)
|
Driver core: udev triggered device-<>driver binding
We get two per-bus sysfs files:
ls-l /sys/subsystem/usb
drwxr-xr-x 2 root root 0 2007-02-16 16:42 devices
drwxr-xr-x 7 root root 0 2007-02-16 14:55 drivers
-rw-r--r-- 1 root root 4096 2007-02-16 16:42 drivers_autoprobe
--w------- 1 root root 4096 2007-02-16 16:42 drivers_probe
The flag "drivers_autoprobe" controls the behavior of the bus to bind
devices by default, or just initialize the device and leave it alone.
The command "drivers_probe" accepts a bus_id and the bus tries to bind a
driver to this device.
Systems who want to control the driver binding with udev, switch off the
bus initiated probing:
echo 0 > /sys/subsystem/usb/drivers_autoprobe
echo 0 > /sys/subsystem/pcmcia/drivers_autoprobe
...
and initiate the probing with udev rules like:
ACTION=="add", SUBSYSTEM=="usb", ATTR{subsystem/drivers_probe}="$kernel"
ACTION=="add", SUBSYSTEM=="pcmcia", ATTR{subsystem/drivers_probe}="$kernel"
...
Custom driver binding can happen in earlier rules by something like:
ACTION=="add", SUBSYSTEM=="usb", \
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="5678" \
ATTR{subsystem/drivers/<custom-driver>/bind}="$kernel"
This is intended to solve the modprobe.conf mess with "install-rules", custom
bind/unbind-scripts and all the weird things people invented over the years.
It should also provide the functionality "libusual" was supposed to do.
With udev, one can just write a udev rule to drive all USB-disks at the
third port of USB-hub by the "ub" driver, and everything else by
usb-storage. One can also instruct udev to bind different wireless
drivers to identical cards - just selected by the pcmcia slot-number, and
whatever ...
To use the mentioned rules, it needs udev version 106, to be able to
write ATTR{}="$kernel" to sysfs files.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-02-16 16:33:36 +00:00
|
|
|
|
|
|
|
|
extern int __must_check bus_create_file(struct bus_type *,
|
|
|
|
|
struct bus_attribute *);
|
|
|
|
|
extern void bus_remove_file(struct bus_type *, struct bus_attribute *);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
struct bus_type {
|
2008-01-25 05:04:46 +00:00
|
|
|
const char *name;
|
|
|
|
|
struct bus_attribute *bus_attrs;
|
|
|
|
|
struct device_attribute *dev_attrs;
|
|
|
|
|
struct driver_attribute *drv_attrs;
|
|
|
|
|
|
|
|
|
|
int (*match)(struct device *dev, struct device_driver *drv);
|
|
|
|
|
int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
|
|
|
|
|
int (*probe)(struct device *dev);
|
|
|
|
|
int (*remove)(struct device *dev);
|
|
|
|
|
void (*shutdown)(struct device *dev);
|
|
|
|
|
|
|
|
|
|
int (*suspend)(struct device *dev, pm_message_t state);
|
|
|
|
|
int (*resume)(struct device *dev);
|
Driver core: udev triggered device-<>driver binding
We get two per-bus sysfs files:
ls-l /sys/subsystem/usb
drwxr-xr-x 2 root root 0 2007-02-16 16:42 devices
drwxr-xr-x 7 root root 0 2007-02-16 14:55 drivers
-rw-r--r-- 1 root root 4096 2007-02-16 16:42 drivers_autoprobe
--w------- 1 root root 4096 2007-02-16 16:42 drivers_probe
The flag "drivers_autoprobe" controls the behavior of the bus to bind
devices by default, or just initialize the device and leave it alone.
The command "drivers_probe" accepts a bus_id and the bus tries to bind a
driver to this device.
Systems who want to control the driver binding with udev, switch off the
bus initiated probing:
echo 0 > /sys/subsystem/usb/drivers_autoprobe
echo 0 > /sys/subsystem/pcmcia/drivers_autoprobe
...
and initiate the probing with udev rules like:
ACTION=="add", SUBSYSTEM=="usb", ATTR{subsystem/drivers_probe}="$kernel"
ACTION=="add", SUBSYSTEM=="pcmcia", ATTR{subsystem/drivers_probe}="$kernel"
...
Custom driver binding can happen in earlier rules by something like:
ACTION=="add", SUBSYSTEM=="usb", \
ATTRS{idVendor}=="1234", ATTRS{idProduct}=="5678" \
ATTR{subsystem/drivers/<custom-driver>/bind}="$kernel"
This is intended to solve the modprobe.conf mess with "install-rules", custom
bind/unbind-scripts and all the weird things people invented over the years.
It should also provide the functionality "libusual" was supposed to do.
With udev, one can just write a udev rule to drive all USB-disks at the
third port of USB-hub by the "ub" driver, and everything else by
usb-storage. One can also instruct udev to bind different wireless
drivers to identical cards - just selected by the pcmcia slot-number, and
whatever ...
To use the mentioned rules, it needs udev version 106, to be able to
write ATTR{}="$kernel" to sysfs files.
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-02-16 16:33:36 +00:00
|
|
|
|
2009-07-25 05:11:32 +00:00
|
|
|
const struct dev_pm_ops *pm;
|
Introduce new top level suspend and hibernation callbacks
Introduce 'struct pm_ops' and 'struct pm_ext_ops' ('ext' meaning
'extended') representing suspend and hibernation operations for bus
types, device classes, device types and device drivers.
Modify the PM core to use 'struct pm_ops' and 'struct pm_ext_ops'
objects, if defined, instead of the ->suspend(), ->resume(),
->suspend_late(), and ->resume_early() callbacks (the old callbacks
will be considered as legacy and gradually phased out).
The main purpose of doing this is to separate suspend (aka S2RAM and
standby) callbacks from hibernation callbacks in such a way that the
new callbacks won't take arguments and the semantics of each of them
will be clearly specified. This has been requested for multiple
times by many people, including Linus himself, and the reason is that
within the current scheme if ->resume() is called, for example, it's
difficult to say why it's been called (ie. is it a resume from RAM or
from hibernation or a suspend/hibernation failure etc.?).
The second purpose is to make the suspend/hibernation callbacks more
flexible so that device drivers can handle more than they can within
the current scheme. For example, some drivers may need to prevent
new children of the device from being registered before their
->suspend() callbacks are executed or they may want to carry out some
operations requiring the availability of some other devices, not
directly bound via the parent-child relationship, in order to prepare
for the execution of ->suspend(), etc.
Ultimately, we'd like to stop using the freezing of tasks for suspend
and therefore the drivers' suspend/hibernation code will have to take
care of the handling of the user space during suspend/hibernation.
That, in turn, would be difficult within the current scheme, without
the new ->prepare() and ->complete() callbacks.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org>
2008-05-20 21:00:01 +00:00
|
|
|
|
2007-11-02 02:41:16 +00:00
|
|
|
struct bus_type_private *p;
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check bus_register(struct bus_type *bus);
|
|
|
|
|
extern void bus_unregister(struct bus_type *bus);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check bus_rescan_devices(struct bus_type *bus);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
/* iterator helpers for buses */
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
int bus_for_each_dev(struct bus_type *bus, struct device *start, void *data,
|
|
|
|
|
int (*fn)(struct device *dev, void *data));
|
|
|
|
|
struct device *bus_find_device(struct bus_type *bus, struct device *start,
|
|
|
|
|
void *data,
|
|
|
|
|
int (*match)(struct device *dev, void *data));
|
2008-01-27 18:29:20 +00:00
|
|
|
struct device *bus_find_device_by_name(struct bus_type *bus,
|
|
|
|
|
struct device *start,
|
|
|
|
|
const char *name);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2006-08-15 05:43:17 +00:00
|
|
|
int __must_check bus_for_each_drv(struct bus_type *bus,
|
2008-01-25 05:04:46 +00:00
|
|
|
struct device_driver *start, void *data,
|
|
|
|
|
int (*fn)(struct device_driver *, void *));
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-08-26 16:00:57 +00:00
|
|
|
void bus_sort_breadthfirst(struct bus_type *bus,
|
|
|
|
|
int (*compare)(const struct device *a,
|
|
|
|
|
const struct device *b));
|
Driver core: add notification of bus events
I finally did as you suggested and added the notifier to the struct
bus_type itself. There are still problems to be expected is something
attaches to a bus type where the code can hook in different struct
device sub-classes (which is imho a big bogosity but I won't even try to
argue that case now) but it will solve nicely a number of issues I've
had so far.
That also means that clients interested in registering for such
notifications have to do it before devices are added and after bus types
are registered. Fortunately, most bus types that matter for the various
usage scenarios I have in mind are registerd at postcore_initcall time,
which means I have a really nice spot at arch_initcall time to add my
notifiers.
There are 4 notifications provided. Device being added (before hooked to
the bus) and removed (failure of previous case or after being unhooked
from the bus), along with driver being bound to a device and about to be
unbound.
The usage I have for these are:
- The 2 first ones are used to maintain a struct device_ext that is
hooked to struct device.firmware_data. This structure contains for now a
pointer to the Open Firmware node related to the device (if any), the
NUMA node ID (for quick access to it) and the DMA operations pointers &
iommu table instance for DMA to/from this device. For bus types I own
(like IBM VIO or EBUS), I just maintain that structure directly from the
bus code when creating the devices. But for bus types managed by generic
code like PCI or platform (actually, of_platform which is a variation of
platform linked to Open Firmware device-tree), I need this notifier.
- The other two ones have a completely different usage scenario. I have
cases where multiple devices and their drivers depend on each other. For
example, the IBM EMAC network driver needs to attach to a MAL DMA engine
which is a separate device, and a PHY interface which is also a separate
device. They are all of_platform_device's (well, about to be with my
upcoming patches) but there is no say in what precise order the core
will "probe" them and instanciate the various modules. The solution I
found for that is to have the drivers for emac to use multithread_probe,
and wait for a driver to be bound to the target MAL and PHY control
devices (the device-tree contains reference to the MAL and PHY interface
nodes, which I can then match to of_platform_devices). Right now, I've
been polling, but with that notifier, I can more cleanly wait (with a
timeout of course).
Signed-off-by: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2006-10-25 03:44:59 +00:00
|
|
|
/*
|
|
|
|
|
* Bus notifiers: Get notified of addition/removal of devices
|
|
|
|
|
* and binding/unbinding of drivers to devices.
|
|
|
|
|
* In the long run, it should be a replacement for the platform
|
|
|
|
|
* notify hooks.
|
|
|
|
|
*/
|
|
|
|
|
struct notifier_block;
|
|
|
|
|
|
|
|
|
|
extern int bus_register_notifier(struct bus_type *bus,
|
|
|
|
|
struct notifier_block *nb);
|
|
|
|
|
extern int bus_unregister_notifier(struct bus_type *bus,
|
|
|
|
|
struct notifier_block *nb);
|
|
|
|
|
|
|
|
|
|
/* All 4 notifers below get called with the target struct device *
|
|
|
|
|
* as an argument. Note that those functions are likely to be called
|
|
|
|
|
* with the device semaphore held in the core, so be careful.
|
|
|
|
|
*/
|
|
|
|
|
#define BUS_NOTIFY_ADD_DEVICE 0x00000001 /* device added */
|
|
|
|
|
#define BUS_NOTIFY_DEL_DEVICE 0x00000002 /* device removed */
|
|
|
|
|
#define BUS_NOTIFY_BOUND_DRIVER 0x00000003 /* driver bound to device */
|
|
|
|
|
#define BUS_NOTIFY_UNBIND_DRIVER 0x00000004 /* driver about to be
|
|
|
|
|
unbound */
|
2009-04-24 12:57:00 +00:00
|
|
|
#define BUS_NOTIFY_UNBOUND_DRIVER 0x00000005 /* driver is unbound
|
|
|
|
|
from the device */
|
Driver core: add notification of bus events
I finally did as you suggested and added the notifier to the struct
bus_type itself. There are still problems to be expected is something
attaches to a bus type where the code can hook in different struct
device sub-classes (which is imho a big bogosity but I won't even try to
argue that case now) but it will solve nicely a number of issues I've
had so far.
That also means that clients interested in registering for such
notifications have to do it before devices are added and after bus types
are registered. Fortunately, most bus types that matter for the various
usage scenarios I have in mind are registerd at postcore_initcall time,
which means I have a really nice spot at arch_initcall time to add my
notifiers.
There are 4 notifications provided. Device being added (before hooked to
the bus) and removed (failure of previous case or after being unhooked
from the bus), along with driver being bound to a device and about to be
unbound.
The usage I have for these are:
- The 2 first ones are used to maintain a struct device_ext that is
hooked to struct device.firmware_data. This structure contains for now a
pointer to the Open Firmware node related to the device (if any), the
NUMA node ID (for quick access to it) and the DMA operations pointers &
iommu table instance for DMA to/from this device. For bus types I own
(like IBM VIO or EBUS), I just maintain that structure directly from the
bus code when creating the devices. But for bus types managed by generic
code like PCI or platform (actually, of_platform which is a variation of
platform linked to Open Firmware device-tree), I need this notifier.
- The other two ones have a completely different usage scenario. I have
cases where multiple devices and their drivers depend on each other. For
example, the IBM EMAC network driver needs to attach to a MAL DMA engine
which is a separate device, and a PHY interface which is also a separate
device. They are all of_platform_device's (well, about to be with my
upcoming patches) but there is no say in what precise order the core
will "probe" them and instanciate the various modules. The solution I
found for that is to have the drivers for emac to use multithread_probe,
and wait for a driver to be bound to the target MAL and PHY control
devices (the device-tree contains reference to the MAL and PHY interface
nodes, which I can then match to of_platform_devices). Right now, I've
been polling, but with that notifier, I can more cleanly wait (with a
timeout of course).
Signed-off-by: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2006-10-25 03:44:59 +00:00
|
|
|
|
2007-11-02 02:41:16 +00:00
|
|
|
extern struct kset *bus_get_kset(struct bus_type *bus);
|
2007-11-02 02:41:16 +00:00
|
|
|
extern struct klist *bus_get_device_klist(struct bus_type *bus);
|
2007-11-02 02:41:16 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
struct device_driver {
|
2007-11-28 23:59:15 +00:00
|
|
|
const char *name;
|
|
|
|
|
struct bus_type *bus;
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2007-11-28 23:59:15 +00:00
|
|
|
struct module *owner;
|
2009-10-13 03:17:41 +00:00
|
|
|
const char *mod_name; /* used for built-in modules */
|
|
|
|
|
|
|
|
|
|
bool suppress_bind_attrs; /* disables bind/unbind via sysfs */
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
int (*probe) (struct device *dev);
|
|
|
|
|
int (*remove) (struct device *dev);
|
|
|
|
|
void (*shutdown) (struct device *dev);
|
|
|
|
|
int (*suspend) (struct device *dev, pm_message_t state);
|
|
|
|
|
int (*resume) (struct device *dev);
|
2009-06-24 17:06:31 +00:00
|
|
|
const struct attribute_group **groups;
|
2007-11-28 23:59:15 +00:00
|
|
|
|
2009-07-25 05:11:32 +00:00
|
|
|
const struct dev_pm_ops *pm;
|
Introduce new top level suspend and hibernation callbacks
Introduce 'struct pm_ops' and 'struct pm_ext_ops' ('ext' meaning
'extended') representing suspend and hibernation operations for bus
types, device classes, device types and device drivers.
Modify the PM core to use 'struct pm_ops' and 'struct pm_ext_ops'
objects, if defined, instead of the ->suspend(), ->resume(),
->suspend_late(), and ->resume_early() callbacks (the old callbacks
will be considered as legacy and gradually phased out).
The main purpose of doing this is to separate suspend (aka S2RAM and
standby) callbacks from hibernation callbacks in such a way that the
new callbacks won't take arguments and the semantics of each of them
will be clearly specified. This has been requested for multiple
times by many people, including Linus himself, and the reason is that
within the current scheme if ->resume() is called, for example, it's
difficult to say why it's been called (ie. is it a resume from RAM or
from hibernation or a suspend/hibernation failure etc.?).
The second purpose is to make the suspend/hibernation callbacks more
flexible so that device drivers can handle more than they can within
the current scheme. For example, some drivers may need to prevent
new children of the device from being registered before their
->suspend() callbacks are executed or they may want to carry out some
operations requiring the availability of some other devices, not
directly bound via the parent-child relationship, in order to prepare
for the execution of ->suspend(), etc.
Ultimately, we'd like to stop using the freezing of tasks for suspend
and therefore the drivers' suspend/hibernation code will have to take
care of the handling of the user space during suspend/hibernation.
That, in turn, would be difficult within the current scheme, without
the new ->prepare() and ->complete() callbacks.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org>
2008-05-20 21:00:01 +00:00
|
|
|
|
2007-11-28 23:59:15 +00:00
|
|
|
struct driver_private *p;
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check driver_register(struct device_driver *drv);
|
|
|
|
|
extern void driver_unregister(struct device_driver *drv);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern struct device_driver *get_driver(struct device_driver *drv);
|
|
|
|
|
extern void put_driver(struct device_driver *drv);
|
|
|
|
|
extern struct device_driver *driver_find(const char *name,
|
|
|
|
|
struct bus_type *bus);
|
2006-07-18 17:59:59 +00:00
|
|
|
extern int driver_probe_done(void);
|
2009-02-21 08:45:07 +00:00
|
|
|
extern void wait_for_device_probe(void);
|
2009-02-14 00:59:06 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2007-02-17 18:13:42 +00:00
|
|
|
/* sysfs interface for exporting driver attributes */
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
struct driver_attribute {
|
2008-01-25 05:04:46 +00:00
|
|
|
struct attribute attr;
|
|
|
|
|
ssize_t (*show)(struct device_driver *driver, char *buf);
|
|
|
|
|
ssize_t (*store)(struct device_driver *driver, const char *buf,
|
|
|
|
|
size_t count);
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
#define DRIVER_ATTR(_name, _mode, _show, _store) \
|
|
|
|
|
struct driver_attribute driver_attr_##_name = \
|
|
|
|
|
__ATTR(_name, _mode, _show, _store)
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check driver_create_file(struct device_driver *driver,
|
|
|
|
|
struct driver_attribute *attr);
|
|
|
|
|
extern void driver_remove_file(struct device_driver *driver,
|
|
|
|
|
struct driver_attribute *attr);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2007-12-19 19:54:39 +00:00
|
|
|
extern int __must_check driver_add_kobj(struct device_driver *drv,
|
|
|
|
|
struct kobject *kobj,
|
|
|
|
|
const char *fmt, ...);
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check driver_for_each_device(struct device_driver *drv,
|
|
|
|
|
struct device *start,
|
|
|
|
|
void *data,
|
|
|
|
|
int (*fn)(struct device *dev,
|
|
|
|
|
void *));
|
|
|
|
|
struct device *driver_find_device(struct device_driver *drv,
|
|
|
|
|
struct device *start, void *data,
|
|
|
|
|
int (*match)(struct device *dev, void *data));
|
2005-03-21 18:59:56 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/*
|
|
|
|
|
* device classes
|
|
|
|
|
*/
|
|
|
|
|
struct class {
|
2008-01-25 05:04:46 +00:00
|
|
|
const char *name;
|
|
|
|
|
struct module *owner;
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
struct class_attribute *class_attrs;
|
|
|
|
|
struct device_attribute *dev_attrs;
|
2008-04-21 17:51:07 +00:00
|
|
|
struct kobject *dev_kobj;
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
|
2009-09-18 21:01:12 +00:00
|
|
|
char *(*devnode)(struct device *dev, mode_t *mode);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
void (*class_release)(struct class *class);
|
|
|
|
|
void (*dev_release)(struct device *dev);
|
2006-06-24 21:50:29 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
int (*suspend)(struct device *dev, pm_message_t state);
|
|
|
|
|
int (*resume)(struct device *dev);
|
Introduce new top level suspend and hibernation callbacks
Introduce 'struct pm_ops' and 'struct pm_ext_ops' ('ext' meaning
'extended') representing suspend and hibernation operations for bus
types, device classes, device types and device drivers.
Modify the PM core to use 'struct pm_ops' and 'struct pm_ext_ops'
objects, if defined, instead of the ->suspend(), ->resume(),
->suspend_late(), and ->resume_early() callbacks (the old callbacks
will be considered as legacy and gradually phased out).
The main purpose of doing this is to separate suspend (aka S2RAM and
standby) callbacks from hibernation callbacks in such a way that the
new callbacks won't take arguments and the semantics of each of them
will be clearly specified. This has been requested for multiple
times by many people, including Linus himself, and the reason is that
within the current scheme if ->resume() is called, for example, it's
difficult to say why it's been called (ie. is it a resume from RAM or
from hibernation or a suspend/hibernation failure etc.?).
The second purpose is to make the suspend/hibernation callbacks more
flexible so that device drivers can handle more than they can within
the current scheme. For example, some drivers may need to prevent
new children of the device from being registered before their
->suspend() callbacks are executed or they may want to carry out some
operations requiring the availability of some other devices, not
directly bound via the parent-child relationship, in order to prepare
for the execution of ->suspend(), etc.
Ultimately, we'd like to stop using the freezing of tasks for suspend
and therefore the drivers' suspend/hibernation code will have to take
care of the handling of the user space during suspend/hibernation.
That, in turn, would be difficult within the current scheme, without
the new ->prepare() and ->complete() callbacks.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org>
2008-05-20 21:00:01 +00:00
|
|
|
|
2009-07-25 05:11:32 +00:00
|
|
|
const struct dev_pm_ops *pm;
|
|
|
|
|
|
2008-01-22 23:17:41 +00:00
|
|
|
struct class_private *p;
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
2008-08-25 17:50:19 +00:00
|
|
|
struct class_dev_iter {
|
|
|
|
|
struct klist_iter ki;
|
|
|
|
|
const struct device_type *type;
|
|
|
|
|
};
|
|
|
|
|
|
2008-04-21 17:51:07 +00:00
|
|
|
extern struct kobject *sysfs_dev_block_kobj;
|
|
|
|
|
extern struct kobject *sysfs_dev_char_kobj;
|
2008-05-28 16:28:39 +00:00
|
|
|
extern int __must_check __class_register(struct class *class,
|
|
|
|
|
struct lock_class_key *key);
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void class_unregister(struct class *class);
|
2008-05-28 16:28:39 +00:00
|
|
|
|
|
|
|
|
/* This is a #define to keep the compiler from merging different
|
|
|
|
|
* instances of the __key variable */
|
|
|
|
|
#define class_register(class) \
|
|
|
|
|
({ \
|
|
|
|
|
static struct lock_class_key __key; \
|
|
|
|
|
__class_register(class, &__key); \
|
|
|
|
|
})
|
|
|
|
|
|
2009-08-04 10:55:34 +00:00
|
|
|
struct class_compat;
|
|
|
|
|
struct class_compat *class_compat_register(const char *name);
|
|
|
|
|
void class_compat_unregister(struct class_compat *cls);
|
|
|
|
|
int class_compat_create_link(struct class_compat *cls, struct device *dev,
|
|
|
|
|
struct device *device_link);
|
|
|
|
|
void class_compat_remove_link(struct class_compat *cls, struct device *dev,
|
|
|
|
|
struct device *device_link);
|
|
|
|
|
|
2008-08-25 17:50:19 +00:00
|
|
|
extern void class_dev_iter_init(struct class_dev_iter *iter,
|
|
|
|
|
struct class *class,
|
|
|
|
|
struct device *start,
|
|
|
|
|
const struct device_type *type);
|
|
|
|
|
extern struct device *class_dev_iter_next(struct class_dev_iter *iter);
|
|
|
|
|
extern void class_dev_iter_exit(struct class_dev_iter *iter);
|
|
|
|
|
|
2008-05-22 21:21:08 +00:00
|
|
|
extern int class_for_each_device(struct class *class, struct device *start,
|
|
|
|
|
void *data,
|
2008-01-22 07:27:08 +00:00
|
|
|
int (*fn)(struct device *dev, void *data));
|
2008-05-22 21:21:08 +00:00
|
|
|
extern struct device *class_find_device(struct class *class,
|
|
|
|
|
struct device *start, void *data,
|
2008-01-22 07:27:08 +00:00
|
|
|
int (*match)(struct device *, void *));
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
struct class_attribute {
|
2008-01-25 05:04:46 +00:00
|
|
|
struct attribute attr;
|
|
|
|
|
ssize_t (*show)(struct class *class, char *buf);
|
|
|
|
|
ssize_t (*store)(struct class *class, const char *buf, size_t count);
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
#define CLASS_ATTR(_name, _mode, _show, _store) \
|
|
|
|
|
struct class_attribute class_attr_##_name = __ATTR(_name, _mode, _show, _store)
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check class_create_file(struct class *class,
|
|
|
|
|
const struct class_attribute *attr);
|
|
|
|
|
extern void class_remove_file(struct class *class,
|
|
|
|
|
const struct class_attribute *attr);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
struct class_interface {
|
|
|
|
|
struct list_head node;
|
|
|
|
|
struct class *class;
|
|
|
|
|
|
2006-09-13 13:34:05 +00:00
|
|
|
int (*add_dev) (struct device *, struct class_interface *);
|
|
|
|
|
void (*remove_dev) (struct device *, struct class_interface *);
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
2006-08-15 05:43:17 +00:00
|
|
|
extern int __must_check class_interface_register(struct class_interface *);
|
2005-04-16 22:20:36 +00:00
|
|
|
extern void class_interface_unregister(struct class_interface *);
|
|
|
|
|
|
2008-05-28 16:28:39 +00:00
|
|
|
extern struct class * __must_check __class_create(struct module *owner,
|
|
|
|
|
const char *name,
|
|
|
|
|
struct lock_class_key *key);
|
2005-03-15 19:54:21 +00:00
|
|
|
extern void class_destroy(struct class *cls);
|
|
|
|
|
|
2008-05-28 16:28:39 +00:00
|
|
|
/* This is a #define to keep the compiler from merging different
|
|
|
|
|
* instances of the __key variable */
|
|
|
|
|
#define class_create(owner, name) \
|
|
|
|
|
({ \
|
|
|
|
|
static struct lock_class_key __key; \
|
|
|
|
|
__class_create(owner, name, &__key); \
|
|
|
|
|
})
|
|
|
|
|
|
2007-03-12 20:08:57 +00:00
|
|
|
/*
|
|
|
|
|
* The type of device, "struct device" is embedded in. A class
|
|
|
|
|
* or bus can contain devices of different types
|
|
|
|
|
* like "partitions" and "disks", "mouse" and "event".
|
|
|
|
|
* This identifies the device type and carries type-specific
|
|
|
|
|
* information, equivalent to the kobj_type of a kobject.
|
|
|
|
|
* If "name" is specified, the uevent will contain it in
|
|
|
|
|
* the DEVTYPE variable.
|
|
|
|
|
*/
|
2006-10-07 19:54:55 +00:00
|
|
|
struct device_type {
|
2007-03-12 20:08:57 +00:00
|
|
|
const char *name;
|
2009-06-24 17:06:31 +00:00
|
|
|
const struct attribute_group **groups;
|
2007-08-14 13:15:12 +00:00
|
|
|
int (*uevent)(struct device *dev, struct kobj_uevent_env *env);
|
2009-09-18 21:01:12 +00:00
|
|
|
char *(*devnode)(struct device *dev, mode_t *mode);
|
2006-10-07 19:54:55 +00:00
|
|
|
void (*release)(struct device *dev);
|
Introduce new top level suspend and hibernation callbacks
Introduce 'struct pm_ops' and 'struct pm_ext_ops' ('ext' meaning
'extended') representing suspend and hibernation operations for bus
types, device classes, device types and device drivers.
Modify the PM core to use 'struct pm_ops' and 'struct pm_ext_ops'
objects, if defined, instead of the ->suspend(), ->resume(),
->suspend_late(), and ->resume_early() callbacks (the old callbacks
will be considered as legacy and gradually phased out).
The main purpose of doing this is to separate suspend (aka S2RAM and
standby) callbacks from hibernation callbacks in such a way that the
new callbacks won't take arguments and the semantics of each of them
will be clearly specified. This has been requested for multiple
times by many people, including Linus himself, and the reason is that
within the current scheme if ->resume() is called, for example, it's
difficult to say why it's been called (ie. is it a resume from RAM or
from hibernation or a suspend/hibernation failure etc.?).
The second purpose is to make the suspend/hibernation callbacks more
flexible so that device drivers can handle more than they can within
the current scheme. For example, some drivers may need to prevent
new children of the device from being registered before their
->suspend() callbacks are executed or they may want to carry out some
operations requiring the availability of some other devices, not
directly bound via the parent-child relationship, in order to prepare
for the execution of ->suspend(), etc.
Ultimately, we'd like to stop using the freezing of tasks for suspend
and therefore the drivers' suspend/hibernation code will have to take
care of the handling of the user space during suspend/hibernation.
That, in turn, would be difficult within the current scheme, without
the new ->prepare() and ->complete() callbacks.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org>
2008-05-20 21:00:01 +00:00
|
|
|
|
2009-07-25 05:11:32 +00:00
|
|
|
const struct dev_pm_ops *pm;
|
2006-10-07 19:54:55 +00:00
|
|
|
};
|
|
|
|
|
|
2005-10-01 12:49:43 +00:00
|
|
|
/* interface for exporting device attributes */
|
|
|
|
|
struct device_attribute {
|
|
|
|
|
struct attribute attr;
|
|
|
|
|
ssize_t (*show)(struct device *dev, struct device_attribute *attr,
|
|
|
|
|
char *buf);
|
|
|
|
|
ssize_t (*store)(struct device *dev, struct device_attribute *attr,
|
|
|
|
|
const char *buf, size_t count);
|
|
|
|
|
};
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
#define DEVICE_ATTR(_name, _mode, _show, _store) \
|
|
|
|
|
struct device_attribute dev_attr_##_name = __ATTR(_name, _mode, _show, _store)
|
2005-10-01 12:49:43 +00:00
|
|
|
|
2006-08-15 05:43:17 +00:00
|
|
|
extern int __must_check device_create_file(struct device *device,
|
2009-12-18 13:34:19 +00:00
|
|
|
const struct device_attribute *entry);
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void device_remove_file(struct device *dev,
|
2009-12-18 13:34:19 +00:00
|
|
|
const struct device_attribute *attr);
|
2006-09-19 16:39:19 +00:00
|
|
|
extern int __must_check device_create_bin_file(struct device *dev,
|
|
|
|
|
struct bin_attribute *attr);
|
|
|
|
|
extern void device_remove_bin_file(struct device *dev,
|
|
|
|
|
struct bin_attribute *attr);
|
2007-04-26 07:12:04 +00:00
|
|
|
extern int device_schedule_callback_owner(struct device *dev,
|
2008-01-25 05:04:46 +00:00
|
|
|
void (*func)(struct device *dev), struct module *owner);
|
2007-04-26 07:12:04 +00:00
|
|
|
|
|
|
|
|
/* This is a macro to avoid include problems with THIS_MODULE */
|
|
|
|
|
#define device_schedule_callback(dev, func) \
|
|
|
|
|
device_schedule_callback_owner(dev, func, THIS_MODULE)
|
devres: device resource management
Implement device resource management, in short, devres. A device
driver can allocate arbirary size of devres data which is associated
with a release function. On driver detach, release function is
invoked on the devres data, then, devres data is freed.
devreses are typed by associated release functions. Some devreses are
better represented by single instance of the type while others need
multiple instances sharing the same release function. Both usages are
supported.
devreses can be grouped using devres group such that a device driver
can easily release acquired resources halfway through initialization
or selectively release resources (e.g. resources for port 1 out of 4
ports).
This patch adds devres core including documentation and the following
managed interfaces.
* alloc/free : devm_kzalloc(), devm_kzfree()
* IO region : devm_request_region(), devm_release_region()
* IRQ : devm_request_irq(), devm_free_irq()
* DMA : dmam_alloc_coherent(), dmam_free_coherent(),
dmam_declare_coherent_memory(), dmam_pool_create(),
dmam_pool_destroy()
* PCI : pcim_enable_device(), pcim_pin_device(), pci_is_managed()
* iomap : devm_ioport_map(), devm_ioport_unmap(), devm_ioremap(),
devm_ioremap_nocache(), devm_iounmap(), pcim_iomap_table(),
pcim_iomap(), pcim_iounmap()
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-01-20 07:00:26 +00:00
|
|
|
|
|
|
|
|
/* device resource management */
|
|
|
|
|
typedef void (*dr_release_t)(struct device *dev, void *res);
|
|
|
|
|
typedef int (*dr_match_t)(struct device *dev, void *res, void *match_data);
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_DEBUG_DEVRES
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void *__devres_alloc(dr_release_t release, size_t size, gfp_t gfp,
|
devres: device resource management
Implement device resource management, in short, devres. A device
driver can allocate arbirary size of devres data which is associated
with a release function. On driver detach, release function is
invoked on the devres data, then, devres data is freed.
devreses are typed by associated release functions. Some devreses are
better represented by single instance of the type while others need
multiple instances sharing the same release function. Both usages are
supported.
devreses can be grouped using devres group such that a device driver
can easily release acquired resources halfway through initialization
or selectively release resources (e.g. resources for port 1 out of 4
ports).
This patch adds devres core including documentation and the following
managed interfaces.
* alloc/free : devm_kzalloc(), devm_kzfree()
* IO region : devm_request_region(), devm_release_region()
* IRQ : devm_request_irq(), devm_free_irq()
* DMA : dmam_alloc_coherent(), dmam_free_coherent(),
dmam_declare_coherent_memory(), dmam_pool_create(),
dmam_pool_destroy()
* PCI : pcim_enable_device(), pcim_pin_device(), pci_is_managed()
* iomap : devm_ioport_map(), devm_ioport_unmap(), devm_ioremap(),
devm_ioremap_nocache(), devm_iounmap(), pcim_iomap_table(),
pcim_iomap(), pcim_iounmap()
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-01-20 07:00:26 +00:00
|
|
|
const char *name);
|
|
|
|
|
#define devres_alloc(release, size, gfp) \
|
|
|
|
|
__devres_alloc(release, size, gfp, #release)
|
|
|
|
|
#else
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void *devres_alloc(dr_release_t release, size_t size, gfp_t gfp);
|
devres: device resource management
Implement device resource management, in short, devres. A device
driver can allocate arbirary size of devres data which is associated
with a release function. On driver detach, release function is
invoked on the devres data, then, devres data is freed.
devreses are typed by associated release functions. Some devreses are
better represented by single instance of the type while others need
multiple instances sharing the same release function. Both usages are
supported.
devreses can be grouped using devres group such that a device driver
can easily release acquired resources halfway through initialization
or selectively release resources (e.g. resources for port 1 out of 4
ports).
This patch adds devres core including documentation and the following
managed interfaces.
* alloc/free : devm_kzalloc(), devm_kzfree()
* IO region : devm_request_region(), devm_release_region()
* IRQ : devm_request_irq(), devm_free_irq()
* DMA : dmam_alloc_coherent(), dmam_free_coherent(),
dmam_declare_coherent_memory(), dmam_pool_create(),
dmam_pool_destroy()
* PCI : pcim_enable_device(), pcim_pin_device(), pci_is_managed()
* iomap : devm_ioport_map(), devm_ioport_unmap(), devm_ioremap(),
devm_ioremap_nocache(), devm_iounmap(), pcim_iomap_table(),
pcim_iomap(), pcim_iounmap()
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-01-20 07:00:26 +00:00
|
|
|
#endif
|
|
|
|
|
extern void devres_free(void *res);
|
|
|
|
|
extern void devres_add(struct device *dev, void *res);
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void *devres_find(struct device *dev, dr_release_t release,
|
devres: device resource management
Implement device resource management, in short, devres. A device
driver can allocate arbirary size of devres data which is associated
with a release function. On driver detach, release function is
invoked on the devres data, then, devres data is freed.
devreses are typed by associated release functions. Some devreses are
better represented by single instance of the type while others need
multiple instances sharing the same release function. Both usages are
supported.
devreses can be grouped using devres group such that a device driver
can easily release acquired resources halfway through initialization
or selectively release resources (e.g. resources for port 1 out of 4
ports).
This patch adds devres core including documentation and the following
managed interfaces.
* alloc/free : devm_kzalloc(), devm_kzfree()
* IO region : devm_request_region(), devm_release_region()
* IRQ : devm_request_irq(), devm_free_irq()
* DMA : dmam_alloc_coherent(), dmam_free_coherent(),
dmam_declare_coherent_memory(), dmam_pool_create(),
dmam_pool_destroy()
* PCI : pcim_enable_device(), pcim_pin_device(), pci_is_managed()
* iomap : devm_ioport_map(), devm_ioport_unmap(), devm_ioremap(),
devm_ioremap_nocache(), devm_iounmap(), pcim_iomap_table(),
pcim_iomap(), pcim_iounmap()
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-01-20 07:00:26 +00:00
|
|
|
dr_match_t match, void *match_data);
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void *devres_get(struct device *dev, void *new_res,
|
|
|
|
|
dr_match_t match, void *match_data);
|
|
|
|
|
extern void *devres_remove(struct device *dev, dr_release_t release,
|
|
|
|
|
dr_match_t match, void *match_data);
|
devres: device resource management
Implement device resource management, in short, devres. A device
driver can allocate arbirary size of devres data which is associated
with a release function. On driver detach, release function is
invoked on the devres data, then, devres data is freed.
devreses are typed by associated release functions. Some devreses are
better represented by single instance of the type while others need
multiple instances sharing the same release function. Both usages are
supported.
devreses can be grouped using devres group such that a device driver
can easily release acquired resources halfway through initialization
or selectively release resources (e.g. resources for port 1 out of 4
ports).
This patch adds devres core including documentation and the following
managed interfaces.
* alloc/free : devm_kzalloc(), devm_kzfree()
* IO region : devm_request_region(), devm_release_region()
* IRQ : devm_request_irq(), devm_free_irq()
* DMA : dmam_alloc_coherent(), dmam_free_coherent(),
dmam_declare_coherent_memory(), dmam_pool_create(),
dmam_pool_destroy()
* PCI : pcim_enable_device(), pcim_pin_device(), pci_is_managed()
* iomap : devm_ioport_map(), devm_ioport_unmap(), devm_ioremap(),
devm_ioremap_nocache(), devm_iounmap(), pcim_iomap_table(),
pcim_iomap(), pcim_iounmap()
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-01-20 07:00:26 +00:00
|
|
|
extern int devres_destroy(struct device *dev, dr_release_t release,
|
|
|
|
|
dr_match_t match, void *match_data);
|
|
|
|
|
|
|
|
|
|
/* devres group */
|
|
|
|
|
extern void * __must_check devres_open_group(struct device *dev, void *id,
|
|
|
|
|
gfp_t gfp);
|
|
|
|
|
extern void devres_close_group(struct device *dev, void *id);
|
|
|
|
|
extern void devres_remove_group(struct device *dev, void *id);
|
|
|
|
|
extern int devres_release_group(struct device *dev, void *id);
|
|
|
|
|
|
|
|
|
|
/* managed kzalloc/kfree for device drivers, no kmalloc, always use kzalloc */
|
|
|
|
|
extern void *devm_kzalloc(struct device *dev, size_t size, gfp_t gfp);
|
|
|
|
|
extern void devm_kfree(struct device *dev, void *p);
|
|
|
|
|
|
2008-02-05 06:27:55 +00:00
|
|
|
struct device_dma_parameters {
|
|
|
|
|
/*
|
|
|
|
|
* a low level driver may set these to teach IOMMU code about
|
|
|
|
|
* sg limitations.
|
|
|
|
|
*/
|
|
|
|
|
unsigned int max_segment_size;
|
|
|
|
|
unsigned long segment_boundary_mask;
|
|
|
|
|
};
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
struct device {
|
2007-05-08 07:29:39 +00:00
|
|
|
struct device *parent;
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-12-16 20:23:36 +00:00
|
|
|
struct device_private *p;
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
struct kobject kobj;
|
2008-05-30 17:45:12 +00:00
|
|
|
const char *init_name; /* initial name of the device */
|
2006-10-07 19:54:55 +00:00
|
|
|
struct device_type *type;
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2005-03-21 18:41:04 +00:00
|
|
|
struct semaphore sem; /* semaphore to synchronize calls to
|
|
|
|
|
* its driver.
|
|
|
|
|
*/
|
|
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
struct bus_type *bus; /* type of bus device is on */
|
2005-04-16 22:20:36 +00:00
|
|
|
struct device_driver *driver; /* which driver has allocated this
|
|
|
|
|
device */
|
2009-03-08 15:13:32 +00:00
|
|
|
void *platform_data; /* Platform specific data, device
|
|
|
|
|
core doesn't touch it */
|
2005-04-16 22:20:36 +00:00
|
|
|
struct dev_pm_info power;
|
|
|
|
|
|
2006-12-07 04:32:33 +00:00
|
|
|
#ifdef CONFIG_NUMA
|
|
|
|
|
int numa_node; /* NUMA node this device is close to */
|
|
|
|
|
#endif
|
2005-04-16 22:20:36 +00:00
|
|
|
u64 *dma_mask; /* dma mask (if dma'able device) */
|
|
|
|
|
u64 coherent_dma_mask;/* Like dma_mask, but for
|
|
|
|
|
alloc_coherent mappings as
|
|
|
|
|
not all hardware supports
|
|
|
|
|
64 bit addresses for consistent
|
|
|
|
|
allocations such descriptors. */
|
|
|
|
|
|
2008-02-05 06:27:55 +00:00
|
|
|
struct device_dma_parameters *dma_parms;
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
struct list_head dma_pools; /* dma pools (if dma'ble) */
|
|
|
|
|
|
|
|
|
|
struct dma_coherent_mem *dma_mem; /* internal for coherent mem
|
|
|
|
|
override */
|
2006-11-11 06:18:39 +00:00
|
|
|
/* arch specific additions */
|
|
|
|
|
struct dev_archdata archdata;
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-10-16 21:51:35 +00:00
|
|
|
dev_t devt; /* dev_t, creates the sysfs "dev" */
|
|
|
|
|
|
devres: device resource management
Implement device resource management, in short, devres. A device
driver can allocate arbirary size of devres data which is associated
with a release function. On driver detach, release function is
invoked on the devres data, then, devres data is freed.
devreses are typed by associated release functions. Some devreses are
better represented by single instance of the type while others need
multiple instances sharing the same release function. Both usages are
supported.
devreses can be grouped using devres group such that a device driver
can easily release acquired resources halfway through initialization
or selectively release resources (e.g. resources for port 1 out of 4
ports).
This patch adds devres core including documentation and the following
managed interfaces.
* alloc/free : devm_kzalloc(), devm_kzfree()
* IO region : devm_request_region(), devm_release_region()
* IRQ : devm_request_irq(), devm_free_irq()
* DMA : dmam_alloc_coherent(), dmam_free_coherent(),
dmam_declare_coherent_memory(), dmam_pool_create(),
dmam_pool_destroy()
* PCI : pcim_enable_device(), pcim_pin_device(), pci_is_managed()
* iomap : devm_ioport_map(), devm_ioport_unmap(), devm_ioremap(),
devm_ioremap_nocache(), devm_iounmap(), pcim_iomap_table(),
pcim_iomap(), pcim_iounmap()
Signed-off-by: Tejun Heo <htejun@gmail.com>
Signed-off-by: Jeff Garzik <jeff@garzik.org>
2007-01-20 07:00:26 +00:00
|
|
|
spinlock_t devres_lock;
|
|
|
|
|
struct list_head devres_head;
|
|
|
|
|
|
2008-08-25 17:50:19 +00:00
|
|
|
struct klist_node knode_class;
|
2006-10-07 19:54:55 +00:00
|
|
|
struct class *class;
|
2009-06-24 17:06:31 +00:00
|
|
|
const struct attribute_group **groups; /* optional groups */
|
2006-06-14 19:14:34 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
void (*release)(struct device *dev);
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
|
2008-03-19 21:39:13 +00:00
|
|
|
/* Get the wakeup routines, which depend on struct device */
|
|
|
|
|
#include <linux/pm_wakeup.h>
|
|
|
|
|
|
2008-07-30 19:29:21 +00:00
|
|
|
static inline const char *dev_name(const struct device *dev)
|
2008-05-02 04:02:41 +00:00
|
|
|
{
|
2009-01-25 14:17:37 +00:00
|
|
|
return kobject_name(&dev->kobj);
|
2008-05-02 04:02:41 +00:00
|
|
|
}
|
|
|
|
|
|
2008-05-30 00:16:40 +00:00
|
|
|
extern int dev_set_name(struct device *dev, const char *name, ...)
|
|
|
|
|
__attribute__((format(printf, 2, 3)));
|
|
|
|
|
|
2006-12-07 04:32:33 +00:00
|
|
|
#ifdef CONFIG_NUMA
|
|
|
|
|
static inline int dev_to_node(struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return dev->numa_node;
|
|
|
|
|
}
|
|
|
|
|
static inline void set_dev_node(struct device *dev, int node)
|
|
|
|
|
{
|
|
|
|
|
dev->numa_node = node;
|
|
|
|
|
}
|
|
|
|
|
#else
|
|
|
|
|
static inline int dev_to_node(struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return -1;
|
|
|
|
|
}
|
|
|
|
|
static inline void set_dev_node(struct device *dev, int node)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
2009-03-01 13:10:49 +00:00
|
|
|
static inline unsigned int dev_get_uevent_suppress(const struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return dev->kobj.uevent_suppress;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void dev_set_uevent_suppress(struct device *dev, int val)
|
|
|
|
|
{
|
|
|
|
|
dev->kobj.uevent_suppress = val;
|
|
|
|
|
}
|
|
|
|
|
|
2005-09-22 07:47:24 +00:00
|
|
|
static inline int device_is_registered(struct device *dev)
|
|
|
|
|
{
|
2008-03-13 21:07:03 +00:00
|
|
|
return dev->kobj.state_in_sysfs;
|
2005-09-22 07:47:24 +00:00
|
|
|
}
|
|
|
|
|
|
2006-12-19 21:01:28 +00:00
|
|
|
void driver_init(void);
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/*
|
|
|
|
|
* High level routines for use by the bus drivers
|
|
|
|
|
*/
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int __must_check device_register(struct device *dev);
|
|
|
|
|
extern void device_unregister(struct device *dev);
|
|
|
|
|
extern void device_initialize(struct device *dev);
|
|
|
|
|
extern int __must_check device_add(struct device *dev);
|
|
|
|
|
extern void device_del(struct device *dev);
|
|
|
|
|
extern int device_for_each_child(struct device *dev, void *data,
|
|
|
|
|
int (*fn)(struct device *dev, void *data));
|
|
|
|
|
extern struct device *device_find_child(struct device *dev, void *data,
|
|
|
|
|
int (*match)(struct device *dev, void *data));
|
2006-07-03 21:31:12 +00:00
|
|
|
extern int device_rename(struct device *dev, char *new_name);
|
2009-03-04 11:44:00 +00:00
|
|
|
extern int device_move(struct device *dev, struct device *new_parent,
|
|
|
|
|
enum dpm_order dpm_order);
|
2009-09-18 21:01:12 +00:00
|
|
|
extern const char *device_get_devnode(struct device *dev,
|
|
|
|
|
mode_t *mode, const char **tmp);
|
2009-05-11 21:16:57 +00:00
|
|
|
extern void *dev_get_drvdata(const struct device *dev);
|
|
|
|
|
extern void dev_set_drvdata(struct device *dev, void *data);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-12-15 12:58:26 +00:00
|
|
|
/*
|
|
|
|
|
* Root device objects for grouping under /sys/devices
|
|
|
|
|
*/
|
|
|
|
|
extern struct device *__root_device_register(const char *name,
|
|
|
|
|
struct module *owner);
|
|
|
|
|
static inline struct device *root_device_register(const char *name)
|
|
|
|
|
{
|
|
|
|
|
return __root_device_register(name, THIS_MODULE);
|
|
|
|
|
}
|
|
|
|
|
extern void root_device_unregister(struct device *root);
|
|
|
|
|
|
2009-07-17 14:06:08 +00:00
|
|
|
static inline void *dev_get_platdata(const struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return dev->platform_data;
|
|
|
|
|
}
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/*
|
|
|
|
|
* Manual binding of a device to driver. See drivers/base/bus.c
|
|
|
|
|
* for information on use.
|
|
|
|
|
*/
|
2006-08-15 05:43:20 +00:00
|
|
|
extern int __must_check device_bind_driver(struct device *dev);
|
2008-01-25 05:04:46 +00:00
|
|
|
extern void device_release_driver(struct device *dev);
|
|
|
|
|
extern int __must_check device_attach(struct device *dev);
|
2006-08-15 05:43:20 +00:00
|
|
|
extern int __must_check driver_attach(struct device_driver *drv);
|
|
|
|
|
extern int __must_check device_reprobe(struct device *dev);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2006-06-14 19:14:34 +00:00
|
|
|
/*
|
|
|
|
|
* Easy functions for dynamically creating devices on the fly
|
|
|
|
|
*/
|
2008-05-15 20:44:08 +00:00
|
|
|
extern struct device *device_create_vargs(struct class *cls,
|
|
|
|
|
struct device *parent,
|
|
|
|
|
dev_t devt,
|
|
|
|
|
void *drvdata,
|
|
|
|
|
const char *fmt,
|
|
|
|
|
va_list vargs);
|
2008-07-22 03:03:34 +00:00
|
|
|
extern struct device *device_create(struct class *cls, struct device *parent,
|
|
|
|
|
dev_t devt, void *drvdata,
|
|
|
|
|
const char *fmt, ...)
|
2008-05-15 20:44:08 +00:00
|
|
|
__attribute__((format(printf, 5, 6)));
|
2006-06-14 19:14:34 +00:00
|
|
|
extern void device_destroy(struct class *cls, dev_t devt);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Platform "fixup" functions - allow the platform to have their say
|
|
|
|
|
* about devices and actions that the general device layer doesn't
|
|
|
|
|
* know about.
|
|
|
|
|
*/
|
|
|
|
|
/* Notify platform of device discovery */
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int (*platform_notify)(struct device *dev);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2008-01-25 05:04:46 +00:00
|
|
|
extern int (*platform_notify_remove)(struct device *dev);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* get_device - atomically increment the reference count for the device.
|
|
|
|
|
*
|
|
|
|
|
*/
|
2008-01-25 05:04:46 +00:00
|
|
|
extern struct device *get_device(struct device *dev);
|
|
|
|
|
extern void put_device(struct device *dev);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2009-04-21 20:32:54 +00:00
|
|
|
extern void wait_for_device_probe(void);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
Driver Core: devtmpfs - kernel-maintained tmpfs-based /dev
Devtmpfs lets the kernel create a tmpfs instance called devtmpfs
very early at kernel initialization, before any driver-core device
is registered. Every device with a major/minor will provide a
device node in devtmpfs.
Devtmpfs can be changed and altered by userspace at any time,
and in any way needed - just like today's udev-mounted tmpfs.
Unmodified udev versions will run just fine on top of it, and will
recognize an already existing kernel-created device node and use it.
The default node permissions are root:root 0600. Proper permissions
and user/group ownership, meaningful symlinks, all other policy still
needs to be applied by userspace.
If a node is created by devtmps, devtmpfs will remove the device node
when the device goes away. If the device node was created by
userspace, or the devtmpfs created node was replaced by userspace, it
will no longer be removed by devtmpfs.
If it is requested to auto-mount it, it makes init=/bin/sh work
without any further userspace support. /dev will be fully populated
and dynamic, and always reflect the current device state of the kernel.
With the commonly used dynamic device numbers, it solves the problem
where static devices nodes may point to the wrong devices.
It is intended to make the initial bootup logic simpler and more robust,
by de-coupling the creation of the inital environment, to reliably run
userspace processes, from a complex userspace bootstrap logic to provide
a working /dev.
Signed-off-by: Kay Sievers <kay.sievers@vrfy.org>
Signed-off-by: Jan Blunck <jblunck@suse.de>
Tested-By: Harald Hoyer <harald@redhat.com>
Tested-By: Scott James Remnant <scott@ubuntu.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2009-04-30 13:23:42 +00:00
|
|
|
#ifdef CONFIG_DEVTMPFS
|
|
|
|
|
extern int devtmpfs_create_node(struct device *dev);
|
|
|
|
|
extern int devtmpfs_delete_node(struct device *dev);
|
2009-10-28 18:51:17 +00:00
|
|
|
extern int devtmpfs_mount(const char *mntdir);
|
Driver Core: devtmpfs - kernel-maintained tmpfs-based /dev
Devtmpfs lets the kernel create a tmpfs instance called devtmpfs
very early at kernel initialization, before any driver-core device
is registered. Every device with a major/minor will provide a
device node in devtmpfs.
Devtmpfs can be changed and altered by userspace at any time,
and in any way needed - just like today's udev-mounted tmpfs.
Unmodified udev versions will run just fine on top of it, and will
recognize an already existing kernel-created device node and use it.
The default node permissions are root:root 0600. Proper permissions
and user/group ownership, meaningful symlinks, all other policy still
needs to be applied by userspace.
If a node is created by devtmps, devtmpfs will remove the device node
when the device goes away. If the device node was created by
userspace, or the devtmpfs created node was replaced by userspace, it
will no longer be removed by devtmpfs.
If it is requested to auto-mount it, it makes init=/bin/sh work
without any further userspace support. /dev will be fully populated
and dynamic, and always reflect the current device state of the kernel.
With the commonly used dynamic device numbers, it solves the problem
where static devices nodes may point to the wrong devices.
It is intended to make the initial bootup logic simpler and more robust,
by de-coupling the creation of the inital environment, to reliably run
userspace processes, from a complex userspace bootstrap logic to provide
a working /dev.
Signed-off-by: Kay Sievers <kay.sievers@vrfy.org>
Signed-off-by: Jan Blunck <jblunck@suse.de>
Tested-By: Harald Hoyer <harald@redhat.com>
Tested-By: Scott James Remnant <scott@ubuntu.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2009-04-30 13:23:42 +00:00
|
|
|
#else
|
|
|
|
|
static inline int devtmpfs_create_node(struct device *dev) { return 0; }
|
|
|
|
|
static inline int devtmpfs_delete_node(struct device *dev) { return 0; }
|
|
|
|
|
static inline int devtmpfs_mount(const char *mountpoint) { return 0; }
|
|
|
|
|
#endif
|
|
|
|
|
|
2006-03-21 23:58:53 +00:00
|
|
|
/* drivers/base/power/shutdown.c */
|
2005-04-16 22:20:36 +00:00
|
|
|
extern void device_shutdown(void);
|
|
|
|
|
|
2007-07-26 14:29:55 +00:00
|
|
|
/* drivers/base/sys.c */
|
|
|
|
|
extern void sysdev_shutdown(void);
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/* debugging and troubleshooting/diagnostic helpers. */
|
2008-07-30 19:29:21 +00:00
|
|
|
extern const char *dev_driver_string(const struct device *dev);
|
2005-04-16 22:20:36 +00:00
|
|
|
#define dev_printk(level, dev, format, arg...) \
|
2008-01-25 05:04:46 +00:00
|
|
|
printk(level "%s %s: " format , dev_driver_string(dev) , \
|
2008-05-02 04:02:41 +00:00
|
|
|
dev_name(dev) , ## arg)
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2007-10-30 19:37:14 +00:00
|
|
|
#define dev_emerg(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_EMERG , dev , format , ## arg)
|
|
|
|
|
#define dev_alert(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_ALERT , dev , format , ## arg)
|
|
|
|
|
#define dev_crit(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_CRIT , dev , format , ## arg)
|
|
|
|
|
#define dev_err(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_ERR , dev , format , ## arg)
|
|
|
|
|
#define dev_warn(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_WARNING , dev , format , ## arg)
|
|
|
|
|
#define dev_notice(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_NOTICE , dev , format , ## arg)
|
|
|
|
|
#define dev_info(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_INFO , dev , format , ## arg)
|
|
|
|
|
|
2008-12-04 15:55:47 +00:00
|
|
|
#if defined(DEBUG)
|
|
|
|
|
#define dev_dbg(dev, format, arg...) \
|
|
|
|
|
dev_printk(KERN_DEBUG , dev , format , ## arg)
|
2009-02-05 16:51:38 +00:00
|
|
|
#elif defined(CONFIG_DYNAMIC_DEBUG)
|
driver core: basic infrastructure for per-module dynamic debug messages
Base infrastructure to enable per-module debug messages.
I've introduced CONFIG_DYNAMIC_PRINTK_DEBUG, which when enabled centralizes
control of debugging statements on a per-module basis in one /proc file,
currently, <debugfs>/dynamic_printk/modules. When, CONFIG_DYNAMIC_PRINTK_DEBUG,
is not set, debugging statements can still be enabled as before, often by
defining 'DEBUG' for the proper compilation unit. Thus, this patch set has no
affect when CONFIG_DYNAMIC_PRINTK_DEBUG is not set.
The infrastructure currently ties into all pr_debug() and dev_dbg() calls. That
is, if CONFIG_DYNAMIC_PRINTK_DEBUG is set, all pr_debug() and dev_dbg() calls
can be dynamically enabled/disabled on a per-module basis.
Future plans include extending this functionality to subsystems, that define
their own debug levels and flags.
Usage:
Dynamic debugging is controlled by the debugfs file,
<debugfs>/dynamic_printk/modules. This file contains a list of the modules that
can be enabled. The format of the file is as follows:
<module_name> <enabled=0/1>
.
.
.
<module_name> : Name of the module in which the debug call resides
<enabled=0/1> : whether the messages are enabled or not
For example:
snd_hda_intel enabled=0
fixup enabled=1
driver enabled=0
Enable a module:
$echo "set enabled=1 <module_name>" > dynamic_printk/modules
Disable a module:
$echo "set enabled=0 <module_name>" > dynamic_printk/modules
Enable all modules:
$echo "set enabled=1 all" > dynamic_printk/modules
Disable all modules:
$echo "set enabled=0 all" > dynamic_printk/modules
Finally, passing "dynamic_printk" at the command line enables
debugging for all modules. This mode can be turned off via the above
disable command.
[gkh: minor cleanups and tweaks to make the build work quietly]
Signed-off-by: Jason Baron <jbaron@redhat.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-08-12 20:46:19 +00:00
|
|
|
#define dev_dbg(dev, format, ...) do { \
|
|
|
|
|
dynamic_dev_dbg(dev, format, ##__VA_ARGS__); \
|
|
|
|
|
} while (0)
|
2005-04-16 22:20:36 +00:00
|
|
|
#else
|
driver core: Convert debug functions declared inline __attribute__((format (printf,x,y) to statement expression macros
When DEBUG is not defined, pr_debug and dev_dbg and some
other local debugging functions are specified as:
"inline __attribute__((format (printf, x, y)))"
This is done to validate printk arguments when not debugging.
Converting these functions to macros or statement expressions
"do { if (0) printk(fmt, ##arg); } while (0)"
or
"({ if (0) printk(fmt, ##arg); 0; })
makes at least gcc 4.2.2 produce smaller objects.
This has the additional benefit of allowing the optimizer to
avoid calling functions like print_mac that might have been
arguments to the printk.
defconfig x86 current:
$ size vmlinux
text data bss dec hex filename
4716770 474560 618496 5809826 58a6a2 vmlinux
all converted: (More patches follow)
$ size vmlinux
text data bss dec hex filename
4716642 474560 618496 5809698 58a622 vmlinux
Even kernel/sched.o, which doesn't even use these
functions, becomes smaller.
It appears that merely having an indirect include
of <linux/device.h> can cause bigger objects.
$ size sched.inline.o sched.if0.o
text data bss dec hex filename
31385 2854 328 34567 8707 sched.inline.o
31366 2854 328 34548 86f4 sched.if0.o
The current preprocessed only kernel/sched.i file contains:
# 612 "include/linux/device.h"
static inline __attribute__((always_inline)) int __attribute__ ((format (printf, 2, 3)))
dev_dbg(struct device *dev, const char *fmt, ...)
{
return 0;
}
# 628 "include/linux/device.h"
static inline __attribute__((always_inline)) int __attribute__ ((format (printf, 2, 3)))
dev_vdbg(struct device *dev, const char *fmt, ...)
{
return 0;
}
Removing these unused inlines from sched.i shrinks sched.o
Signed-off-by: Joe Perches <joe@perches.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-02-27 03:08:42 +00:00
|
|
|
#define dev_dbg(dev, format, arg...) \
|
|
|
|
|
({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
|
2005-04-16 22:20:36 +00:00
|
|
|
#endif
|
|
|
|
|
|
2007-07-13 05:08:22 +00:00
|
|
|
#ifdef VERBOSE_DEBUG
|
|
|
|
|
#define dev_vdbg dev_dbg
|
|
|
|
|
#else
|
driver core: Convert debug functions declared inline __attribute__((format (printf,x,y) to statement expression macros
When DEBUG is not defined, pr_debug and dev_dbg and some
other local debugging functions are specified as:
"inline __attribute__((format (printf, x, y)))"
This is done to validate printk arguments when not debugging.
Converting these functions to macros or statement expressions
"do { if (0) printk(fmt, ##arg); } while (0)"
or
"({ if (0) printk(fmt, ##arg); 0; })
makes at least gcc 4.2.2 produce smaller objects.
This has the additional benefit of allowing the optimizer to
avoid calling functions like print_mac that might have been
arguments to the printk.
defconfig x86 current:
$ size vmlinux
text data bss dec hex filename
4716770 474560 618496 5809826 58a6a2 vmlinux
all converted: (More patches follow)
$ size vmlinux
text data bss dec hex filename
4716642 474560 618496 5809698 58a622 vmlinux
Even kernel/sched.o, which doesn't even use these
functions, becomes smaller.
It appears that merely having an indirect include
of <linux/device.h> can cause bigger objects.
$ size sched.inline.o sched.if0.o
text data bss dec hex filename
31385 2854 328 34567 8707 sched.inline.o
31366 2854 328 34548 86f4 sched.if0.o
The current preprocessed only kernel/sched.i file contains:
# 612 "include/linux/device.h"
static inline __attribute__((always_inline)) int __attribute__ ((format (printf, 2, 3)))
dev_dbg(struct device *dev, const char *fmt, ...)
{
return 0;
}
# 628 "include/linux/device.h"
static inline __attribute__((always_inline)) int __attribute__ ((format (printf, 2, 3)))
dev_vdbg(struct device *dev, const char *fmt, ...)
{
return 0;
}
Removing these unused inlines from sched.i shrinks sched.o
Signed-off-by: Joe Perches <joe@perches.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-02-27 03:08:42 +00:00
|
|
|
|
|
|
|
|
#define dev_vdbg(dev, format, arg...) \
|
|
|
|
|
({ if (0) dev_printk(KERN_DEBUG, dev, format, ##arg); 0; })
|
2007-07-13 05:08:22 +00:00
|
|
|
#endif
|
|
|
|
|
|
2008-09-21 02:08:39 +00:00
|
|
|
/*
|
|
|
|
|
* dev_WARN() acts like dev_printk(), but with the key difference
|
|
|
|
|
* of using a WARN/WARN_ON to get the message out, including the
|
|
|
|
|
* file/line information and a backtrace.
|
|
|
|
|
*/
|
|
|
|
|
#define dev_WARN(dev, format, arg...) \
|
|
|
|
|
WARN(1, "Device: %s\n" format, dev_driver_string(dev), ## arg);
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/* Create alias, so I can be autoloaded. */
|
|
|
|
|
#define MODULE_ALIAS_CHARDEV(major,minor) \
|
|
|
|
|
MODULE_ALIAS("char-major-" __stringify(major) "-" __stringify(minor))
|
|
|
|
|
#define MODULE_ALIAS_CHARDEV_MAJOR(major) \
|
|
|
|
|
MODULE_ALIAS("char-major-" __stringify(major) "-*")
|
|
|
|
|
#endif /* _DEVICE_H_ */
|