"Documentation" update.

2 files changed, 52 insertions, 36 deletions

diff --git a/sys/dev/ieee1394/IMPLEMENTATION b/sys/dev/ieee1394/IMPLEMENTATION
index f814065c52c..0344ed2e6a8 100644
--- a/sys/dev/ieee1394/IMPLEMENTATION
+++ b/sys/dev/ieee1394/IMPLEMENTATION
@@ -1,7 +1,7 @@
-$OpenBSD: IMPLEMENTATION,v 1.1 2002/06/25 17:11:49 itojun Exp $
+$OpenBSD: IMPLEMENTATION,v 1.2 2002/12/13 02:54:18 tdeval Exp $
 $NetBSD: IMPLEMENTATION,v 1.6 2002/02/03 07:29:14 jmc Exp $
 
-At time point in time, there are 3 controller drivers planned:
+At this point in time, there are 3 controller drivers planned:
 
 	fwochi		IEEE 1394 OHCI Controller (PCI & CardBus)
 	fwlynx		TI TSB12LV21 (found B&W G3s)
@@ -22,9 +22,9 @@ fwohci*	at pci? dev ? function ?
 # specific device by specifing its nodeid as its identifier (XXX this
 # is a 64 bit quantity and locators used by config must be 32 bit integers).
 #
-fwnode0 at fwbus? idhi 0x003065ff idlo 0xfedc46c0       
-fwnode1 at fwbus? idhi 0x0060e202 idlo 0x0000157e       
-fwnode2 at fwbus? idhi 0x00110600 idlo 0x00003169          
+fwnode0 at fwbus? idhi 0x003065ff idlo 0xfedc46c0
+fwnode1 at fwbus? idhi 0x0060e202 idlo 0x0000157e
+fwnode2 at fwbus? idhi 0x00110600 idlo 0x00003169
 fwnode* at fwbus? idhi ? idlo ?
 #
 # An ip capable interface can be added to the local bus as a service to offer
@@ -39,16 +39,16 @@ fw* at fwbus?
 # look at values in their children nodes. (updating nodeid's, etc)
 #
 # One of the services that a node might offer is access to SCSI devices via
-# SBP-2.  As decsribed above, this mean a scsibus is a child of fwnode at some
-# point. (Making it a direct child is bad since that drags in the whole scsi
-# code base even if all a person wants is an fwnode and camera support)
+# SBP-2.  As described above, this means a scsibus is a child of fwnode at
+# some point. (Making it a direct child is bad since that drags in the whole
+# scsi code base even if all a person wants is an fwnode and camera support)
 #
 fwscsi* at fwnode?
 scsibus* at fwscsi?
 
-Note that with advent of highly mobile storage devices, the need for 
-signatures or other mechanisms to identity disks indepentend of their
-localtion in the device hierarchy is sorely needed.
+Note that with the advent of highly mobile storage devices, the need for
+signatures or other mechanisms to identify disks independently of their
+location in the device hierarchy is sorely needed.
 
 fwohci0 at pci1 dev 12 function 0: NEC uPD72870 IEEE 1394 OHCI Host Controller (rev. 0x01)
 fwohci0: interrupting at isa irq 15
diff --git a/sys/dev/ieee1394/TODO b/sys/dev/ieee1394/TODO
index 2d70aff26c7..39cca9f5482 100644
--- a/sys/dev/ieee1394/TODO
+++ b/sys/dev/ieee1394/TODO
@@ -1,41 +1,57 @@
-Rewrite handler_set to allow sub regions, minimums, etc without having to
-register 100 callbacks for 100 quad reads.
+TODO :
+------
 
-Use handler set (with NULL cb) to create a higher level <bus>_unreg
+- Rewrite handler_set to allow sub regions, minimums, etc without having to
+  register 100 callbacks for 100 quad reads.
 
-Move all mbuf code to if_fw.c. Make if_fw use the generic read/write/inreg and
-then it can translate the packets into the appropriate mbuf's.
+- Use handler_set (with NULL cb) to create a higher level <bus>_unreg.
 
-Need a tlabel alloc routine within fwohci and a way to use 64 tlabel's per
-node (rather than a global set of 64 as it's used now).
+- Move all mbuf code to if_fw.c. Make if_fw use the generic read/write/inreg
+  and then it can translate the packets into the appropriate mbuf's.
 
-Flesh out the documentation of the high level API in fwohci.c (fwlynx will need
-to implement the same thing so this should be more than just comments in 
-fwohci.c)
+- Need a tlabel alloc routine within fwohci and a way to use 64 tlabel's per
+  node (rather than a global set of 64 as it's used now).
 
-Move SBP2 routines into their own file.
+- Flesh out the documentation of the high level API in fwohci.c (fwlynx will
+  need to implement the same thing so this should be more than just comments
+  in fwohci.c).
 
-done - Rewrite ROM parsing/validation. Unroll all recursion, add ref counting, 
-       path elimination, etc. 
+- Track down issues where multiple hosts plugged into a firewire hub don't
+  init/see all devices on resets sometimes.
 
-done - Move rom routines into their own files to allow easier cross usage.
+- Should do topology maps, speed maps, the various bus managers, etc.
 
-done - Write sub match setup for fwnode/fwscsi so matching devices listed in 
-       the ROM can be done via autoconf.
+- Implement a real fwscsi scsibus, with each attached device as a new
+  target/lun. Not a new scsibus per device.
 
-done - Remove all of the devcap stuff.
+- Implement proper handlers with either 1 main thread, or timeouts and
+  callbacks.
 
-SBP2 needs a complete API written up: logins, ORB management/allocation, etc.
+==============================================================================
 
-done - Add locator detection/usage into fwohci code.
+DONE :
+------
 
-Should do topology maps, speed maps, the various bus managers, etc.
+- Move SBP2 routines into their own file.
 
-done - change all FW_DEBUG wrapped printf's to DPRINTF macro's
+- Rewrite ROM parsing/validation. Unroll all recursion, add ref counting, path
+  elimination, etc.
 
-done - ack errors from a TX complete should get passed up to any registered callbacks
+- Move rom routines into their own files to allow easier cross usage.
 
-Track down issues where multiple hosts plugged into a firewire hub don't 
-init/see all devices on resets sometimes.
+- Write sub match setup for fwnode/fwscsi so matching devices listed in the
+  ROM can be done via autoconf.
 
-done - Make fwohci detach correctly (for cardbus/etc type interfaces)
+- Remove all of the devcap stuff.
+
+- SBP2 needs a complete API written up: logins, ORB management/allocation, etc. 
+  (basic routines have been implemented).
+
+- Add locator detection/usage into fwohci code.
+
+- Change all FW_DEBUG wrapped printf's to DPRINTF macro's.
+
+- Ack errors from a TX complete should get passed up to any registered
+  callbacks.
+
+- Make fwohci detach correctly (for cardbus/etc type interfaces).