]> Joshua Wise's Git repositories - netwatch.git/blob - GUIDE
Make some documentation a bit more accurate.
[netwatch.git] / GUIDE
1 File overview:
2
3 elfload/
4         Obsolete Linux-based ELF loader. This used to allow loading NetWatch
5 from within an already-running kernel; it could be updated to work with the
6 current memory layout, but is nonfunctional at the moment. See grubload/ for
7 the preferred loader.
8
9 grubload/
10         This is a multiboot-compliant simple ELF loader, for use with NetWatch
11 aseg.elf images or similar. It loads its input file (passed via multiboot),
12 invokes the startup routines, and then returns to real mode and starts the
13 bootloader again.
14
15 ich2/
16         Intel ICH2 northbridge drivers. A similar API should be implemeted to
17 port NetWatch to other chipsets.
18
19 ich7/
20         Intel ICH7 northbridge drivers. Incomplete / untested.
21
22 include/
23         General header files.
24
25 lib/
26         Library functions.
27
28 lwip/
29         LWIP. (http://www.sics.se/~adam/lwip/)
30
31 net/
32         Network card (currently only 3c90x) drivers, glue code, and the RFB
33 and HTTP applications. Other network drivers should go here.
34
35 netwatch/
36         Main startup and initialization code, logging, SMI response, VGA text
37 overlay, and other general top-level sources. To build the main NetWatch binary,
38 run "make" here to produce aseg.elf.
39  
40 pci/
41         PCI bus interface and BAR-clobbering routines.
42
43 tools/
44         Assorted useful Linux command line tools we've found useful, such as
45 for SMRAM segment manipulation, raw I/O port pokes, etc. These are not required
46 to use NetWatch.
47
48 video/
49         Framebuffer drivers for VGA text and TNT2 graphics consoles. Supporting
50 graphics on other chipsets will require making a driver like that in tnt2.c.
51
52 ---
53
54 Porting NetWatch to other systems will likely require:
55 - A network driver, if you don't have a 3c905 (net/3c90x.c)
56 - A video driver, if you are interested in graphics rather than VGA text,
57   and don't have an NVidia TNT2. (video/tnt2.c)
58 - North- and southbridge drivers for your chipset. (ich2/)
59
60 We have found that Intel generally provides easily-accessible chipset
61 datasheets on their website; searching for a particular ICH series part on
62 Google will likely lead to the correct datasheet without too much trouble. 
63 Other chipset manufacturers have been found to be significantly less
64 cooperative.
65
66
This page took 0.030513 seconds and 4 git commands to generate.