pvrusb2 driver FAQ

$Id: faq.html 1141 2006-04-29 21:17:26Z isely $

Mike Isely <isely at pobox dot com>

You can find the main driver page on the web at http://www.isely.net/pvrusb2/pvrusb2.html.


This page describes list of common pitfalls (in no particular order) and their corresponding solutions when using the pvrusb2 linux driver. I have gathered up this list from e-mail correspondence over time, along with some lessons learned here. If there are things you think should be added here, please let me know.

Feel free to e-mail me if you have any other questions.

Mike Isely <isely at pobox dot com>

Contents

1. When I try to install the driver with "make install" the installation fails.
2. Why am I not getting any sound?
3. Why can't I get this driver to work on an xbox?
4. The image is jumpy and the audio tends to lag.
5. I can't tune anything. I get either video snow or a blank screen.
6. I can't get xawtv to work.
7. I can't get mplayer to work.
8. I can't compile because tveeprom.h is missing or the compilation dies with a complaint about tvdata being an incomplete type.
9. I'm getting errors in the log about being unable to find pvrusb2.f1 or pvrusb2.f2.
10. I copied the driver module(s) into my system but the kernel is not loading them.
11. Sometimes streaming quits in xawtv.
12. Where the heck is /dev/input/eventX for my device?
13. Why did the device go batty when my air conditioning turned on?
14. Why must I be root to access the control files in sysfs?
15. I just added a second PVR USB2 and now the video is stuttering, corrupted and/or unstable.
16. Changing the balance, bass or treble doesn't have any effect.
17. Changing the audio mode (stereo / mono / sap) doesn't do anything!
18. Should I be worried if I see a message about a corrupt Hauppauge PROM?
19. What's up with "pvrusb2 disagrees about version of symbol tveeprom_hauppauge_analog"?

1. When I try to install the driver with "make install" the installation fails.

That's because I screwed up when reworking the build process with the 20050527 snapshot. We're using Kbuild and the correct internal target is "modules_install" not "install". Previous snapshots should be OK because they predate the bug. Anything after 20050527 should be OK because it's been fixed. Note that in any case if you follow the procedure on the pvrusb2.html, then you're copying the modules by hand anyway, in which case this isn't an issue.

2. Why am I not getting any sound?

There are multiple possible causes for this problem. Check the following:

3. Why can't I get this driver to work on an xbox?

The problem is that the xbox has an I2C adapter controller in the xbox Linux software that is very hostile to the presence of other I2C busses showing up in the system. The pvrusb2 hardware has an internal I2C bus. The fix for this is to patch the xbox Linux software. Contact me for a patch.

4. The image is jumpy and the audio tends to lag.

Possibly your system isn't keeping up with the driver's bit rate. There are some things you can do to determine what is going on:

It is possible to have a very fast system but still have lousy video rendering performance. Good video rendering depends a lot on the video card you are using. For example I have found that Nvidia 5200-class video cards do hardware video scaling significantly better than ATI 9200-class video cards.

5. I can't tune anything. I get either video snow or a blank screen.

There are multiple possible causes for this problem. Check the following:

6. I can't get xawtv to work.

There are multiple possible causes for this problem. Check the following:

7. I can't get mplayer to work.

Even though this driver is a video4linux driver, and mplayer is able to handle video4linux devices, you can't run mplayer against this driver in such a way that mplayer tries to treat it as a video4linux device. What happens when you try is that mplayer (1) can't grok v4l frames as mpeg2 data, and (2) even if it could, mplayer tries to use mmap() style I/O to fetch the video "frames" and that is not currently supported by the pvrusb2 driver.

The way to make mplayer work is just to not do anything special. Specify your video device name (e.g. /dev/video0) as the "file" to read - mplayer will then happily stream plain old mpeg2 data from the device. Yes, I know that means you can't use mplayer to adjust the device's controls, like for example changing the channel. However you can still use the driver's sysfs interface to do this while mplayer is running.

