11ed7d0c0SAlex Elder /* SPDX-License-Identifier: GPL-2.0 */ 21ed7d0c0SAlex Elder 31ed7d0c0SAlex Elder /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved. 41ed7d0c0SAlex Elder * Copyright (C) 2019-2020 Linaro Ltd. 51ed7d0c0SAlex Elder */ 61ed7d0c0SAlex Elder #ifndef _IPA_DATA_H_ 71ed7d0c0SAlex Elder #define _IPA_DATA_H_ 81ed7d0c0SAlex Elder 91ed7d0c0SAlex Elder #include <linux/types.h> 101ed7d0c0SAlex Elder 111ed7d0c0SAlex Elder #include "ipa_version.h" 121ed7d0c0SAlex Elder #include "ipa_endpoint.h" 131ed7d0c0SAlex Elder #include "ipa_mem.h" 141ed7d0c0SAlex Elder 151ed7d0c0SAlex Elder /** 161ed7d0c0SAlex Elder * DOC: IPA/GSI Configuration Data 171ed7d0c0SAlex Elder * 181ed7d0c0SAlex Elder * Boot-time configuration data is used to define the configuration of the 191ed7d0c0SAlex Elder * IPA and GSI resources to use for a given platform. This data is supplied 201ed7d0c0SAlex Elder * via the Device Tree match table, associated with a particular compatible 211ed7d0c0SAlex Elder * string. The data defines information about resources, endpoints, and 221ed7d0c0SAlex Elder * channels. 231ed7d0c0SAlex Elder * 241ed7d0c0SAlex Elder * Resources are data structures used internally by the IPA hardware. The 251ed7d0c0SAlex Elder * configuration data defines the number (or limits of the number) of various 261ed7d0c0SAlex Elder * types of these resources. 271ed7d0c0SAlex Elder * 281ed7d0c0SAlex Elder * Endpoint configuration data defines properties of both IPA endpoints and 291ed7d0c0SAlex Elder * GSI channels. A channel is a GSI construct, and represents a single 301ed7d0c0SAlex Elder * communication path between the IPA and a particular execution environment 311ed7d0c0SAlex Elder * (EE), such as the AP or Modem. Each EE has a set of channels associated 321ed7d0c0SAlex Elder * with it, and each channel has an ID unique for that EE. For the most part 331ed7d0c0SAlex Elder * the only GSI channels of concern to this driver belong to the AP 341ed7d0c0SAlex Elder * 351ed7d0c0SAlex Elder * An endpoint is an IPA construct representing a single channel anywhere 361ed7d0c0SAlex Elder * in the system. An IPA endpoint ID maps directly to an (EE, channel_id) 371ed7d0c0SAlex Elder * pair. Generally, this driver is concerned with only endpoints associated 381ed7d0c0SAlex Elder * with the AP, however this will change when support for routing (etc.) is 391ed7d0c0SAlex Elder * added. IPA endpoint and GSI channel configuration data are defined 401ed7d0c0SAlex Elder * together, establishing the endpoint_id->(EE, channel_id) mapping. 411ed7d0c0SAlex Elder * 421ed7d0c0SAlex Elder * Endpoint configuration data consists of three parts: properties that 431ed7d0c0SAlex Elder * are common to IPA and GSI (EE ID, channel ID, endpoint ID, and direction); 441ed7d0c0SAlex Elder * properties associated with the GSI channel; and properties associated with 451ed7d0c0SAlex Elder * the IPA endpoint. 461ed7d0c0SAlex Elder */ 471ed7d0c0SAlex Elder 481ed7d0c0SAlex Elder /* The maximum value returned by ipa_resource_group_count() */ 491ed7d0c0SAlex Elder #define IPA_RESOURCE_GROUP_COUNT 4 501ed7d0c0SAlex Elder 511ed7d0c0SAlex Elder /** enum ipa_resource_type_src - source resource types */ 521ed7d0c0SAlex Elder /** 531ed7d0c0SAlex Elder * struct gsi_channel_data - GSI channel configuration data 541ed7d0c0SAlex Elder * @tre_count: number of TREs in the channel ring 551ed7d0c0SAlex Elder * @event_count: number of slots in the associated event ring 561ed7d0c0SAlex Elder * @tlv_count: number of entries in channel's TLV FIFO 571ed7d0c0SAlex Elder * 581ed7d0c0SAlex Elder * A GSI channel is a unidirectional means of transferring data to or 591ed7d0c0SAlex Elder * from (and through) the IPA. A GSI channel has a ring buffer made 601ed7d0c0SAlex Elder * up of "transfer elements" (TREs) that specify individual data transfers 611ed7d0c0SAlex Elder * or IPA immediate commands. TREs are filled by the AP, and control 621ed7d0c0SAlex Elder * is passed to IPA hardware by writing the last written element 631ed7d0c0SAlex Elder * into a doorbell register. 641ed7d0c0SAlex Elder * 651ed7d0c0SAlex Elder * When data transfer commands have completed the GSI generates an 661ed7d0c0SAlex Elder * event (a structure of data) and optionally signals the AP with 671ed7d0c0SAlex Elder * an interrupt. Event structures are implemented by another ring 681ed7d0c0SAlex Elder * buffer, directed toward the AP from the IPA. 691ed7d0c0SAlex Elder * 701ed7d0c0SAlex Elder * The input to a GSI channel is a FIFO of type/length/value (TLV) 711ed7d0c0SAlex Elder * elements, and the size of this FIFO limits the number of TREs 721ed7d0c0SAlex Elder * that can be included in a single transaction. 731ed7d0c0SAlex Elder */ 741ed7d0c0SAlex Elder struct gsi_channel_data { 751ed7d0c0SAlex Elder u16 tre_count; 761ed7d0c0SAlex Elder u16 event_count; 771ed7d0c0SAlex Elder u8 tlv_count; 781ed7d0c0SAlex Elder }; 791ed7d0c0SAlex Elder 801ed7d0c0SAlex Elder /** 811ed7d0c0SAlex Elder * struct ipa_endpoint_tx_data - configuration data for TX endpoints 821ed7d0c0SAlex Elder * @status_endpoint: endpoint to which status elements are sent 831ed7d0c0SAlex Elder * @delay: whether endpoint starts in delay mode 841ed7d0c0SAlex Elder * 851ed7d0c0SAlex Elder * Delay mode prevents a TX endpoint from transmitting anything, even if 861ed7d0c0SAlex Elder * commands have been presented to the hardware. Once the endpoint exits 871ed7d0c0SAlex Elder * delay mode, queued transfer commands are sent. 881ed7d0c0SAlex Elder * 891ed7d0c0SAlex Elder * The @status_endpoint is only valid if the endpoint's @status_enable 901ed7d0c0SAlex Elder * flag is set. 911ed7d0c0SAlex Elder */ 921ed7d0c0SAlex Elder struct ipa_endpoint_tx_data { 931ed7d0c0SAlex Elder enum ipa_endpoint_name status_endpoint; 941ed7d0c0SAlex Elder bool delay; 951ed7d0c0SAlex Elder }; 961ed7d0c0SAlex Elder 971ed7d0c0SAlex Elder /** 981ed7d0c0SAlex Elder * struct ipa_endpoint_rx_data - configuration data for RX endpoints 991ed7d0c0SAlex Elder * @pad_align: power-of-2 boundary to which packet payload is aligned 1001ed7d0c0SAlex Elder * @aggr_close_eof: whether aggregation closes on end-of-frame 1011ed7d0c0SAlex Elder * 1021ed7d0c0SAlex Elder * With each packet it transfers, the IPA hardware can perform certain 1031ed7d0c0SAlex Elder * transformations of its packet data. One of these is adding pad bytes 1041ed7d0c0SAlex Elder * to the end of the packet data so the result ends on a power-of-2 boundary. 1051ed7d0c0SAlex Elder * 1061ed7d0c0SAlex Elder * It is also able to aggregate multiple packets into a single receive buffer. 1071ed7d0c0SAlex Elder * Aggregation is "open" while a buffer is being filled, and "closes" when 1081ed7d0c0SAlex Elder * certain criteria are met. One of those criteria is the sender indicating 1091ed7d0c0SAlex Elder * a "frame" consisting of several transfers has ended. 1101ed7d0c0SAlex Elder */ 1111ed7d0c0SAlex Elder struct ipa_endpoint_rx_data { 1121ed7d0c0SAlex Elder u32 pad_align; 1131ed7d0c0SAlex Elder bool aggr_close_eof; 1141ed7d0c0SAlex Elder }; 1151ed7d0c0SAlex Elder 1161ed7d0c0SAlex Elder /** 1171ed7d0c0SAlex Elder * struct ipa_endpoint_config_data - IPA endpoint hardware configuration 1181ed7d0c0SAlex Elder * @checksum: whether checksum offload is enabled 1191ed7d0c0SAlex Elder * @qmap: whether endpoint uses QMAP protocol 1201ed7d0c0SAlex Elder * @aggregation: whether endpoint supports aggregation 1211ed7d0c0SAlex Elder * @status_enable: whether endpoint uses status elements 1221ed7d0c0SAlex Elder * @dma_mode: whether endpoint operates in DMA mode 1231ed7d0c0SAlex Elder * @dma_endpoint: peer endpoint, if operating in DMA mode 1241ed7d0c0SAlex Elder * @tx: TX-specific endpoint information (see above) 1251ed7d0c0SAlex Elder * @rx: RX-specific endpoint information (see above) 1261ed7d0c0SAlex Elder */ 1271ed7d0c0SAlex Elder struct ipa_endpoint_config_data { 1281ed7d0c0SAlex Elder bool checksum; 1291ed7d0c0SAlex Elder bool qmap; 1301ed7d0c0SAlex Elder bool aggregation; 1311ed7d0c0SAlex Elder bool status_enable; 1321ed7d0c0SAlex Elder bool dma_mode; 1331ed7d0c0SAlex Elder enum ipa_endpoint_name dma_endpoint; 1341ed7d0c0SAlex Elder union { 1351ed7d0c0SAlex Elder struct ipa_endpoint_tx_data tx; 1361ed7d0c0SAlex Elder struct ipa_endpoint_rx_data rx; 1371ed7d0c0SAlex Elder }; 1381ed7d0c0SAlex Elder }; 1391ed7d0c0SAlex Elder 1401ed7d0c0SAlex Elder /** 1411ed7d0c0SAlex Elder * struct ipa_endpoint_data - IPA endpoint configuration data 1421ed7d0c0SAlex Elder * @filter_support: whether endpoint supports filtering 1431ed7d0c0SAlex Elder * @seq_type: hardware sequencer type used for endpoint 1441ed7d0c0SAlex Elder * @config: hardware configuration (see above) 1451ed7d0c0SAlex Elder * 1461ed7d0c0SAlex Elder * Not all endpoints support the IPA filtering capability. A filter table 1471ed7d0c0SAlex Elder * defines the filters to apply for those endpoints that support it. The 1481ed7d0c0SAlex Elder * AP is responsible for initializing this table, and it must include entries 1491ed7d0c0SAlex Elder * for non-AP endpoints. For this reason we define *all* endpoints used 1501ed7d0c0SAlex Elder * in the system, and indicate whether they support filtering. 1511ed7d0c0SAlex Elder * 1521ed7d0c0SAlex Elder * The remaining endpoint configuration data applies only to AP endpoints. 1531ed7d0c0SAlex Elder * The IPA hardware is implemented by sequencers, and the AP must program 1541ed7d0c0SAlex Elder * the type(s) of these sequencers at initialization time. The remaining 1551ed7d0c0SAlex Elder * endpoint configuration data is defined above. 1561ed7d0c0SAlex Elder */ 1571ed7d0c0SAlex Elder struct ipa_endpoint_data { 1581ed7d0c0SAlex Elder bool filter_support; 1591ed7d0c0SAlex Elder /* The next two are specified only for AP endpoints */ 1601ed7d0c0SAlex Elder enum ipa_seq_type seq_type; 1611ed7d0c0SAlex Elder struct ipa_endpoint_config_data config; 1621ed7d0c0SAlex Elder }; 1631ed7d0c0SAlex Elder 1641ed7d0c0SAlex Elder /** 1651ed7d0c0SAlex Elder * struct ipa_gsi_endpoint_data - GSI channel/IPA endpoint data 1661ed7d0c0SAlex Elder * ee: GSI execution environment ID 1671ed7d0c0SAlex Elder * channel_id: GSI channel ID 1681ed7d0c0SAlex Elder * endpoint_id: IPA endpoint ID 1691ed7d0c0SAlex Elder * toward_ipa: direction of data transfer 1701ed7d0c0SAlex Elder * gsi: GSI channel configuration data (see above) 1711ed7d0c0SAlex Elder * ipa: IPA endpoint configuration data (see above) 1721ed7d0c0SAlex Elder */ 1731ed7d0c0SAlex Elder struct ipa_gsi_endpoint_data { 1741ed7d0c0SAlex Elder u8 ee_id; /* enum gsi_ee_id */ 1751ed7d0c0SAlex Elder u8 channel_id; 1761ed7d0c0SAlex Elder u8 endpoint_id; 1771ed7d0c0SAlex Elder bool toward_ipa; 1781ed7d0c0SAlex Elder 1791ed7d0c0SAlex Elder struct gsi_channel_data channel; 1801ed7d0c0SAlex Elder struct ipa_endpoint_data endpoint; 1811ed7d0c0SAlex Elder }; 1821ed7d0c0SAlex Elder 1831ed7d0c0SAlex Elder /** enum ipa_resource_type_src - source resource types */ 1841ed7d0c0SAlex Elder enum ipa_resource_type_src { 1851ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_SRC_PKT_CONTEXTS, 1861ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_SRC_DESCRIPTOR_LISTS, 1871ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_SRC_DESCRIPTOR_BUFF, 1881ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_SRC_HPS_DMARS, 1891ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_SRC_ACK_ENTRIES, 1901ed7d0c0SAlex Elder }; 1911ed7d0c0SAlex Elder 1921ed7d0c0SAlex Elder /** enum ipa_resource_type_dst - destination resource types */ 1931ed7d0c0SAlex Elder enum ipa_resource_type_dst { 1941ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_DST_DATA_SECTORS, 1951ed7d0c0SAlex Elder IPA_RESOURCE_TYPE_DST_DPS_DMARS, 1961ed7d0c0SAlex Elder }; 1971ed7d0c0SAlex Elder 1981ed7d0c0SAlex Elder /** 1991ed7d0c0SAlex Elder * struct ipa_resource_limits - minimum and maximum resource counts 2001ed7d0c0SAlex Elder * @min: minimum number of resources of a given type 2011ed7d0c0SAlex Elder * @max: maximum number of resources of a given type 2021ed7d0c0SAlex Elder */ 2031ed7d0c0SAlex Elder struct ipa_resource_limits { 2041ed7d0c0SAlex Elder u32 min; 2051ed7d0c0SAlex Elder u32 max; 2061ed7d0c0SAlex Elder }; 2071ed7d0c0SAlex Elder 2081ed7d0c0SAlex Elder /** 2091ed7d0c0SAlex Elder * struct ipa_resource_src - source endpoint group resource usage 2101ed7d0c0SAlex Elder * @type: source group resource type 2111ed7d0c0SAlex Elder * @limits: array of limits to use for each resource group 2121ed7d0c0SAlex Elder */ 2131ed7d0c0SAlex Elder struct ipa_resource_src { 2141ed7d0c0SAlex Elder enum ipa_resource_type_src type; 2151ed7d0c0SAlex Elder struct ipa_resource_limits limits[IPA_RESOURCE_GROUP_COUNT]; 2161ed7d0c0SAlex Elder }; 2171ed7d0c0SAlex Elder 2181ed7d0c0SAlex Elder /** 2191ed7d0c0SAlex Elder * struct ipa_resource_dst - destination endpoint group resource usage 2201ed7d0c0SAlex Elder * @type: destination group resource type 2211ed7d0c0SAlex Elder * @limits: array of limits to use for each resource group 2221ed7d0c0SAlex Elder */ 2231ed7d0c0SAlex Elder struct ipa_resource_dst { 2241ed7d0c0SAlex Elder enum ipa_resource_type_dst type; 2251ed7d0c0SAlex Elder struct ipa_resource_limits limits[IPA_RESOURCE_GROUP_COUNT]; 2261ed7d0c0SAlex Elder }; 2271ed7d0c0SAlex Elder 2281ed7d0c0SAlex Elder /** 2291ed7d0c0SAlex Elder * struct ipa_resource_data - IPA resource configuration data 2301ed7d0c0SAlex Elder * @resource_src_count: number of entries in the resource_src array 2311ed7d0c0SAlex Elder * @resource_src: source endpoint group resources 2321ed7d0c0SAlex Elder * @resource_dst_count: number of entries in the resource_dst array 2331ed7d0c0SAlex Elder * @resource_dst: destination endpoint group resources 2341ed7d0c0SAlex Elder * 2351ed7d0c0SAlex Elder * In order to manage quality of service between endpoints, certain resources 2361ed7d0c0SAlex Elder * required for operation are allocated to groups of endpoints. Generally 2371ed7d0c0SAlex Elder * this information is invisible to the AP, but the AP is responsible for 2381ed7d0c0SAlex Elder * programming it at initialization time, so we specify it here. 2391ed7d0c0SAlex Elder */ 2401ed7d0c0SAlex Elder struct ipa_resource_data { 2411ed7d0c0SAlex Elder u32 resource_src_count; 2421ed7d0c0SAlex Elder const struct ipa_resource_src *resource_src; 2431ed7d0c0SAlex Elder u32 resource_dst_count; 2441ed7d0c0SAlex Elder const struct ipa_resource_dst *resource_dst; 2451ed7d0c0SAlex Elder }; 2461ed7d0c0SAlex Elder 2471ed7d0c0SAlex Elder /** 2483e313c3fSAlex Elder * struct ipa_mem - description of IPA memory regions 2493128aae8SAlex Elder * @local_count: number of regions defined in the local[] array 2503128aae8SAlex Elder * @local: array of IPA-local memory region descriptors 2513e313c3fSAlex Elder * @imem_addr: physical address of IPA region within IMEM 2523e313c3fSAlex Elder * @imem_size: size in bytes of IPA IMEM region 2531ed7d0c0SAlex Elder */ 2541ed7d0c0SAlex Elder struct ipa_mem_data { 2553128aae8SAlex Elder u32 local_count; 2563128aae8SAlex Elder const struct ipa_mem *local; 2573e313c3fSAlex Elder u32 imem_addr; 2583e313c3fSAlex Elder u32 imem_size; 2591ed7d0c0SAlex Elder }; 2601ed7d0c0SAlex Elder 2611ed7d0c0SAlex Elder /** 2621ed7d0c0SAlex Elder * struct ipa_data - combined IPA/GSI configuration data 2631ed7d0c0SAlex Elder * @version: IPA hardware version 2641ed7d0c0SAlex Elder * @endpoint_count: number of entries in endpoint_data array 2651ed7d0c0SAlex Elder * @endpoint_data: IPA endpoint/GSI channel data 2661ed7d0c0SAlex Elder * @resource_data: IPA resource configuration data 2671ed7d0c0SAlex Elder * @mem_count: number of entries in mem_data array 2681ed7d0c0SAlex Elder * @mem_data: IPA-local shared memory region data 2691ed7d0c0SAlex Elder */ 2701ed7d0c0SAlex Elder struct ipa_data { 2711ed7d0c0SAlex Elder enum ipa_version version; 2721ed7d0c0SAlex Elder u32 endpoint_count; /* # entries in endpoint_data[] */ 2731ed7d0c0SAlex Elder const struct ipa_gsi_endpoint_data *endpoint_data; 2741ed7d0c0SAlex Elder const struct ipa_resource_data *resource_data; 2753128aae8SAlex Elder const struct ipa_mem_data *mem_data; 2761ed7d0c0SAlex Elder }; 2771ed7d0c0SAlex Elder 2781ed7d0c0SAlex Elder extern const struct ipa_data ipa_data_sdm845; 2791ed7d0c0SAlex Elder extern const struct ipa_data ipa_data_sc7180; 2801ed7d0c0SAlex Elder 2811ed7d0c0SAlex Elder #endif /* _IPA_DATA_H_ */ 282