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