-
Notifications
You must be signed in to change notification settings - Fork 191
/
pf_types.h
1814 lines (1546 loc) · 61.1 KB
/
pf_types.h
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
/*********************************************************************
* _ _ _
* _ __ | |_ _ | | __ _ | |__ ___
* | '__|| __|(_)| | / _` || '_ \ / __|
* | | | |_ _ | || (_| || |_) |\__ \
* |_| \__|(_)|_| \__,_||_.__/ |___/
*
* www.rt-labs.com
* Copyright 2018 rt-labs AB, Sweden.
*
* This software is dual-licensed under GPLv3 and a commercial
* license. See the file LICENSE.md distributed with this software for
* full license information.
********************************************************************/
/**
* @file
* @brief Internal typedefs for pnet
*/
#ifndef PF_TYPES_H
#define PF_TYPES_H
#ifdef __cplusplus
extern "C"
{
#endif
#if PNET_USE_ATOMICS
#include <stdatomic.h>
#else
#define atomic_int uint32_t
#define ATOMIC_VAR_INIT(x) x
#ifdef atomic_fetch_add
#undef atomic_fetch_add
#endif
static inline uint32_t atomic_fetch_add(atomic_int *p, uint32_t v)
{
uint32_t prev = *p;
*p += v;
return prev;
}
#ifdef atomic_fetch_sub
#undef atomic_fetch_sub
#endif
static inline uint32_t atomic_fetch_sub(atomic_int *p, uint32_t v)
{
uint32_t prev = *p;
*p -= v;
return prev;
}
#endif
/* ============================> RPC header */
/** Magic UUID values */
#define PNET_UUID_NIL_OBJECT "00000000-0000-0000-0000-000000000000"
#define PNET_RPC_DATA_REPRESENTATION "8A885D04-1CEB-11C9-9FE8-08002B104860" /* Used by the EPMAP service */
#define PNET_UUID_EPMAP_INTERFACE "E1AF8308-5D1F-11C9-91A4-08002B14A0FA" /* RPC interface version 3.0 */
#define PNET_UUID_EPMAP_OBJECT "00000000-0000-0000-0000-000000000000" /* RPC interface version 3.0 */
#define PROFINET_IO_CONSTANT_VALUE "DEA00000-6C97-11D1-8271"
#define PNET_UUID_IO_DEVICE_INTERFACE "DEA00001-6C97-11D1-8271-00A02442DF7D" /* RPC interface version 1.0 */
#define PNET_UUID_IO_CONTROLLER_INTERFACE "DEA00002-6C97-11D1-8271-00A02442DF7D" /* RPC interface version 1.0 */
#define PNET_UUID_IO_SUPERVISOR_INTERFACE "DEA00003-6C97-11D1-8271-00A02442DF7D" /* RPC interface version 1.0 */
#define PNET_UUID_IO_PRM_SERVER_INTERFACE "DEA00004-6C97-11D1-8271-00A02442DF7D" /* RPC interface version 1.0 */
typedef enum pf_rpc_packet_type_values
{
PF_RPC_PT_REQUEST = 0,
PF_RPC_PT_PING,
PF_RPC_PT_RESPONSE,
PF_RPC_PT_FAULT,
PF_RPC_PT_WORKING,
PF_RPC_PT_RESP_PING, /* No Call - response to ping */
PF_RPC_PT_REJECT,
PF_RPC_PT_ACK,
PF_RPC_PT_CL_CANCEL,
PF_RPC_PT_FRAG_ACK,
PF_RPC_PT_CANCEL_ACK,
} pf_rpc_packet_type_values_t;
typedef enum pf_rpc_flags_bits
{
PF_RPC_F_RESERVED_0 = 0,
PF_RPC_F_LAST_FRAGMENT,
PF_RPC_F_FRAGMENT,
PF_RPC_F_NO_FACK,
PF_RPC_F_MAYBE,
PF_RPC_F_IDEMPOTENT,
PF_RPC_F_BROADCAST,
PF_RPC_F_RESERVED_7,
} pf_rpc_flags_bits_t;
typedef enum pf_rpc_flags2_bits
{
PF_RPC_F2_CANCEL_PENDING = 1,
} pf_rpc_flags2_bits_t;
typedef enum pf_dev_opnum_values
{
PF_RPC_DEV_OPNUM_CONNECT = 0,
PF_RPC_DEV_OPNUM_RELEASE,
PF_RPC_DEV_OPNUM_READ,
PF_RPC_DEV_OPNUM_WRITE,
PF_RPC_DEV_OPNUM_CONTROL,
PF_RPC_DEV_OPNUM_READ_IMPLICIT,
} pf_dev_opnum_values_t;
/* ToDo: The EPM is not yet implemented */
typedef enum pf_epmapper_opnum_values
{
PF_RPC_EPM_OPNUM_INSERT,
PF_RPC_EPM_OPNUM_DELETE,
PF_RPC_EPM_OPNUM_LOOKUP, /* Mandatory to support */
PF_RPC_EPM_OPNUM_MAP,
PF_RPC_EPM_OPNUM_LOOKUP_HANDLE_FREE, /* Mandatory */
PF_RPC_EPM_OPNUM_INP_OBJECT,
PF_RPC_EPM_OPNUM_MGMT_DELETE,
} pf_epmapper_opnum_values_t;
typedef struct pf_rpc_flags
{
bool last_fragment;
bool fragment;
bool no_fack;
bool maybe;
bool idempotent;
bool broadcast;
} pf_rpc_flags_t;
typedef struct pf_rpc_flags2_t
{
bool cancel_pending;
} pf_rpc_flags2_t;
typedef struct pf_uuid
{
uint32_t data1;
uint16_t data2;
uint16_t data3;
uint8_t data4[8];
} pf_uuid_t;
typedef struct pf_rpc_header
{
uint8_t version; /* Allowed: 0x04 */
uint8_t packet_type; /* rpc_packet_type_values_t */
pf_rpc_flags_t flags; /* rpc_flags_bits */
pf_rpc_flags2_t flags2;
bool is_big_endian;
uint8_t float_repr; /* Allowed: IEEE (0) */
uint8_t reserved;
uint8_t serial_high;
pf_uuid_t object_uuid; /* Identifies IO device, IO controller or IO supervisor */
pf_uuid_t interface_uuid; /* Identify PNIO interface */
pf_uuid_t activity_uuid;
uint32_t server_boot_time;
uint32_t interface_version;
uint32_t sequence_nmb;
uint16_t opnum; /* Dev: pf_dev_opnum_values_t/pf_epmapper_opnum_values */
uint16_t interface_hint;
uint16_t activity_hint;
uint16_t length_of_body; /* AKA fragment_length */
uint16_t fragment_nmb;
uint8_t auth_protocol; /* Allowed: 0 (zero) */
uint8_t serial_low;
} pf_rpc_header_t;
/* <============================ RPC header */
/* ============================> Block header */
typedef enum pf_block_type_values
{
/* Reserved 0x0000 */
PF_BT_ALARM_NOTIFICATION_HIGH = 0x0001,
PF_BT_ALARM_NOTIFICATION_LOW = 0x0002,
/* Reserved 0x0003.. 0x0007 */
PF_BT_IOD_WRITE_REQ_HEADER = 0x0008,
PF_BT_IOD_READ_REQ_HEADER = 0x0009,
/* Reserved 0x000A..0x000F */
PF_BT_DIAGNOSIS_DATA = 0x0010,
/* Reserved 0x0011 */
PF_BT_EXPECTED_IDENTIFICATION_DATA = 0x0012,
PF_BT_REAL_IDENTIFICATION_DATA = 0x0013,
PF_BT_SUBSTITUTE_VALUE = 0x0014,
PF_BT_RECORD_INPUT_DATA_OBJECT = 0x0015,
PF_BT_RECORD_OUTPUT_DATA_OBJECT = 0x0016,
PF_BT_AR_DATA = 0x0018,
PF_BT_LOG_BOOK_DATA = 0x0019,
PF_BT_API_DATA = 0x001A,
PF_BT_SRL_DATA = 0x001B,
PF_BT_IM_0 = 0x0020,
PF_BT_IM_1 = 0x0021,
PF_BT_IM_2 = 0x0022,
PF_BT_IM_3 = 0x0023,
PF_BT_IM_4 = 0x0024,
PF_BT_IM_5 = 0x0025,
PF_BT_IM_6 = 0x0026,
PF_BT_IM_7 = 0x0027,
PF_BT_IM_8 = 0x0028,
PF_BT_IM_9 = 0x0029,
PF_BT_IM_10 = 0x002a,
PF_BT_IM_11 = 0x002b,
PF_BT_IM_12 = 0x002c,
PF_BT_IM_13 = 0x002d,
PF_BT_IM_14 = 0x002e,
PF_BT_IM_15 = 0x002f,
PF_BT_IM_0_FILTER_DATA_SUBMODULE = 0x0030,
PF_BT_IM_0_FILTER_DATA_MODULE = 0x0031,
PF_BT_IM_0_FILTER_DATA_DEVICE = 0x0032,
PF_BT_IM_5_DATA = 0x0034,
PF_BT_AR_BLOCK_REQ = 0x0101,
PF_BT_IOCR_BLOCK_REQ = 0x0102,
PF_BT_ALARM_CR_BLOCK_REQ = 0x0103,
PF_BT_EXPECTED_SUBMODULE_BLOCK = 0x0104,
PF_BT_PRM_SERVER_REQ = 0x0105,
PF_BT_MCR_REQ = 0x0106,
PF_BT_RPC_SERVER_REQ = 0x0107,
PF_BT_AR_VENDOR_BLOCK_REQ = 0x0108,
PF_BT_IR_INFO_BLOCK_REQ = 0x0109,
PF_BT_SR_INFO_BLOCK_REQ = 0x010A,
PF_BT_AR_FSU_BLOCK_REQ = 0x010B,
PF_BT_RS_INFO_BLOCK_REQ = 0x010C,
/* Reserved 0x010D-0x0x010F */
PF_BT_PRMEND_REQ = 0x0110,
PF_BT_PRMEND_PLUG_ALARM_REQ = 0x0111,
PF_BT_APPRDY_REQ = 0x0112,
PF_BT_APPRDY_PLUG_ALARM_REQ = 0x0113,
PF_BT_RELEASE_BLOCK_REQ = 0x0114,
/* Reserved 0x0115 */
PF_BT_XCONTROL_RDYCOMP_REQ = 0x0116,
PF_BT_XCONTROL_RDYRTC3_REQ = 0x0117,
PF_BT_PRMBEGIN_REQ = 0x0118,
PF_BT_SUBMODULE_PRMBEGIN_REQ = 0x0119,
PF_BT_MAINTENANCE_ITEM = 0x0f00,
/* Output from a PROFINET device */
/* Reserved 0x8000 */
PF_BT_ALARM_ACK_HIGH = 0x8001,
PF_BT_ALARM_ACK_LOW = 0x8002,
PF_BT_WRITE_RES = 0x8008,
PF_BT_READ_RES = 0x8009,
/* Reserved 0x8010.. 0x8100 */
PF_BT_AR_BLOCK_RES = 0x8101,
PF_BT_IOCR_BLOCK_RES = 0x8102,
PF_BT_ALARM_CR_BLOCK_RES = 0x8103,
PF_BT_MODULE_DIFF_BLOCK = 0x8104,
PF_BT_PRM_SERVER_BLOCK_RES = 0x8105,
PF_BT_AR_SERVER_BLOCK = 0x8106,
PF_BT_AR_RPC_BLOCK_RES = 0x8107,
PF_BT_AR_VENDOR_BLOCK_RES = 0x8108,
/* Reserved 0x8109-0x0x810F */
PF_BT_PRMEND_RES = 0x8110,
PF_BT_PRMEND_PLUG_ALARM_RES = 0x8111,
PF_BT_APPRDY_RES = 0x8112,
PF_BT_APPRDY_PLUG_ALARM_RES = 0x8113,
PF_BT_RELEASE_BLOCK_RES = 0x8114,
} pf_block_type_values_t;
typedef enum pf_index_values
{
PF_IDX_USER_MAX = 0x7fff,
PF_IDX_SUB_EXP_ID_DATA = 0x8000,
PF_IDX_SUB_REAL_ID_DATA = 0x8001,
PF_IDX_SUB_DIAGNOSIS_CH = 0x800a,
PF_IDX_SUB_DIAGNOSIS_ALL = 0x800b,
PF_IDX_SUB_DIAGNOSIS_DMQS = 0x800c,
PF_IDX_SUB_DIAG_MAINT_REQ_CH = 0x8010,
PF_IDX_SUB_DIAG_MAINT_DEM_CH = 0x8011,
PF_IDX_SUB_DIAG_MAINT_REQ_ALL = 0x8012,
PF_IDX_SUB_DIAG_MAINT_DEM_ALL = 0x8013,
PF_IDX_SUB_SUBSTITUTE = 0x801e,
PF_IDX_SUB_PDIR = 0x8020,
PF_IDX_SUB_PDPORTDATAREALEXT = 0x8027,
PF_IDX_SUB_INPUT_DATA = 0x8028,
PF_IDX_SUB_OUTPUT_DATA = 0x8029,
PF_IDX_SUB_PDPORT_DATA_REAL = 0x802a,
PF_IDX_SUB_PDPORT_DATA_CHECK = 0x802b,
PF_IDX_SUB_PDIR_DATA = 0x802c,
PF_IDX_SUB_PDSYNC_ID0 = 0x802d,
PF_IDX_SUB_PDPORT_DATA_ADJ = 0x802f,
PF_IDX_SUB_ISOCHRONUOUS_DATA = 0x8030,
PF_IDX_SUB_PDTIME = 0x8031,
PF_IDX_SUB_PDINTF_MRP_REAL = 0x8050,
PF_IDX_SUB_PDINTF_MRP_CHECK = 0x8051,
PF_IDX_SUB_PDINTF_MRP_ADJUST = 0x8052,
PF_IDX_SUB_PDPORT_MRP_ADJUST = 0x8053,
PF_IDX_SUB_PDPORT_MRP_REAL = 0x8054,
PF_IDX_SUB_PDPORT_MRPIC_REAL = 0x8055,
PF_IDX_SUB_PDPORT_MRPIC_CHECK = 0x8056,
PF_IDX_SUB_PDPORT_MRPIC_ADJUST = 0x8057,
PF_IDX_SUB_PDPORT_FO_REAL = 0x8060,
PF_IDX_SUB_PDPORT_FO_CHECK = 0x8061,
PF_IDX_SUB_PDPORT_FO_ADJUST = 0x8062,
PF_IDX_SUB_PDNC_CHECK = 0x8070,
PF_IDX_SUB_PDINTF_ADJUST = 0x8071,
PF_IDX_SUB_PDPORT_STATISTIC = 0x8072,
PF_IDX_SUB_PDINTF_REAL = 0x8080,
PF_IDX_SUB_PDINTF_FSU_ADJUST = 0x8090,
PF_IDX_SUB_PE_ENTITY_STATUS = 0x80af,
PF_IDX_SUB_COMBINED_OBJ_CONTAINER = 0x80b0,
PF_IDX_SUB_RS_ADJUST_OBSERVER = 0x80cf,
PF_IDX_SUB_IM_0 = 0xaff0,
PF_IDX_SUB_IM_1 = 0xaff1,
PF_IDX_SUB_IM_2 = 0xaff2,
PF_IDX_SUB_IM_3 = 0xaff3,
PF_IDX_SUB_IM_4 = 0xaff4,
PF_IDX_SUB_IM_5 = 0xaff5,
PF_IDX_SUB_IM_6 = 0xaff6,
PF_IDX_SUB_IM_7 = 0xaff7,
PF_IDX_SUB_IM_8 = 0xaff8,
PF_IDX_SUB_IM_9 = 0xaff9,
PF_IDX_SUB_IM_10 = 0xaffa,
PF_IDX_SUB_IM_11 = 0xaffb,
PF_IDX_SUB_IM_12 = 0xaffc,
PF_IDX_SUB_IM_13 = 0xaffd,
PF_IDX_SUB_IM_14 = 0xaffe,
PF_IDX_SUB_IM_15 = 0xafff,
PF_IDX_SLOT_EXP_ID_DATA = 0xc000,
PF_IDX_SLOT_REAL_ID_DATA = 0xc001,
PF_IDX_SLOT_DIAGNOSIS_CH = 0xc00a,
PF_IDX_SLOT_DIAGNOSIS_ALL = 0xc00b,
PF_IDX_SLOT_DIAGNOSIS_DMQS = 0xc00c,
PF_IDX_SLOT_DIAG_MAINT_REQ_CH = 0xc010,
PF_IDX_SLOT_DIAG_MAINT_DEM_CH = 0xc011,
PF_IDX_SLOT_DIAG_MAINT_REQ_ALL = 0xc012,
PF_IDX_SLOT_DIAG_MAINT_DEM_ALL = 0xc013,
PF_IDX_AR_EXP_ID_DATA = 0xe000,
PF_IDX_AR_REAL_ID_DATA = 0xe001,
PF_IDX_AR_MOD_DIFF = 0xe002,
PF_IDX_AR_DIAGNOSIS_CH = 0xe00a,
PF_IDX_AR_DIAGNOSIS_ALL = 0xe00b,
PF_IDX_AR_DIAGNOSIS_DMQS = 0xe00c,
PF_IDX_AR_DIAG_MAINT_REQ_CH = 0xe010,
PF_IDX_AR_DIAG_MAINT_DEM_CH = 0xe011,
PF_IDX_AR_DIAG_MAINT_REQ_ALL = 0xe012,
PF_IDX_AR_DIAG_MAINT_DEM_ALL = 0xe013,
PF_IDX_AR_PE_ENTITY_FILTER_DATA = 0xe030,
PF_IDX_AR_PE_ENTITY_STATUS_DATA = 0xe031,
PF_IDX_AR_WRITE_MULTIPLE = 0xe040,
PF_IDX_AR_FSU_DATA_ADJUST = 0xe050,
PF_IDX_AR_RS_GET_EVENT = 0xe060,
PF_IDX_AR_RS_ACK_EVENT = 0xe061,
PF_IDX_API_REAL_ID_DATA = 0xf000,
PF_IDX_API_DIAGNOSIS_CH = 0xf00a,
PF_IDX_API_DIAGNOSIS_ALL = 0xf00b,
PF_IDX_API_DIAGNOSIS_DMQS = 0xf00c,
PF_IDX_API_DIAG_MAINT_REQ_CH = 0xf010,
PF_IDX_API_DIAG_MAINT_DEM_CH = 0xf011,
PF_IDX_API_DIAG_MAINT_REQ_ALL = 0xf012,
PF_IDX_API_DIAG_MAINT_DEM_ALL = 0xf013,
PF_IDX_API_AR_DATA = 0xf020,
PF_IDX_DEV_DIAGNOSIS_DMQS = 0xf80c,
PF_IDX_DEV_AR_DATA = 0xf820,
PF_IDX_DEV_API_DATA = 0xf821,
PF_IDX_DEV_LOGBOOK_DATA = 0xf830,
PF_IDX_DEV_PDEV_DATA = 0xf831,
PF_IDX_DEV_IM_0_FILTER_DATA = 0xf840,
PF_IDX_DEV_PDREAL_DATA = 0xf841,
PF_IDX_DEV_PDEXP_DATA = 0xf842,
PF_IDX_DEV_AUTO_CONFIGURATION = 0xf850,
PF_IDX_DEV_GSD_UPLOAD = 0xf860,
PF_IDX_DEV_PE_ENTITY_FILTER_DATA = 0xf870,
PF_IDX_DEV_PE_ENTITY_STATUS_DATA = 0xf871,
PF_IDX_DEV_ASSET_MANAGEMENT_1 = 0xf880,
PF_IDX_DEV_ASSET_MANAGEMENT_2 = 0xf881,
PF_IDX_DEV_ASSET_MANAGEMENT_3 = 0xf882,
PF_IDX_DEV_ASSET_MANAGEMENT_4 = 0xf883,
PF_IDX_DEV_ASSET_MANAGEMENT_5 = 0xf884,
PF_IDX_DEV_ASSET_MANAGEMENT_6 = 0xf885,
PF_IDX_DEV_ASSET_MANAGEMENT_7 = 0xf886,
PF_IDX_DEV_ASSET_MANAGEMENT_8 = 0xf887,
PF_IDX_DEV_ASSET_MANAGEMENT_9 = 0xf888,
PF_IDX_DEV_ASSET_MANAGEMENT_10 = 0xf889,
PF_IDX_DEV_CONN_MON_TRIGGER = 0xfbff,
} pf_index_values_t;
CC_PACKED_BEGIN
typedef struct CC_PACKED pf_block_header
{
uint16_t block_type; /** pf_block_type_values_t */
uint16_t block_length;
uint8_t block_version_high;
uint8_t block_version_low;
} pf_block_header_t;
CC_PACKED_END
/* The following line guarantees that offsetof works as expected on received data. */
CC_STATIC_ASSERT(sizeof(pf_block_header_t) == (2+2+1+1));
/* <============================ Block header */
typedef struct pf_ndr_array
{
uint32_t maximum_count;
uint32_t offset;
uint32_t actual_count;
} pf_ndr_array_t;
typedef struct pf_ndr_data
{
uint32_t args_maximum;
uint32_t args_length;
pf_ndr_array_t array;
} pf_ndr_data_t;
typedef enum pf_control_command_bit_positions
{
PF_CONTROL_COMMAND_BIT_PRM_END = 0,
PF_CONTROL_COMMAND_BIT_APP_RDY = 1,
PF_CONTROL_COMMAND_BIT_RELEASE = 2,
PF_CONTROL_COMMAND_BIT_DONE = 3,
PF_CONTROL_COMMAND_BIT_RDY_FOR_COMPANION = 4,
PF_CONTROL_COMMAND_BIT_RDY_FOR_RTC3 = 5,
PF_CONTROL_COMMAND_BIT_PRM_BEGIN = 6,
} pf_control_command_bit_positions_t;
/** Used for both RPC control/release requests and responses */
typedef struct pf_control_block
{
pf_uuid_t ar_uuid;
uint16_t session_key;
uint16_t control_command;
uint16_t control_block_properties;
uint16_t alarm_sequence_number;
} pf_control_block_t;
typedef struct pf_ip_suite
{
/* Order is important!! */
os_ipaddr_t ip_addr;
os_ipaddr_t ip_mask;
os_ipaddr_t ip_gateway;
} pf_ip_suite_t;
typedef struct pf_full_ip_suite
{
/* Order is important!! */
pf_ip_suite_t ip_suite;
os_ipaddr_t dns_addr[4];
} pf_full_ip_suite_t;
/*
* ============= im_0_filter_data typedefs ==================
*/
typedef struct pf_im_0_filter_data_sub
{
uint16_t subslot_number; /** Allowed 0x0000.0x7FFF */
uint32_t submodule_ident_number;
} pf_im_0_filter_data_sub_t;
typedef struct pf_im_0_filter_data_mod
{
uint32_t module_ident_number;
uint16_t slot_number; /** Allowed 0x0000.0x7FFF */
uint16_t nbr_submodules;
pf_im_0_filter_data_sub_t submodules[1];
} pf_im_0_filter_data_mod_t;
typedef struct pf_im_0_filter_data_api
{
uint32_t api;
uint16_t nbr_modules;
pf_im_0_filter_data_mod_t modules[1];
} pf_im_0_filter_data_api_t;
typedef struct pf_im_0_filter_data
{
uint16_t nbr_apis;
pf_im_0_filter_data_api_t apis[1];
} pf_im_0_filter_data_t;
/*
* ============= Alarm typedefs ==================
*/
#define PF_ALARM_PDU_TYPE_VERSION_1 0x01
typedef enum pf_alarm_pdu_type_values
{
PF_RTA_PDU_TYPE_RESERVED = 0,
PF_RTA_PDU_TYPE_DATA = 1,
PF_RTA_PDU_TYPE_NACK = 2,
PF_RTA_PDU_TYPE_ACK = 3,
PF_RTA_PDU_TYPE_ERR = 4,
/* 0x05..0x0f Reserved */
} pf_alarm_pdu_type_values_t;
typedef enum pf_alarm_type_values
{
PF_ALARM_TYPE_DIAGNOSIS = 0x0001,
PF_ALARM_TYPE_PROCESS = 0x0002,
PF_ALARM_TYPE_PULL = 0x0003,
PF_ALARM_TYPE_PLUG = 0x0004,
PF_ALARM_TYPE_STATUS = 0x0005,
PF_ALARM_TYPE_UPDATE = 0x0006,
PF_ALARM_TYPE_MEDIA_REDUNDANCY = 0x0007,
PF_ALARM_TYPE_CONTROLLED_BY_SUPERVISOR = 0x0008,
PF_ALARM_TYPE_RELEASED = 0x0009,
PF_ALARM_TYPE_PLUG_WRONG_MODULE = 0x000a,
PF_ALARM_TYPE_RETURN_OF_SUBMODULE = 0x000b,
PF_ALARM_TYPE_DIAGNOSIS_DISAPPEARS = 0x000c,
PF_ALARM_TYPE_MC_COMM_MISMATCH = 0x000d,
PF_ALARM_TYPE_PORT_DATA_CHANGE = 0x000e,
PF_ALARM_TYPE_SYNC_DATA_CHANGE = 0x000f,
PF_ALARM_TYPE_ISOCHRONUOUS_MODE_PROBLEM = 0x0010,
PF_ALARM_TYPE_NETWORK_COMPONENT_PROBLEM = 0x0011,
PF_ALARM_TYPE_TIME_DATA_CHANGE = 0x0012,
PF_ALARM_TYPE_DYNAMIC_FRAME_PACKING_PROBLEM = 0x0013,
PF_ALARM_TYPE_MRPD_PROBLEM = 0x0014,
/* Reserved 0x0015 */
PF_ALARM_TYPE_MILTIPLE_INTERFACE_MISMATCH = 0x0016,
/* Reserved 0x0017..0x001d */
PF_ALARM_TYPE_UPLOAD_AND_RETRIVAL = 0x001e,
PF_ALARM_TYPE_PULL_MODULE = 0x001f,
/* Manufaturer specific 0x0020..0x007f */
/* Reserved for profiles 0x0080..0x00ff */
/* Reserved 0x0100.. 0xffff */
} pf_alarm_type_values_t;
typedef struct pf_alarm_pdu_type
{
uint8_t type; /* pf_alarm_pdu_type_values_t */
uint8_t version;
} pf_alarm_pdu_type_t;
typedef struct pf_alarm_add_flags
{
uint8_t window_size;
bool tack;
} pf_alarm_add_flags_t;
typedef struct pf_alarm_fixed
{
uint16_t dst_ref;
uint16_t src_ref;
pf_alarm_pdu_type_t pdu_type;
pf_alarm_add_flags_t add_flags;
uint16_t send_seq_num;
uint16_t ack_seq_nbr;
/*
* pf_alarm_fixed_t is followed by:
* uint16_t var_part_len; (0..1432)
* [block_header (pf_alarm_data_t/pf_alarm_err_t)]
*/
} pf_alarm_fixed_t;
typedef struct pf_alarm_data
{
uint16_t alarm_type; /* pf_alarm_type_values_t */
uint32_t api_id;
uint16_t slot_nbr;
uint16_t subslot_nbr;
uint32_t module_ident;
uint16_t submodule_ident;
pnet_alarm_spec_t alarm_specifier;
uint16_t sequence_number;
/*
* pf_alarm_data_t may be followed by alarm_payload:
* RTA-SDU = alarm_noftification_pdu | alarm_ack_pdu
*/
} pf_alarm_data_t;
typedef struct pf_alarm_ack
{
uint16_t alarm_type; /* pf_alarm_type_values_t */
uint32_t api_id;
uint16_t slot_nbr;
uint16_t subslot_nbr;
pnet_alarm_spec_t alarm_specifier;
pnet_pnio_status_t pnio_status;
} pf_alarm_ack_t;
typedef struct pf_alarm_err
{
pnet_pnio_status_t pnio_status;
/*
* pf_alarm_err_t may be followed by alarm_payload:
* vendor_device_error_info = VendorId, DeviceId, data*
*/
} pf_alarm_err_t;
/* ====== AR typedefs ============== */
typedef enum pf_ppm_state_values
{
PF_PPM_STATE_W_START = 0,
PF_PPM_STATE_RUN,
} pf_ppm_state_values_t;
typedef enum pf_cpm_state_values
{
PF_CPM_STATE_W_START = 0,
PF_CPM_STATE_FRUN,
PF_CPM_STATE_RUN,
} pf_cpm_state_values_t;
typedef enum pf_parameter_server_values
{
PF_PS_EXTERNAL_PARAMETER_SERVER,
PF_PS_CM_INITIATOR
} pf_parameter_server_values_t;
typedef enum pf_ar_type_values
{
PF_ART_IOCAR_SINGLE = 0x0001,
PF_ART_IOSAR = 0x0006, /** Supervisor AR */
PF_ART_IOCAR_SINGLE_RTC_3 = 0x0010,
PF_ART_IOCAR_SR = 0x0020, /** Set of AR */
} pf_ar_type_values_t;
typedef enum pf_iocr_type_values
{
PF_IOCR_TYPE_RESERVED_0,
PF_IOCR_TYPE_INPUT,
PF_IOCR_TYPE_OUTPUT,
PF_IOCR_TYPE_MC_PROVIDER,
PF_IOCR_TYPE_MC_CONSUMER,
} pf_iocr_type_values_t;
typedef enum pf_companion_ar_values
{
PF_CAR_SINGLE_AR,
PF_CAR_FIRST_COMPANION_AR, /** For future use */
PF_CAR_SECOND_COMPANION_AR /** For future use */
} pf_companion_ar_values_t;
typedef enum pf_rt_class_values
{
PF_RT_CLASS_1 = 1, /** Legacy: FrameID range 7 */
PF_RT_CLASS_2, /** FrameID range 6 */
PF_RT_CLASS_3, /** FrameID range 3 */
PF_RT_CLASS_UDP /** FrameID range 7 */
} pf_rt_class_values_t;
typedef enum pf_protocol_values
{
PF_PROTOCOL_DNS,
PF_PROTOCOL_DCP
} pf_protocol_values_t;
typedef enum pf_priority_values
{
PF_PRIORITY_USER,
PF_PRIORITY_FIXED
} pf_priority_values_t;
typedef enum pf_data_direction_values
{
PF_DIRECTION_INPUT = 1,
PF_DIRECTION_OUTPUT = 2,
} pf_data_direction_values_t;
typedef enum pf_end_point_1_values
{
PF_EP1_NEITHER_LEFT_NOR_ABOVE,
PF_EP1_LEFT_OR_ABOVE
} pf_end_point_1_values_t;
typedef enum pf_end_point_2_values
{
PF_EP2_NEITHER_RIGHT_NOR_BELOW,
PF_EP2_RIGHT_OR_BELOW
} pf_end_point_2_values_t;
typedef enum pf_rs_alarm_transport_mode_values
{
PF_RSA_TRANSPORT_MODE_0 = 0,
PF_RSA_TRANSPORT_MODE_1 = 1,
} pf_rs_alarm_transport_mode_values_t;
typedef enum pf_fs_parameter_mode_values
{
PF_FS_PARAMETER_MODE_ON,
PF_FS_PARAMETER_MODE__OFF
} pf_fs_parameter_mode_values_t;
typedef enum pf_ar_state_values
{
PF_AR_STATE_PRIMARY, /** default value */
PF_AR_STATE_FIRST,
PF_AR_STATE_BACKUP
} pf_ar_state_values_t;
typedef enum pf_sync_state_values
{
PF_SYNC_STATE_SYNCHRONIZED,
PF_SYNC_STATE_NOT_AVAILABLE
} pf_sync_state_values_t;
typedef enum pf_alarm_cr_type_values
{
PF_ALARM_CR = 0x0001,
} pf_alarm_cr_type_values_t;
/** According to the spec these are the states used by CMDEV/CMDEV_DA.
*
* The states for the AR is stored in cmdev_state, within the AR.
*
* An AR can be controlled by either a CMDEV or a CMDEV_DA state machine.
* This is selected by looking at ar_parameters.device_access.
* A CMDEV_DA state machine has only the states POWER_ON, W_CIND, W_CRES and DATA.
* A CMDEV state machine uses all states listed below.
*/
typedef enum pf_cmdev_state_values
{
PF_CMDEV_STATE_POWER_ON = 0, /* Data initialization. (Must be first) */
PF_CMDEV_STATE_W_CIND, /* Wait for connect indcation. */
PF_CMDEV_STATE_W_CRES, /* Wait for connect response from app and CMSU startup. */
PF_CMDEV_STATE_W_SUCNF, /* Wait for CMSU confirmation. */
PF_CMDEV_STATE_W_PEIND, /* Wait for PrmEnd indication. */
PF_CMDEV_STATE_W_PERES, /* Wait for PrmEnd response from app. */
PF_CMDEV_STATE_W_ARDY, /* Wait for app ready from app. */
PF_CMDEV_STATE_W_ARDYCNF, /* Wait for app ready confirmation from controller. */
PF_CMDEV_STATE_WDATA, /* Wait for established cyclic data exchange. */
PF_CMDEV_STATE_DATA, /* Data exchange and connection monitoring. */
PF_CMDEV_STATE_ABORT /* Abort application relation. */
} pf_cmdev_state_values_t;
/* ====================================================================== */
typedef struct pf_ar_properties
{
uint16_t state; /** Allowed values: ACTIVE (=1) */
bool supervisor_takeover_allowed;
uint8_t parameterization_server; /** pf_parameter_server_values_t */
bool device_access; /** See IEC61158-6-10 */
uint16_t companion_ar; /** pf_companion_ar_values_t */
bool acknowledge_companion_ar; /** whether companion_ar is needed */
bool combined_object_container; /** See IEC61158-6-10 */
bool startup_mode; /** false: legacy (do not use), true: advanced */
bool pull_module_alarm_allowed; /** false: mandatory support, true: optional */
} pf_ar_properties_t;
typedef struct pf_ar_param
{
bool valid;
uint16_t ar_type; /** pf_ar_type_values_t */
pf_uuid_t ar_uuid;
uint16_t session_key;
pnet_ethaddr_t cm_initiator_mac_add;
pf_uuid_t cm_initiator_object_uuid;
pf_ar_properties_t ar_properties;
uint16_t cm_initiator_activity_timeout_factor; /** res: 100ms */
uint16_t cm_initiator_udp_rt_port; /** 0x8892 */
uint16_t cm_initiator_station_name_len;
char cm_initiator_station_name[240 + 1]; /** Terminated string. */
} pf_ar_param_t;
typedef struct pf_ar_result
{
pnet_ethaddr_t cm_responder_mac_add;
uint16_t responder_udp_rt_port;
} pf_ar_result_t;
typedef struct pf_iocr_properties
{
uint32_t rt_class; /** pf_rt_class_values_t */
uint16_t reserved_1;
uint16_t reserved_2;
uint16_t reserved_3;
} pf_iocr_properties_t;
typedef struct pf_frame_descriptor
{
uint16_t slot_number;
uint16_t subslot_number;
uint16_t frame_offset;
} pf_frame_descriptor_t;
typedef struct pf_api_entry
{
uint32_t api;
uint16_t nbr_io_data;
pf_frame_descriptor_t io_data[PNET_MAX_MODULES * PNET_MAX_SUBMODULES];
uint16_t nbr_iocs;
pf_frame_descriptor_t iocs[PNET_MAX_MODULES * PNET_MAX_SUBMODULES];
} pf_api_entry_t;
typedef struct pf_iocr_tag_header
{
uint16_t vlan_id; /** Bits 0..11. Default: 0 */
uint16_t iocr_user_priority; /** Bits 12..15. Allowed: IOCR_PRIORITY = 6 */
} pf_iocr_tag_header_t;
typedef struct pf_iocr_param
{
bool valid;
uint16_t iocr_type; /** pf_iocr_type_values_t */
uint16_t iocr_reference; /** Cross-ref from e.g. mcr_request and ir_info */
uint16_t lt_field; /** Allowed: 0x8892 */
pf_iocr_properties_t iocr_properties;
uint16_t c_sdu_length; /** Allowed: RT_CLASS_UDP: 12..1440, others: 40..1440 */
uint16_t frame_id; /** Depends on RT_class */
uint16_t send_clock_factor; /** res: 31.25us, Allowed: 1..128, default: 32 */
uint16_t reduction_ratio;
uint16_t phase; /** 1..reduction_ratio */
uint16_t sequence; /** Allowed: RT_class_3: 0, others: 0 (mandatory) 1..0xffff (optional) */
uint32_t frame_send_offset; /** res: 1ns, Allowed: (All:) BEST_EFFORT (0xffffffff), RT_class_3: 0x0..0x3D08FF (mandatory) */
uint32_t watchdog_factor;
uint16_t data_hold_factor; /** Allowed: 0x0000..0x1e00, more restrictions apply */
pf_iocr_tag_header_t iocr_tag_header;
pnet_ethaddr_t iocr_multicast_mac_add; /** See IEC61158-6-10 */
uint16_t nbr_apis;
pf_api_entry_t apis[PNET_MAX_API];
} pf_iocr_param_t;
typedef struct pf_iocr_result
{
uint16_t iocr_type; /** pf_iocr_type_values_t */
uint16_t iocr_reference;
uint16_t frame_id;
} pf_iocr_result_t;
typedef struct pf_data_descriptor
{
uint16_t data_direction; /** pf_data_direction_values_t */
uint16_t submodule_data_length; /** Allowed: 0..1439 */
uint8_t length_iops; /** Allowed: 1 */
uint8_t length_iocs; /** Allowed: 1 */
} pf_data_descriptor_t;
typedef struct pf_submodule_properties
{
uint8_t type; /** Bits 0..1: pnet_submodule_dir_t */
bool sharedInput;
bool reduce_input_submodule_data_length;
bool reduce_output_submodule_data_length;
bool discard_ioxs;
} pf_submodule_properties_t;
typedef struct pf_exp_submodule
{
uint16_t subslot_number; /** Allowed: 0x0000..0x9FFF */
uint32_t submodule_ident_number;
pf_submodule_properties_t submodule_properties;
uint16_t nbr_data_descriptors;
pf_data_descriptor_t data_descriptor[2]; /** 2 used for PNET_DIR_IO */
} pf_exp_submodule_t;
typedef struct pf_exp_module
{
uint16_t slot_number; /** Allowed 0x0000.0x7FFF */
uint32_t module_ident_number;
uint16_t module_properties; /** Reserved - currently unused */
uint16_t nbr_submodules;
pf_exp_submodule_t submodules[PNET_MAX_SUBMODULES];
} pf_exp_module_t;
typedef struct pf_exp_api
{
bool valid;
uint32_t api;
uint16_t nbr_modules;
pf_exp_module_t modules[PNET_MAX_MODULES];
} pf_exp_api_t;
typedef struct pf_submodule_state
{
uint8_t add_info; /** Bits 0..2: pf_submod_add_info_t */
bool advice_avail; /** Bit 3 */
bool maintenance_required; /** Bit 4 */
bool maintenance_demanded; /** Bit 5 */
bool fault; /** Bit 6 */
uint8_t ar_info; /** Bits 7..10: pf_submod_ar_info_t */
uint8_t ident_info; /** Bits 11..14: pf_ident_info_values_t */
bool format_indicator; /** Bit 15: Always 1 (true) */
} pf_submodule_state_t;
typedef struct pf_submodule_diff
{
uint16_t subslot_number;
uint32_t submodule_ident_number;
pf_submodule_state_t submodule_state;
} pf_submodule_diff_t;
typedef struct pf_module_diff
{
uint16_t slot_number;
uint32_t module_ident_number;
uint16_t module_state; /** pf_module_state_values_t */
uint16_t nbr_submodule_diffs;
pf_submodule_diff_t submodule_diffs[PNET_MAX_SUBMODULES];
} pf_module_diff_t;
typedef struct pf_api_diff
{
uint32_t api;
uint16_t nbr_module_diffs;
pf_module_diff_t module_diffs[PNET_MAX_MODULES];
} pf_api_diff_t;
typedef struct pf_parameter_server_properties
{
uint32_t reserved; /** Currently unused */
} pf_parameter_server_properties_t;
typedef struct pf_prm_server
{
bool valid;
pf_uuid_t parameter_server_object_uuid;
pf_parameter_server_properties_t parameter_server_properties; /** Allowed: 0 */
uint16_t cm_initiator_activity_timeout_factor; /** res: 100ms, allowed 1..1000 */
uint16_t parameter_server_station_name_len;
char parameter_server_station_name[240 + 1];/** Terminated */
} pf_prm_server_t;
typedef struct pf_address_resolution_properties
{
uint8_t protocol; /** pf_protocol_values_t */
uint8_t resolution_factor; /** range: 1..0x64 */
} pf_address_resolution_properties_t;
typedef struct pf_multicast_cr
{
bool valid;
uint16_t iocr_reference;
pf_address_resolution_properties_t address_resolution_properties;
uint16_t mci_timeout_factor; /* MCI_timeout range 0x0001..0xffff */
uint16_t length_provider_station_name;
char provider_station_name[240 + 1]; /** Terminated */
} pf_multicast_cr_t;
typedef struct pf_ar_rpc_request
{
bool valid; /** Requested in connect.req */
uint16_t initiator_rpc_server_port; /** Allowed 0x0000..0x03ff (optional), 0x0400..0xbfff (usable), 0xc000..0xffff (recommended) */
} pf_ar_rpc_request_t;
typedef struct pf_ar_rpc_result
{
uint16_t responder_rpc_server_port; /** Allowed 0x0000..0x03ff (optional), 0x0400..0xbfff (usable), 0xc000..0xffff (recommended) */
} pf_ar_rpc_result_t;
typedef struct pf_subframe_data
{
uint8_t subframe_position;
uint8_t subframe_length;
} pf_subframe_data_t;
typedef struct pf_dfp_iocr
{
uint16_t iocr_reference;
uint16_t subframe_offset; /** Range: 0..0x59B */
pf_subframe_data_t subframe_data;
} pf_dfp_iocr_t;
typedef struct pf_ir_info