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