Merge commit '81fd23e2b3ccf71c807e671444e8accaba98ca53' of https://git.pengutronix...
[linux-2.6-microblaze.git] / Documentation / admin-guide / media / ci.rst
1 .. SPDX-License-Identifier: GPL-2.0
2
3 Digital TV Conditional Access Interface
4 =======================================
5
6
7 .. note::
8
9    This documentation is outdated.
10
11 This document describes the usage of the high level CI API as
12 in accordance to the Linux DVB API. This is a not a documentation for the,
13 existing low level CI API.
14
15 .. note::
16
17    For the Twinhan/Twinhan clones, the dst_ca module handles the CI
18    hardware handling. This module is loaded automatically if a CI
19    (Common Interface, that holds the CAM (Conditional Access Module)
20    is detected.
21
22 ca_zap
23 ~~~~~~
24
25 A userspace application, like ``ca_zap`` is required to handle encrypted
26 MPEG-TS streams.
27
28 The ``ca_zap`` userland application is in charge of sending the
29 descrambling related information to the Conditional Access Module (CAM).
30
31 This application requires the following to function properly as of now.
32
33 a) Tune to a valid channel, with szap.
34
35   eg: $ szap -c channels.conf -r "TMC" -x
36
37 b) a channels.conf containing a valid PMT PID
38
39   eg: TMC:11996:h:0:27500:278:512:650:321
40
41   here 278 is a valid PMT PID. the rest of the values are the
42   same ones that szap uses.
43
44 c) after running a szap, you have to run ca_zap, for the
45    descrambler to function,
46
47   eg: $ ca_zap channels.conf "TMC"
48
49 d) Hopefully enjoy your favourite subscribed channel as you do with
50    a FTA card.
51
52 .. note::
53
54   Currently ca_zap, and dst_test, both are meant for demonstration
55   purposes only, they can become full fledged applications if necessary.
56
57
58 Cards that fall in this category
59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
61 At present the cards that fall in this category are the Twinhan and its
62 clones, these cards are available as VVMER, Tomato, Hercules, Orange and
63 so on.
64
65 CI modules that are supported
66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67
68 The CI module support is largely dependent upon the firmware on the cards
69 Some cards do support almost all of the available CI modules. There is
70 nothing much that can be done in order to make additional CI modules
71 working with these cards.
72
73 Modules that have been tested by this driver at present are
74
75 (1) Irdeto 1 and 2 from SCM
76 (2) Viaccess from SCM
77 (3) Dragoncam