Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2b680d1b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent fa241988

Documentation/DocBook/media/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -150,7 +150,7 @@ DVB_DOCUMENTED = \ 
	-e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \

	-e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \

	-e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \

	-e "s,\(audio-mixer\|audio-karaoke\|audio-status\)-t,\1,g" \

	-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" \

	-e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \

	-e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \

Documentation/DocBook/media/dvb/ca.xml

+46 −47
Original line number Diff line number Diff line
@@ -8,18 +8,17 @@ including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application. 
<title>CA Data Types</title>





<section id="ca_slot_info_t">

<section id="ca-slot-info">

<title>ca_slot_info_t</title>

 <programlisting>

 /&#x22C6; slot interface types and info &#x22C6;/



 typedef struct ca_slot_info_s {

typedef struct ca_slot_info {

	int num;               /&#x22C6; slot number &#x22C6;/



	int type;              /&#x22C6; CA interface this slot supports &#x22C6;/

#define CA_CI            1     /&#x22C6; CI high level interface &#x22C6;/

#define CA_CI_LINK       2     /&#x22C6; CI link layer level interface &#x22C6;/

#define CA_CI_PHYS       4     /&#x22C6; CI physical layer level interface &#x22C6;/

#define CA_DESCR         8     /&#x22C6; built-in descrambler &#x22C6;/

#define CA_SC          128     /&#x22C6; simple smart card interface &#x22C6;/



	unsigned int flags;
@@ -29,10 +28,10 @@ including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application. 
</programlisting>



</section>

<section id="ca_descr_info_t">

<section id="ca-descr-info">

<title>ca_descr_info_t</title>

<programlisting>

 typedef struct ca_descr_info_s {

typedef struct ca_descr_info {

	unsigned int num;  /&#x22C6; number of available descramblers (keys) &#x22C6;/

	unsigned int type; /&#x22C6; type of supported scrambling system &#x22C6;/

#define CA_ECD           1
@@ -42,8 +41,8 @@ including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application. 
</programlisting>



</section>

<section id="ca_cap_t">

<title>ca_cap_t</title>

<section id="ca-caps">

<title>ca_caps_t</title>

<programlisting>

typedef struct ca_cap_s {

	unsigned int slot_num;  /&#x22C6; total number of CA card and module slots &#x22C6;/
@@ -54,11 +53,11 @@ including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application. 
</programlisting>



</section>

<section id="ca_msg_t">

<section id="ca-msg">

<title>ca_msg_t</title>

<programlisting>

/&#x22C6; a message to/from a CI-CAM &#x22C6;/

 typedef struct ca_msg_s {

typedef struct ca_msg {

	unsigned int index;

	unsigned int type;

	unsigned int length;
@@ -67,10 +66,10 @@ including <emphasis role="tt">linux/dvb/ca.h</emphasis> in your application. 
</programlisting>



</section>

<section id="ca_descr_t">

<section id="ca-descr">

<title>ca_descr_t</title>

<programlisting>

 typedef struct ca_descr_s {

typedef struct ca_descr {

	unsigned int index;

	unsigned int parity;

	unsigned char cw[8];