Commit c8d182bd authored by Xie Yongji's avatar Xie Yongji Committed by Michael S. Tsirkin
Browse files

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: default avatarXie Yongji <xieyongji@bytedance.com>
Link: https://lore.kernel.org/r/20210715080026.242-4-xieyongji@bytedance.com


Signed-off-by: default avatarMichael S. Tsirkin <mst@redhat.com>
Acked-by: default avatarJason Wang <jasowang@redhat.com>
Reviewed-by: default avatarStefano Garzarella <sgarzare@redhat.com>
parent 1057afa0

include/linux/vdpa.h

+11 −0
Original line number Diff line number Diff line
@@ -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, \