Another alternative solution you can try is the patched mplayer available with the ivtv driver. I haven't tried this, but I suspect the ivtv driver author patched mplayer to deal with exactly the problems I describe above. Thus if it works for ivtv it may very well also work for the pvrusb2 driver. (Please tell me if you try this and let me know if it worked.)

8. I can't compile because tveeprom.h is missing or the compilation dies with a complaint about tvdata being an incomplete type.

The tvdata structure is defined in tveeprom.h so the common solution is to find tveeprom.h. That header file is part of your kernel source tree. If it isn't there, then your kernel sources are too old to work with this driver. Update your kernel. Alternatively you can probably also work with a slightly older kernel that has been patched up with the latest video4linux snapshot. However I really recommend you go to a later kernel. A good choice known to work is 2.6.11.10.

9. I'm getting errors in the log about being unable to find pvrusb2.f1 or pvrusb2.f2.

Those two files are the firmware images that must be loaded into the pvrusb2 hardware before it will work properly. The firmware is not part of this snapshot, but you can extract it from your Windows drivers - which you should have gotten with the device. The extraction process is described here.

10. I copied the driver module(s) into my system but the kernel is not loading them.

You might have compiled for the wrong kernel version. The kernel loader will usually report this in a very unsubtle way in the system log.

If the kernel is complaining that it can't find the module, you might want to try this first:

depmod -a

I leave it as an exercise to the reader to look up the man page for depmod to see why this is important :-)

11. Sometimes streaming quits in xawtv.

This problem was mostly fixed as of the 20050626 snapshot of the driver. Are you using a recent enough snapshot?

The remaining issues right now I consider to be xawtv application issues. These problems include:

Any time streaming quits in xawtv, you can always restart it by doing something that causes xawtv to stop then start again. Changing the channel for example is a way to kick the streaming going again.

12. Where the heck is /dev/input/eventX for my device?

There isn't any such device node entry for this driver. Aurelien's older driver directly integrated with the kernel's input system for IR processing; I removed all that logic in favor of allowing the lirc package to do the work of handling the IR processing. When you use lirc, input is captured differently, thus no /dev/input/eventX will be found for this driver. More info about this is described here.

13. Why did the device go batty when my air conditioning turned on?

This is because your air conditioning compressor caused a temporary sag in your line power. While modern PC power supplies are pretty good at surviving such power abuse, your PVR USB2 device is externally powered using a cheap wall-wart which just can't defend against a power sag. So the result is a power glitch into the tuner's hardware and that can screw up video capture.

This sort of issue is not unique to the PVR USB2 device - it can happen for any device which has a separate external power supply (which would be typical of many USB devices). If this is a problem for you, get a UPS and plug your PVR USB2 device into it (along with the PC of course).

14. Why must I be root to access the control files in sysfs?

Files created in sysfs are initialized with a default user and group ids of root. There's no way to initialize them to anything else. Now, though the driver can't set the uid or gid, the driver can set the mode for each sysfs file it creates. So why not just make the files world writable? Because that would violate the security of the system. The simple fact is that there are things one can tweak here that would probably cause the driver to fail, which might be a way to destablize the system. (No, I don't know that for certain, but when you don't know, the correct action is really to not allow it in the first place.) Just accept the fact that for the same reason that permissions should be restricted for access, to say your CD burner, that it should not be possible for just anyone to write information or otherwise control the pvrusb2 driver. That is why only root can access the control files in sysfs.

Now, with that said, there are other possibilities. While it should not be the business of the pvrusb2 driver to set fine grained security policy, there's no reason why one couldn't do other things in user space to solve the problem. Some possibilities include:

15. I just added a second PVR USB2 and now the video is stuttering, corrupted and/or unstable.

Beyond instancing itself again, the driver doesn't have to do anything special to support multiple devices. So it should "just work".

