This file is indexed.

/usr/share/gtk-doc/html/hinawa/HinawaFwReq.html is in libhinawa-dev 0.8.2-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HinawaFwReq: Hinawa Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Hinawa Reference Manual">
<link rel="up" href="libhinawa.html" title="libhinawa">
<link rel="prev" href="HinawaFwResp.html" title="HinawaFwResp">
<link rel="next" href="HinawaFwFcp.html" title="HinawaFwFcp">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#HinawaFwReq.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#HinawaFwReq.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#HinawaFwReq.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libhinawa.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="HinawaFwResp.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="HinawaFwFcp.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="HinawaFwReq"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="HinawaFwReq.top_of_page"></a>HinawaFwReq</span></h2>
<p>HinawaFwReq — A transaction executor to a FireWire unit</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="HinawaFwReq.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="HinawaFwReq.html#hinawa-fw-req-write" title="hinawa_fw_req_write ()">hinawa_fw_req_write</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="HinawaFwReq.html#hinawa-fw-req-read" title="hinawa_fw_req_read ()">hinawa_fw_req_read</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="HinawaFwReq.html#hinawa-fw-req-lock" title="hinawa_fw_req_lock ()">hinawa_fw_req_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="HinawaFwReq.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="HinawaFwReq.html#HinawaFwReq--timeout" title="The “timeout” property">timeout</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="HinawaFwReq.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> HinawaFwReq
</pre>
</div>
<div class="refsect1">
<a name="HinawaFwReq.description"></a><h2>Description</h2>
<p>A HinawaFwReq supports three types of transactions in IEEE 1212:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>read</p></li>
<li class="listitem"><p>write</p></li>
<li class="listitem"><p>lock</p></li>
</ul></div>
<p>Any of transaction frames should be aligned to 32bit (quadlet).
This class is an application of Linux FireWire subsystem. All of operations
utilize ioctl(2) with subsystem specific request commands.</p>
</div>
<div class="refsect1">
<a name="HinawaFwReq.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="hinawa-fw-req-write"></a><h3>hinawa_fw_req_write ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
hinawa_fw_req_write (<em class="parameter"><code><a class="link" href="HinawaFwReq.html" title="HinawaFwReq"><span class="type">HinawaFwReq</span></a> *self</code></em>,
                     <em class="parameter"><code><a class="link" href="HinawaFwUnit.html" title="HinawaFwUnit"><span class="type">HinawaFwUnit</span></a> *unit</code></em>,
                     <em class="parameter"><code><span class="type">guint64</span> addr</code></em>,
                     <em class="parameter"><code><span class="type">GArray</span> *frame</code></em>,
                     <em class="parameter"><code><span class="type">GError</span> **exception</code></em>);</pre>
<p>Execute write transactions to the given unit.</p>
<div class="refsect3">
<a name="hinawa-fw-req-write.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="HinawaFwReq.html" title="HinawaFwReq"><span class="type">HinawaFwReq</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>A <a class="link" href="HinawaFwUnit.html" title="HinawaFwUnit"><span class="type">HinawaFwUnit</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>addr</p></td>
<td class="parameter_description"><p>A destination address of target device</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>frame</p></td>
<td class="parameter_description"><p>a 32bit array. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>exception</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hinawa-fw-req-read"></a><h3>hinawa_fw_req_read ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
hinawa_fw_req_read (<em class="parameter"><code><a class="link" href="HinawaFwReq.html" title="HinawaFwReq"><span class="type">HinawaFwReq</span></a> *self</code></em>,
                    <em class="parameter"><code><a class="link" href="HinawaFwUnit.html" title="HinawaFwUnit"><span class="type">HinawaFwUnit</span></a> *unit</code></em>,
                    <em class="parameter"><code><span class="type">guint64</span> addr</code></em>,
                    <em class="parameter"><code><span class="type">GArray</span> *frame</code></em>,
                    <em class="parameter"><code><span class="type">guint</span> quads</code></em>,
                    <em class="parameter"><code><span class="type">GError</span> **exception</code></em>);</pre>
<p>Execute read transaction to the given unit.</p>
<div class="refsect3">
<a name="hinawa-fw-req-read.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="HinawaFwReq.html" title="HinawaFwReq"><span class="type">HinawaFwReq</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>A <a class="link" href="HinawaFwUnit.html" title="HinawaFwUnit"><span class="type">HinawaFwUnit</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>addr</p></td>
<td class="parameter_description"><p>A destination address of target device</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>frame</p></td>
<td class="parameter_description"><p>a 32bit array. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>quads</p></td>
<td class="parameter_description"><p>the number of quadlets to read</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>exception</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hinawa-fw-req-lock"></a><h3>hinawa_fw_req_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
hinawa_fw_req_lock (<em class="parameter"><code><a class="link" href="HinawaFwReq.html" title="HinawaFwReq"><span class="type">HinawaFwReq</span></a> *self</code></em>,
                    <em class="parameter"><code><a class="link" href="HinawaFwUnit.html" title="HinawaFwUnit"><span class="type">HinawaFwUnit</span></a> *unit</code></em>,
                    <em class="parameter"><code><span class="type">guint64</span> addr</code></em>,
                    <em class="parameter"><code><span class="type">GArray</span> **frame</code></em>,
                    <em class="parameter"><code><span class="type">GError</span> **exception</code></em>);</pre>
<p>Execute lock transaction to the given unit.</p>
<div class="refsect3">
<a name="hinawa-fw-req-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="HinawaFwReq.html" title="HinawaFwReq"><span class="type">HinawaFwReq</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>A <a class="link" href="HinawaFwUnit.html" title="HinawaFwUnit"><span class="type">HinawaFwUnit</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>addr</p></td>
<td class="parameter_description"><p>A destination address of target device</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>frame</p></td>
<td class="parameter_description"><p>a 32bit array. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint32][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>exception</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="HinawaFwReq.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="HinawaFwReq.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="HinawaFwReq--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3>
<pre class="programlisting">  “timeout”                  <span class="type">guint</span></pre>
<p>An elapse to expire waiting for response by ms unit.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: &gt;= 10</p>
<p>Default value: 10</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>