1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * Copyright (c) 2023-2024 Qualcomm Innovation Center, Inc. All rights reserved. 4*5113495bSYour Name * 5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 7*5113495bSYour Name * above copyright notice and this permission notice appear in all 8*5113495bSYour Name * copies. 9*5113495bSYour Name * 10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 18*5113495bSYour Name */ 19*5113495bSYour Name 20*5113495bSYour Name /** 21*5113495bSYour Name * DOC: qdf_platform.h 22*5113495bSYour Name * This file defines platform API abstractions. 23*5113495bSYour Name */ 24*5113495bSYour Name 25*5113495bSYour Name #ifndef _QDF_PLATFORM_H 26*5113495bSYour Name #define _QDF_PLATFORM_H 27*5113495bSYour Name 28*5113495bSYour Name #include "qdf_types.h" 29*5113495bSYour Name 30*5113495bSYour Name /** 31*5113495bSYour Name * typedef qdf_self_recovery_callback() - callback for self recovery 32*5113495bSYour Name * @psoc: pointer to the posc object 33*5113495bSYour Name * @reason: the reason for the recovery request 34*5113495bSYour Name * @func: the caller's function name 35*5113495bSYour Name * @line: the line number of the callsite 36*5113495bSYour Name * 37*5113495bSYour Name * Return: none 38*5113495bSYour Name */ 39*5113495bSYour Name typedef void (*qdf_self_recovery_callback)(void *psoc, 40*5113495bSYour Name enum qdf_hang_reason reason, 41*5113495bSYour Name const char *func, 42*5113495bSYour Name const uint32_t line); 43*5113495bSYour Name 44*5113495bSYour Name /** 45*5113495bSYour Name * typedef qdf_is_fw_down_callback() - callback to query if fw is down 46*5113495bSYour Name * 47*5113495bSYour Name * Return: true if fw is down and false if fw is not down 48*5113495bSYour Name */ 49*5113495bSYour Name typedef bool (*qdf_is_fw_down_callback)(void); 50*5113495bSYour Name 51*5113495bSYour Name /** 52*5113495bSYour Name * qdf_register_fw_down_callback() - API to register fw down callback 53*5113495bSYour Name * @is_fw_down: callback to query if fw is down or not 54*5113495bSYour Name * 55*5113495bSYour Name * Return: none 56*5113495bSYour Name */ 57*5113495bSYour Name void qdf_register_fw_down_callback(qdf_is_fw_down_callback is_fw_down); 58*5113495bSYour Name 59*5113495bSYour Name /** 60*5113495bSYour Name * qdf_is_fw_down() - API to check if fw is down or not 61*5113495bSYour Name * 62*5113495bSYour Name * Return: true: if fw is down 63*5113495bSYour Name * false: if fw is not down 64*5113495bSYour Name */ 65*5113495bSYour Name bool qdf_is_fw_down(void); 66*5113495bSYour Name 67*5113495bSYour Name /** 68*5113495bSYour Name * typedef qdf_wmi_recv_qmi_cb() - callback to receive WMI over QMI 69*5113495bSYour Name * @cb_ctx: WMI event recv callback context(wmi_handle) 70*5113495bSYour Name * @buf: WMI buffer 71*5113495bSYour Name * @len: WMI buffer len 72*5113495bSYour Name * 73*5113495bSYour Name * Return: 0 if success otherwise -EINVAL 74*5113495bSYour Name */ 75*5113495bSYour Name typedef int (*qdf_wmi_recv_qmi_cb)(void *cb_ctx, void *buf, int len); 76*5113495bSYour Name 77*5113495bSYour Name /** 78*5113495bSYour Name * typedef qdf_qmi_ind_cb() - callback to receive QMI Indication 79*5113495bSYour Name * @cb_ctx: QMI indication callback context 80*5113495bSYour Name * @type: Indication type 81*5113495bSYour Name * @event: Indication Event 82*5113495bSYour Name * @event_len: QMI indication event buffer len 83*5113495bSYour Name * 84*5113495bSYour Name * Return: 0 if success otherwise -EINVAL 85*5113495bSYour Name */ 86*5113495bSYour Name typedef int (*qdf_qmi_ind_cb)(void *cb_ctx, uint16_t type, 87*5113495bSYour Name void *event, int event_len); 88*5113495bSYour Name 89*5113495bSYour Name /** 90*5113495bSYour Name * typedef qdf_wmi_send_over_qmi_callback() - callback to send WMI over QMI 91*5113495bSYour Name * @buf: WMI buffer 92*5113495bSYour Name * @len: WMI buffer len 93*5113495bSYour Name * @cb_ctx: WMI event recv callback context(wmi_handle) 94*5113495bSYour Name * @wmi_rx_cb: WMI event receive call back 95*5113495bSYour Name * 96*5113495bSYour Name * Return: QDF_STATUS_SUCCESS if success otherwise QDF error code 97*5113495bSYour Name */ 98*5113495bSYour Name typedef QDF_STATUS (*qdf_wmi_send_over_qmi_callback)(void *buf, uint32_t len, 99*5113495bSYour Name void *cb_ctx, 100*5113495bSYour Name qdf_wmi_recv_qmi_cb 101*5113495bSYour Name wmi_rx_cb); 102*5113495bSYour Name 103*5113495bSYour Name /** 104*5113495bSYour Name * typedef qdf_send_ind_over_qmi_callback() - callback to receive QMI Indication 105*5113495bSYour Name * @cb_ctx: QMI Indication recv callback context 106*5113495bSYour Name * @qmi_ind_cb: QMI Indication receive callback 107*5113495bSYour Name * 108*5113495bSYour Name * Return: QDF_STATUS_SUCCESS if success otherwise QDF error code 109*5113495bSYour Name */ 110*5113495bSYour Name typedef QDF_STATUS (*qdf_send_ind_over_qmi_callback)(void *cb_ctx, 111*5113495bSYour Name qdf_qmi_ind_cb qmi_ind_cb); 112*5113495bSYour Name 113*5113495bSYour Name /** 114*5113495bSYour Name * qdf_register_wmi_send_recv_qmi_callback() - Register WMI over QMI callback 115*5113495bSYour Name * @wmi_send_recv_qmi_cb: callback to send recv WMI data over QMI 116*5113495bSYour Name * 117*5113495bSYour Name * Return: none 118*5113495bSYour Name */ 119*5113495bSYour Name void qdf_register_wmi_send_recv_qmi_callback(qdf_wmi_send_over_qmi_callback 120*5113495bSYour Name wmi_send_recv_qmi_cb); 121*5113495bSYour Name 122*5113495bSYour Name /** 123*5113495bSYour Name * qdf_register_qmi_indication_callback() - Register QMI Indication callback 124*5113495bSYour Name * @qmi_ind_cb: callback to receive QMI Indications 125*5113495bSYour Name * 126*5113495bSYour Name * Return: none 127*5113495bSYour Name */ 128*5113495bSYour Name void qdf_register_qmi_indication_callback(qdf_send_ind_over_qmi_callback qmi_ind_cb); 129*5113495bSYour Name 130*5113495bSYour Name /** 131*5113495bSYour Name * qdf_wmi_send_recv_qmi() - API to send receive WMI data over QMI 132*5113495bSYour Name * @buf: WMI buffer 133*5113495bSYour Name * @len: WMI buffer len 134*5113495bSYour Name * @cb_ctx: WMI event recv callback context(wmi_handle) 135*5113495bSYour Name * @wmi_rx_cb: WMI event receive call back 136*5113495bSYour Name * 137*5113495bSYour Name * Return: QDF STATUS of operation 138*5113495bSYour Name */ 139*5113495bSYour Name QDF_STATUS qdf_wmi_send_recv_qmi(void *buf, uint32_t len, void *cb_ctx, 140*5113495bSYour Name qdf_wmi_recv_qmi_cb wmi_rx_cb); 141*5113495bSYour Name 142*5113495bSYour Name /** 143*5113495bSYour Name * qdf_reg_qmi_indication() - API to receive QMI Indication data 144*5113495bSYour Name * @cb_ctx: QMI Indication recv callback context 145*5113495bSYour Name * @qmi_ind_cb: QMI Indication event receive callback 146*5113495bSYour Name * 147*5113495bSYour Name * Return: QDF STATUS of operation 148*5113495bSYour Name */ 149*5113495bSYour Name QDF_STATUS qdf_reg_qmi_indication(void *cb_ctx, qdf_qmi_ind_cb qmi_ind_cb); 150*5113495bSYour Name 151*5113495bSYour Name /** 152*5113495bSYour Name * typedef qdf_is_driver_unloading_callback() - callback to get driver 153*5113495bSYour Name * unloading in progress or not 154*5113495bSYour Name * 155*5113495bSYour Name * Return: true if driver is unloading else false 156*5113495bSYour Name */ 157*5113495bSYour Name typedef bool (*qdf_is_driver_unloading_callback)(void); 158*5113495bSYour Name 159*5113495bSYour Name /** 160*5113495bSYour Name * qdf_register_is_driver_unloading_callback() - driver unloading callback 161*5113495bSYour Name * @callback: driver unloading callback 162*5113495bSYour Name * 163*5113495bSYour Name * Return: None 164*5113495bSYour Name */ 165*5113495bSYour Name void qdf_register_is_driver_unloading_callback( 166*5113495bSYour Name qdf_is_driver_unloading_callback callback); 167*5113495bSYour Name 168*5113495bSYour Name /** 169*5113495bSYour Name * typedef qdf_is_driver_state_module_stop_callback() - callback to get driver 170*5113495bSYour Name * state is module stop or not 171*5113495bSYour Name * 172*5113495bSYour Name * Return: true if driver state is module stop else false 173*5113495bSYour Name */ 174*5113495bSYour Name typedef bool (*qdf_is_driver_state_module_stop_callback)(void); 175*5113495bSYour Name 176*5113495bSYour Name /** 177*5113495bSYour Name * qdf_register_is_driver_state_module_stop_callback() - driver state is 178*5113495bSYour Name * module stop or not 179*5113495bSYour Name * @callback: driver state module stop callback 180*5113495bSYour Name * 181*5113495bSYour Name * Return: None 182*5113495bSYour Name */ 183*5113495bSYour Name void qdf_register_is_driver_state_module_stop_callback( 184*5113495bSYour Name qdf_is_driver_state_module_stop_callback callback); 185*5113495bSYour Name 186*5113495bSYour Name /** 187*5113495bSYour Name * qdf_register_self_recovery_callback() - register self recovery callback 188*5113495bSYour Name * @callback: self recovery callback 189*5113495bSYour Name * 190*5113495bSYour Name * Return: None 191*5113495bSYour Name */ 192*5113495bSYour Name void qdf_register_self_recovery_callback(qdf_self_recovery_callback callback); 193*5113495bSYour Name 194*5113495bSYour Name /** 195*5113495bSYour Name * qdf_trigger_self_recovery () - trigger self recovery 196*5113495bSYour Name * @psoc: the psoc at which the recovery is being triggered 197*5113495bSYour Name * @reason: the reason for the recovery request 198*5113495bSYour Name * 199*5113495bSYour Name * Call API only in case of fatal error, 200*5113495bSYour Name * if self_recovery_cb callback is registered, injcets fw crash and recovers 201*5113495bSYour Name * else raises QDF_BUG() 202*5113495bSYour Name * 203*5113495bSYour Name * Return: None 204*5113495bSYour Name */ 205*5113495bSYour Name #define qdf_trigger_self_recovery(psoc, reason) \ 206*5113495bSYour Name __qdf_trigger_self_recovery(psoc, reason, __func__, __LINE__) 207*5113495bSYour Name void __qdf_trigger_self_recovery(void *psoc, enum qdf_hang_reason reason, 208*5113495bSYour Name const char *func, const uint32_t line); 209*5113495bSYour Name 210*5113495bSYour Name /** 211*5113495bSYour Name * typedef qdf_is_recovering_callback() - callback to get driver recovering in 212*5113495bSYour Name * progress or not 213*5113495bSYour Name * 214*5113495bSYour Name * Return: true if driver is doing recovering else false 215*5113495bSYour Name */ 216*5113495bSYour Name typedef bool (*qdf_is_recovering_callback)(void); 217*5113495bSYour Name 218*5113495bSYour Name /** 219*5113495bSYour Name * qdf_register_recovering_state_query_callback() - register recover status 220*5113495bSYour Name * query callback 221*5113495bSYour Name * @is_recovering: true if driver is recovering 222*5113495bSYour Name * 223*5113495bSYour Name * Return: none 224*5113495bSYour Name */ 225*5113495bSYour Name void qdf_register_recovering_state_query_callback( 226*5113495bSYour Name qdf_is_recovering_callback is_recovering); 227*5113495bSYour Name 228*5113495bSYour Name /** 229*5113495bSYour Name * qdf_is_driver_unloading() - get driver unloading in progress status 230*5113495bSYour Name * or not 231*5113495bSYour Name * 232*5113495bSYour Name * Return: true if driver is unloading else false 233*5113495bSYour Name */ 234*5113495bSYour Name bool qdf_is_driver_unloading(void); 235*5113495bSYour Name 236*5113495bSYour Name /** 237*5113495bSYour Name * qdf_is_driver_state_module_stop() - get driver state is module stop or not 238*5113495bSYour Name * 239*5113495bSYour Name * Return: true if driver state is module stop else false 240*5113495bSYour Name */ 241*5113495bSYour Name bool qdf_is_driver_state_module_stop(void); 242*5113495bSYour Name 243*5113495bSYour Name /** 244*5113495bSYour Name * qdf_is_recovering() - get driver recovering in progress status 245*5113495bSYour Name * or not 246*5113495bSYour Name * 247*5113495bSYour Name * Return: true if driver is doing recovering else false 248*5113495bSYour Name */ 249*5113495bSYour Name bool qdf_is_recovering(void); 250*5113495bSYour Name 251*5113495bSYour Name /* 252*5113495bSYour Name * struct qdf_op_sync - opaque operation synchronization context handle 253*5113495bSYour Name */ 254*5113495bSYour Name struct qdf_op_sync; 255*5113495bSYour Name 256*5113495bSYour Name typedef int (*qdf_op_protect_cb)(void **out_sync, const char *func); 257*5113495bSYour Name typedef void (*qdf_op_unprotect_cb)(void *sync, const char *func); 258*5113495bSYour Name 259*5113495bSYour Name /** 260*5113495bSYour Name * qdf_op_protect() - attempt to protect a driver operation 261*5113495bSYour Name * @out_sync: output parameter for the synchronization context, populated on 262*5113495bSYour Name * success 263*5113495bSYour Name * 264*5113495bSYour Name * Return: Errno 265*5113495bSYour Name */ 266*5113495bSYour Name #define qdf_op_protect(out_sync) __qdf_op_protect(out_sync, __func__) 267*5113495bSYour Name 268*5113495bSYour Name qdf_must_check int 269*5113495bSYour Name __qdf_op_protect(struct qdf_op_sync **out_sync, const char *func); 270*5113495bSYour Name 271*5113495bSYour Name /** 272*5113495bSYour Name * qdf_op_unprotect() - release driver operation protection 273*5113495bSYour Name * @sync: synchronization context returned from qdf_op_protect() 274*5113495bSYour Name * 275*5113495bSYour Name * Return: None 276*5113495bSYour Name */ 277*5113495bSYour Name #define qdf_op_unprotect(sync) __qdf_op_unprotect(sync, __func__) 278*5113495bSYour Name 279*5113495bSYour Name void __qdf_op_unprotect(struct qdf_op_sync *sync, const char *func); 280*5113495bSYour Name 281*5113495bSYour Name /** 282*5113495bSYour Name * qdf_op_callbacks_register() - register driver operation protection callbacks 283*5113495bSYour Name * @on_protect: callback on protect 284*5113495bSYour Name * @on_unprotect: callback on unprotect 285*5113495bSYour Name * 286*5113495bSYour Name * Return: None 287*5113495bSYour Name */ 288*5113495bSYour Name void qdf_op_callbacks_register(qdf_op_protect_cb on_protect, 289*5113495bSYour Name qdf_op_unprotect_cb on_unprotect); 290*5113495bSYour Name 291*5113495bSYour Name /** 292*5113495bSYour Name * typedef qdf_is_drv_connected_callback() - callback to query if drv 293*5113495bSYour Name * is connected 294*5113495bSYour Name * 295*5113495bSYour Name * Return: true if drv is connected else false 296*5113495bSYour Name */ 297*5113495bSYour Name typedef bool (*qdf_is_drv_connected_callback)(void); 298*5113495bSYour Name 299*5113495bSYour Name /** 300*5113495bSYour Name * qdf_is_drv_connected() - API to check if drv is connected or not 301*5113495bSYour Name * 302*5113495bSYour Name * DRV is dynamic request voting using which fw can do page fault and 303*5113495bSYour Name * bring in page back without apps wake up 304*5113495bSYour Name * 305*5113495bSYour Name * Return: true: if drv is connected 306*5113495bSYour Name * false: if drv is not connected 307*5113495bSYour Name */ 308*5113495bSYour Name bool qdf_is_drv_connected(void); 309*5113495bSYour Name 310*5113495bSYour Name /** 311*5113495bSYour Name * qdf_register_drv_connected_callback() - API to register drv connected cb 312*5113495bSYour Name * @is_drv_connected: callback to query if drv is connected or not 313*5113495bSYour Name * 314*5113495bSYour Name * Return: none 315*5113495bSYour Name */ 316*5113495bSYour Name void qdf_register_drv_connected_callback(qdf_is_drv_connected_callback 317*5113495bSYour Name is_drv_connected); 318*5113495bSYour Name 319*5113495bSYour Name /** 320*5113495bSYour Name * qdf_check_state_before_panic() - API to check if FW is down 321*5113495bSYour Name * or driver is in recovery before calling assert 322*5113495bSYour Name * @func: Caller function pointer used for debug info 323*5113495bSYour Name * @line: Caller function line number 324*5113495bSYour Name * 325*5113495bSYour Name * Return: none 326*5113495bSYour Name */ 327*5113495bSYour Name void qdf_check_state_before_panic(const char *func, const uint32_t line); 328*5113495bSYour Name 329*5113495bSYour Name /** 330*5113495bSYour Name *typedef qdf_is_drv_supported_callback() - callback to query if drv is supported 331*5113495bSYour Name * 332*5113495bSYour Name * Return: true if drv is supported else false 333*5113495bSYour Name */ 334*5113495bSYour Name typedef bool (*qdf_is_drv_supported_callback)(void); 335*5113495bSYour Name 336*5113495bSYour Name /** 337*5113495bSYour Name * qdf_is_drv_supported() - API to check if drv is supported or not 338*5113495bSYour Name * 339*5113495bSYour Name * DRV is dynamic request voting using which fw can do page fault and 340*5113495bSYour Name * bring in page back without apps wake up 341*5113495bSYour Name * 342*5113495bSYour Name * Return: true: if drv is supported 343*5113495bSYour Name * false: if drv is not supported 344*5113495bSYour Name */ 345*5113495bSYour Name bool qdf_is_drv_supported(void); 346*5113495bSYour Name 347*5113495bSYour Name /** 348*5113495bSYour Name * qdf_register_drv_supported_callback() - API to register drv supported cb 349*5113495bSYour Name * @is_drv_supported: callback to query if drv is supported or not 350*5113495bSYour Name * 351*5113495bSYour Name * Return: none 352*5113495bSYour Name */ 353*5113495bSYour Name void qdf_register_drv_supported_callback(qdf_is_drv_supported_callback 354*5113495bSYour Name is_drv_supported); 355*5113495bSYour Name 356*5113495bSYour Name /** 357*5113495bSYour Name * typedef qdf_recovery_reason_update_callback() - recovery reason update callback 358*5113495bSYour Name * @reason: recovery reason 359*5113495bSYour Name */ 360*5113495bSYour Name typedef void (*qdf_recovery_reason_update_callback)(enum qdf_hang_reason 361*5113495bSYour Name reason); 362*5113495bSYour Name 363*5113495bSYour Name /** 364*5113495bSYour Name * qdf_register_recovery_reason_update() - Register callback to update recovery 365*5113495bSYour Name * reason 366*5113495bSYour Name * @callback: callback to update recovery reason 367*5113495bSYour Name * 368*5113495bSYour Name * Return: none 369*5113495bSYour Name */ 370*5113495bSYour Name void qdf_register_recovery_reason_update(qdf_recovery_reason_update_callback 371*5113495bSYour Name callback); 372*5113495bSYour Name 373*5113495bSYour Name /** 374*5113495bSYour Name * qdf_recovery_reason_update() - update recovery reason 375*5113495bSYour Name * @reason: recovery reason 376*5113495bSYour Name * 377*5113495bSYour Name * Return: none 378*5113495bSYour Name */ 379*5113495bSYour Name void qdf_recovery_reason_update(enum qdf_hang_reason reason); 380*5113495bSYour Name 381*5113495bSYour Name /** 382*5113495bSYour Name * typedef qdf_bus_reg_dump() - callback for getting bus specific register dump 383*5113495bSYour Name * @dev: Bus specific device 384*5113495bSYour Name * @buf: Hang event buffer in which the data will be populated 385*5113495bSYour Name * @len: length of data to be populated in the hang event buffer 386*5113495bSYour Name * 387*5113495bSYour Name * Return: none 388*5113495bSYour Name */ 389*5113495bSYour Name typedef void (*qdf_bus_reg_dump)(struct device *dev, uint8_t *buf, 390*5113495bSYour Name uint32_t len); 391*5113495bSYour Name 392*5113495bSYour Name /** 393*5113495bSYour Name * qdf_register_get_bus_reg_dump() - Register callback to update bus register 394*5113495bSYour Name * dump 395*5113495bSYour Name * @callback: callback to update bus register dump 396*5113495bSYour Name * 397*5113495bSYour Name * Return: none 398*5113495bSYour Name */ 399*5113495bSYour Name void qdf_register_get_bus_reg_dump(qdf_bus_reg_dump callback); 400*5113495bSYour Name 401*5113495bSYour Name /** 402*5113495bSYour Name * qdf_get_bus_reg_dump() - Get the register dump for the bus 403*5113495bSYour Name * @dev: device 404*5113495bSYour Name * @buf: buffer for hang data 405*5113495bSYour Name * @len: len of hang data 406*5113495bSYour Name * 407*5113495bSYour Name * Return: none 408*5113495bSYour Name */ 409*5113495bSYour Name void qdf_get_bus_reg_dump(struct device *dev, uint8_t *buf, uint32_t len); 410*5113495bSYour Name 411*5113495bSYour Name #ifdef WLAN_SUPPORT_DPDK 412*5113495bSYour Name /** 413*5113495bSYour Name * qdf_uio_register_device() - register dev to UIO dev 414*5113495bSYour Name * @parent: parent device to be registered with UIO dev 415*5113495bSYour Name * @info: UIO device capabilities 416*5113495bSYour Name * 417*5113495bSYour Name * Return: zero on success or a negative error code 418*5113495bSYour Name */ 419*5113495bSYour Name int qdf_uio_register_device(struct device *parent, qdf_uio_info_t *info); 420*5113495bSYour Name 421*5113495bSYour Name /** 422*5113495bSYour Name * qdf_uio_unregister_device - unregister a UIO device 423*5113495bSYour Name * @info: UIO device capabilities 424*5113495bSYour Name * 425*5113495bSYour Name * Return: none 426*5113495bSYour Name */ 427*5113495bSYour Name void qdf_uio_unregister_device(qdf_uio_info_t *info); 428*5113495bSYour Name #endif 429*5113495bSYour Name #endif /*_QDF_PLATFORM_H*/ 430