projects / linux-block.git / blame
| Commit | Line | Data |
|---|---|---|
| ca48b27b AE |
1 | /* SPDX-License-Identifier: GPL-2.0 */ |
| 2 | ||
| 3 | /* Copyright (c) 2015-2018, The Linux Foundation. All rights reserved. | |
| 4 | * Copyright (C) 2018-2020 Linaro Ltd. | |
| 5 | */ | |
| 6 | #ifndef _GSI_PRIVATE_H_ | |
| 7 | #define _GSI_PRIVATE_H_ | |
| 8 | ||
| 9 | /* === Only "gsi.c" and "gsi_trans.c" should include this file === */ | |
| 10 | ||
| 11 | #include <linux/types.h> | |
| 12 | ||
| 13 | struct gsi_trans; | |
| 14 | struct gsi_ring; | |
| 15 | struct gsi_channel; | |
| 16 | ||
| 19aaf72c | 17 | #define GSI_RING_ELEMENT_SIZE 16 /* bytes; must be a power of 2 */ |
| ca48b27b | 18 | |
| ca48b27b AE |
19 | /** |
| 20 | * gsi_trans_move_complete() - Mark a GSI transaction completed | |
| 21 | * @trans: Transaction to commit | |
| 22 | */ | |
| 23 | void gsi_trans_move_complete(struct gsi_trans *trans); | |
| 24 | ||
| 25 | /** | |
| 26 | * gsi_trans_move_polled() - Mark a transaction polled | |
| 27 | * @trans: Transaction to update | |
| 28 | */ | |
| 29 | void gsi_trans_move_polled(struct gsi_trans *trans); | |
| 30 | ||
| 31 | /** | |
| 32 | * gsi_trans_complete() - Complete a GSI transaction | |
| 33 | * @trans: Transaction to complete | |
| 34 | * | |
| 35 | * Marks a transaction complete (including freeing it). | |
| 36 | */ | |
| 37 | void gsi_trans_complete(struct gsi_trans *trans); | |
| 38 | ||
| 39 | /** | |
| 40 | * gsi_channel_trans_mapped() - Return a transaction mapped to a TRE index | |
| 41 | * @channel: Channel associated with the transaction | |
| 42 | * @index: Index of the TRE having a transaction | |
| 43 | * | |
| e3eea08e | 44 | * Return: The GSI transaction pointer associated with the TRE index |
| ca48b27b AE |
45 | */ |
| 46 | struct gsi_trans *gsi_channel_trans_mapped(struct gsi_channel *channel, | |
| 47 | u32 index); | |
| 48 | ||
| 49 | /** | |
| 50 | * gsi_channel_trans_complete() - Return a channel's next completed transaction | |
| 51 | * @channel: Channel whose next transaction is to be returned | |
| 52 | * | |
| e3eea08e | 53 | * Return: The next completed transaction, or NULL if nothing new |
| ca48b27b AE |
54 | */ |
| 55 | struct gsi_trans *gsi_channel_trans_complete(struct gsi_channel *channel); | |
| 56 | ||
| 57 | /** | |
| 58 | * gsi_channel_trans_cancel_pending() - Cancel pending transactions | |
| 59 | * @channel: Channel whose pending transactions should be cancelled | |
| 60 | * | |
| 61 | * Cancel all pending transactions on a channel. These are transactions | |
| 62 | * that have been committed but not yet completed. This is required when | |
| 63 | * the channel gets reset. At that time all pending transactions will be | |
| 64 | * marked as cancelled. | |
| 65 | * | |
| 66 | * NOTE: Transactions already complete at the time of this call are | |
| 67 | * unaffected. | |
| 68 | */ | |
| 69 | void gsi_channel_trans_cancel_pending(struct gsi_channel *channel); | |
| 70 | ||
| 71 | /** | |
| 72 | * gsi_channel_trans_init() - Initialize a channel's GSI transaction info | |
| 73 | * @gsi: GSI pointer | |
| 74 | * @channel_id: Channel number | |
| 75 | * | |
| e3eea08e | 76 | * Return: 0 if successful, or -ENOMEM on allocation failure |
| ca48b27b AE |
77 | * |
| 78 | * Creates and sets up information for managing transactions on a channel | |
| 79 | */ | |
| 80 | int gsi_channel_trans_init(struct gsi *gsi, u32 channel_id); | |
| 81 | ||
| 82 | /** | |
| 83 | * gsi_channel_trans_exit() - Inverse of gsi_channel_trans_init() | |
| 84 | * @channel: Channel whose transaction information is to be cleaned up | |
| 85 | */ | |
| 86 | void gsi_channel_trans_exit(struct gsi_channel *channel); | |
| 87 | ||
| 88 | /** | |
| 89 | * gsi_channel_doorbell() - Ring a channel's doorbell | |
| 90 | * @channel: Channel whose doorbell should be rung | |
| 91 | * | |
| 92 | * Rings a channel's doorbell to inform the GSI hardware that new | |
| 93 | * transactions (TREs, really) are available for it to process. | |
| 94 | */ | |
| 95 | void gsi_channel_doorbell(struct gsi_channel *channel); | |
| 96 | ||
| 97 | /** | |
| 98 | * gsi_ring_virt() - Return virtual address for a ring entry | |
| 99 | * @ring: Ring whose address is to be translated | |
| 862d3f2c | 100 | * @index: Index (slot number) of entry |
| ca48b27b AE |
101 | */ |
| 102 | void *gsi_ring_virt(struct gsi_ring *ring, u32 index); | |
| 103 | ||
| 4e0f28e9 AE |
104 | /** |
| 105 | * gsi_trans_tx_committed() - Record bytes committed for transmit | |
| 106 | * @trans: TX endpoint transaction being committed | |
| 107 | * | |
| 108 | * Report that a TX transaction has been committed. It updates some | |
| 109 | * statistics used to manage transmit rates. | |
| 110 | */ | |
| 111 | void gsi_trans_tx_committed(struct gsi_trans *trans); | |
| 112 | ||
| ca48b27b | 113 | /** |
| bcec9ecb AE |
114 | * gsi_trans_tx_queued() - Report a queued TX channel transaction |
| 115 | * @trans: Transaction being passed to hardware | |
| ca48b27b | 116 | * |
| bcec9ecb AE |
117 | * Report to the network stack that a TX transaction is being supplied |
| 118 | * to the hardware. | |
| ca48b27b | 119 | */ |
| bcec9ecb | 120 | void gsi_trans_tx_queued(struct gsi_trans *trans); |
| ca48b27b AE |
121 | |
| 122 | #endif /* _GSI_PRIVATE_H_ */ |