From 0735851ca7ecc69349d9d6ca3e47b34393b1d9ad Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Duval?= <korli@users.berlios.de>
Date: Fri, 31 Aug 2007 18:21:34 +0000
Subject: [PATCH] readme for firewire from JiSheng

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22131 a95241bf-73f2-0310-859d-f6bbb57e9c96
---
 .../bus_managers/firewire/00README.haiku      | 105 ++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 src/add-ons/kernel/bus_managers/firewire/00README.haiku

diff --git a/src/add-ons/kernel/bus_managers/firewire/00README.haiku b/src/add-ons/kernel/bus_managers/firewire/00README.haiku
new file mode 100644
index 0000000000..f06e01b44e
--- /dev/null
+++ b/src/add-ons/kernel/bus_managers/firewire/00README.haiku
@@ -0,0 +1,105 @@
+src/add-ons/kernel/bus_managers/firewire/00README, v 0.1 2007/08/31 09:10:08 JiSheng Zhang
+
+IEEE 1394 support for haiku
+
+1. Introduction
+
+	  These directories contains IEEE1394(FireWire) driver which is my 
+	GSOC2007 project work under my mentor Jerome Duval's guidance.
+	Please note this driver is still under development. You can find latest 
+	version from Haiku's repository:
+
+	The driver consists of 13 parts:
+	
+	DIRECTORY: src/add-ons/kernel/bus_managers/firewire/
+	- fwohci.c/fwohci_pci.c
+		OHCI driver
+			- IEEE1394 link/phy chip control
+	- firewire.c
+		Chip independent driver 
+			- CSR
+			- Transaction
+			- Bus management
+	- fwdma.c
+		allocate memory and other convenient functions for DMA.
+
+	- fwmem.c
+		physical memory of a remote node.
+
+	- firewire_module.c
+		implementation of firewire module interfaces
+
+	- util.c
+		memory allocation. Copied from haiku's rtl8169 driver
+	
+	- timer.c
+		timer implemetation. Copied from haiku's rtl8169 driver
+	
+	- fwcrom.c(This file is in src/bin/fwcontrol directory)
+		handle with config rom
+	
+	DIRECTORY: src/add-ons/kernel/drivers/bus/firewire/
+	
+	- fw_raw.c
+		Character devices for userland
+	
+	DIRECTORY: src/bin/fwcontrol/
+
+	- fwcontrol.c (userland)
+		Bus management function for user. 
+		show topology map, change gap count, bus reset, etc.
+	
+	- eui64.c
+		handle with EUI64 ID
+	
+	- fwdv.c
+		dv format support
+	
+	- fwmpegts.c
+		mpegts format support
+
+2. Installation
+
+	- svn up to update the source
+	- jam -q firewire.
+	- jam -q fw_raw
+	- jam -q fwcontrol
+	- jam -q dpc(This file is in src/add-ons/kernel/generic/dpc)
+	- cp the firewire to haiku's /system/add-ons/kernel/bus_managers
+	- cp the dpc to haiku's /system/add-ons/kernel/generic
+	- cp the fw_raw to haiku's drivers/bin and make a softlink in drivers/dev
+
+3. DV
+	I have tested my minidv: MV920. It works OK.
+
+4. SBP
+	This support is still under development
+
+5. Tested HW
+
+	OS
+	- HAIKU/i386
+
+	* Not tested on SMP.
+	* Not tested on big-endian machine...
+
+	OHCI
+	- Texas Instruments TSB12LV26 (PCI)
+
+	* There might be phy probing problem but most of the OHCI
+	  chips should work.
+
+	Physical layer chip
+	- This does not matter, most physical layer chip should work
+
+References:
+[1] IEEE 1394-1995
+[2] IEEE 1394a-2000
+[3] IEEE 1212-2001
+[4] IEC 61883
+[5] http://developer.intel.com/technology/1394/download/ohci_11.htm
+[6] FreeBSD's current
+
+
+JiSheng Zhang
+jszhang3@gmail.com