forked from ~ljy/RK356X_SDK_RELEASE

hc
2023-12-11 d2ccde1c8e90d38cee87a1b0309ad2827f3fd30d
kernel/Documentation/sound/designs/tracepoints.rst
....@@ -34,20 +34,20 @@
3434 interaction between applications and ALSA PCM core. Once decided, runtime of
3535 the PCM substream keeps the parameters.
3636
37
-The parameters are described in :c:type:`struct snd_pcm_hw_params`. This
37
+The parameters are described in struct snd_pcm_hw_params. This
3838 structure includes several types of parameters. Applications set preferable
3939 value to these parameters, then execute ioctl(2) with SNDRV_PCM_IOCTL_HW_REFINE
4040 or SNDRV_PCM_IOCTL_HW_PARAMS. The former is used just for refining available
4141 set of parameters. The latter is used for an actual decision of the parameters.
4242
43
-The :c:type:`struct snd_pcm_hw_params` structure has below members:
43
+The struct snd_pcm_hw_params structure has below members:
4444
4545 ``flags``
4646 Configurable. ALSA PCM core and some drivers handle this flag to select
4747 convenient parameters or change their behaviour.
4848 ``masks``
4949 Configurable. This type of parameter is described in
50
- :c:type:`struct snd_mask` and represent mask values. As of PCM protocol
50
+ struct snd_mask and represent mask values. As of PCM protocol
5151 v2.0.13, three types are defined.
5252
5353 - SNDRV_PCM_HW_PARAM_ACCESS
....@@ -55,7 +55,7 @@
5555 - SNDRV_PCM_HW_PARAM_SUBFORMAT
5656 ``intervals``
5757 Configurable. This type of parameter is described in
58
- :c:type:`struct snd_interval` and represent values with a range. As of
58
+ struct snd_interval and represent values with a range. As of
5959 PCM protocol v2.0.13, twelve types are defined.
6060
6161 - SNDRV_PCM_HW_PARAM_SAMPLE_BITS
....@@ -78,7 +78,7 @@
7878 are going to be changed.
7979 ``cmask``
8080 Read-only. After returning from ioctl(2), buffer in user space for
81
- :c:type:`struct snd_pcm_hw_params` includes result of each operation.
81
+ struct snd_pcm_hw_params includes result of each operation.
8282 This mask represents which mask/interval parameter is actually changed.
8383 ``info``
8484 Read-only. This represents hardware/driver capabilities as bit flags
....@@ -110,10 +110,10 @@
110110 value to this parameter but some drivers intentionally set zero with
111111 a care of hardware design or data transmission protocol.
112112
113
-ALSA PCM core handles buffer of :c:type:`struct snd_pcm_hw_params` when
113
+ALSA PCM core handles buffer of struct snd_pcm_hw_params when
114114 applications execute ioctl(2) with SNDRV_PCM_HW_REFINE or SNDRV_PCM_HW_PARAMS.
115115 Parameters in the buffer are changed according to
116
-:c:type:`struct snd_pcm_hardware` and rules of constraints in the runtime. The
116
+struct snd_pcm_hardware and rules of constraints in the runtime. The
117117 structure describes capabilities of handled hardware. The rules describes
118118 dependencies on which a parameter is decided according to several parameters.
119119 A rule has a callback function, and drivers can register arbitrary functions
....@@ -121,17 +121,17 @@
121121 runtime as a default.
122122
123123 Each driver can join in the interaction as long as it prepared for two stuffs
124
-in a callback of :c:type:`struct snd_pcm_ops.open`.
124
+in a callback of struct snd_pcm_ops.open.
125125
126126 1. In the callback, drivers are expected to change a member of
127
- :c:type:`struct snd_pcm_hardware` type in the runtime, according to
127
+ struct snd_pcm_hardware type in the runtime, according to
128128 capacities of corresponding hardware.
129129 2. In the same callback, drivers are also expected to register additional rules
130130 of constraints into the runtime when several parameters have dependencies
131131 due to hardware design.
132132
133133 The driver can refers to result of the interaction in a callback of
134
-:c:type:`struct snd_pcm_ops.hw_params`, however it should not change the
134
+struct snd_pcm_ops.hw_params, however it should not change the
135135 content.
136136
137137 Tracepoints in this category are designed to trace changes of the
....@@ -163,7 +163,7 @@
163163 type, the fields represent hexadecimal dump of content of the parameter. For
164164 parameters of interval type, the fields represent values of each member of
165165 ``empty``, ``integer``, ``openmin``, ``min``, ``max``, ``openmax`` in
166
-:c:type:`struct snd_interval` in this order.
166
+struct snd_interval in this order.
167167
168168 Tracepoints in drivers
169169 ======================