At least pretend to split more ICH2 bits out into a config.mk. A real build system...

[netwatch.git] / GUIDE

diff --git a/GUIDE b/GUIDE
index 07db389d3f8fbc4cc07ac554f93ac541b3b8ffcb..6e6e6d050a656d119fcd181bc93325bd251f418c 100644 (file)
--- a/GUIDE
+++ b/GUIDE
@@ -1,65 +1,61 @@
 File overview:
 
 File overview:
 

-elfload/
-       Obsolete Linux-based ELF loader. This used to allow loading NetWatch
-from within an already-running kernel; it could be updated to work with the
-current memory layout, but is nonfunctional at the moment. See grubload/ for
-the preferred loader.
-

 grubload/
 grubload/

-       This is a multiboot-compliant simple ELF loader, for use with NetWatch
-aseg.elf images or similar. It loads its input file (passed via multiboot),
-invokes the startup routines, and then returns to real mode and starts the
-bootloader again.
+  A multiboot-compliant simple ELF loader, for use with NetWatch aseg.elf
+  images or similar.  It loads its input file (passed via multiboot),
+  invokes the startup routines, and then returns to real mode and starts the
+  bootloader again.

 
 ich2/
 
 ich2/

-       Intel ICH2 northbridge drivers. A similar API should be implemeted to
-port NetWatch to other chipsets.
+  Intel ICH2 northbridge/southbridge drivers. A similar API should be
+  implemented to port NetWatch to other chipsets.

 
 ich7/
 
 ich7/

-       Intel ICH7 northbridge drivers. Incomplete / untested.
+  Intel ICH7 northbridge drivers. Incomplete.

 
 include/
 
 include/

-       General header files.
+  General header files.

 
 lib/
 
 lib/

-       Library functions.
+  Library functions.

 
 lwip/
 
 lwip/

-       LWIP. (http://www.sics.se/~adam/lwip/)
+  LWIP. (http://www.sics.se/~adam/lwip/)

 
 net/
 
 net/

-       Network card (currently only 3c90x) drivers, glue code, and the RFB
-and HTTP applications. Other network drivers should go here.
+  Network card (currently only 3c90x) drivers, glue code, and the RFB and
+  HTTP applications.  Other network drivers and applications should go here.

 
 netwatch/
 
 netwatch/

-       Main startup and initialization code, logging, SMI response, VGA text
-overlay, and other general top-level sources. To build the main NetWatch binary,
-run "make" here to produce aseg.elf.
+  Main startup and initialization code, logging, SMI response, VGA text
+  overlay, and other general top-level sources.  To build the main NetWatch
+  binary, run "make" here to produce aseg.elf.

  
 pci/
  
 pci/

-       PCI bus interface and BAR-clobbering routines.
+  PCI bus interface and BAR-clobbering routines.

 
 tools/
 
 tools/

-       Assorted useful Linux command line tools we've found useful, such as
-for SMRAM segment manipulation, raw I/O port pokes, etc. These are not required
-to use NetWatch.
+  Assorted useful Linux command line tools we've found useful, such as for
+  SMRAM segment manipulation, raw I/O port pokes, etc.  These are not
+  required to use NetWatch.

 
 video/
 
 video/

-       Framebuffer drivers for VGA text and TNT2 graphics consoles. Supporting
-graphics on other chipsets will require making a driver like that in tnt2.c.
+  Framebuffer drivers for VGA text and TNT2 graphics consoles. Supporting
+  graphics on other chipsets will require writing a driver similar to that
+  in tnt2.c.

 
 ---
 
 Porting NetWatch to other systems will likely require:
 
 ---
 
 Porting NetWatch to other systems will likely require:

-- A network driver, if you don't have a 3c905 (net/3c90x.c)
-- A video driver, if you are interested in graphics rather than VGA text,
-  and don't have an NVidia TNT2. (video/tnt2.c)
-- North- and southbridge drivers for your chipset. (ich2/)
+  - A network driver, if you don't have a 3c905 (net/3c90x.c)
+  - A video driver, if you are interested in graphics rather than VGA text,
+    and don't have an NVidia TNT2. (video/tnt2.c)
+  - North- and southbridge drivers for your chipset. (ich2/)

 
 We have found that Intel generally provides easily-accessible chipset
 datasheets on their website; searching for a particular ICH series part on
 
 We have found that Intel generally provides easily-accessible chipset
 datasheets on their website; searching for a particular ICH series part on

-Google will likely lead to the correct datasheet without too much trouble.
-Other chipset manufacturers are likely to be significantly less cooperative.
+Google will likely lead to the correct datasheet without too much trouble. 
+Other chipset manufacturers have been found to be significantly less
+cooperative.