xref: /wlan-dirver/qca-wifi-host-cmn/qdf/inc/qdf_platform.h (revision 6ecd284e5a94a1c96e26d571dd47419ac305990d)
1 /*
2  * Copyright (c) 2018 The Linux Foundation. All rights reserved.
3  *
4  * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
5  *
6  *
7  * Permission to use, copy, modify, and/or distribute this software for
8  * any purpose with or without fee is hereby granted, provided that the
9  * above copyright notice and this permission notice appear in all
10  * copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
13  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
14  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
15  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
16  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
17  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
18  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
19  * PERFORMANCE OF THIS SOFTWARE.
20  */
21 
22 /*
23  * This file was originally distributed by Qualcomm Atheros, Inc.
24  * under proprietary terms before Copyright ownership was assigned
25  * to the Linux Foundation.
26  */
27 
28 /**
29  * DOC: qdf_platform.h
30  * This file defines platform API abstractions.
31  */
32 
33 #ifndef _QDF_PLATFORM_H
34 #define _QDF_PLATFORM_H
35 
36 /**
37  * qdf_is_fw_down_callback - callback to query if fw is down
38  *
39  * Return: true if fw is down and false if fw is not down
40  */
41 typedef bool (*qdf_is_fw_down_callback)(void);
42 
43 /**
44  * qdf_register_fw_down_callback() - API to register fw down callback
45  * @is_fw_down: callback to query if fw is down or not
46  *
47  * Return: none
48  */
49 void qdf_register_fw_down_callback(qdf_is_fw_down_callback is_fw_down);
50 
51 /**
52  * qdf_is_fw_down() - API to check if fw is down or not
53  *
54  * Return: true: if fw is down
55  *	   false: if fw is not down
56  */
57 bool qdf_is_fw_down(void);
58 #endif /*_QDF_PLATFORM_H*/
59