From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <stable-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 2164B43F32
	for <public@inbox.dpdk.org>; Tue, 30 Apr 2024 20:57:42 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 0159840262;
	Tue, 30 Apr 2024 20:57:42 +0200 (CEST)
Received: from NAM11-DM6-obe.outbound.protection.outlook.com
 (mail-dm6nam11on2086.outbound.protection.outlook.com [40.107.223.86])
 by mails.dpdk.org (Postfix) with ESMTP id A6A674025C;
 Tue, 30 Apr 2024 20:57:40 +0200 (CEST)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;
 b=RmyJ7ArsQSjUlA2Nfzeo4Fu/Y9I2BhCTm84m/4B23HJZzLl6Vfn6yAu08kyaQPOrlcMVj4f1hMYMRHqZsKFtE5YUuUJ/KhoEnkyFzR2tk0M53Hkod06Nu7/k/8QoLUO6oR1DfEcic91wONYgCDOx9vkE7+YCamJLnvNXdWWlXUq4QjLMfOQvG6O5GU+6b3EHyEPi+Wuu3yPQKbamIcVcprp6Qr/csAGYrybteZYgNcOCVJUToYyJFHLfEveY5EjGAbEQc/czBMnG0G9fmdXZ0FqswAsFaI+0oPsVzeKjhtQyf+DkqZ00HB8Vt30Sc7bd6HjeQ5B8mXdu5yo4rcoEVg==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; 
 s=arcselector9901;
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;
 bh=TMirQ3vZmNBf+dUGtXwuVtZm5IZt9hWtyAJwenJUBAE=;
 b=i/yGg0wEQ9a9TcbybZx1Ldg5Udovaa24bWO0iskH0GgQ29xyVAZWq4EF3Votd8ynQt2aOQzHkIDqTQEfrdR6EqYBblyB2AZsdW7eZd1nl3m6YKBOa/yuaG9m92mqyADI0uwG/1++PYl1m2ExKT1+6S6OSbLzIxdEv7VtAG/7vERYRNXJV96VwdEQXTQX5nWhp+BnXbLSZ0132aGL+y2H022zuk8WzJeCAy+TVIEZ2vdnxm/04V3bPsIjVVFWk63sMc0CLCh7cLla/Jvtbz9ipz5vS5dvv2GMTQyyLCj6wSujNDi90AiAuygxYegluMSm0wyxhCf6sonzNq6urLJlXg==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is
 165.204.84.17) smtp.rcpttodomain=dpdk.org smtp.mailfrom=amd.com; dmarc=pass
 (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com;
 dkim=none (message not signed); arc=none (0)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; 
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
 bh=TMirQ3vZmNBf+dUGtXwuVtZm5IZt9hWtyAJwenJUBAE=;
 b=DBO/ydilLhsluYbo+0XdK20qRj3ZV0WGdbcmjnJC+RiPx+ugmsXoa13yATc/i2ZfdXuBTKYMP7NqwssKXvbVBpY7qgrZFmJ7HOz3ehQsGAGVhDJ9pDk7rOxJnM1kN9WsmhsWnUBq6AXawWy+x1BsEXanAi/g0cLDUHzk20HSnaw=
Received: from MW4PR03CA0325.namprd03.prod.outlook.com (2603:10b6:303:dd::30)
 by SJ2PR12MB8806.namprd12.prod.outlook.com (2603:10b6:a03:4d0::8)
 with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7519.35; Tue, 30 Apr
 2024 18:57:38 +0000
Received: from MWH0EPF000A6731.namprd04.prod.outlook.com
 (2603:10b6:303:dd:cafe::12) by MW4PR03CA0325.outlook.office365.com
 (2603:10b6:303:dd::30) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7519.34 via Frontend
 Transport; Tue, 30 Apr 2024 18:57:38 +0000
X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17)
 smtp.mailfrom=amd.com; dkim=none (message not signed)
 header.d=none;dmarc=pass action=none header.from=amd.com;
