Commit 0685552f authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

isa.txt: standardize document format

Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- Use the main title standard for this document;
- replace _foo_ by **foo** for emphasis;
- mark literal blocks as such.
Acked-by: default avatarWilliam Breathitt Gray <vilhelm.gray@gmail.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 66b338ea
===========
ISA Drivers ISA Drivers
----------- ===========
The following text is adapted from the commit message of the initial The following text is adapted from the commit message of the initial
commit of the ISA bus driver authored by Rene Herman. commit of the ISA bus driver authored by Rene Herman.
...@@ -23,17 +24,17 @@ that all device creation has been made internal as well. ...@@ -23,17 +24,17 @@ that all device creation has been made internal as well.
The usage model this provides is nice, and has been acked from the ALSA The usage model this provides is nice, and has been acked from the ALSA
side by Takashi Iwai and Jaroslav Kysela. The ALSA driver module_init's side by Takashi Iwai and Jaroslav Kysela. The ALSA driver module_init's
now (for oldisa-only drivers) become: now (for oldisa-only drivers) become::
static int __init alsa_card_foo_init(void) static int __init alsa_card_foo_init(void)
{ {
return isa_register_driver(&snd_foo_isa_driver, SNDRV_CARDS); return isa_register_driver(&snd_foo_isa_driver, SNDRV_CARDS);
} }
static void __exit alsa_card_foo_exit(void) static void __exit alsa_card_foo_exit(void)
{ {
isa_unregister_driver(&snd_foo_isa_driver); isa_unregister_driver(&snd_foo_isa_driver);
} }
Quite like the other bus models therefore. This removes a lot of Quite like the other bus models therefore. This removes a lot of
duplicated init code from the ALSA ISA drivers. duplicated init code from the ALSA ISA drivers.
...@@ -47,11 +48,11 @@ parameter, indicating how many devices to create and call our methods ...@@ -47,11 +48,11 @@ parameter, indicating how many devices to create and call our methods
with. with.
The platform_driver callbacks are called with a platform_device param; The platform_driver callbacks are called with a platform_device param;
the isa_driver callbacks are being called with a "struct device *dev, the isa_driver callbacks are being called with a ``struct device *dev,
unsigned int id" pair directly -- with the device creation completely unsigned int id`` pair directly -- with the device creation completely
internal to the bus it's much cleaner to not leak isa_dev's by passing internal to the bus it's much cleaner to not leak isa_dev's by passing
them in at all. The id is the only thing we ever want other then the them in at all. The id is the only thing we ever want other then the
struct device * anyways, and it makes for nicer code in the callbacks as struct device anyways, and it makes for nicer code in the callbacks as
well. well.
With this additional .match() callback ISA drivers have all options. If With this additional .match() callback ISA drivers have all options. If
...@@ -75,10 +76,10 @@ This exports only two functions; isa_{,un}register_driver(). ...@@ -75,10 +76,10 @@ This exports only two functions; isa_{,un}register_driver().
isa_register_driver() register's the struct device_driver, and then isa_register_driver() register's the struct device_driver, and then
loops over the passed in ndev creating devices and registering them. loops over the passed in ndev creating devices and registering them.
This causes the bus match method to be called for them, which is: This causes the bus match method to be called for them, which is::
int isa_bus_match(struct device *dev, struct device_driver *driver) int isa_bus_match(struct device *dev, struct device_driver *driver)
{ {
struct isa_driver *isa_driver = to_isa_driver(driver); struct isa_driver *isa_driver = to_isa_driver(driver);
if (dev->platform_data == isa_driver) { if (dev->platform_data == isa_driver) {
...@@ -88,7 +89,7 @@ int isa_bus_match(struct device *dev, struct device_driver *driver) ...@@ -88,7 +89,7 @@ int isa_bus_match(struct device *dev, struct device_driver *driver)
dev->platform_data = NULL; dev->platform_data = NULL;
} }
return 0; return 0;
} }
The first thing this does is check if this device is in fact one of this The first thing this does is check if this device is in fact one of this
driver's devices by seeing if the device's platform_data pointer is set driver's devices by seeing if the device's platform_data pointer is set
...@@ -102,7 +103,7 @@ well. ...@@ -102,7 +103,7 @@ well.
Then, if the the driver did not provide a .match, it matches. If it did, Then, if the the driver did not provide a .match, it matches. If it did,
the driver match() method is called to determine a match. the driver match() method is called to determine a match.
If it did _not_ match, dev->platform_data is reset to indicate this to If it did **not** match, dev->platform_data is reset to indicate this to
isa_register_driver which can then unregister the device again. isa_register_driver which can then unregister the device again.
If during all this, there's any error, or no devices matched at all If during all this, there's any error, or no devices matched at all
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment