summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/dvb/ca-get-msg.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-09-05media: ca.h: document ca_msg and the corresponding ioctlsMauro Carvalho Chehab1-13/+6
Usually, CA messages are sent/received via reading/writing at the CA device node. However, two drivers (dst_ca and firedtv-ci) also implement it via ioctls. Apparently, on both cases, the net result is the same. Anyway, let's document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-05media: dvb uAPI docs: adjust return value ioctl descriptionsMauro Carvalho Chehab1-2/+7
There are several issues on the return value for ioctls: - Text is confusing; - Some error codes don't exist; - The non-generic error codes should come before the text that points to the generic error codes; - Tables don't contain column size hints; - Some references are not marked as such. Correct them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-05media: dvb CA docs: place undocumented data together with ioctlsMauro Carvalho Chehab1-29/+9
Right now, the same undocumented structs are on two places: at ca_data_types.rst and together with their ioctls. Move them to just one place and use the standard way to represent them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] docs-rst: fix the remaining broken links for DVB CA APIMauro Carvalho Chehab1-1/+1
Several links are broken, as they were using the typedef name, instead of using the corresponding structs. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-09-09[media] ca-get-msg.rst: add a boilerplate for struct ca_msgMauro Carvalho Chehab1-1/+32
There are no descriptions at ca.h header for this struct. Yet, as we want to get rid of the warnings, let's add a boilerplate, with just the struct types and fields. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22[media] docs-rst: Convert DVB uAPI to use C function referencesMauro Carvalho Chehab1-23/+7
Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. While here, improve the documentation, marking the deprecated ioctls, and making the non-deprecated ones more like the rest of the media book. Also, add a notice for ioctls that still require documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22[media] docs-next: stop abusing on the cpp domainMauro Carvalho Chehab1-1/+1
Now that we have an override for the c domain that will do the right thing for the Kernel, stop abusing on the cpp domain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08doc_rst: rename the media Sphinx suff to Documentation/mediaMauro Carvalho Chehab1-0/+59
The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>