summaryrefslogtreecommitdiff
path: root/mac/fira_access.h
blob: 43812ba6df1925292e395bb275bfaa06a05a7a92 (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
/*
 * This file is part of the UWB stack for linux.
 *
 * Copyright (c) 2020-2021 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_ACCESS_H
#define FIRA_ACCESS_H

#include <net/mcps802154_schedule.h>

struct fira_local;
struct fira_session;

/**
 * fira_get_access() - Get access for a given region at the given timestamp.
 * @region: Region.
 * @next_timestamp_dtu: Next access opportunity.
 * @next_in_region_dtu: Unused.
 * @region_duration_dtu: Unused.
 *
 * Return: The access.
 */
struct mcps802154_access *fira_get_access(struct mcps802154_region *region,
					  u32 next_timestamp_dtu,
					  int next_in_region_dtu,
					  int region_duration_dtu);

/**
 * fira_compute_access() - Get access for a given session.
 * @local: FiRa context.
 * @session: Session.
 *
 * Return: The access.
 */
struct mcps802154_access *fira_compute_access(struct fira_local *local,
					      struct fira_session *session);

/**
 * fira_session_get_demand() - Get access information for a given session.
 * @local: FiRa context.
 * @session: Session.
 * @demand: Access information.
 */
void fira_session_get_demand(struct fira_local *local,
			     struct fira_session *session,
			     struct mcps802154_region_demand *demand);

#endif /* FIRA_ACCESS_H */