[dpdk-stable] [dpdk-dev] [PATCH v3 2/6] power: make channel msg functions public

[David Hunt]

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 at 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 at dpdk.org
>>
>> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
>> Signed-off-by: David Hunt <david.hunt at 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
>>   }
>>
>
>