[syscalls][docs] Make a few more misc 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 a few more misc functions synopsis be generated, various locations match
ZX-968 #comment [syscalls][docs] Make a few more misc functions synopsis be generated, various locations match
Test: CQ
Change-Id: I13069fc9f1a4bf04e5ad2acc6d6525ef48e74e6f
diff --git a/docs/syscalls/iommu_create.md b/docs/syscalls/iommu_create.md
index dd080ed..96b0cc1 100644
--- a/docs/syscalls/iommu_create.md
+++ b/docs/syscalls/iommu_create.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_iommu_create(zx_handle_t root_resource, uint32_t type,
- const void* desc, size_t desc_size, zx_handle_t* out);
+zx_status_t zx_iommu_create(zx_handle_t resource,
+ uint32_t type,
+ const void* desc,
+ size_t desc_size,
+ zx_handle_t* out);
```
## DESCRIPTION
@@ -33,7 +38,7 @@
done with it.
*desc* must be a valid pointer to a value of type *zx_iommu_desc_dummy_t*.
-*desc_len* must be *sizeof(zx_iommu_desc_dummy_t)*.
+*desc_size* must be *sizeof(zx_iommu_desc_dummy_t)*.
## RIGHTS
@@ -49,11 +54,11 @@
## ERRORS
-**ZX_ERR_BAD_HANDLE** *root_resource* is not a valid handle.
+**ZX_ERR_BAD_HANDLE** *resource* is not a valid handle.
-**ZX_ERR_WRONG_TYPE** *root_resource* is not a resource handle.
+**ZX_ERR_WRONG_TYPE** *resource* is not a resource handle.
-**ZX_ERR_ACCESS_DENIED** *root_resource* handle does not have sufficient privileges.
+**ZX_ERR_ACCESS_DENIED** *resource* handle does not have sufficient privileges.
**ZX_ERR_NOT_SUPPORTED** *type* is not a defined value or is not
supported on this system.
diff --git a/docs/syscalls/resource_create.md b/docs/syscalls/resource_create.md
index eb319cb..a81603e 100644
--- a/docs/syscalls/resource_create.md
+++ b/docs/syscalls/resource_create.md
@@ -8,18 +8,18 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
zx_status_t zx_resource_create(zx_handle_t parent_rsrc,
uint32_t options,
uint64_t base,
- size_t len,
+ size_t size,
const char* name,
size_t name_size,
- zx_handle_t* out_handle)
-
-
+ zx_handle_t* resource_out);
```
## DESCRIPTION
@@ -28,7 +28,7 @@
syscalls. Resources are typically handed out to bus drivers and rarely need to
be interacted with directly by drivers using driver protocols. Resource objects
grant access to an address space range starting at *base* up to but not
-including *base* + *len*. Two special values for *kind* exist:
+including *base* + *size*. Two special values for *kind* exist:
**ZX_RSRC_KIND_ROOT** and **ZX_RSRC_KIND_HYPERVISOR**. These resources have no
range associated with them and are used as a privilege check.
@@ -40,7 +40,7 @@
**ZX_RSRC_KIND_HYPERVISOR**, **ZX_RSRC_KIND_VMEX**, and **ZX_RSRC_KIND_SMC**
(ARM only).
**ZX_RSRC_KIND_ROOT**, **ZX_RSRC_KIND_HYPERVISOR**, and **ZX_RSRC_KIND_VMEX**
-must be paired with zero values for *base* and *len*, as they do not use
+must be paired with zero values for *base* and *size*, as they do not use
an address space range.
At this time the only optional flag is **ZX_RSRC_FLAG_EXCLUSIVE**. If
**ZX_RSRC_FLAG_EXCLUSIVE** is provided then the syscall will attempt to
@@ -51,7 +51,7 @@
This name is provided for debugging / tool use only and is not used by the
kernel.
-On success, a valid resource handle is returned in *out_handle*.
+On success, a valid resource handle is returned in *resource_out*.
## RETURN VALUE
@@ -81,7 +81,7 @@
**ZX_ERR_INVALID_ARGS** *options* contains an invalid kind or flag combination,
*name* is an invalid pointer, or the kind specified is one of
-**ZX_RSRC_KIND_ROOT** or **ZX_RSRC_KIND_HYPERVISOR** but *base* and *len* are
+**ZX_RSRC_KIND_ROOT** or **ZX_RSRC_KIND_HYPERVISOR** but *base* and *size* are
not 0.
**ZX_ERR_NO_MEMORY** Failure due to lack of memory. There is no good way for
diff --git a/docs/syscalls/timer_create.md b/docs/syscalls/timer_create.md
index 22181d4..edaf211 100644
--- a/docs/syscalls/timer_create.md
+++ b/docs/syscalls/timer_create.md
@@ -8,11 +8,14 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
-zx_status_t zx_timer_create(uint32_t options, uint32_t clock_id, zx_handle_t* out);
-
+zx_status_t zx_timer_create(uint32_t options,
+ zx_clock_t clock_id,
+ zx_handle_t* out);
```
## DESCRIPTION
diff --git a/docs/syscalls/vmo_replace_as_executable.md b/docs/syscalls/vmo_replace_as_executable.md
index 4705e62..74582ab 100644
--- a/docs/syscalls/vmo_replace_as_executable.md
+++ b/docs/syscalls/vmo_replace_as_executable.md
@@ -8,19 +8,22 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
-zx_status_t zx_vmo_replace_as_executable(zx_handle_t vmo, zx_handle_t vmex, zx_handle_t* out);
-
+zx_status_t zx_vmo_replace_as_executable(zx_handle_t handle,
+ zx_handle_t vmex,
+ zx_handle_t* out);
```
## DESCRIPTION
-**vmo_replace_as_executable**() creates a replacement for *vmo*, referring
+**vmo_replace_as_executable**() creates a replacement for *handle*, referring
to the same underlying VM object, adding the right **ZX_RIGHT_EXECUTE**.
-*vmo* is always invalidated.
+*handle* is always invalidated.
*vmex* may currently be **ZX_HANDLE_INVALID** to ease migration of new code,
this is TODO(SEC-42) and will be removed.
@@ -40,7 +43,7 @@
## ERRORS
-**ZX_ERR_BAD_HANDLE** *vmo* isn't a valid VM object handle, or
+**ZX_ERR_BAD_HANDLE** *handle* isn't a valid VM object handle, or
*vmex* isn't a valid **ZX_RSRC_KIND_VMEX** resource handle.
**ZX_ERR_NO_MEMORY** Failure due to lack of memory.
diff --git a/kernel/syscalls/ddk.cpp b/kernel/syscalls/ddk.cpp
index e62b168..04ea18c 100644
--- a/kernel/syscalls/ddk.cpp
+++ b/kernel/syscalls/ddk.cpp
@@ -188,16 +188,16 @@
}
// zx_status_t zx_iommu_create
-zx_status_t sys_iommu_create(zx_handle_t rsrc_handle, uint32_t type,
- user_in_ptr<const void> desc, size_t desc_len,
+zx_status_t sys_iommu_create(zx_handle_t resource, uint32_t type,
+ user_in_ptr<const void> desc, size_t desc_size,
user_out_handle* out) {
// TODO: finer grained validation
zx_status_t status;
- if ((status = validate_resource(rsrc_handle, ZX_RSRC_KIND_ROOT)) < 0) {
+ if ((status = validate_resource(resource, ZX_RSRC_KIND_ROOT)) < 0) {
return status;
}
- if (desc_len > ZX_IOMMU_MAX_DESC_LEN) {
+ if (desc_size > ZX_IOMMU_MAX_DESC_LEN) {
return ZX_ERR_INVALID_ARGS;
}
@@ -208,16 +208,16 @@
// Copy the descriptor into the kernel and try to create the dispatcher
// using it.
fbl::AllocChecker ac;
- ktl::unique_ptr<uint8_t[]> copied_desc(new (&ac) uint8_t[desc_len]);
+ ktl::unique_ptr<uint8_t[]> copied_desc(new (&ac) uint8_t[desc_size]);
if (!ac.check()) {
return ZX_ERR_NO_MEMORY;
}
- if ((status = desc.copy_array_from_user(copied_desc.get(), desc_len)) != ZX_OK) {
+ if ((status = desc.copy_array_from_user(copied_desc.get(), desc_size)) != ZX_OK) {
return status;
}
status = IommuDispatcher::Create(type,
ktl::unique_ptr<const uint8_t[]>(copied_desc.release()),
- desc_len, &dispatcher, &rights);
+ desc_size, &dispatcher, &rights);
if (status != ZX_OK) {
return status;
}
diff --git a/kernel/syscalls/resource.cpp b/kernel/syscalls/resource.cpp
index 41777a8..7961791 100644
--- a/kernel/syscalls/resource.cpp
+++ b/kernel/syscalls/resource.cpp
@@ -32,7 +32,7 @@
uint32_t options,
uint64_t base,
size_t size,
- user_in_ptr<const char> _name,
+ user_in_ptr<const char> user_name,
size_t name_size,
user_out_handle* resource_out) {
auto up = ProcessDispatcher::GetCurrent();
@@ -61,7 +61,7 @@
char name[ZX_MAX_NAME_LEN];
size_t namesize = MIN(name_size, ZX_MAX_NAME_LEN - 1);
if (name_size > 0) {
- if (_name.copy_array_from_user(name, namesize) != ZX_OK) {
+ if (user_name.copy_array_from_user(name, namesize) != ZX_OK) {
return ZX_ERR_INVALID_ARGS;
}
}
diff --git a/kernel/syscalls/vmo.cpp b/kernel/syscalls/vmo.cpp
index 29117b8..f735ae3 100644
--- a/kernel/syscalls/vmo.cpp
+++ b/kernel/syscalls/vmo.cpp
@@ -279,8 +279,8 @@
// zx_status_t zx_vmo_replace_as_executable
zx_status_t sys_vmo_replace_as_executable(
- zx_handle_t vmo, zx_handle_t vmex, user_out_handle* out) {
- LTRACEF("repexec %x %x\n", vmo, vmex);
+ zx_handle_t handle, zx_handle_t vmex, user_out_handle* out) {
+ LTRACEF("repexec %x %x\n", handle, vmex);
zx_status_t vmex_status = ZX_OK;
if (vmex != ZX_HANDLE_INVALID) {
@@ -293,12 +293,12 @@
auto up = ProcessDispatcher::GetCurrent();
Guard<fbl::Mutex> guard{up->handle_table_lock()};
- auto source = up->GetHandleLocked(vmo);
+ auto source = up->GetHandleLocked(handle);
if (!source)
return ZX_ERR_BAD_HANDLE;
- auto handle_cleanup = fbl::MakeAutoCall([up, vmo]() TA_NO_THREAD_SAFETY_ANALYSIS {
- up->RemoveHandleLocked(vmo);
+ auto handle_cleanup = fbl::MakeAutoCall([up, handle]() TA_NO_THREAD_SAFETY_ANALYSIS {
+ up->RemoveHandleLocked(handle);
});
if (vmex_status != ZX_OK)
diff --git a/scripts/update-docs-from-abigen b/scripts/update-docs-from-abigen
index 04a1c47..23740a6 100755
--- a/scripts/update-docs-from-abigen
+++ b/scripts/update-docs-from-abigen
@@ -405,14 +405,10 @@
'futex_wake_handle_close_thread_exit',
'interrupt_bind',
'interrupt_create',
- 'iommu_create',
'object_get_info',
'object_get_property',
'object_signal',
'object_wait_many',
- 'resource_create',
- 'timer_create',
- 'vmo_replace_as_executable',
)
