bcmdhd.101.10.361.x/dhd_linux_wq.h

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