vdpa: Add documentation for vdpa_alloc_device() macro
The return value of vdpa_alloc_device() macro is not very clear, so that most of callers did the wrong check. Let's add some comments to better document it. Signed-off-by: Xie Yongji <xieyongji@bytedance.com> Link: https://lore.kernel.org/r/20210715080026.242-4-xieyongji@bytedance.com Signed-off-by: Michael S. Tsirkin <mst@redhat.com> Acked-by: Jason Wang <jasowang@redhat.com> Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
This commit is contained in:
parent
1057afa012
commit
c8d182bd38
@ -277,6 +277,17 @@ struct vdpa_device *__vdpa_alloc_device(struct device *parent,
|
||||
const struct vdpa_config_ops *config,
|
||||
size_t size, const char *name);
|
||||
|
||||
/**
|
||||
* vdpa_alloc_device - allocate and initilaize a vDPA device
|
||||
*
|
||||
* @dev_struct: the type of the parent structure
|
||||
* @member: the name of struct vdpa_device within the @dev_struct
|
||||
* @parent: the parent device
|
||||
* @config: the bus operations that is supported by this device
|
||||
* @name: name of the vdpa device
|
||||
*
|
||||
* Return allocated data structure or ERR_PTR upon error
|
||||
*/
|
||||
#define vdpa_alloc_device(dev_struct, member, parent, config, name) \
|
||||
container_of(__vdpa_alloc_device( \
|
||||
parent, config, \
|
||||
|
Loading…
Reference in New Issue
Block a user