Received-SPF: Pass (protection.outlook.com: domain of amd.com designates
 165.204.84.17 as permitted sender) receiver=protection.outlook.com;
 client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C
Received: from SATLEXMB04.amd.com (165.204.84.17) by
 MWH0EPF000A6731.mail.protection.outlook.com (10.167.249.23) with Microsoft
 SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id
 15.20.7544.18 via Frontend Transport; Tue, 30 Apr 2024 18:57:38 +0000
Received: from telcodpdk.amd.com (10.180.168.240) by SATLEXMB04.amd.com
 (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.35; Tue, 30 Apr
 2024 13:57:30 -0500
From: Ferruh Yigit <ferruh.yigit@amd.com>
To: Sivaprasad Tummala <sivaprasad.tummala@amd.com>
CC: <dev@dpdk.org>, <stable@dpdk.org>, Vipin Varghese
 <vipin.varghese@amd.com>, Anatoly Burakov <anatoly.burakov@intel.com>, "David
 Hunt" <david.hunt@intel.com>
Subject: [PATCH] doc: add power uncore API documentation
Date: Tue, 30 Apr 2024 19:57:14 +0100
Message-ID: <20240430185714.2550698-1-ferruh.yigit@amd.com>
X-Mailer: git-send-email 2.34.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Originating-IP: [10.180.168.240]
X-ClientProxiedBy: SATLEXMB04.amd.com (10.181.40.145) To SATLEXMB04.amd.com
 (10.181.40.145)
X-EOPAttributedMessage: 0
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: MWH0EPF000A6731:EE_|SJ2PR12MB8806:EE_
X-MS-Office365-Filtering-Correlation-Id: fdfc1a39-cf82-4f74-b1f8-08dc694767eb
X-MS-Exchange-SenderADCheck: 1
X-MS-Exchange-AntiSpam-Relay: 0
X-Microsoft-Antispam: BCL:0;
 ARA:13230031|1800799015|36860700004|82310400014|376005; 
X-Microsoft-Antispam-Message-Info: =?us-ascii?Q?f7kevMCoAQFwUTXhv6mYkjBGklXt7e7VMfS2mooj72PBfAebbohFC2cX8Qc9?=
 =?us-ascii?Q?hm3duKxZW9Jkm2venRDeKVhH/KpTzCy1yTzjiSg62e0uYFqJgKJi3Hq+MJ8L?=
 =?us-ascii?Q?5nVPI01fWx3PeAHWrbN7W0SVJ61Q2SQRPh6gKe/z60lx50XtYJDh41R05mUw?=
 =?us-ascii?Q?OFxSCloDV5bIz3tWcMfuGxuLJkh5/Nh/T04bYDpvlOTxnMIyqdRZ4ir8s1EA?=
 =?us-ascii?Q?t8N3M59qf6Vr4+P/ulDCZMePZny07ejfO8+Q45qv/euPJJFTsOdMdB6g3yZq?=
 =?us-ascii?Q?0ZODQS8Ly8DNyveiWdzsBkVPUZ/t2nDDT+QTLQktNoej7aY1PLL70PyI+n9T?=
 =?us-ascii?Q?U9FP5TvMYkkp4i35V2AAu7NBZe1pvQnL/H8cFh4dX9OdjBsmYN8Z7rAWZ3mS?=
 =?us-ascii?Q?or+ffpaPGxj5eticgh6uDPNi4QTmWuJqfXwi2lbIRduDxPGTOfZ6XPlyxrbp?=
 =?us-ascii?Q?SJcuiNyG4C6/cTTXLoHlFxmjxCU4CKlzxkC+sAW79sPEWEoswN7S4XvnqhBs?=
 =?us-ascii?Q?ryshaiuCj4nzMEUkEOj041Gmh2Nh3xvjK1ReJzDLK4NTWzyazNYbHCT2eXAb?=
 =?us-ascii?Q?YJ1CzlGgar68x6HDkTOdGIl8ZmPcqXJYY9UuoSMrxGyuuWDS+hfLJ3MlfLUX?=
 =?us-ascii?Q?+hPhchv9BSLATlKIf4XNJxnSnGY+JBJcrwDEntO4LGlYqh6PX39PmWHk/oJY?=
 =?us-ascii?Q?akUJ/1lXjPfwXxwjt0x9xtLPBXh/FOiLMJL4ear0RsmophnhuA3LcSvFppAr?=
 =?us-ascii?Q?l25axldjG0LUNW7TsErhheyX/9FOzBpR86Thoc6DKVa+jc1YeujWell6cFXa?=
 =?us-ascii?Q?rXAV9e4fJZrEKZQ1yT7B9y+8UggHVPpod6DYq7jERWc2EwsCIvI7hygHYVFj?=
 =?us-ascii?Q?ErExjZJ+181nul95W0ilADeqq9yfW0rTWc6dUynpWCd/njF1mFAVRsur+cw5?=
 =?us-ascii?Q?89K71QJcqjMASZABZQa4SmTcsWTcCDWaiUgVVIbNIynncxvuLSYaGp6Nq7hJ?=
 =?us-ascii?Q?LZ0UG2nP1Ntb/s1eoV0tvP7jybiHPr+/e7e4Uuq27OAbnfOI4rucvViAc1yH?=
 =?us-ascii?Q?QiAgG1y/irr8JvGXjxHXMyGXp2Vco6ytKwRExdEHpf4ugC/nr3hVsSGcmpS9?=
 =?us-ascii?Q?tYEDnAinB5MPeYF/BuKXl7s2Zrhw6lTeD/3GapOK242f+vXAz0ab3hwLM5w7?=
 =?us-ascii?Q?8UkZgio1skvVTZt21TI8N6CGZ44dKqpeoJPzrX3Wryut+FphMQnqoLsXSMUr?=
 =?us-ascii?Q?VBWLkqI2/JRd5kk330ScfWbDam5q6K/enklOGEAsawBU5f8BknyK7BHqEXG/?=
 =?us-ascii?Q?SbApfWwROPot1cORG/BaGPKNJ4lV6WvUwcqZ/eIAjjjudymcKNpJUnjuVkeW?=
 =?us-ascii?Q?A4mObXHXp9VzXdE1wZKR55zaHOeY?=
X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:;
 IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE;
 SFS:(13230031)(1800799015)(36860700004)(82310400014)(376005); DIR:OUT;
 SFP:1101; 
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Apr 2024 18:57:38.4518 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: fdfc1a39-cf82-4f74-b1f8-08dc694767eb
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17];
 Helo=[SATLEXMB04.amd.com]
