Commit a5581206 authored by Jiang Biao's avatar Jiang Biao Committed by Michael S. Tsirkin

virtio/virtio_ring: do some comment fixes

There are lots of mismatches between comments and codes, this
patch do these comment fixes.
Signed-off-by: default avatarJiang Biao <benbjiang@tencent.com>
Signed-off-by: default avatarMichael S. Tsirkin <mst@redhat.com>
parent 889e31e7
...@@ -1719,10 +1719,10 @@ static inline int virtqueue_add(struct virtqueue *_vq, ...@@ -1719,10 +1719,10 @@ static inline int virtqueue_add(struct virtqueue *_vq,
/** /**
* virtqueue_add_sgs - expose buffers to other end * virtqueue_add_sgs - expose buffers to other end
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* @sgs: array of terminated scatterlists. * @sgs: array of terminated scatterlists.
* @out_num: the number of scatterlists readable by other side * @out_sgs: the number of scatterlists readable by other side
* @in_num: the number of scatterlists which are writable (after readable ones) * @in_sgs: the number of scatterlists which are writable (after readable ones)
* @data: the token identifying the buffer. * @data: the token identifying the buffer.
* @gfp: how to do memory allocations (if necessary). * @gfp: how to do memory allocations (if necessary).
* *
...@@ -1822,7 +1822,7 @@ EXPORT_SYMBOL_GPL(virtqueue_add_inbuf_ctx); ...@@ -1822,7 +1822,7 @@ EXPORT_SYMBOL_GPL(virtqueue_add_inbuf_ctx);
/** /**
* virtqueue_kick_prepare - first half of split virtqueue_kick call. * virtqueue_kick_prepare - first half of split virtqueue_kick call.
* @vq: the struct virtqueue * @_vq: the struct virtqueue
* *
* Instead of virtqueue_kick(), you can do: * Instead of virtqueue_kick(), you can do:
* if (virtqueue_kick_prepare(vq)) * if (virtqueue_kick_prepare(vq))
...@@ -1842,7 +1842,7 @@ EXPORT_SYMBOL_GPL(virtqueue_kick_prepare); ...@@ -1842,7 +1842,7 @@ EXPORT_SYMBOL_GPL(virtqueue_kick_prepare);
/** /**
* virtqueue_notify - second half of split virtqueue_kick call. * virtqueue_notify - second half of split virtqueue_kick call.
* @vq: the struct virtqueue * @_vq: the struct virtqueue
* *
* This does not need to be serialized. * This does not need to be serialized.
* *
...@@ -1886,8 +1886,9 @@ EXPORT_SYMBOL_GPL(virtqueue_kick); ...@@ -1886,8 +1886,9 @@ EXPORT_SYMBOL_GPL(virtqueue_kick);
/** /**
* virtqueue_get_buf - get the next used buffer * virtqueue_get_buf - get the next used buffer
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* @len: the length written into the buffer * @len: the length written into the buffer
* @ctx: extra context for the token
* *
* If the device wrote data into the buffer, @len will be set to the * If the device wrote data into the buffer, @len will be set to the
* amount written. This means you don't need to clear the buffer * amount written. This means you don't need to clear the buffer
...@@ -1917,7 +1918,7 @@ void *virtqueue_get_buf(struct virtqueue *_vq, unsigned int *len) ...@@ -1917,7 +1918,7 @@ void *virtqueue_get_buf(struct virtqueue *_vq, unsigned int *len)
EXPORT_SYMBOL_GPL(virtqueue_get_buf); EXPORT_SYMBOL_GPL(virtqueue_get_buf);
/** /**
* virtqueue_disable_cb - disable callbacks * virtqueue_disable_cb - disable callbacks
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* *
* Note that this is not necessarily synchronous, hence unreliable and only * Note that this is not necessarily synchronous, hence unreliable and only
* useful as an optimization. * useful as an optimization.
...@@ -1937,7 +1938,7 @@ EXPORT_SYMBOL_GPL(virtqueue_disable_cb); ...@@ -1937,7 +1938,7 @@ EXPORT_SYMBOL_GPL(virtqueue_disable_cb);
/** /**
* virtqueue_enable_cb_prepare - restart callbacks after disable_cb * virtqueue_enable_cb_prepare - restart callbacks after disable_cb
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* *
* This re-enables callbacks; it returns current queue state * This re-enables callbacks; it returns current queue state
* in an opaque unsigned value. This value should be later tested by * in an opaque unsigned value. This value should be later tested by
...@@ -1958,7 +1959,7 @@ EXPORT_SYMBOL_GPL(virtqueue_enable_cb_prepare); ...@@ -1958,7 +1959,7 @@ EXPORT_SYMBOL_GPL(virtqueue_enable_cb_prepare);
/** /**
* virtqueue_poll - query pending used buffers * virtqueue_poll - query pending used buffers
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* @last_used_idx: virtqueue state (from call to virtqueue_enable_cb_prepare). * @last_used_idx: virtqueue state (from call to virtqueue_enable_cb_prepare).
* *
* Returns "true" if there are pending used buffers in the queue. * Returns "true" if there are pending used buffers in the queue.
...@@ -1977,7 +1978,7 @@ EXPORT_SYMBOL_GPL(virtqueue_poll); ...@@ -1977,7 +1978,7 @@ EXPORT_SYMBOL_GPL(virtqueue_poll);
/** /**
* virtqueue_enable_cb - restart callbacks after disable_cb. * virtqueue_enable_cb - restart callbacks after disable_cb.
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* *
* This re-enables callbacks; it returns "false" if there are pending * This re-enables callbacks; it returns "false" if there are pending
* buffers in the queue, to detect a possible race between the driver * buffers in the queue, to detect a possible race between the driver
...@@ -1996,7 +1997,7 @@ EXPORT_SYMBOL_GPL(virtqueue_enable_cb); ...@@ -1996,7 +1997,7 @@ EXPORT_SYMBOL_GPL(virtqueue_enable_cb);
/** /**
* virtqueue_enable_cb_delayed - restart callbacks after disable_cb. * virtqueue_enable_cb_delayed - restart callbacks after disable_cb.
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* *
* This re-enables callbacks but hints to the other side to delay * This re-enables callbacks but hints to the other side to delay
* interrupts until most of the available buffers have been processed; * interrupts until most of the available buffers have been processed;
...@@ -2018,7 +2019,7 @@ EXPORT_SYMBOL_GPL(virtqueue_enable_cb_delayed); ...@@ -2018,7 +2019,7 @@ EXPORT_SYMBOL_GPL(virtqueue_enable_cb_delayed);
/** /**
* virtqueue_detach_unused_buf - detach first unused buffer * virtqueue_detach_unused_buf - detach first unused buffer
* @vq: the struct virtqueue we're talking about. * @_vq: the struct virtqueue we're talking about.
* *
* Returns NULL or the "data" token handed to virtqueue_add_*(). * Returns NULL or the "data" token handed to virtqueue_add_*().
* This is not valid on an active queue; it is useful only for device * This is not valid on an active queue; it is useful only for device
...@@ -2250,7 +2251,7 @@ EXPORT_SYMBOL_GPL(vring_transport_features); ...@@ -2250,7 +2251,7 @@ EXPORT_SYMBOL_GPL(vring_transport_features);
/** /**
* virtqueue_get_vring_size - return the size of the virtqueue's vring * virtqueue_get_vring_size - return the size of the virtqueue's vring
* @vq: the struct virtqueue containing the vring of interest. * @_vq: the struct virtqueue containing the vring of interest.
* *
* Returns the size of the vring. This is mainly used for boasting to * Returns the size of the vring. This is mainly used for boasting to
* userspace. Unlike other operations, this need not be serialized. * userspace. Unlike other operations, this need not be serialized.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment