-
Notifications
You must be signed in to change notification settings - Fork 203
/
Copy pathpf_types.h
2877 lines (2504 loc) · 84.4 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
#ifdef ATOMIC_VAR_INIT
#undef ATOMIC_VAR_INIT
#endif
#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
#define PF_RPC_SERVER_PORT 0x8894 /* PROFInet Context Manager */
#define PF_UDP_UNICAST_PORT 0x8892
#define PF_RPC_CCONTROL_EPHEMERAL_PORT 0xc001
#define PF_FRAME_BUFFER_SIZE 1500
/** This should be smaller than PF_FRAME_BUFFER_SIZE with the maximum size of
* IP- and UDP headers, and some margin. Linux will fragment frames if this is
* larger than 1464. */
#define PF_MAX_UDP_PAYLOAD_SIZE 1440
/**
* Timeout in milliseconds after which the CControl request is re-transmitted.
*/
#define PF_CCONTROL_TIMEOUT 2000
#define PF_FRAG_TIMEOUT 2000
/** Time between Ethernet link status checks, in microseconds */
#define PF_LINK_MONITOR_INTERVAL 100000
/** One neighbour shall be checked for PDPortDataCheck
* See Profinet 2.4 protocol, section 5.2.13.3
*/
#define PF_CHECK_PEERS_PER_PORT 1
/** Including termination */
#define PF_ALIAS_NAME_MAX_SIZE \
(PNET_STATION_NAME_MAX_SIZE + PNET_PORT_NAME_MAX_SIZE)
/************************* Diagnosis ******************************************/
#define PF_DIAG_QUALIFIED_SEVERITY_MASK ~0x00000007
#define PF_DIAG_BIT_MAINTENANCE_REQUIRED BIT (0)
#define PF_DIAG_BIT_MAINTENANCE_DEMANDED BIT (1)
/** Qualifier 31..27 */
#define PF_DIAG_QUALIFIER_MASK_FAULT 0xF8000000
/** Qualifier 26..17 */
#define PF_DIAG_QUALIFIER_MASK_DEMANDED 0x07FE0000
/** Qualifier 16..7 */
#define PF_DIAG_QUALIFIER_MASK_REQUIRED 0x0001FF80
/** Qualifier 6..3 */
#define PF_DIAG_QUALIFIER_MASK_ADVICE 0x00000078
/* ch_properties channel size in bits
See also pnet_diag_ch_prop_type_values_t */
#define PF_DIAG_CH_PROP_TYPE_MASK 0x00ff
#define PF_DIAG_CH_PROP_TYPE_POS 0
#define PF_DIAG_CH_PROP_TYPE_GET(x) \
(((X)&PF_DIAG_CH_PROP_TYPE_MASK) >> PF_DIAG_CH_PROP_TYPE_POS)
#define PF_DIAG_CH_PROP_TYPE_SET(x, v) \
do \
{ \
(x) &= ~PF_DIAG_CH_PROP_TYPE_MASK; \
(x) |= (v) << PF_DIAG_CH_PROP_TYPE_POS; \
} while (0)
/* ch_properties channel group or individual channel
See also pnet_diag_ch_group_values_t */
#define PF_DIAG_CH_PROP_ACC_MASK 0x0100
#define PF_DIAG_CH_PROP_ACC_POS 8
#define PF_DIAG_CH_PROP_ACC_GET(x) \
(((x)&PF_DIAG_CH_PROP_ACC_MASK) >> PF_DIAG_CH_PROP_ACC_POS)
#define PF_DIAG_CH_PROP_ACC_SET(x, v) \
do \
{ \
(x) &= ~PF_DIAG_CH_PROP_ACC_MASK; \
(x) |= (v) << PF_DIAG_CH_PROP_ACC_POS; \
} while (0)
/* ch_properties diagnosis severity
See also pnet_diag_ch_prop_maint_values_t */
#define PF_DIAG_CH_PROP_MAINT_MASK 0x0600
#define PF_DIAG_CH_PROP_MAINT_POS 9
#define PF_DIAG_CH_PROP_MAINT_GET(x) \
(((x)&PF_DIAG_CH_PROP_MAINT_MASK) >> PF_DIAG_CH_PROP_MAINT_POS)
#define PF_DIAG_CH_PROP_MAINT_SET(x, v) \
do \
{ \
(x) &= ~PF_DIAG_CH_PROP_MAINT_MASK; \
(x) |= (v) << PF_DIAG_CH_PROP_MAINT_POS; \
} while (0)
/* ch_properties appears or disappers */
#define PF_DIAG_CH_PROP_SPEC_MASK 0x1800
#define PF_DIAG_CH_PROP_SPEC_POS 11
#define PF_DIAG_CH_PROP_SPEC_GET(x) \
(((x)&PF_DIAG_CH_PROP_SPEC_MASK) >> PF_DIAG_CH_PROP_SPEC_POS)
#define PF_DIAG_CH_PROP_SPEC_SET(x, v) \
do \
{ \
(x) &= ~PF_DIAG_CH_PROP_SPEC_MASK; \
(x) |= (v) << PF_DIAG_CH_PROP_SPEC_POS; \
} while (0)
typedef enum pf_diag_ch_prop_spec_values
{
PF_DIAG_CH_PROP_SPEC_ALL_DISAPPEARS = 0,
PF_DIAG_CH_PROP_SPEC_APPEARS = 1,
PF_DIAG_CH_PROP_SPEC_DISAPPEARS = 2,
PF_DIAG_CH_PROP_SPEC_DIS_OTHERS_REMAIN = 3,
} pf_diag_ch_prop_spec_values_t;
/* ch_properties direction
See also pnet_diag_ch_prop_dir_values_t */
#define PF_DIAG_CH_PROP_DIR_MASK 0xe000
#define PF_DIAG_CH_PROP_DIR_POS 13
#define PF_DIAG_CH_PROP_DIR_GET(x) \
(((x)&PF_DIAG_CH_PROP_DIR_MASK) >> PF_DIAG_CH_PROP_DIR_POS)
#define PF_DIAG_CH_PROP_DIR_SET(x, v) \
do \
{ \
(x) &= ~PF_DIAG_CH_PROP_DIR_MASK; \
(x) |= (v) << PF_DIAG_CH_PROP_DIR_POS; \
} while (0)
/*********************** RPC header ******************************************/
typedef enum pf_rpc_packet_type_values
{
PF_RPC_PT_REQUEST = 0, //!< PF_RPC_PT_REQUEST
PF_RPC_PT_PING, //!< PF_RPC_PT_PING
PF_RPC_PT_RESPONSE, //!< PF_RPC_PT_RESPONSE
PF_RPC_PT_FAULT, //!< PF_RPC_PT_FAULT
PF_RPC_PT_WORKING, //!< PF_RPC_PT_WORKING
PF_RPC_PT_RESP_PING,
/* No Call - response to ping */ //!< PF_RPC_PT_RESP_PING
PF_RPC_PT_REJECT, //!< PF_RPC_PT_REJECT
PF_RPC_PT_ACK, //!< PF_RPC_PT_ACK
PF_RPC_PT_CL_CANCEL, //!< PF_RPC_PT_CL_CANCEL
PF_RPC_PT_FRAG_ACK, //!< PF_RPC_PT_FRAG_ACK
PF_RPC_PT_CANCEL_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;
/* PN-AL-protocol (Mar20) Table 725 */
typedef enum pf_link_state_link
{
PF_PD_LINK_STATE_LINK_RESERVED = 0,
PF_PD_LINK_STATE_LINK_UP = 1,
PF_PD_LINK_STATE_LINK_DOWN = 2,
PF_PD_LINK_STATE_LINK_TESTING = 3,
PF_PD_LINK_STATE_LINK_UNKNOWN = 4,
PF_PD_LINK_STATE_LINK_DORMANT = 5,
PF_PD_LINK_STATE_LINK_NOTPRESENT = 6,
PF_PD_LINK_STATE_LINK_LOWERLAYERDOWN = 7
} pf_link_state_link_t;
/* PN-AL-protocol (Mar20) Table 726 */
typedef enum pf_link_state_port
{
PF_PD_LINK_STATE_PORT_UNKNOWN = 0,
PF_PD_LINK_STATE_PORT_DISABLED = 1,
PF_PD_LINK_STATE_PORT_BLOCKING = 2,
PF_PD_LINK_STATE_PORT_LISTENING = 3,
PF_PD_LINK_STATE_PORT_LEARNING = 4,
PF_PD_LINK_STATE_PORT_FORWARDING = 5,
PF_PD_LINK_STATE_PORT_BROKEN = 6
} pf_link_state_port_t;
/* PN-AL-protocol (Mar20) Table 727 */
typedef enum pf_mediatype_values
{
PF_PD_MEDIATYPE_UNKNOWN = 0,
PF_PD_MEDIATYPE_COPPER,
PF_PD_MEDIATYPE_FIBER,
PF_PD_MEDIATYPE_RADIO
} pf_mediatype_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;
typedef enum pf_write_req_error_type_values
{
PF_WRT_ERROR_REMOTE_MISMATCH = 0x8001
} pf_write_req_error_type_t;
typedef enum pf_write_req_ext_error_type_values
{
PF_WRT_ERROR_PEER_STATIONNAME_MISMATCH = 0x8000,
PF_WRT_ERROR_PEER_PORTNAME_MISMATCH = 0x8001,
PF_WRT_ERROR_NO_PEER_DETECTED = 0x8005
} pf_write_req_ext_error_type_t;
/*
* RPC and EPM implementation
* PN-AL-protocol (Mar20) Section 4.10.3
*/
#define PF_RPC_TOWER_REFERENTID 3
#define PF_RPC_TOWER_FLOOR_COUNT 5
#define PF_RPC_FLOOR_VERSION_EPMv4 3
#define PF_RPC_FLOOR_VERSION_NPR 2
#define PF_RPC_FLOOR_VERSION_PNIO 1
#define PF_RPC_FLOOR_VERSION_MINOR 0
#define PF_RPC_EPM_ANNOTATION_OFFSET 0
#define PF_RPC_EPM_ANNOTATION_LENGTH 64
#define PF_RPC_EPM_FLOOR_LENGTH 75
typedef enum pf_rpc_protocol_type
{
PF_RPC_PROTOCOL_DOD_UDP = 0x08,
PF_RPC_PROTOCOL_DOD_IP = 0x09,
PF_RPC_PROTOCOL_CONNECTIONLESS = 0x0a,
PF_RPC_PROTOCOL_UUID = 0x0d
} pf_rpc_protocol_type_t;
/* PN-AL-protocol (Mar20) Table 328 */
typedef enum pf_rpc_inquiry_type
{
PF_RPC_INQUIRY_READ_ALL_REGISTERED_INTERFACES = 0, /*mandatory*/
PF_RPC_INQUIRY_READ_ALL_OBJECTS_FOR_ONE_INTERFACE = 1, /*optional*/
PF_RPC_INQUIRY_READ_ALL_INTERFACES_INCLUDING_OBJECTS = 2, /*optional*/
PF_RPC_INQUIRY_READ_ONE_INTERFACE_WITH_ONE_OBJECT = 3 /*optional*/
} pf_rpc_inquiry_type_t;
/* PN-AL-protocol (Mar20) Table 329 */
typedef enum pf_rpc_error_value
{
PF_RPC_OK = 0,
PF_RPC_NOT_REGISTERED = 0x16c9a0d6, /* Endpoint not registered */
} pf_rpc_error_value_t;
typedef enum
{
PF_EPM_TYPE_NONE = 0,
PF_EPM_TYPE_EPMV4,
PF_EPM_TYPE_PNIO
} pf_rpc_epm_type_t;
/* Described in DCP 1.1 Appendix A */
typedef struct pf_rpc_uuid_type
{
uint32_t time_low;
uint16_t time_mid;
uint16_t time_hi_and_version;
uint8_t clock_hi_and_reserved;
uint8_t clock_low;
uint8_t node[6];
} pf_rpc_uuid_type_t;
/* Used for definition of epm protocol tower floors 1 and 2. */
typedef struct pf_floor_uuid_t
{
uint8_t protocol_id;
pf_rpc_uuid_type_t uuid;
uint16_t version_major;
uint16_t version_minor;
} pf_floor_uuid_t;
typedef struct pf_floor_3_t
{
uint8_t protocol_id;
uint16_t version_minor;
} pf_floor_3_t;
typedef struct pf_floor_4_t
{
uint8_t protocol_id;
uint16_t port;
} pf_floor_4_t;
typedef struct pf_floor_5_t
{
uint8_t protocol_id;
uint32_t ip_address;
} pf_floor_5_t;
typedef struct pf_rpc_tower
{
pf_floor_uuid_t floor_1;
pf_floor_uuid_t floor_2;
pf_floor_3_t floor_3;
pf_floor_4_t floor_4;
pf_floor_5_t floor_5;
pnet_cfg_t * p_cfg; /* Used for generation of annotation string*/
} pf_rpc_tower_t;
typedef struct pf_rpc_entry
{
pf_rpc_epm_type_t epm_type;
uint32_t max_count;
uint32_t offset;
uint32_t actual_count;
pf_rpc_uuid_type_t object_uuid;
pf_rpc_tower_t tower_entry;
} pf_rpc_entry_t;
typedef struct pf_rpc_handle
{
uint32_t rpc_entry_handle;
pf_rpc_uuid_type_t handle_uuid;
} pf_rpc_handle_t;
/*
* See PN-AL-protocol (Mar20) Table 310 RPC substitutions
* for definitions of rpc lookup response
*/
typedef struct pf_rpc_lookup_rsp
{
pf_rpc_handle_t rpc_handle;
uint32_t num_entry;
pf_rpc_entry_t rpc_entry;
uint32_t return_code;
} pf_rpc_lookup_rsp_t;
typedef struct pf_rpc_lookup_req
{
uint32_t inquiry_type;
uint32_t object_id;
pf_uuid_t object_uuid;
uint32_t interface_id;
pf_uuid_t interface_uuid;
uint16_t interface_ver_major;
uint16_t interface_ver_minor;
uint32_t version_option;
pf_rpc_handle_t rpc_handle;
uint32_t max_entries;
uint16_t udpPort;
} pf_rpc_lookup_req_t;
/************************** 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_PDPORTCHECK = 0x0200,
PF_BT_CHECKPEERS = 0x020a,
PF_BT_PDPORTDATAREAL = 0x020f,
PF_BT_BOUNDARY_ADJUST = 0x0202,
PF_BT_PEER_TO_PEER_BOUNDARY = 0x0224,
PF_BT_INTERFACE_REAL_DATA = 0x0240,
PF_BT_INTERFACE_ADJUST = 0x0250,
PF_BT_PORT_STATISTICS = 0x0251,
PF_BT_MULTIPLEBLOCK_HEADER = 0x0400,
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_PDPORT_SPF_CHECK = 0x8063,
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_TSN_NETWORK_CONTROL_DATA_REAL = 0x80f0,
PF_IDX_TSN_STREAM_PATH_DATA = 0x80f1,
PF_IDX_TSN_SYNC_TREE_DATA = 0x80f2,
PF_IDX_TSN_UPLOAD_NETWORK_ATTRIBUTES = 0x80f3,
PF_IDX_TSN_EXPECTED_NETWORK_ATTRIBUTES = 0x80f4,
PF_IDX_TSN_NETWORK_CONTROL_DATA_ADJUST = 0x80f5,
PF_IDX_SUB_PDINTF_SECURITY_ADJUST = 0x8200,
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_APPLICATION_READY = 0xe041, /* Closes parameterization phase */
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_TSN_STREAM_ADD = 0xf8f0,
PF_IDX_PDRSI_INSTANCDES = 0xf8f1,
PF_IDX_TSN_STREAM_REMOVE = 0xf8f2,
PF_IDX_TSN_STREAM_RENEW = 0xf8f3,
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!! */
pnal_ipaddr_t ip_addr;
pnal_ipaddr_t ip_mask;
pnal_ipaddr_t ip_gateway;
} pf_ip_suite_t;
typedef struct pf_full_ip_suite
{
/* Order is important!! */
pf_ip_suite_t ip_suite;
pnal_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_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;
typedef struct pf_diag_std
{
uint32_t ext_ch_add_value;
uint32_t qual_ch_qualifier;
uint16_t ch_nbr;
uint16_t ch_properties; /* Appears, direction, channelgroup etc */
uint16_t ch_error_type;
uint16_t ext_ch_error_type;
} pf_diag_std_t;
typedef struct pf_diag_usi
{
/* Number of bytes of manufacturer data */
uint16_t len;
uint8_t manuf_data[PNET_MAX_DIAG_MANUF_DATA_SIZE];
} pf_diag_usi_t;
/* This is the end of list designator. */
#define PF_DIAG_IX_NULL UINT16_MAX
typedef struct pf_diag_item
{
/* The selector is the usi member (0x0000..0x7fff => usi, else std) */
union fmt
{
pf_diag_std_t std;
pf_diag_usi_t usi;
} fmt;
bool in_use;
uint16_t usi; /* pf_usi_values_t */
uint16_t next; /* Next in list (array index) */
} pf_diag_item_t;
typedef struct pf_alarm_payload
{
uint16_t usi;
/* Number of bytes of manufacturer data */
uint16_t len;
/* pf_diag_item_t or manufacturer data */
uint8_t data[PNET_MAX_ALARM_PAYLOAD_DATA_SIZE];
} pf_alarm_payload_t;
/* See also pnet_alarm_argument_t for a subset */
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; /* Booleans for diagnosis alarms. */
uint16_t sequence_number;
/*
* pf_alarm_data_t may be followed by alarm_payload:
* RTA-SDU = alarm_noftification_pdu | alarm_ack_pdu
*/
pf_alarm_payload_t payload;
} pf_alarm_data_t;
typedef struct pf_alarm_queue
{
pf_alarm_data_t items[PNET_MAX_ALARMS];
uint16_t write_index;
uint16_t read_index;
uint16_t count;
} pf_alarm_queue_t;
#define PF_MAX_SESSION (2 * (PNET_MAX_AR) + 1) /* 2 per ar, and one spare. */
/*
* Keep this value small as it define the number of entries in the
* frame id map and all entries are probed until a match is found.
*