xref: /OK3568_Linux_fs/external/rkwifibt/drivers/infineon/dhd_linux_wq.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Broadcom Dongle Host Driver (DHD), Generic work queue framework
3*4882a593Smuzhiyun  * Generic interface to handle dhd deferred work events
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Portions of this code are copyright (c) 2021 Cypress Semiconductor Corporation
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Copyright (C) 1999-2017, Broadcom Corporation
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  *      Unless you and Broadcom execute a separate written software license
10*4882a593Smuzhiyun  * agreement governing use of this software, this software is licensed to you
11*4882a593Smuzhiyun  * under the terms of the GNU General Public License version 2 (the "GPL"),
12*4882a593Smuzhiyun  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
13*4882a593Smuzhiyun  * following added to such license:
14*4882a593Smuzhiyun  *
15*4882a593Smuzhiyun  *      As a special exception, the copyright holders of this software give you
16*4882a593Smuzhiyun  * permission to link this software with independent modules, and to copy and
17*4882a593Smuzhiyun  * distribute the resulting executable under terms of your choice, provided that
18*4882a593Smuzhiyun  * you also meet, for each linked independent module, the terms and conditions of
19*4882a593Smuzhiyun  * the license of that module.  An independent module is a module which is not
20*4882a593Smuzhiyun  * derived from this software.  The special exception does not apply to any
21*4882a593Smuzhiyun  * modifications of the software.
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  *      Notwithstanding the above, under no circumstances may you combine this
24*4882a593Smuzhiyun  * software in any way with any other Broadcom software provided under a license
25*4882a593Smuzhiyun  * other than the GPL, without Broadcom's express prior written consent.
26*4882a593Smuzhiyun  *
27*4882a593Smuzhiyun  *
28*4882a593Smuzhiyun  * <<Broadcom-WL-IPTag/Open:>>
29*4882a593Smuzhiyun  *
30*4882a593Smuzhiyun  * $Id: dhd_linux_wq.h 701044 2017-05-23 12:16:12Z $
31*4882a593Smuzhiyun  */
32*4882a593Smuzhiyun #ifndef _dhd_linux_wq_h_
33*4882a593Smuzhiyun #define _dhd_linux_wq_h_
34*4882a593Smuzhiyun /*
35*4882a593Smuzhiyun  *	Work event definitions
36*4882a593Smuzhiyun  */
37*4882a593Smuzhiyun enum _wq_event {
38*4882a593Smuzhiyun 	DHD_WQ_WORK_IF_ADD = 1,
39*4882a593Smuzhiyun 	DHD_WQ_WORK_IF_DEL,
40*4882a593Smuzhiyun 	DHD_WQ_WORK_SET_MAC,
41*4882a593Smuzhiyun 	DHD_WQ_WORK_SET_MCAST_LIST,
42*4882a593Smuzhiyun 	DHD_WQ_WORK_IPV6_NDO,
43*4882a593Smuzhiyun 	DHD_WQ_WORK_HANG_MSG,
44*4882a593Smuzhiyun 	DHD_WQ_WORK_DHD_LOG_DUMP,
45*4882a593Smuzhiyun 	DHD_WQ_WORK_PKTLOG_DUMP,
46*4882a593Smuzhiyun 	DHD_WQ_WORK_INFORM_DHD_MON,
47*4882a593Smuzhiyun 	DHD_WQ_WORK_EVENT_LOGTRACE,
48*4882a593Smuzhiyun 	DHD_WQ_WORK_DMA_LB_MEM_REL,
49*4882a593Smuzhiyun 	DHD_WQ_WORK_NATOE_EVENT,
50*4882a593Smuzhiyun 	DHD_WQ_WORK_NATOE_IOCTL,
51*4882a593Smuzhiyun 	DHD_WQ_WORK_MACDBG,
52*4882a593Smuzhiyun 	DHD_WQ_WORK_DEBUG_UART_DUMP,
53*4882a593Smuzhiyun 	DHD_WQ_WORK_GET_BIGDATA_AP,
54*4882a593Smuzhiyun 	DHD_WQ_WORK_SOC_RAM_DUMP,
55*4882a593Smuzhiyun #ifdef DHD_ERPOM
56*4882a593Smuzhiyun 	DHD_WQ_WORK_ERROR_RECOVERY,
57*4882a593Smuzhiyun #endif /* DHD_ERPOM */
58*4882a593Smuzhiyun 	DHD_WQ_WORK_H2D_CONSOLE_TIME_STAMP_MATCH,
59*4882a593Smuzhiyun 	DHD_WQ_WORK_AXI_ERROR_DUMP,
60*4882a593Smuzhiyun 	DHD_WQ_WORK_CTO_RECOVERY,
61*4882a593Smuzhiyun #ifdef DHD_BANDSTEER
62*4882a593Smuzhiyun 	DHD_WQ_WORK_BANDSTEER_STEP_MOVE,
63*4882a593Smuzhiyun #endif /* DHD_BANDSTEER */
64*4882a593Smuzhiyun 	DHD_MAX_WQ_EVENTS
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun /*
68*4882a593Smuzhiyun  *	Work event priority
69*4882a593Smuzhiyun  */
70*4882a593Smuzhiyun enum wq_priority {
71*4882a593Smuzhiyun 	DHD_WQ_WORK_PRIORITY_LOW = 1,
72*4882a593Smuzhiyun 	DHD_WQ_WORK_PRIORITY_HIGH,
73*4882a593Smuzhiyun 	DHD_WQ_MAX_PRIORITY
74*4882a593Smuzhiyun };
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun /*
77*4882a593Smuzhiyun  *	Error definitions
78*4882a593Smuzhiyun  */
79*4882a593Smuzhiyun #define DHD_WQ_STS_OK			 0
80*4882a593Smuzhiyun #define DHD_WQ_STS_FAILED		-1	/* General failure */
81*4882a593Smuzhiyun #define DHD_WQ_STS_UNINITIALIZED	-2
82*4882a593Smuzhiyun #define DHD_WQ_STS_SCHED_FAILED		-3
83*4882a593Smuzhiyun #define DHD_WQ_STS_UNKNOWN_EVENT	-4
84*4882a593Smuzhiyun #define DHD_WQ_STS_UNKNOWN_PRIORITY	-5
85*4882a593Smuzhiyun #define DHD_WQ_STS_EVENT_SKIPPED	-6
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun typedef void (*event_handler_t)(void *handle, void *event_data, u8 event);
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun void *dhd_deferred_work_init(void *dhd);
90*4882a593Smuzhiyun void dhd_deferred_work_deinit(void *workq);
91*4882a593Smuzhiyun int dhd_deferred_schedule_work(void *workq, void *event_data, u8 event,
92*4882a593Smuzhiyun 	event_handler_t evt_handler, u8 priority);
93*4882a593Smuzhiyun void dhd_deferred_work_set_skip(void *work, u8 event, bool set);
94*4882a593Smuzhiyun #endif /* _dhd_linux_wq_h_ */
95