Difference between revisions of "How to make use of IrDA"

From ThinkWiki
Jump to: navigation, search
m (LIRC and IrDA: english)
 
(83 intermediate revisions by 20 users not shown)
Line 9: Line 9:
 
== Serial IR (SIR) ==
 
== Serial IR (SIR) ==
 
SIR is limited to serial datarates up to 115.2Kb/s
 
SIR is limited to serial datarates up to 115.2Kb/s
 +
 +
On modern distributions all configuration might be taken care of automatically by starting the irda service {{cmdroot|service irda start}}. If not try the following;
 +
 +
To use it, run {{cmdroot|irattach /dev/ttyS1 -s; modprobe ircomm-tty}} 
 +
 +
Then turn on your IrDA-capable device and put it within range, and point your software (e.g., <tt>minicom</tt>) to {{path|/dev/irda0}}.
  
 
===Kernel configuration===
 
===Kernel configuration===
==== Linux 2.4 kernel config ====
 
Edit {{path|/etc/modules.conf}} and add the following lines
 
  alias tty-ldisc-11 irtty
 
  alias char-major-161 ircomm-tty
 
  
==== Linux 2.6 kernel config ====
 
 
Edit {{path|/etc/modprobe.conf}} and add the following lines
 
Edit {{path|/etc/modprobe.conf}} and add the following lines
  alias tty-ldisc-11 irtty-sir
+
alias tty-ldisc-11 irtty-sir
  alias char-major-161 ircomm-tty
+
alias char-major-161 ircomm-tty
  
 
== Fast IR (FIR) ==
 
== Fast IR (FIR) ==
FIR is the preferred mode of IrDA operation and operates at a bandwidth of 4 Mbps
+
FIR is the preferred mode of IrDA operation and operates at a maximum bandwidth of 4 Mbps
 
 
=== BIOS settings ===
 
Main problem here is that the chips FIR mode needs to be activated. On most ThinkPads, the easiest way to activate FIR mode is by entering BIOS setup during boot-up by pressing {{key|F1}} when prompted.
 
Then, selecting 'Config' followed by 'Infrared' will allow you to control the IrDA operation. Here you will need to select the option to Enable the infra-red port, and ensure the proper resources are set (typically: IO 0x2f8 and IRQ 3). Be sure to save the changes, and then Exit.
 
 
 
{{NOTE|Changing these BIOS settings does not affect Windows 2000 or XP operating systems, but may cause resource issues in older windows versions, or other legacy operating systems.}}
 
 
 
=== PnP settings from Linux ===
 
If changing the BIOS setting is not an option or if the settings cannot be altered, as on some older ThinkPads, the FIR mode can be activated from Linux with one of the following (this needs to be done on every boot):
 
* setpnp as part of the old pcmcia-utils source package
 
* tpctl, but only for some old ThinkPads
 
setpnp requires a kernel with pnp-bios support compiled in, which the {{Redhat}} and {{Fedora}} kernels lack.
 
 
 
=== ISA PnP patch ===
 
2.6 kernel ISA PnP Patches exist for the nsc-ircc driver, that allow the loading of the driver without the BIOS, setpnp or tpctl hacks.<br />
 
You will still have to call setserial and set the dongle_id parameter, as shown below.
 
