HinawaFwReq: Hinawa Reference Manual

HinawaFwReq

HinawaFwReq — A transaction executor to a FireWire unit

Functions

void	hinawa_fw_req_write ()
void	hinawa_fw_req_read ()
void	hinawa_fw_req_lock ()

Description

A HinawaFwReq supports three types of transactions in IEEE 1212:

read
write
lock

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

Functions

hinawa_fw_req_write ()

void
hinawa_fw_req_write (HinawaFwReq *self,
                     HinawaFwUnit *unit,
                     guint64 addr,
                     GByteArray *frame,
                     GError **exception);

Execute write transactions to the given unit.

Parameters

self	A HinawaFwReq
unit	A HinawaFwUnit
addr	A destination address of target device
frame	a 8bit array.	[element-type guint8][array][in]
exception	A GError

hinawa_fw_req_read ()

void
hinawa_fw_req_read (HinawaFwReq *self,
                    HinawaFwUnit *unit,
                    guint64 addr,
                    GByteArray *frame,
                    guint length,
                    GError **exception);

Execute read transaction to the given unit.

Parameters

self	A HinawaFwReq
unit	A HinawaFwUnit
addr	A destination address of target device
frame	a 8bit array.	[element-type guint8][array][out caller-allocates]
length	the number of bytes to read
exception	A GError

hinawa_fw_req_lock ()

void
hinawa_fw_req_lock (HinawaFwReq *self,
                    HinawaFwUnit *unit,
                    guint64 addr,
                    GByteArray **frame,
                    HinawaFwTcode lock_tcode,
                    GError **exception);

Execute lock transaction to the given unit.

Parameters

self	A HinawaFwReq
unit	A HinawaFwUnit
addr	A destination address of target device
frame	a 8bit array.	[element-type guint8][array][inout]
lock_tcode	One of HinawaFwTcode enumerator for lock operation.
exception	A GError