Merge remote-tracking branch 'xen-tip/linux-next'
[deliverable/linux.git] / Documentation / media / uapi / dvb / video-set-spu-palette.rst
CommitLineData
47d23e36
MCC
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _VIDEO_SET_SPU_PALETTE:
4
586027ce 5=====================
47d23e36
MCC
6VIDEO_SET_SPU_PALETTE
7=====================
8
15e7d615 9Name
586027ce 10----
47d23e36 11
586027ce 12VIDEO_SET_SPU_PALETTE
47d23e36 13
cf8076c3 14.. attention:: This ioctl is deprecated.
15e7d615
MCC
15
16Synopsis
47d23e36
MCC
17--------
18
848d1031 19.. c:function:: int ioctl(fd, VIDEO_SET_SPU_PALETTE, struct video_spu_palette *palette )
cf8076c3 20 :name: VIDEO_SET_SPU_PALETTE
47d23e36 21
47d23e36 22
15e7d615 23Arguments
586027ce 24---------
47d23e36
MCC
25
26.. flat-table::
27 :header-rows: 0
28 :stub-columns: 0
29
30
31 - .. row 1
32
33 - int fd
34
35 - File descriptor returned by a previous call to open().
36
37 - .. row 2
38
39 - int request
40
41 - Equals VIDEO_SET_SPU_PALETTE for this command.
42
43 - .. row 3
44
45 - video_spu_palette_t \*palette
46
47 - SPU palette according to section ??.
48
49
15e7d615 50Description
586027ce
MCC
51-----------
52
53This ioctl sets the SPU color palette.
54
848d1031
MCC
55.. c:type:: video_spu_palette
56
57.. code-block::c
58
59 typedef struct video_spu_palette { /* SPU Palette information */
60 int length;
61 __u8 __user *palette;
62 } video_spu_palette_t;
586027ce 63
15e7d615 64Return Value
47d23e36
MCC
65------------
66
67On success 0 is returned, on error -1 and the ``errno`` variable is set
68appropriately. The generic error codes are described at the
69:ref:`Generic Error Codes <gen-errors>` chapter.
70
71
72
73.. flat-table::
74 :header-rows: 0
75 :stub-columns: 0
76
77
78 - .. row 1
79
80 - ``EINVAL``
81
82 - input is not a valid palette or driver doesn’t handle SPU.
This page took 0.046355 seconds and 5 git commands to generate.