However there can be hardware issues with such a configuration. The thing to watch out for is how you have your device(s) connected to the computer. If everything is using USB 2.0 running at hi-speed, then you should be fine (and if you are not contact me). A single PVR USB2 device plugged into a "full speed" USB 1.1 port will also work fine, but since "full speed" is at best 12mbps and your average mpeg2 stream is going to be around 6mbps or higher, then a second PVR USB2 device sharing that connection through a hub is going to cause trouble. There just isn't enough USB bandwidth in this case. If you are going to run multiple PVR USB2 devices, make sure that each has enough bandwidth available between it and the PC. Generally this means that if you are going to share a port using a hub, the hub at least must be a hi-speed hub and it must be connected to a hi-speed port.

Note that you can dump out the ctl_usb_speed control in sysfs for each device to find out what speed it thinks it is running at.

16. Changing the balance, bass or treble doesn't have any effect.

Handling of the various audio tone / balance settings is not directly implemented by the pvrusb2 driver. It just passes everything through to msp3400.ko for processing, and that module processes the settings into commands for the msp34xx chip inside the device. The problem here (at least for me and probably everyone) is that the particular msp34xx variant inside the PVR USB2 doesn't have the ability to adjust any of the balance, bass, or treble. The msp3400.ko tries to act like the capability is there, but it just doesn't work because it isn't implemented in the silicon. That's why it probably isn't working for you.

This of course leads to the obvious question: If it isn't going to work, then why do the controls exist in the driver? Answer: Because I'm not sure that it isn't going to work. It is conceivable that there might be some PVR USB2 variants floating around that happen to have the right kind of msp34xx part to implement this. Given Hauppauge's penchant for changing out parts without changing models, I'm not prepared to assume that the ability won't be there. So the driver makes these controls available and dutifully passes that information down to msp3400.ko which in turn tries to influence the (apparently) non-existent functionality. What would really be nice would be for msp3400.ko to provide a means to detect if balance / bass / treble are supported and to tell the parent driver this information. Then I could disable controls that obviously aren't going to work. But that ability as far as I can tell isn't there, and for now I'm going to assume that it might be there.

17. Changing the audio mode (stereo / mono / sap) doesn't do anything!

After a night of bug chasing, I believe I understand this problem, and it only affects those of us in NTSC territory.

Again, this is a case where the pvrusb2 driver just passes the information down to msp3400.ko and it's up to that module to act on the information to implement the correct mode. There's very little that the pvrusb2 driver can do to foul this up.

