aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-17 19:32:28 -0400
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-17 21:51:16 -0400
commitf1668f1d132ad08e3cccd10f34cfbe8434ffe81d (patch)
tree1e695a083b36fd67dae690953b20bace0df17c6a
parentb299357065a439ed9a26794c37f7827e30187445 (diff)
[media] doc-rst: add documentation for si476x
Convert it to ReST and add to media/v4l-drivers book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-rw-r--r--Documentation/media/v4l-drivers/index.rst2
-rw-r--r--Documentation/media/v4l-drivers/si476x.rst229
2 files changed, 96 insertions, 135 deletions
diff --git a/Documentation/media/v4l-drivers/index.rst b/Documentation/media/v4l-drivers/index.rst
index 5a582438b2c4..3ff127195fd3 100644
--- a/Documentation/media/v4l-drivers/index.rst
+++ b/Documentation/media/v4l-drivers/index.rst
@@ -36,4 +36,6 @@ License".
36 saa7134 36 saa7134
37 sh_mobile_ceu_camera 37 sh_mobile_ceu_camera
38 si470x 38 si470x
39 si4713
40 si476x
39 zr364xx 41 zr364xx
diff --git a/Documentation/media/v4l-drivers/si476x.rst b/Documentation/media/v4l-drivers/si476x.rst
index 616607955aaf..01a8d44425aa 100644
--- a/Documentation/media/v4l-drivers/si476x.rst
+++ b/Documentation/media/v4l-drivers/si476x.rst
@@ -27,159 +27,118 @@ The drivers exposes following files:
27 information. The contents of the file is binary data of the 27 information. The contents of the file is binary data of the
28 following layout: 28 following layout:
29 29
30 Offset | Name | Description 30 ============= ============== ====================================
31 ==================================================================== 31 Offset Name Description
32 0x00 | blend_int | Flag, set when stereo separation has 32 ============= ============== ====================================
33 | | crossed below the blend threshold 33 0x00 blend_int Flag, set when stereo separation has
34 -------------------------------------------------------------------- 34 crossed below the blend threshold
35 0x01 | hblend_int | Flag, set when HiBlend cutoff 35 0x01 hblend_int Flag, set when HiBlend cutoff
36 | | frequency is lower than threshold 36 frequency is lower than threshold
37 -------------------------------------------------------------------- 37 0x02 hicut_int Flag, set when HiCut cutoff
38 0x02 | hicut_int | Flag, set when HiCut cutoff 38 frequency is lower than threshold
39 | | frequency is lower than threshold 39 0x03 chbw_int Flag, set when channel filter
40 -------------------------------------------------------------------- 40 bandwidth is less than threshold
41 0x03 | chbw_int | Flag, set when channel filter 41 0x04 softmute_int Flag indicating that softmute
42 | | bandwidth is less than threshold 42 attenuation has increased above
43 -------------------------------------------------------------------- 43 softmute threshold
44 0x04 | softmute_int | Flag indicating that softmute 44 0x05 smute 0 - Audio is not soft muted
45 | | attenuation has increased above 45 1 - Audio is soft muted
46 | | softmute threshold 46 0x06 smattn Soft mute attenuation level in dB
47 -------------------------------------------------------------------- 47 0x07 chbw Channel filter bandwidth in kHz
48 0x05 | smute | 0 - Audio is not soft muted 48 0x08 hicut HiCut cutoff frequency in units of
49 | | 1 - Audio is soft muted 49 100Hz
50 -------------------------------------------------------------------- 50 0x09 hiblend HiBlend cutoff frequency in units
51 0x06 | smattn | Soft mute attenuation level in dB 51 of 100 Hz
52 -------------------------------------------------------------------- 52 0x10 pilot 0 - Stereo pilot is not present
53 0x07 | chbw | Channel filter bandwidth in kHz 53 1 - Stereo pilot is present
54 -------------------------------------------------------------------- 54 0x11 stblend Stereo blend in %
55 0x08 | hicut | HiCut cutoff frequency in units of 55 ============= ============== ====================================
56 | | 100Hz
57 --------------------------------------------------------------------
58 0x09 | hiblend | HiBlend cutoff frequency in units
59 | | of 100 Hz
60 --------------------------------------------------------------------
61 0x10 | pilot | 0 - Stereo pilot is not present
62 | | 1 - Stereo pilot is present
63 --------------------------------------------------------------------
64 0x11 | stblend | Stereo blend in %
65 --------------------------------------------------------------------
66 56
67 57
68* /sys/kernel/debug/<device-name>/rds_blckcnt 58* /sys/kernel/debug/<device-name>/rds_blckcnt
69 This file contains statistics about RDS receptions. It's binary data 59 This file contains statistics about RDS receptions. It's binary data
70 has the following layout: 60 has the following layout:
71 61
72 Offset | Name | Description 62 ============= ============== ====================================
73 ==================================================================== 63 Offset Name Description
74 0x00 | expected | Number of expected RDS blocks 64 ============= ============== ====================================
75 -------------------------------------------------------------------- 65 0x00 expected Number of expected RDS blocks
76 0x02 | received | Number of received RDS blocks 66 0x02 received Number of received RDS blocks
77 -------------------------------------------------------------------- 67 0x04 uncorrectable Number of uncorrectable RDS blocks
78 0x04 | uncorrectable | Number of uncorrectable RDS blocks 68 ============= ============== ====================================
79 --------------------------------------------------------------------
80 69
81* /sys/kernel/debug/<device-name>/agc 70* /sys/kernel/debug/<device-name>/agc
82 This file contains information about parameters pertaining to 71 This file contains information about parameters pertaining to
83 AGC(Automatic Gain Control) 72 AGC(Automatic Gain Control)
84 73
85 The layout is: 74 The layout is:
86 Offset | Name | Description 75
87 ==================================================================== 76 ============= ============== ====================================
88 0x00 | mxhi | 0 - FM Mixer PD high threshold is 77 Offset Name Description
89 | | not tripped 78 ============= ============== ====================================
90 | | 1 - FM Mixer PD high threshold is 79 0x00 mxhi 0 - FM Mixer PD high threshold is
91 | | tripped 80 not tripped
92 -------------------------------------------------------------------- 81 1 - FM Mixer PD high threshold is
93 0x01 | mxlo | ditto for FM Mixer PD low 82 tripped
94 -------------------------------------------------------------------- 83 0x01 mxlo ditto for FM Mixer PD low
95 0x02 | lnahi | ditto for FM LNA PD high 84 0x02 lnahi ditto for FM LNA PD high
96 -------------------------------------------------------------------- 85 0x03 lnalo ditto for FM LNA PD low
97 0x03 | lnalo | ditto for FM LNA PD low 86 0x04 fmagc1 FMAGC1 attenuator resistance
98 -------------------------------------------------------------------- 87 (see datasheet for more detail)
99 0x04 | fmagc1 | FMAGC1 attenuator resistance 88 0x05 fmagc2 ditto for FMAGC2
100 | | (see datasheet for more detail) 89 0x06 pgagain PGA gain in dB
101 -------------------------------------------------------------------- 90 0x07 fmwblang FM/WB LNA Gain in dB
102 0x05 | fmagc2 | ditto for FMAGC2 91 ============= ============== ====================================
103 --------------------------------------------------------------------
104 0x06 | pgagain | PGA gain in dB
105 --------------------------------------------------------------------
106 0x07 | fmwblang | FM/WB LNA Gain in dB
107 --------------------------------------------------------------------
108 92
109* /sys/kernel/debug/<device-name>/rsq 93* /sys/kernel/debug/<device-name>/rsq
110 This file contains information about parameters pertaining to 94 This file contains information about parameters pertaining to
111 RSQ(Received Signal Quality) 95 RSQ(Received Signal Quality)
112 96
113 The layout is: 97 The layout is:
114 Offset | Name | Description 98
115 ==================================================================== 99 ============= ============== ====================================
116 0x00 | multhint | 0 - multipath value has not crossed 100 Offset Name Description
117 | | the Multipath high threshold 101 ============= ============== ====================================
118 | | 1 - multipath value has crossed 102 0x00 multhint 0 - multipath value has not crossed
119 | | the Multipath high threshold 103 the Multipath high threshold
120 -------------------------------------------------------------------- 104 1 - multipath value has crossed
121 0x01 | multlint | ditto for Multipath low threshold 105 the Multipath high threshold
122 -------------------------------------------------------------------- 106 0x01 multlint ditto for Multipath low threshold
123 0x02 | snrhint | 0 - received signal's SNR has not 107 0x02 snrhint 0 - received signal's SNR has not
124 | | crossed high threshold 108 crossed high threshold
125 | | 1 - received signal's SNR has 109 1 - received signal's SNR has
126 | | crossed high threshold 110 crossed high threshold
127 -------------------------------------------------------------------- 111 0x03 snrlint ditto for low threshold
128 0x03 | snrlint | ditto for low threshold 112 0x04 rssihint ditto for RSSI high threshold
129 -------------------------------------------------------------------- 113 0x05 rssilint ditto for RSSI low threshold
130 0x04 | rssihint | ditto for RSSI high threshold 114 0x06 bltf Flag indicating if seek command
131 -------------------------------------------------------------------- 115 reached/wrapped seek band limit
132 0x05 | rssilint | ditto for RSSI low threshold 116 0x07 snr_ready Indicates that SNR metrics is ready
133 -------------------------------------------------------------------- 117 0x08 rssiready ditto for RSSI metrics
134 0x06 | bltf | Flag indicating if seek command 118 0x09 injside 0 - Low-side injection is being used
135 | | reached/wrapped seek band limit 119 1 - High-side injection is used
136 -------------------------------------------------------------------- 120 0x10 afcrl Flag indicating if AFC rails
137 0x07 | snr_ready | Indicates that SNR metrics is ready 121 0x11 valid Flag indicating if channel is valid
138 -------------------------------------------------------------------- 122 0x12 readfreq Current tuned frequency
139 0x08 | rssiready | ditto for RSSI metrics 123 0x14 freqoff Signed frequency offset in units of
140 -------------------------------------------------------------------- 124 2ppm
141 0x09 | injside | 0 - Low-side injection is being used 125 0x15 rssi Signed value of RSSI in dBuV
142 | | 1 - High-side injection is used 126 0x16 snr Signed RF SNR in dB
143 -------------------------------------------------------------------- 127 0x17 issi Signed Image Strength Signal
144 0x10 | afcrl | Flag indicating if AFC rails 128 indicator
145 -------------------------------------------------------------------- 129 0x18 lassi Signed Low side adjacent Channel
146 0x11 | valid | Flag indicating if channel is valid 130 Strength indicator
147 -------------------------------------------------------------------- 131 0x19 hassi ditto fpr High side
148 0x12 | readfreq | Current tuned frequency 132 0x20 mult Multipath indicator
149 -------------------------------------------------------------------- 133 0x21 dev Frequency deviation
150 0x14 | freqoff | Signed frequency offset in units of 134 0x24 assi Adjacent channel SSI
151 | | 2ppm 135 0x25 usn Ultrasonic noise indicator
152 -------------------------------------------------------------------- 136 0x26 pilotdev Pilot deviation in units of 100 Hz
153 0x15 | rssi | Signed value of RSSI in dBuV 137 0x27 rdsdev ditto for RDS
154 -------------------------------------------------------------------- 138 0x28 assidev ditto for ASSI
155 0x16 | snr | Signed RF SNR in dB 139 0x29 strongdev Frequency deviation
156 -------------------------------------------------------------------- 140 0x30 rdspi RDS PI code
157 0x17 | issi | Signed Image Strength Signal 141 ============= ============== ====================================
158 | | indicator
159 --------------------------------------------------------------------
160 0x18 | lassi | Signed Low side adjacent Channel
161 | | Strength indicator
162 --------------------------------------------------------------------
163 0x19 | hassi | ditto fpr High side
164 --------------------------------------------------------------------
165 0x20 | mult | Multipath indicator
166 --------------------------------------------------------------------
167 0x21 | dev | Frequency deviation
168 --------------------------------------------------------------------
169 0x24 | assi | Adjacent channel SSI
170 --------------------------------------------------------------------
171 0x25 | usn | Ultrasonic noise indicator
172 --------------------------------------------------------------------
173 0x26 | pilotdev | Pilot deviation in units of 100 Hz
174 --------------------------------------------------------------------
175 0x27 | rdsdev | ditto for RDS
176 --------------------------------------------------------------------
177 0x28 | assidev | ditto for ASSI
178 --------------------------------------------------------------------
179 0x29 | strongdev | Frequency deviation
180 --------------------------------------------------------------------
181 0x30 | rdspi | RDS PI code
182 --------------------------------------------------------------------
183 142
184* /sys/kernel/debug/<device-name>/rsq_primary 143* /sys/kernel/debug/<device-name>/rsq_primary
185 This file contains information about parameters pertaining to 144 This file contains information about parameters pertaining to