[syscalls][docs] Make fifo functions synopsis be generated, various locations match
Make parameter names follow
https://fuchsia.googlesource.com/docs/+/master/development/api/system.md#parameters
and make docs, abigen, and implementation match.
ZX-559 #comment [syscalls][docs] Make fifo functions synopsis be generated, various locations match
ZX-968 #comment [syscalls][docs] Make fifo functions synopsis be generated, various locations match
Test: CQ
Change-Id: Icc449c05f815e564cc403f588a3a2c54e31281ff
diff --git a/docs/syscalls/fifo_read.md b/docs/syscalls/fifo_read.md
index 179b5dd..bdee793 100644
--- a/docs/syscalls/fifo_read.md
+++ b/docs/syscalls/fifo_read.md
@@ -8,17 +8,22 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
-zx_status_t zx_fifo_read(zx_handle_t handle, size_t elem_size,
- void* buffer, size_t count, size_t* actual_count);
+zx_status_t zx_fifo_read(zx_handle_t handle,
+ size_t elem_size,
+ void* data,
+ size_t count,
+ size_t* actual_count);
```
## DESCRIPTION
**fifo_read**() attempts to read up to *count* elements from the fifo
-*handle* into *buffer*.
+*handle* into *data*.
Fewer elements may be read than requested if there are insufficient
elements in the fifo to fulfill the entire request. The number of
@@ -27,7 +32,7 @@
The element size specified by *elem_size* must match the element size
that was passed into **fifo_create**().
-*buffer* must have a size of at least *count * elem_size* bytes.
+*data* must have a size of at least *count * elem_size* bytes.
*actual_count* is allowed to be NULL. This is useful when reading
a single element: if *count* is 1 and **fifo_read**() returns **ZX_OK**,
@@ -52,7 +57,7 @@
**ZX_ERR_WRONG_TYPE** *handle* is not a fifo handle.
-**ZX_ERR_INVALID_ARGS** *buffer* is an invalid pointer or *actual_count*
+**ZX_ERR_INVALID_ARGS** *data* is an invalid pointer or *actual_count*
is an invalid pointer.
**ZX_ERR_OUT_OF_RANGE** *count* is zero or *elem_size* is not equal
diff --git a/docs/syscalls/fifo_write.md b/docs/syscalls/fifo_write.md
index c86735b..4e82573 100644
--- a/docs/syscalls/fifo_write.md
+++ b/docs/syscalls/fifo_write.md
@@ -8,11 +8,16 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
-zx_status_t zx_fifo_write(zx_handle_t handle, size_t elem_size,
- const void* buffer, size_t count, size_t* actual_count);
+zx_status_t zx_fifo_write(zx_handle_t handle,
+ size_t elem_size,
+ const void* data,
+ size_t count,
+ size_t* actual_count);
```
## DESCRIPTION
@@ -50,7 +55,7 @@
**ZX_ERR_WRONG_TYPE** *handle* is not a fifo handle.
-**ZX_ERR_INVALID_ARGS** *buffer* is an invalid pointer or *actual_count*
+**ZX_ERR_INVALID_ARGS** *data* is an invalid pointer or *actual_count*
is an invalid pointer.
**ZX_ERR_OUT_OF_RANGE** *count* is zero or *elem_size* is not equal
diff --git a/kernel/syscalls/fifo.cpp b/kernel/syscalls/fifo.cpp
index ba84403..29b143d 100644
--- a/kernel/syscalls/fifo.cpp
+++ b/kernel/syscalls/fifo.cpp
@@ -45,8 +45,8 @@
}
// zx_status_t zx_fifo_write
-zx_status_t sys_fifo_write(zx_handle_t handle, size_t elem_size, user_in_ptr<const void> entries,
- size_t count, user_out_ptr<size_t> actual_out) {
+zx_status_t sys_fifo_write(zx_handle_t handle, size_t elem_size, user_in_ptr<const void> data,
+ size_t count, user_out_ptr<size_t> actual_count) {
auto up = ProcessDispatcher::GetCurrent();
fbl::RefPtr<FifoDispatcher> fifo;
@@ -55,12 +55,12 @@
return status;
size_t actual;
- status = fifo->WriteFromUser(elem_size, entries.reinterpret<const uint8_t>(), count, &actual);
+ status = fifo->WriteFromUser(elem_size, data.reinterpret<const uint8_t>(), count, &actual);
if (status != ZX_OK)
return status;
- if (actual_out) {
- status = actual_out.copy_to_user(actual);
+ if (actual_count) {
+ status = actual_count.copy_to_user(actual);
if (status != ZX_OK)
return status;
}
@@ -68,8 +68,8 @@
}
// zx_status_t zx_fifo_read
-zx_status_t sys_fifo_read(zx_handle_t handle, size_t elem_size, user_out_ptr<void> entries,
- size_t count, user_out_ptr<size_t> actual_out) {
+zx_status_t sys_fifo_read(zx_handle_t handle, size_t elem_size, user_out_ptr<void> data,
+ size_t count, user_out_ptr<size_t> actual_count) {
auto up = ProcessDispatcher::GetCurrent();
fbl::RefPtr<FifoDispatcher> fifo;
@@ -78,12 +78,12 @@
return status;
size_t actual;
- status = fifo->ReadToUser(elem_size, entries.reinterpret<uint8_t>(), count, &actual);
+ status = fifo->ReadToUser(elem_size, data.reinterpret<uint8_t>(), count, &actual);
if (status != ZX_OK)
return status;
- if (actual_out) {
- status = actual_out.copy_to_user(actual);
+ if (actual_count) {
+ status = actual_count.copy_to_user(actual);
if (status != ZX_OK)
return status;
}
diff --git a/scripts/update-docs-from-abigen b/scripts/update-docs-from-abigen
index f72f9e5..2e8ee94 100755
--- a/scripts/update-docs-from-abigen
+++ b/scripts/update-docs-from-abigen
@@ -398,6 +398,8 @@
'event_create',
'eventpair_create',
'fifo_create',
+ 'fifo_read',
+ 'fifo_write',
'guest_create',
'handle_close',
'handle_close_many',
