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