[syscalls][docs] Make interrupt 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 interrupt functions synopsis be generated, various locations match
ZX-968 #comment [syscalls][docs] Make interrupt functions synopsis be generated, various locations match
Test: CQ
Change-Id: Ia59ef381691704244ec1e317ef0963e4cc1bda74
diff --git a/docs/syscalls/interrupt_bind.md b/docs/syscalls/interrupt_bind.md
index 97054fb..49c787a 100644
--- a/docs/syscalls/interrupt_bind.md
+++ b/docs/syscalls/interrupt_bind.md
@@ -8,12 +8,15 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
-zx_status_t zx_interrupt_bind(zx_handle_t inth, zx_handle_t porth,
- uint64_t key, uint32_t options);
-
+zx_status_t zx_interrupt_bind(zx_handle_t handle,
+ zx_handle_t port_handle,
+ uint64_t key,
+ uint32_t options);
```
## DESCRIPTION
@@ -44,7 +47,7 @@
*handle* must be of type **ZX_OBJ_TYPE_INTERRUPT** and have **ZX_RIGHT_READ**.
-*port* must be of type **ZX_OBJ_TYPE_PORT** and have **ZX_RIGHT_WRITE**.
+*port_handle* must be of type **ZX_OBJ_TYPE_PORT** and have **ZX_RIGHT_WRITE**.
## RETURN VALUE
@@ -53,15 +56,15 @@
## ERRORS
-**ZX_ERR_BAD_HANDLE** *inth* or *porth* is not a valid handle.
+**ZX_ERR_BAD_HANDLE** *handle* or *port_handle* is not a valid handle.
-**ZX_ERR_WRONG_TYPE** *inth* is not an interrupt object or *porth* is not a port object.
+**ZX_ERR_WRONG_TYPE** *handle* is not an interrupt object or *port_handle* is not a port object.
-**ZX_ERR_CANCELED** **zx_interrupt_destroy**() was called on *inth*.
+**ZX_ERR_CANCELED** **zx_interrupt_destroy**() was called on *handle*.
**ZX_ERR_BAD_STATE** A thread is waiting on the interrupt using **zx_interrupt_wait**()
-**ZX_ERR_ACCESS_DENIED** the *inth* handle lacks **ZX_RIGHT_READ** or the *porth* handle
+**ZX_ERR_ACCESS_DENIED** the *handle* handle lacks **ZX_RIGHT_READ** or the *port_handle* handle
lacks **ZX_RIGHT_WRITE**
**ZX_ERR_ALREADY_BOUND** this interrupt object is already bound.
diff --git a/docs/syscalls/interrupt_create.md b/docs/syscalls/interrupt_create.md
index 83395cc..f6f9e40 100644
--- a/docs/syscalls/interrupt_create.md
+++ b/docs/syscalls/interrupt_create.md
@@ -8,12 +8,15 @@
## SYNOPSIS
+<!-- Updated by scripts/update-docs-from-abigen, do not edit this section manually. -->
+
```
#include <zircon/syscalls.h>
-zx_status_t zx_interrupt_create(zx_handle_t src_obj, uint32_t src_num,
- uint32_t options, zx_handle_t* out_handle);
-
+zx_status_t zx_interrupt_create(zx_handle_t src_obj,
+ uint32_t src_num,
+ uint32_t options,
+ zx_handle_t* out_handle);
```
## DESCRIPTION
diff --git a/kernel/syscalls/ddk.cpp b/kernel/syscalls/ddk.cpp
index 04ea18c..c258a07 100644
--- a/kernel/syscalls/ddk.cpp
+++ b/kernel/syscalls/ddk.cpp
@@ -461,9 +461,9 @@
}
// zx_status_t zx_interrupt_bind
-zx_status_t sys_interrupt_bind(zx_handle_t inth, zx_handle_t porth,
+zx_status_t sys_interrupt_bind(zx_handle_t handle, zx_handle_t port_handle,
uint64_t key, uint32_t options) {
- LTRACEF("handle %x\n", inth);
+ LTRACEF("handle %x\n", handle);
if (options) {
return ZX_ERR_INVALID_ARGS;
}
@@ -471,12 +471,12 @@
zx_status_t status;
auto up = ProcessDispatcher::GetCurrent();
fbl::RefPtr<InterruptDispatcher> interrupt;
- status = up->GetDispatcherWithRights(inth, ZX_RIGHT_READ, &interrupt);
+ status = up->GetDispatcherWithRights(handle, ZX_RIGHT_READ, &interrupt);
if (status != ZX_OK)
return status;
fbl::RefPtr<PortDispatcher> port;
- status = up->GetDispatcherWithRights(porth, ZX_RIGHT_WRITE, &port);
+ status = up->GetDispatcherWithRights(port_handle, ZX_RIGHT_WRITE, &port);
if (status != ZX_OK)
return status;
diff --git a/scripts/update-docs-from-abigen b/scripts/update-docs-from-abigen
index 23740a6..1fcba24 100755
--- a/scripts/update-docs-from-abigen
+++ b/scripts/update-docs-from-abigen
@@ -403,8 +403,6 @@
'futex_wait',
'futex_wake',
'futex_wake_handle_close_thread_exit',
- 'interrupt_bind',
- 'interrupt_create',
'object_get_info',
'object_get_property',
'object_signal',
diff --git a/system/public/zircon/syscalls.abigen b/system/public/zircon/syscalls.abigen
index b6e1e1f..8848746 100644
--- a/system/public/zircon/syscalls.abigen
+++ b/system/public/zircon/syscalls.abigen
@@ -831,13 +831,13 @@
#! src_obj must have resource kind ZX_RSRC_KIND_IRQ.
syscall interrupt_create
(src_obj: zx_handle_t, src_num: uint32_t, options: uint32_t)
- returns (zx_status_t, out: zx_handle_t);
+ returns (zx_status_t, out_handle: zx_handle_t);
#^ Bind an interrupt object to a port
#! handle must be of type ZX_OBJ_TYPE_INTERRUPT and have ZX_RIGHT_READ.
-#! port must be of type ZX_OBJ_TYPE_PORT and have ZX_RIGHT_WRITE.
+#! port_handle must be of type ZX_OBJ_TYPE_PORT and have ZX_RIGHT_WRITE.
syscall interrupt_bind
- (handle: zx_handle_t, port: zx_handle_t, key: uint64_t, options: uint32_t)
+ (handle: zx_handle_t, port_handle: zx_handle_t, key: uint64_t, options: uint32_t)
returns (zx_status_t);
#^ wait for an interrupt