X-MS-Exchange-CrossTenant-AuthSource: MWH0EPF000A6731.namprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ2PR12MB8806
X-BeenThere: stable@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: patches for DPDK stable branches <stable.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/stable>,
 <mailto:stable-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/stable/>
List-Post: <mailto:stable@dpdk.org>
List-Help: <mailto:stable-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/stable>,
 <mailto:stable-request@dpdk.org?subject=subscribe>
Errors-To: stable-bounces@dpdk.org

Add missing power uncore API documenttation.

Fixes: ac1edcb6621a ("power: refactor uncore power management API")
Cc: stable@dpdk.org

Reported-by: Vipin Varghese <vipin.varghese@amd.com>
Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
Cc: Anatoly Burakov <anatoly.burakov@intel.com>
Cc: David Hunt <david.hunt@intel.com>
Cc: Sivaprasad Tummala <sivaprasad.tummala@amd.com>
---
 doc/api/doxy-api-index.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 8c1eb8fafa73..353b0e85ae0a 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -103,6 +103,7 @@ The public API headers are grouped by topics:
   [service cores](@ref rte_service.h),
   [keepalive](@ref rte_keepalive.h),
   [power/freq](@ref rte_power.h),
+  [power/uncore](@ref rte_power_uncore.h),
   [PMD power](@ref rte_power_pmd_mgmt.h)
 
 - **layers**:
-- 
2.34.1