patches for DPDK stable branches
 help / color / mirror / Atom feed
From: David Hunt <david.hunt@intel.com>
To: "Burakov, Anatoly" <anatoly.burakov@intel.com>, dev@dpdk.org
Cc: stable@dpdk.org, Bruce Richardson <bruce.richardson@intel.com>
Subject: Re: [dpdk-stable] [dpdk-dev] [PATCH v3 2/6] power: make channel msg functions public
Date: Wed, 20 Jan 2021 15:08:40 +0000	[thread overview]
Message-ID: <71a096fb-52d1-f08b-4e7d-c11e8f8c65c7@intel.com> (raw)
In-Reply-To: <3e7fc5b8-9e10-af74-6060-68143a8931be@intel.com>


On 20/1/2021 2:26 PM, Burakov, Anatoly wrote:
> 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 :)


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
>>   }
>>
>
>

  reply	other threads:[~2021-01-20 15:08 UTC|newest]

Thread overview: 71+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-17 11:36 [dpdk-stable] [PATCH v1] power: fix make build for power apps David Hunt
2021-01-08 14:30 ` [dpdk-stable] [PATCH 0/6] " David Hunt
2021-01-08 14:30   ` [dpdk-stable] [PATCH v2 1/6] power: create guest channel public header file David Hunt
2021-01-20 13:55     ` [dpdk-stable] [PATCH v3 0/6] power: fix make build for power apps David Hunt
2021-01-20 13:55       ` [dpdk-stable] [PATCH v3 1/6] power: create guest channel public header file David Hunt
2021-01-20 15:09         ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-20 15:12           ` David Hunt
2021-01-21 17:21         ` [dpdk-stable] [PATCH v4 0/6] power: fix make build for power apps David Hunt
2021-01-21 17:21           ` [dpdk-stable] [PATCH v4 1/6] power: create guest channel public header file David Hunt
2021-01-29 10:21             ` [dpdk-stable] [PATCH v5 0/6] power: fix make build for power apps David Hunt
2021-01-29 10:21               ` [dpdk-stable] [PATCH v5 1/6] power: create guest channel public header file David Hunt
2021-01-29 10:21               ` [dpdk-stable] [PATCH v5 2/6] power: make channel msg functions public David Hunt
2021-01-29 10:21               ` [dpdk-stable] [PATCH v5 3/6] power: rename public structs David Hunt
2021-01-29 10:21               ` [dpdk-stable] [PATCH v5 4/6] power: rename defines David Hunt
2021-01-29 10:21               ` [dpdk-stable] [PATCH v5 5/6] power: add new header file to export list David Hunt
2021-01-29 10:21               ` [dpdk-stable] [PATCH v5 6/6] power: clean up includes David Hunt
2021-01-29 10:30               ` [dpdk-stable] [dpdk-dev] [PATCH v5 0/6] power: fix make build for power apps Thomas Monjalon
2021-01-21 17:21           ` [dpdk-stable] [PATCH v4 2/6] power: make channel msg functions public David Hunt
2021-01-22 12:12             ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-02-22  9:53             ` [dpdk-stable] " Ferruh Yigit
2021-01-21 17:21           ` [dpdk-stable] [PATCH v4 3/6] power: rename public structs David Hunt
2021-01-22 12:15             ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-22 12:18               ` Burakov, Anatoly
2021-01-22 12:18             ` Burakov, Anatoly
2021-01-28 22:57             ` [dpdk-stable] " Thomas Monjalon
2021-02-22  9:56             ` Ferruh Yigit
2021-01-21 17:21           ` [dpdk-stable] [PATCH v4 4/6] power: rename defines David Hunt
2021-01-22 13:50             ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-21 17:22           ` [dpdk-stable] [PATCH v4 5/6] power: add new header file to export list David Hunt
2021-01-22 13:51             ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-21 17:22           ` [dpdk-stable] [PATCH v4 6/6] power: clean up includes David Hunt
2021-01-22 13:53             ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-29 10:27           ` [dpdk-stable] [PATCH v4 0/6] power: fix make build for power apps Thomas Monjalon
2021-02-24 13:16           ` [dpdk-stable] [PATCH] power: remove duplicated symbols from map file Ferruh Yigit
2021-02-24 15:24             ` Aaron Conole
2021-02-24 14:54           ` Ferruh Yigit
2021-02-25  9:11             ` [dpdk-stable] [dpdk-dev] " David Marchand
2021-02-25 10:41               ` Ferruh Yigit
2021-02-25 10:44                 ` David Marchand
2021-02-25 10:54             ` [dpdk-stable] [PATCH v2] " Ferruh Yigit
2021-02-25 14:38               ` David Marchand
2021-03-02 12:42                 ` David Marchand
2021-01-20 13:55       ` [dpdk-stable] [PATCH v3 2/6] power: make channel msg functions public David Hunt
2021-01-20 14:26         ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-20 15:08           ` David Hunt [this message]
2021-01-20 15:23             ` Burakov, Anatoly
2021-01-20 13:55       ` [dpdk-stable] [PATCH v3 3/6] power: rename public structs David Hunt
2021-01-20 14:27         ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-20 15:03           ` David Hunt
2021-01-20 13:55       ` [dpdk-stable] [PATCH v3 4/6] power: rename defines David Hunt
2021-01-20 13:55       ` [dpdk-stable] [PATCH v3 5/6] power: add new header file to export list David Hunt
2021-01-20 14:28         ` [dpdk-stable] [dpdk-dev] " Burakov, Anatoly
2021-01-20 15:01           ` David Hunt
2021-01-20 15:17             ` Burakov, Anatoly
2021-01-20 15:08           ` Bruce Richardson
2021-01-20 15:18             ` Burakov, Anatoly
2021-01-20 15:29               ` David Hunt
2021-01-20 15:43                 ` Burakov, Anatoly
2021-01-20 13:55       ` [dpdk-stable] [PATCH v3 6/6] power: clean up includes David Hunt
2021-01-08 14:30   ` [dpdk-stable] [PATCH v2 2/6] power: make channel msg functions public David Hunt
2021-01-19 14:31     ` Thomas Monjalon
2021-01-19 14:51       ` David Hunt
2021-01-08 14:30   ` [dpdk-stable] [PATCH v2 3/6] power: rename public structs David Hunt
2021-01-08 14:30   ` [dpdk-stable] [PATCH v2 4/6] power: rename defines David Hunt
2021-01-08 14:30   ` [dpdk-stable] [PATCH v2 5/6] power: add new header file to export list David Hunt
2021-01-08 14:30   ` [dpdk-stable] [PATCH v2 6/6] power: clean up includes David Hunt
2021-01-13 11:08   ` [dpdk-stable] [dpdk-dev] [PATCH 0/6] power: fix make build for power apps Burakov, Anatoly
2021-01-13 11:14     ` David Hunt
2021-01-13 11:18       ` Burakov, Anatoly
2021-01-13 13:25         ` David Hunt
2021-01-13 17:30           ` Burakov, Anatoly

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=71a096fb-52d1-f08b-4e7d-c11e8f8c65c7@intel.com \
    --to=david.hunt@intel.com \
    --cc=anatoly.burakov@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).