xref: /OK3568_Linux_fs/kernel/Documentation/usb/iuu_phoenix.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun=============================
2*4882a593SmuzhiyunInfinity Usb Unlimited Readme
3*4882a593Smuzhiyun=============================
4*4882a593Smuzhiyun
5*4882a593SmuzhiyunHi all,
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunThis module provide a serial interface to use your
9*4882a593SmuzhiyunIUU unit in phoenix mode. Loading this module will
10*4882a593Smuzhiyunbring a ttyUSB[0-x] interface. This driver must be
11*4882a593Smuzhiyunused by your favorite application to pilot the IUU
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunThis driver is still in beta stage, so bugs can
14*4882a593Smuzhiyunoccur and your system may freeze. As far I now,
15*4882a593SmuzhiyunI never had any problem with it, but I'm not a real
16*4882a593Smuzhiyunguru, so don't blame me if your system is unstable
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunYou can plug more than one IUU. Every unit will
19*4882a593Smuzhiyunhave his own device file(/dev/ttyUSB0,/dev/ttyUSB1,...)
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunHow to tune the reader speed?
24*4882a593Smuzhiyun=============================
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun A few parameters can be used at load time
27*4882a593Smuzhiyun To use parameters, just unload the module if it is
28*4882a593Smuzhiyun already loaded and use modprobe iuu_phoenix param=value.
29*4882a593Smuzhiyun In case of prebuilt module, use the command
30*4882a593Smuzhiyun insmod iuu_phoenix param=value.
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun Example::
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun	modprobe iuu_phoenix clockmode=3
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun The parameters are:
37*4882a593Smuzhiyun
38*4882a593Smuzhiyunclockmode:
39*4882a593Smuzhiyun	1=3Mhz579,2=3Mhz680,3=6Mhz (int)
40*4882a593Smuzhiyunboost:
41*4882a593Smuzhiyun	overclock boost percent 100 to 500 (int)
42*4882a593Smuzhiyuncdmode:
43*4882a593Smuzhiyun	Card detect mode
44*4882a593Smuzhiyun	0=none, 1=CD, 2=!CD, 3=DSR, 4=!DSR, 5=CTS, 6=!CTS, 7=RING, 8=!RING (int)
45*4882a593Smuzhiyunxmas:
46*4882a593Smuzhiyun	xmas color enabled or not (bool)
47*4882a593Smuzhiyundebug:
48*4882a593Smuzhiyun	Debug enabled or not (bool)
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun-  clockmode will provide 3 different base settings commonly adopted by
51*4882a593Smuzhiyun   different software:
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun	1. 3Mhz579
54*4882a593Smuzhiyun	2. 3Mhz680
55*4882a593Smuzhiyun	3. 6Mhz
56*4882a593Smuzhiyun
57*4882a593Smuzhiyun-  boost provide a way to overclock the reader ( my favorite :-)  )
58*4882a593Smuzhiyun   For example to have best performance than a simple clockmode=3, try this::
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun      modprobe boost=195
61*4882a593Smuzhiyun
62*4882a593Smuzhiyun   This will put the reader in a base of 3Mhz579 but boosted a 195 % !
63*4882a593Smuzhiyun   the real clock will be now : 6979050 Hz ( 6Mhz979 ) and will increase
64*4882a593Smuzhiyun   the speed to a score 10 to 20% better than the simple clockmode=3 !!!
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun
67*4882a593Smuzhiyun-  cdmode permit to setup the signal used to inform the userland ( ioctl answer )
68*4882a593Smuzhiyun   if the card is present or not. Eight signals are possible.
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun-  xmas is completely useless except for your eyes. This is one of my friend who was
71*4882a593Smuzhiyun   so sad to have a nice device like the iuu without seeing all color range available.
72*4882a593Smuzhiyun   So I have added this option to permit him to see a lot of color ( each activity change the color
73*4882a593Smuzhiyun   and the frequency randomly )
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun-  debug will produce a lot of debugging messages...
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun
78*4882a593SmuzhiyunLast notes
79*4882a593Smuzhiyun==========
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun Don't worry about the serial settings, the serial emulation
82*4882a593Smuzhiyun is an abstraction, so use any speed or parity setting will
83*4882a593Smuzhiyun work. ( This will not change anything ).Later I will perhaps
84*4882a593Smuzhiyun use this settings to deduce de boost but is that feature
85*4882a593Smuzhiyun really necessary ?
86*4882a593Smuzhiyun The autodetect feature used is the serial CD. If that doesn't
87*4882a593Smuzhiyun work for your software, disable detection mechanism in it.
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun Have fun !
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun Alain Degreffe
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun eczema(at)ecze.com
95