Hinoko.FwIsoCtx¶

Implementations:: Hinoko.FwIsoIrMultiple, Hinoko.FwIsoIrSingle, Hinoko.FwIsoIt

Methods¶

	`create_source` ()
	`flush_completions` ()
	`read_cycle_time` (clock_id, cycle_time)
	`release` ()
	`stop` ()
	`unmap_buffer` ()

Virtual Methods¶

	`do_create_source` ()
	`do_flush_completions` ()
	`do_read_cycle_time` (clock_id, cycle_time)
	`do_release` ()
	`do_stop` ()
	`do_stopped` (error)
	`do_unmap_buffer` ()

Properties¶

Name	Type	Flags	Short Description
`bytes-per-chunk`	`int`	r	The number of bytes for chunk in buffer.
`chunks-per-buffer`	`int`	r	The number of chunks in buffer.

Signals¶

Name	Short Description
`stopped`	Emitted when isochronous context is stopped.

Fields¶

None

Class Details¶

class Hinoko.FwIsoCtx¶

Bases:: GObject.GInterface
Structure:: Hinoko.FwIsoCtxInterface

A set of basic interfaces to operate isochronous context on 1394 OHCI hardware. [iface`FwIsoCtx`] includes interfaces to operate 1394 OHCI hardware for isochronous communication by any kind of contexts.

create_source()¶

Raises:

GLib.Error

Returns:

True if the overall operation finishes successfully, otherwise False.

source:: A [struct`GLib`.Source].

Return type:

(bool, source: GLib.Source)

Create [struct`GLib`.Source] for [struct`GLib`.MainContext] to dispatch events for isochronous context.

New in version 0.7.

flush_completions()¶

Raises:: GLib.Error
Returns:: True if the overall operation finishes successfully, otherwise False.
Return type:: bool

Flush isochronous context until recent isochronous cycle. The call of function forces the context to queue any type of interrupt event for the recent isochronous cycle. Application can process the content of isochronous packet without waiting for actual hardware interrupt.

New in version 0.7.

read_cycle_time(clock_id, cycle_time)¶

Parameters:

clock_id (int) – The numeric ID of clock source for the reference timestamp. One CLOCK_REALTIME(0), CLOCK_MONOTONIC(1), and CLOCK_MONOTONIC_RAW(4) is available in UAPI of Linux kernel.
cycle_time (Hinawa.CycleTime) – A [struct`Hinawa`.CycleTime] to store data of cycle time.

Raises:

GLib.Error

Returns:

True if the overall operation finishes successfully, otherwise False.

cycle_time:: A [struct`Hinawa`.CycleTime] to store data of cycle time.

Return type:

(bool, cycle_time: Hinawa.CycleTime)

Retrieve the value of cycle time register. This method call is available once any isochronous context is created.

New in version 1.0.

release()¶: Release the contest from 1394 OHCI hardware.

New in version 0.7.

stop()¶: Stop isochronous context.

New in version 0.7.

unmap_buffer()¶: Unmap intermediate buffer shared with 1394 OHCI hardware for the context.

New in version 0.7.

do_create_source() virtual¶

Returns:

True if the overall operation finishes successfully, otherwise False.

source:: A [struct`GLib`.Source].

Return type:

(bool, source: GLib.Source)

Create [struct`GLib`.Source] for [struct`GLib`.MainContext] to dispatch events for isochronous context.

New in version 0.7.

do_flush_completions() virtual¶

Returns:: True if the overall operation finishes successfully, otherwise False.
Return type:: bool

Flush isochronous context until recent isochronous cycle. The call of function forces the context to queue any type of interrupt event for the recent isochronous cycle. Application can process the content of isochronous packet without waiting for actual hardware interrupt.

New in version 0.7.

do_read_cycle_time(clock_id, cycle_time) virtual¶

Parameters:

clock_id (int) – The numeric ID of clock source for the reference timestamp. One CLOCK_REALTIME(0), CLOCK_MONOTONIC(1), and CLOCK_MONOTONIC_RAW(4) is available in UAPI of Linux kernel.
cycle_time (Hinawa.CycleTime) – A [struct`Hinawa`.CycleTime] to store data of cycle time.

Returns:

True if the overall operation finishes successfully, otherwise False.

cycle_time:: A [struct`Hinawa`.CycleTime] to store data of cycle time.

Return type:

(bool, cycle_time: Hinawa.CycleTime)

Retrieve the value of cycle time register. This method call is available once any isochronous context is created.

New in version 1.0.

do_release() virtual¶: Release the contest from 1394 OHCI hardware.

New in version 0.7.

do_stop() virtual¶: Stop isochronous context.

New in version 0.7.

do_stopped(error) virtual¶

Parameters:: error (GLib.Error or None) – A [struct`GLib`.Error].

Closure for the [signal`FwIsoCtx`:py:func:::stopped<Hinoko.FwIsoCtx.signals.stopped>] signal.

do_unmap_buffer() virtual¶: Unmap intermediate buffer shared with 1394 OHCI hardware for the context.

New in version 0.7.

Signal Details¶

Hinoko.FwIsoCtx.signals.stopped(fw_iso_ctx, error)¶

Signal Name:

stopped

Flags:

RUN_LAST, ACTION

Parameters:

fw_iso_ctx (Hinoko.FwIsoCtx) – The object which received the signal
error (GLib.Error or None) – A [struct`GLib`.Error].

Emitted when isochronous context is stopped.

New in version 0.7.

Property Details¶

Hinoko.FwIsoCtx.props.bytes_per_chunk¶

Name:: bytes-per-chunk
Type:: int
Default Value:: 0
Flags:: READABLE

The number of bytes per chunk in buffer.

New in version 0.7.

Hinoko.FwIsoCtx.props.chunks_per_buffer¶

Name:: chunks-per-buffer
Type:: int
Default Value:: 0
Flags:: READABLE

The number of chunks per buffer.

New in version 0.7.