
				RTL8196c-11n Customization Kit - v1.2
				---------------------------------------------------

1.	Introduction
	
	This package includes tools, allow you to modify the configuration data
and web pages for RTL8196c-11n turnkey solution.

	The customized data (configuration data or web pages) could be uploaded
to RTL8196c EV (evaluation) board through web server directly. Besides, it also
provides a tool to integrate the all images (e.g., boot code, configuration 
data, web pages and Linux system image) into one image file as the raw data 
used to burn into flash memory in production.

	The kit provides the configuration data in the form of text file. You 
could edit the text file, and then uses a converting tool to convert it into 
binary. 

	The source code of RTL8196c-11n turnkey web pages is included. You could 
modify the web pages, and then uses the provided tool to compress the web
pages into a binary file.

	Both MS-Windows and Linux platform are supported. Note, only MS-Windows 
2K/XP, and Linux RH 7.3/9.0 are been tested. Please note, if you use the tools
under Linux platform, you should run in ROOT privilege.


2.	Directory tree

	- README.txt : Current read file

	- Change.log : Change log of CMK package

	- goahead-license.txt : GoAhead web server license agreement	
		
	- "RTL8196c_Firmware_Release_Note_v1.2.doc" : Firmware release note

	- "System Note.doc" : Note described flash layout and application 
	  components

	- "Realtek_WPS_user_guide_V1.3.doc" : Document about how to use WPS 
		
	- "WLAN Application_Note_RTL8196C.doc" - Document about wlan system architecture
	  and configuration parameters in detail
	  
	- config-gw-96c.txt : configuration text file for gateway
	
	- config-ap-96c.txt : configuration text file for ap
	
	- image\boot.16m : binary file of boot code used for 8196c under 16M (16bit) DDRAM
	
	- image\boot.8m : binary file of boot code used for 8196c under 8M (16bit) DDRAM
	
	- image\linux-gw.bin : Linux kernel image for gateway
		
	- image\root-gw.bin : Linux root fs image for gateway
	
	- image\linux-ap.bin : Linux kernel image for AP
			
	- image\root-ap.bin : Linux root fs image for AP
	
	- image\linux-8m.bin : Linux kernel image for gateway 8m
			
	- image\root-8m.bin : Linux root fs image for gateway 8m
		
	- image\linux-pocket.bin : Linux kernel image for gateway pocket
			
	- image\root-pocket.bin : Linux root fs image for gateway pocket
			
	- MP\document\RTL8196C MP Test Program Guide.doc: user guide of mp utility
	
	- MP\image\nfjrom-mp.bin: MP image for gateway
	
	-MP\utility\RTL8196C_V1.0NormalRelease.zip: mp utility
	
	- tools\LINUX: it contains tools used under Linux. The tools is 
	  compressed in a tar file. You should uncompress it before using.

	- tools\WIN - it contains tools used under MS-Windows. These tools 
	  should run in DOS command prompt.

	- web-gw: it includes web pages source adopted in gateway version image
	
	- web-ap: it includes web pages source adopted in AP version image
    
    
4.	Install
	
	- MS-Windows: copy the all directories and files into disk.

	- Linux: copy the all directories and files into disk. Go to tools\LNUX, 
	  and type: tar xfvz tools.tar.gz


5.	Modify and update configuration data
	
	- Edit the configuration file as you want

	- If you ONLY want to update the configuration data to a running RTL8196c-11n
	  system:
	  
	  MS-WINDOWS - open a DOS prompt, change directory tools\WIN. Then,
		 type 'cvcfg-xx ..\..\config\config-xx-96c.txt config-xx.dat' 

	  LINUX - open a shell, change directory tools/LINUX. Then,
		 type './cvcfg-xx ../../config/config-xx-96c.txt config-xx.dat' 
		 	
	  After that, the output file '*.dat' could be updated to system through 
	  target web server (in save/restore setting page).

	NOTE: If you want to update configuration setting without modifying hardware 
		parameters, you may edit config file to mark or remove the ALL 
		parameters with "HW_" prefix. Then, using converting tool (cvcfg-xx)
		to convert config file from text to binary.		
		

