Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

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

Documentation/isa.txt

+27 −26
Original line number Diff line number Diff line 
===========

ISA Drivers

-----------

===========



The following text is adapted from the commit message of the initial

commit of the ISA bus driver authored by Rene Herman.
@@ -23,7 +24,7 @@ that all device creation has been made internal as well. 


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

now (for oldisa-only drivers) become:

now (for oldisa-only drivers) become::



	static int __init alsa_card_foo_init(void)

	{
@@ -47,11 +48,11 @@ parameter, indicating how many devices to create and call our methods 
with.



The platform_driver callbacks are called with a platform_device param;

the isa_driver callbacks are being called with a "struct device *dev,

unsigned int id" pair directly -- with the device creation completely

the isa_driver callbacks are being called with a ``struct device *dev,

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

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.



With this additional .match() callback ISA drivers have all options. If
@@ -75,7 +76,7 @@ This exports only two functions; isa_{,un}register_driver(). 


isa_register_driver() register's the struct device_driver, and then

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)

	{
@@ -102,7 +103,7 @@ well. 
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.



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.



If during all this, there's any error, or no devices matched at all