* [http://steffenpingel.de/patches/nsc-ircc-pnp.diff 2.6.10 patch]
 
* [http://shamrock.dyndns.org/~ln/linux/nsc-ircc-pnp.2.6.12-rc6.diff 2.6.12-rc6 patch]
 
* [http://shamrock.dyndns.org/~ln/linux/nsc-ircc-pnp.2.6.12.diff 2.6.12 patch (applies cleanly to 2.6.12 through 2.6.15)]
 
  
This patch seems '''necessary''I in some cases (e.g., ThinkPad {{T43}} and kernel 2.6.14.2).
+
On modern distributions this should all be automatically handled by simply starting the idra service {{cmdroot|service irda start}}. If not try the following;
  
 
===Kernel configuration===
 
===Kernel configuration===
==== Linux 2.4 kernel config ====
+
Edit {{path|/etc/modprobe.conf}} and add the following lines
Edit {{path|/etc/modules.conf}} and add the following lines
 
  
      alias irda0 nsc-ircc
+
alias irda0 nsc-ircc
      options nsc-ircc dongle_id=0x09 io=0x2f8 irq=3
 
      pre-install nsc-ircc setserial /dev/ttyS1 uart none port 0 irq 0
 
  
==== Linux 2.6 kernel config ====
+
Make sure that setserial is in right directory (e.g not in /usr/bin/setserial).After that if irdadump still gives nothing try:
Edit {{path|/etc/modprobe.conf}} and add the following lines
+
echo 1 > /proc/sys/net/irda/discovery
 
 
      alias irda0 nsc-ircc
 
      options nsc-ircc dongle_id=0x09 io=0x2f8 irq=3
 
      install nsc-ircc /bin/setserial /dev/ttyS1 uart none port 0 irq 0; /sbin/modprobe --ignore-install nsc-ircc
 
  
 
== Known problems ==
 
== Known problems ==
* If the FIR mode is not activated, attempts to load the <tt>nsc-ircc</tt> module will result in an error in syslog of "Wrong chip version ff".
+
* If you read something like "ttyS1: LSR safety check engaged!" and "irattach: tcgetattr: Input/output error" in the system log, try limiting the FIR max baud rate (echo 57600 > /proc/sys/net/irda/max_baud_rate). This did the trick for me when I was trying to synchronize my Ericsson T39m with my Thinkpad R51 (multisync, evolution-2.8, KDE 3.5.5, openSUSE 10.2).
* After suspend the <tt>nsc-ircc</tt> module needs to be manually reloaded
+
* If you get an error in syslog like "nsc_ircc_open(), can't get iobase of 0x2f8" it probably means you have manually specified resources for IrDA in the BIOS. When you do that you effectively allow the serial driver to take control, and as a result the nsc_ircc driver can no longer take control of the resources. Options are to either restore the BIOS settings for IrDA to factory default, or you can work around it by using setserial to clear the resources before loading the nsc_ircc kernel module
* If module reloading does not work after a suspend, try reactivating the IrDA port as well:
+
setserial /dev/ttyS1 uart none port 0 irq 0; modprobe nsc_ircc
rmmod nsc_ircc
 
echo disable > /sys/devices/pnp0/00\:0d/resources
 
echo activate > /sys/devices/pnp0/00\:0d/resources
 
modprobe nsc_ircc
 
:The value <tt>pnp0/00\:0d</tt> can vary - look for a resources file containing the appropriate irq/dma/io values, e.g., using {{cmdroot|grep 0x2f8 /sys/devices/pnp*/*/resources}} .
 
  
 
== Some other things you might want to do with IrDA ==
 
== Some other things you might want to do with IrDA ==
Line 75: Line 45:
 
* if needed, limit further the size of the transmit window
 
* if needed, limit further the size of the transmit window
 
:{{cmdroot|echo 1 > /proc/sys/net/irda/max_tx_window}}
 
:{{cmdroot|echo 1 > /proc/sys/net/irda/max_tx_window}}
 +
* set the connection speed to 4Mbit in FIR mode:
 +
:{{cmdroot|echo 4000000 > /proc/sys/net/irda/max_baud_rate}}
  
 
==LIRC and IrDA==
 
==LIRC and IrDA==
Usually, IrDA port's are not compatible with LIRC, but you may have luck using lirc_sir.
+
LIRC allows the use of infrared remote controls with Linux as input devices. This can be especially useful to control applications like mplayer, xine, mythtv or boxee. Usually, IrDA ports are not compatible with LIRC, but you may have luck using lirc_sir, as follows;
 +
{{NOTE|lirc_sir is incompatible with the regular Linux IrDA drivers (nsc_ircc). You can only use one at a time, and will have to reboot before you can switch}}
 +
{{NOTE|Even if you are successful in getting this to work, you might find that the distance between remote control and receiver on the ThinkPad cannot exceed ~50cm, rendering it effectively useless. This can vary depending on Remote and ThinkPad used, there has been one successful report of a T60 with >2M}}
 +
 
 +
====Success reports====
 +
* R40
 +
* T41
 +
* T60
 +
* 600
 +
* Z61m (the distance between remote control and receiver highly depends on the remote control used. With an Acer STRC-100 I get only 80 cm compared to 180 cm with a Sony RM-SRG440)
 +
 
 +
====Failure reports====
 +
lirc_sir does not always work, particular on newer machines it seems the module loads when following these instructions, but the device {{path|/dev/lirc0}} cannot be opened and returns a device or resource busy. You can simply test this by typing {{cmdroot|cat /dev/lirc0}}
 +
* T60
 +
 
 +
===Configuring lirc_sir===
 +
Go into your BIOS setup, and ensure that Infrared is fully enabled and that resources are assigned. I suggest using IO 2f8 and IRQ 3.
 +
 
 +
Boot into Linux, and first ensure the setserial program is installed. Running {{cmdroot|/bin/setserial /dev/ttyS1}} should return at this point:
 +
/dev/ttyS1, UART: undefined, Port: 0x02f8, IRQ: 3
 +
If setserial cannot be found, install the setserial package with your distributions package management software
 +
 
 +
Then create a file {{path|/etc/modprobe.d/lirc.conf}} with the following content:
 +
# prevent nsc_ircc from loading (blacklist might not be enough)
 +
blacklist nsc_ircc
 +
install nsc_ircc /bin/true
 +
# pass options to lirc_sir to load it on ttyS1
 +
options lirc_sir io=0x2f8 irq=3
 +
# ensure serial resources are cleared before loading lirc_sir
 +
# not doing so can result in a device busy error, or can even hang your system
 +
install lirc_sir /bin/setserial /dev/ttyS1 uart none port 0 irq 0; /sbin/modprobe --ignore-install lirc_sir
 +
 
 +
At this point it is best to reboot, to ensure that nsc_ircc was never loaded. Several things can go wrong if the steps are not followed accurately. You might get an error when loading lirc_sir that the device is busy, or your system may even hang.
  
If loading the <tt>lirc_sir</tt> module shows something like the following in {{cmdroot|dmesg}} output, you are lucky and can use LIRC with the IrDA port to remote control your ThinkPad.
+
Now do a {{cmdroot|modprobe lirc_sir}} and check {{cmdroot|dmesg}} output. You should see something like this:
 +
lirc_dev: IR Remote Control driver registered, major 61
 +
lirc_dev: lirc_register_plugin: sample_rate: 0
 
  lirc_sir: I/O port 0x02f8, IRQ 3.
 
  lirc_sir: I/O port 0x02f8, IRQ 3.
 
  lirc_sir: Installed.
 
  lirc_sir: Installed.
 +
 +
===Configuring LIRC===
 +
If you did not yet install LIRC, then do so now using your distributions package management system.
 +
 +
====Ubuntu====
 +
{{NOTE|Successfully tested under Ubuntu 10.04}}
 +
 +
Make sure your {{path|/etc/lirc/hardware.conf}} looks like this:
 +
REMOTE="SIR IrDA (built-in IR ports)"
 +
REMOTE_MODULES="lirc_dev lirc_sir"
 +
REMOTE_DRIVER=""
 +
REMOTE_DEVICE="/dev/lirc0"
 +
REMOTE_LIRCD_CONF=""
 +
REMOTE_LIRCD_ARGS=""
 +
TRANSMITTER="None"
 +
TRANSMITTER_MODULES=""
 +
TRANSMITTER_DRIVER=""
 +
TRANSMITTER_DEVICE=""
 +
TRANSMITTER_LIRCD_CONF=""
 +
TRANSMITTER_LIRCD_ARGS=""
 +
START_LIRCD="true"
 +
START_LIRCMD=""
 +
LOAD_MODULES=""
 +
LIRCMD_CONF=""
 +
FORCE_NONINTERACTIVE_RECONFIGURATION="false"
 +
 +
After this, start (or re-start) the lirc daemon, and set it to automatically start on bootup.
 +
 +
{{cmdroot|sudo service lirc restart}}<br>
 +
{{cmdroot|sudo update-rc.d lirc defaults}}
 +
 +
====Fedora====
 +
On Fedora the default LIRC device is already set to /dev/lirc0
 +
 +
{{Todo|best way of ensuring lirc_sir is loaded before lircd is started? The config file /etc/sysconfig/lirc does not seem to help. Perhaps an alias line in the modules config file if someone knows the correct syntax?}}
 +
 +
{{cmdroot|service lirc restart}}<br>
 +
{{cmdroot|chkconfig lirc on}}
 +
 +
===Testing LIRC===
 +
Now we are ready to test if we can receive IR data from a remote control.
 +
 +
Try running {{cmdroot|irrecord -d /dev/lirc0 foo}} and follow the onscreen instructions. When asked keep a button on a remote pressed while pointing at the ThinkPad IR port and you should see dots appear.  After having configured your specific remote control, copy {{path|foo}} to {{path|/etc/lirc/lircd.conf}} and restart LIRC. You can use '''irw''' to check whether the remote control is working properly.
 +
 +
To make it perform something useful, try '''irexec'''. It looks for a {{path|.lircrc}} in your home directory. If you don't have one, here is an example which maps KEY_UP and KEY_DOWN (key names can be chosen while performing '''irrecord''') to Up and Down.
 +
<pre>
 +
begin
 +
          button = KEY_UP
 +
          prog = irexec
 +
          config = /usr/bin/xvkbd -xsendevent -text "\\[Up]"
 +
          mode = order
 +
          flags = quit
 +
  end
 +
 +
begin
 +
          button = KEY_DOWN
 +
          prog = irexec
 +
          config = /usr/bin/xvkbd -xsendevent -text "\\[Down]"
 +
          mode = order
 +
          flags = quit
 +
  end
 +
</pre>
 +
 +
Configuring remote controls is out of scope for this document and you should check the LIRC website for detailed instructions. But if your using Gnome you might want to try {{cmd|gnome-lirc-properties|$}}, or in the case of KDE {{cmd|kdelirc|$}}.
 +
 +
{{NOTE|Current versions of gnome-lirc-properties (at least up to 0.3.1) do not support lirc_sir, you need to first edit {{path|/usr/share/gnome-lirc-properties/receivers.conf}} and add the following:<br><pre>[Generic: IrDA SIR Receiver]
 +
kernel-module = lirc_sir
 +
device-nodes  = /dev/lirc0</pre>
 +
After this you can select Generic - IrDA SIR Receiver from the drop down menus (autodetect will not pick it up)}}
  
 
== External Sources ==
 
== External Sources ==
Line 87: Line 162:
 
*[http://pcmcia-cs.sourceforge.net/ Linux PCMCIA Project] (External)
 
*[http://pcmcia-cs.sourceforge.net/ Linux PCMCIA Project] (External)
 
*[http://tpctl.sourceforge.net/ tpctl homepage] (External)
 
*[http://tpctl.sourceforge.net/ tpctl homepage] (External)
*[http://www.lirc.org/ Linux Infrared Remote Control] (External)
+
*[http://www.lirc.org/ Linux Infrared Remote Control (LIRC)] (External)

Latest revision as of 18:07, 26 July 2011

The purpose of this document is to get the IrDA hardware in your ThinkPad operational, setting up communication to other devices is not covered. However, the external links section can prove useful for this.

Serial IR (SIR)

SIR is limited to serial datarates up to 115.2Kb/s

On modern distributions all configuration might be taken care of automatically by starting the irda service # service irda start. If not try the following;

To use it, run # irattach /dev/ttyS1 -s; modprobe ircomm-tty

Then turn on your IrDA-capable device and put it within range, and point your software (e.g., minicom) to /dev/irda0.

Kernel configuration

Edit /etc/modprobe.conf and add the following lines

alias tty-ldisc-11 irtty-sir
alias char-major-161 ircomm-tty

Fast IR (FIR)

FIR is the preferred mode of IrDA operation and operates at a maximum bandwidth of 4 Mbps

On modern distributions this should all be automatically handled by simply starting the idra service # service irda start. If not try the following;

Kernel configuration

Edit /etc/modprobe.conf and add the following lines

alias irda0 nsc-ircc

Make sure that setserial is in right directory (e.g not in /usr/bin/setserial).After that if irdadump still gives nothing try:

echo 1 > /proc/sys/net/irda/discovery

Known problems

  • If you read something like "ttyS1: LSR safety check engaged!" and "irattach: tcgetattr: Input/output error" in the system log, try limiting the FIR max baud rate (echo 57600 > /proc/sys/net/irda/max_baud_rate). This did the trick for me when I was trying to synchronize my Ericsson T39m with my Thinkpad R51 (multisync, evolution-2.8, KDE 3.5.5, openSUSE 10.2).
  • If you get an error in syslog like "nsc_ircc_open(), can't get iobase of 0x2f8" it probably means you have manually specified resources for IrDA in the BIOS. When you do that you effectively allow the serial driver to take control, and as a result the nsc_ircc driver can no longer take control of the resources. Options are to either restore the BIOS settings for IrDA to factory default, or you can work around it by using setserial to clear the resources before loading the nsc_ircc kernel module
setserial /dev/ttyS1 uart none port 0 irq 0; modprobe nsc_ircc

Some other things you might want to do with IrDA

  • add fast PPP support:
# modprobe irnet
  • if needed, limit further the size of the transmit window
# echo 1 > /proc/sys/net/irda/max_tx_window
  • set the connection speed to 4Mbit in FIR mode:
# echo 4000000 > /proc/sys/net/irda/max_baud_rate

LIRC and IrDA

LIRC allows the use of infrared remote controls with Linux as input devices. This can be especially useful to control applications like mplayer, xine, mythtv or boxee. Usually, IrDA ports are not compatible with LIRC, but you may have luck using lirc_sir, as follows;

NOTE!
lirc_sir is incompatible with the regular Linux IrDA drivers (nsc_ircc). You can only use one at a time, and will have to reboot before you can switch
NOTE!
Even if you are successful in getting this to work, you might find that the distance between remote control and receiver on the ThinkPad cannot exceed ~50cm, rendering it effectively useless. This can vary depending on Remote and ThinkPad used, there has been one successful report of a T60 with >2M

Success reports

  • R40
  • T41
  • T60
  • 600
  • Z61m (the distance between remote control and receiver highly depends on the remote control used. With an Acer STRC-100 I get only 80 cm compared to 180 cm with a Sony RM-SRG440)

Failure reports

lirc_sir does not always work, particular on newer machines it seems the module loads when following these instructions, but the device /dev/lirc0 cannot be opened and returns a device or resource busy. You can simply test this by typing # cat /dev/lirc0

  • T60

Configuring lirc_sir

Go into your BIOS setup, and ensure that Infrared is fully enabled and that resources are assigned. I suggest using IO 2f8 and IRQ 3.

Boot into Linux, and first ensure the setserial program is installed. Running # /bin/setserial /dev/ttyS1 should return at this point:

/dev/ttyS1, UART: undefined, Port: 0x02f8, IRQ: 3

If setserial cannot be found, install the setserial package with your distributions package management software

Then create a file /etc/modprobe.d/lirc.conf with the following content:

# prevent nsc_ircc from loading (blacklist might not be enough)
blacklist nsc_ircc
install nsc_ircc /bin/true
# pass options to lirc_sir to load it on ttyS1
options lirc_sir io=0x2f8 irq=3
# ensure serial resources are cleared before loading lirc_sir
# not doing so can result in a device busy error, or can even hang your system
install lirc_sir /bin/setserial /dev/ttyS1 uart none port 0 irq 0; /sbin/modprobe --ignore-install lirc_sir

At this point it is best to reboot, to ensure that nsc_ircc was never loaded. Several things can go wrong if the steps are not followed accurately. You might get an error when loading lirc_sir that the device is busy, or your system may even hang.

Now do a # modprobe lirc_sir and check # dmesg output. You should see something like this:

lirc_dev: IR Remote Control driver registered, major 61
lirc_dev: lirc_register_plugin: sample_rate: 0
lirc_sir: I/O port 0x02f8, IRQ 3.
lirc_sir: Installed.

Configuring LIRC

If you did not yet install LIRC, then do so now using your distributions package management system.

Ubuntu

NOTE!
Successfully tested under Ubuntu 10.04

Make sure your /etc/lirc/hardware.conf looks like this:

REMOTE="SIR IrDA (built-in IR ports)"
REMOTE_MODULES="lirc_dev lirc_sir"
REMOTE_DRIVER=""
REMOTE_DEVICE="/dev/lirc0"
REMOTE_LIRCD_CONF=""
REMOTE_LIRCD_ARGS=""
TRANSMITTER="None"
TRANSMITTER_MODULES=""
TRANSMITTER_DRIVER=""
TRANSMITTER_DEVICE=""
TRANSMITTER_LIRCD_CONF=""
TRANSMITTER_LIRCD_ARGS=""
START_LIRCD="true"
START_LIRCMD=""
LOAD_MODULES=""
LIRCMD_CONF=""
FORCE_NONINTERACTIVE_RECONFIGURATION="false"

After this, start (or re-start) the lirc daemon, and set it to automatically start on bootup.

# sudo service lirc restart
# sudo update-rc.d lirc defaults

Fedora

On Fedora the default LIRC device is already set to /dev/lirc0

TODO
best way of ensuring lirc_sir is loaded before lircd is started? The config file /etc/sysconfig/lirc does not seem to help. Perhaps an alias line in the modules config file if someone knows the correct syntax?

# service lirc restart
# chkconfig lirc on

Testing LIRC

Now we are ready to test if we can receive IR data from a remote control.

Try running # irrecord -d /dev/lirc0 foo and follow the onscreen instructions. When asked keep a button on a remote pressed while pointing at the ThinkPad IR port and you should see dots appear. After having configured your specific remote control, copy foo to /etc/lirc/lircd.conf and restart LIRC. You can use irw to check whether the remote control is working properly.

To make it perform something useful, try irexec. It looks for a .lircrc in your home directory. If you don't have one, here is an example which maps KEY_UP and KEY_DOWN (key names can be chosen while performing irrecord) to Up and Down.

 begin
           button = KEY_UP
           prog = irexec
           config = /usr/bin/xvkbd -xsendevent -text "\\[Up]"
           mode = order
           flags = quit
  end

 begin
           button = KEY_DOWN
           prog = irexec
           config = /usr/bin/xvkbd -xsendevent -text "\\[Down]"
           mode = order
           flags = quit
  end

Configuring remote controls is out of scope for this document and you should check the LIRC website for detailed instructions. But if your using Gnome you might want to try $ gnome-lirc-properties, or in the case of KDE $ kdelirc.

NOTE!
Current versions of gnome-lirc-properties (at least up to 0.3.1) do not support lirc_sir, you need to first edit /usr/share/gnome-lirc-properties/receivers.conf and add the following:
[Generic: IrDA SIR Receiver]
kernel-module = lirc_sir
device-nodes  = /dev/lirc0
After this you can select Generic - IrDA SIR Receiver from the drop down menus (autodetect will not pick it up)

External Sources