6.	Modify web pages

	- Edit the web page source as you want. If you have new added or delete 
	  page, you should update web page list file (web-files-xx) in tool\WIN 
	  or tool\LINUX.

	- If you ONLY want to update the web pages to a running RTL8196c-11n system:
	  
	  MS-WINDOWS - open a DOS prompt, change directory to 'tools\WIN'. Then,
		 type 'compweb web-files-xx webpages-xx.bin'
	
	  LINUX - open a shell, change directory to 'tools/LINUX'. Then,
		 type './compweb web-files-xx webpages-xx.bin'

	  After that, the output file 'webpages-xx.bin' could be updated to 
	  system through target web server (in upgrade firmware page).

	NOTE1: You are better to read GoAhead web server document before update, 
		except you are familiar with HTML programming. RTL8196c web server 
		use the ASP mechanism (term by GoAhead document) to display dynamic 
		data. In source of web page, you may see the keyword '<% %>', which 
		denotes the action will be taken by web server. You may not change 
		the content between '<%' '%>'. All the static data is safe to modify 
		(e.g., logo, title....).

	NOTE2: Please refer 'goahead-license.txt' for GoAhead web sever license 
		agreement if you want to deliver it.


7.	Make whole flash image

	- Edit configuration file and web pages as you want. Then,

	  MS-WINDOWS - open a DOS prompt, change directory tools\WIN. Then,
		type 'mkimg [gw | gw-no]'
		
	  LINUX - open a shell, change directory tools/LINUX. Then,
		type './mkimg [gw | gw-no]'
		
	  After that, the output file 'rtl8196c-xx.bin' could be burned to 
	  flash memory from begin to end.

	NOTE: If your image is generated with "xx-no" argument, the output file
		  'rtl8196c-xx.bin' should be burned to flash memory from offset 
		  8000 (hex).


8.  Update new Linux image

	You could update the new Linux image (linux-xx.bin) to RTL8196c-11n EV 
board through web server (in upgrade firmware page). Please note, 
if the new updated Linux image has new added configuration parameters or new 
setting layout, the new updated firmware will reset the all setting to its 
default (hard-coded) when bootup. In this case, after update, you may see the 
setting is changed.

	In addition to update through web server, you may update the image (
including the binary of boot code, web pages, linux or whole image) via boot
loader through Ethernet TFTP. You need connect Ethernet between target LAN 
port and PC host. Besides, You also need connect target and PC COM port with a 
NULL modem cable, which setting is 38400 8N1. When target is powered on, 
press 'ESC' key to force loader to break the booting for Linux image. Then, 
run a TFTP client in PC host and connect server IP with 192.168.1.6 (e.g., 
in Windows DOS prompt, run "tftp -i 192.168.1.6 put linux-xxx.bin"). 

	If you update the image for boot loader (boot.xx) and Linux image 
(linux-xxx.bin), loader will automatically write image into flash memory and
reboot the target after TFTP upload is completed (root.bin will not reboot).
If you update the whole image (rtl8196c-xxx.bin), loader will not update flash 
automatically. Instead, you have to enter command in COM port terminal 
manually by type:  "flw offset down_addr image_len".
The 'offset' could be '0' or '8000' for the image included with or without boot loader. 
Default 'down_addr' is '80500000'.
You may see the correct download address and image 
length in COM port terminal after TFTP upload is done. After image is written 
into flash, you need power off/on the target to make new updated firmware take 
effect.
	
NOTE1: If you want to burn the binary image into flash memory by a flash writer
	, you may need to do bye-swap in the output image before update. The 
	tool (mgbin) has provided an option for this purpose. You may edit
	WINDOWS batch file (mkimg-xx.bat) in 'tools\WIN' directory or Linux 
	script file (mkimg-xx) in 'tools\LINUX' directoty, and modify as:
	"mgbin -s -o file...". Then. the output file could be used by flash 
	writer.

NOTE2: Except update individual image through web server, you may merge images 
	(including config setting, web pages and Linux) together and update it to
	server at one time. You may issue the command as:
		"mgbin -c -o ouput_file file1 file2 ..."
	'fileN' is binary files to be merged. It may be config setting, web-page 
	image and Linux image. 'output_file' is output merged image, used to 
	upload to web server. If 'fileN' is a config file, it should be a binary 
	file generated as described in step 5.
	Please note, boot code can't be updated through web server.	


04-26-2010
