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