define __KERNEL_STRICT_NAMES to avoid inclusion of kernel types on systems that carry...
[cake.git] / rom / isapnp / README
blob7f2c7954233bc24991f4c1a6b19560626197a6a2
1 Short:    A Plug And Play ISA software layer for AmigaOS.
2 Uploader: Martin Blom <martin@blom.org>
3 Author:   Martin Blom <martin@blom.org>
4 Type:     hard/drivr
5 Requires: 68020+, GG2 Bus+ ISA bridge card, some PnP ISA cards
6 Version:  1.2
8                                   ISA-PnP
9                                   *******
11               A Plug And Play ISA software layer for AmigaOS.
12              Copyright (C) 2001 Martin Blom <martin@blom.org>
15 Overview
16 ¯¯¯¯¯¯¯¯
17 This is an implementation of (parts of) the Plug and Play ISA Specification
18 version 1.0a for AmigaOS.  The bridge card GG2 Bus+ is supported.
20 For a list of bugs and missing features, see BUGS.
22 The code LGPL (see COPYING.LIB), which means that there are no restrictions
23 on code that uses the provided API (see below), but any modifications to or
24 derivates of ISA-PnP itself must stay LGPL.
26 Installation
27 ¯¯¯¯¯¯¯¯¯¯¯¯
28 Just drop the binary and the icon in the SYS:Expansion drawer and run
29 C:BindDrivers (or reboot).
31 Usage
32 ¯¯¯¯¯
33 The following tool types are available, in addition to the required PRODUCT
34 tooltype (that BindDrivers uses)
36 * DISABLE_CARD=<card id>
37   DISABLE_CARD=<card id>/<serial number>
39   Disables a card completely.  No resources will be assigned this card
40   during the resource allocation phase.
42 * DISABLE_DEVICE=<device id>
43   DISABLE_DEVICE=<card id>:<logical device number>
44   DISABLE_DEVICE=<card id>/<serial number>:<logical device number>
46   Disables a logical device.  No resources will be assigned this device
47   during the resource allocation phase.
49 * LEGACY_DEVICE=<device id> [ IO=<address>/<length> [ IO=...] ... ]
50                 [ DMA=<channel> [DMA=...] ... ] [ IRQ=<int> [IRQ=...] ... ]
52   Adds a non-PnP device to the resource database. All non-PnP devices must
53   be registered in order to avoid resource allocation conflicts.
55 The ISA-PnP binary itself can also be run from the command line.  It uses
56 the following template:
58 SHOWCONFIG/S,SHOWOPTIONS/S,REMOVE/S
60 SHOWCONFIG will display information about all cards found, and what
61 resources they have allocated.
63 If the SHOWOPTIONS switch is given as well, information about what
64 resources each device requires.  Can be useful when conflicts occur and you
65 need to manualy find out what logical device to disable.
67 REMOVE should only be used for debug purposes.  It is very dangerous!  The
68 isapnp.resource (see below) will be removed from the system.  Any drivers
69 or applications currently using it will crash instantly!
72 The API
73 ¯¯¯¯¯¯¯
74 ISA-PnP installs a Exec resource named "isapnp.resource", that provides a
75 few functions that can be used by drivers and applications to find PnP ISA
76 cards and logical devices, gain exclusive access to them and a set of
77 helper functions to access registers and memory on the ISA bus.
79 The API is not final, not finished and probably not working either.
81 $Id: README,v 1.4 2001/05/08 23:44:05 lcs Exp $