net/ipa/ipa_data.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4  * Copyright (C) 2019-2024 Linaro Ltd.
18  * Boot-time configuration data is used to define the configuration of the
26  * configuration data defines the number (or limits of the number) of various
27  * types of these resources.
29  * Endpoint configuration data defines properties of both IPA endpoints and
32  * (EE), such as the AP or Modem.  Each EE has a set of channels associated
34  * the only GSI channels of concern to this driver belong to the AP.
41  * together, establishing the endpoint_id->(EE, channel_id) mapping.
43  * Endpoint configuration data consists of three parts:  properties that
49 /* The maximum possible number of source or destination resource groups */
52 /** enum ipa_qsb_master_id - array index for IPA QSB configuration data */
59  * struct ipa_qsb_data - Qualcomm System Bus configuration data
62  * @max_reads_beats: Max outstanding read bytes in 8-byte "beats" (if non-zero)
71  * struct gsi_channel_data - GSI channel configuration data
72  * @tre_count:		number of TREs in the channel ring
73  * @event_count:	number of slots in the associated event ring
74  * @tlv_count:		number of entries in channel's TLV FIFO
76  * A GSI channel is a unidirectional means of transferring data to or
78  * up of "transfer ring elements" (TREs) that specify individual data
84  * event (a structure of data) and optionally signals the AP with
88  * The input to a GSI channel is a FIFO of type/length/value (TLV)
89  * elements, and the size of this FIFO limits the number of TREs
93 	u16 tre_count;			/* must be a power of 2 */
94 	u16 event_count;		/* must be a power of 2 */
99  * struct ipa_endpoint_data - IPA endpoint configuration data
106  * for non-AP endpoints.  For this reason we define *all* endpoints used
118  * struct ipa_gsi_endpoint_data - GSI channel/IPA endpoint data
122  * @toward_ipa:	direction of data transfer
137  * struct ipa_resource_limits - minimum and maximum resource counts
138  * @min:	minimum number of resources of a given type
139  * @max:	maximum number of resources of a given type
147  * struct ipa_resource - resource group source or destination resource usage
148  * @limits:	array of resource limits, indexed by group
155  * struct ipa_resource_data - IPA resource configuration data
156  * @rsrc_group_src_count: number of source resource groups supported
157  * @rsrc_group_dst_count: number of destination resource groups supported
158  * @resource_src_count:	number of entries in the resource_src array
160  * @resource_dst_count:	number of entries in the resource_dst array
163  * In order to manage quality of service between endpoints, certain resources
164  * required for operation are allocated to groups of endpoints.  Generally
178  * struct ipa_mem_data - description of IPA memory regions
179  * @local_count:	number of regions defined in the local[] array
180  * @local:		array of IPA-local memory region descriptors
181  * @imem_addr:		physical address of IPA region within IMEM
182  * @imem_size:		size in bytes of IPA IMEM region
184  * @smem_size:		size in bytes of the IPA SMEM region
196  * struct ipa_interconnect_data - description of IPA interconnect bandwidths
197  * @name:		Interconnect name (matches interconnect-name in DT)
208  * struct ipa_power_data - description of IPA power configuration data
210  * @interconnect_count:	Number of entries in the interconnect_data array
220  * struct ipa_data - combined IPA/GSI configuration data
223  * @qsb_count:		number of entries in the qsb_data array
225  * @modem_route_count:	number of modem entries in a routing table
226  * @endpoint_count:	number of entries in the endpoint_data array
235 	u32 qsb_count;		/* number of entries in qsb_data[] */
238 	u32 endpoint_count;	/* number of entries in endpoint_data[] */