Documentation/usb/iuu_phoenix.rst

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