mirror of
https://github.com/torvalds/linux
synced 2024-10-16 16:29:20 +00:00
e3eea08e64
This commit affects comments (and in one case, whitespace) only. Throughout the IPA code, return statements are documented using "@Return:", whereas they should use "Return:" instead. Fix these mistakes. In function definitions, some parameters are missing their comment to describe them. And in structure definitions, some fields are missing their comment to describe them. Add these missing descriptions. Some arguments changed name and type along the way, but their descriptions were not updated (an endpoint pointer is now used in many places that previously used an endpoint ID). Fix these incorrect parameter descriptions. In the description for the ipa_clock structure, one field had a semicolon instead of a colon in its description. Fix this. Add a missing function description for ipa_gsi_endpoint_data_empty(). All of these issues were identified when building with "W=1". Signed-off-by: Alex Elder <elder@linaro.org> Signed-off-by: David S. Miller <davem@davemloft.net>
49 lines
1.2 KiB
C
49 lines
1.2 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
|
|
/* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
|
|
* Copyright (C) 2019-2020 Linaro Ltd.
|
|
*/
|
|
#ifndef _IPA_SMP2P_H_
|
|
#define _IPA_SMP2P_H_
|
|
|
|
#include <linux/types.h>
|
|
|
|
struct ipa;
|
|
|
|
/**
|
|
* ipa_smp2p_init() - Initialize the IPA SMP2P subsystem
|
|
* @ipa: IPA pointer
|
|
* @modem_init: Whether the modem is responsible for GSI initialization
|
|
*
|
|
* Return: 0 if successful, or a negative error code
|
|
*
|
|
*/
|
|
int ipa_smp2p_init(struct ipa *ipa, bool modem_init);
|
|
|
|
/**
|
|
* ipa_smp2p_exit() - Inverse of ipa_smp2p_init()
|
|
* @ipa: IPA pointer
|
|
*/
|
|
void ipa_smp2p_exit(struct ipa *ipa);
|
|
|
|
/**
|
|
* ipa_smp2p_disable() - Prevent "ipa-setup-ready" interrupt handling
|
|
* @IPA: IPA pointer
|
|
*
|
|
* Prevent handling of the "setup ready" interrupt from the modem.
|
|
* This is used before initiating shutdown of the driver.
|
|
*/
|
|
void ipa_smp2p_disable(struct ipa *ipa);
|
|
|
|
/**
|
|
* ipa_smp2p_notify_reset() - Reset modem notification state
|
|
* @ipa: IPA pointer
|
|
*
|
|
* If the modem crashes it queries the IPA clock state. In cleaning
|
|
* up after such a crash this is used to reset some state maintained
|
|
* for managing this notification.
|
|
*/
|
|
void ipa_smp2p_notify_reset(struct ipa *ipa);
|
|
|
|
#endif /* _IPA_SMP2P_H_ */
|