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