From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6BCAAA0A05; Wed, 20 Jan 2021 16:08:48 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 57471140DD9; Wed, 20 Jan 2021 16:08:48 +0100 (CET) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by mails.dpdk.org (Postfix) with ESMTP id BBA4C140DB2; Wed, 20 Jan 2021 16:08:45 +0100 (CET) IronPort-SDR: kyBNoIp/pNfuM4fpQliqCGLqkgac/9JNr5quL91kHrmxcxXQqoMjHOJBQDCkyRySsDTjeqyOER AMpbBIKryA+g== X-IronPort-AV: E=McAfee;i="6000,8403,9870"; a="263930157" X-IronPort-AV: E=Sophos;i="5.79,361,1602572400"; d="scan'208";a="263930157" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Jan 2021 07:08:44 -0800 IronPort-SDR: zNNeV0JW30ODikN7SfsLRd1naZWZdXqKGRB2EqvfK4X2oVCkTAUwJLpRgJmbscDG3lv0oqoJ3X 0RwFC1B0Hcog== X-IronPort-AV: E=Sophos;i="5.79,361,1602572400"; d="scan'208";a="356076156" Received: from dhunt5-mobl5.ger.corp.intel.com (HELO [10.213.196.25]) ([10.213.196.25]) by fmsmga008-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Jan 2021 07:08:42 -0800 To: "Burakov, Anatoly" , dev@dpdk.org Cc: stable@dpdk.org, Bruce Richardson References: <20210108143048.23755-2-david.hunt@intel.com> <20210120135556.33763-1-david.hunt@intel.com> <20210120135556.33763-3-david.hunt@intel.com> <3e7fc5b8-9e10-af74-6060-68143a8931be@intel.com> From: David Hunt Message-ID: <71a096fb-52d1-f08b-4e7d-c11e8f8c65c7@intel.com> Date: Wed, 20 Jan 2021 15:08:40 +0000 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.6.1 MIME-Version: 1.0 In-Reply-To: <3e7fc5b8-9e10-af74-6060-68143a8931be@intel.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit Content-Language: en-GB 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 20/1/2021 2:26 PM, Burakov, Anatoly wrote: > On 20-Jan-21 1:55 PM, David Hunt wrote: >> From: Bruce Richardson >> >> 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 >> Signed-off-by: David Hunt >> >> --- > > > >>   +/** >> + * 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 :) Maybe "Use channel specific to this lcore_id"? > >> + * >> + * @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? > Yes, I believe so. I will add @internal. >> + * @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. Same here. >> + * >> + * @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 >>   } >> > >