xref: /haiku/src/add-ons/kernel/bus_managers/firewire/00README.haiku (revision 99d027cd0238c1d86da86d7c3f4200509ccc61a6)
1src/add-ons/kernel/bus_managers/firewire/00README, v 0.1 2007/08/31 09:10:08 JiSheng Zhang
2
3IEEE 1394 support for haiku
4
51. Introduction
6
7	  These directories contains IEEE1394(FireWire) driver which is my
8	GSOC2007 project work under my mentor Jerome Duval's guidance.
9	Please note this driver is still under development. You can find latest
10	version from Haiku's repository:
11
12	The driver consists of 13 parts:
13
14	DIRECTORY: src/add-ons/kernel/bus_managers/firewire/
15	- fwohci.c/fwohci_pci.c
16		OHCI driver
17			- IEEE1394 link/phy chip control
18	- firewire.c
19		Chip independent driver
20			- CSR
21			- Transaction
22			- Bus management
23	- fwdma.c
24		allocate memory and other convenient functions for DMA.
25
26	- fwmem.c
27		physical memory of a remote node.
28
29	- firewire_module.c
30		implementation of firewire module interfaces
31
32	- util.c
33		memory allocation. Copied from haiku's rtl8169 driver
34
35	- timer.c
36		timer implemetation. Copied from haiku's rtl8169 driver
37
38	- fwcrom.c(This file is in src/bin/fwcontrol directory)
39		handle with config rom
40
41	DIRECTORY: src/add-ons/kernel/drivers/bus/firewire/
42
43	- fw_raw.c
44		Character devices for userland
45
46	DIRECTORY: src/bin/fwcontrol/
47
48	- fwcontrol.c (userland)
49		Bus management function for user.
50		show topology map, change gap count, bus reset, etc.
51
52	- eui64.c
53		handle with EUI64 ID
54
55	- fwdv.c
56		dv format support
57
58	- fwmpegts.c
59		mpegts format support
60
612. Installation
62
63	- svn up to update the source
64	- jam -q firewire.
65	- jam -q fw_raw
66	- jam -q fwcontrol
67	- jam -q dpc(This file is in src/add-ons/kernel/generic/dpc)
68	- cp the firewire to haiku's /system/add-ons/kernel/bus_managers
69	- cp the dpc to haiku's /system/add-ons/kernel/generic
70	- cp the fw_raw to haiku's drivers/bin and make a softlink in drivers/dev
71
723. DV
73	I have tested my minidv: MV920. It works OK.
74
754. SBP
76	This support is still under development
77
785. Tested HW
79
80	OS
81	- HAIKU/i386
82
83	* Not tested on SMP.
84	* Not tested on big-endian machine...
85
86	OHCI
87	- Texas Instruments TSB12LV26 (PCI)
88
89	* There might be phy probing problem but most of the OHCI
90	  chips should work.
91
92	Physical layer chip
93	- This does not matter, most physical layer chip should work
94
956. Example
96	fwcontrol
97	Output a list of devices that are connected to the bus
98
99	fwcontrol -t
100	Show the topology map
101
102	fwcontrol -c 0
103	Show the config rom of node 0
104
105	fwcontrol -r
106	trigger bus reset
107
108	fwcontrol -R mini.dv
109	Receive DV or MPEG TS stream and save it in mini.dv. Press Ctrl-C to
110	stop receiving data.
111	Note: the program will try to guess which mode first
112
113	fwcontrol -M d -R mini.dv
114	Explicitly specify receiving via DV mode.
115
116References:
117[1] IEEE 1394-1995
118[2] IEEE 1394a-2000
119[3] IEEE 1212-2001
120[4] IEC 61883
121[5] http://developer.intel.com/technology/1394/download/ohci_11.htm
122[6] FreeBSD's current
123
124
125JiSheng Zhang
126jszhang3@gmail.com
127