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>
72 lines
2.3 KiB
C
72 lines
2.3 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_GSI_TRANS_H_
|
|
#define _IPA_GSI_TRANS_H_
|
|
|
|
#include <linux/types.h>
|
|
|
|
struct gsi;
|
|
struct gsi_trans;
|
|
struct ipa_gsi_endpoint_data;
|
|
|
|
/**
|
|
* ipa_gsi_trans_complete() - GSI transaction completion callback
|
|
* @trans: Transaction that has completed
|
|
*
|
|
* This called from the GSI layer to notify the IPA layer that a
|
|
* transaction has completed.
|
|
*/
|
|
void ipa_gsi_trans_complete(struct gsi_trans *trans);
|
|
|
|
/**
|
|
* ipa_gsi_trans_release() - GSI transaction release callback
|
|
* @trans: Transaction whose resources should be freed
|
|
*
|
|
* This called from the GSI layer to notify the IPA layer that a
|
|
* transaction is about to be freed, so any resources associated
|
|
* with it should be released.
|
|
*/
|
|
void ipa_gsi_trans_release(struct gsi_trans *trans);
|
|
|
|
/**
|
|
* ipa_gsi_channel_tx_queued() - GSI queued to hardware notification
|
|
* @gsi: GSI pointer
|
|
* @channel_id: Channel number
|
|
* @count: Number of transactions queued
|
|
* @byte_count: Number of bytes to transfer represented by transactions
|
|
*
|
|
* This called from the GSI layer to notify the IPA layer that some
|
|
* number of transactions have been queued to hardware for execution.
|
|
*/
|
|
void ipa_gsi_channel_tx_queued(struct gsi *gsi, u32 channel_id, u32 count,
|
|
u32 byte_count);
|
|
|
|
/**
|
|
* ipa_gsi_channel_tx_completed() - GSI transaction completion callback
|
|
* @gsi: GSI pointer
|
|
* @channel_id: Channel number
|
|
* @count: Number of transactions completed since last report
|
|
* @byte_count: Number of bytes transferred represented by transactions
|
|
*
|
|
* This called from the GSI layer to notify the IPA layer that the hardware
|
|
* has reported the completion of some number of transactions.
|
|
*/
|
|
void ipa_gsi_channel_tx_completed(struct gsi *gsi, u32 channel_id, u32 count,
|
|
u32 byte_count);
|
|
|
|
/* ipa_gsi_endpoint_data_empty() - Empty endpoint config data test
|
|
* @data: endpoint configuration data
|
|
*
|
|
* Determines whether an endpoint configuration data entry is empty,
|
|
* meaning it contains no valid configuration information and should
|
|
* be ignored.
|
|
*
|
|
* Return: true if empty; false otherwise
|
|
*/
|
|
bool ipa_gsi_endpoint_data_empty(const struct ipa_gsi_endpoint_data *data);
|
|
|
|
#endif /* _IPA_GSI_TRANS_H_ */
|