hailort-sys 0.1.1

Raw FFI bindings to the HailoRT C runtime library
Documentation
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
//! Raw `extern "C"` declarations for every public HailoRT function.
//!
//! All functions here are `unsafe`.  The `#[link(name = "hailort")]`
//! attribute instructs the linker to pull in `libhailort.so`; `build.rs`
//! tells Cargo where to find it.

use std::os::raw::{c_char, c_void};

use crate::enums::{
    hailo_averaging_factor_t, hailo_cpu_id_t, hailo_device_type_t, hailo_dvm_options_t,
    hailo_fw_logger_level_t,
    hailo_measurement_buffer_index_t, hailo_notification_id_t,
    hailo_power_measurement_types_t, hailo_reset_device_mode_t, hailo_sampling_period_t,
    hailo_sensor_types_t, hailo_stream_direction_t, hailo_watchdog_mode_t,
};
use crate::handles::{
    hailo_activated_network_group, hailo_configured_network_group, hailo_device,
    hailo_hef, hailo_input_stream, hailo_input_transform_context, hailo_input_vstream,
    hailo_output_demuxer, hailo_output_stream, hailo_output_transform_context,
    hailo_output_vstream, hailo_scan_devices_params_t, hailo_vdevice,
};
use crate::status::hailo_status;
use crate::types::{
    float32_t, hailo_activate_network_group_params_t, hailo_chip_temperature_info_t,
    hailo_configure_params_t, hailo_core_information_t, hailo_demux_params_t,
    hailo_device_id_t, hailo_device_identity_t, hailo_extended_device_information_t,
    hailo_format_t, hailo_health_info_t, hailo_health_stats_t,
    hailo_i2c_slave_config_t, hailo_input_vstream_params_by_name_t,
    hailo_latency_measurement_result_t, hailo_network_group_info_t, hailo_network_info_t,
    hailo_notification_callback, hailo_output_vstream_params_by_name_t,
    hailo_pcie_device_info_t, hailo_performance_stats_t, hailo_power_measurement_data_t,
    hailo_quant_info_t, hailo_stream_info_t, hailo_stream_read_async_callback_t,
    hailo_stream_write_async_callback_t, hailo_transform_params_t, hailo_version_t,
    hailo_vdevice_params_t, hailo_vstream_info_t, hailo_vstream_params_t,
};

