From patchwork Sat Mar 20 15:57:07 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alex Elder X-Patchwork-Id: 405452 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp2267489jai; Sat, 20 Mar 2021 08:59:18 -0700 (PDT) X-Google-Smtp-Source: ABdhPJz4jAIHY14dnrLB8HVwz4b/mhR3smLGSdmXV6vXqg78D75eu/d2U/1brtmeg1LKD7Z38u14 X-Received: by 2002:a05:6402:105a:: with SMTP id e26mr16103445edu.164.1616255957979; Sat, 20 Mar 2021 08:59:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1616255957; cv=none; d=google.com; s=arc-20160816; b=LAlBmLNmUdCCLHtjpMTZIyh1IgNYqEDUYG+IKih6HUhMziXxMzPWWcpHiCh/Lty57S yEs9msKoU4eJSHcuWFg0expGOws0YUrETApJrkPLth2iV7LLNXSAOdN5XhlVInwnJAWF 8pss/Rk5KHGea4m8WCBbZUYZokfSVRXIVby/Hy72YGxyUSakJfQeMB0onLhAJ8/v2xBw wPSes/xgEMgKOI5EWDbqYHn1C9Low9LElbFCXCisMBjP1YgevzzYPXT/wbFHkF4AWHjB ReoXVGM9450m6++MFfNkRpp8RwpL0Og3Up7FNAFh3bQk68ud43fPNbj7iLFImuUHW5t0 RQzw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=dqBAhnvQZBZS9R5OnlTX21fRiOb56RVD97okeY10dMw=; b=LN9ShpB7XULzxPU8xLoH7FlXo6pSJa9VyoN0nPRcvUMkrYhfKslbJ5ALQy0xEOTegF oM1tPZmvWqh6y2Ebly3R9qF/R1JF+UXlJeQrQzrTSCLLs6vzYxHK4tic5xt1zc+3PHxs xzT9RnNyvao7PfUxZkZ1Rc69rD0wT19RjGb1ElhBa5xX7f+hjnI3LD7VyutTx/0ygohO KwZc2AoKx58oaipobYnlCubLzqKxh4CS5OuDxMepkPfJmYNXr1hgi6KOofQbCoDYXz4Z IPirM7AWrpNRsoheVMp9VGIXas9rqxQr8zGUtQbtJbAjzor9RgWYyU7wo1L1sNw5JrSo srPw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=goyrhVJu; spf=pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=netdev-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id v5si7262729edc.166.2021.03.20.08.59.17; Sat, 20 Mar 2021 08:59:17 -0700 (PDT) Received-SPF: pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=goyrhVJu; spf=pass (google.com: domain of netdev-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=netdev-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229979AbhCTP5i (ORCPT + 8 others); Sat, 20 Mar 2021 11:57:38 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43818 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229846AbhCTP5Q (ORCPT ); Sat, 20 Mar 2021 11:57:16 -0400 Received: from mail-il1-x12f.google.com (mail-il1-x12f.google.com [IPv6:2607:f8b0:4864:20::12f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 51690C061763 for ; Sat, 20 Mar 2021 08:57:15 -0700 (PDT) Received: by mail-il1-x12f.google.com with SMTP id v3so10864976ilj.12 for ; Sat, 20 Mar 2021 08:57:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=dqBAhnvQZBZS9R5OnlTX21fRiOb56RVD97okeY10dMw=; b=goyrhVJuCTasQ8dNYdkm58sZiQT3GQITChYTvN2McOENcEIZeBs2mFwXWOT6yvhC/T C5FOfj2aOGJKVVmmycTNgkjkfDMI5lrB5TWCZatHmQ0NiC4a8+kpIv7TkwdFG9qtN3PD R8PCjmz5wvp9PmF/hbdLZv3HDqXo+HBrnaRWTj2FrelpFY6x22QT3c894GgwuXAwN0ZL cL/+aUWAf6EwKbMcVL2hpqP+IlSkokRvaCHMH07AIGPYjnoow2GFonCR1yN0EIVnQPta 03kDdf7H8/R9onwvMrczwzUuTvJ2xLMY7nKq+KdenEta5g3mAJKO2GY3q5Yg67SfwX5L IQ/w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=dqBAhnvQZBZS9R5OnlTX21fRiOb56RVD97okeY10dMw=; b=iheraDKy+4ohZ17svUwD8Jz8TK7Komuy3auyXc+cMedlL67HfrxpN4G8AZ+2sv2r2T UvDxf/neYN9VM5SlzOmPDGH/jdoITA7b5BoS4zNWkC9zMKPSg92mFYv5pyHeTB+bPa4G oYZVjLx4a/Ft2m3shPXObbf4MisTLFOXr3fEPSg78asoM5Yy9+nsjx5coMpSZHRKz0Qu EJDfbmd80YVm1nEoztl6bbkC0Ns1mk2vLo8hG7a2G30zbP3ypX2EHcypkKqGuDB3fA+u q5U+ivAs8gNjTdFRJgbNrLc1VWq7tf0Uo+06emqgyfV6EbhmxjHFYoK8cbmBgwHP8Rok CnbA== X-Gm-Message-State: AOAM531YzEQ/cdS3zCytEvYOj2nmpJVBSiigVF2mpdawvc8SQls63xFp ahP5McsF6iQqcwl3DndCLzmrCQ== X-Received: by 2002:a92:cccb:: with SMTP id u11mr6323434ilq.44.1616255834829; Sat, 20 Mar 2021 08:57:14 -0700 (PDT) Received: from localhost.localdomain (c-73-185-129-58.hsd1.mn.comcast.net. [73.185.129.58]) by smtp.gmail.com with ESMTPSA id n16sm4501698ilq.71.2021.03.20.08.57.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 20 Mar 2021 08:57:14 -0700 (PDT) From: Alex Elder To: davem@davemloft.net, kuba@kernel.org Cc: bjorn.andersson@linaro.org, evgreen@chromium.org, cpratapa@codeaurora.org, subashab@codeaurora.org, elder@kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH net-next 5/5] net: ipa: update some comments in "ipa_data.h" Date: Sat, 20 Mar 2021 10:57:07 -0500 Message-Id: <20210320155707.2009962-6-elder@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210320155707.2009962-1-elder@linaro.org> References: <20210320155707.2009962-1-elder@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Fix/expand some comments in "ipa_data.h". Signed-off-by: Alex Elder --- drivers/net/ipa/ipa_data.h | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) -- 2.27.0 diff --git a/drivers/net/ipa/ipa_data.h b/drivers/net/ipa/ipa_data.h index caf9b3f9577eb..7816583fc14aa 100644 --- a/drivers/net/ipa/ipa_data.h +++ b/drivers/net/ipa/ipa_data.h @@ -18,8 +18,9 @@ * Boot-time configuration data is used to define the configuration of the * IPA and GSI resources to use for a given platform. This data is supplied * via the Device Tree match table, associated with a particular compatible - * string. The data defines information about resources, endpoints, and - * channels. + * string. The data defines information about how resources, endpoints and + * channels, memory, clocking and so on are allocated and used for the + * platform. * * Resources are data structures used internally by the IPA hardware. The * configuration data defines the number (or limits of the number) of various @@ -75,10 +76,10 @@ struct ipa_qsb_data { * * A GSI channel is a unidirectional means of transferring data to or * from (and through) the IPA. A GSI channel has a ring buffer made - * up of "transfer elements" (TREs) that specify individual data transfers - * or IPA immediate commands. TREs are filled by the AP, and control - * is passed to IPA hardware by writing the last written element - * into a doorbell register. + * up of "transfer ring elements" (TREs) that specify individual data + * transfers or IPA immediate commands. TREs are filled by the AP, + * and control is passed to IPA hardware by writing the last written + * element into a doorbell register. * * When data transfer commands have completed the GSI generates an * event (a structure of data) and optionally signals the AP with @@ -264,7 +265,7 @@ struct ipa_resource_data { * @imem_addr: physical address of IPA region within IMEM * @imem_size: size in bytes of IPA IMEM region * @smem_id: item identifier for IPA region within SMEM memory - * @imem_size: size in bytes of the IPA SMEM region + * @smem_size: size in bytes of the IPA SMEM region */ struct ipa_mem_data { u32 local_count; @@ -307,14 +308,14 @@ struct ipa_clock_data { * @endpoint_count: number of entries in the endpoint_data array * @endpoint_data: IPA endpoint/GSI channel data * @resource_data: IPA resource configuration data - * @mem_count: number of entries in the mem_data array - * @mem_data: IPA-local shared memory region data + * @mem_data: IPA memory region data + * @clock_data: IPA clock and interconnect data */ struct ipa_data { enum ipa_version version; - u32 qsb_count; /* # entries in qsb_data[] */ + u32 qsb_count; /* number of entries in qsb_data[] */ const struct ipa_qsb_data *qsb_data; - u32 endpoint_count; /* # entries in endpoint_data[] */ + u32 endpoint_count; /* number of entries in endpoint_data[] */ const struct ipa_gsi_endpoint_data *endpoint_data; const struct ipa_resource_data *resource_data; const struct ipa_mem_data *mem_data;