xref: /OK3568_Linux_fs/external/rkwifibt/drivers/bcmdhd/pom.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Broadcom Dongle Host Driver (DHD), common DHD core.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 2020, Broadcom.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  *      Unless you and Broadcom execute a separate written software license
7*4882a593Smuzhiyun  * agreement governing use of this software, this software is licensed to you
8*4882a593Smuzhiyun  * under the terms of the GNU General Public License version 2 (the "GPL"),
9*4882a593Smuzhiyun  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10*4882a593Smuzhiyun  * following added to such license:
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  *      As a special exception, the copyright holders of this software give you
13*4882a593Smuzhiyun  * permission to link this software with independent modules, and to copy and
14*4882a593Smuzhiyun  * distribute the resulting executable under terms of your choice, provided that
15*4882a593Smuzhiyun  * you also meet, for each linked independent module, the terms and conditions of
16*4882a593Smuzhiyun  * the license of that module.  An independent module is a module which is not
17*4882a593Smuzhiyun  * derived from this software.  The special exception does not apply to any
18*4882a593Smuzhiyun  * modifications of the software.
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  *
21*4882a593Smuzhiyun  * <<Broadcom-WL-IPTag/Open:>>
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  * $Id:  $
24*4882a593Smuzhiyun  */
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun /*
27*4882a593Smuzhiyun  * NOTE:-
28*4882a593Smuzhiyun  * This file is a exact copy of trunk/components/opensource/pom/pom.h.
29*4882a593Smuzhiyun  * Any changes needed to this file should reflect in trunk too.
30*4882a593Smuzhiyun  * Otherwise POM(power on off manager) and dhd will go out of sync
31*4882a593Smuzhiyun  */
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun /*
34*4882a593Smuzhiyun  * Donot change the order of func ids below.
35*4882a593Smuzhiyun  * Order of invoking the power off and power on handlers is importent during
36*4882a593Smuzhiyun  * power toggle through API: pom_toggle_reg_on.
37*4882a593Smuzhiyun  * WLAN FW should be loaded first after REG-ON. Otherwise SR doesnot work.
38*4882a593Smuzhiyun  *
39*4882a593Smuzhiyun  */
40*4882a593Smuzhiyun enum pom_func_id {
41*4882a593Smuzhiyun 	WLAN_FUNC_ID = 0,
42*4882a593Smuzhiyun 	BT_FUNC_ID = 1,
43*4882a593Smuzhiyun 	MAX_COEX_FUNC = 2
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun enum pom_toggle_reason {
47*4882a593Smuzhiyun 	BY_WLAN_DUE_TO_WLAN = 0,
48*4882a593Smuzhiyun 	BY_WLAN_DUE_TO_BT = 1,
49*4882a593Smuzhiyun 	BY_BT_DUE_TO_BT = 2,
50*4882a593Smuzhiyun 	BY_BT_DUE_TO_WLAN = 3,
51*4882a593Smuzhiyun 	BY_USER_PROCESS = 4,
52*4882a593Smuzhiyun 	BY_UNKNOWN_REASON = 5
53*4882a593Smuzhiyun };
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun /* Common structure to be used to register and de-register from BT/WLAN */
56*4882a593Smuzhiyun typedef struct pom_func_handler {
57*4882a593Smuzhiyun 	unsigned char func_id;
58*4882a593Smuzhiyun 	void *handler;
59*4882a593Smuzhiyun 	int (*power_off)(void *handler, unsigned char reason);
60*4882a593Smuzhiyun 	int (*power_on)(void *handler, unsigned char reason);
61*4882a593Smuzhiyun } pom_func_handler_t;
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun /* Register call back during attach of each function */
64*4882a593Smuzhiyun extern int pom_func_register(struct pom_func_handler *func);
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun /* De-Register call back during detach of each function */
67*4882a593Smuzhiyun extern int pom_func_deregister(struct pom_func_handler *func);
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun /* Toggle Reg ON, called to recover from bad state */
70*4882a593Smuzhiyun extern int pom_toggle_reg_on(unsigned char func_id, unsigned char reason);
71