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

   1 /*
   2  * Copyright (c) 2014-2015 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 };
  27
  28 /**
  29  * struct wil_platform_ops - wil platform module calls from this
  30  * driver to platform driver
  31  */
  32 struct wil_platform_ops {
  33         int (*bus_request)(void *handle, uint32_t kbps /* KBytes/Sec */);
  34         int (*suspend)(void *handle);
  35         int (*resume)(void *handle);
  36         void (*uninit)(void *handle);
  37         int (*notify)(void *handle, enum wil_platform_event evt);
  38 };
  39
  40 /**
  41  * struct wil_platform_rops - wil platform module callbacks from
  42  * platform driver to this driver
  43  * @ramdump: store a ramdump from the wil firmware. The platform
  44  *      driver may add additional data to the ramdump to
  45  *      generate the final crash dump.
  46  * @fw_recovery: start a firmware recovery process. Called as
  47  *      part of a crash recovery process which may include other
  48  *      related platform subsystems.
  49  */
  50 struct wil_platform_rops {
  51         int (*ramdump)(void *wil_handle, void *buf, uint32_t size);
  52         int (*fw_recovery)(void *wil_handle);
  53 };
  54
  55 /**
  56  * wil_platform_init - initialize the platform driver
  57  *
  58  * @dev - pointer to the wil6210 device
  59  * @ops - structure with platform driver operations. Platform
  60  *      driver will fill this structure with function pointers.
  61  * @rops - structure with callbacks from platform driver to
  62  *      this driver. The platform driver copies the structure to
  63  *      its own storage. Can be NULL if this driver does not
  64  *      support crash recovery.
  65  * @wil_handle - context for this driver that will be passed
  66  *      when platform driver invokes one of the callbacks in
  67  *      rops. May be NULL if rops is NULL.
  68  */
  69 void *wil_platform_init(struct device *dev, struct wil_platform_ops *ops,
  70                         const struct wil_platform_rops *rops, void *wil_handle);
  71
  72 int __init wil_platform_modinit(void);
  73 void wil_platform_modexit(void);
  74
  75 #endif /* __WIL_PLATFORM_H__ */