Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: ca docs: document CA_SET_DESCR ioctl and structs

The av7110 driver uses CA_SET_DESCR to store the descrambler
control words at the CA descrambler slots.

Document it.

Thanks-to: Honza Petrouš <jpetrous@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+10 -14
+2 -13
Documentation/media/uapi/dvb/ca-set-descr.rst
··· 28 28 ``msg`` 29 29 Pointer to struct :c:type:`ca_descr`. 30 30 31 - .. c:type:: ca_descr 32 - 33 - .. code-block:: c 34 - 35 - struct ca_descr { 36 - unsigned int index; 37 - unsigned int parity; 38 - unsigned char cw[8]; 39 - }; 40 - 41 - 42 31 Description 43 32 ----------- 44 33 45 - .. note:: This ioctl is undocumented. Documentation is welcome. 46 - 34 + CA_SET_DESCR is used for feeding descrambler CA slots with descrambling 35 + keys (refered as control words). 47 36 48 37 Return Value 49 38 ------------
+8 -1
include/uapi/linux/dvb/ca.h
··· 109 109 unsigned char msg[256]; 110 110 }; 111 111 112 + /** 113 + * struct ca_descr - CA descrambler control words info 114 + * 115 + * @index: CA Descrambler slot 116 + * @parity: control words parity, where 0 means even and 1 means odd 117 + * @cw: CA Descrambler control words 118 + */ 112 119 struct ca_descr { 113 120 unsigned int index; 114 - unsigned int parity; /* 0 == even, 1 == odd */ 121 + unsigned int parity; 115 122 unsigned char cw[8]; 116 123 }; 117 124