xref: /wlan-driver/qca-wifi-host-cmn/qdf/linux/src/i_qdf_event.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2014-2017,2020 The Linux Foundation. All rights reserved.
3  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for
6  * any purpose with or without fee is hereby granted, provided that the
7  * above copyright notice and this permission notice appear in all
8  * copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17  * PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /**
21  * DOC: i_qdf_event.h
22  * This file provides OS dependent event API's.
23  */
24 
25 #if !defined(__I_QDF_EVENT_H)
26 #define __I_QDF_EVENT_H
27 
28 #include <linux/completion.h>
29 
30 /**
31  * typedef __qdf_event_t - manages events
32  * @complete: instance to completion
33  * @cookie: unsigned int
34  * @done: indicate completion
35  * @force_set: indicate forceful completion
36  */
37 typedef struct qdf_evt {
38 	struct completion complete;
39 	uint32_t cookie;
40 	bool done;
41 	bool force_set;
42 } __qdf_event_t;
43 
44 /* Preprocessor definitions and constants */
45 #define LINUX_EVENT_COOKIE 0x12341234
46 
47 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(3, 14, 0))
48 #define INIT_COMPLETION(event) reinit_completion(&event)
49 #endif
50 
51 #endif /*__I_QDF_EVENT_H*/
52