-
Notifications
You must be signed in to change notification settings - Fork 2
/
Hinawa-4.0.gir
2640 lines (2626 loc) · 118 KB
/
Hinawa-4.0.gir
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GLib" version="2.0"/>
<include name="GObject" version="2.0"/>
<package name="hinawa"/>
<c:include name="hinawa.h"/>
<namespace name="Hinawa"
version="4.0"
shared-library="libhinawa.so.4"
c:identifier-prefixes="Hinawa"
c:symbol-prefixes="hinawa_">
<record name="CycleTime"
c:type="HinawaCycleTime"
opaque="1"
glib:type-name="HinawaCycleTime"
glib:get-type="hinawa_cycle_time_get_type"
c:symbol-prefix="cycle_time">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="4">A boxed object to express data of cycle time.
A [struct@CycleTime] expresses the value of cycle time of 1394 OHCI as well as Linux system
time referring to clock_id.</doc>
<source-position filename="src/cycle_time.h" line="11"/>
<constructor name="new"
c:identifier="hinawa_cycle_time_new"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="26">Allocate and return an instance of [struct@CycleTime].</doc>
<source-position filename="src/cycle_time.h" line="15"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="31">An instance of [struct@CycleTime].</doc>
<type name="CycleTime" c:type="HinawaCycleTime*"/>
</return-value>
</constructor>
<method name="compute_tstamp"
c:identifier="hinawa_cycle_time_compute_tstamp"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="135">Compute second count and cycle count from unsigned 16 bit integer value retrieved by Asynchronous
Transmit (AT), Asynchronous Receive(AR), Isochronous Transmit (IT), and Isochronous Receive (IR)
contexts of 1394 OHCI. The second count is completed with the internal value read from the
CYCLE_TIME register. For the precise computation, the method should be called in the condition
that the timing between receipt of time stamp and access to CYCLE_TIME register is within 8
seconds.</doc>
<source-position filename="src/cycle_time.h" line="26"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="137">A [struct@CycleTime].</doc>
<type name="CycleTime" c:type="const HinawaCycleTime*"/>
</instance-parameter>
<parameter name="tstamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="138">The value of time stamp retrieved from each context of 1394 OHCI.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="isoc_cycle"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="139">The result to parse the time stamp. The
first element is for 7 bits of second field in the format of IEEE 1394 CYCLE_TIME
register, up to 127. The second element is for 13 bits of cycle field in the format,
up to 7,999.</doc>
<array zero-terminated="0" c:type="guint*" fixed-size="2">
<type name="guint" c:type="guint"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_clock_id"
c:identifier="hinawa_cycle_time_get_clock_id"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="57">Get the ID of clock for timestamp.</doc>
<source-position filename="src/cycle_time.h" line="20"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="59">A [struct@CycleTime].</doc>
<type name="CycleTime" c:type="const HinawaCycleTime*"/>
</instance-parameter>
<parameter name="clock_id"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="60">The numeric ID of clock source for the reference timestamp.
One of CLOCK_REALTIME(0), CLOCK_MONOTONIC(1), and CLOCK_MONOTONIC_RAW(4) is available
UAPI of Linux kernel.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_fields"
c:identifier="hinawa_cycle_time_get_fields"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="94">Get the value of cycle time in 1394 OHCI hardware. The first element of array expresses the
value of sec field, up to 127. The second element of array expresses the value of cycle field,
up to 7999. The third element of array expresses the value of offset field, up to 3071.</doc>
<source-position filename="src/cycle_time.h" line="22"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="96">A [struct@CycleTime].</doc>
<type name="CycleTime" c:type="const HinawaCycleTime*"/>
</instance-parameter>
<parameter name="fields"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="97">The value of cycle time register of 1394
OHCI hardware, including three elements; second, cycle, and offset in its order.</doc>
<array zero-terminated="0" c:type="guint16*" fixed-size="3">
<type name="guint16" c:type="guint16"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_raw"
c:identifier="hinawa_cycle_time_get_raw"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="113">Get the value of cycle time in 1394 OHCI hardware.</doc>
<source-position filename="src/cycle_time.h" line="24"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="115">A [struct@CycleTime].</doc>
<type name="CycleTime" c:type="const HinawaCycleTime*"/>
</instance-parameter>
<parameter name="raw"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="116">The raw value for CYCLE_TIME register.</doc>
<type name="guint32" c:type="guint32*"/>
</parameter>
</parameters>
</method>
<method name="get_system_time"
c:identifier="hinawa_cycle_time_get_system_time"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="40">Get system time with enough size of strorage. The timestamp refers to clock_id available by
[[email protected]_clock_id].</doc>
<source-position filename="src/cycle_time.h" line="17"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="42">A [struct@CycleTime].</doc>
<type name="CycleTime" c:type="const HinawaCycleTime*"/>
</instance-parameter>
<parameter name="tv_sec"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="43">The second part of timestamp.</doc>
<type name="gint64" c:type="gint64*"/>
</parameter>
<parameter name="tv_nsec"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="44">The nanosecond part of timestamp.</doc>
<type name="gint32" c:type="gint32*"/>
</parameter>
</parameters>
</method>
<function name="parse_tstamp"
c:identifier="hinawa_cycle_time_parse_tstamp"
version="2.6">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="169">Parse second count and cycle count from unsigned 16 bit integer value retrieved by Asynchronous
Transmit (AT), Asynchronous Receive(AR), Isochronous Transmit (IT), and Isochronous Receive (IR)
contexts of 1394 OHCI.</doc>
<source-position filename="src/cycle_time.h" line="28"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tstamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="171">The value of time stamp retrieved from each context of 1394 OHCI.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="isoc_cycle"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/cycle_time.c"
line="172">The result to parse the time stamp. The
first element is for three order bits of second field in the format of IEEE 1394
CYCLE_TIME register, up to 7. The second element is for 13 bits of cycle field in
the format, up to 7,999.</doc>
<array zero-terminated="0" c:type="guint*" fixed-size="2">
<type name="guint" c:type="guint"/>
</array>
</parameter>
</parameters>
</function>
</record>
<class name="FwFcp"
c:symbol-prefix="fw_fcp"
c:type="HinawaFwFcp"
parent="FwResp"
glib:type-name="HinawaFwFcp"
glib:get-type="hinawa_fw_fcp_get_type"
glib:type-struct="FwFcpClass">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="9">A FCP transaction executor to node in IEEE 1394 bus.
[class@FwFcp] supports Function Control Protocol (FCP) in IEC 61883-1. FCP transaction consists
of a pair of asynchronous transactions for command and response, while the protocol has no
mechanism to match them. In AV/C Digital Interface Command Set General Specification Version 4.2
(Sep 1 2004, 1394TA), they are loosely matched by the content of their frames, and this class
employs the way.
Any of transaction frames should be aligned to 8 bit (1 byte). This class is an application of
[class@FwReq] / [class@FwResp].</doc>
<source-position filename="src/fw_fcp.h" line="36"/>
<constructor name="new" c:identifier="hinawa_fw_fcp_new" version="1.3">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="210">Instantiate [class@FwFcp] object and return the instance.</doc>
<source-position filename="src/fw_fcp.h" line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="215">an instance of [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</return-value>
</constructor>
<virtual-method name="responded" version="4.0">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="20">Class closure for the [signal@FwFcp::responded] signal.</doc>
<source-position filename="src/fw_fcp.h" line="34"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="22">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
<parameter name="generation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="23">The generation of bus topology.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="tstamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="24">The time stamp at which the request subaction arrived for the response of FCP
transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="26">The array with elements for byte
data in the response of Function Control Protocol.</doc>
<array length="3" zero-terminated="0" c:type="const guint8*">
<type name="guint8"/>
</array>
</parameter>
<parameter name="frame_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="28">The number of elements of the array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<method name="avc_transaction"
c:identifier="hinawa_fw_fcp_avc_transaction"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="478">Finish the pair of asynchronous transaction for AV/C command and response. The @timeout_ms
parameter is used to wait for response transaction since the command transaction is initiated.
The timeout is not expanded in the case that AV/C INTERIM status arrived, thus the caller should
expand the timeout in advance for the case.</doc>
<source-position filename="src/fw_fcp.h" line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="499">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="480">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
<parameter name="cmd" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="481">An array with elements for request byte data. The value of
this argument should point to the array and immutable.</doc>
<array length="1" zero-terminated="0" c:type="const guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="cmd_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="483">The size of array for request in byte unit.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="resp"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="484">An array with elements for response 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.</doc>
<array length="3" zero-terminated="0" c:type="guint8**">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="resp_size"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="488">The size of array for response in byte unit. The value of this argument should point to
the numerical number and mutable.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="timeout_ms" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="490">The timeout to wait for response transaction since command transactions finishes.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="avc_transaction_with_tstamp"
c:identifier="hinawa_fw_fcp_avc_transaction_with_tstamp"
version="2.6"
throws="1">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="348">Finish the pair of asynchronous transaction for AV/C command and response. The @timeout_ms
parameter is used to wait for response transaction since the command transaction is initiated.
The timeout is not expanded in the case that AV/C INTERIM status arrived, thus the caller should
expand the timeout in advance for the case.</doc>
<source-position filename="src/fw_fcp.h" line="52"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="374">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="350">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
<parameter name="cmd" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="351">An array with elements for request byte data. The value of
this argument should point to the array and immutable.</doc>
<array length="1" zero-terminated="0" c:type="const guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="cmd_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="353">The size of array for request in byte unit.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="resp"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="354">An array with elements for response 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.</doc>
<array length="3" zero-terminated="0" c:type="guint8**">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="resp_size"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="358">The size of array for response in byte unit. The value of this argument should point
to the numerical number and mutable.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="tstamp"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="360">The array with three elements for time
stamps. The first element is for the isochronous cycle at which the request was sent
for the command of FCP transaction. The second element is for the isochronous cycle at
which the response arrived for the command of FCP transaction. The third element is for
the isochronous cycle at which the request was sent for the response of FCP transaction.</doc>
<array zero-terminated="0" c:type="guint*" fixed-size="3">
<type name="guint" c:type="guint"/>
</array>
</parameter>
<parameter name="timeout_ms" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="365">The timeout to wait for response transaction since command transactions finishes.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="bind"
c:identifier="hinawa_fw_fcp_bind"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="638">Start to listen to FCP responses.</doc>
<source-position filename="src/fw_fcp.h" line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="646">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="640">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
<parameter name="node" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="641">A [class@FwNode].</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</parameter>
</parameters>
</method>
<method name="command"
c:identifier="hinawa_fw_fcp_command"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="276">Transfer command frame for FCP. When receiving response frame for FCP, [signal@FwFcp::responded]
signal is emitted.</doc>
<source-position filename="src/fw_fcp.h" line="44"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="289">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="278">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
<parameter name="cmd" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="279">An array with elements for request byte data. The value of this
argument should point to the array and immutable.</doc>
<array length="1" zero-terminated="0" c:type="const guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="cmd_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="281">The size of array for request in byte unit.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="timeout_ms" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="282">The timeout to wait for response subaction of transaction for command frame.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="command_with_tstamp"
c:identifier="hinawa_fw_fcp_command_with_tstamp"
version="2.6"
throws="1">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="223">Transfer command frame for FCP. When receiving response frame for FCP, [signal@FwFcp::responded]
signal is emitted.
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_MAXUINT16).</doc>
<source-position filename="src/fw_fcp.h" line="46"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="245">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="225">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
<parameter name="cmd" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="226">An array with elements for request byte data. The value of this
argument should point to the array and immutable.</doc>
<array length="1" zero-terminated="0" c:type="const guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="cmd_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="228">The size of array for request in byte unit.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="tstamp"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="229">The array with two elements for time stamps.
The first element is for the isochronous cycle at which the request arrived. The second
element is for the isochronous cycle at which the response was sent.</doc>
<array zero-terminated="0" c:type="guint*" fixed-size="2">
<type name="guint" c:type="guint"/>
</array>
</parameter>
<parameter name="timeout_ms" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="232">The timeout to wait for response subaction of transaction for command frame.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="unbind" c:identifier="hinawa_fw_fcp_unbind" version="1.4">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="687">Stop to listen to FCP responses. Any pending transactions are forced to be aborted.</doc>
<source-position filename="src/fw_fcp.h" line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="689">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</instance-parameter>
</parameters>
</method>
<property name="is-bound"
version="2.0"
transfer-ownership="none"
default-value="FALSE">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="149">Whether this protocol is bound to any instance of HinawaFwNode.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent_instance">
<type name="FwResp" c:type="HinawaFwResp"/>
</field>
<glib:signal name="responded" when="last" version="4.0">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="167">Emitted when the node transfers asynchronous packet as response for FCP and the process
successfully read the content of packet.
The values 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, the value of
@tstamp argument has invalid value (=G_MAXUINT).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="generation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="170">The generation of bus topology.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="tstamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="171">The time stamp at which the request arrived for the response of FCP
transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="173">The array with elements for byte
data of response for FCP.</doc>
<array length="3" zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="frame_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="175">The number of elements of the array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="FwFcpClass"
c:type="HinawaFwFcpClass"
glib:is-gtype-struct-for="FwFcp">
<source-position filename="src/fw_fcp.h" line="36"/>
<field name="parent_class">
<type name="FwRespClass" c:type="HinawaFwRespClass"/>
</field>
<field name="responded">
<callback name="responded">
<source-position filename="src/fw_fcp.h" line="34"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="22">A [class@FwFcp].</doc>
<type name="FwFcp" c:type="HinawaFwFcp*"/>
</parameter>
<parameter name="generation" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="23">The generation of bus topology.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="tstamp" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="24">The time stamp at which the request subaction arrived for the response of FCP
transaction.</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="frame" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="26">The array with elements for byte
data in the response of Function Control Protocol.</doc>
<array length="4" zero-terminated="0" c:type="const guint8*">
<type name="guint8"/>
</array>
</parameter>
<parameter name="frame_size" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.h"
line="28">The number of elements of the array.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<enumeration name="FwFcpError"
version="2.1"
glib:type-name="HinawaFwFcpError"
glib:get-type="hinawa_fw_fcp_error_get_type"
c:type="HinawaFwFcpError"
glib:error-domain="hinawa-fw-fcp-error-quark">
<doc xml:space="preserve"
filename="src/hinawa_enum_types.h"
line="152">A set of error code for [[email protected]] for operations in [class@FwFcp].</doc>
<member name="timeout"
value="0"
c:identifier="HINAWA_FW_FCP_ERROR_TIMEOUT"
glib:nick="timeout"
glib:name="HINAWA_FW_FCP_ERROR_TIMEOUT">
<doc xml:space="preserve"
filename="src/hinawa_enum_types.h"
line="154">The transaction is canceled due to response timeout.</doc>
</member>
<member name="large_resp"
value="1"
c:identifier="HINAWA_FW_FCP_ERROR_LARGE_RESP"
glib:nick="large-resp"
glib:name="HINAWA_FW_FCP_ERROR_LARGE_RESP">
<doc xml:space="preserve"
filename="src/hinawa_enum_types.h"
line="155">The size of response is larger than expected.</doc>
</member>
<member name="aborted"
value="2"
c:identifier="HINAWA_FW_FCP_ERROR_ABORTED"
glib:nick="aborted"
glib:name="HINAWA_FW_FCP_ERROR_ABORTED">
<doc xml:space="preserve"
filename="src/hinawa_enum_types.h"
line="156">The transaction is aborted due to bus reset.</doc>
</member>
<function name="quark"
c:identifier="hinawa_fw_fcp_error_quark"
version="2.1">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="23">Return the [[email protected]] for [[email protected]] which has code in [error@FwFcpError].</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_fcp.c"
line="30">A [[email protected]].</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<class name="FwNode"
c:symbol-prefix="fw_node"
c:type="HinawaFwNode"
version="1.4"
parent="GObject.Object"
glib:type-name="HinawaFwNode"
glib:get-type="hinawa_fw_node_get_type"
glib:type-struct="FwNodeClass">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="11">An event listener for node in IEEE 1394 bus.
[class@FwNode] listens to any events for an associated node in IEEE 1394 bus. Additionally,
it provides some methods to retrieve fundamental information about the bus.</doc>
<source-position filename="src/fw_node.h" line="40"/>
<constructor name="new" c:identifier="hinawa_fw_node_new" version="1.4">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="307">Instantiate [class@FwNode] object and return the instance.</doc>
<source-position filename="src/fw_node.h" line="42"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="312">an instance of [class@FwNode].</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</return-value>
</constructor>
<virtual-method name="bus_update" version="1.4">
<doc xml:space="preserve"
filename="src/fw_node.h"
line="20">Class closure for the [signal@FwNode::bus-update].</doc>
<source-position filename="src/fw_node.h" line="28"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.h"
line="22">A [class@FwNode].</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="disconnected" version="1.4">
<doc xml:space="preserve"
filename="src/fw_node.h"
line="30">Class closure for the [signal@FwNode::disconnected].</doc>
<source-position filename="src/fw_node.h" line="38"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.h"
line="32">A [class@FwNode]</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="create_source"
c:identifier="hinawa_fw_node_create_source"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="595">Create [[email protected]] for [[email protected]] to dispatch events for the node on
IEEE 1394 bus.</doc>
<source-position filename="src/fw_node.h" line="52"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="604">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="597">A [class@FwNode].</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</instance-parameter>
<parameter name="gsrc"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="598">A [[email protected]].</doc>
<type name="GLib.Source" c:type="GSource**"/>
</parameter>
</parameters>
</method>
<method name="get_config_rom"
c:identifier="hinawa_fw_node_get_config_rom"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="415">Get cached content of configuration ROM aligned to big-endian.</doc>
<source-position filename="src/fw_node.h" line="46"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="424">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="417">A [class@FwNode]</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</instance-parameter>
<parameter name="image"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="418">The content of configuration ROM.</doc>
<array length="1" zero-terminated="0" c:type="const guint8**">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="length"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="419">The number of bytes consists of the configuration ROM.</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</method>
<method name="open"
c:identifier="hinawa_fw_node_open"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="353">Open Linux FireWire character device to operate node in IEEE 1394 bus.</doc>
<source-position filename="src/fw_node.h" line="44"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="363">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="355">A [class@FwNode]</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="356">A path to Linux FireWire character device</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="open_flag" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="357">The flag of `open(2)` system call. `O_RDONLY` is fulfilled internally.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="read_cycle_time"
c:identifier="hinawa_fw_node_read_cycle_time"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="454">Read current value of CYCLE_TIME register in 1394 OHCI hardware dedicated to communicate with
the associated node in IEEE 1394 bus.</doc>
<source-position filename="src/fw_node.h" line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="465">TRUE if the overall operation finishes successfully, otherwise FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="456">A [class@FwNode]</doc>
<type name="FwNode" c:type="HinawaFwNode*"/>
</instance-parameter>
<parameter name="clock_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="src/fw_node.c"
line="457">The numeric ID of clock source for the reference timestamp. One of CLOCK_REALTIME(0),
CLOCK_MONOTONIC(1), and CLOCK_MONOTONIC_RAW(4) is available in UAPI of Linux kernel.</doc>
<type name="gint" c:type="gint"/>