#[link(name = "hailort")]
unsafe extern "C" {
    // --- Library version and status -----------------------------------------

    pub fn hailo_get_library_version(version: *mut hailo_version_t) -> hailo_status;
    pub fn hailo_get_status_message(status: hailo_status) -> *const c_char;

    // --- Device discovery and creation --------------------------------------

    pub fn hailo_scan_devices(
        params: *mut hailo_scan_devices_params_t,
        device_ids: *mut hailo_device_id_t,
        device_ids_length: *mut usize,
    ) -> hailo_status;

    pub fn hailo_create_device_by_id(
        device_id: *const hailo_device_id_t,
        device: *mut hailo_device,
    ) -> hailo_status;

    pub fn hailo_scan_pcie_devices(
        pcie_device_infos: *mut hailo_pcie_device_info_t,
        pcie_device_infos_length: usize,
        number_of_devices: *mut usize,
    ) -> hailo_status;

    pub fn hailo_parse_pcie_device_info(
        device_info_str: *const c_char,
        device_info: *mut hailo_pcie_device_info_t,
    ) -> hailo_status;

    pub fn hailo_create_pcie_device(
        device_info: *mut hailo_pcie_device_info_t,
        device: *mut hailo_device,
    ) -> hailo_status;

    pub fn hailo_release_device(device: hailo_device) -> hailo_status;

    pub fn hailo_device_get_type_by_device_id(
        device_id: *const hailo_device_id_t,
        device_type: *mut hailo_device_type_t,
    ) -> hailo_status;

    // --- Device identification ----------------------------------------------

    pub fn hailo_identify(
        device: hailo_device,
        device_identity: *mut hailo_device_identity_t,
    ) -> hailo_status;

    pub fn hailo_core_identify(
        device: hailo_device,
        core_information: *mut hailo_core_information_t,
    ) -> hailo_status;

    pub fn hailo_get_extended_device_information(
        device: hailo_device,
        extended_device_information: *mut hailo_extended_device_information_t,
    ) -> hailo_status;

    pub fn hailo_get_device_id(
        device: hailo_device,
        id: *mut hailo_device_id_t,
    ) -> hailo_status;

    pub fn hailo_get_driver_version(
        device: hailo_device,
        version: *mut hailo_version_t,
    ) -> hailo_status;

    // --- Firmware and system control ----------------------------------------

    pub fn hailo_set_fw_logger(
        device: hailo_device,
        level: hailo_fw_logger_level_t,
        interface_mask: u32,
    ) -> hailo_status;

    pub fn hailo_set_throttling_state(
        device: hailo_device,
        should_activate: bool,
    ) -> hailo_status;

    pub fn hailo_get_throttling_state(device: hailo_device, is_active: *mut bool) -> hailo_status;

    pub fn hailo_wd_enable(device: hailo_device, cpu_id: hailo_cpu_id_t) -> hailo_status;

    pub fn hailo_wd_disable(device: hailo_device, cpu_id: hailo_cpu_id_t) -> hailo_status;

    pub fn hailo_wd_config(
        device: hailo_device,
        cpu_id: hailo_cpu_id_t,
        wd_cycles: u32,
        wd_mode: hailo_watchdog_mode_t,
    ) -> hailo_status;

    pub fn hailo_get_previous_system_state(
        device: hailo_device,
        cpu_id: hailo_cpu_id_t,
        previous_system_state: *mut u32,
    ) -> hailo_status;

    pub fn hailo_set_pause_frames(
        device: hailo_device,
        rx_pause_frames_enable: bool,
    ) -> hailo_status;

    // --- Temperature and reset ----------------------------------------------

    pub fn hailo_get_chip_temperature(
        device: hailo_device,
        temp_info: *mut hailo_chip_temperature_info_t,
    ) -> hailo_status;

    pub fn hailo_reset_device(
        device: hailo_device,
        mode: hailo_reset_device_mode_t,
    ) -> hailo_status;

    // --- Firmware update ----------------------------------------------------

    pub fn hailo_update_firmware(
        device: hailo_device,
        firmware_buffer: *mut c_void,
        firmware_buffer_size: u32,
    ) -> hailo_status;

    pub fn hailo_update_second_stage(
        device: hailo_device,
        second_stage_buffer: *mut c_void,
        second_stage_buffer_size: u32,
    ) -> hailo_status;

    // --- Notification management --------------------------------------------

    pub fn hailo_set_notification_callback(
        device: hailo_device,
        callback: hailo_notification_callback,
        notification_id: hailo_notification_id_t,
        opaque: *mut c_void,
    ) -> hailo_status;

    pub fn hailo_remove_notification_callback(
        device: hailo_device,
        notification_id: hailo_notification_id_t,
    ) -> hailo_status;

    // --- Sensor management --------------------------------------------------

    pub fn hailo_reset_sensor(device: hailo_device, section_index: u8) -> hailo_status;

    pub fn hailo_set_sensor_i2c_bus_index(
        device: hailo_device,
        sensor_type: hailo_sensor_types_t,
        bus_index: u8,
    ) -> hailo_status;

    pub fn hailo_load_and_start_sensor(
        device: hailo_device,
        section_index: u8,
    ) -> hailo_status;

    pub fn hailo_dump_sensor_config(
        device: hailo_device,
        section_index: u8,
        config_file_path: *const c_char,
    ) -> hailo_status;

    pub fn hailo_store_sensor_config(
        device: hailo_device,
        section_index: u32,
        sensor_type: hailo_sensor_types_t,
        reset_config_size: u32,
        config_height: u16,
        config_width: u16,
        config_fps: u16,
        config_file_path: *const c_char,
        config_name: *const c_char,
    ) -> hailo_status;

    pub fn hailo_store_isp_config(
        device: hailo_device,
        reset_config_size: u32,
        config_height: u16,
        config_width: u16,
        config_fps: u16,
        isp_static_config_file_path: *const c_char,
        isp_runtime_config_file_path: *const c_char,
        config_name: *const c_char,
    ) -> hailo_status;

    // --- I²C ----------------------------------------------------------------

    pub fn hailo_i2c_read(
        device: hailo_device,
        slave_config: *const hailo_i2c_slave_config_t,
        register_address: u32,
        data: *mut u8,
        length: u32,
    ) -> hailo_status;

    pub fn hailo_i2c_write(
        device: hailo_device,
        slave_config: *const hailo_i2c_slave_config_t,
        register_address: u32,
        data: *const u8,
        length: u32,
    ) -> hailo_status;

    // --- Diagnostics --------------------------------------------------------

    pub fn hailo_test_chip_memories(device: hailo_device) -> hailo_status;

    // --- Power measurement --------------------------------------------------

    pub fn hailo_power_measurement(
        device: hailo_device,
        dvm: hailo_dvm_options_t,
        measurement_type: hailo_power_measurement_types_t,
        measurement: *mut float32_t,
    ) -> hailo_status;

    pub fn hailo_start_power_measurement(
        device: hailo_device,
        averaging_factor: hailo_averaging_factor_t,
        sampling_period: hailo_sampling_period_t,
    ) -> hailo_status;

    pub fn hailo_set_power_measurement(
        device: hailo_device,
        buffer_index: hailo_measurement_buffer_index_t,
        dvm: hailo_dvm_options_t,
        measurement_type: hailo_power_measurement_types_t,
    ) -> hailo_status;

    pub fn hailo_get_power_measurement(
        device: hailo_device,
        buffer_index: hailo_measurement_buffer_index_t,
        should_clear: bool,
        measurement_data: *mut hailo_power_measurement_data_t,
    ) -> hailo_status;

    pub fn hailo_stop_power_measurement(device: hailo_device) -> hailo_status;

    // --- Health monitoring --------------------------------------------------

    pub fn hailo_get_health_information(
        device: hailo_device,
        health_info: *mut hailo_health_info_t,
    ) -> hailo_status;

    pub fn hailo_get_performance_stats(
        device: hailo_device,
        perf_stats: *mut hailo_performance_stats_t,
    ) -> hailo_status;

    pub fn hailo_get_health_stats(
        device: hailo_device,
        health_stats: *mut hailo_health_stats_t,
    ) -> hailo_status;

    // --- VDevice ------------------------------------------------------------

    pub fn hailo_init_vdevice_params(params: *mut hailo_vdevice_params_t) -> hailo_status;

    pub fn hailo_create_vdevice(
        params: *mut hailo_vdevice_params_t,
        vdevice: *mut hailo_vdevice,
    ) -> hailo_status;

    pub fn hailo_configure_vdevice(
        vdevice: hailo_vdevice,
        hef: hailo_hef,
        params: *mut hailo_configure_params_t,
        network_groups: *mut hailo_configured_network_group,
        number_of_network_groups: *mut usize,
    ) -> hailo_status;

    pub fn hailo_get_physical_devices(
        vdevice: hailo_vdevice,
        devices: *mut hailo_device,
        number_of_devices: *mut usize,
    ) -> hailo_status;

    pub fn hailo_vdevice_get_physical_devices_ids(
        vdevice: hailo_vdevice,
        devices_ids: *mut hailo_device_id_t,
        number_of_devices: *mut usize,
    ) -> hailo_status;

    pub fn hailo_release_vdevice(vdevice: hailo_vdevice) -> hailo_status;

    // --- HEF ----------------------------------------------------------------

    pub fn hailo_create_hef_file(hef: *mut hailo_hef, file_name: *const c_char) -> hailo_status;

    pub fn hailo_create_hef_buffer(
        hef: *mut hailo_hef,
        buffer: *const c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_release_hef(hef: hailo_hef) -> hailo_status;

    pub fn hailo_hef_get_stream_infos(
        hef: hailo_hef,
        name: *const c_char,
        stream_infos: *mut hailo_stream_info_t,
        number_of_streams: *mut usize,
    ) -> hailo_status;

    pub fn hailo_hef_get_vstream_infos(
        hef: hailo_hef,
        name: *const c_char,
        vstream_infos: *mut hailo_vstream_info_t,
        number_of_vstreams: *mut usize,
    ) -> hailo_status;

    pub fn hailo_hef_get_network_group_infos(
        hef: hailo_hef,
        network_group_infos: *mut hailo_network_group_info_t,
        number_of_network_groups: *mut usize,
    ) -> hailo_status;

    pub fn hailo_hef_get_network_infos(
        hef: hailo_hef,
        network_group_name: *const c_char,
        network_infos: *mut hailo_network_info_t,
        number_of_networks: *mut usize,
    ) -> hailo_status;

    // --- Configure device ---------------------------------------------------

    pub fn hailo_init_configure_params_by_device(
        device: hailo_device,
        hef: hailo_hef,
        params: *mut hailo_configure_params_t,
    ) -> hailo_status;

    pub fn hailo_init_configure_params_by_vdevice(
        vdevice: hailo_vdevice,
        hef: hailo_hef,
        params: *mut hailo_configure_params_t,
    ) -> hailo_status;

    pub fn hailo_configure_device(
        device: hailo_device,
        hef: hailo_hef,
        params: *mut hailo_configure_params_t,
        network_groups: *mut hailo_configured_network_group,
        number_of_network_groups: *mut usize,
    ) -> hailo_status;

    // --- Network group activation -------------------------------------------

    pub fn hailo_activate_network_group(
        network_group: hailo_configured_network_group,
        params: *mut hailo_activate_network_group_params_t,
        activated_network_group: *mut hailo_activated_network_group,
    ) -> hailo_status;

    pub fn hailo_deactivate_network_group(
        network_group: hailo_activated_network_group,
    ) -> hailo_status;

    pub fn hailo_release_network_group(
        network_group: hailo_configured_network_group,
    ) -> hailo_status;

    pub fn hailo_get_network_group_info(
        network_group: hailo_configured_network_group,
        info: *mut hailo_network_group_info_t,
    ) -> hailo_status;

    // --- Synchronous stream I/O ---------------------------------------------

    pub fn hailo_get_input_streams_by_network(
        network_group: hailo_activated_network_group,
        network_name: *const c_char,
        inputs: *mut hailo_input_stream,
        number_of_inputs: *mut usize,
    ) -> hailo_status;

    pub fn hailo_get_output_streams_by_network(
        network_group: hailo_activated_network_group,
        network_name: *const c_char,
        outputs: *mut hailo_output_stream,
        number_of_outputs: *mut usize,
    ) -> hailo_status;

    pub fn hailo_input_stream_write(
        stream: hailo_input_stream,
        buffer: *const c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_output_stream_read(
        stream: hailo_output_stream,
        buffer: *mut c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_stream_get_info(
        stream: hailo_input_stream,
        info: *mut hailo_stream_info_t,
    ) -> hailo_status;

    pub fn hailo_output_stream_get_info(
        stream: hailo_output_stream,
        info: *mut hailo_stream_info_t,
    ) -> hailo_status;

    // --- Asynchronous stream I/O --------------------------------------------

    pub fn hailo_input_stream_write_async(
        stream: hailo_input_stream,
        buffer: *const c_void,
        size: usize,
        callback: hailo_stream_write_async_callback_t,
        opaque: *mut c_void,
    ) -> hailo_status;

    pub fn hailo_output_stream_read_async(
        stream: hailo_output_stream,
        buffer: *mut c_void,
        size: usize,
        callback: hailo_stream_read_async_callback_t,
        opaque: *mut c_void,
    ) -> hailo_status;

    // --- Quantisation info --------------------------------------------------

    pub fn hailo_get_output_stream_quant_infos(
        stream: hailo_output_stream,
        quant_infos: *mut hailo_quant_info_t,
        number_of_quant_infos: *mut usize,
    ) -> hailo_status;

    pub fn hailo_get_output_vstream_quant_infos(
        vstream: hailo_output_vstream,
        quant_infos: *mut hailo_quant_info_t,
        number_of_quant_infos: *mut usize,
    ) -> hailo_status;

    // --- Transform contexts -------------------------------------------------

    pub fn hailo_create_input_transform_context(
        stream: hailo_input_stream,
        transform_params: *const hailo_transform_params_t,
        context: *mut hailo_input_transform_context,
    ) -> hailo_status;

    pub fn hailo_create_output_transform_context(
        stream: hailo_output_stream,
        transform_params: *const hailo_transform_params_t,
        context: *mut hailo_output_transform_context,
    ) -> hailo_status;

    pub fn hailo_input_transform_context_write(
        context: hailo_input_transform_context,
        buffer: *const c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_output_transform_context_read(
        context: hailo_output_transform_context,
        buffer: *mut c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_release_input_transform_context(
        context: hailo_input_transform_context,
    ) -> hailo_status;

    pub fn hailo_release_output_transform_context(
        context: hailo_output_transform_context,
    ) -> hailo_status;

    // --- Output demuxer -----------------------------------------------------

    pub fn hailo_create_output_demuxer(
        stream: hailo_output_stream,
        demux_params: *const hailo_demux_params_t,
        demuxer: *mut hailo_output_demuxer,
    ) -> hailo_status;

    pub fn hailo_output_demuxer_read(
        demuxer: hailo_output_demuxer,
        buffer: *mut c_void,
        size: usize,
        actual_size: *mut usize,
    ) -> hailo_status;

    pub fn hailo_release_output_demuxer(demuxer: hailo_output_demuxer) -> hailo_status;

    // --- Virtual streams (vstreams) -----------------------------------------

    pub fn hailo_create_input_vstreams(
        network_group: hailo_configured_network_group,
        inputs_params: *const hailo_input_vstream_params_by_name_t,
        inputs_count: usize,
        input_vstreams: *mut hailo_input_vstream,
    ) -> hailo_status;

    pub fn hailo_create_output_vstreams(
        network_group: hailo_configured_network_group,
        outputs_params: *const hailo_output_vstream_params_by_name_t,
        outputs_count: usize,
        output_vstreams: *mut hailo_output_vstream,
    ) -> hailo_status;

    pub fn hailo_release_input_vstream(vstream: hailo_input_vstream) -> hailo_status;
    pub fn hailo_release_output_vstream(vstream: hailo_output_vstream) -> hailo_status;

    pub fn hailo_input_vstream_write(
        vstream: hailo_input_vstream,
        buffer: *const c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_output_vstream_read(
        vstream: hailo_output_vstream,
        buffer: *mut c_void,
        size: usize,
    ) -> hailo_status;

    pub fn hailo_input_vstream_get_info(
        vstream: hailo_input_vstream,
        info: *mut hailo_vstream_info_t,
    ) -> hailo_status;

    pub fn hailo_output_vstream_get_info(
        vstream: hailo_output_vstream,
        info: *mut hailo_vstream_info_t,
    ) -> hailo_status;

    pub fn hailo_input_vstream_flush(vstream: hailo_input_vstream) -> hailo_status;

    pub fn hailo_input_vstream_clear(vstream: hailo_input_vstream) -> hailo_status;

    // --- Default parameter initialisation -----------------------------------

    pub fn hailo_get_default_vstream_params(
        vstream_info: *const hailo_vstream_info_t,
        user_buffer_format: hailo_format_t,
        direction: hailo_stream_direction_t,
        params: *mut hailo_vstream_params_t,
    ) -> hailo_status;

    // --- Latency measurement ------------------------------------------------

    pub fn hailo_input_vstream_get_latency_measurement(
        vstream: hailo_input_vstream,
        result: *mut hailo_latency_measurement_result_t,
    ) -> hailo_status;
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------
//
// Each test assigns an extern function to a local variable with the expected
// function-pointer type.  The assignment is a compile-time type-check: if the
// declared signature does not match what we assert here the test file will not
// compile.  At runtime the assignment is a no-op.

#[cfg(test)]
mod tests {
    use super::*;
    use crate::enums::{
        hailo_averaging_factor_t, hailo_cpu_id_t, hailo_device_type_t, hailo_dvm_options_t,
        hailo_fw_logger_level_t, hailo_measurement_buffer_index_t, hailo_notification_id_t,
        hailo_power_measurement_types_t, hailo_reset_device_mode_t, hailo_sampling_period_t,
        hailo_sensor_types_t, hailo_stream_direction_t, hailo_watchdog_mode_t,
    };
    use crate::handles::{
        hailo_activated_network_group, hailo_configured_network_group, hailo_device, hailo_hef,
        hailo_input_stream, hailo_input_transform_context, hailo_input_vstream,
        hailo_output_demuxer, hailo_output_stream, hailo_output_transform_context,
        hailo_output_vstream, hailo_scan_devices_params_t, hailo_vdevice,
    };
    use crate::status::hailo_status;
    use crate::types::{
        float32_t, hailo_activate_network_group_params_t, hailo_chip_temperature_info_t,
        hailo_configure_params_t, hailo_core_information_t, hailo_demux_params_t,
        hailo_device_id_t, hailo_device_identity_t, hailo_extended_device_information_t,
        hailo_format_t, hailo_health_info_t, hailo_health_stats_t, hailo_i2c_slave_config_t,
        hailo_input_vstream_params_by_name_t, hailo_latency_measurement_result_t,
        hailo_network_group_info_t, hailo_network_info_t, hailo_notification_callback,
        hailo_output_vstream_params_by_name_t, hailo_pcie_device_info_t,
        hailo_performance_stats_t, hailo_power_measurement_data_t, hailo_quant_info_t,
        hailo_stream_info_t, hailo_stream_read_async_callback_t,
        hailo_stream_write_async_callback_t, hailo_transform_params_t, hailo_version_t,
        hailo_vdevice_params_t, hailo_vstream_info_t, hailo_vstream_params_t,
    };
    use std::os::raw::{c_char, c_void};

    #[test]
    fn library_and_status_signatures() {
        let _: unsafe extern "C" fn(*mut hailo_version_t) -> hailo_status =
            hailo_get_library_version;
        let _: unsafe extern "C" fn(hailo_status) -> *const c_char = hailo_get_status_message;
    }

    #[test]
    fn device_discovery_signatures() {
        let _: unsafe extern "C" fn(
            *mut hailo_scan_devices_params_t,
            *mut hailo_device_id_t,
            *mut usize,
        ) -> hailo_status = hailo_scan_devices;
        let _: unsafe extern "C" fn(
            *const hailo_device_id_t,
            *mut hailo_device,
        ) -> hailo_status = hailo_create_device_by_id;
        let _: unsafe extern "C" fn(
            *mut hailo_pcie_device_info_t,
            usize,
            *mut usize,
        ) -> hailo_status = hailo_scan_pcie_devices;
        let _: unsafe extern "C" fn(
            *const c_char,
            *mut hailo_pcie_device_info_t,
        ) -> hailo_status = hailo_parse_pcie_device_info;
        let _: unsafe extern "C" fn(
            *mut hailo_pcie_device_info_t,
            *mut hailo_device,
        ) -> hailo_status = hailo_create_pcie_device;
        let _: unsafe extern "C" fn(hailo_device) -> hailo_status = hailo_release_device;
        let _: unsafe extern "C" fn(
            *const hailo_device_id_t,
            *mut hailo_device_type_t,
        ) -> hailo_status = hailo_device_get_type_by_device_id;
    }

    #[test]
    fn device_identification_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_device_identity_t,
        ) -> hailo_status = hailo_identify;
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_core_information_t,
        ) -> hailo_status = hailo_core_identify;
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_extended_device_information_t,
        ) -> hailo_status = hailo_get_extended_device_information;
        let _: unsafe extern "C" fn(hailo_device, *mut hailo_device_id_t) -> hailo_status =
            hailo_get_device_id;
        let _: unsafe extern "C" fn(hailo_device, *mut hailo_version_t) -> hailo_status =
            hailo_get_driver_version;
    }

    #[test]
    fn firmware_and_system_control_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_fw_logger_level_t,
            u32,
        ) -> hailo_status = hailo_set_fw_logger;
        let _: unsafe extern "C" fn(hailo_device, bool) -> hailo_status =
            hailo_set_throttling_state;
        let _: unsafe extern "C" fn(hailo_device, *mut bool) -> hailo_status =
            hailo_get_throttling_state;
        let _: unsafe extern "C" fn(hailo_device, hailo_cpu_id_t) -> hailo_status = hailo_wd_enable;
        let _: unsafe extern "C" fn(hailo_device, hailo_cpu_id_t) -> hailo_status =
            hailo_wd_disable;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_cpu_id_t,
            u32,
            hailo_watchdog_mode_t,
        ) -> hailo_status = hailo_wd_config;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_cpu_id_t,
            *mut u32,
        ) -> hailo_status = hailo_get_previous_system_state;
        let _: unsafe extern "C" fn(hailo_device, bool) -> hailo_status = hailo_set_pause_frames;
    }

    #[test]
    fn temperature_and_reset_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_chip_temperature_info_t,
        ) -> hailo_status = hailo_get_chip_temperature;
        let _: unsafe extern "C" fn(hailo_device, hailo_reset_device_mode_t) -> hailo_status =
            hailo_reset_device;
    }

    #[test]
    fn firmware_update_signatures() {
        let _: unsafe extern "C" fn(hailo_device, *mut c_void, u32) -> hailo_status =
            hailo_update_firmware;
        let _: unsafe extern "C" fn(hailo_device, *mut c_void, u32) -> hailo_status =
            hailo_update_second_stage;
    }

    #[test]
    fn notification_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_notification_callback,
            hailo_notification_id_t,
            *mut c_void,
        ) -> hailo_status = hailo_set_notification_callback;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_notification_id_t,
        ) -> hailo_status = hailo_remove_notification_callback;
    }

    #[test]
    fn sensor_management_signatures() {
        let _: unsafe extern "C" fn(hailo_device, u8) -> hailo_status = hailo_reset_sensor;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_sensor_types_t,
            u8,
        ) -> hailo_status = hailo_set_sensor_i2c_bus_index;
        let _: unsafe extern "C" fn(hailo_device, u8) -> hailo_status =
            hailo_load_and_start_sensor;
        let _: unsafe extern "C" fn(hailo_device, u8, *const c_char) -> hailo_status =
            hailo_dump_sensor_config;
        let _: unsafe extern "C" fn(
            hailo_device,
            u32,
            hailo_sensor_types_t,
            u32,
            u16,
            u16,
            u16,
            *const c_char,
            *const c_char,
        ) -> hailo_status = hailo_store_sensor_config;
        let _: unsafe extern "C" fn(
            hailo_device,
            u32,
            u16,
            u16,
            u16,
            *const c_char,
            *const c_char,
            *const c_char,
        ) -> hailo_status = hailo_store_isp_config;
    }

    #[test]
    fn i2c_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            *const hailo_i2c_slave_config_t,
            u32,
            *mut u8,
            u32,
        ) -> hailo_status = hailo_i2c_read;
        let _: unsafe extern "C" fn(
            hailo_device,
            *const hailo_i2c_slave_config_t,
            u32,
            *const u8,
            u32,
        ) -> hailo_status = hailo_i2c_write;
    }

    #[test]
    fn diagnostics_signature() {
        let _: unsafe extern "C" fn(hailo_device) -> hailo_status = hailo_test_chip_memories;
    }

    #[test]
    fn power_measurement_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_dvm_options_t,
            hailo_power_measurement_types_t,
            *mut float32_t,
        ) -> hailo_status = hailo_power_measurement;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_averaging_factor_t,
            hailo_sampling_period_t,
        ) -> hailo_status = hailo_start_power_measurement;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_measurement_buffer_index_t,
            hailo_dvm_options_t,
            hailo_power_measurement_types_t,
        ) -> hailo_status = hailo_set_power_measurement;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_measurement_buffer_index_t,
            bool,
            *mut hailo_power_measurement_data_t,
        ) -> hailo_status = hailo_get_power_measurement;
        let _: unsafe extern "C" fn(hailo_device) -> hailo_status = hailo_stop_power_measurement;
    }

    #[test]
    fn health_monitoring_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_health_info_t,
        ) -> hailo_status = hailo_get_health_information;
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_performance_stats_t,
        ) -> hailo_status = hailo_get_performance_stats;
        let _: unsafe extern "C" fn(
            hailo_device,
            *mut hailo_health_stats_t,
        ) -> hailo_status = hailo_get_health_stats;
    }

    #[test]
    fn vdevice_signatures() {
        let _: unsafe extern "C" fn(*mut hailo_vdevice_params_t) -> hailo_status =
            hailo_init_vdevice_params;
        let _: unsafe extern "C" fn(
            *mut hailo_vdevice_params_t,
            *mut hailo_vdevice,
        ) -> hailo_status = hailo_create_vdevice;
        let _: unsafe extern "C" fn(
            hailo_vdevice,
            hailo_hef,
            *mut hailo_configure_params_t,
            *mut hailo_configured_network_group,
            *mut usize,
        ) -> hailo_status = hailo_configure_vdevice;
        let _: unsafe extern "C" fn(
            hailo_vdevice,
            *mut hailo_device,
            *mut usize,
        ) -> hailo_status = hailo_get_physical_devices;
        let _: unsafe extern "C" fn(
            hailo_vdevice,
            *mut hailo_device_id_t,
            *mut usize,
        ) -> hailo_status = hailo_vdevice_get_physical_devices_ids;
        let _: unsafe extern "C" fn(hailo_vdevice) -> hailo_status = hailo_release_vdevice;
    }

    #[test]
    fn hef_signatures() {
        let _: unsafe extern "C" fn(*mut hailo_hef, *const c_char) -> hailo_status =
            hailo_create_hef_file;
        let _: unsafe extern "C" fn(*mut hailo_hef, *const c_void, usize) -> hailo_status =
            hailo_create_hef_buffer;
        let _: unsafe extern "C" fn(hailo_hef) -> hailo_status = hailo_release_hef;
        let _: unsafe extern "C" fn(
            hailo_hef,
            *const c_char,
            *mut hailo_stream_info_t,
            *mut usize,
        ) -> hailo_status = hailo_hef_get_stream_infos;
        let _: unsafe extern "C" fn(
            hailo_hef,
            *const c_char,
            *mut hailo_vstream_info_t,
            *mut usize,
        ) -> hailo_status = hailo_hef_get_vstream_infos;
        let _: unsafe extern "C" fn(
            hailo_hef,
            *mut hailo_network_group_info_t,
            *mut usize,
        ) -> hailo_status = hailo_hef_get_network_group_infos;
        let _: unsafe extern "C" fn(
            hailo_hef,
            *const c_char,
            *mut hailo_network_info_t,
            *mut usize,
        ) -> hailo_status = hailo_hef_get_network_infos;
    }

    #[test]
    fn configure_device_signatures() {
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_hef,
            *mut hailo_configure_params_t,
        ) -> hailo_status = hailo_init_configure_params_by_device;
        let _: unsafe extern "C" fn(
            hailo_vdevice,
            hailo_hef,
            *mut hailo_configure_params_t,
        ) -> hailo_status = hailo_init_configure_params_by_vdevice;
        let _: unsafe extern "C" fn(
            hailo_device,
            hailo_hef,
            *mut hailo_configure_params_t,
            *mut hailo_configured_network_group,
            *mut usize,
        ) -> hailo_status = hailo_configure_device;
    }

    #[test]
    fn network_group_activation_signatures() {
        let _: unsafe extern "C" fn(
            hailo_configured_network_group,
            *mut hailo_activate_network_group_params_t,
            *mut hailo_activated_network_group,
        ) -> hailo_status = hailo_activate_network_group;
        let _: unsafe extern "C" fn(hailo_activated_network_group) -> hailo_status =
            hailo_deactivate_network_group;
        let _: unsafe extern "C" fn(hailo_configured_network_group) -> hailo_status =
            hailo_release_network_group;
        let _: unsafe extern "C" fn(
            hailo_configured_network_group,
            *mut hailo_network_group_info_t,
        ) -> hailo_status = hailo_get_network_group_info;
    }

    #[test]
    fn sync_stream_io_signatures() {
        let _: unsafe extern "C" fn(
            hailo_activated_network_group,
            *const c_char,
            *mut hailo_input_stream,
            *mut usize,
        ) -> hailo_status = hailo_get_input_streams_by_network;
        let _: unsafe extern "C" fn(
            hailo_activated_network_group,
            *const c_char,
            *mut hailo_output_stream,
            *mut usize,
        ) -> hailo_status = hailo_get_output_streams_by_network;
        let _: unsafe extern "C" fn(hailo_input_stream, *const c_void, usize) -> hailo_status =
            hailo_input_stream_write;
        let _: unsafe extern "C" fn(hailo_output_stream, *mut c_void, usize) -> hailo_status =
            hailo_output_stream_read;
        let _: unsafe extern "C" fn(
            hailo_input_stream,
            *mut hailo_stream_info_t,
        ) -> hailo_status = hailo_stream_get_info;
        let _: unsafe extern "C" fn(
            hailo_output_stream,
            *mut hailo_stream_info_t,
        ) -> hailo_status = hailo_output_stream_get_info;
    }

    #[test]
    fn async_stream_io_signatures() {
        let _: unsafe extern "C" fn(
            hailo_input_stream,
            *const c_void,
            usize,
            hailo_stream_write_async_callback_t,
            *mut c_void,
        ) -> hailo_status = hailo_input_stream_write_async;
        let _: unsafe extern "C" fn(
            hailo_output_stream,
            *mut c_void,
            usize,
            hailo_stream_read_async_callback_t,
            *mut c_void,
        ) -> hailo_status = hailo_output_stream_read_async;
    }

    #[test]
    fn quant_info_signatures() {
        let _: unsafe extern "C" fn(
            hailo_output_stream,
            *mut hailo_quant_info_t,
            *mut usize,
        ) -> hailo_status = hailo_get_output_stream_quant_infos;
        let _: unsafe extern "C" fn(
            hailo_output_vstream,
            *mut hailo_quant_info_t,
            *mut usize,
        ) -> hailo_status = hailo_get_output_vstream_quant_infos;
    }

    #[test]
    fn transform_context_signatures() {
        let _: unsafe extern "C" fn(
            hailo_input_stream,
            *const hailo_transform_params_t,
            *mut hailo_input_transform_context,
        ) -> hailo_status = hailo_create_input_transform_context;
        let _: unsafe extern "C" fn(
            hailo_output_stream,
            *const hailo_transform_params_t,
            *mut hailo_output_transform_context,
        ) -> hailo_status = hailo_create_output_transform_context;
        let _: unsafe extern "C" fn(
            hailo_input_transform_context,
            *const c_void,
            usize,
        ) -> hailo_status = hailo_input_transform_context_write;
        let _: unsafe extern "C" fn(
            hailo_output_transform_context,
            *mut c_void,
            usize,
        ) -> hailo_status = hailo_output_transform_context_read;
        let _: unsafe extern "C" fn(hailo_input_transform_context) -> hailo_status =
            hailo_release_input_transform_context;
        let _: unsafe extern "C" fn(hailo_output_transform_context) -> hailo_status =
            hailo_release_output_transform_context;
    }

    #[test]
    fn output_demuxer_signatures() {
        let _: unsafe extern "C" fn(
            hailo_output_stream,
            *const hailo_demux_params_t,
            *mut hailo_output_demuxer,
        ) -> hailo_status = hailo_create_output_demuxer;
        let _: unsafe extern "C" fn(
            hailo_output_demuxer,
            *mut c_void,
            usize,
            *mut usize,
        ) -> hailo_status = hailo_output_demuxer_read;
        let _: unsafe extern "C" fn(hailo_output_demuxer) -> hailo_status =
            hailo_release_output_demuxer;
    }

    #[test]
    fn vstream_signatures() {
        let _: unsafe extern "C" fn(
            hailo_configured_network_group,
            *const hailo_input_vstream_params_by_name_t,
            usize,
            *mut hailo_input_vstream,
        ) -> hailo_status = hailo_create_input_vstreams;
        let _: unsafe extern "C" fn(
            hailo_configured_network_group,
            *const hailo_output_vstream_params_by_name_t,
            usize,
            *mut hailo_output_vstream,
        ) -> hailo_status = hailo_create_output_vstreams;
        let _: unsafe extern "C" fn(hailo_input_vstream) -> hailo_status =
            hailo_release_input_vstream;
        let _: unsafe extern "C" fn(hailo_output_vstream) -> hailo_status =
            hailo_release_output_vstream;
        let _: unsafe extern "C" fn(hailo_input_vstream, *const c_void, usize) -> hailo_status =
            hailo_input_vstream_write;
        let _: unsafe extern "C" fn(hailo_output_vstream, *mut c_void, usize) -> hailo_status =
            hailo_output_vstream_read;
        let _: unsafe extern "C" fn(
            hailo_input_vstream,
            *mut hailo_vstream_info_t,
        ) -> hailo_status = hailo_input_vstream_get_info;
        let _: unsafe extern "C" fn(
            hailo_output_vstream,
            *mut hailo_vstream_info_t,
        ) -> hailo_status = hailo_output_vstream_get_info;
        let _: unsafe extern "C" fn(hailo_input_vstream) -> hailo_status =
            hailo_input_vstream_flush;
        let _: unsafe extern "C" fn(hailo_input_vstream) -> hailo_status =
            hailo_input_vstream_clear;
    }

    #[test]
    fn default_params_and_latency_signatures() {
        let _: unsafe extern "C" fn(
            *const hailo_vstream_info_t,
            hailo_format_t,
            hailo_stream_direction_t,
            *mut hailo_vstream_params_t,
        ) -> hailo_status = hailo_get_default_vstream_params;
        let _: unsafe extern "C" fn(
            hailo_input_vstream,
            *mut hailo_latency_measurement_result_t,
        ) -> hailo_status = hailo_input_vstream_get_latency_measurement;
    }
}