aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-10-30 23:00:07 +0900
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-10-30 23:00:07 +0900
commit2ab54dcbf03763af3581264028f4047e9205169a (patch)
tree3e240ce2c8a719e0fb4ed28a23047fb5a63adceb
parent9874ed60fac7281a6843259d50072266a8e57135 (diff)
downloadlibhinoko-2ab54dcbf03763af3581264028f4047e9205169a.tar.gz
doc: use the word '1394 OHCI hardware' for consistency
There are several expressions for 1394 OHCI hardware. For consistency, this commit replaces themwith '1394 OHCI hardware'. Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r--README.rst2
-rw-r--r--doc/hinoko.toml.in4
-rw-r--r--doc/overview.md2
-rw-r--r--src/fw_iso_ctx.c8
-rw-r--r--src/fw_iso_ctx.h4
-rw-r--r--src/fw_iso_ctx_private.c12
-rw-r--r--src/fw_iso_ir_multiple.c9
-rw-r--r--src/fw_iso_ir_single.c8
-rw-r--r--src/fw_iso_it.c8
-rw-r--r--src/meson.build2
10 files changed, 29 insertions, 30 deletions
diff --git a/README.rst b/README.rst
index 4d48dc2..15bc0ab 100644
--- a/README.rst
+++ b/README.rst
@@ -12,7 +12,7 @@ This is a sister project of `libhinawa <https://git.kernel.org/pub/scm/libs/ieee
I design this library for userspace applications to transfer/receive isochronous packets on
IEEE 1394 bus by any language binding of GObject Introspection. The applications is able to
-operate OHCI 1394 controllers for any isochronous context and isochronous resources. According
+operate 1394 OHCI hardware for any isochronous context and isochronous resources. According
to this design, this library is an application of Linux FireWire subsystem and GLib/GObject.
The latest release is `0.9.0 <https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tag/?h=v0.9.0>`_
diff --git a/doc/hinoko.toml.in b/doc/hinoko.toml.in
index ac71298..350f50d 100644
--- a/doc/hinoko.toml.in
+++ b/doc/hinoko.toml.in
@@ -1,6 +1,6 @@
[library]
version = "@VERSION@"
-description = "The library to operate OHCI 1394 hardware for isochronous communication in IEEE 1394 bus"
+description = "The library to operate 1394 OHCI hardware for isochronous communication in IEEE 1394 bus"
authors = "Takashi Sakamoto"
license = "LGPL-2.1-or-later"
website_url = "https://alsa-project.github.io/gobject-introspection-docs/hinoko/"
@@ -28,7 +28,7 @@ docs_url = "https://docs.gtk.org/gobject/"
[dependencies."Hinawa-3.0"]
name = "Hinawa"
-description = "Operate OHCI 1394 hardware for asynchronous communication with GObject Introspection support"
+description = "Operate 1394 OHCI hardware for asynchronous communication with GObject Introspection support"
docs_url = "https://alsa-project.github.io/gobject-introspection-docs/hinawa/"
[source-location]
diff --git a/doc/overview.md b/doc/overview.md
index f2e1d9d..ac0c39a 100644
--- a/doc/overview.md
+++ b/doc/overview.md
@@ -3,7 +3,7 @@ Title: Overview
The library produces some objects derived from [class@GObject.Object] as an abstraction to operate
system resources in Linux FireWire subsystem.
-The library operates 1394 OHCI controller for isochronous communication on IEEE 1394 bus. All
+The library operates 1394 OHCI hardware for isochronous communication on IEEE 1394 bus. All
operations are associated with [struct@GLib.Source] retrieved from each object, therefore
applications should be programmed with [struct@GLib.MainContext].
diff --git a/src/fw_iso_ctx.c b/src/fw_iso_ctx.c
index ace0d3a..c53a213 100644
--- a/src/fw_iso_ctx.c
+++ b/src/fw_iso_ctx.c
@@ -5,10 +5,10 @@
/**
* HinokoFwIsoCtx
- * An basic interface to operate isochronous context on 1394 OHCI controller.
+ * An basic interface to operate isochronous context on 1394 OHCI hardware.
*
* A [iface@FwIsoCtx] is an basic interface to use UAPI of Linux FireWire subsystem to operate
- * 1394 OHCI controller.
+ * 1394 OHCI hardware.
*/
G_DEFINE_INTERFACE(HinokoFwIsoCtx, hinoko_fw_iso_ctx, G_TYPE_OBJECT)
@@ -174,7 +174,7 @@ void hinoko_fw_iso_ctx_stop(HinokoFwIsoCtx *self)
* hinoko_fw_iso_ctx_unmap_buffer:
* @self: A [iface@FwIsoCtx].
*
- * Unmap intermediate buffer shared with 1394 OHCI controller for the context.
+ * Unmap intermediate buffer shared with 1394 OHCI hardware for the context.
*
* Since: 0.7
*/
@@ -190,7 +190,7 @@ void hinoko_fw_iso_ctx_unmap_buffer(HinokoFwIsoCtx *self)
* hinoko_fw_iso_ctx_release:
* @self: A [iface@FwIsoCtx].
*
- * Release the contest from 1394 OHCI controller.
+ * Release the contest from 1394 OHCI hardware.
*
* Since: 0.7
*/
diff --git a/src/fw_iso_ctx.h b/src/fw_iso_ctx.h
index c663e62..cb25dd9 100644
--- a/src/fw_iso_ctx.h
+++ b/src/fw_iso_ctx.h
@@ -31,7 +31,7 @@ struct _HinokoFwIsoCtxInterface {
*HinokoFwIsoCtxInterface::unmap_buffer:
* @self: A [iface@FwIsoCtx].
*
- * Virtual function to unmap intermediate buffer shared with 1394 OHCI controller for the
+ * Virtual function to unmap intermediate buffer shared with 1394 OHCI hardware for the
* context.
*
* Since: 0.7
@@ -42,7 +42,7 @@ struct _HinokoFwIsoCtxInterface {
* HinokoFwIsoCtxInterface::release:
* @self: A [iface@FwIsoCtx].
*
- * Virtual function to release the contest from 1394 OHCI controller.
+ * Virtual function to release the contest from 1394 OHCI hardware.
*
* Since: 0.7
*/
diff --git a/src/fw_iso_ctx_private.c b/src/fw_iso_ctx_private.c
index ded55e7..e3bf7f4 100644
--- a/src/fw_iso_ctx_private.c
+++ b/src/fw_iso_ctx_private.c
@@ -66,8 +66,8 @@ void fw_iso_ctx_state_init(struct fw_iso_ctx_state *state)
* @header_size: The number of bytes for header of isochronous context.
* @error: A [struct@GLib.Error].
*
- * Allocate a isochronous context to 1394 OHCI controller. A local node of the
- * node corresponding to the given path is used as the controller, thus any
+ * Allocate a isochronous context to 1394 OHCI hardware. A local node of the
+ * node corresponding to the given path is used as the hardware, thus any
* path is accepted as long as process has enough permission for the path.
*/
gboolean fw_iso_ctx_state_allocate(struct fw_iso_ctx_state *state, const char *path,
@@ -153,7 +153,7 @@ gboolean fw_iso_ctx_state_allocate(struct fw_iso_ctx_state *state, const char *p
* fw_iso_ctx_state_release:
* @state: A [struct@FwIsoCtxState].
*
- * Release allocated isochronous context from 1394 OHCI controller.
+ * Release allocated isochronous context from 1394 OHCI hardware.
*/
void fw_iso_ctx_state_release(struct fw_iso_ctx_state *state)
{
@@ -170,7 +170,7 @@ void fw_iso_ctx_state_release(struct fw_iso_ctx_state *state)
* @chunks_per_buffer: The number of chunks in buffer going to be allocated.
* @error: A [struct@GLib.Error].
*
- * Map intermediate buffer to share payload of isochronous context with 1394 OHCI controller.
+ * Map intermediate buffer to share payload of isochronous context with 1394 OHCI hardware.
*/
gboolean fw_iso_ctx_state_map_buffer(struct fw_iso_ctx_state *state, guint bytes_per_chunk,
guint chunks_per_buffer, GError **error)
@@ -223,7 +223,7 @@ gboolean fw_iso_ctx_state_map_buffer(struct fw_iso_ctx_state *state, guint bytes
* hinoko_fw_iso_ctx_unmap_buffer:
* @state: A [struct@FwIsoCtxState].
*
- * Unmap intermediate buffer shard with 1394 OHCI controller for payload of isochronous context.
+ * Unmap intermediate buffer shard with 1394 OHCI hardware for payload of isochronous context.
*/
void fw_iso_ctx_state_unmap_buffer(struct fw_iso_ctx_state *state)
{
@@ -353,7 +353,7 @@ static guint fw_cdev_iso_packet_control_to_payload_length(guint control)
* @state: A [struct@FwIsoCtxState].
* @error: A [struct@GLib.Error].
*
- * Queue registered chunks to 1394 OHCI controller.
+ * Queue registered chunks to 1394 OHCI hardware.
*/
gboolean fw_iso_ctx_state_queue_chunks(struct fw_iso_ctx_state *state, GError **error)
{
diff --git a/src/fw_iso_ir_multiple.c b/src/fw_iso_ir_multiple.c
index 881bab1..f4bf0a4 100644
--- a/src/fw_iso_ir_multiple.c
+++ b/src/fw_iso_ir_multiple.c
@@ -96,7 +96,7 @@ static void hinoko_fw_iso_ir_multiple_class_init(HinokoFwIsoIrMultipleClass *kla
* Emitted when Linux FireWire subsystem generates interrupt event. There are two cases
* for Linux FireWire subsystem to generate the event:
*
- * - When OHCI 1394 controller generates hardware interrupt as a result to process the
+ * - When 1394 OHCI hardware generates hardware interrupt as a result to process the
* isochronous packet for the buffer chunk marked to generate hardware interrupt.
* - When application calls [method@FwIsoCtx.flush_completions] explicitly.
*
@@ -349,8 +349,8 @@ HinokoFwIsoIrMultiple *hinoko_fw_iso_ir_multiple_new(void)
* @channels_length: The length of channels.
* @error: A [struct@GLib.Error].
*
- * Allocate an IR context to 1394 OHCI controller for buffer-fill mode. A local node of the node
- * corresponding to the given path is used as the controller, thus any path is accepted as long as
+ * Allocate an IR context to 1394 OHCI hardware for buffer-fill mode. A local node of the node
+ * corresponding to the given path is used as the hardware, thus any path is accepted as long as
* process has enough permission for the path.
*/
gboolean hinoko_fw_iso_ir_multiple_allocate(HinokoFwIsoIrMultiple *self, const char *path,
@@ -407,8 +407,7 @@ gboolean hinoko_fw_iso_ir_multiple_allocate(HinokoFwIsoIrMultiple *self, const c
* @chunks_per_buffer: The number of chunks in buffer.
* @error: A [struct@GLib.Error].
*
- * Map an intermediate buffer to share payload of IR context with 1394 OHCI
- * controller.
+ * Map an intermediate buffer to share payload of IR context with 1394 OHCI hardware.
*/
gboolean hinoko_fw_iso_ir_multiple_map_buffer(HinokoFwIsoIrMultiple *self, guint bytes_per_chunk,
guint chunks_per_buffer, GError **error)
diff --git a/src/fw_iso_ir_single.c b/src/fw_iso_ir_single.c
index 8cb46ee..a516684 100644
--- a/src/fw_iso_ir_single.c
+++ b/src/fw_iso_ir_single.c
@@ -70,7 +70,7 @@ static void hinoko_fw_iso_ir_single_class_init(HinokoFwIsoIrSingleClass *klass)
* Emitted when Linux FireWire subsystem generates interrupt event. There are three cases
* for Linux FireWire subsystem to generate the event:
*
- * - When OHCI 1394 controller generates hardware interrupt as a result to process the
+ * - When 1394 OHCI hardware generates hardware interrupt as a result to process the
* isochronous packet for the buffer chunk marked to generate hardware interrupt.
* - When the size of accumulated context header for packets since the last event reaches
* the size of memory page (usually 4,096 bytes).
@@ -245,8 +245,8 @@ HinokoFwIsoIrSingle *hinoko_fw_iso_ir_single_new(void)
* isochronous packet header in header parameter of [signal@FwIsoIrSingle::interrupted].
* @error: A [struct@GLib.Error].
*
- * Allocate an IR context to 1394 OHCI controller for packet-per-buffer mode. A local node of the
- * node corresponding to the given path is used as the controller, thus any path is accepted as
+ * Allocate an IR context to 1394 OHCI hardware for packet-per-buffer mode. A local node of the
+ * node corresponding to the given path is used as the hardware, thus any path is accepted as
* long as process has enough permission for the path.
*
* The header_size parameter has an effect for the content of header parameter in
@@ -286,7 +286,7 @@ gboolean hinoko_fw_iso_ir_single_allocate(HinokoFwIsoIrSingle *self, const char
* @payloads_per_buffer: The number of payload in buffer.
* @error: A [struct@GLib.Error].
*
- * Map intermediate buffer to share payload of IR context with 1394 OHCI controller.
+ * Map intermediate buffer to share payload of IR context with 1394 OHCI hardware.
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
diff --git a/src/fw_iso_it.c b/src/fw_iso_it.c
index 95f55f3..852a5e8 100644
--- a/src/fw_iso_it.c
+++ b/src/fw_iso_it.c
@@ -63,7 +63,7 @@ static void hinoko_fw_iso_it_class_init(HinokoFwIsoItClass *klass)
* Emitted when Linux FireWire subsystem generates interrupt event. There are three cases
* for Linux FireWire subsystem to generate the event:
*
- * - When OHCI 1394 controller generates hardware interrupt as a result of processing the
+ * - When 1394 OHCI hardware generates hardware interrupt as a result of processing the
* isochronous packet for the buffer chunk marked to generate hardware interrupt.
* - When the number of isochronous packets sent since the last interrupt event reaches
* one quarter of memory page size (usually 4,096 / 4 = 1,024 packets).
@@ -228,8 +228,8 @@ HinokoFwIsoIt *hinoko_fw_iso_it_new(void)
* @header_size: The number of bytes for header of IT context.
* @error: A [struct@GLib.Error].
*
- * Allocate an IT context to 1394 OHCI controller. A local node of the node corresponding to the
- * given path is used as the controller, thus any path is accepted as long as process has enough
+ * Allocate an IT context to 1394 OHCI hardware. A local node of the node corresponding to the
+ * given path is used as the hardware, thus any path is accepted as long as process has enough
* permission for the path.
*
* Returns: TRUE if the overall operation finishes successful, otherwise FALSE.
@@ -257,7 +257,7 @@ gboolean hinoko_fw_iso_it_allocate(HinokoFwIsoIt *self, const char *path, Hinoko
* @payloads_per_buffer: The number of payloads of IT context in buffer.
* @error: A [struct@GLib.Error].
*
- * Map intermediate buffer to share payload of IT context with 1394 OHCI controller.
+ * Map intermediate buffer to share payload of IT context with 1394 OHCI hardware.
*
* Returns: TRUE if the overall operation finishes successful, otherwise FALSE.
*
diff --git a/src/meson.build b/src/meson.build
index 948844f..2d0d31e 100644
--- a/src/meson.build
+++ b/src/meson.build
@@ -78,7 +78,7 @@ install_headers(headers,
pkg = import('pkgconfig')
pkg.generate(myself,
- description: 'The library to operate OHCI 1394 hardware for isoochronous communication in IEEE 1394 bus',
+ description: 'The library to operate 1394 OHCI hardware for isoochronous communication in IEEE 1394 bus',
subdirs: inc_dir,
)