aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-06-08 10:29:27 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:57 -0400
commit2b680d1b4e7e0c561d1523d5155212705fcbb10a (patch)
tree6b2f24afcad8bcc86f2acbee2409bc443b4156f1 /Documentation/DocBook
parentfa24198897ff0e8d34876be0e61f9b35d3c0d467 (diff)
[media] Docbook/ca.xml: match section ID's with the reference links
Make sure that both ca.h.xml and ca.xml will match the same names for the sections/links. This way, it is now possible to identify API spec gaps: Error: no ID for constraint linkend: ca-pid. Error: no ID for constraint linkend: ca-pid. Error: no ID for constraint linkend: CA_RESET. Error: no ID for constraint linkend: CA_GET_CAP. Error: no ID for constraint linkend: CA_GET_SLOT_INFO. Error: no ID for constraint linkend: CA_GET_DESCR_INFO. Error: no ID for constraint linkend: CA_GET_MSG. Error: no ID for constraint linkend: CA_SEND_MSG. Error: no ID for constraint linkend: CA_SET_DESCR. Error: no ID for constraint linkend: CA_SET_PID. Basically, in this case, no CA ioctl is described at the specs, and one file structure (ca-pid) is missing. Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/Makefile2
-rw-r--r--Documentation/DocBook/media/dvb/ca.xml93
2 files changed, 47 insertions, 48 deletions
diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile
index 18604dde1b87..249edd353968 100644
--- a/Documentation/DocBook/media/Makefile
+++ b/Documentation/DocBook/media/Makefile
@@ -150,7 +150,7 @@ DVB_DOCUMENTED = \
150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ 150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
151 -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \ 151 -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \
152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \ 152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
153 -e "s,\(audio-mixer\|audio-karaoke\|audio-status\)-t,\1,g" \ 153 -e "s,\(audio-mixer\|audio-karaoke\|audio-status\|ca-slot-info\|ca-descr-info\|ca-caps\|ca-msg\|ca-descr\|ca-pid\)-t,\1,g" \
154 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \ 154 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
155 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \ 155 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
156 156
diff --git a/Documentation/DocBook/media/dvb/ca.xml b/Documentation/DocBook/media/dvb/ca.xml
index b1f1d2fad654..143ec5bf6bd3 100644
--- a/Documentation/DocBook/media/dvb/ca.xml
+++ b/Documentation/DocBook/media/dvb/ca.xml
@@ -8,73 +8,72 @@ including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application.
8<title>CA Data Types</title> 8<title>CA Data Types</title>
9 9
10 10
11<section id="ca_slot_info_t"> 11<section id="ca-slot-info">
12<title>ca_slot_info_t</title> 12<title>ca_slot_info_t</title>
13 <programlisting> 13 <programlisting>
14 /&#x22C6; slot interface types and info &#x22C6;/ 14typedef struct ca_slot_info {
15 int num; /&#x22C6; slot number &#x22C6;/
15 16
16 typedef struct ca_slot_info_s { 17 int type; /&#x22C6; CA interface this slot supports &#x22C6;/
17 int num; /&#x22C6; slot number &#x22C6;/ 18#define CA_CI 1 /&#x22C6; CI high level interface &#x22C6;/
19#define CA_CI_LINK 2 /&#x22C6; CI link layer level interface &#x22C6;/
20#define CA_CI_PHYS 4 /&#x22C6; CI physical layer level interface &#x22C6;/
21#define CA_DESCR 8 /&#x22C6; built-in descrambler &#x22C6;/
22#define CA_SC 128 /&#x22C6; simple smart card interface &#x22C6;/
18 23
19 int type; /&#x22C6; CA interface this slot supports &#x22C6;/ 24 unsigned int flags;
20 #define CA_CI 1 /&#x22C6; CI high level interface &#x22C6;/ 25#define CA_CI_MODULE_PRESENT 1 /&#x22C6; module (or card) inserted &#x22C6;/
21 #define CA_CI_LINK 2 /&#x22C6; CI link layer level interface &#x22C6;/ 26#define CA_CI_MODULE_READY 2
22 #define CA_CI_PHYS 4 /&#x22C6; CI physical layer level interface &#x22C6;/ 27} ca_slot_info_t;
23 #define CA_SC 128 /&#x22C6; simple smart card interface &#x22C6;/
24
25 unsigned int flags;
26 #define CA_CI_MODULE_PRESENT 1 /&#x22C6; module (or card) inserted &#x22C6;/
27 #define CA_CI_MODULE_READY 2
28 } ca_slot_info_t;
29</programlisting> 28</programlisting>
30 29
31</section> 30</section>
32<section id="ca_descr_info_t"> 31<section id="ca-descr-info">
33<title>ca_descr_info_t</title> 32<title>ca_descr_info_t</title>
34 <programlisting> 33<programlisting>
35 typedef struct ca_descr_info_s { 34typedef struct ca_descr_info {
36 unsigned int num; /&#x22C6; number of available descramblers (keys) &#x22C6;/ 35 unsigned int num; /&#x22C6; number of available descramblers (keys) &#x22C6;/
37 unsigned int type; /&#x22C6; type of supported scrambling system &#x22C6;/ 36 unsigned int type; /&#x22C6; type of supported scrambling system &#x22C6;/
38 #define CA_ECD 1 37#define CA_ECD 1
39 #define CA_NDS 2 38#define CA_NDS 2
40 #define CA_DSS 4 39#define CA_DSS 4
41 } ca_descr_info_t; 40} ca_descr_info_t;
42</programlisting> 41</programlisting>
43 42
44</section> 43</section>
45<section id="ca_cap_t"> 44<section id="ca-caps">
46<title>ca_cap_t</title> 45<title>ca_caps_t</title>
47 <programlisting> 46<programlisting>
48 typedef struct ca_cap_s { 47typedef struct ca_cap_s {
49 unsigned int slot_num; /&#x22C6; total number of CA card and module slots &#x22C6;/ 48 unsigned int slot_num; /&#x22C6; total number of CA card and module slots &#x22C6;/
50 unsigned int slot_type; /&#x22C6; OR of all supported types &#x22C6;/ 49 unsigned int slot_type; /&#x22C6; OR of all supported types &#x22C6;/
51 unsigned int descr_num; /&#x22C6; total number of descrambler slots (keys) &#x22C6;/ 50 unsigned int descr_num; /&#x22C6; total number of descrambler slots (keys) &#x22C6;/
52 unsigned int descr_type;/&#x22C6; OR of all supported types &#x22C6;/ 51 unsigned int descr_type;/&#x22C6; OR of all supported types &#x22C6;/
53 } ca_cap_t; 52 } ca_cap_t;
54</programlisting> 53</programlisting>
55 54
56</section> 55</section>
57<section id="ca_msg_t"> 56<section id="ca-msg">
58<title>ca_msg_t</title> 57<title>ca_msg_t</title>
59 <programlisting> 58<programlisting>
60 /&#x22C6; a message to/from a CI-CAM &#x22C6;/ 59/&#x22C6; a message to/from a CI-CAM &#x22C6;/
61 typedef struct ca_msg_s { 60typedef struct ca_msg {
62 unsigned int index; 61 unsigned int index;
63 unsigned int type; 62 unsigned int type;
64 unsigned int length; 63 unsigned int length;
65 unsigned char msg[256]; 64 unsigned char msg[256];
66 } ca_msg_t; 65} ca_msg_t;
67</programlisting> 66</programlisting>
68 67
69</section> 68</section>
70<section id="ca_descr_t"> 69<section id="ca-descr">
71<title>ca_descr_t</title> 70<title>ca_descr_t</title>
72 <programlisting> 71<programlisting>
73 typedef struct ca_descr_s { 72typedef struct ca_descr {
74 unsigned int index; 73 unsigned int index;
75 unsigned int parity; 74 unsigned int parity;
76 unsigned char cw[8]; 75 unsigned char cw[8];
77 } ca_descr_t; 76} ca_descr_t;
78</programlisting> 77</programlisting>
79 </section></section> 78 </section></section>
80<section id="ca_function_calls"> 79<section id="ca_function_calls">