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
275
276
277
278
279
// SPDX-License-Identifier: MIT
use crate::*;
/// Trait containing the rest of [`struct@FwReq`] methods.
///
/// # Implementors
///
/// [`FwReq`][struct@crate::FwReq]
pub trait FwReqExtManual {
/// Execute request subaction of transaction to the given node according to given code. When the
/// response subaction arrives and running event dispatcher reads the contents,
/// [`responded`][struct@crate::FwReq#responded] signal handler is called.
/// ## `node`
/// A [`FwNode`][crate::FwNode].
/// ## `tcode`
/// A transaction code of [`FwTcode`][crate::FwTcode].
/// ## `addr`
/// A destination address of target device
/// ## `length`
/// The range of address in byte unit.
/// ## `frame`
/// An array with elements for byte data. Callers should
/// give it for buffer with enough space against the request since this library performs no
/// reallocation. Due to the reason, the value of this argument should point to the pointer
/// to the array and immutable. The content of array is mutable for read and lock
/// transaction.
#[doc(alias = "hinawa_fw_req_request")]
fn request<P: IsA<FwNode>>(
&self,
node: &P,
tcode: FwTcode,
addr: u64,
length: usize,
frame: &mut [u8],
) -> Result<(), glib::Error>;
/// Execute request subaction of transaction to the given node according to given code, then wait
/// for response subaction within the given timeout.
///
/// Each value of @tstamp is unsigned 16 bit integer including higher 3 bits for three low order bits
/// of second field and the rest 13 bits for cycle field in the format of IEEE 1394 CYCLE_TIMER register.
///
/// If the version of kernel ABI for Linux FireWire subsystem is less than 6, each element of @tstamp
/// has invalid value (=G_MAXUINT).
/// ## `node`
/// A [`FwNode`][crate::FwNode].
/// ## `tcode`
/// A transaction code of [`FwTcode`][crate::FwTcode].
/// ## `addr`
/// A destination address of target device
/// ## `length`
/// The range of address in byte unit.
/// ## `frame`
/// An array with elements for byte data. Callers should
/// give it for buffer with enough space against the request since this library performs no
/// reallocation. Due to the reason, the value of this argument should point to the pointer
/// to the array and immutable. The content of array is mutable for read and lock
/// transaction.
/// ## `timeout_ms`
/// The timeout to wait for the response subaction of transaction since the request
/// subaction is initiated, in milliseconds.
///
/// # Returns
///
/// TRUE if the overall operation finishes successfully, otherwise FALSE.
///
/// ## `tstamp`
/// The array with two elements for time stamps.
/// The first element is for the isochronous cycle at which the request subaction was sent.
/// The second element is for the isochronous cycle at which the response subaction arrived.
#[doc(alias = "hinawa_fw_req_transaction_with_tstamp")]
fn transaction_with_tstamp<P: IsA<FwNode>>(
&self,
node: &P,
tcode: FwTcode,
addr: u64,
length: usize,
frame: &mut [u8],
timeout_ms: u32,
) -> Result<[u32; 2], glib::Error>;
/// Execute request subaction of transaction to the given node according to given code, then wait
/// for response subaction within the value of timeout argument. The function is a thin wrapper to
/// [`FwReqExtManual::transaction_with_tstamp()`][crate::prelude::FwReqExtManual::transaction_with_tstamp()].
/// ## `node`
/// A [`FwNode`][crate::FwNode].
/// ## `tcode`
/// A transaction code of [`FwTcode`][crate::FwTcode].
/// ## `addr`
/// A destination address of target device
/// ## `length`
/// The range of address in byte unit.
/// ## `frame`
/// An array with elements for byte data. Callers should
/// give it for buffer with enough space against the request since this library performs no
/// reallocation. Due to the reason, the value of this argument should point to the pointer
/// to the array and immutable. The content of array is mutable for read and lock
/// transaction.
/// ## `timeout_ms`
/// The timeout to wait for response subaction of the transaction since request
/// subaction is initiated, in milliseconds.
///
/// # Returns
///
/// TRUE if the overall operation finishes successfully, otherwise FALSE.
#[doc(alias = "hinawa_fw_req_transaction")]
fn transaction<P: IsA<FwNode>>(
&self,
node: &P,
tcode: FwTcode,
addr: u64,
length: usize,
frame: &mut [u8],
timeout_ms: u32,
) -> Result<(), glib::Error>;
/// Emitted when the node transfers asynchronous packet as response subaction for the
/// transaction and the process successfully reads the content of packet from Linux firewire
/// subsystem.
///
/// The values of @request_tstamp and @response_tstamp are unsigned 16 bit integer including
/// higher 3 bits for three low order bits of second field and the rest 13 bits for cycle
/// field in the format of IEEE 1394 CYCLE_TIMER register.
///
/// If the version of kernel ABI for Linux FireWire subsystem is less than 6, the
/// @request_tstamp and @response_tstamp argument has invalid value (=G_MAXUINT).
///
/// ## `rcode`
/// One of [`FwRcode`][crate::FwRcode].
/// ## `request_tstamp`
/// The isochronous cycle at which the request was sent.
/// ## `response_tstamp`
/// The isochronous cycle at which the response arrived.
/// ## `frame`
/// The array with elements for byte data of response subaction for transaction.
#[doc(alias = "responded")]
fn connect_responded<F>(&self, f: F) -> SignalHandlerId
where
F: Fn(&Self, FwRcode, u32, u32, &[u8]) + 'static;
}
impl<O: IsA<FwReq>> FwReqExtManual for O {
fn request<P: IsA<FwNode>>(
&self,
node: &P,
tcode: FwTcode,
addr: u64,
length: usize,
frame: &mut [u8],
) -> Result<(), glib::Error> {
unsafe {
let mut frame_size = frame.len();
let mut error = std::ptr::null_mut();
let is_ok = ffi::hinawa_fw_req_request(
self.as_ref().to_glib_none().0,
node.as_ref().to_glib_none().0,
tcode.into_glib(),
addr,
length,
&mut frame.as_mut_ptr(),
&mut frame_size,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
fn transaction_with_tstamp<P: IsA<FwNode>>(
&self,
node: &P,
tcode: FwTcode,
addr: u64,
length: usize,
frame: &mut [u8],
timeout_ms: u32,
) -> Result<[u32; 2], glib::Error> {
unsafe {
let mut frame_size = frame.len();
let mut tstamp = [0; 2];
let mut error = std::ptr::null_mut();
let is_ok = ffi::hinawa_fw_req_transaction_with_tstamp(
self.as_ref().to_glib_none().0,
node.as_ref().to_glib_none().0,
tcode.into_glib(),
addr,
length,
&mut frame.as_mut_ptr(),
&mut frame_size,
&mut tstamp,
timeout_ms,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(tstamp)
} else {
Err(from_glib_full(error))
}
}
}
fn transaction<P: IsA<FwNode>>(
&self,
node: &P,
tcode: FwTcode,
addr: u64,
length: usize,
frame: &mut [u8],
timeout_ms: u32,
) -> Result<(), glib::Error> {
unsafe {
let mut frame_size = frame.len();
let mut error = std::ptr::null_mut();
let is_ok = ffi::hinawa_fw_req_transaction(
self.as_ref().to_glib_none().0,
node.as_ref().to_glib_none().0,
tcode.into_glib(),
addr,
length,
&mut frame.as_mut_ptr(),
&mut frame_size,
timeout_ms,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
fn connect_responded<F>(&self, f: F) -> SignalHandlerId
where
F: Fn(&Self, FwRcode, u32, u32, &[u8]) + 'static,
{
unsafe extern "C" fn responded_trampoline<P, F>(
this: *mut ffi::HinawaFwReq,
rcode: ffi::HinawaFwRcode,
request_tstamp: std::ffi::c_uint,
response_tstamp: std::ffi::c_uint,
frame: *const u8,
length: std::ffi::c_uint,
f: glib::ffi::gpointer,
) where
P: IsA<FwReq>,
F: Fn(&P, FwRcode, u32, u32, &[u8]) + 'static,
{
let f: &F = &*(f as *const F);
f(
&FwReq::from_glib_borrow(this).unsafe_cast_ref(),
from_glib(rcode),
request_tstamp,
response_tstamp,
std::slice::from_raw_parts(frame, length as usize),
)
}
unsafe {
let f: std::boxed::Box<F> = std::boxed::Box::new(f);
connect_raw(
self.as_ptr() as *mut _,
c"responded".as_ptr() as *const _,
Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
responded_trampoline::<Self, F> as *const (),
)),
std::boxed::Box::into_raw(f),
)
}
}
}