aboutsummaryrefslogtreecommitdiff
path: root/platform/linux-generic/include/odp/api/plat/packet_inline_types.h
blob: e819c48a30a433fa521b7427300bf43e58438742 (plain)
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
/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2015-2018 Linaro Limited
 * Copyright (c) 2019-2022 Nokia
 */


/**
 * @file
 *
 * ODP packet descriptor
 */

#ifndef ODP_PACKET_INLINE_TYPES_H_
#define ODP_PACKET_INLINE_TYPES_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

/** @cond _ODP_HIDE_FROM_DOXYGEN_ */

/* Packet field accessor */
#define _odp_pkt_get(pkt, cast, field) \
	(*(cast *)(uintptr_t)((uint8_t *)pkt + _odp_packet_inline.field))

#define _odp_pkt_get_ptr(pkt, cast, field) \
	((cast *)(uintptr_t)((uint8_t *)pkt + _odp_packet_inline.field))

/* Packet header field offsets for inline functions */
typedef struct _odp_packet_inline_offset_t {
	uint16_t seg_data;
	uint16_t seg_len;
	uint16_t seg_next;
	uint16_t frame_len;
	uint16_t headroom;
	uint16_t tailroom;
	uint16_t pool;
	uint16_t input;
	uint16_t seg_count;
	uint16_t user_ptr;
	uint16_t user_area;
	uint16_t l2_offset;
	uint16_t l3_offset;
	uint16_t l4_offset;
	uint16_t flow_hash;
	uint16_t timestamp;
	uint16_t input_flags;
	uint16_t flags;
	uint16_t cls_mark;
	uint16_t ipsec_ctx;
	uint16_t crypto_op;

} _odp_packet_inline_offset_t;

extern const _odp_packet_inline_offset_t _odp_packet_inline;

/* Packet input & protocol flags */
typedef union {
	/* All input flags */
	uint64_t all;

	/* Individual input flags */
	struct {
		uint64_t dst_queue:1; /* Dst queue present */
		uint64_t cls_mark: 1; /* Classifier mark value present*/

		uint64_t flow_hash:1; /* Flow hash present */
		uint64_t timestamp:1; /* Timestamp present */

		uint64_t l2:1;        /* known L2 protocol present */
		uint64_t l3:1;        /* known L3 protocol present */
		uint64_t l4:1;        /* known L4 protocol present */

		uint64_t eth:1;       /* Ethernet */
		uint64_t eth_bcast:1; /* Ethernet broadcast */
		uint64_t eth_mcast:1; /* Ethernet multicast */
		uint64_t jumbo:1;     /* Jumbo frame */
		uint64_t vlan:1;      /* VLAN hdr found */
		uint64_t vlan_qinq:1; /* Stacked VLAN found, QinQ */

		uint64_t snap:1;      /* SNAP */
		uint64_t arp:1;       /* ARP */

		uint64_t ipv4:1;      /* IPv4 */
		uint64_t ipv6:1;      /* IPv6 */
		uint64_t ip_bcast:1;  /* IP broadcast */
		uint64_t ip_mcast:1;  /* IP multicast */
		uint64_t ipfrag:1;    /* IP fragment */
		uint64_t ipopt:1;     /* IP optional headers */

		uint64_t ipsec:1;     /* IPSec packet. Required by the
					   odp_packet_has_ipsec_set() func. */
		uint64_t ipsec_ah:1;  /* IPSec authentication header */
		uint64_t ipsec_esp:1; /* IPSec encapsulating security
					   payload */
		uint64_t udp:1;       /* UDP */
		uint64_t tcp:1;       /* TCP */
		uint64_t sctp:1;      /* SCTP */
		uint64_t icmp:1;      /* ICMP */
		uint64_t no_next_hdr:1; /* No Next Header */

		uint64_t color:2;     /* Packet color for traffic mgmt */
		uint64_t nodrop:1;    /* Drop eligibility status */

		uint64_t l3_chksum_done:1; /* L3 checksum validation done */
		uint64_t l4_chksum_done:1; /* L4 checksum validation done */
		uint64_t ipsec_udp:1; /* UDP-encapsulated IPsec packet */
		uint64_t udp_chksum_zero:1; /* UDP header had 0 as chksum */
	};

} _odp_packet_input_flags_t;

/*
 * Additional packet flags
 */
typedef union {
	/* All flags */
	uint32_t all_flags;

	struct {
		uint32_t reserved1:      4;

	/*
	 * Init flags
	 */
		uint32_t user_ptr_set:   1; /* User has set a non-NULL value */
		uint32_t user_flag:      1;

	/*
	 * Packet output flags
	 */
		uint32_t lso:            1; /* LSO requested */
		uint32_t payload_off:    1; /* Payload offset is valid */
		uint32_t l3_chksum_set:  1; /* L3 chksum bit is valid */
		uint32_t l3_chksum:      1; /* L3 chksum override */
		uint32_t l4_chksum_set:  1; /* L4 chksum bit is valid */
		uint32_t l4_chksum:      1; /* L4 chksum override */
		uint32_t ts_set:         1; /* Set Tx timestamp */
		uint32_t tx_compl_ev:    1; /* Tx completion event requested */
		uint32_t tx_compl_poll:  1; /* Tx completion poll requested */
		uint32_t free_ctrl:      1; /* Don't free option */
		uint32_t tx_aging:       1; /* Packet aging at Tx requested */
		uint32_t shaper_len_adj: 8; /* Adjustment for traffic mgr */

	/*
	 * Error flags
	 */
		uint32_t snap_len_err:   1; /* Snap length error */
		uint32_t ip_err:         1; /* IP error */
		uint32_t l3_chksum_err:  1; /* L3 checksum error */
		uint32_t tcp_err:        1; /* TCP error */
		uint32_t udp_err:        1; /* UDP error */
		uint32_t sctp_err:       1; /* SCTP error */
		uint32_t l4_chksum_err:  1; /* L4 checksum error */
	};

	/* Flag groups */
	struct {
		uint32_t reserved2:      4;
		uint32_t other:         21; /* All other flags */
		uint32_t error:          7; /* All error flags */
	} all;

} _odp_packet_flags_t;

/** @endcond */

#ifdef __cplusplus
}
#endif

#endif