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>
62 lines
1.5 KiB
C
62 lines
1.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
|
|
/* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
|
|
* Copyright (C) 2018-2020 Linaro Ltd.
|
|
*/
|
|
#ifndef _IPA_CLOCK_H_
|
|
#define _IPA_CLOCK_H_
|
|
|
|
struct device;
|
|
|
|
struct ipa;
|
|
|
|
/**
|
|
* ipa_clock_rate() - Return the current IPA core clock rate
|
|
* @ipa: IPA structure
|
|
*
|
|
* Return: The current clock rate (in Hz), or 0.
|
|
*/
|
|
u32 ipa_clock_rate(struct ipa *ipa);
|
|
|
|
/**
|
|
* ipa_clock_init() - Initialize IPA clocking
|
|
* @dev: IPA device
|
|
*
|
|
* Return: A pointer to an ipa_clock structure, or a pointer-coded error
|
|
*/
|
|
struct ipa_clock *ipa_clock_init(struct device *dev);
|
|
|
|
/**
|
|
* ipa_clock_exit() - Inverse of ipa_clock_init()
|
|
* @clock: IPA clock pointer
|
|
*/
|
|
void ipa_clock_exit(struct ipa_clock *clock);
|
|
|
|
/**
|
|
* ipa_clock_get() - Get an IPA clock reference
|
|
* @ipa: IPA pointer
|
|
*
|
|
* This call blocks if this is the first reference.
|
|
*/
|
|
void ipa_clock_get(struct ipa *ipa);
|
|
|
|
/**
|
|
* ipa_clock_get_additional() - Get an IPA clock reference if not first
|
|
* @ipa: IPA pointer
|
|
*
|
|
* This returns immediately, and only takes a reference if not the first
|
|
*/
|
|
bool ipa_clock_get_additional(struct ipa *ipa);
|
|
|
|
/**
|
|
* ipa_clock_put() - Drop an IPA clock reference
|
|
* @ipa: IPA pointer
|
|
*
|
|
* This drops a clock reference. If the last reference is being dropped,
|
|
* the clock is stopped and RX endpoints are suspended. This call will
|
|
* not block unless the last reference is dropped.
|
|
*/
|
|
void ipa_clock_put(struct ipa *ipa);
|
|
|
|
#endif /* _IPA_CLOCK_H_ */
|