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
|
/*
* This file is part of the UWB stack for linux.
*
* Copyright (c) 2020-2022 Qorvo US, Inc.
*
* This software is provided under the GNU General Public License, version 2
* (GPLv2), as well as under a Qorvo commercial license.
*
* You may choose to use this software under the terms of the GPLv2 License,
* version 2 ("GPLv2"), as published by the Free Software Foundation.
* You should have received a copy of the GPLv2 along with this program. If
* not, see <http://www.gnu.org/licenses/>.
*
* This program is distributed under the GPLv2 in the hope that it will be
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GPLv2 for more
* details.
*
* If you cannot meet the requirements of the GPLv2, you may not use this
* software for any purpose without first obtaining a commercial license from
* Qorvo. Please contact Qorvo to inquire about licensing terms.
*/
#ifndef FIRA_FRAME_H
#define FIRA_FRAME_H
#include <linux/types.h>
struct fira_local;
struct fira_session;
struct fira_slot;
struct sk_buff;
struct mcps802154_ie_get_context;
struct fira_session_params;
#define FIRA_IE_VENDOR_OUI_LEN 3
#define FIRA_IE_HEADER_PADDING_LEN 8
#define FIRA_IE_HEADER_SESSION_ID_LEN 4
#define FIRA_IE_HEADER_STS_INDEX_LEN 4
#define FIRA_IE_HEADER_LEN \
(FIRA_IE_VENDOR_OUI_LEN + FIRA_IE_HEADER_PADDING_LEN + \
FIRA_IE_HEADER_SESSION_ID_LEN + FIRA_IE_HEADER_STS_INDEX_LEN)
#define FIRA_IE_PAYLOAD_CONTROL_LEN(n_mngt) \
(FIRA_IE_VENDOR_OUI_LEN + 4 + 4 * (n_mngt))
#define FIRA_IE_PAYLOAD_MEASUREMENT_REPORT_TYPE1_LEN(round_index_present, \
n_reply_time) \
(FIRA_IE_VENDOR_OUI_LEN + 2 + 2 * (round_index_present) + 4 + \
6 * (n_reply_time))
#define FIRA_IE_PAYLOAD_MEASUREMENT_REPORT_TYPE2_LEN( \
round_index_present, reply_time_present, n_reply_time) \
(FIRA_IE_VENDOR_OUI_LEN + 3 + 2 * (round_index_present) + \
4 * (reply_time_present) + 6 * (n_reply_time))
#define FIRA_IE_PAYLOAD_RESULT_REPORT_LEN(tof_present, aoa_azimuth_present, \
aoa_elevation_present, \
aoa_fom_present, neg_tof_present) \
(FIRA_IE_VENDOR_OUI_LEN + 2 + 4 * (tof_present) + \
2 * (aoa_azimuth_present) + 2 * (aoa_elevation_present) + \
(aoa_fom_present) * \
(1 * (aoa_azimuth_present) + 1 * (aoa_elevation_present)) + \
4 * (neg_tof_present))
#define FIRA_MIC_LEVEL 64
#define FIRA_MIC_LEN (FIRA_MIC_LEVEL / 8)
/* 3 IE headers in the frame : vendor IE, header terminator and payload. */
#define FIRA_FRAME_WITHOUT_PAYLOAD_LEN \
(IEEE802154_FC_LEN + IEEE802154_SCF_LEN + IEEE802154_SHORT_ADDR_LEN + \
3 * IEEE802154_IE_HEADER_LEN + FIRA_IE_HEADER_LEN + FIRA_MIC_LEN + \
IEEE802154_FCS_LEN)
#define FIRA_IE_VENDOR_OUI 0x5a18ff
#define FIRA_IE_HEADER_PADDING 0x08
#define FIRA_MNGT_RANGING_ROLE (1 << 0)
#define FIRA_MNGT_SLOT_INDEX (0xff << 1)
#define FIRA_MNGT_SHORT_ADDR (0xffff << 9)
#define FIRA_MNGT_MESSAGE_ID (0xf << 25)
#define FIRA_MNGT_STOP (1 << 29)
#define FIRA_MNGT_RESERVED (0x3U << 30)
#define FIRA_MEASUREMENT_REPORT_CONTROL_HOPPING_MODE (1 << 0)
#define FIRA_MEASUREMENT_REPORT_CONTROL_ROUND_INDEX_PRESENT (1 << 1)
#define FIRA_MEASUREMENT_REPORT_CONTROL_N_REPLY_TIME (0x3f << 2)
#define FIRA_MEASUREMENT_REPORT_CONTROL_REPLY_TIME_PRESENT (1 << 0)
#define FIRA_RESULT_REPORT_CONTROL_TOF_PRESENT (1 << 0)
#define FIRA_RESULT_REPORT_CONTROL_AOA_AZIMUTH_PRESENT (1 << 1)
#define FIRA_RESULT_REPORT_CONTROL_AOA_ELEVATION_PRESENT (1 << 2)
#define FIRA_RESULT_REPORT_CONTROL_AOA_FOM_PRESENT (1 << 3)
#define FIRA_RESULT_REPORT_CONTROL_NEG_TOF_PRESENT (1 << 4)
/**
* fira_frame_check_n_controlees() - Check the number of wanted
* controlees.
* @session: Current session.
* @n_controlees: Wanted number of controlees.
* @active: Is the session (supposed to be) active?
*
* Return: true if number of controlees fits.
*
* For an inactive session, the number of controlees is limited by the list
* size, aka FIRA_CONTROLEES_MAX.
* For an active session, it depends on the space left in messages, which is
* determined by the session parameters.
*/
bool fira_frame_check_n_controlees(const struct fira_session *session,
size_t n_controlees, bool active);
/**
* fira_frame_header_put() - Fill FiRa frame header.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
*/
void fira_frame_header_put(const struct fira_local *local,
const struct fira_slot *slot, struct sk_buff *skb);
/**
* fira_frame_control_payload_put() - Fill FiRa frame payload for a control
* message.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
*/
void fira_frame_control_payload_put(const struct fira_local *local,
const struct fira_slot *slot,
struct sk_buff *skb);
/**
* fira_frame_measurement_report_payload_put() - Fill FiRa frame payload for
* a measurement report message.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
*/
void fira_frame_measurement_report_payload_put(const struct fira_local *local,
const struct fira_slot *slot,
struct sk_buff *skb);
/**
* fira_frame_result_report_payload_put() - Fill FiRa frame payload for a result
* report message.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
*/
void fira_frame_result_report_payload_put(const struct fira_local *local,
const struct fira_slot *slot,
struct sk_buff *skb);
/**
* fira_frame_rframe_payload_put() - Check availability of a custom data
* payload, write it to tx frame.
* @local: FiRa context.
* @skb: Frame buffer.
*/
void fira_frame_rframe_payload_put(struct fira_local *local,
struct sk_buff *skb);
/**
* fira_frame_header_check() - Check and consume FiRa header.
* @local: FiRa context.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must be zero initialized.
* @phy_sts_index: STS index read from header.
* @session_id: Session id read from header.
*
* Return: true if header is correct.
*/
bool fira_frame_header_check(const struct fira_local *local,
struct sk_buff *skb,
struct mcps802154_ie_get_context *ie_get,
u32 *phy_sts_index, u32 *session_id);
/**
* fira_frame_control_payload_check() - Check FiRa frame payload for a control
* message.
* @local: FiRa context.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must have been used to read header first.
* @n_slots: Pointer where to store number of used slots.
* @stop_ranging: True if the message indicates that the ranging must be stopped.
* @block_stride_len: Pointer where to store number of blocks to stride.
*
* Return: true if message is correct. Extra payload is accepted.
*/
bool fira_frame_control_payload_check(struct fira_local *local,
struct sk_buff *skb,
struct mcps802154_ie_get_context *ie_get,
unsigned int *n_slots, bool *stop_ranging,
int *block_stride_len);
/**
* fira_frame_measurement_report_payload_check() - Check FiRa frame payload for
* a measurement report message.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must have been used to read header first.
*
* Return: true if message is correct. Extra payload is accepted.
*/
bool fira_frame_measurement_report_payload_check(
struct fira_local *local, const struct fira_slot *slot,
struct sk_buff *skb, struct mcps802154_ie_get_context *ie_get);
/**
* fira_frame_result_report_payload_check() - Check FiRa frame payload for
* a result report message.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must have been used to read header first.
*
* Return: true if message is correct. Extra payload is accepted.
*/
bool fira_frame_result_report_payload_check(
struct fira_local *local, const struct fira_slot *slot,
struct sk_buff *skb, struct mcps802154_ie_get_context *ie_get);
/**
* fira_frame_rframe_payload_check() - Parse custom data from ranging frame.
* @local: FiRa context.
* @slot: Slot information.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must have been used to read header first.
*
* Return: true if message is correct. Extra payload is accepted.
*/
bool fira_frame_rframe_payload_check(struct fira_local *local,
const struct fira_slot *slot,
struct sk_buff *skb,
struct mcps802154_ie_get_context *ie_get);
/**
* fira_rx_frame_control_header_check() - Check control frame and consume
* header.
* @local: FiRa context.
* @slot: Corresponding slot.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must be zero initialized.
* @phy_sts_index: STS index received.
*
* Return: Session context or NULL.
*/
struct fira_session *fira_rx_frame_control_header_check(
struct fira_local *local, const struct fira_slot *slot,
struct sk_buff *skb, struct mcps802154_ie_get_context *ie_get,
u32 *phy_sts_index);
/**
* fira_frame_header_check_decrypt() - Check and consume header, and decrypt
* payload.
* @local: FiRa context.
* @slot: Corresponding slot.
* @skb: Frame buffer.
* @ie_get: Context used to read IE, must be zero initialized.
*
* Return: 0 or error.
*/
int fira_frame_header_check_decrypt(struct fira_local *local,
const struct fira_slot *slot,
struct sk_buff *skb,
struct mcps802154_ie_get_context *ie_get);
#endif /* FIRA_FRAME_H */
|
