From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 9B6BFA0A05;
Wed, 20 Jan 2021 15:26:12 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 2AC18140D0A;
Wed, 20 Jan 2021 15:26:12 +0100 (CET)
Received: from mga07.intel.com (mga07.intel.com [134.134.136.100])
by mails.dpdk.org (Postfix) with ESMTP id 13FD2140D07;
Wed, 20 Jan 2021 15:26:09 +0100 (CET)
IronPort-SDR: S+ZUlfXtl25+wtSvQEFxLn+l5ELaDrciUaurgqa7M4Sy8AtXeb3qAIEoiWU4ZgKD7zTwLZK1Ys
0D3YGAS+NAVg==
X-IronPort-AV: E=McAfee;i="6000,8403,9869"; a="243181872"
X-IronPort-AV: E=Sophos;i="5.79,361,1602572400"; d="scan'208";a="243181872"
Received: from orsmga003.jf.intel.com ([10.7.209.27])
by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
20 Jan 2021 06:26:08 -0800
IronPort-SDR: pNM9sKxnpe6v2OUfZwwyJAGlHnIp5rkuBk7Ma0F1WDlkssg75R01mMthZJowmJxQgEg3Qq2K54
Sb+l1DqnmYTg==
X-IronPort-AV: E=Sophos;i="5.79,361,1602572400"; d="scan'208";a="351061157"
Received: from aburakov-mobl.ger.corp.intel.com (HELO [10.213.240.112])
([10.213.240.112])
by orsmga003-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
20 Jan 2021 06:26:07 -0800
To: David Hunt <david.hunt@intel.com>, dev@dpdk.org
Cc: stable@dpdk.org, Bruce Richardson <bruce.richardson@intel.com>
References: <20210108143048.23755-2-david.hunt@intel.com>
<20210120135556.33763-1-david.hunt@intel.com>
<20210120135556.33763-3-david.hunt@intel.com>
From: "Burakov, Anatoly" <anatoly.burakov@intel.com>
Message-ID: <3e7fc5b8-9e10-af74-6060-68143a8931be@intel.com>
Date: Wed, 20 Jan 2021 14:26:05 +0000
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:68.0) Gecko/20100101
Thunderbird/68.12.0
MIME-Version: 1.0
In-Reply-To: <20210120135556.33763-3-david.hunt@intel.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Subject: Re: [dpdk-dev] [PATCH v3 2/6] power: make channel msg functions
public
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
On 20-Jan-21 1:55 PM, David Hunt wrote:
> From: Bruce Richardson <bruce.richardson@intel.com>
>
> Move the 2 public functions into rte_power_guest_channel.h
>
> Fixes: 210c383e247b ("power: packet format for vm power management")
> Fixes: cd0d5547e873 ("power: vm communication channels in guest")
> Cc: stable@dpdk.org
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> Signed-off-by: David Hunt <david.hunt@intel.com>
>
> ---
<snip>
>
> +/**
> + * Send a message contained in pkt over the Virtio-Serial to the host endpoint.
> + *
> + * @param pkt
> + * Pointer to a populated struct channel_packet
> + *
> + * @param lcore_id
> + * lcore_id.
Not very informative doxygen comment :)
> + *
> + * @return
> + * - 0 on success.
> + * - Negative on error.
> + */
> +__rte_experimental
> +int rte_power_guest_channel_send_msg(struct channel_packet *pkt,
> + unsigned int lcore_id);
> +
> +/**
> + * Receive a message contained in pkt over the Virtio-Serial
> + * from the host endpoint.
> + *
Nitpick, but we generally add a warning to experimental functions, like so:
* @warning
* @b EXPERIMENTAL: this API may change, or be removed, without prior
notice.
also, presumably this is not meant to be public API and exists solely
because there's no other way to do it without significant rework, so
maybe mark as @internal too?
> + * @param pkt
> + * Pointer to channel_packet or
> + * channel_packet_freq_list struct.
> + *
> + * @param pkt_len
> + * Size of expected data packet.
> + *
> + * @param lcore_id
> + * lcore_id.
> + *
> + * @return
> + * - 0 on success.
> + * - Negative on error.
> + */
> +__rte_experimental
> +int rte_power_guest_channel_receive_msg(void *pkt,
> + size_t pkt_len,
> + unsigned int lcore_id);
> +
>
> #ifdef __cplusplus
> }
>
--
Thanks,
Anatoly