To avoid confusion in the terminology used in ZIO code and
documentation, this page lists
the types and data structures used in ZIO. For each row we list the
structure name (without struct
),
the name (english word) we consistently use in all documentation and the
preferred name for pointers
to that data structure.
| Structure name or C type| Name| Variable name|
Description*|
| zio_device | full-device | zdev | The overall I/O device, either a or
a chip. The full-device is what modules register into ZIO. |
| zio_cset | cset | cset | Part of a device; it represents a group of
channels with the same physical features. |
| zio_channel | channel | chan | Part of a cset; it is the single data
stream endpoint, input or output. |
| zio_device_operations | device operations or operations | d_op |
Device-specific methods that act on attributes and data blocks. |
| zio_buffer_type | buffer type | zbuf | Description of a buffer. |
| zio_bi | buffer instance or instance | bi | Instance of a buffer
type associated to a specific channel. |
| zio_buffer_operations | buffer operation or operations | b_op |
Methods of a buffer type: instance creation and destruction, block
allocation etc. |
| zio_trigger_type | trigger type | trig | Description of a trigger,
i.e. a generator of I/O events according to some rules. |
| zio_ti | trigger instance or instance | ti | Instance of a trigger
type associated to a specific cset. |
| zio_trigger_operations | trigger operations or operations | t_op
| Methods of a trigger type; instance creation and destruction, block
transfer etc. |
| void * | data or samples | data | A memory area hosting actual I/O
data. |
| zio_control | control | ctrl | A binary data structure used to
exchange meta-data with user space. |
| zio_block | block | block | A container for both data and control. In
ZIO, all I/O data is always handled within blocks. |
| zio_obj_head | head | head | All ZIO objects begin with this
sub-structure, to ease common management. |
| zio_cdev_type | - | - | An enumeration to identify type of a char
device (control or data). |
| zio_f_priv | - | - | Set as private_data in all open files.
includes cdev_type
and bi
. |
| zio_attribute_set | attribute set | zattr_set | Attributes of a ZIO
object (device, cset, chan, ti, bi) |