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