For all areas except NTSC there are 2 possible audio subchannels (I'm guessing this), and the msp34xx chip has the ability to select combinations of those two within a given mode. But with NTSC there are actually 3 possible audio subchannels that can be broadcast at the same time (stereo left, stereo right, sap), and the msp34xx chip has to handle this by pre-selecting a subset based on the mode setting. There are two NTSC "modes" because of this, so when switching between either stereo or sap one has to switch this mode in addition to switching the source. Unfortunately the implementation in msp3400.ko fails to do this. It just locks onto the first mode which selects the stereo choice. Given that many people using this module do not live in an NTSC area (I presume), this problem has probably gone unnoticed. I imagine that the ivtv driver likely has the same issue.

The fix for this needs to be in msp3400.ko, which I don't maintain. When switching to/from sap, the mode has to be manually switched to/from 0x0020 (BTSC stereo) and 0x0021 (BTSC sap). It might be possible to force this by disabling automatic mode selection in the mode and forcing video standard code 0x0021 on the module's option line, but I haven't tried this and it's really clunky to try to operate the tuner in this manner. If someone else would like to look into this, I would welcome the effort.

At some point in the future I may try to code a fix for this, but now isn't the time. There are two variants of this rather messy msp3400.ko module already floating around (kernel and ivtv) and I don't want to fork a 3rd version. The versions I'm looking at are already several months old. Before attacking something like this one would need to first go to bleeding edge versions and talk to the corresponding maintainers. I just don't have the time right now.

18. Should I be worried if I see a message about a corrupt Hauppauge PROM?

You might see a message in your system log that looks like this:

tveeprom 2-0050: Encountered bad packet header [c2]. Corrupt or not a Hauppauge eeprom.

Yet even with such an alarming thing in the log, the PVR USB2 device operates correctly. This is because the tveeprom.ko module is trying on its own to parse the PROM data in the PVR USB2 and it frequently can't do that correctly without outside help. Later on the pvrusb2 driver will orchestrate that action, this time with the correct results, therefore this warning message can be ignored.

This message is coming from a support module, not the pvrusb2 driver itself, and so the pvrusb2 driver can't do much to control its appearance in the log. The interested reader may wish to read all about operation of tveeprom.ko, which is laid out in gory detail over in eeprom.html.

19. What's up with "pvrusb2 disagrees about version of symbol tveeprom_hauppauge_analog"?

This is the result of an interaction between CONFIG_MODVERSIONS (a kernel build option) and the horrid hacked up way in which the pvrusb2 driver attempts to deal with tveeprom.ko (see eeprom.html for more about that hack).

When CONFIG_MODVERSIONS is in use, the kernel build system generates these per-symbol CRCs by taking into account every aspect related to the symbol's declaration - like its argument types, the definition of those argument types, the return type, etc. This is done for each symbol exported by a module (a definition) and for each symbol that needs to be imported into a module (a declaration). The idea here is to make sure that the symbol has been defined in precisely the same way it has been declared. If the declaration and definition disagree, then their CRCs won't match and the module loader catches this, prints that nasty message and aborts the load of the module in question. Obviously if a symbol's declaration and definition do not match, then there may be an incompatibility and this is how the kernel CONFIG_MODVERSIONS mechanism prevents usage of incompatible symbols.

For example, if I declare and call function foobar this way:


   void foobar(short abc, char *def);

But the module actually defines foobar this way:


   void foobar(char *def) {
 	/* whatever */
   }

Obviously such a mismatched call will likely generate bad behavior and possibly a kernel oops. But since the CRC for foobar stored in the module defining foobar won't match the CRC for foobar stored in the module using foobar, the mismatch will be caught and the kernel won't let you load that combination of modules at the same time.

In theory this all looks great. But why, might you ask, is this mechanism not working for tveeprom_hauppauge_analog? That's because we really do have conflicting definitions here.

Look back at my diatribe in eeprom.html, and you'll see how I point out that the V4L defined version of this function uses a struct tveeprom that is different than the struct tveeprom used by the ivtv defined version of this function. The CRC generation algorithm is apparently using the full definition of the tveeprom structure as input into the CRC value. Now, in pvrusb2-eeprom.c I do some really ugly hackery to make a run time determination of which struct tveeprom is really the correct one so the code is actually fairly safe. But this sort of thing still trips up the CRC generation. It turns out that in the pvrusb2 driver build, pvrusb2-eeprom.c will see the V4L defined prototype for tveeprom_hauppauge_analog and struct tveeprom, so the expected CRC will be the V4L version of the function. Thus we now see why we get this "disagrees about version of symbol" error when we try to load the ivtv version of tveeprom.ko with the other definition - and a different CRC.

Right now I don't see a good solution. The simple fact is that I'm trying to make the pvrusb2 driver survive a screwed up situation between V4L and ivtv and there's only so much I can do here. There's really only two choices here: (1) Don't enable CONFIG_MODVERSIONS in your kernel build (if you can), or (2) Don't bother trying to use the tveeprom.ko supplied with the pvrusb2 driver. I should also point out here that the same problem should happen if you try to use the "real" ivtv driver's tveeprom.ko, for exactly the same reason. This means that if you really do want ivtv to run co-resident with the pvrusb2 driver, then you are only really left with choice (1).