drivers/net/wireless/ath/wil6210/wil_platform.h

   1 /*
   2  * Copyright (c) 2014-2017 Qualcomm Atheros, Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef __WIL_PLATFORM_H__
  18 #define __WIL_PLATFORM_H__
  19
  20 struct device;
  21
  22 enum wil_platform_event {
  23         WIL_PLATFORM_EVT_FW_CRASH = 0,
  24         WIL_PLATFORM_EVT_PRE_RESET = 1,
  25         WIL_PLATFORM_EVT_FW_RDY = 2,
  26         WIL_PLATFORM_EVT_PRE_SUSPEND = 3,
  27         WIL_PLATFORM_EVT_POST_SUSPEND = 4,
  28 };
  29
  30 enum wil_platform_features {
  31         WIL_PLATFORM_FEATURE_FW_EXT_CLK_CONTROL = 0,
  32         WIL_PLATFORM_FEATURE_TRIPLE_MSI = 1,
  33         WIL_PLATFORM_FEATURE_MAX,
  34 };
  35
  36 enum wil_platform_capa {
  37         WIL_PLATFORM_CAPA_RADIO_ON_IN_SUSPEND = 0,
  38         WIL_PLATFORM_CAPA_T_PWR_ON_0 = 1,
  39         WIL_PLATFORM_CAPA_EXT_CLK = 2,
  40         WIL_PLATFORM_CAPA_MAX,
  41 };
  42
  43 /**
  44  * struct wil_platform_ops - wil platform module calls from this
  45  * driver to platform driver
  46  */
  47 struct wil_platform_ops {
  48         int (*bus_request)(void *handle, uint32_t kbps /* KBytes/Sec */);
  49         int (*suspend)(void *handle, bool keep_device_power);
  50         int (*resume)(void *handle, bool device_powered_on);
  51         void (*uninit)(void *handle);
  52         int (*notify)(void *handle, enum wil_platform_event evt);
  53         int (*get_capa)(void *handle);
  54         void (*set_features)(void *handle, int features);
  55 };
  56
  57 /**
  58  * struct wil_platform_rops - wil platform module callbacks from
  59  * platform driver to this driver
  60  * @ramdump: store a ramdump from the wil firmware. The platform
  61  *      driver may add additional data to the ramdump to
  62  *      generate the final crash dump.
  63  * @fw_recovery: start a firmware recovery process. Called as
  64  *      part of a crash recovery process which may include other
  65  *      related platform subsystems.
  66  */
  67 struct wil_platform_rops {
  68         int (*ramdump)(void *wil_handle, void *buf, uint32_t size);
  69         int (*fw_recovery)(void *wil_handle);
  70 };
  71
  72 /**
  73  * wil_platform_init - initialize the platform driver
  74  *
  75  * @dev - pointer to the wil6210 device
  76  * @ops - structure with platform driver operations. Platform
  77  *      driver will fill this structure with function pointers.
  78  * @rops - structure with callbacks from platform driver to
  79  *      this driver. The platform driver copies the structure to
  80  *      its own storage. Can be NULL if this driver does not
  81  *      support crash recovery.
  82  * @wil_handle - context for this driver that will be passed
  83  *      when platform driver invokes one of the callbacks in
  84  *      rops. May be NULL if rops is NULL.
  85  */
  86 void *wil_platform_init(struct device *dev, struct wil_platform_ops *ops,
  87                         const struct wil_platform_rops *rops, void *wil_handle);
  88
  89 int __init wil_platform_modinit(void);
  90 void wil_platform_modexit(void);
  91
  92 #endif /* __WIL_PLATFORM_H__ */