HinawaFwResp

HinawaFwResp — A transaction responder for a FireWire node.

Functions

HinawaFwResp * hinawa_fw_resp_new ()
void hinawa_fw_resp_reserve ()
void hinawa_fw_resp_release ()
void hinawa_fw_resp_get_req_frame ()
void hinawa_fw_resp_set_resp_frame ()

Properties

gboolean is-reserved Read

Signals

HinawaFwRcode requested Run Last

Object Hierarchy

    GObject
    ╰── HinawaFwResp
        ╰── HinawaFwFcp

Includes

#include <fw_resp.h>

Description

A HinawaFwResp responds requests from any units.

This class is an application of Linux FireWire subsystem. All of operations utilize ioctl(2) with subsystem specific request commands.

Functions

hinawa_fw_resp_new ()

HinawaFwResp *
hinawa_fw_resp_new (void);

Instantiate HinawaFwResp object and return the instance.

Returns

a new instance of HinawaFwResp.

Since: 1.3.

hinawa_fw_resp_reserve ()

void
hinawa_fw_resp_reserve (HinawaFwResp *self,
                        HinawaFwNode *node,
                        guint64 addr,
                        guint width,
                        GError **exception);

Start to listen to a range of address in host controller which connects to the node.

Parameters

self

A HinawaFwResp.

  

node

A HinawaFwNode.

  

addr

A start address to listen to in host controller.

  

width

The byte width of address to listen to host controller.

  

exception

A GError. Error can be generated with domain of hinawa_fw_node_error_quark().

  

Since: 1.4.

hinawa_fw_resp_release ()

void
hinawa_fw_resp_release (HinawaFwResp *self);

stop to listen to a range of address in host controller.

Parameters

self

A HinawaFwResp.

  

Since: 1.4.

hinawa_fw_resp_get_req_frame ()

void
hinawa_fw_resp_get_req_frame (HinawaFwResp *self,
                              const guint8 **frame,
                              gsize *length);

Retrieve byte frame to be requested.

Parameters

self

A HinawaFwResp

  

frame

a 8bit array for response frame.

[array length=length][out][transfer none]

length

The length of bytes for the frame.

[out]

hinawa_fw_resp_set_resp_frame ()

void
hinawa_fw_resp_set_resp_frame (HinawaFwResp *self,
                               guint8 *frame,
                               gsize length);

Register byte frame as response.

Parameters

self

A HinawaFwResp

  

frame

a 8bit array for response frame.

[element-type guint8][array length=length]

length

The length of bytes for the frame.

  

Property Details

The “is-reserved” property

  “is-reserved”              gboolean

Whether a range of address is reserved or not in host controller. .

Owner: HinawaFwResp

Flags: Read

Default value: FALSE

Signal Details

The “requested” signal

HinawaFwRcode
user_function (HinawaFwResp *self,
               HinawaFwTcode tcode,
               gpointer      user_data)

When any node transfers requests to the range of address to which this object listening. The “requested” signal handler can get data frame by a call of hinawa_fw_resp_get_req_frame() and set data frame by a call of hinawa_fw_resp_set_resp_frame(), then returns rcode.

Parameters

self

A HinawaFwResp

  

tcode

One of HinawaTcode enumerators

  

user_data

user data set when the signal handler was connected.

  

Returns

One of HinawaRcode enumerators corresponding to rcodes defined in IEEE 1394 specification.

Flags: Run Last

Generated by GTK-Doc V1.33.0