| /* |
| * Copyright (c) 2014-2016 The Linux Foundation. All rights reserved. |
| * |
| * Previously licensed under the ISC license by Qualcomm Atheros, Inc. |
| * |
| * |
| * Permission to use, copy, modify, and/or distribute this software for |
| * any purpose with or without fee is hereby granted, provided that the |
| * above copyright notice and this permission notice appear in all |
| * copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
| * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
| * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
| * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
| * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
| * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
| * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
| * PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| /* |
| * This file was originally distributed by Qualcomm Atheros, Inc. |
| * under proprietary terms before Copyright ownership was assigned |
| * to the Linux Foundation. |
| */ |
| #if !defined(__CDS_API_H) |
| #define __CDS_API_H |
| |
| /** |
| * DOC: cds_api.h |
| * |
| * Connectivity driver services public API |
| * |
| */ |
| |
| #include <cdf_types.h> |
| #include <cdf_status.h> |
| #include <qdf_status.h> |
| #include <cdf_memory.h> |
| #include <qdf_list.h> |
| #include <cdf_trace.h> |
| #include <qdf_event.h> |
| #include <cdf_lock.h> |
| #include <cds_reg_service.h> |
| #include <cds_mq.h> |
| #include <cds_packet.h> |
| #include <cds_sched.h> |
| #include <cdf_threads.h> |
| #include <cdf_mc_timer.h> |
| #include <cds_pack_align.h> |
| |
| /* Amount of time to wait for WMA to perform an asynchronous activity. |
| * This value should be larger than the timeout used by WMI to wait for |
| * a response from target |
| */ |
| #define CDS_WMA_TIMEOUT (15000) |
| |
| /** |
| * enum cds_driver_state - Driver state |
| * @CDS_DRIVER_STATE_UNINITIALIZED: Driver is in uninitialized state. |
| * CDS_DRIVER_STATE_LOADED: Driver is loaded and functional. |
| * CDS_DRIVER_STATE_LOADING: Driver probe is in progress. |
| * CDS_DRIVER_STATE_UNLOADING: Driver remove is in progress. |
| * CDS_DRIVER_STATE_RECOVERING: Recovery in progress. |
| */ |
| enum cds_driver_state { |
| CDS_DRIVER_STATE_UNINITIALIZED = 0, |
| CDS_DRIVER_STATE_LOADED = BIT(0), |
| CDS_DRIVER_STATE_LOADING = BIT(1), |
| CDS_DRIVER_STATE_UNLOADING = BIT(2), |
| CDS_DRIVER_STATE_RECOVERING = BIT(3), |
| }; |
| |
| #define __CDS_IS_DRIVER_STATE(_state, _mask) (((_state) & (_mask)) == (_mask)) |
| |
| void cds_set_driver_state(enum cds_driver_state); |
| void cds_clear_driver_state(enum cds_driver_state); |
| enum cds_driver_state cds_get_driver_state(void); |
| |
| /** |
| * cds_is_driver_loading() - Is driver load in progress |
| * |
| * Return: true if driver is loading and false otherwise. |
| */ |
| static inline bool cds_is_driver_loading(void) |
| { |
| enum cds_driver_state state = cds_get_driver_state(); |
| |
| return __CDS_IS_DRIVER_STATE(state, CDS_DRIVER_STATE_LOADING); |
| } |
| |
| /** |
| * cds_is_driver_unloading() - Is driver unload in progress |
| * |
| * Return: true if driver is unloading and false otherwise. |
| */ |
| static inline bool cds_is_driver_unloading(void) |
| { |
| enum cds_driver_state state = cds_get_driver_state(); |
| |
| return __CDS_IS_DRIVER_STATE(state, CDS_DRIVER_STATE_UNLOADING); |
| } |
| |
| /** |
| * cds_is_driver_recovering() - Is recovery in progress |
| * |
| * Return: true if recovery in progress and false otherwise. |
| */ |
| static inline bool cds_is_driver_recovering(void) |
| { |
| enum cds_driver_state state = cds_get_driver_state(); |
| |
| return __CDS_IS_DRIVER_STATE(state, CDS_DRIVER_STATE_RECOVERING); |
| } |
| |
| /** |
| * cds_is_load_or_unload_in_progress() - Is driver load OR unload in progress |
| * |
| * Return: true if driver is loading OR unloading and false otherwise. |
| */ |
| static inline bool cds_is_load_or_unload_in_progress(void) |
| { |
| enum cds_driver_state state = cds_get_driver_state(); |
| |
| return __CDS_IS_DRIVER_STATE(state, CDS_DRIVER_STATE_LOADING) || |
| __CDS_IS_DRIVER_STATE(state, CDS_DRIVER_STATE_UNLOADING); |
| } |
| |
| /** |
| * cds_set_recovery_in_progress() - Set recovery in progress |
| * @value: value to set |
| * |
| * Return: none |
| */ |
| static inline void cds_set_recovery_in_progress(uint8_t value) |
| { |
| if (value) |
| cds_set_driver_state(CDS_DRIVER_STATE_RECOVERING); |
| else |
| cds_clear_driver_state(CDS_DRIVER_STATE_RECOVERING); |
| } |
| |
| /** |
| * cds_set_load_in_progress() - Set load in progress |
| * @value: value to set |
| * |
| * Return: none |
| */ |
| static inline void cds_set_load_in_progress(uint8_t value) |
| { |
| if (value) |
| cds_set_driver_state(CDS_DRIVER_STATE_LOADING); |
| else |
| cds_clear_driver_state(CDS_DRIVER_STATE_LOADING); |
| } |
| |
| /** |
| * cds_set_driver_loaded() - Set load completed |
| * @value: value to set |
| * |
| * Return: none |
| */ |
| static inline void cds_set_driver_loaded(uint8_t value) |
| { |
| if (value) |
| cds_set_driver_state(CDS_DRIVER_STATE_LOADED); |
| else |
| cds_clear_driver_state(CDS_DRIVER_STATE_LOADED); |
| } |
| |
| /** |
| * cds_set_unload_in_progress() - Set unload in progress |
| * @value: value to set |
| * |
| * Return: none |
| */ |
| static inline void cds_set_unload_in_progress(uint8_t value) |
| { |
| if (value) |
| cds_set_driver_state(CDS_DRIVER_STATE_UNLOADING); |
| else |
| cds_clear_driver_state(CDS_DRIVER_STATE_UNLOADING); |
| } |
| |
| v_CONTEXT_t cds_init(void); |
| void cds_deinit(void); |
| |
| CDF_STATUS cds_pre_enable(v_CONTEXT_t cds_context); |
| |
| CDF_STATUS cds_open(void); |
| |
| CDF_STATUS cds_enable(v_CONTEXT_t cds_context); |
| |
| CDF_STATUS cds_disable(v_CONTEXT_t cds_context); |
| |
| CDF_STATUS cds_close(v_CONTEXT_t cds_context); |
| |
| CDF_STATUS cds_shutdown(v_CONTEXT_t cds_context); |
| |
| void cds_core_return_msg(void *pVContext, p_cds_msg_wrapper pMsgWrapper); |
| |
| void *cds_get_context(CDF_MODULE_ID moduleId); |
| |
| v_CONTEXT_t cds_get_global_context(void); |
| |
| CDF_STATUS cds_alloc_context(void *p_cds_context, CDF_MODULE_ID moduleID, |
| void **ppModuleContext, uint32_t size); |
| |
| CDF_STATUS cds_free_context(void *p_cds_context, CDF_MODULE_ID moduleID, |
| void *pModuleContext); |
| |
| CDF_STATUS cds_set_context(CDF_MODULE_ID moduleID, void *context); |
| |
| CDF_STATUS cds_get_vdev_types(enum tCDF_ADAPTER_MODE mode, uint32_t *type, |
| uint32_t *subType); |
| |
| void cds_flush_work(void *work); |
| void cds_flush_delayed_work(void *dwork); |
| |
| bool cds_is_packet_log_enabled(void); |
| |
| uint64_t cds_get_monotonic_boottime(void); |
| |
| void cds_trigger_recovery(void); |
| |
| void cds_set_wakelock_logging(bool value); |
| bool cds_is_wakelock_enabled(void); |
| void cds_set_ring_log_level(uint32_t ring_id, uint32_t log_level); |
| enum wifi_driver_log_level cds_get_ring_log_level(uint32_t ring_id); |
| void cds_set_multicast_logging(uint8_t value); |
| uint8_t cds_is_multicast_logging(void); |
| CDF_STATUS cds_set_log_completion(uint32_t is_fatal, |
| uint32_t type, |
| uint32_t sub_type); |
| void cds_get_log_completion(uint32_t *is_fatal, |
| uint32_t *type, |
| uint32_t *sub_type); |
| bool cds_is_log_report_in_progress(void); |
| void cds_init_log_completion(void); |
| void cds_deinit_log_completion(void); |
| CDF_STATUS cds_flush_logs(uint32_t is_fatal, |
| uint32_t indicator, |
| uint32_t reason_code); |
| void cds_logging_set_fw_flush_complete(void); |
| #endif /* if !defined __CDS_API_H */ |