1
2		BCM47xx/BCM535x Linux Software and Tools Readme
3			
4
5
6This file documents the directory structure and contents of the Software
7and Tools for the BCM47xx/BCM535x family. It also tells how to install
8the tools. The development environment is assumed to be PC's running
9Linux, RedHat8, RedHat9 and Fedora3 to be more precise. It is possible that
10the tools will run on other Linux distributions, but as of now we have only
11tested on RedHat8, RedHat9 and Fedora3.
12
13Depending on the release type received, you may or may not have source code
14to all components.
15
161. Installing the tools.
17
18   To install the BCM47xx/535x software tools, the "3.2.3 47xx_535x MIPS
19   Cross Compiler and Tools" package is required, and must be obtained
20   separately from the Broadcom Customer Support Portal.
21
22   Once you have installed the tools, you should be able to compile C
23   programs and build the source distribution. You can test that by
24   going to the src directory and typing "make".
25
26
272. Contents of the distribution.
28
29   src/linux/linux
30
31	This directory contains a full copy of our Linux kernel sources.
32
33	The bulk of the kernel is based on linux-2.4.20 as modified for
34	MIPS CPU's and maintained at linux-mips.org. We are currently using
35	a snapshot from the oss tree as of 2003-02-03.
36
37	There are two areas where we have updated beyond that oss
38	snapshot:
39	    o HNBU has added the necessary low level interface support
40	      for MTD support (in drivers/mtd) in files prefixed with
41	      "bcm947xx".
42	    o PCMCIA card services 3.1.29 from sourceforge.net
43	    o Intersil 802.11b drivers 2.4.14 from kernel.org
44
45
46	The BCM47xx/BCM535x specific code can be found mainly under the
47	directory arch/mips/brcm-boards/bcm947xx. The network drivers are
48	in separate directories described below.
49
50   src/et
51
52	Sources for the 10/100 Ethernet driver.
53
54   src/cfe
55
56	Source for the boot loader "cfe". This code has been developed by 
57	Broadcom. It is a replacement for "pmon". It is more compact, 
58	contains greater functionality and is more efficient than "pmon".
59
60   src/router
61
62	User level code for HNBU's reference WAN Agnostic Residential
63	Gateway. It includes code written by HNBU plus the following:
64	    o busybox-0.60.0 from opensource.lineo.com
65	    o ppp-2.4.1-pppoe2 from www.shoshin.uwaterloo.ca/~mostrous
66	      with significant modifications by HNBU
67	    o udhcp-0.9.5 from opensource.lineo.com
68
69   src/rts
70
71	Sources for utilities.
72
73   src/ses
74
75	Sources/objects for the SES.
76
77   src/shared
78   src/include
79
80	Common code and include files used by all of the above.
81
82   src/usbdev
83
84	Sources/objects for the WLAN USB driver.
85
86   src/wl
87
88	Sources/objects for the WLAN driver.
89
90   image
91
92	Contains a binary image for the combined kernel and root file system
93	processed with gzip and trx that can be burned directly into
94	flash on a BCM947xx/BCM9534x board. Also contains binary images for
95	pmon, rnd cfe with additional text files for the supported boards.
96	Either cfe or pmon can be used in with the approriate text file to
97	create an image that can be burned into flash on any of the supported
98	BCM947xx/BCM9534x board.
99
100   tools/visionICE
101
102	Files needed to use WindRiver visionICE with the BCM4710.
103